diff --git a/internal/domain/workflow/prreview_headless.go b/internal/domain/workflow/prreview_headless.go index 639d39675..dc3a2881a 100644 --- a/internal/domain/workflow/prreview_headless.go +++ b/internal/domain/workflow/prreview_headless.go @@ -17,11 +17,7 @@ type PRReviewDecision struct { func ReviewPullRequest(ctx context.Context, tc *TaskContext) (PRReviewDecision, error) { ctx, cancel := context.WithTimeout(ctx, prReviewTotalBudget.WallClock) defer cancel() - defer func() { - if tc.prReview != nil && tc.prReview.snapshotDir != "" { - _ = os.RemoveAll(tc.prReview.snapshotDir) - } - }() + defer removePRSnapshot(tc) for _, stage := range prReviewDecisionStages() { if err := ctx.Err(); err != nil { return PRReviewDecision{}, err @@ -44,3 +40,11 @@ func ReviewPullRequest(ctx context.Context, tc *TaskContext) (PRReviewDecision, SkippedPhases: append([]string(nil), tc.prReview.skippedPhases...), }, nil } + +// removePRSnapshot deletes the snapshot anatomy materialized. Every runner of +// the pr-review phases defers it, since any phase may end the run early. +func removePRSnapshot(tc *TaskContext) { + if tc.prReview != nil && tc.prReview.snapshotDir != "" { + _ = os.RemoveAll(tc.prReview.snapshotDir) + } +} diff --git a/internal/domain/workflow/prreview_own_pr.go b/internal/domain/workflow/prreview_own_pr.go index e884374fa..643fc0779 100644 --- a/internal/domain/workflow/prreview_own_pr.go +++ b/internal/domain/workflow/prreview_own_pr.go @@ -92,6 +92,7 @@ func stagePRReviewAndOpenPR(decisionStages []Stage, body func(*TaskContext) stri if tc.PRSource == nil { tc.PRSource = &localPRSource{tc: tc} } + defer removePRSnapshot(tc) for _, stage := range decisionStages { if err := stage.Run(ctx, tc); err != nil { return fmt.Errorf("pr-review (%s): %w", stage.Name, err) diff --git a/internal/domain/workflow/prreview_snapshot_test.go b/internal/domain/workflow/prreview_snapshot_test.go new file mode 100644 index 000000000..722df1f6e --- /dev/null +++ b/internal/domain/workflow/prreview_snapshot_test.go @@ -0,0 +1,31 @@ +package workflow + +import ( + "context" + "errors" + "os" + "testing" + + "github.com/samcharles93/archie-core/internal/domain/workflow/task" +) + +type failingSnapshotSource struct{ PRSource } + +func (failingSnapshotSource) Snapshot(context.Context, string, string, int, string) (string, error) { + return "", errors.New("forge unreachable") +} + +// A pr-review run that stops after anatomy must not leave its snapshot behind. +func TestPRReviewRemovesSnapshotOnEarlyStop(t *testing.T) { + tc := &TaskContext{Task: &task.Task{ID: 7}, PRSource: failingSnapshotSource{}, prReview: &prReviewState{}} + stage := stagePRReviewAndOpenPR([]Stage{stagePRAnatomy()}, func(*TaskContext) string { return "" }) + if err := stage.Run(context.Background(), tc); err == nil { + t.Fatal("expected the snapshot failure to stop the run") + } + if tc.prReview.snapshotDir == "" { + t.Fatal("anatomy did not create a snapshot directory") + } + if _, err := os.Stat(tc.prReview.snapshotDir); !errors.Is(err, os.ErrNotExist) { + t.Fatalf("snapshot directory %s still exists", tc.prReview.snapshotDir) + } +} diff --git a/internal/domain/workflow/review_steps.go b/internal/domain/workflow/review_steps.go index e44d19cfb..d8a5fb063 100644 --- a/internal/domain/workflow/review_steps.go +++ b/internal/domain/workflow/review_steps.go @@ -43,6 +43,7 @@ func newReviewPRStage(settings yaml.Node) (Stage, error) { } phases := prReviewStandaloneStages(s) return Stage{Name: ReviewPRStepName, Run: func(ctx context.Context, tc *TaskContext) error { + defer removePRSnapshot(tc) for _, phase := range phases { if err := phase.Run(ctx, tc); err != nil { return fmt.Errorf("%s (%s): %w", ReviewPRStepName, phase.Name, err)