test(maintenance): use tab style for testing

Scalingo · Jul 18, 2023 · 272f536 · 272f536
1 parent 5538524
commit 272f536
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 175 deletions.
diff --git a/db/maintenance/info.go b/db/maintenance/info.go
@@ -72,6 +72,8 @@ func Info(ctx context.Context, app, addonUUID, maintenanceID string) error {
 //	Yes => then the next maintenance is the day of the maintenance + 1 week
 //			except in the case if we are already in the range of the maintenance window and status different than "Scheduled".
 //	No 	=> then the next maintenance is the maintenance time from the database information.
+//
+// It returns the current maintenance if we are within the maintenance boundaries or returns the next maintenance.
 func getNextLocalMaintenanceWindow(now time.Time, maintenanceWindow scalingo.MaintenanceWindow, status scalingo.MaintenanceStatus) (time.Time, time.Time) {
 	var nextMaintenanceWindowStartingDate time.Time
 	now = now.UTC()

diff --git a/db/maintenance/info_test.go b/db/maintenance/info_test.go
@@ -5,190 +5,67 @@ import (
 	"time"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
-	"github.com/Scalingo/cli/utils"
 	"github.com/Scalingo/go-scalingo/v6"
 )
 
-func TestGetNextMaintenanceLocalWindow(t *testing.T) {
-	functionExecutionTime := dateOfTheWeekUTC(time.Wednesday, 8)
-
-	t.Run("when the maintenance is notified", func(t *testing.T) {
-		maintenanceType := scalingo.MaintenanceStatusNotified
-
-		t.Run("when the maintenance should be executed next week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Sunday, 0)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime.AddDate(0, 0, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-
-		t.Run("when the maintenance window is ongoing", func(t *testing.T) {
-			// given
-			expectedMaintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Wednesday, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(expectedMaintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: expectedMaintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-
-		t.Run("when the maintenance window is this week", func(t *testing.T) {
-			// given
-			expectedMaintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Saturday, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(expectedMaintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: expectedMaintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-	})
-
-	t.Run("when the maintenance is queued", func(t *testing.T) {
-		maintenanceType := scalingo.MaintenanceStatusQueued
-
-		t.Run("when the maintenance should be executed next week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Sunday, 0)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime.AddDate(0, 0, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-
-		t.Run("when the maintenance window is ongoing", func(t *testing.T) {
-			// given
-			expectedMaintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Wednesday, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(expectedMaintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: expectedMaintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceWindowExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-
-		t.Run("when the maintenance window is this week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Saturday, 7)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-	})
-
-	t.Run("when the maintenance is scheduled", func(t *testing.T) {
-		maintenanceType := scalingo.MaintenanceStatusScheduled
-
-		t.Run("when the maintenance should be executed next week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Sunday, 0)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime.AddDate(0, 0, 7)
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
-			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
+type test struct {
+	maintenanceStatuses []scalingo.MaintenanceStatus
+	expectedRunTime     time.Time
+	maintenanceRunDate  time.Time
+}
 
-		t.Run("when the maintenance window is ongoing it should be executed next week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Wednesday, 7)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime.AddDate(0, 0, 7)
+func TestGetNextMaintenanceLocalWindow(t *testing.T) {
+	now := dateAt(t, "Wednesday, 19-Jul-23 08:00:00 UTC")
+
+	tests := map[string]test{
+		"when the maintenance is notified, queued or scheduled, the maintenance should be executed a week later when execution date is in the past": {
+			maintenanceStatuses: []scalingo.MaintenanceStatus{scalingo.MaintenanceStatusNotified, scalingo.MaintenanceStatusQueued, scalingo.MaintenanceStatusScheduled},
+			maintenanceRunDate:  dateAt(t, "Sunday, 16-Jul-23 00:00:00 UTC"),
+			expectedRunTime:     dateAt(t, "Sunday, 23-Jul-23 00:00:00 UTC"),
+		},
+		"when the maintenance is notified or queued, the maintenance should be ongoing when execution date is within maintenance boundaries": {
+			maintenanceStatuses: []scalingo.MaintenanceStatus{scalingo.MaintenanceStatusNotified, scalingo.MaintenanceStatusQueued},
+			maintenanceRunDate:  dateAt(t, "Wednesday, 19-Jul-23 07:00:00 UTC"),
+			expectedRunTime:     dateAt(t, "Wednesday, 19-Jul-23 07:00:00 UTC"),
+		},
+		"when the maintenance is scheduled, the maintenance should be executed when execution date is within maintenance boundaries": {
+			maintenanceStatuses: []scalingo.MaintenanceStatus{scalingo.MaintenanceStatusScheduled},
+			maintenanceRunDate:  dateAt(t, "Wednesday, 19-Jul-23 07:00:00 UTC"),
+			expectedRunTime:     dateAt(t, "Saturday, 26-Jul-23 07:00:00 UTC"),
+		},
+		"when the maintenance is notified, queued or scheduled, the maintenance should be executed this week when execution date in future": {
+			maintenanceStatuses: []scalingo.MaintenanceStatus{scalingo.MaintenanceStatusNotified, scalingo.MaintenanceStatusQueued, scalingo.MaintenanceStatusScheduled},
+			maintenanceRunDate:  dateAt(t, "Saturday, 22-Jul-23 07:00:00 UTC"),
+			expectedRunTime:     dateAt(t, "Saturday, 22-Jul-23 07:00:00 UTC"),
+		},
+	}
+
+	for testName, test := range tests {
+		t.Run(testName, func(t *testing.T) {
 			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
+				WeekdayUTC:      int(test.maintenanceRunDate.Weekday()),
+				StartingHourUTC: test.maintenanceRunDate.Hour(),
 				DurationInHour:  8,
 			}
 
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
+			for _, status := range test.maintenanceStatuses {
+				// when
+				nextExec, untilExec := getNextLocalMaintenanceWindow(now, maintenanceWindow, status)
 
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
-		})
-
-		t.Run("when the maintenance window is this week", func(t *testing.T) {
-			// given
-			maintenanceWindowExecutionTime := dateOfTheWeekUTC(time.Saturday, 7)
-			expectedMaintenanceExecutionTime := maintenanceWindowExecutionTime
-			maintenanceWindow := scalingo.MaintenanceWindow{
-				WeekdayUTC:      int(maintenanceWindowExecutionTime.Weekday()),
-				StartingHourUTC: maintenanceWindowExecutionTime.Hour(),
-				DurationInHour:  8,
+				// Then
+				assert.Equal(t, test.expectedRunTime.Local(), nextExec)
+				assert.Equal(t, test.expectedRunTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
 			}
-
-			// when
-			nextExec, untilExec := getNextLocalMaintenanceWindow(functionExecutionTime, maintenanceWindow, maintenanceType)
-
-			// Then
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local(), nextExec)
-			assert.Equal(t, expectedMaintenanceExecutionTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
 		})
-	})
+	}
 }
 
-func dateOfTheWeekUTC(weekday time.Weekday, hour int) time.Time {
-	date := utils.BeginningOfWeek(time.Now().In(time.UTC))
-	date = date.AddDate(0, 0, int(weekday)-1)
-	date = date.Add(time.Duration(hour) * time.Hour)
+func dateAt(t *testing.T, date string) time.Time {
+	parsedTime, err := time.Parse(time.RFC850, date)
+
+	require.NoError(t, err)
 
-	return date
+	return parsedTime
 }
diff --git a/utils/time.go b/utils/time.go
@@ -28,7 +28,7 @@ func FormatMaintenanceWindowWithTimezone(maintenanceWindow scalingo.MaintenanceW
 }
 
 func ConvertDayAndHourToTimezone(weekday time.Weekday, hour int, inputLocation *time.Location, outputLocation *time.Location) (time.Weekday, int) {
-	newTimezoneDate := BeginningOfWeek(time.Now().In(inputLocation))
+	newTimezoneDate := beginningOfWeek(time.Now().In(inputLocation))
 
 	newTimezoneDate = newTimezoneDate.AddDate(0, 0, int(weekday)-1)
 	newTimezoneDate = newTimezoneDate.Add(time.Duration(hour) * time.Hour)
@@ -38,7 +38,7 @@ func ConvertDayAndHourToTimezone(weekday time.Weekday, hour int, inputLocation *
 	return newTimezoneDate.Weekday(), newTimezoneDate.Hour()
 }
 
-func BeginningOfWeek(t time.Time) time.Time {
+func beginningOfWeek(t time.Time) time.Time {
 	t = beginningOfDay(t)
 	weekday := int(t.Weekday())
 

diff --git a/utils/time_test.go b/utils/time_test.go
@@ -23,7 +23,7 @@ func Test_beginningOfDay(t *testing.T) {
 	})
 }
 
-func Test_BeginningOfWeek(t *testing.T) {
+func Test_beginningOfWeek(t *testing.T) {
 	testDates := []struct {
 		description  string
 		givenDate    time.Time
@@ -52,7 +52,7 @@ func Test_BeginningOfWeek(t *testing.T) {
 			date := testCase.givenDate
 
 			// When
-			result := BeginningOfWeek(date)
+			result := beginningOfWeek(date)
 
 			// Then
 			assert.Equal(t, testCase.expectedDate, result)