Fix broken integration tests by stripping YAML comment header before assertions (#4890)

* Initial plan

* Fix broken tests by stripping comment header before string checks

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Co-authored-by: Peli de Halleux <pelikhan@users.noreply.github.com>

Author: 3 people

pkg/testutil/tempdir.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 	"sync"
 	"testing"
 	"time"
@@ -64,3 +65,18 @@ func TempDir(t *testing.T, pattern string) string {
 
 	return tempDir
 }
+
+// StripYAMLCommentHeader removes the comment header from generated YAML files
+// and returns only the non-comment YAML content. This is useful for tests that
+// need to verify content without matching strings in the comment header.
+func StripYAMLCommentHeader(yamlContent string) string {
+	lines := strings.Split(yamlContent, "\n")
+	for i, line := range lines {
+		// Find the first non-comment, non-empty line (start of actual YAML)
+		trimmed := strings.TrimSpace(line)
+		if trimmed != "" && !strings.HasPrefix(trimmed, "#") {
+			return strings.Join(lines[i:], "\n")
+		}
+	}
+	return yamlContent
+}

pkg/testutil/tempdir_test.go

@@ -82,3 +82,57 @@ func TestTempDirCleanup(t *testing.T) {
 		t.Error("tempDir should have been set by subtest")
 	}
 }
+
+func TestStripYAMLCommentHeader(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected string
+	}{
+		{
+			name: "strips comment header",
+			input: `#
+# Header comment
+# More comments
+#
+name: my-workflow
+on: push`,
+			expected: `name: my-workflow
+on: push`,
+		},
+		{
+			name:     "handles no comments",
+			input:    `name: my-workflow`,
+			expected: `name: my-workflow`,
+		},
+		{
+			name: "handles empty lines before YAML",
+			input: `#
+# Comment
+
+name: my-workflow`,
+			expected: `name: my-workflow`,
+		},
+		{
+			name:     "handles empty input",
+			input:    "",
+			expected: "",
+		},
+		{
+			name: "handles only comments",
+			input: `# Only comments
+# No YAML`,
+			expected: `# Only comments
+# No YAML`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := testutil.StripYAMLCommentHeader(tt.input)
+			if result != tt.expected {
+				t.Errorf("StripYAMLCommentHeader(%q) = %q, want %q", tt.input, result, tt.expected)
+			}
+		})
+	}
+}

pkg/workflow/github_token_precedence_integration_test.go

@@ -102,15 +102,17 @@ Test that safe-outputs github-token overrides top-level.
 		}
 
 		yamlContent := string(content)
+		// Strip the comment header to check only the actual YAML content
+		yamlContentNoComments := testutil.StripYAMLCommentHeader(yamlContent)
 
 		// Verify that safe-outputs token is used in the create_issue job
-		if !strings.Contains(yamlContent, "github-token: ${{ secrets.SAFE_OUTPUTS_PAT }}") {
+		if !strings.Contains(yamlContentNoComments, "github-token: ${{ secrets.SAFE_OUTPUTS_PAT }}") {
 			t.Error("Expected safe-outputs github-token to be used in create_issue job")
 			t.Logf("Generated YAML:\n%s", yamlContent)
 		}
 
 		// Verify that top-level token is NOT used in safe-outputs job
-		if strings.Contains(yamlContent, "github-token: ${{ secrets.TOPLEVEL_PAT }}") {
+		if strings.Contains(yamlContentNoComments, "github-token: ${{ secrets.TOPLEVEL_PAT }}") {
 			t.Error("Top-level github-token should not be used when safe-outputs token is present")
 		}
 	})

pkg/workflow/neutral_tools_integration_test.go

@@ -56,6 +56,8 @@ Test workflow with neutral tools format.
 		t.Fatalf("Failed to read compiled workflow: %v", err)
 	}
 	yamlContent := string(yamlBytes)
+	// Strip the comment header to check only the actual YAML content
+	yamlContentNoComments := testutil.StripYAMLCommentHeader(yamlContent)
 
 	// Should contain Claude tools that were converted from neutral tools
 	expectedClaudeTools := []string{
@@ -95,8 +97,8 @@ Test workflow with neutral tools format.
 		}
 	}
 
-	// Verify that the old format is not present in the compiled output
-	if strings.Contains(yamlContent, "bash:") || strings.Contains(yamlContent, "web-fetch:") {
+	// Verify that the old format is not present in the compiled output (excluding comments)
+	if strings.Contains(yamlContentNoComments, "bash:") || strings.Contains(yamlContentNoComments, "web-fetch:") {
 		t.Error("Compiled YAML should not contain neutral tool names directly")
 	}
 }