|
| 1 | +package workflow |
| 2 | + |
| 3 | +import ( |
| 4 | + "strings" |
| 5 | + "testing" |
| 6 | + |
| 7 | + "github.com/githubnext/gh-aw/pkg/constants" |
| 8 | +) |
| 9 | + |
| 10 | +// TestRenderBuiltinMCPServerBlock verifies the shared helper function that eliminated code duplication |
| 11 | +func TestRenderBuiltinMCPServerBlock(t *testing.T) { |
| 12 | + tests := []struct { |
| 13 | + name string |
| 14 | + serverID string |
| 15 | + command string |
| 16 | + args []string |
| 17 | + envVars []string |
| 18 | + isLast bool |
| 19 | + includeCopilotFields bool |
| 20 | + expectedContent []string |
| 21 | + unexpectedContent []string |
| 22 | + }{ |
| 23 | + { |
| 24 | + name: "SafeOutputs Copilot format", |
| 25 | + serverID: constants.SafeOutputsMCPServerID, |
| 26 | + command: "node", |
| 27 | + args: []string{"/tmp/gh-aw/safeoutputs/mcp-server.cjs"}, |
| 28 | + envVars: []string{ |
| 29 | + "GH_AW_SAFE_OUTPUTS", |
| 30 | + "GH_AW_ASSETS_BRANCH", |
| 31 | + }, |
| 32 | + isLast: true, |
| 33 | + includeCopilotFields: true, |
| 34 | + expectedContent: []string{ |
| 35 | + `"safeoutputs": {`, |
| 36 | + `"type": "local"`, |
| 37 | + `"command": "node"`, |
| 38 | + `"args": ["/tmp/gh-aw/safeoutputs/mcp-server.cjs"]`, |
| 39 | + `"tools": ["*"]`, |
| 40 | + `"env": {`, |
| 41 | + `"GH_AW_SAFE_OUTPUTS": "\${GH_AW_SAFE_OUTPUTS}"`, |
| 42 | + `"GH_AW_ASSETS_BRANCH": "\${GH_AW_ASSETS_BRANCH}"`, |
| 43 | + ` }`, // isLast = true, no comma |
| 44 | + }, |
| 45 | + unexpectedContent: []string{}, |
| 46 | + }, |
| 47 | + { |
| 48 | + name: "SafeOutputs Claude format", |
| 49 | + serverID: constants.SafeOutputsMCPServerID, |
| 50 | + command: "node", |
| 51 | + args: []string{"/tmp/gh-aw/safeoutputs/mcp-server.cjs"}, |
| 52 | + envVars: []string{ |
| 53 | + "GH_AW_SAFE_OUTPUTS", |
| 54 | + "GH_AW_ASSETS_BRANCH", |
| 55 | + }, |
| 56 | + isLast: false, |
| 57 | + includeCopilotFields: false, |
| 58 | + expectedContent: []string{ |
| 59 | + `"safeoutputs": {`, |
| 60 | + `"command": "node"`, |
| 61 | + `"args": ["/tmp/gh-aw/safeoutputs/mcp-server.cjs"]`, |
| 62 | + `"env": {`, |
| 63 | + `"GH_AW_SAFE_OUTPUTS": "$GH_AW_SAFE_OUTPUTS"`, |
| 64 | + `"GH_AW_ASSETS_BRANCH": "$GH_AW_ASSETS_BRANCH"`, |
| 65 | + ` },`, // isLast = false, with comma |
| 66 | + }, |
| 67 | + unexpectedContent: []string{ |
| 68 | + `"type"`, |
| 69 | + `"tools"`, |
| 70 | + `\\${`, // Should not have backslash-escaped variables in Claude format |
| 71 | + }, |
| 72 | + }, |
| 73 | + { |
| 74 | + name: "AgenticWorkflows Copilot format", |
| 75 | + serverID: "agentic_workflows", |
| 76 | + command: "gh", |
| 77 | + args: []string{"aw", "mcp-server"}, |
| 78 | + envVars: []string{"GITHUB_TOKEN"}, |
| 79 | + isLast: false, |
| 80 | + includeCopilotFields: true, |
| 81 | + expectedContent: []string{ |
| 82 | + `"agentic_workflows": {`, |
| 83 | + `"type": "local"`, |
| 84 | + `"command": "gh"`, |
| 85 | + `"args": ["aw", "mcp-server"]`, |
| 86 | + `"tools": ["*"]`, |
| 87 | + `"env": {`, |
| 88 | + `"GITHUB_TOKEN": "\${GITHUB_TOKEN}"`, |
| 89 | + ` },`, // isLast = false, with comma |
| 90 | + }, |
| 91 | + unexpectedContent: []string{}, |
| 92 | + }, |
| 93 | + { |
| 94 | + name: "AgenticWorkflows Claude format", |
| 95 | + serverID: "agentic_workflows", |
| 96 | + command: "gh", |
| 97 | + args: []string{"aw", "mcp-server"}, |
| 98 | + envVars: []string{"GITHUB_TOKEN"}, |
| 99 | + isLast: true, |
| 100 | + includeCopilotFields: false, |
| 101 | + expectedContent: []string{ |
| 102 | + `"agentic_workflows": {`, |
| 103 | + `"command": "gh"`, |
| 104 | + `"args": ["aw", "mcp-server"]`, |
| 105 | + `"env": {`, |
| 106 | + `"GITHUB_TOKEN": "$GITHUB_TOKEN"`, |
| 107 | + ` }`, // isLast = true, no comma |
| 108 | + }, |
| 109 | + unexpectedContent: []string{ |
| 110 | + `"type"`, |
| 111 | + `"tools"`, |
| 112 | + `\\${`, // Should not have backslash-escaped variables in Claude format |
| 113 | + }, |
| 114 | + }, |
| 115 | + { |
| 116 | + name: "Multiple args formatting", |
| 117 | + serverID: "test_server", |
| 118 | + command: "testcmd", |
| 119 | + args: []string{"arg1", "arg2", "arg3"}, |
| 120 | + envVars: []string{"VAR1", "VAR2"}, |
| 121 | + isLast: false, |
| 122 | + includeCopilotFields: true, |
| 123 | + expectedContent: []string{ |
| 124 | + `"test_server": {`, |
| 125 | + `"args": ["arg1", "arg2", "arg3"]`, |
| 126 | + `"VAR1": "\${VAR1}"`, |
| 127 | + `"VAR2": "\${VAR2}"`, |
| 128 | + }, |
| 129 | + unexpectedContent: []string{}, |
| 130 | + }, |
| 131 | + } |
| 132 | + |
| 133 | + for _, tt := range tests { |
| 134 | + t.Run(tt.name, func(t *testing.T) { |
| 135 | + var output strings.Builder |
| 136 | + |
| 137 | + renderBuiltinMCPServerBlock(&output, tt.serverID, tt.command, tt.args, tt.envVars, tt.isLast, tt.includeCopilotFields) |
| 138 | + |
| 139 | + result := output.String() |
| 140 | + |
| 141 | + // Check expected content |
| 142 | + for _, expected := range tt.expectedContent { |
| 143 | + if !strings.Contains(result, expected) { |
| 144 | + t.Errorf("Expected content not found: %q\nActual output:\n%s", expected, result) |
| 145 | + } |
| 146 | + } |
| 147 | + |
| 148 | + // Check unexpected content |
| 149 | + for _, unexpected := range tt.unexpectedContent { |
| 150 | + if strings.Contains(result, unexpected) { |
| 151 | + t.Errorf("Unexpected content found: %q\nActual output:\n%s", unexpected, result) |
| 152 | + } |
| 153 | + } |
| 154 | + }) |
| 155 | + } |
| 156 | +} |
| 157 | + |
| 158 | +// TestBuiltinMCPServerBlockCommaHandling specifically tests comma handling for isLast parameter |
| 159 | +func TestBuiltinMCPServerBlockCommaHandling(t *testing.T) { |
| 160 | + tests := []struct { |
| 161 | + name string |
| 162 | + isLast bool |
| 163 | + expectedEnding string |
| 164 | + }{ |
| 165 | + { |
| 166 | + name: "Not last - should have comma", |
| 167 | + isLast: false, |
| 168 | + expectedEnding: " },\n", |
| 169 | + }, |
| 170 | + { |
| 171 | + name: "Is last - should not have comma", |
| 172 | + isLast: true, |
| 173 | + expectedEnding: " }\n", |
| 174 | + }, |
| 175 | + } |
| 176 | + |
| 177 | + for _, tt := range tests { |
| 178 | + t.Run(tt.name, func(t *testing.T) { |
| 179 | + var output strings.Builder |
| 180 | + |
| 181 | + renderBuiltinMCPServerBlock(&output, "test", "node", []string{"arg"}, []string{"VAR"}, tt.isLast, false) |
| 182 | + |
| 183 | + result := output.String() |
| 184 | + |
| 185 | + if !strings.HasSuffix(result, tt.expectedEnding) { |
| 186 | + t.Errorf("Expected ending %q but got:\n%s", tt.expectedEnding, result) |
| 187 | + } |
| 188 | + }) |
| 189 | + } |
| 190 | +} |
| 191 | + |
| 192 | +// TestBuiltinMCPServerBlockEnvVarOrdering tests that environment variables maintain order |
| 193 | +func TestBuiltinMCPServerBlockEnvVarOrdering(t *testing.T) { |
| 194 | + envVars := []string{"VAR_A", "VAR_B", "VAR_C", "VAR_D"} |
| 195 | + |
| 196 | + var output strings.Builder |
| 197 | + renderBuiltinMCPServerBlock(&output, "test", "cmd", []string{"arg"}, envVars, true, false) |
| 198 | + |
| 199 | + result := output.String() |
| 200 | + |
| 201 | + // Find positions of each variable in the output |
| 202 | + positions := make(map[string]int) |
| 203 | + for _, envVar := range envVars { |
| 204 | + pos := strings.Index(result, `"`+envVar+`"`) |
| 205 | + if pos == -1 { |
| 206 | + t.Errorf("Environment variable %s not found in output", envVar) |
| 207 | + continue |
| 208 | + } |
| 209 | + positions[envVar] = pos |
| 210 | + } |
| 211 | + |
| 212 | + // Verify ordering |
| 213 | + for i := 0; i < len(envVars)-1; i++ { |
| 214 | + currentVar := envVars[i] |
| 215 | + nextVar := envVars[i+1] |
| 216 | + |
| 217 | + if positions[currentVar] >= positions[nextVar] { |
| 218 | + t.Errorf("Environment variables out of order: %s should come before %s", currentVar, nextVar) |
| 219 | + } |
| 220 | + } |
| 221 | +} |
0 commit comments