mirror of
https://github.com/helmfile/helmfile.git
synced 2026-09-30 18:48:12 +02:00
* feat(state): add mergeStrategy field to EnvironmentSpec Introduces a per-environment mergeStrategy with valid values "override" (default, current behavior) and "fallback". This commit only adds the field, the constants, and a parse-time validator; the loader still ignores the value, so behavior is unchanged. Subsequent commits thread the value through the values loader and implement the fallback semantics. Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> * refactor(state): thread mergeStrategy through values loader Adds a mergeStrategy string parameter to LoadEnvironmentValues, loadValuesEntries, and mapMerge so the value can flow from EnvironmentSpec down to the merge call site. Behavior is unchanged in this commit; mapMerge ignores the strategy and the next commit implements the fallback semantics. Top-level state.DefaultValues and the --state-values-file/-set loaders are passed an empty strategy ("") since they have no per-environment spec to consult and stay on the default override behavior. Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> * feat(state): implement fallback merge strategy Adds a hand-rolled fallbackDeepMerge that, unlike mergo, preserves keys present in the destination even when their value is the zero value (false, 0, "", nil, empty list/map). mapMerge dispatches to it when mergeStrategy == "fallback"; "override" and the empty default keep using mergo with WithOverride so existing behaviour is unchanged. Validation lives at the entry of LoadEnvironmentValues so a single chokepoint guards the field. Invalid values produce an error naming both the offending value and the valid options. Tests cover: first-file-wins precedence, gap filling, deep nested merge, three-file chains, explicit zero-value preservation (the case naïve mergo gets wrong), explicit nil preservation, inline map entries, override regression, default-equals-override equivalence, and invalid-strategy errors. Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> * feat(state): expose prior-file values in fallback template context Under mergeStrategy: fallback, .gotmpl values files can now reference values from earlier files in the same `values:` list via .Values (e.g. `service.domain: "service.{{ .Values.cluster.domain }}"`). The accumulated result is layered under env.GetMergedValues so env defaults, env values, and CLI overrides still win on overlap. Override mode keeps the historical template context — unchanged — so this is strictly opt-in via the mergeStrategy field. Together with the precedence flip from the previous commit, this lets users replace the brittle two-stage `merged-values.yaml.gotmpl` workaround with native helmfile syntax. Tests cover the headline cross-file template reference case and pin the override-mode contract that prior-file values stay invisible. Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> * docs: document mergeStrategy and fallback semantics Adds a new section to values-and-merging.md describing the override vs fallback strategies, the explicit-zero-value preservation guarantee, and the cross-file template reference behavior. Adds a brief pointer to environments.md so users land on the new field from the environment values discussion. Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> * refactor(state): reuse maputil.MergeMaps for fallback merge Replaces the hand-rolled fallbackDeepMerge with a single call to maputil.MergeMaps, swapping its arguments so the accumulated dest wins over the new src file. Same first-file-wins semantic, fewer lines, and the fallback path now inherits the same slice merge strategies the rest of helmfile already uses. The one observable behavior shift is for explicit nil values: under fallback, nil in an earlier file no longer 'wins' over a non-nil value in a later file — instead it falls through (matching MergeMaps' rule that nil from the override side only fills missing keys). This is internally consistent: nil-overwrites is an mergo.WithOverride quirk that lives only in the override path. The renamed test NilFallsThroughToFallback pins the new behavior with a comment referencing the contrast with override mode (Issue1154). Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de> --------- Signed-off-by: Dominik Schmidt <dev@dominik-schmidt.de>
1028 lines
30 KiB
Go
1028 lines
30 KiB
Go
package state
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"dario.cat/mergo"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/zap"
|
|
"go.uber.org/zap/zaptest"
|
|
|
|
"github.com/helmfile/helmfile/pkg/environment"
|
|
"github.com/helmfile/helmfile/pkg/filesystem"
|
|
"github.com/helmfile/helmfile/pkg/remote"
|
|
"github.com/helmfile/helmfile/pkg/testhelper"
|
|
)
|
|
|
|
func createFromYaml(content []byte, file string, env string, logger *zap.SugaredLogger) (*HelmState, error) {
|
|
c := &StateCreator{
|
|
logger: logger,
|
|
fs: filesystem.DefaultFileSystem(),
|
|
Strict: true,
|
|
}
|
|
return c.ParseAndLoad(content, filepath.Dir(file), file, env, false, true, true, nil, nil)
|
|
}
|
|
|
|
func TestReadFromYaml(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
chart: mychart
|
|
`)
|
|
state, err := createFromYaml(yamlContent, yamlFile, DefaultEnv, logger)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
|
|
if state.Releases[0].Name != "myrelease" {
|
|
t.Errorf("unexpected release name: expected=myrelease actual=%s", state.Releases[0].Name)
|
|
}
|
|
if state.Releases[0].Namespace != "mynamespace" {
|
|
t.Errorf("unexpected chart namespace: expected=mynamespace actual=%s", state.Releases[0].Chart)
|
|
}
|
|
if state.Releases[0].Chart != "mychart" {
|
|
t.Errorf("unexpected chart name: expected=mychart actual=%s", state.Releases[0].Chart)
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_NonexistentEnv(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
chart: mychart
|
|
`)
|
|
_, err := createFromYaml(yamlContent, yamlFile, "production", logger)
|
|
// This does not produce an error because the environment existence check if done
|
|
// outside of the ParseAndLoad function since
|
|
// https://github.com/helmfile/helmfile/pull/885
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
type stateTestEnv struct {
|
|
Files map[string]string
|
|
WorkDir string
|
|
}
|
|
|
|
func (testEnv stateTestEnv) MustLoadState(t *testing.T, file, envName string) *HelmState {
|
|
return testEnv.MustLoadStateWithEnableLiveOutput(t, file, envName, false)
|
|
}
|
|
|
|
func (testEnv stateTestEnv) MustLoadStateWithEnableLiveOutput(t *testing.T, file, envName string, enableLiveOutput bool) *HelmState {
|
|
t.Helper()
|
|
|
|
testFs := testhelper.NewTestFs(testEnv.Files)
|
|
|
|
if testFs.Cwd == "" {
|
|
testFs.Cwd = "/"
|
|
}
|
|
|
|
yamlContent, ok := testEnv.Files[file]
|
|
if !ok {
|
|
t.Fatalf("no file named %q registered", file)
|
|
}
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
state, err := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, enableLiveOutput, "").
|
|
ParseAndLoad([]byte(yamlContent), filepath.Dir(file), file, envName, true, true, true, nil, nil)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
return state
|
|
}
|
|
|
|
func TestReadFromYaml_NonDefaultEnv(t *testing.T) {
|
|
yamlFile := "/example/path/to/helmfile.yaml"
|
|
yamlContent := []byte(`environments:
|
|
production:
|
|
values:
|
|
- foo.yaml
|
|
- bar.yaml.gotmpl
|
|
|
|
releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
chart: mychart
|
|
values:
|
|
- values.yaml.gotmpl
|
|
`)
|
|
|
|
fooYamlFile := "/example/path/to/foo.yaml"
|
|
fooYamlContent := []byte(`foo: foo
|
|
# As this file doesn't have an file extension ".gotmpl", this template expression should not be evaluated
|
|
baz: "{{ readFile \"baz.txt\" }}"`)
|
|
|
|
barYamlFile := "/example/path/to/bar.yaml.gotmpl"
|
|
barYamlContent := []byte(`foo: FOO
|
|
bar: {{ readFile "bar.txt" }}
|
|
env: {{ .Environment.Name }}
|
|
`)
|
|
|
|
barTextFile := "/example/path/to/bar.txt"
|
|
barTextContent := []byte("BAR")
|
|
|
|
expected := map[string]any{
|
|
"foo": "FOO",
|
|
"bar": "BAR",
|
|
// As the file doesn't have an file extension ".gotmpl", this template expression should not be evaluated
|
|
"baz": "{{ readFile \"baz.txt\" }}",
|
|
"env": "production",
|
|
}
|
|
|
|
valuesFile := "/example/path/to/values.yaml.gotmpl"
|
|
valuesContent := []byte(`env: {{ .Environment.Name }}
|
|
releaseName: {{ .Release.Name }}
|
|
releaseNamespace: {{ .Release.Namespace }}
|
|
`)
|
|
|
|
expectedValues := `env: production
|
|
releaseName: myrelease
|
|
releaseNamespace: mynamespace
|
|
`
|
|
|
|
testFs := testhelper.NewTestFs(map[string]string{
|
|
fooYamlFile: string(fooYamlContent),
|
|
barYamlFile: string(barYamlContent),
|
|
barTextFile: string(barTextContent),
|
|
valuesFile: string(valuesContent),
|
|
})
|
|
testFs.Cwd = "/example/path/to"
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
env := environment.Environment{
|
|
Name: "production",
|
|
}
|
|
state, err := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, false, "").
|
|
ParseAndLoad(yamlContent, filepath.Dir(yamlFile), yamlFile, "production", true, true, true, &env, nil)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
actual := state.Env.Values
|
|
if !reflect.DeepEqual(actual, expected) {
|
|
t.Errorf("unexpected environment values: expected=%v, actual=%v", expected, actual)
|
|
}
|
|
|
|
release := state.Releases[0]
|
|
|
|
state.ApplyOverrides(&release)
|
|
|
|
actualValuesData, err := state.RenderReleaseValuesFileToBytes(&release, valuesFile)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
actualValues := string(actualValuesData)
|
|
|
|
if !reflect.DeepEqual(expectedValues, actualValues) {
|
|
t.Errorf("unexpected values: expected=%v, actual=%v", expectedValues, actualValues)
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_OverrideNamespace(t *testing.T) {
|
|
yamlFile := "/example/path/to/helmfile.yaml"
|
|
yamlContent := []byte(`environments:
|
|
production:
|
|
values:
|
|
- foo.yaml
|
|
- bar.yaml.gotmpl
|
|
|
|
# A.k.a helmfile apply --namespace myns
|
|
namespace: myns
|
|
|
|
releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
chart: mychart
|
|
values:
|
|
- values.yaml.gotmpl
|
|
`)
|
|
|
|
fooYamlFile := "/example/path/to/foo.yaml"
|
|
fooYamlContent := []byte(`foo: foo
|
|
# As this file doesn't have an file extension ".gotmpl", this template expression should not be evaluated
|
|
baz: "{{ readFile \"baz.txt\" }}"`)
|
|
|
|
barYamlFile := "/example/path/to/bar.yaml.gotmpl"
|
|
barYamlContent := []byte(`foo: FOO
|
|
bar: {{ readFile "bar.txt" }}
|
|
`)
|
|
|
|
barTextFile := "/example/path/to/bar.txt"
|
|
barTextContent := []byte("BAR")
|
|
|
|
expected := map[string]any{
|
|
"foo": "FOO",
|
|
"bar": "BAR",
|
|
// As the file doesn't have an file extension ".gotmpl", this template expression should not be evaluated
|
|
"baz": "{{ readFile \"baz.txt\" }}",
|
|
}
|
|
|
|
valuesFile := "/example/path/to/values.yaml.gotmpl"
|
|
valuesContent := []byte(`env: {{ .Environment.Name }}
|
|
releaseName: {{ .Release.Name }}
|
|
releaseNamespace: {{ .Release.Namespace }}
|
|
overrideNamespace: {{ .Namespace }}
|
|
`)
|
|
|
|
expectedValues := `env: production
|
|
releaseName: myrelease
|
|
releaseNamespace: myns
|
|
overrideNamespace: myns
|
|
`
|
|
|
|
testFs := testhelper.NewTestFs(map[string]string{
|
|
fooYamlFile: string(fooYamlContent),
|
|
barYamlFile: string(barYamlContent),
|
|
barTextFile: string(barTextContent),
|
|
valuesFile: string(valuesContent),
|
|
})
|
|
testFs.Cwd = "/example/path/to"
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
state, err := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, false, "").
|
|
ParseAndLoad(yamlContent, filepath.Dir(yamlFile), yamlFile, "production", true, true, true, nil, nil)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
actual := state.Env.Values
|
|
if !reflect.DeepEqual(actual, expected) {
|
|
t.Errorf("unexpected environment values: expected=%v, actual=%v", expected, actual)
|
|
}
|
|
|
|
release := state.Releases[0]
|
|
|
|
state.ApplyOverrides(&release)
|
|
|
|
actualValuesData, err := state.RenderReleaseValuesFileToBytes(&release, valuesFile)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
actualValues := string(actualValuesData)
|
|
|
|
if !reflect.DeepEqual(expectedValues, actualValues) {
|
|
t.Errorf("unexpected values: expected=%v, actual=%v", expectedValues, actualValues)
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_StrictUnmarshalling(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
releases: mychart
|
|
`)
|
|
_, err := createFromYaml(yamlContent, yamlFile, DefaultEnv, logger)
|
|
if err == nil {
|
|
t.Error("expected an error for wrong key 'releases' which is not in struct")
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_ConflictingReleasesConfig(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`charts:
|
|
- name: myrelease1
|
|
chart: mychart1
|
|
releases:
|
|
- name: myrelease2
|
|
chart: mychart2
|
|
`)
|
|
_, err := createFromYaml(yamlContent, yamlFile, DefaultEnv, logger)
|
|
if err == nil {
|
|
t.Error("expected error")
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_FilterReleasesOnLabels(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`releases:
|
|
- name: myrelease1
|
|
chart: mychart1
|
|
labels:
|
|
tier: frontend
|
|
foo: bar
|
|
- name: myrelease2
|
|
chart: mychart2
|
|
labels:
|
|
tier: frontend
|
|
- name: myrelease3
|
|
chart: mychart3
|
|
labels:
|
|
tier: backend
|
|
`)
|
|
cases := []struct {
|
|
filter LabelFilter
|
|
results []bool
|
|
}{
|
|
{LabelFilter{positiveLabels: [][]string{{"tier", "frontend"}}},
|
|
[]bool{true, true, false}},
|
|
{LabelFilter{positiveLabels: [][]string{{"tier", "frontend"}, {"foo", "bar"}}},
|
|
[]bool{true, false, false}},
|
|
{LabelFilter{negativeLabels: [][]string{{"tier", "frontend"}}},
|
|
[]bool{false, false, true}},
|
|
{LabelFilter{positiveLabels: [][]string{{"tier", "frontend"}}, negativeLabels: [][]string{{"foo", "bar"}}},
|
|
[]bool{false, true, false}},
|
|
}
|
|
state, err := createFromYaml(yamlContent, yamlFile, DefaultEnv, logger)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
for idx, c := range cases {
|
|
for idx2, expected := range c.results {
|
|
if f := c.filter.Match(state.Releases[idx2]); f != expected {
|
|
t.Errorf("[case: %d][outcome: %d] Unexpected outcome wanted %t, got %t", idx, idx2, expected, f)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_FilterNegatives(t *testing.T) {
|
|
yamlFile := "example/path/to/yaml/file"
|
|
yamlContent := []byte(`releases:
|
|
- name: myrelease1
|
|
chart: mychart1
|
|
labels:
|
|
stage: pre
|
|
foo: bar
|
|
- name: myrelease2
|
|
chart: mychart2
|
|
labels:
|
|
stage: post
|
|
- name: myrelease3
|
|
chart: mychart3
|
|
`)
|
|
cases := []struct {
|
|
filter LabelFilter
|
|
results []bool
|
|
}{
|
|
{LabelFilter{positiveLabels: [][]string{{"stage", "pre"}}},
|
|
[]bool{true, false, false}},
|
|
{LabelFilter{positiveLabels: [][]string{{"stage", "post"}}},
|
|
[]bool{false, true, false}},
|
|
{LabelFilter{negativeLabels: [][]string{{"stage", "pre"}, {"stage", "post"}}},
|
|
[]bool{false, false, true}},
|
|
{LabelFilter{negativeLabels: [][]string{{"foo", "bar"}}},
|
|
[]bool{false, true, true}},
|
|
}
|
|
state, err := createFromYaml(yamlContent, yamlFile, DefaultEnv, logger)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
for idx, c := range cases {
|
|
for idx2, expected := range c.results {
|
|
if f := c.filter.Match(state.Releases[idx2]); f != expected {
|
|
t.Errorf("[case: %d][outcome: %d] Unexpected outcome wanted %t, got %t", idx, idx2, expected, f)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_Helmfiles_Selectors(t *testing.T) {
|
|
tests := []struct {
|
|
path string
|
|
content []byte
|
|
wantErr bool
|
|
helmfiles []SubHelmfileSpec
|
|
}{
|
|
{
|
|
path: "working/selector",
|
|
content: []byte(`helmfiles:
|
|
- simple/helmfile.yaml
|
|
- path: path/prefix/selector.yaml
|
|
selectors:
|
|
- name=zorba
|
|
- foo=bar
|
|
- path: path/prefix/empty/selector.yaml
|
|
selectors: []
|
|
- path: path/prefix/inherits/selector.yaml
|
|
selectorsInherited: true
|
|
`),
|
|
wantErr: false,
|
|
helmfiles: []SubHelmfileSpec{{Path: "simple/helmfile.yaml", Selectors: nil, SelectorsInherited: false},
|
|
{Path: "path/prefix/selector.yaml", Selectors: []string{"name=zorba", "foo=bar"}, SelectorsInherited: false},
|
|
{Path: "path/prefix/empty/selector.yaml", Selectors: []string{}, SelectorsInherited: false},
|
|
{Path: "path/prefix/inherits/selector.yaml", Selectors: nil, SelectorsInherited: true},
|
|
},
|
|
},
|
|
{
|
|
path: "failing2/selector",
|
|
content: []byte(`helmfiles:
|
|
- path: failing2/helmfile.yaml
|
|
wrongkey:
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
path: "failing3/selector",
|
|
content: []byte(`helmfiles:
|
|
- path: failing3/helmfile.yaml
|
|
selectors: foo
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
path: "failing4/selector",
|
|
content: []byte(`helmfiles:
|
|
- path: failing4/helmfile.yaml
|
|
selectors:
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
path: "failing4/selector",
|
|
content: []byte(`helmfiles:
|
|
- path: failing4/helmfile.yaml
|
|
selectors:
|
|
- colon: not-authorized
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
path: "failing6/selector",
|
|
content: []byte(`helmfiles:
|
|
- selectors:
|
|
- whatever
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
path: "failing7/selector",
|
|
content: []byte(`helmfiles:
|
|
- path: foo/bar
|
|
selectors:
|
|
- foo=bar
|
|
selectorsInherited: true
|
|
`),
|
|
wantErr: true,
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
st, err := createFromYaml(test.content, test.path, DefaultEnv, logger)
|
|
if err != nil {
|
|
if test.wantErr {
|
|
continue
|
|
} else {
|
|
t.Error("unexpected error:", err)
|
|
}
|
|
}
|
|
require.Equalf(t, test.helmfiles, st.Helmfiles, "for path %s", test.path)
|
|
}
|
|
}
|
|
|
|
func TestReadFromYaml_EnvironmentContext(t *testing.T) {
|
|
yamlFile := "/example/path/to/helmfile.yaml"
|
|
yamlContent := []byte(`environments:
|
|
production:
|
|
values: []
|
|
kubeContext: myCtx
|
|
|
|
releases:
|
|
- name: myrelease
|
|
namespace: mynamespace
|
|
chart: mychart
|
|
values:
|
|
- values.yaml.gotmpl
|
|
`)
|
|
|
|
valuesFile := "/example/path/to/values.yaml.gotmpl"
|
|
valuesContent := []byte(`envName: {{ .Environment.Name }}
|
|
envContext: {{ .Environment.KubeContext }}
|
|
releaseName: {{ .Release.Name }}
|
|
releaseContext: {{ .Release.KubeContext }}
|
|
`)
|
|
|
|
expectedValues := `envName: production
|
|
envContext: myCtx
|
|
releaseName: myrelease
|
|
releaseContext:
|
|
`
|
|
|
|
testFs := testhelper.NewTestFs(map[string]string{
|
|
valuesFile: string(valuesContent),
|
|
})
|
|
testFs.Cwd = "/example/path/to"
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
state, err := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, false, "").
|
|
ParseAndLoad(yamlContent, filepath.Dir(yamlFile), yamlFile, "production", true, true, true, nil, nil)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
release := state.Releases[0]
|
|
|
|
state.ApplyOverrides(&release)
|
|
|
|
actualValuesData, err := state.RenderReleaseValuesFileToBytes(&release, valuesFile)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
actualValues := string(actualValuesData)
|
|
|
|
if !reflect.DeepEqual(expectedValues, actualValues) {
|
|
t.Errorf("unexpected values: expected=%v, actual=%v", expectedValues, actualValues)
|
|
}
|
|
}
|
|
|
|
// TestHelmBinaryInBases tests that helmBinary and kustomizeBinary settings
|
|
// from bases are properly merged with later values overriding earlier ones
|
|
func TestHelmBinaryInBases(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
files map[string]string
|
|
mainFile string
|
|
expectedHelmBinary string
|
|
expectedKustomizeBinary string
|
|
}{
|
|
{
|
|
name: "helmBinary in second base should be used",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/env.yaml
|
|
---
|
|
bases:
|
|
- ./bases/repos.yaml
|
|
---
|
|
bases:
|
|
- ./bases/releases.yaml
|
|
`,
|
|
"/path/to/bases/env.yaml": `environments:
|
|
default:
|
|
values:
|
|
- key: value1
|
|
`,
|
|
"/path/to/bases/repos.yaml": `repositories:
|
|
- name: stable
|
|
url: https://charts.helm.sh/stable
|
|
helmBinary: /path/to/custom/helm
|
|
`,
|
|
"/path/to/bases/releases.yaml": `releases:
|
|
- name: myapp
|
|
chart: stable/nginx
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: "/path/to/custom/helm",
|
|
expectedKustomizeBinary: DefaultKustomizeBinary,
|
|
},
|
|
{
|
|
name: "helmBinary in main file after bases should override",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/env.yaml
|
|
---
|
|
bases:
|
|
- ./bases/repos.yaml
|
|
---
|
|
bases:
|
|
- ./bases/releases.yaml
|
|
helmBinary: /path/to/main/helm
|
|
`,
|
|
"/path/to/bases/env.yaml": `environments:
|
|
default:
|
|
values:
|
|
- key: value1
|
|
`,
|
|
"/path/to/bases/repos.yaml": `repositories:
|
|
- name: stable
|
|
url: https://charts.helm.sh/stable
|
|
helmBinary: /path/to/base/helm
|
|
`,
|
|
"/path/to/bases/releases.yaml": `releases:
|
|
- name: myapp
|
|
chart: stable/nginx
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: "/path/to/main/helm",
|
|
expectedKustomizeBinary: DefaultKustomizeBinary,
|
|
},
|
|
{
|
|
name: "helmBinary in main file between bases should override earlier bases",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/env.yaml
|
|
---
|
|
bases:
|
|
- ./bases/repos.yaml
|
|
helmBinary: /path/to/middle/helm
|
|
---
|
|
bases:
|
|
- ./bases/releases.yaml
|
|
`,
|
|
"/path/to/bases/env.yaml": `environments:
|
|
default:
|
|
values:
|
|
- key: value1
|
|
`,
|
|
"/path/to/bases/repos.yaml": `repositories:
|
|
- name: stable
|
|
url: https://charts.helm.sh/stable
|
|
helmBinary: /path/to/base/helm
|
|
`,
|
|
"/path/to/bases/releases.yaml": `releases:
|
|
- name: myapp
|
|
chart: stable/nginx
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: "/path/to/middle/helm",
|
|
expectedKustomizeBinary: DefaultKustomizeBinary,
|
|
},
|
|
{
|
|
name: "kustomizeBinary in base should be used",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/base.yaml
|
|
`,
|
|
"/path/to/bases/base.yaml": `kustomizeBinary: /path/to/custom/kustomize
|
|
releases:
|
|
- name: myapp
|
|
chart: mychart
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: DefaultHelmBinary,
|
|
expectedKustomizeBinary: "/path/to/custom/kustomize",
|
|
},
|
|
{
|
|
name: "both helmBinary and kustomizeBinary in different bases",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/helm.yaml
|
|
---
|
|
bases:
|
|
- ./bases/kustomize.yaml
|
|
`,
|
|
"/path/to/bases/helm.yaml": `helmBinary: /path/to/custom/helm
|
|
`,
|
|
"/path/to/bases/kustomize.yaml": `kustomizeBinary: /path/to/custom/kustomize
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: "/path/to/custom/helm",
|
|
expectedKustomizeBinary: "/path/to/custom/kustomize",
|
|
},
|
|
{
|
|
name: "later base overrides earlier base for helmBinary",
|
|
files: map[string]string{
|
|
"/path/to/helmfile.yaml": `bases:
|
|
- ./bases/first.yaml
|
|
---
|
|
bases:
|
|
- ./bases/second.yaml
|
|
`,
|
|
"/path/to/bases/first.yaml": `helmBinary: /path/to/first/helm
|
|
`,
|
|
"/path/to/bases/second.yaml": `helmBinary: /path/to/second/helm
|
|
`,
|
|
},
|
|
mainFile: "/path/to/helmfile.yaml",
|
|
expectedHelmBinary: "/path/to/second/helm",
|
|
expectedKustomizeBinary: DefaultKustomizeBinary,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
testFs := testhelper.NewTestFs(tt.files)
|
|
if testFs.Cwd == "" {
|
|
testFs.Cwd = "/"
|
|
}
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
creator := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, false, "")
|
|
|
|
// Set up LoadFile for recursive base loading
|
|
creator.LoadFile = func(inheritedEnv, overrodeEnv *environment.Environment, baseDir, file string, evaluateBases bool) (*HelmState, error) {
|
|
path := filepath.Join(baseDir, file)
|
|
content, ok := tt.files[path]
|
|
if !ok {
|
|
return nil, fmt.Errorf("file not found: %s", path)
|
|
}
|
|
// When loading base files, we don't apply defaults - they should only
|
|
// be applied to the main file after all parts/bases are merged.
|
|
// So applyDefaults = evaluateBases (true for main, false for bases).
|
|
applyDefaults := evaluateBases
|
|
return creator.ParseAndLoad([]byte(content), filepath.Dir(path), path, DefaultEnv, true, evaluateBases, applyDefaults, inheritedEnv, overrodeEnv)
|
|
}
|
|
|
|
yamlContent, ok := tt.files[tt.mainFile]
|
|
if !ok {
|
|
t.Fatalf("no file named %q registered", tt.mainFile)
|
|
}
|
|
|
|
state, err := creator.ParseAndLoad([]byte(yamlContent), filepath.Dir(tt.mainFile), tt.mainFile, DefaultEnv, true, true, true, nil, nil)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if state.DefaultHelmBinary != tt.expectedHelmBinary {
|
|
t.Errorf("helmBinary mismatch: expected=%s, actual=%s",
|
|
tt.expectedHelmBinary, state.DefaultHelmBinary)
|
|
}
|
|
|
|
if state.DefaultKustomizeBinary != tt.expectedKustomizeBinary {
|
|
t.Errorf("kustomizeBinary mismatch: expected=%s, actual=%s",
|
|
tt.expectedKustomizeBinary, state.DefaultKustomizeBinary)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestHelmBinaryInMultiDocumentYAML tests that helmBinary is preserved when
|
|
// processing multi-document YAML files (files with --- separators).
|
|
// This is a regression test for issue #2319.
|
|
func TestHelmBinaryInMultiDocumentYAML(t *testing.T) {
|
|
logger := zaptest.NewLogger(t).Sugar()
|
|
testFs := testhelper.NewTestFs(map[string]string{})
|
|
testFs.Cwd = "/"
|
|
|
|
r := remote.NewRemote(logger, testFs.Cwd, testFs.ToFileSystem())
|
|
creator := NewCreator(logger, testFs.ToFileSystem(), nil, nil, "", "", r, false, "")
|
|
|
|
// Simulate a multi-document YAML where the first document sets helmBinary
|
|
// and the second document has no helmBinary
|
|
doc1 := `helmBinary: /custom/helm
|
|
helmDefaults:
|
|
timeout: 300
|
|
`
|
|
doc2 := `releases:
|
|
- name: myapp
|
|
chart: stable/nginx
|
|
`
|
|
|
|
// Simulate what load() in desired_state_file_loader.go does:
|
|
// 1. Process each part with applyDefaults=false
|
|
state1, err := creator.ParseAndLoad([]byte(doc1), "/", "/helmfile.yaml", DefaultEnv, true, true, false, nil, nil)
|
|
require.NoError(t, err)
|
|
|
|
state2, err := creator.ParseAndLoad([]byte(doc2), "/", "/helmfile.yaml", DefaultEnv, true, true, false, nil, nil)
|
|
require.NoError(t, err)
|
|
|
|
// 2. Merge parts (simulating what mergo.Merge does with mergo.WithOverride)
|
|
// Since state2 has empty DefaultHelmBinary, mergo.WithOverride should preserve state1's value
|
|
require.NoError(t, mergo.Merge(state1, state2, mergo.WithAppendSlice, mergo.WithOverride))
|
|
|
|
// 3. Apply defaults after merge
|
|
creator.ApplyDefaultsAndOverrides(state1)
|
|
|
|
// Verify that helmBinary from first document is preserved
|
|
assert.Equal(t, "/custom/helm", state1.DefaultHelmBinary,
|
|
"helmBinary from first document should be preserved after merge and applyDefaults")
|
|
}
|
|
|
|
// TestEnvironmentMergingWithBases tests that environment values from multiple bases
|
|
// are properly merged rather than replaced. This is a regression test for issue #2273.
|
|
func TestEnvironmentMergingWithBases(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
files map[string]string
|
|
mainFile string
|
|
environment string
|
|
expectedError bool
|
|
checkValues func(t *testing.T, state *HelmState)
|
|
}{
|
|
{
|
|
name: "environment values should merge from multiple bases",
|
|
files: map[string]string{
|
|
"/path/one.yaml": `environments:
|
|
sandbox:
|
|
values:
|
|
- example:
|
|
enabled: true
|
|
`,
|
|
"/path/two.yaml": `environments:
|
|
sandbox: {}
|
|
`,
|
|
"/path/helmfile.yaml": `bases:
|
|
- one.yaml
|
|
- two.yaml
|
|
---
|
|
repositories:
|
|
- name: examples
|
|
url: https://helm.github.io/examples
|
|
releases:
|
|
- name: example
|
|
chart: examples/hello-world
|
|
`,
|
|
},
|
|
mainFile: "/path/helmfile.yaml",
|
|
environment: "sandbox",
|
|
checkValues: func(t *testing.T, state *HelmState) {
|
|
// Check that the environment has the values from the first base
|
|
envSpec, ok := state.Environments["sandbox"]
|
|
require.True(t, ok, "sandbox environment should exist")
|
|
require.NotNil(t, envSpec.Values, "environment values should not be nil")
|
|
require.Greater(t, len(envSpec.Values), 0, "environment should have values from first base")
|
|
|
|
// Check that RenderedValues has the example.enabled value
|
|
require.NotNil(t, state.RenderedValues, "rendered values should not be nil")
|
|
exampleVal, ok := state.RenderedValues["example"]
|
|
require.True(t, ok, "example key should exist in rendered values")
|
|
exampleMap, ok := exampleVal.(map[string]any)
|
|
require.True(t, ok, "example should be a map")
|
|
enabled, ok := exampleMap["enabled"]
|
|
require.True(t, ok, "enabled key should exist")
|
|
require.Equal(t, true, enabled, "enabled should be true")
|
|
},
|
|
},
|
|
{
|
|
name: "environment values should merge when second base adds values",
|
|
files: map[string]string{
|
|
"/path/one.yaml": `environments:
|
|
sandbox:
|
|
values:
|
|
- example:
|
|
enabled: true
|
|
`,
|
|
"/path/two.yaml": `environments:
|
|
sandbox:
|
|
values:
|
|
- another:
|
|
setting: value
|
|
`,
|
|
"/path/helmfile.yaml": `bases:
|
|
- one.yaml
|
|
- two.yaml
|
|
---
|
|
repositories:
|
|
- name: examples
|
|
url: https://helm.github.io/examples
|
|
releases:
|
|
- name: example
|
|
chart: examples/hello-world
|
|
`,
|
|
},
|
|
mainFile: "/path/helmfile.yaml",
|
|
environment: "sandbox",
|
|
checkValues: func(t *testing.T, state *HelmState) {
|
|
// Check that both values from both bases are present
|
|
require.NotNil(t, state.RenderedValues, "rendered values should not be nil")
|
|
|
|
exampleVal, ok := state.RenderedValues["example"]
|
|
require.True(t, ok, "example key should exist in rendered values")
|
|
exampleMap, ok := exampleVal.(map[string]any)
|
|
require.True(t, ok, "example should be a map")
|
|
enabled, ok := exampleMap["enabled"]
|
|
require.True(t, ok, "enabled key should exist")
|
|
require.Equal(t, true, enabled, "enabled should be true")
|
|
|
|
anotherVal, ok := state.RenderedValues["another"]
|
|
require.True(t, ok, "another key should exist in rendered values")
|
|
anotherMap, ok := anotherVal.(map[string]any)
|
|
require.True(t, ok, "another should be a map")
|
|
setting, ok := anotherMap["setting"]
|
|
require.True(t, ok, "setting key should exist")
|
|
require.Equal(t, "value", setting, "setting should be 'value'")
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
creator := &StateCreator{
|
|
logger: logger,
|
|
fs: &filesystem.FileSystem{
|
|
ReadFile: func(filename string) ([]byte, error) {
|
|
content, ok := tt.files[filename]
|
|
if !ok {
|
|
return nil, fmt.Errorf("file not found: %s", filename)
|
|
}
|
|
return []byte(content), nil
|
|
},
|
|
},
|
|
valsRuntime: valsRuntime,
|
|
Strict: true,
|
|
}
|
|
creator.LoadFile = func(inheritedEnv, overrodeEnv *environment.Environment, baseDir, file string, evaluateBases bool) (*HelmState, error) {
|
|
path := filepath.Join(baseDir, file)
|
|
content, ok := tt.files[path]
|
|
if !ok {
|
|
return nil, fmt.Errorf("file not found: %s", path)
|
|
}
|
|
// When loading base files, we don't apply defaults - they should only
|
|
// be applied to the main file after all parts/bases are merged.
|
|
// So applyDefaults = evaluateBases (true for main, false for bases).
|
|
applyDefaults := evaluateBases
|
|
return creator.ParseAndLoad([]byte(content), filepath.Dir(path), path, tt.environment, true, evaluateBases, applyDefaults, inheritedEnv, overrodeEnv)
|
|
}
|
|
|
|
yamlContent, ok := tt.files[tt.mainFile]
|
|
if !ok {
|
|
t.Fatalf("no file named %q registered", tt.mainFile)
|
|
}
|
|
|
|
state, err := creator.ParseAndLoad([]byte(yamlContent), filepath.Dir(tt.mainFile), tt.mainFile, tt.environment, true, true, true, nil, nil)
|
|
if tt.expectedError {
|
|
require.Error(t, err, "expected an error but got none")
|
|
return
|
|
}
|
|
require.NoError(t, err, "unexpected error: %v", err)
|
|
|
|
if tt.checkValues != nil {
|
|
tt.checkValues(t, state)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// mergeEnvironments must keep the established "later layer wins over earlier
|
|
// layer" semantics even when the resolved strategy is fallback. Under override
|
|
// the natural append order (dst then src) achieves that because last-wins
|
|
// chooses src; under fallback we have to prepend src so that first-wins still
|
|
// resolves to src. Without this adjustment, a base helmfile's values would
|
|
// silently override values declared in the main helmfile that includes it.
|
|
func TestMergeEnvironments_LaterLayerWinsRegardlessOfStrategy(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
strategy string
|
|
wantOrdering []any
|
|
}{
|
|
{
|
|
name: "override appends src after dst (last wins)",
|
|
strategy: MergeStrategyOverride,
|
|
wantOrdering: []any{"base.yaml", "main.yaml"},
|
|
},
|
|
{
|
|
name: "empty strategy defaults to override semantics",
|
|
strategy: "",
|
|
wantOrdering: []any{"base.yaml", "main.yaml"},
|
|
},
|
|
{
|
|
name: "fallback prepends src (first wins) so main still beats base",
|
|
strategy: MergeStrategyFallback,
|
|
wantOrdering: []any{"main.yaml", "base.yaml"},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
dst := map[string]EnvironmentSpec{
|
|
"prod": {Values: []any{"base.yaml"}, MergeStrategy: tt.strategy},
|
|
}
|
|
src := map[string]EnvironmentSpec{
|
|
"prod": {Values: []any{"main.yaml"}, MergeStrategy: tt.strategy},
|
|
}
|
|
mergeEnvironments(dst, src)
|
|
got := dst["prod"].Values
|
|
if !reflect.DeepEqual(got, tt.wantOrdering) {
|
|
t.Errorf("Values ordering: want %v, got %v", tt.wantOrdering, got)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// mergeEnvironments must preserve MergeStrategy when layering multiple
|
|
// helmfiles (bases). Without this, an environment that opted into
|
|
// fallback in a base helmfile would silently fall back to the default
|
|
// override behavior in any helmfile that re-declares the environment.
|
|
func TestMergeEnvironments_PreservesMergeStrategy(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
dst EnvironmentSpec
|
|
src EnvironmentSpec
|
|
expected string
|
|
}{
|
|
{
|
|
name: "src declares fallback, dst empty",
|
|
dst: EnvironmentSpec{},
|
|
src: EnvironmentSpec{MergeStrategy: MergeStrategyFallback},
|
|
expected: MergeStrategyFallback,
|
|
},
|
|
{
|
|
name: "dst declares fallback, src empty preserves dst",
|
|
dst: EnvironmentSpec{MergeStrategy: MergeStrategyFallback},
|
|
src: EnvironmentSpec{},
|
|
expected: MergeStrategyFallback,
|
|
},
|
|
{
|
|
name: "src override wins over dst fallback",
|
|
dst: EnvironmentSpec{MergeStrategy: MergeStrategyFallback},
|
|
src: EnvironmentSpec{MergeStrategy: MergeStrategyOverride},
|
|
expected: MergeStrategyOverride,
|
|
},
|
|
{
|
|
name: "both empty stays empty",
|
|
dst: EnvironmentSpec{},
|
|
src: EnvironmentSpec{},
|
|
expected: "",
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
dst := map[string]EnvironmentSpec{"prod": tt.dst}
|
|
src := map[string]EnvironmentSpec{"prod": tt.src}
|
|
mergeEnvironments(dst, src)
|
|
if got := dst["prod"].MergeStrategy; got != tt.expected {
|
|
t.Errorf("MergeStrategy after merge: want %q, got %q", tt.expected, got)
|
|
}
|
|
})
|
|
}
|
|
}
|