refactor: failure propagation in reports (#1960) (#1961)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
Co-authored-by: Charles-Edouard Brétéché <[email protected]>

Author: gcp-cherry-pick-bot[bot]

pkg/model/report.go

@@ -28,13 +28,17 @@ type TestReport struct {
 	EndTime    time.Time
 	Namespace  string
 	Skipped    bool
+	Failed     bool
 	Steps      []StepReport
 }
 
 func (r *TestReport) Add(report StepReport) {
 	if report.Name == "" {
 		report.Name = fmt.Sprintf("step %d", len(r.Steps)+1)
 	}
+	if report.Failed {
+		r.Failed = true
+	}
 	r.Steps = append(r.Steps, report)
 }
 
@@ -50,12 +54,15 @@ func (r *StepReport) Add(report OperationReport) {
 	if report.Name == "" {
 		report.Name = fmt.Sprintf("operation %d", len(r.Operations)+1)
 	}
+	if report.Err != nil {
+		r.Failed = true
+	}
 	r.Operations = append(r.Operations, report)
 }
 
 type OperationReport struct {
 	Name      string
 	StartTime time.Time
 	EndTime   time.Time
-	Failed    bool
+	Err       error
 }

pkg/report/junit.go

@@ -36,16 +36,22 @@ func addTestSuite(testSuites *junit.Testsuites, report model.TestReport) {
 	}
 	suite.SetTimestamp(report.StartTime)
 	suite.AddProperty("namespace", report.Namespace)
+	if report.Skipped {
+		suite.Skipped = suite.Skipped + 1
+	}
 	for _, report := range report.Steps {
 		testCase := junit.Testcase{
 			Name: report.Name,
 			Time: durationInSecondsString(report.StartTime, report.EndTime),
 		}
-		// if report.Skipped {
-		// 	testCase.Skipped = &junit.Result{}
-		// }
 		if report.Failed {
 			testCase.Failure = &junit.Result{}
+			for _, report := range report.Operations {
+				if report.Err != nil {
+					testCase.Failure.Message = report.Err.Error()
+					break
+				}
+			}
 		}
 		suite.AddTestcase(testCase)
 	}

pkg/runner/processors/operation.go

@@ -29,17 +29,16 @@ func newOperation(
 	}
 }
 
-func (o operation) execute(ctx context.Context, tc engine.Context, stepReport *model.StepReport) (outputs.Outputs, error) {
+func (o operation) execute(ctx context.Context, tc engine.Context, stepReport *model.StepReport) (_ outputs.Outputs, err error) {
 	report := model.OperationReport{
 		StartTime: time.Now(),
 	}
 	defer func() {
 		report.EndTime = time.Now()
+		report.Err = err
 		stepReport.Add(report)
 	}()
-	tc = tc.WithBinding(ctx, "operation", o.info)
-	operation, timeout, tc, err := o.operation(ctx, tc)
-	if err != nil {
+	if operation, timeout, tc, err := o.operation(ctx, tc.WithBinding(ctx, "operation", o.info)); err != nil {
 		logging.Log(ctx, logging.Internal, logging.ErrorStatus, color.BoldRed, logging.ErrSection(err))
 		return nil, err
 	} else {

pkg/runner/processors/step.go

@@ -99,9 +99,6 @@ func (p *stepProcessor) Run(ctx context.Context, namespacer namespacer.Namespace
 	}
 	defer func() {
 		report.EndTime = time.Now()
-		if t.Failed() {
-			report.Failed = true
-		}
 		p.report.Add(report)
 	}()
 	logger := logging.FromContext(ctx)