fix: retain a failed spec's error message when appending a suite run #219 (#220)

Author: cwrm56

internal/domains/testing/infrastructure/database_converter.go

@@ -72,16 +72,23 @@ func (c *DatabaseConverter) ConvertDomainSuiteRunsToDatabase(domainSuiteRuns []d
 	return dbSuiteRuns
 }
 
+// mergeErrorMessage combines a spec's ErrorMessage and FailureMessage into the
+// single error_message column the database has. ErrorMessage (status "error")
+// takes priority; FailureMessage (status "failed", the common case) is used
+// as a fallback when ErrorMessage is empty.
+func mergeErrorMessage(errorMessage, failureMessage string) string {
+	if errorMessage == "" && failureMessage != "" {
+		return failureMessage
+	}
+	return errorMessage
+}
+
 // ConvertDomainSpecRunsToDatabase converts domain SpecRuns to database SpecRuns
 func (c *DatabaseConverter) ConvertDomainSpecRunsToDatabase(domainSpecRuns []*domain.SpecRun) []database.SpecRun {
 	dbSpecRuns := make([]database.SpecRun, len(domainSpecRuns))
 
 	for i, domainSpec := range domainSpecRuns {
-		// Combine ErrorMessage and FailureMessage into ErrorMessage
-		errorMessage := domainSpec.ErrorMessage
-		if errorMessage == "" && domainSpec.FailureMessage != "" {
-			errorMessage = domainSpec.FailureMessage
-		}
+		errorMessage := mergeErrorMessage(domainSpec.ErrorMessage, domainSpec.FailureMessage)
 
 		// Convert tags
 		dbTags := c.ConvertDomainTagsToDatabase(domainSpec.Tags)

internal/domains/testing/infrastructure/gorm_spec_run_repository.go

@@ -32,7 +32,7 @@ func (r *GormSpecRunRepository) Create(ctx context.Context, specRun *domain.Spec
 		StartTime:    specRun.StartTime,
 		EndTime:      specRun.EndTime,
 		Duration:     int64(specRun.Duration / time.Millisecond),
-		ErrorMessage: specRun.ErrorMessage,
+		ErrorMessage: mergeErrorMessage(specRun.ErrorMessage, specRun.FailureMessage),
 		StackTrace:   specRun.StackTrace,
 		RetryCount:   specRun.RetryCount,
 		IsFlaky:      specRun.IsFlaky,
@@ -62,7 +62,7 @@ func (r *GormSpecRunRepository) CreateBatch(ctx context.Context, specRuns []*dom
 			StartTime:    specRun.StartTime,
 			EndTime:      specRun.EndTime,
 			Duration:     int64(specRun.Duration / time.Millisecond),
-			ErrorMessage: specRun.ErrorMessage,
+			ErrorMessage: mergeErrorMessage(specRun.ErrorMessage, specRun.FailureMessage),
 			StackTrace:   specRun.StackTrace,
 			RetryCount:   specRun.RetryCount,
 			IsFlaky:      specRun.IsFlaky,

internal/domains/testing/infrastructure/gorm_spec_run_repository_test.go

@@ -112,6 +112,43 @@ var _ = Describe("GormSpecRunRepository", func() {
 			})
 		})
 
+		Context("when the spec run has only a FailureMessage (status \"failed\")", func() {
+			It("should persist FailureMessage into the error_message column", func() {
+				endTime := time.Now().Add(time.Second)
+				failedSpec := &domain.SpecRun{
+					SuiteRunID:     1,
+					Name:           "test-spec-failed",
+					Status:         "failed",
+					StartTime:      time.Now(),
+					EndTime:        &endTime,
+					Duration:       time.Second,
+					FailureMessage: "expected 2 to equal 3",
+				}
+
+				mock.ExpectBegin()
+				mock.ExpectQuery(regexp.QuoteMeta(`INSERT INTO "spec_runs"`)).
+					WithArgs(
+						AnyTime{}, AnyTime{}, nil,
+						failedSpec.SuiteRunID,
+						failedSpec.Name,
+						failedSpec.Status,
+						AnyTime{}, AnyTime{},
+						int64(1000),
+						failedSpec.FailureMessage,
+						failedSpec.StackTrace,
+						failedSpec.RetryCount,
+						failedSpec.IsFlaky,
+					).
+					WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(456))
+				mock.ExpectCommit()
+
+				err := repository.Create(ctx, failedSpec)
+
+				Expect(err).NotTo(HaveOccurred())
+				Expect(failedSpec.ID).To(Equal(uint(456)))
+			})
+		})
+
 		Context("when creation fails", func() {
 			It("should return an error", func() {
 				mock.ExpectBegin()
@@ -180,6 +217,40 @@ var _ = Describe("GormSpecRunRepository", func() {
 			})
 		})
 
+		Context("when the batch has a spec run with only a FailureMessage", func() {
+			It("should persist FailureMessage into the error_message column", func() {
+				now := time.Now()
+				end := now.Add(time.Second)
+
+				specRuns := []*domain.SpecRun{
+					{
+						SuiteRunID:     1,
+						Name:           "test-spec-failed",
+						Status:         "failed",
+						StartTime:      now,
+						EndTime:        &end,
+						Duration:       time.Second,
+						FailureMessage: "expected 2 to equal 3",
+					},
+				}
+
+				mock.ExpectBegin()
+				mock.ExpectQuery(regexp.QuoteMeta(`INSERT INTO "spec_runs"`)).
+					WithArgs(
+						AnyTime{}, AnyTime{}, nil,
+						uint(1), "test-spec-failed", "failed", AnyTime{}, AnyTime{}, int64(1000),
+						"expected 2 to equal 3", "", 0, false,
+					).
+					WillReturnRows(sqlmock.NewRows([]string{"id"}).AddRow(1))
+				mock.ExpectCommit()
+
+				err := repository.CreateBatch(ctx, specRuns)
+
+				Expect(err).NotTo(HaveOccurred())
+				Expect(specRuns[0].ID).To(Equal(uint(1)))
+			})
+		})
+
 		Context("when batch creation fails", func() {
 			It("should return an error", func() {
 				now := time.Now()