|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | + *--------------------------------------------------------------------------------------------*/ |
| 4 | + |
| 5 | +using Xunit; |
| 6 | + |
| 7 | +namespace GitHub.Copilot.SDK.Test; |
| 8 | + |
| 9 | +/// <summary> |
| 10 | +/// Regression tests for the Environment merge-vs-replace bug (Issue #441). |
| 11 | +/// |
| 12 | +/// Background: |
| 13 | +/// Before the fix, <see cref="CopilotClientOptions.Environment"/> was handled with: |
| 14 | +/// |
| 15 | +/// startInfo.Environment.Clear(); // ← BUG: wiped PATH, SystemRoot, COMSPEC, TEMP, etc. |
| 16 | +/// foreach (var (key, value) in options.Environment) |
| 17 | +/// startInfo.Environment[key] = value; |
| 18 | +/// |
| 19 | +/// ProcessStartInfo.Environment is pre-populated with the current process's inherited |
| 20 | +/// environment. The Clear() call threw it all away, so supplying even ONE custom key |
| 21 | +/// caused the Node.js-based CLI subprocess to crash on Windows because essential system |
| 22 | +/// variables (PATH, SystemRoot, COMSPEC) were gone. |
| 23 | +/// |
| 24 | +/// After the fix, user-supplied keys are merged (override or add) into the inherited |
| 25 | +/// environment -- the CLI subprocess receives all inherited vars plus any overrides. |
| 26 | +/// |
| 27 | +/// How the tests prove the fix: |
| 28 | +/// Every test below that provides a non-null Environment dict would have thrown an |
| 29 | +/// IOException ("CLI process exited unexpectedly") BEFORE the fix. After the fix they |
| 30 | +/// all pass because PATH/SystemRoot/COMSPEC remain available to the subprocess. |
| 31 | +/// </summary> |
| 32 | +public class EnvironmentTests |
| 33 | +{ |
| 34 | + // ── Null / empty cases ──────────────────────────────────────────────────── |
| 35 | + |
| 36 | + [Fact] |
| 37 | + public void Environment_DefaultsToNull() |
| 38 | + { |
| 39 | + // Verify the documented default: null means "fully inherit from parent process". |
| 40 | + var options = new CopilotClientOptions(); |
| 41 | + Assert.Null(options.Environment); |
| 42 | + } |
| 43 | + |
| 44 | + [Fact] |
| 45 | + public async Task Should_Start_When_Environment_Is_Null() |
| 46 | + { |
| 47 | + // Baseline: null Environment → all inherited vars are present → CLI starts. |
| 48 | + using var client = new CopilotClient(new CopilotClientOptions |
| 49 | + { |
| 50 | + UseStdio = true, |
| 51 | + Environment = null, |
| 52 | + }); |
| 53 | + |
| 54 | + try |
| 55 | + { |
| 56 | + await client.StartAsync(); |
| 57 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 58 | + |
| 59 | + var pong = await client.PingAsync("null-env"); |
| 60 | + Assert.Equal("pong: null-env", pong.Message); |
| 61 | + |
| 62 | + await client.StopAsync(); |
| 63 | + } |
| 64 | + finally |
| 65 | + { |
| 66 | + await client.ForceStopAsync(); |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + [Fact] |
| 71 | + public async Task Should_Start_When_Environment_Is_An_Empty_Dictionary() |
| 72 | + { |
| 73 | + // An empty dictionary supplies no keys, so the loop in Client.cs runs zero |
| 74 | + // iterations -- the inherited environment is completely unchanged. |
| 75 | + // Before the fix: Clear() was still called → crash. |
| 76 | + // After the fix: no Clear(); inherited env untouched → CLI starts normally. |
| 77 | + using var client = new CopilotClient(new CopilotClientOptions |
| 78 | + { |
| 79 | + UseStdio = true, |
| 80 | + Environment = new Dictionary<string, string>(), |
| 81 | + }); |
| 82 | + |
| 83 | + try |
| 84 | + { |
| 85 | + await client.StartAsync(); |
| 86 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 87 | + |
| 88 | + var pong = await client.PingAsync("empty-env"); |
| 89 | + Assert.Equal("pong: empty-env", pong.Message); |
| 90 | + |
| 91 | + await client.StopAsync(); |
| 92 | + } |
| 93 | + finally |
| 94 | + { |
| 95 | + await client.ForceStopAsync(); |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + // ── Partial-dict merge cases ────────────────────────────────────────────── |
| 100 | + |
| 101 | + [Fact] |
| 102 | + public async Task Should_Start_When_Environment_Has_One_Custom_Key() |
| 103 | + { |
| 104 | + // This is the canonical regression test for Issue #441. |
| 105 | + // |
| 106 | + // The user provides a single custom environment variable -- a perfectly |
| 107 | + // reasonable thing to do (e.g. to set COPILOT_API_URL, a proxy, etc.). |
| 108 | + // |
| 109 | + // Before the fix: |
| 110 | + // startInfo.Environment.Clear() ← removes PATH, SystemRoot, COMSPEC … |
| 111 | + // startInfo.Environment["MY_KEY"] = "value" |
| 112 | + // → CLI subprocess starts with only MY_KEY → crashes immediately |
| 113 | + // → StartAsync() throws IOException |
| 114 | + // |
| 115 | + // After the fix: |
| 116 | + // startInfo.Environment["MY_KEY"] = "value" (merged) |
| 117 | + // → CLI subprocess retains all inherited vars + MY_KEY → starts normally |
| 118 | + using var client = new CopilotClient(new CopilotClientOptions |
| 119 | + { |
| 120 | + UseStdio = true, |
| 121 | + Environment = new Dictionary<string, string> |
| 122 | + { |
| 123 | + ["MY_CUSTOM_SDK_VAR"] = "hello_world", |
| 124 | + }, |
| 125 | + }); |
| 126 | + |
| 127 | + try |
| 128 | + { |
| 129 | + // This line would throw before the fix: |
| 130 | + // System.IO.IOException: CLI process exited unexpectedly … |
| 131 | + await client.StartAsync(); |
| 132 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 133 | + |
| 134 | + var pong = await client.PingAsync("one-key-env"); |
| 135 | + Assert.Equal("pong: one-key-env", pong.Message); |
| 136 | + |
| 137 | + await client.StopAsync(); |
| 138 | + } |
| 139 | + finally |
| 140 | + { |
| 141 | + await client.ForceStopAsync(); |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + [Fact] |
| 146 | + public async Task Should_Start_When_Environment_Has_Multiple_Custom_Keys() |
| 147 | + { |
| 148 | + // Multiple custom keys, none of them system variables. |
| 149 | + // Proves that the merge works for an arbitrary number of custom entries. |
| 150 | + using var client = new CopilotClient(new CopilotClientOptions |
| 151 | + { |
| 152 | + UseStdio = true, |
| 153 | + Environment = new Dictionary<string, string> |
| 154 | + { |
| 155 | + ["SDK_TEST_VAR_A"] = "alpha", |
| 156 | + ["SDK_TEST_VAR_B"] = "beta", |
| 157 | + ["SDK_TEST_VAR_C"] = "gamma", |
| 158 | + }, |
| 159 | + }); |
| 160 | + |
| 161 | + try |
| 162 | + { |
| 163 | + await client.StartAsync(); |
| 164 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 165 | + |
| 166 | + var pong = await client.PingAsync("multi-key-env"); |
| 167 | + Assert.Equal("pong: multi-key-env", pong.Message); |
| 168 | + |
| 169 | + await client.StopAsync(); |
| 170 | + } |
| 171 | + finally |
| 172 | + { |
| 173 | + await client.ForceStopAsync(); |
| 174 | + } |
| 175 | + } |
| 176 | + |
| 177 | + [Fact] |
| 178 | + public async Task Should_Start_When_Environment_Overrides_An_Inherited_Key() |
| 179 | + { |
| 180 | + // Overriding an EXISTING env var (e.g. COPILOT_LOG_LEVEL) should work: |
| 181 | + // the override takes effect, and all other inherited vars remain. |
| 182 | + using var client = new CopilotClient(new CopilotClientOptions |
| 183 | + { |
| 184 | + UseStdio = true, |
| 185 | + Environment = new Dictionary<string, string> |
| 186 | + { |
| 187 | + // Override a var that is almost certainly already present in the |
| 188 | + // parent process environment so we exercise the "override" code path. |
| 189 | + ["PATH"] = System.Environment.GetEnvironmentVariable("PATH") ?? "/usr/bin", |
| 190 | + }, |
| 191 | + }); |
| 192 | + |
| 193 | + try |
| 194 | + { |
| 195 | + await client.StartAsync(); |
| 196 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 197 | + |
| 198 | + var pong = await client.PingAsync("override-inherited-key"); |
| 199 | + Assert.Equal("pong: override-inherited-key", pong.Message); |
| 200 | + |
| 201 | + await client.StopAsync(); |
| 202 | + } |
| 203 | + finally |
| 204 | + { |
| 205 | + await client.ForceStopAsync(); |
| 206 | + } |
| 207 | + } |
| 208 | + |
| 209 | + // ── Verifying the merge semantics via the harness pattern ────────────── |
| 210 | + |
| 211 | + [Fact] |
| 212 | + public async Task TestHarness_GetEnvironment_Pattern_Works_After_Fix() |
| 213 | + { |
| 214 | + // The E2E test harness (E2ETestContext.GetEnvironment) follows this pattern: |
| 215 | + // |
| 216 | + // var env = Environment.GetEnvironmentVariables() |
| 217 | + // .Cast<DictionaryEntry>() |
| 218 | + // .ToDictionary(...); |
| 219 | + // env["COPILOT_API_URL"] = proxyUrl; // ← override |
| 220 | + // env["XDG_CONFIG_HOME"] = homeDir; // ← override |
| 221 | + // env["XDG_STATE_HOME"] = homeDir; // ← override |
| 222 | + // return env; |
| 223 | + // |
| 224 | + // This pattern always supplied the FULL environment, so it happened to work |
| 225 | + // even before the fix. Here we verify the same pattern continues to work. |
| 226 | + var fullEnvWithOverrides = System.Environment.GetEnvironmentVariables() |
| 227 | + .Cast<System.Collections.DictionaryEntry>() |
| 228 | + .ToDictionary(e => (string)e.Key, e => e.Value?.ToString() ?? ""); |
| 229 | + |
| 230 | + fullEnvWithOverrides["SDK_HARNESS_STYLE_OVERRIDE"] = "harness_value"; |
| 231 | + |
| 232 | + using var client = new CopilotClient(new CopilotClientOptions |
| 233 | + { |
| 234 | + UseStdio = true, |
| 235 | + Environment = fullEnvWithOverrides, |
| 236 | + }); |
| 237 | + |
| 238 | + try |
| 239 | + { |
| 240 | + await client.StartAsync(); |
| 241 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 242 | + |
| 243 | + var pong = await client.PingAsync("harness-pattern"); |
| 244 | + Assert.Equal("pong: harness-pattern", pong.Message); |
| 245 | + |
| 246 | + await client.StopAsync(); |
| 247 | + } |
| 248 | + finally |
| 249 | + { |
| 250 | + await client.ForceStopAsync(); |
| 251 | + } |
| 252 | + } |
| 253 | + |
| 254 | + // ── NODE_DEBUG is always stripped ───────────────────────────────────────── |
| 255 | + |
| 256 | + [Fact] |
| 257 | + public async Task Should_Strip_NODE_DEBUG_Even_When_Environment_Is_Null() |
| 258 | + { |
| 259 | + // Client.cs always calls startInfo.Environment.Remove("NODE_DEBUG") after |
| 260 | + // the merge step, so the CLI subprocess never sees NODE_DEBUG regardless of |
| 261 | + // whether the parent process has it set. The CLI must start normally. |
| 262 | + var envWithNodeDebug = System.Environment.GetEnvironmentVariables() |
| 263 | + .Cast<System.Collections.DictionaryEntry>() |
| 264 | + .ToDictionary(e => (string)e.Key, e => e.Value?.ToString() ?? ""); |
| 265 | + envWithNodeDebug["NODE_DEBUG"] = "http,net"; // would pollute CLI stdout if kept |
| 266 | + |
| 267 | + using var client = new CopilotClient(new CopilotClientOptions |
| 268 | + { |
| 269 | + UseStdio = true, |
| 270 | + Environment = envWithNodeDebug, |
| 271 | + }); |
| 272 | + |
| 273 | + try |
| 274 | + { |
| 275 | + await client.StartAsync(); |
| 276 | + Assert.Equal(ConnectionState.Connected, client.State); |
| 277 | + |
| 278 | + var pong = await client.PingAsync("node-debug-stripped"); |
| 279 | + Assert.Equal("pong: node-debug-stripped", pong.Message); |
| 280 | + |
| 281 | + await client.StopAsync(); |
| 282 | + } |
| 283 | + finally |
| 284 | + { |
| 285 | + await client.ForceStopAsync(); |
| 286 | + } |
| 287 | + } |
| 288 | +} |
0 commit comments