Make tests deterministic

Emyrk · Emyrk · commit 62a22e7286f8 · 2024-01-31T15:17:14.000-06:00
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -2186,20 +2186,24 @@ func (d DAURequest) asRequestOption() RequestOption {
 	}
 }
 
-// TimezoneOffsetHour is implemented to match the javascript 'getTimezoneOffset()' function.
+// TimezoneOffsetHourWithTime is implemented to match the javascript 'getTimezoneOffset()' function.
 // This is the amount of time between this date evaluated in UTC and evaluated in the 'loc'
 // The trivial case of times being on the same day is:
 // 'time.Now().UTC().Hour() - time.Now().In(loc).Hour()'
-func TimezoneOffsetHour(loc *time.Location) int {
+func TimezoneOffsetHourWithTime(now time.Time, loc *time.Location) int {
 	if loc == nil {
 		// Default to UTC time to be consistent across all callers.
 		loc = time.UTC
 	}
-	_, offsetSec := time.Now().In(loc).Zone()
+	_, offsetSec := now.In(loc).Zone()
 	// Convert to hours and flip the sign
 	return -1 * offsetSec / 60 / 60
 }
 
+func TimezoneOffsetHour(loc *time.Location) int {
+	return TimezoneOffsetHourWithTime(time.Now(), loc)
+}
+
 func (c *Client) DeploymentDAUsLocalTZ(ctx context.Context) (*DAUsResponse, error) {
 	return c.DeploymentDAUs(ctx, TimezoneOffsetHour(time.Local))
 }
diff --git a/codersdk/deployment_test.go b/codersdk/deployment_test.go
@@ -205,6 +205,7 @@ func TestTimezoneOffsets(t *testing.T) {
 
 	testCases := []struct {
 		Name           string
+		Now            time.Time
 		Loc            *time.Location
 		ExpectedOffset int
 	}{
@@ -213,29 +214,52 @@ func TestTimezoneOffsets(t *testing.T) {
 			Loc:            time.UTC,
 			ExpectedOffset: 0,
 		},
-		// The following test cases are broken re: daylight savings
-		//{
-		//	Name:           "Eastern",
-		//	Loc:            must(time.LoadLocation("America/New_York")),
-		//	ExpectedOffset: -4,
-		// },
-		//{
-		//	Name:           "Central",
-		//	Loc:            must(time.LoadLocation("America/Chicago")),
-		//	ExpectedOffset: -5,
-		// },
-		//{
-		//	Name:           "Ireland",
-		//	Loc:            must(time.LoadLocation("Europe/Dublin")),
-		//	ExpectedOffset: 1,
-		// },
+
+		{
+			Name:           "Eastern",
+			Now:            time.Date(2021, 2, 1, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("America/New_York")),
+			ExpectedOffset: 5,
+		},
+		{
+			// Daylight savings is on the 14th of March to Nov 7 in 2021
+			Name:           "EasternDaylightSavings",
+			Now:            time.Date(2021, 3, 16, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("America/New_York")),
+			ExpectedOffset: 4,
+		},
+		{
+			Name:           "Central",
+			Now:            time.Date(2021, 2, 1, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("America/Chicago")),
+			ExpectedOffset: 6,
+		},
+		{
+			Name:           "CentralDaylightSavings",
+			Now:            time.Date(2021, 3, 16, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("America/Chicago")),
+			ExpectedOffset: 5,
+		},
+		{
+			Name:           "Ireland",
+			Now:            time.Date(2021, 2, 1, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("Europe/Dublin")),
+			ExpectedOffset: 0,
+		},
+		{
+			Name:           "IrelandDaylightSavings",
+			Now:            time.Date(2021, 4, 3, 0, 0, 0, 0, time.UTC),
+			Loc:            must(time.LoadLocation("Europe/Dublin")),
+			ExpectedOffset: -1,
+		},
 		{
 			Name: "HalfHourTz",
+			Now:  time.Date(2024, 1, 20, 6, 0, 0, 0, must(time.LoadLocation("Asia/Yangon"))),
 			// This timezone is +6:30, but the function rounds to the nearest hour.
 			// This is intentional because our DAUs endpoint only covers 1-hour offsets.
 			// If the user is in a non-hour timezone, they get the closest hour bucket.
 			Loc:            must(time.LoadLocation("Asia/Yangon")),
-			ExpectedOffset: 6,
+			ExpectedOffset: -6,
 		},
 	}
 
@@ -244,7 +268,7 @@ func TestTimezoneOffsets(t *testing.T) {
 		t.Run(c.Name, func(t *testing.T) {
 			t.Parallel()
 
-			offset := codersdk.TimezoneOffsetHour(c.Loc)
+			offset := codersdk.TimezoneOffsetHourWithTime(c.Now, c.Loc)
 			require.Equal(t, c.ExpectedOffset, offset)
 		})
 	}

Original file line number	Diff line number	Diff line change
`@@ -2186,20 +2186,24 @@ func (d DAURequest) asRequestOption() RequestOption {`
`2186`	`2186`	`}`
`2187`	`2187`	`}`
`2188`	`2188`
`2189`		`-// TimezoneOffsetHour is implemented to match the javascript 'getTimezoneOffset()' function.`
	`2189`	`+// TimezoneOffsetHourWithTime is implemented to match the javascript 'getTimezoneOffset()' function.`
`2190`	`2190`	`// This is the amount of time between this date evaluated in UTC and evaluated in the 'loc'`
`2191`	`2191`	`// The trivial case of times being on the same day is:`
`2192`	`2192`	`// 'time.Now().UTC().Hour() - time.Now().In(loc).Hour()'`
`2193`		`-func TimezoneOffsetHour(loc *time.Location) int {`
	`2193`	`+func TimezoneOffsetHourWithTime(now time.Time, loc *time.Location) int {`
`2194`	`2194`	`if loc == nil {`
`2195`	`2195`	`// Default to UTC time to be consistent across all callers.`
`2196`	`2196`	`loc = time.UTC`
`2197`	`2197`	`}`
`2198`		`- _, offsetSec := time.Now().In(loc).Zone()`
	`2198`	`+ _, offsetSec := now.In(loc).Zone()`
`2199`	`2199`	`// Convert to hours and flip the sign`
`2200`	`2200`	`return -1 * offsetSec / 60 / 60`
`2201`	`2201`	`}`
`2202`	`2202`
	`2203`	`+func TimezoneOffsetHour(loc *time.Location) int {`
	`2204`	`+ return TimezoneOffsetHourWithTime(time.Now(), loc)`
	`2205`	`+}`
	`2206`	`+`
`2203`	`2207`	`func (c Client) DeploymentDAUsLocalTZ(ctx context.Context) (DAUsResponse, error) {`
`2204`	`2208`	`return c.DeploymentDAUs(ctx, TimezoneOffsetHour(time.Local))`
`2205`	`2209`	`}`