|
| 1 | +// SPDX-FileCopyrightText: Copyright 2025 Stacklok, Inc. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package cli |
| 5 | + |
| 6 | +import ( |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/stretchr/testify/assert" |
| 10 | + "github.com/stretchr/testify/require" |
| 11 | + |
| 12 | + "github.com/stacklok/toolhive/pkg/vmcp" |
| 13 | +) |
| 14 | + |
| 15 | +// TestReadHeaderForwardFromEnv covers reconstructing the per-backend |
| 16 | +// HeaderForwardConfig from the JSON-encoded TOOLHIVE_HEADER_FORWARD_<entry> |
| 17 | +// env vars the operator emits on the vMCP pod. Original header casing / |
| 18 | +// punctuation is preserved by the JSON value, so the runtime reconstructs |
| 19 | +// "X-MCP-Toolsets" rather than "X_MCP_TOOLSETS". |
| 20 | +// |
| 21 | +// The map is keyed by the normalized entry segment from the env-var |
| 22 | +// suffix; the discoverer normalizes Backend.Name through |
| 23 | +// ctrlutil.NormalizeHeaderForEnvVar before indexing. |
| 24 | +func TestReadHeaderForwardFromEnv(t *testing.T) { |
| 25 | + t.Parallel() |
| 26 | + |
| 27 | + tests := []struct { |
| 28 | + name string |
| 29 | + env []string |
| 30 | + validate func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) |
| 31 | + }{ |
| 32 | + { |
| 33 | + name: "no env vars yields empty map", |
| 34 | + env: []string{"HOME=/root", "PATH=/bin"}, |
| 35 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 36 | + t.Helper() |
| 37 | + assert.Empty(t, m) |
| 38 | + }, |
| 39 | + }, |
| 40 | + { |
| 41 | + name: "plaintext header decodes preserving original casing and hyphens", |
| 42 | + env: []string{ |
| 43 | + `TOOLHIVE_HEADER_FORWARD_GITHUB_COPILOT={"addPlaintextHeaders":{"X-MCP-Toolsets":"projects,issues"}}`, |
| 44 | + "PATH=/bin", |
| 45 | + }, |
| 46 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 47 | + t.Helper() |
| 48 | + cfg := m["GITHUB_COPILOT"] |
| 49 | + require.NotNil(t, cfg) |
| 50 | + assert.Equal(t, map[string]string{"X-MCP-Toolsets": "projects,issues"}, cfg.AddPlaintextHeaders) |
| 51 | + assert.Empty(t, cfg.AddHeadersFromSecret) |
| 52 | + }, |
| 53 | + }, |
| 54 | + { |
| 55 | + name: "secret header decodes to identifier (value not in manifest)", |
| 56 | + env: []string{ |
| 57 | + `TOOLHIVE_HEADER_FORWARD_STRIPE={"addHeadersFromSecret":{"X-Api-Key":"HEADER_FORWARD_X_API_KEY_STRIPE"}}`, |
| 58 | + // The secret-value env var carries the resolved value via |
| 59 | + // secretKeyRef; the walker must NOT treat it as a manifest. |
| 60 | + "TOOLHIVE_SECRET_HEADER_FORWARD_X_API_KEY_STRIPE=resolved-secret-value", |
| 61 | + }, |
| 62 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 63 | + t.Helper() |
| 64 | + assert.NotContains(t, m, "X_API_KEY_STRIPE", "secret env var must not be parsed as a manifest") |
| 65 | + cfg := m["STRIPE"] |
| 66 | + require.NotNil(t, cfg) |
| 67 | + assert.Empty(t, cfg.AddPlaintextHeaders) |
| 68 | + assert.Equal(t, |
| 69 | + map[string]string{"X-Api-Key": "HEADER_FORWARD_X_API_KEY_STRIPE"}, |
| 70 | + cfg.AddHeadersFromSecret, |
| 71 | + ) |
| 72 | + }, |
| 73 | + }, |
| 74 | + { |
| 75 | + name: "malformed manifest is skipped without failing other backends", |
| 76 | + env: []string{ |
| 77 | + `TOOLHIVE_HEADER_FORWARD_BROKEN=not-json`, |
| 78 | + `TOOLHIVE_HEADER_FORWARD_DEMO={"addPlaintextHeaders":{"X-Trace":"ok"}}`, |
| 79 | + }, |
| 80 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 81 | + t.Helper() |
| 82 | + assert.NotContains(t, m, "BROKEN") |
| 83 | + cfg := m["DEMO"] |
| 84 | + require.NotNil(t, cfg) |
| 85 | + assert.Equal(t, map[string]string{"X-Trace": "ok"}, cfg.AddPlaintextHeaders) |
| 86 | + }, |
| 87 | + }, |
| 88 | + { |
| 89 | + name: "mixed plaintext + secret in one manifest scoped per backend", |
| 90 | + env: []string{ |
| 91 | + `TOOLHIVE_HEADER_FORWARD_ALPHA={"addPlaintextHeaders":{"X-Trace":"alpha-trace"},"addHeadersFromSecret":{"X-Token":"HEADER_FORWARD_X_TOKEN_ALPHA"}}`, |
| 92 | + `TOOLHIVE_HEADER_FORWARD_BETA={"addPlaintextHeaders":{"X-Trace":"beta-trace"}}`, |
| 93 | + }, |
| 94 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 95 | + t.Helper() |
| 96 | + |
| 97 | + alpha := m["ALPHA"] |
| 98 | + require.NotNil(t, alpha) |
| 99 | + assert.Equal(t, map[string]string{"X-Trace": "alpha-trace"}, alpha.AddPlaintextHeaders) |
| 100 | + assert.Equal(t, |
| 101 | + map[string]string{"X-Token": "HEADER_FORWARD_X_TOKEN_ALPHA"}, |
| 102 | + alpha.AddHeadersFromSecret, |
| 103 | + ) |
| 104 | + |
| 105 | + beta := m["BETA"] |
| 106 | + require.NotNil(t, beta) |
| 107 | + assert.Equal(t, map[string]string{"X-Trace": "beta-trace"}, beta.AddPlaintextHeaders) |
| 108 | + assert.Empty(t, beta.AddHeadersFromSecret) |
| 109 | + }, |
| 110 | + }, |
| 111 | + { |
| 112 | + name: "malformed env entry without '=' is skipped", |
| 113 | + env: []string{ |
| 114 | + "NO_EQUALS_HERE", |
| 115 | + `TOOLHIVE_HEADER_FORWARD_DEMO={"addPlaintextHeaders":{"X-Trace":"ok"}}`, |
| 116 | + }, |
| 117 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 118 | + t.Helper() |
| 119 | + cfg := m["DEMO"] |
| 120 | + require.NotNil(t, cfg) |
| 121 | + assert.Equal(t, map[string]string{"X-Trace": "ok"}, cfg.AddPlaintextHeaders) |
| 122 | + }, |
| 123 | + }, |
| 124 | + { |
| 125 | + // DNS-1123 forbids underscores in MCPServerEntry names today, so |
| 126 | + // real entries with the same NormalizeForEnvVar output cannot |
| 127 | + // coexist. We pass two manifests that share the same suffix |
| 128 | + // directly to verify the runtime keeps "last wins" behavior and |
| 129 | + // surfaces a warning rather than silently dropping the first. |
| 130 | + name: "duplicate manifest suffix retains last value", |
| 131 | + env: []string{ |
| 132 | + `TOOLHIVE_HEADER_FORWARD_DUP={"addPlaintextHeaders":{"X-Trace":"first"}}`, |
| 133 | + `TOOLHIVE_HEADER_FORWARD_DUP={"addPlaintextHeaders":{"X-Trace":"second"}}`, |
| 134 | + }, |
| 135 | + validate: func(t *testing.T, m map[string]*vmcp.HeaderForwardConfig) { |
| 136 | + t.Helper() |
| 137 | + cfg := m["DUP"] |
| 138 | + require.NotNil(t, cfg) |
| 139 | + assert.Equal(t, map[string]string{"X-Trace": "second"}, cfg.AddPlaintextHeaders, |
| 140 | + "duplicate manifest must keep the later value (last-write-wins)") |
| 141 | + }, |
| 142 | + }, |
| 143 | + } |
| 144 | + |
| 145 | + for _, tt := range tests { |
| 146 | + t.Run(tt.name, func(t *testing.T) { |
| 147 | + t.Parallel() |
| 148 | + tt.validate(t, readHeaderForwardFromEnv(tt.env)) |
| 149 | + }) |
| 150 | + } |
| 151 | +} |
0 commit comments