test: add timezone package tests
Add comprehensive tests for timezone functionality: - Init (valid/invalid timezones, default) - getUTCOffset - Now (with/without location) - Location (with/without location) - Name (with/without name) - StartOfDay, Today, EndOfDay - StartOfWeek (Monday-based) - StartOfMonth - ParseInLocation - ParseInUserLocation (valid/empty/invalid TZ) - NowInUserLocation - StartOfDayInUserLocation Coverage: timezone 45.2% → 93.5%
This commit is contained in:
Your Name
@@ -3,135 +3,307 @@ package timezone
|
|||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestInit(t *testing.T) {
|
func TestInit(t *testing.T) {
|
||||||
// Test with valid timezone
|
// Save original state
|
||||||
err := Init("Asia/Shanghai")
|
originalLoc := location
|
||||||
if err != nil {
|
originalTzName := tzName
|
||||||
t.Fatalf("Init failed with valid timezone: %v", err)
|
defer func() {
|
||||||
|
location = originalLoc
|
||||||
|
tzName = originalTzName
|
||||||
|
}()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
tz string
|
||||||
|
wantErr bool
|
||||||
|
wantName string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid timezone Asia/Shanghai",
|
||||||
|
tz: "Asia/Shanghai",
|
||||||
|
wantErr: false,
|
||||||
|
wantName: "Asia/Shanghai",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid timezone UTC",
|
||||||
|
tz: "UTC",
|
||||||
|
wantErr: false,
|
||||||
|
wantName: "UTC",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "empty string uses default",
|
||||||
|
tz: "",
|
||||||
|
wantErr: false,
|
||||||
|
wantName: "Asia/Shanghai",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid timezone",
|
||||||
|
tz: "Invalid/Timezone",
|
||||||
|
wantErr: true,
|
||||||
|
wantName: "",
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Verify time.Local was set
|
for _, tt := range tests {
|
||||||
if time.Local.String() != "Asia/Shanghai" {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
t.Errorf("time.Local not set correctly, got %s", time.Local.String())
|
// Reset state
|
||||||
}
|
location = nil
|
||||||
|
tzName = ""
|
||||||
|
|
||||||
// Verify our location variable
|
err := Init(tt.tz)
|
||||||
if Location().String() != "Asia/Shanghai" {
|
if tt.wantErr {
|
||||||
t.Errorf("Location() not set correctly, got %s", Location().String())
|
assert.Error(t, err)
|
||||||
}
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
// Test Name()
|
assert.Equal(t, tt.wantName, Name())
|
||||||
if Name() != "Asia/Shanghai" {
|
}
|
||||||
t.Errorf("Name() not set correctly, got %s", Name())
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestInitInvalidTimezone(t *testing.T) {
|
func TestGetUTCOffset(t *testing.T) {
|
||||||
err := Init("Invalid/Timezone")
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
if err == nil {
|
offset := getUTCOffset(loc)
|
||||||
t.Error("Init should fail with invalid timezone")
|
assert.NotEmpty(t, offset)
|
||||||
}
|
// Should be +08:00 for Shanghai
|
||||||
|
assert.Contains(t, offset, "+")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTimeNowAffected(t *testing.T) {
|
func TestNow(t *testing.T) {
|
||||||
// Reset to UTC first
|
// Save and restore
|
||||||
if err := Init("UTC"); err != nil {
|
originalLoc := location
|
||||||
t.Fatalf("Init failed with UTC: %v", err)
|
defer func() { location = originalLoc }()
|
||||||
}
|
|
||||||
utcNow := time.Now()
|
|
||||||
|
|
||||||
// Switch to Shanghai (UTC+8)
|
t.Run("with location set", func(t *testing.T) {
|
||||||
if err := Init("Asia/Shanghai"); err != nil {
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
t.Fatalf("Init failed with Asia/Shanghai: %v", err)
|
location = loc
|
||||||
}
|
now := Now()
|
||||||
shanghaiNow := time.Now()
|
assert.NotZero(t, now)
|
||||||
|
})
|
||||||
|
|
||||||
// The times should be the same instant, but different timezone representation
|
t.Run("without location", func(t *testing.T) {
|
||||||
// Shanghai should be 8 hours ahead in display
|
location = nil
|
||||||
_, utcOffset := utcNow.Zone()
|
now := Now()
|
||||||
_, shanghaiOffset := shanghaiNow.Zone()
|
assert.NotZero(t, now)
|
||||||
|
})
|
||||||
expectedDiff := 8 * 3600 // 8 hours in seconds
|
|
||||||
actualDiff := shanghaiOffset - utcOffset
|
|
||||||
|
|
||||||
if actualDiff != expectedDiff {
|
|
||||||
t.Errorf("Timezone offset difference incorrect: expected %d, got %d", expectedDiff, actualDiff)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToday(t *testing.T) {
|
func TestLocation(t *testing.T) {
|
||||||
if err := Init("Asia/Shanghai"); err != nil {
|
// Save and restore
|
||||||
t.Fatalf("Init failed with Asia/Shanghai: %v", err)
|
originalLoc := location
|
||||||
}
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
today := Today()
|
t.Run("with location set", func(t *testing.T) {
|
||||||
now := Now()
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
assert.Equal(t, loc, Location())
|
||||||
|
})
|
||||||
|
|
||||||
// Today should be at 00:00:00
|
t.Run("without location", func(t *testing.T) {
|
||||||
if today.Hour() != 0 || today.Minute() != 0 || today.Second() != 0 {
|
location = nil
|
||||||
t.Errorf("Today() not at start of day: %v", today)
|
assert.Equal(t, time.Local, Location())
|
||||||
}
|
})
|
||||||
|
}
|
||||||
|
|
||||||
// Today should be same date as now
|
func TestName(t *testing.T) {
|
||||||
if today.Year() != now.Year() || today.Month() != now.Month() || today.Day() != now.Day() {
|
// Save and restore
|
||||||
t.Errorf("Today() date mismatch: today=%v, now=%v", today, now)
|
originalName := tzName
|
||||||
}
|
defer func() { tzName = originalName }()
|
||||||
|
|
||||||
|
t.Run("with name set", func(t *testing.T) {
|
||||||
|
tzName = "Asia/Shanghai"
|
||||||
|
assert.Equal(t, "Asia/Shanghai", Name())
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("without name", func(t *testing.T) {
|
||||||
|
tzName = ""
|
||||||
|
assert.Equal(t, "Local", Name())
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStartOfDay(t *testing.T) {
|
func TestStartOfDay(t *testing.T) {
|
||||||
if err := Init("Asia/Shanghai"); err != nil {
|
// Save and restore
|
||||||
t.Fatalf("Init failed with Asia/Shanghai: %v", err)
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
now := time.Date(2024, 6, 15, 14, 30, 45, 0, loc)
|
||||||
|
start := StartOfDay(now)
|
||||||
|
|
||||||
|
assert.Equal(t, 2024, start.Year())
|
||||||
|
assert.Equal(t, time.Month(6), start.Month())
|
||||||
|
assert.Equal(t, 15, start.Day())
|
||||||
|
assert.Equal(t, 0, start.Hour())
|
||||||
|
assert.Equal(t, 0, start.Minute())
|
||||||
|
assert.Equal(t, 0, start.Second())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestToday(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
today := Today()
|
||||||
|
assert.Equal(t, 0, today.Hour())
|
||||||
|
assert.Equal(t, 0, today.Minute())
|
||||||
|
assert.Equal(t, 0, today.Second())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEndOfDay(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
now := time.Date(2024, 6, 15, 14, 30, 45, 0, loc)
|
||||||
|
end := EndOfDay(now)
|
||||||
|
|
||||||
|
assert.Equal(t, 2024, end.Year())
|
||||||
|
assert.Equal(t, time.Month(6), end.Month())
|
||||||
|
assert.Equal(t, 15, end.Day())
|
||||||
|
assert.Equal(t, 23, end.Hour())
|
||||||
|
assert.Equal(t, 59, end.Minute())
|
||||||
|
assert.Equal(t, 59, end.Second())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartOfWeek(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
// Friday June 14, 2024
|
||||||
|
friday := time.Date(2024, 6, 14, 10, 0, 0, 0, loc)
|
||||||
|
start := StartOfWeek(friday)
|
||||||
|
|
||||||
|
// Should be Monday June 10, 2024
|
||||||
|
assert.Equal(t, 2024, start.Year())
|
||||||
|
assert.Equal(t, time.Month(6), start.Month())
|
||||||
|
assert.Equal(t, 10, start.Day())
|
||||||
|
assert.Equal(t, time.Monday, start.Weekday())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartOfMonth(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
midMonth := time.Date(2024, 6, 15, 10, 0, 0, 0, loc)
|
||||||
|
start := StartOfMonth(midMonth)
|
||||||
|
|
||||||
|
assert.Equal(t, 2024, start.Year())
|
||||||
|
assert.Equal(t, time.Month(6), start.Month())
|
||||||
|
assert.Equal(t, 1, start.Day())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseInLocation(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
parsed, err := ParseInLocation("2006-01-02", "2024-06-15")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, 2024, parsed.Year())
|
||||||
|
assert.Equal(t, time.Month(6), parsed.Month())
|
||||||
|
assert.Equal(t, 15, parsed.Day())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseInUserLocation(t *testing.T) {
|
||||||
|
// Save and restore
|
||||||
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
userTZ string
|
||||||
|
}{
|
||||||
|
{"with valid user timezone", "America/New_York"},
|
||||||
|
{"with empty user timezone", ""},
|
||||||
|
{"with invalid user timezone", "Invalid/Zone"},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a time at 15:30:45
|
for _, tt := range tests {
|
||||||
testTime := time.Date(2024, 6, 15, 15, 30, 45, 123456789, Location())
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
startOfDay := StartOfDay(testTime)
|
parsed, err := ParseInUserLocation("2006-01-02", "2024-06-15", tt.userTZ)
|
||||||
|
require.NoError(t, err)
|
||||||
expected := time.Date(2024, 6, 15, 0, 0, 0, 0, Location())
|
assert.Equal(t, 2024, parsed.Year())
|
||||||
if !startOfDay.Equal(expected) {
|
assert.Equal(t, time.Month(6), parsed.Month())
|
||||||
t.Errorf("StartOfDay incorrect: expected %v, got %v", expected, startOfDay)
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTruncateVsStartOfDay(t *testing.T) {
|
func TestNowInUserLocation(t *testing.T) {
|
||||||
// This test demonstrates why Truncate(24*time.Hour) can be problematic
|
// Save and restore
|
||||||
// and why StartOfDay is more reliable for timezone-aware code
|
originalLoc := location
|
||||||
|
defer func() { location = originalLoc }()
|
||||||
|
|
||||||
if err := Init("Asia/Shanghai"); err != nil {
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
t.Fatalf("Init failed with Asia/Shanghai: %v", err)
|
location = loc
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
userTZ string
|
||||||
|
}{
|
||||||
|
{"with valid user timezone", "America/New_York"},
|
||||||
|
{"with empty user timezone", ""},
|
||||||
|
{"with invalid user timezone", "Invalid/Zone"},
|
||||||
}
|
}
|
||||||
|
|
||||||
now := Now()
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
// Truncate operates on UTC, not local time
|
now := NowInUserLocation(tt.userTZ)
|
||||||
truncated := now.Truncate(24 * time.Hour)
|
assert.NotZero(t, now)
|
||||||
|
})
|
||||||
// StartOfDay operates on local time
|
|
||||||
startOfDay := StartOfDay(now)
|
|
||||||
|
|
||||||
// These will likely be different for non-UTC timezones
|
|
||||||
t.Logf("Now: %v", now)
|
|
||||||
t.Logf("Truncate(24h): %v", truncated)
|
|
||||||
t.Logf("StartOfDay: %v", startOfDay)
|
|
||||||
|
|
||||||
// The truncated time may not be at local midnight
|
|
||||||
// StartOfDay is always at local midnight
|
|
||||||
if startOfDay.Hour() != 0 {
|
|
||||||
t.Errorf("StartOfDay should be at hour 0, got %d", startOfDay.Hour())
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDSTAwareness(t *testing.T) {
|
func TestStartOfDayInUserLocation(t *testing.T) {
|
||||||
// Test with a timezone that has DST (America/New_York)
|
// Save and restore
|
||||||
err := Init("America/New_York")
|
originalLoc := location
|
||||||
if err != nil {
|
defer func() { location = originalLoc }()
|
||||||
t.Skipf("America/New_York timezone not available: %v", err)
|
|
||||||
|
loc, _ := time.LoadLocation("Asia/Shanghai")
|
||||||
|
location = loc
|
||||||
|
|
||||||
|
now := time.Date(2024, 6, 15, 14, 30, 0, 0, loc)
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
userTZ string
|
||||||
|
}{
|
||||||
|
{"with valid user timezone", "America/New_York"},
|
||||||
|
{"with empty user timezone", ""},
|
||||||
|
{"with invalid user timezone", "Invalid/Zone"},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Just verify it doesn't crash
|
for _, tt := range tests {
|
||||||
_ = Today()
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
_ = Now()
|
start := StartOfDayInUserLocation(now, tt.userTZ)
|
||||||
_ = StartOfDay(Now())
|
assert.Equal(t, 0, start.Hour())
|
||||||
|
assert.Equal(t, 0, start.Minute())
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user