feat(helm): add depBuild and template flags to HelmDeployFlags schema #9696
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| Copyright 2025 The Skaffold Authors | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package helm | ||
|
|
||
| import ( | ||
| "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/graph" | ||
| "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/helm" | ||
| "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" | ||
| ) | ||
|
|
||
| func (h Helm) depBuildArgs(chartPath string) []string { | ||
| args := []string{"dep", "build", chartPath} | ||
| args = append(args, h.config.Flags.DepBuild...) | ||
| return args | ||
| } | ||
|
|
||
| func (h Helm) templateArgs(releaseName string, release latest.HelmRelease, builds []graph.Artifact, namespace string, additionalArgs []string) ([]string, error) { | ||
| var err error | ||
| args := []string{"template", releaseName, helm.ChartSource(release)} | ||
| args = append(args, h.config.Flags.Template...) | ||
| args = append(args, additionalArgs...) | ||
|
|
||
| if release.Packaged == nil && release.Version != "" { | ||
| args = append(args, "--version", release.Version) | ||
| } | ||
|
|
||
| args, err = helm.ConstructOverrideArgs(&release, builds, args, h.manifestOverrides) | ||
| if err != nil { | ||
| return nil, helm.UserErr("construct override args", err) | ||
| } | ||
|
|
||
| if namespace != "" { | ||
| args = append(args, "--namespace", namespace) | ||
| } | ||
| if release.Repo != "" { | ||
| args = append(args, "--repo") | ||
| args = append(args, release.Repo) | ||
| } | ||
| if release.SkipTests { | ||
| args = append(args, "--skip-tests") | ||
| } | ||
|
|
||
| return args, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| Copyright 2025 The Skaffold Authors | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package helm | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/graph" | ||
| "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" | ||
| "github.com/GoogleContainerTools/skaffold/v2/testutil" | ||
| ) | ||
|
|
||
| func TestDepBuildArgs(t *testing.T) { | ||
| tests := []struct { | ||
| description string | ||
| chartPath string | ||
| flags latest.HelmDeployFlags | ||
| expected []string | ||
| }{ | ||
| { | ||
| description: "basic", | ||
| chartPath: "chart/path", | ||
| expected: []string{"dep", "build", "chart/path"}, | ||
| }, | ||
| { | ||
| description: "with flags", | ||
| chartPath: "chart/path", | ||
| flags: latest.HelmDeployFlags{ | ||
| DepBuild: []string{"--skip-refresh"}, | ||
| }, | ||
| expected: []string{"dep", "build", "chart/path", "--skip-refresh"}, | ||
| }, | ||
| { | ||
| description: "with multiple flags", | ||
| chartPath: "chart/path", | ||
| flags: latest.HelmDeployFlags{ | ||
| DepBuild: []string{"--skip-refresh", "--debug"}, | ||
| }, | ||
| expected: []string{"dep", "build", "chart/path", "--skip-refresh", "--debug"}, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| testutil.Run(t, test.description, func(t *testutil.T) { | ||
| h := Helm{ | ||
| config: &latest.Helm{ | ||
| Flags: test.flags, | ||
| }, | ||
| } | ||
| args := h.depBuildArgs(test.chartPath) | ||
| t.CheckDeepEqual(test.expected, args) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestTemplateArgs(t *testing.T) { | ||
| tests := []struct { | ||
| description string | ||
| releaseName string | ||
| release latest.HelmRelease | ||
| builds []graph.Artifact | ||
| namespace string | ||
| additionalArgs []string | ||
| flags latest.HelmDeployFlags | ||
| expected []string | ||
| shouldErr bool | ||
| }{ | ||
| { | ||
| description: "basic template", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ | ||
| ChartPath: "chart/path", | ||
| }, | ||
| expected: []string{"template", "release", "chart/path"}, | ||
| }, | ||
| { | ||
| description: "with version", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ | ||
| ChartPath: "chart/path", | ||
| Version: "1.2.3", | ||
| }, | ||
| expected: []string{"template", "release", "chart/path", "--version", "1.2.3"}, | ||
| }, | ||
| { | ||
| description: "with namespace", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ | ||
| ChartPath: "chart/path", | ||
| }, | ||
| namespace: "namespace", | ||
| expected: []string{"template", "release", "chart/path", "--namespace", "namespace"}, | ||
| }, | ||
| { | ||
| description: "with repo", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ | ||
| ChartPath: "chart/path", | ||
| Repo: "repo-url", | ||
| }, | ||
| expected: []string{"template", "release", "chart/path", "--repo", "repo-url"}, | ||
| }, | ||
| { | ||
| description: "with skipTests", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ | ||
| ChartPath: "chart/path", | ||
| SkipTests: true, | ||
| }, | ||
| expected: []string{"template", "release", "chart/path", "--skip-tests"}, | ||
| }, | ||
| { | ||
| description: "with additional args", | ||
| releaseName: "release", | ||
| release: latest.HelmRelease{ChartPath: "chart/path"}, | ||
| additionalArgs: []string{"--foo", "bar"}, | ||
| expected: []string{"template", "release", "chart/path", "--foo", "bar"}, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| testutil.Run(t, test.description, func(t *testutil.T) { | ||
| h := Helm{ | ||
| config: &latest.Helm{ | ||
| Flags: test.flags, | ||
| }, | ||
| } | ||
| args, err := h.templateArgs(test.releaseName, test.release, test.builds, test.namespace, test.additionalArgs) | ||
| if test.shouldErr { | ||
| t.CheckError(true, err) | ||
| } else { | ||
| t.CheckError(false, err) | ||
| t.CheckDeepEqual(test.expected, args) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -154,17 +154,6 @@ func (h Helm) generateHelmManifest(ctx context.Context, builds []graph.Artifact, | |
| return nil, helm.UserErr(fmt.Sprintf("cannot expand chart path %q", release.ChartPath), err) | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. it'll be better to write tests for the There was a problem hiding this comment. yeah, I'd agree. However, the method There was a problem hiding this comment. yes, it was a good idea to extract them and test independently, but at the same time, you've changed the logic as I've explained here #9696 (comment) |
||
| if len(release.Overrides.Values) > 0 { | ||
| overrides, err := yaml.Marshal(release.Overrides) | ||
| if err != nil { | ||
|
|
@@ -179,11 +168,7 @@ func (h Helm) generateHelmManifest(ctx context.Context, builds []graph.Artifact, | |
| os.Remove(constants.HelmOverridesFilename) | ||
| }() | ||
|
|
||
| additionalArgs = append(additionalArgs, "-f", constants.HelmOverridesFilename) | ||
| } | ||
|
|
||
| namespace, err := helm.ReleaseNamespace(h.namespace, release) | ||
|
|
@@ -193,22 +178,20 @@ func (h Helm) generateHelmManifest(ctx context.Context, builds []graph.Artifact, | |
| if h.namespace != "" { | ||
| namespace = h.namespace | ||
| } | ||
|
|
||
| outBuffer := new(bytes.Buffer) | ||
| errBuffer := new(bytes.Buffer) | ||
|
|
||
| args, err := h.templateArgs(releaseName, release, builds, namespace, additionalArgs) | ||
| if err != nil { | ||
| return nil, helm.UserErr("cannot construct helm template args", err) | ||
| } | ||
|
|
||
| // Build Chart dependencies, but allow a user to skip it. | ||
| if !release.SkipBuildDependencies && release.ChartPath != "" { | ||
| log.Entry(ctx).Info("Building helm dependencies...") | ||
| args := h.depBuildArgs(release.ChartPath) | ||
| if err := helm.ExecWithStdoutAndStderr(ctx, h, io.Discard, errBuffer, false, env, args...); err != nil { | ||
|
There was a problem hiding this comment. before: it can exit before I'm not sure if it's ok or not, but to preserve the old behavior you can move the |
||
| log.Entry(ctx).Info(errBuffer.String()) | ||
| return nil, helm.UserErr("building helm dependencies", err) | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you need this, or did you add it just in case? if the second one, then it'll be better to remove it, because the more things you add - the more things that should be support, it is better to add as needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's added here for consitency. If we don't add this for template then it means the commands
helm upgradeandhelm installbehave differenly fromhelm template. The latter is used primarily in gitops workflows. Leaving outtemplatewould mean that we don't have feature parity when we use skaffold to ask helm to apply the changes directly and when we use helm to template only.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you need this - keep it) I meant that there is no need to add something if you don't it, because less code - easy to maintain)