|
| 1 | +package helm |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/json" |
| 6 | + "path/filepath" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/stretchr/testify/assert" |
| 10 | + "github.com/stretchr/testify/require" |
| 11 | + "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" |
| 12 | + |
| 13 | + e "github.com/cloudposse/atmos/internal/exec" |
| 14 | + "github.com/cloudposse/atmos/pkg/auth" |
| 15 | + cfg "github.com/cloudposse/atmos/pkg/config" |
| 16 | + iolib "github.com/cloudposse/atmos/pkg/io" |
| 17 | + "github.com/cloudposse/atmos/pkg/keyring" |
| 18 | + "github.com/cloudposse/atmos/pkg/manifest" |
| 19 | + "github.com/cloudposse/atmos/pkg/schema" |
| 20 | + "github.com/cloudposse/atmos/pkg/store" |
| 21 | + storeproviders "github.com/cloudposse/atmos/pkg/store/providers" |
| 22 | +) |
| 23 | + |
| 24 | +const ( |
| 25 | + serviceAccountJSON = `{"type":"service_account","private_key":"-----BEGIN PRIVATE KEY-----\nAAAA\nBBBB\n-----END PRIVATE KEY-----\n","client_email":"service@example.iam.gserviceaccount.com"}` |
| 26 | + plainSecret = "single-line-example-token" |
| 27 | + privateKey = "-----BEGIN PRIVATE KEY-----\nAAAA\nBBBB\n-----END PRIVATE KEY-----\n" |
| 28 | +) |
| 29 | + |
| 30 | +// jsonDecodingStore reproduces the structured Get behavior of cloud secret stores while using |
| 31 | +// the in-memory keychain backend. GetRaw preserves the opaque payload for !secret ... | raw. |
| 32 | +type jsonDecodingStore struct { |
| 33 | + store.Store |
| 34 | +} |
| 35 | + |
| 36 | +func (s *jsonDecodingStore) Get(stack, component, key string) (any, error) { |
| 37 | + raw, err := s.GetRaw(stack, component, key) |
| 38 | + if err != nil { |
| 39 | + return nil, err |
| 40 | + } |
| 41 | + var decoded any |
| 42 | + if err := json.Unmarshal([]byte(raw), &decoded); err == nil { |
| 43 | + return decoded, nil |
| 44 | + } |
| 45 | + return raw, nil |
| 46 | +} |
| 47 | + |
| 48 | +func (s *jsonDecodingStore) GetRaw(stack, component, key string) (string, error) { |
| 49 | + return s.Store.(store.RawStore).GetRaw(stack, component, key) |
| 50 | +} |
| 51 | + |
| 52 | +func TestNativeHelmSecretRawAndStructuredValuesMaskIndentedMultilineValues(t *testing.T) { |
| 53 | + fixture, err := filepath.Abs(filepath.Join("..", "..", "..", "tests", "fixtures", "scenarios", "helm-secret-values")) |
| 54 | + require.NoError(t, err) |
| 55 | + t.Chdir(fixture) |
| 56 | + t.Setenv("ATMOS_CLI_CONFIG_PATH", ".") |
| 57 | + t.Setenv("ATMOS_BASE_PATH", ".") |
| 58 | + |
| 59 | + info := schema.ConfigAndStacksInfo{ |
| 60 | + ComponentFromArg: "secret-values", |
| 61 | + ComponentType: cfg.HelmComponentType, |
| 62 | + Stack: "dev", |
| 63 | + SubCommand: "template", |
| 64 | + SecretsMaskOnly: true, |
| 65 | + } |
| 66 | + atmosConfig, err := cfg.InitCliConfig(info, true) |
| 67 | + require.NoError(t, err) |
| 68 | + require.Equal(t, store.KindGCPSecret, atmosConfig.StoresConfig["gcp-secrets"].Kind) |
| 69 | + |
| 70 | + memoryStore, err := storeproviders.NewKeychainStore(&storeproviders.KeychainStoreOptions{Backend: keyring.TypeMemory}) |
| 71 | + require.NoError(t, err) |
| 72 | + offlineStore := &jsonDecodingStore{Store: memoryStore} |
| 73 | + atmosConfig.Stores["gcp-secrets"] = offlineStore |
| 74 | + |
| 75 | + // Top-level declarations are stack scoped, so the component segment is intentionally empty. |
| 76 | + require.NoError(t, offlineStore.Set("dev", "", "service-account-json", serviceAccountJSON)) |
| 77 | + require.NoError(t, offlineStore.Set("dev", "", "plain-token", plainSecret)) |
| 78 | + require.NoError(t, offlineStore.Set("dev", "", "signing-key", privateKey)) |
| 79 | + |
| 80 | + info.SecretsMaskOnly = false |
| 81 | + info, err = e.ProcessStacks(&atmosConfig, info, true, true, true, nil, auth.AuthManager(nil)) |
| 82 | + require.NoError(t, err) |
| 83 | + |
| 84 | + values, ok := info.ComponentSection[cfg.ValuesSectionName].(map[string]any) |
| 85 | + require.True(t, ok) |
| 86 | + structured, ok := values["structured_service_account"].(map[string]any) |
| 87 | + require.True(t, ok, "bare !secret must preserve the existing structured store contract") |
| 88 | + assert.Equal(t, "service_account", structured["type"]) |
| 89 | + env, ok := values["env"].([]any) |
| 90 | + require.True(t, ok) |
| 91 | + require.Len(t, env, 4) |
| 92 | + assert.Equal(t, serviceAccountJSON, envValue(t, env, "SERVICE_ACCOUNT_JSON")) |
| 93 | + assert.Equal(t, "service@example.iam.gserviceaccount.com", envValue(t, env, "CLIENT_EMAIL")) |
| 94 | + assert.Equal(t, plainSecret, envValue(t, env, "PLAIN_TOKEN")) |
| 95 | + assert.Equal(t, privateKey, envValue(t, env, "SIGNING_KEY")) |
| 96 | + |
| 97 | + componentPath := filepath.Join(fixture, "components", "helm", "secret-values") |
| 98 | + spec, err := buildChartSpec(&atmosConfig, &info, componentPath) |
| 99 | + require.NoError(t, err) |
| 100 | + rendered, err := renderManifest(context.Background(), spec) |
| 101 | + require.NoError(t, err) |
| 102 | + |
| 103 | + objects, err := manifest.DecodeObjects([]byte(rendered)) |
| 104 | + require.NoError(t, err) |
| 105 | + require.Len(t, objects, 1) |
| 106 | + renderedEnv, found, err := unstructured.NestedSlice(objects[0].Object, "spec", "template", "spec", "containers", "0", "env") |
| 107 | + if err != nil || !found { |
| 108 | + // NestedSlice cannot index arrays by string; extract the container first. |
| 109 | + containers, containersFound, containersErr := unstructured.NestedSlice(objects[0].Object, "spec", "template", "spec", "containers") |
| 110 | + require.NoError(t, containersErr) |
| 111 | + require.True(t, containersFound) |
| 112 | + container := containers[0].(map[string]any) |
| 113 | + renderedEnv = container["env"].([]any) |
| 114 | + } |
| 115 | + assert.Equal(t, serviceAccountJSON, envValue(t, renderedEnv, "SERVICE_ACCOUNT_JSON"), "Helm env.value must remain a scalar string") |
| 116 | + |
| 117 | + masker := iolib.GetContext().Masker() |
| 118 | + t.Cleanup(func() { |
| 119 | + masker.Clear() |
| 120 | + masker.SetEnabled(true) |
| 121 | + }) |
| 122 | + masked := masker.Mask(rendered) |
| 123 | + assert.NotContains(t, masked, "BEGIN PRIVATE KEY") |
| 124 | + assert.NotContains(t, masked, "AAAA") |
| 125 | + assert.NotContains(t, masked, "BBBB") |
| 126 | + assert.NotContains(t, masked, plainSecret) |
| 127 | + assert.Contains(t, masked, masker.Replacement()) |
| 128 | + |
| 129 | + masker.SetEnabled(false) |
| 130 | + unmasked := masker.Mask(rendered) |
| 131 | + assert.Contains(t, unmasked, "BEGIN PRIVATE KEY") |
| 132 | + assert.Contains(t, unmasked, plainSecret) |
| 133 | +} |
| 134 | + |
| 135 | +func envValue(t *testing.T, env []any, name string) any { |
| 136 | + t.Helper() |
| 137 | + for _, item := range env { |
| 138 | + entry, ok := item.(map[string]any) |
| 139 | + if ok && entry["name"] == name { |
| 140 | + return entry["value"] |
| 141 | + } |
| 142 | + } |
| 143 | + t.Fatalf("environment entry %q not found", name) |
| 144 | + return nil |
| 145 | +} |
0 commit comments