hugo/tpl/time/time_test.go
2024-01-28 23:14:09 +01:00

183 lines
6.2 KiB
Go

// Copyright 2017 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package time
import (
"strings"
"testing"
"time"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/common/htime"
translators "github.com/gohugoio/localescompressed"
)
func TestTimeLocation(t *testing.T) {
t.Parallel()
loc, _ := time.LoadLocation("America/Antigua")
ns := New(htime.NewTimeFormatter(translators.GetTranslator("en")), loc)
for i, test := range []struct {
name string
value string
location any
expect any
}{
{"Empty location", "2020-10-20", "", "2020-10-20 00:00:00 +0000 UTC"},
{"New location", "2020-10-20", nil, "2020-10-20 00:00:00 -0400 AST"},
{"New York EDT", "2020-10-20", "America/New_York", "2020-10-20 00:00:00 -0400 EDT"},
{"New York EST", "2020-01-20", "America/New_York", "2020-01-20 00:00:00 -0500 EST"},
{"Empty location, time", "2020-10-20 20:33:59", "", "2020-10-20 20:33:59 +0000 UTC"},
{"New York, time", "2020-10-20 20:33:59", "America/New_York", "2020-10-20 20:33:59 -0400 EDT"},
// The following have an explicit offset specified. In this case, it overrides timezone
{"Offset minus 0700, empty location", "2020-09-23T20:33:44-0700", "", "2020-09-23 20:33:44 -0700 -0700"},
{"Offset plus 0200, empty location", "2020-09-23T20:33:44+0200", "", "2020-09-23 20:33:44 +0200 +0200"},
{"Offset, New York", "2020-09-23T20:33:44-0700", "America/New_York", "2020-09-23 20:33:44 -0700 -0700"},
{"Offset, Oslo", "2020-09-23T20:33:44+0200", "Europe/Oslo", "2020-09-23 20:33:44 +0200 +0200"},
// Failures.
{"Invalid time zone", "2020-01-20", "invalid-timezone", false},
{"Invalid time value", "invalid-value", "", false},
} {
t.Run(test.name, func(t *testing.T) {
var args []any
if test.location != nil {
args = append(args, test.location)
}
result, err := ns.AsTime(test.value, args...)
if b, ok := test.expect.(bool); ok && !b {
if err == nil {
t.Errorf("[%d] AsTime didn't return an expected error, got %v", i, result)
}
} else {
if err != nil {
t.Errorf("[%d] AsTime failed: %s", i, err)
return
}
// See https://github.com/gohugoio/hugo/issues/8843#issuecomment-891551447
// Drop the location string (last element) when comparing,
// as that may change depending on the local locale.
timeStr := result.(time.Time).String()
timeStr = timeStr[:strings.LastIndex(timeStr, " ")]
if !strings.HasPrefix(test.expect.(string), timeStr) {
t.Errorf("[%d] AsTime got %v but expected %v", i, timeStr, test.expect)
}
}
})
}
}
func TestFormat(t *testing.T) {
c := qt.New(t)
c.Run("UTC", func(c *qt.C) {
c.Parallel()
ns := New(htime.NewTimeFormatter(translators.GetTranslator("en")), time.UTC)
for i, test := range []struct {
layout string
value any
expect any
}{
{"Monday, Jan 2, 2006", "2015-01-21", "Wednesday, Jan 21, 2015"},
{"Monday, Jan 2, 2006", time.Date(2015, time.January, 21, 0, 0, 0, 0, time.UTC), "Wednesday, Jan 21, 2015"},
{"This isn't a date layout string", "2015-01-21", "This isn't a date layout string"},
// The following test case gives either "Tuesday, Jan 20, 2015" or "Monday, Jan 19, 2015" depending on the local time zone
{"Monday, Jan 2, 2006", 1421733600, time.Unix(1421733600, 0).Format("Monday, Jan 2, 2006")},
{"Monday, Jan 2, 2006", 1421733600.123, false},
{time.RFC3339, time.Date(2016, time.March, 3, 4, 5, 0, 0, time.UTC), "2016-03-03T04:05:00Z"},
{time.RFC1123, time.Date(2016, time.March, 3, 4, 5, 0, 0, time.UTC), "Thu, 03 Mar 2016 04:05:00 UTC"},
{time.RFC3339, "Thu, 03 Mar 2016 04:05:00 UTC", "2016-03-03T04:05:00Z"},
{time.RFC1123, "2016-03-03T04:05:00Z", "Thu, 03 Mar 2016 04:05:00 UTC"},
// Custom layouts, as introduced in Hugo 0.87.
{":date_medium", "2015-01-21", "Jan 21, 2015"},
} {
result, err := ns.Format(test.layout, test.value)
if b, ok := test.expect.(bool); ok && !b {
if err == nil {
c.Errorf("[%d] DateFormat didn't return an expected error, got %v", i, result)
}
} else {
if err != nil {
c.Errorf("[%d] DateFormat failed: %s", i, err)
continue
}
if result != test.expect {
c.Errorf("[%d] DateFormat got %v but expected %v", i, result, test.expect)
}
}
}
})
// Issue #9084
c.Run("TZ America/Los_Angeles", func(c *qt.C) {
c.Parallel()
loc, err := time.LoadLocation("America/Los_Angeles")
c.Assert(err, qt.IsNil)
ns := New(htime.NewTimeFormatter(translators.GetTranslator("en")), loc)
d, err := ns.Format(":time_full", "2020-03-09T11:00:00")
c.Assert(err, qt.IsNil)
c.Assert(d, qt.Equals, "11:00:00 am Pacific Daylight Time")
})
}
func TestDuration(t *testing.T) {
t.Parallel()
ns := New(htime.NewTimeFormatter(translators.GetTranslator("en")), time.UTC)
for i, test := range []struct {
unit any
num any
expect any
}{
{"nanosecond", 10, 10 * time.Nanosecond},
{"ns", 10, 10 * time.Nanosecond},
{"microsecond", 20, 20 * time.Microsecond},
{"us", 20, 20 * time.Microsecond},
{"µs", 20, 20 * time.Microsecond},
{"millisecond", 20, 20 * time.Millisecond},
{"ms", 20, 20 * time.Millisecond},
{"second", 30, 30 * time.Second},
{"s", 30, 30 * time.Second},
{"minute", 20, 20 * time.Minute},
{"m", 20, 20 * time.Minute},
{"hour", 20, 20 * time.Hour},
{"h", 20, 20 * time.Hour},
{"hours", 20, false},
{"hour", "30", 30 * time.Hour},
} {
result, err := ns.Duration(test.unit, test.num)
if b, ok := test.expect.(bool); ok && !b {
if err == nil {
t.Errorf("[%d] Duration didn't return an expected error, got %v", i, result)
}
} else {
if err != nil {
t.Errorf("[%d] Duration failed: %s", i, err)
continue
}
if result != test.expect {
t.Errorf("[%d] Duration got %v but expected %v", i, result, test.expect)
}
}
}
}