test(maintenance): use tab style for testing

Scalingo · Jul 17, 2023 · d5fb53a · d5fb53a
1 parent 5538524
commit d5fb53a
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 172 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
@@ -11,178 +11,59 @@ import (
 )
 
 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)
-		})
-
-		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)
-			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 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)
-		})
-	})
+	now := dateOfTheWeekUTC(time.Wednesday, 8)
+
+	tests := map[string]struct {
+		maintenanceTimeData        time.Time
+		expectedMaintenanceRunTime func(time.Time, scalingo.MaintenanceStatus) time.Time
+	}{
+		"it should be executed next week": {
+			maintenanceTimeData: dateOfTheWeekUTC(time.Sunday, 0),
+			expectedMaintenanceRunTime: func(maintenanceData time.Time, _ scalingo.MaintenanceStatus) time.Time {
+				return maintenanceData.AddDate(0, 0, 7)
+			},
+		},
+		"it should be ongoing": {
+			maintenanceTimeData: dateOfTheWeekUTC(time.Wednesday, 7),
+			expectedMaintenanceRunTime: func(maintenanceData time.Time, maintenanceType scalingo.MaintenanceStatus) time.Time {
+				if maintenanceType == scalingo.MaintenanceStatusScheduled {
+					return maintenanceData.AddDate(0, 0, 7)
+				}
+				return maintenanceData
+			},
+		},
+		"it should be executed this week": {
+			maintenanceTimeData: dateOfTheWeekUTC(time.Saturday, 7),
+			expectedMaintenanceRunTime: func(maintenanceData time.Time, maintenanceType scalingo.MaintenanceStatus) time.Time {
+				return maintenanceData
+			},
+		},
+	}
+	for _, maintenanceType := range []scalingo.MaintenanceStatus{
+		scalingo.MaintenanceStatusNotified,
+		scalingo.MaintenanceStatusQueued,
+		scalingo.MaintenanceStatusScheduled,
+	} {
+		for testName, test := range tests {
+			t.Run("when the maintenance is "+string(maintenanceType)+"/"+testName, func(t *testing.T) {
+				// given
+				expectedRunTime := test.expectedMaintenanceRunTime(test.maintenanceTimeData, maintenanceType)
+
+				maintenanceWindow := scalingo.MaintenanceWindow{
+					WeekdayUTC:      int(test.maintenanceTimeData.Weekday()),
+					StartingHourUTC: test.maintenanceTimeData.Hour(),
+					DurationInHour:  8,
+				}
+
+				// when
+				nextExec, untilExec := getNextLocalMaintenanceWindow(now, maintenanceWindow, maintenanceType)
+
+				// Then
+				assert.Equal(t, expectedRunTime.Local(), nextExec)
+				assert.Equal(t, expectedRunTime.Local().Add(time.Duration(maintenanceWindow.DurationInHour)*time.Hour), untilExec)
+			})
+		}
+	}
 }
 
 func dateOfTheWeekUTC(weekday time.Weekday, hour int) time.Time {