Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider path nestedness for all possible downward API values #1524

Merged
merged 2 commits into from
Apr 9, 2024
Merged

Consider path nestedness for all possible downward API values #1524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dda7d10
Consider path nestedness for all possible downward API values
mamachanko Apr 9, 2024
195e6e4
Remove redundant tests
mamachanko Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions pkg/template/downward_api_values.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,29 +55,29 @@ func (a DownwardAPIValues) AsYAMLs() ([][]byte, error) {
if err != nil {
return nil, err
}
keyValueContent, err = yaml.Marshal(map[string]string{item.Name: v})
keyValueContent, err = a.nestedKeyValue(item.Name, v)
} else {
keyValueContent, err = yaml.Marshal(map[string]string{item.Name: item.KubernetesVersion.Version})
keyValueContent, err = a.nestedKeyValue(item.Name, item.KubernetesVersion.Version)
}
case item.KappControllerVersion != nil:
if item.KappControllerVersion.Version == "" {
v, err := a.additionalDownwardAPIValues.KappControllerVersion()
if err != nil {
return nil, err
}
keyValueContent, err = yaml.Marshal(map[string]string{item.Name: v})
keyValueContent, err = a.nestedKeyValue(item.Name, v)
} else {
keyValueContent, err = yaml.Marshal(map[string]string{item.Name: item.KappControllerVersion.Version})
keyValueContent, err = a.nestedKeyValue(item.Name, item.KappControllerVersion.Version)
}
case item.KubernetesAPIs != nil:
if item.KubernetesAPIs.GroupVersions == nil {
v, err := a.additionalDownwardAPIValues.KubernetesAPIs()
if err != nil {
return nil, err
}
keyValueContent, err = yaml.Marshal(map[string]interface{}{item.Name: v})
keyValueContent, err = a.nestedKeyValue(item.Name, v)
} else {
keyValueContent, err = yaml.Marshal(map[string]interface{}{item.Name: item.KubernetesAPIs.GroupVersions})
keyValueContent, err = a.nestedKeyValue(item.Name, item.KubernetesAPIs.GroupVersions)
}
default:
return nil, fmt.Errorf("Invalid downward API item given")
Expand Down
67 changes: 24 additions & 43 deletions pkg/template/values_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,45 @@ func TestValues(t *testing.T) {

t.Run("name should allow nested key structure", func(t *testing.T) {
subject := subject
subject.AdditionalValues = AdditionalDownwardAPIValues{
KubernetesVersion: func() (string, error) {
return "test-kubernetes-version", nil
},
KubernetesAPIs: func() ([]string, error) {
return []string{"somegroup.example.com/someversion"}, nil
},
KappControllerVersion: func() (string, error) {
return "test-kapp-controller-version", nil
},
}
subject.ValuesFrom = []v1alpha1.AppTemplateValuesSource{{DownwardAPI: &v1alpha1.AppTemplateValuesDownwardAPI{
Items: []v1alpha1.AppTemplateValuesDownwardAPIItem{
{Name: "parent.child", FieldPath: "metadata.name"},
{Name: "parent.child1.child2", FieldPath: "metadata.namespace"},
{Name: "parent.childwith\\.dot", FieldPath: "metadata.namespace"},
{Name: "parent.kubernetes_version", KubernetesVersion: &v1alpha1.Version{}},
{Name: "parent.kubernetes_version_custom", KubernetesVersion: &v1alpha1.Version{Version: "test-kubernetes-version-custom"}},
{Name: "parent.kubernetes_apis", KubernetesAPIs: &v1alpha1.KubernetesAPIs{}},
{Name: "parent.kubernetes_apis_custom", KubernetesAPIs: &v1alpha1.KubernetesAPIs{GroupVersions: []string{"somecustomgroup.example.com/someversion"}}},
{Name: "parent.kapp_controller_version", KappControllerVersion: &v1alpha1.Version{}},
{Name: "parent.kapp_controller_version_custom", KubernetesVersion: &v1alpha1.Version{Version: "test-kapp-controller-version-custom"}},
}},
}}

paths, cleanup, err := subject.AsPaths(os.TempDir())
require.NoError(t, err)
require.Len(t, paths, 3)
require.Len(t, paths, 9)
t.Cleanup(cleanup)

assertFileContents(t, paths[0], "parent:\n child: some-name\n")
assertFileContents(t, paths[1], "parent:\n child1:\n child2: some-namespace\n")
assertFileContents(t, paths[2], "parent:\n childwith.dot: some-namespace\n")
assertFileContents(t, paths[3], "parent:\n kubernetes_version: test-kubernetes-version\n")
assertFileContents(t, paths[4], "parent:\n kubernetes_version_custom: test-kubernetes-version-custom\n")
assertFileContents(t, paths[5], "parent:\n kubernetes_apis:\n - somegroup.example.com/someversion\n")
assertFileContents(t, paths[6], "parent:\n kubernetes_apis_custom:\n - somecustomgroup.example.com/someversion\n")
assertFileContents(t, paths[7], "parent:\n kapp_controller_version: test-kapp-controller-version\n")
assertFileContents(t, paths[8], "parent:\n kapp_controller_version_custom: test-kapp-controller-version-custom\n")
})

t.Run("map field paths should allow subpaths", func(t *testing.T) {
Expand Down Expand Up @@ -229,48 +252,6 @@ func TestValues(t *testing.T) {
require.Error(t, err)
assert.ErrorContains(t, err, "Invalid field spec provided to DownwardAPI. Only single supported fields are allowed")
})

t.Run("return kubernetes cluster version if not supplied", func(t *testing.T) {
subject := subject
subject.ValuesFrom = []v1alpha1.AppTemplateValuesSource{{DownwardAPI: &v1alpha1.AppTemplateValuesDownwardAPI{
Items: []v1alpha1.AppTemplateValuesDownwardAPIItem{
{Name: "k8s-version", KubernetesVersion: &v1alpha1.Version{}},
}},
}}
subject.AdditionalValues = AdditionalDownwardAPIValues{
KubernetesVersion: func() (string, error) {
return "0.20.0", nil
},
}

paths, cleanup, err := subject.AsPaths(os.TempDir())
require.NoError(t, err)
t.Cleanup(cleanup)

require.Len(t, paths, 1)
assertFileContents(t, paths[0], "k8s-version: 0.20.0\n")
})

t.Run("return kapp-controller version", func(t *testing.T) {
subject := subject
subject.ValuesFrom = []v1alpha1.AppTemplateValuesSource{{DownwardAPI: &v1alpha1.AppTemplateValuesDownwardAPI{
Items: []v1alpha1.AppTemplateValuesDownwardAPIItem{
{Name: "kc-version", KappControllerVersion: &v1alpha1.Version{}},
}},
}}
subject.AdditionalValues = AdditionalDownwardAPIValues{
KappControllerVersion: func() (string, error) {
return "0.42.31337", nil
},
}

paths, cleanup, err := subject.AsPaths(os.TempDir())
require.NoError(t, err)
t.Cleanup(cleanup)

require.Len(t, paths, 1)
assertFileContents(t, paths[0], "kc-version: 0.42.31337\n")
})
})
}

Expand Down
Loading