stub internal test

mtojek · mtojek · commit 8e8ab490866f · 2024-09-12T10:58:56.000+02:00
diff --git a/coderd/notifications/reports/generator.go b/coderd/notifications/reports/generator.go
@@ -28,7 +28,7 @@ const (
 	delay = 15 * time.Minute
 )
 
-func NewReportGenerator(ctx context.Context, logger slog.Logger, db database.Store, enqueur notifications.Enqueuer, clk quartz.Clock) io.Closer {
+func NewReportGenerator(ctx context.Context, logger slog.Logger, db database.Store, enqueuer notifications.Enqueuer, clk quartz.Clock) io.Closer {
 	closed := make(chan struct{})
 
 	ctx, cancelFunc := context.WithCancel(ctx)
@@ -51,7 +51,7 @@ func NewReportGenerator(ctx context.Context, logger slog.Logger, db database.Sto
 				return nil
 			}
 
-			err = reportFailedWorkspaceBuilds(ctx, logger, db, enqueur, clk)
+			err = reportFailedWorkspaceBuilds(ctx, logger, db, enqueuer, clk)
 			if err != nil {
 				logger.Debug(ctx, "unable to report failed workspace builds")
 				return err
@@ -98,8 +98,9 @@ func (i *reportGenerator) Close() error {
 	return nil
 }
 
+const failedWorkspaceBuildsReportFrequencyDays = 7
+
 func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db database.Store, enqueuer notifications.Enqueuer, clk quartz.Clock) error {
-	const frequencyDays = 7
 
 	statsRows, err := db.GetWorkspaceBuildStatsByTemplates(ctx, dbtime.Time(clk.Now()).UTC())
 	if err != nil {
@@ -121,7 +122,7 @@ func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db dat
 			}
 
 			// There are some failed builds, so we have to prepare input data for the report.
-			reportData = buildDataForReportFailedWorkspaceBuilds(frequencyDays, stats, failedBuilds)
+			reportData = buildDataForReportFailedWorkspaceBuilds(failedWorkspaceBuildsReportFrequencyDays, stats, failedBuilds)
 		}
 
 		templateAdmins, err := findTemplateAdmins(ctx, db, stats)
@@ -139,7 +140,7 @@ func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db dat
 				return xerrors.Errorf("unable to get recent report generator log for user: %w", err)
 			}
 
-			if !reportLog.LastGeneratedAt.IsZero() && reportLog.LastGeneratedAt.Add(frequencyDays*24*time.Hour).After(clk.Now()) {
+			if !reportLog.LastGeneratedAt.IsZero() && reportLog.LastGeneratedAt.Add(failedWorkspaceBuildsReportFrequencyDays*24*time.Hour).After(clk.Now()) {
 				// report generated recently, no need to send it now
 				err = db.UpsertReportGeneratorLog(ctx, database.UpsertReportGeneratorLogParams{
 					UserID:                 templateAdmin.ID,
@@ -196,7 +197,7 @@ func reportFailedWorkspaceBuilds(ctx context.Context, logger slog.Logger, db dat
 
 	err = db.DeleteOldReportGeneratorLogs(ctx, database.DeleteOldReportGeneratorLogsParams{
 		NotificationTemplateID: notifications.TemplateWorkspaceBuildsFailedReport,
-		FrequencyDays:          frequencyDays,
+		FrequencyDays:          failedWorkspaceBuildsReportFrequencyDays,
 	})
 	if err != nil {
 		return xerrors.Errorf("unable to delete old report generator logs: %w", err)
diff --git a/coderd/notifications/reports/generator_internal_test.go b/coderd/notifications/reports/generator_internal_test.go
@@ -0,0 +1,37 @@
+package reports
+
+import "testing"
+
+func TestReportFailedWorkspaceBuilds(t *testing.T) {
+	t.Parallel()
+
+	t.Run("FailedBuilds_TemplateAdminOptIn_FirstRun_Report", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+
+	t.Run("FailedBuilds_TemplateAdminOptIn_SecondRunTooEarly_NoReport", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+
+	t.Run("FailedBuilds_TemplateAdminOptIn_SecondRun_Report", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+
+	t.Run("NoFailedBuilds_TemplateAdminIn_NoReport", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+
+	t.Run("FailedBuilds_TemplateAdminOptOut_NoReport", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+
+	t.Run("StaleFailedBuilds_TemplateAdminOptIn_NoReport_Cleanup", func(t *testing.T) {
+		t.Parallel()
+		// TODO
+	})
+}
