Merge pull request #87 from mittwald/fix/spec-interface-type

[BREAKING] remove PostRenderer interface type from ChartSpec

.github/workflows/build.yml

@@ -14,14 +14,12 @@ jobs:
 
       - uses: actions/checkout@v2
 
-      - name: Install and run mockgen
+      - name: Run go generate
         run: |
           set -x
           apt-get -y update && apt-get -y install git
-          cd /
           go install github.com/golang/mock/[email protected]
-          cd -
-          go env
+          go install sigs.k8s.io/controller-tools/cmd/[email protected] 
           go generate ./...
           git diff | cat
           git status --porcelain=v1

client.go

@@ -200,29 +200,29 @@ func (c *HelmClient) UpdateChartRepos() error {
 
 // InstallOrUpgradeChart installs or upgrades the provided chart and returns the corresponding release.
 // Namespace and other context is provided via the helmclient.Options struct when instantiating a client.
-func (c *HelmClient) InstallOrUpgradeChart(ctx context.Context, spec *ChartSpec) (*release.Release, error) {
+func (c *HelmClient) InstallOrUpgradeChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error) {
 	exists, err := c.chartExists(spec)
 	if err != nil {
 		return nil, err
 	}
 
 	if exists {
-		return c.upgrade(ctx, spec)
+		return c.upgrade(ctx, spec, opts)
 	}
 
-	return c.install(ctx, spec)
+	return c.install(ctx, spec, opts)
 }
 
 // InstallChart installs the provided chart and returns the corresponding release.
 // Namespace and other context is provided via the helmclient.Options struct when instantiating a client.
-func (c *HelmClient) InstallChart(ctx context.Context, spec *ChartSpec) (*release.Release, error) {
-	return c.install(ctx, spec)
+func (c *HelmClient) InstallChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error) {
+	return c.install(ctx, spec, opts)
 }
 
 // UpgradeChart upgrades the provided chart and returns the corresponding release.
 // Namespace and other context is provided via the helmclient.Options struct when instantiating a client.
-func (c *HelmClient) UpgradeChart(ctx context.Context, spec *ChartSpec) (*release.Release, error) {
-	return c.upgrade(ctx, spec)
+func (c *HelmClient) UpgradeChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error) {
+	return c.upgrade(ctx, spec, opts)
 }
 
 // ListDeployedReleases lists all deployed releases.
@@ -265,7 +265,7 @@ func (c *HelmClient) UninstallReleaseByName(name string) error {
 
 // install installs the provided chart.
 // Optionally lints the chart if the linting flag is set.
-func (c *HelmClient) install(ctx context.Context, spec *ChartSpec) (*release.Release, error) {
+func (c *HelmClient) install(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error) {
 	client := action.NewInstall(c.ActionConfig)
 	mergeInstallOptions(spec, client)
 
@@ -281,8 +281,10 @@ func (c *HelmClient) install(ctx context.Context, spec *ChartSpec) (*release.Rel
 		client.Version = ">0.0.0-0"
 	}
 
-	if spec.PostRenderer != nil {
-		client.PostRenderer = spec.PostRenderer
+	if opts != nil {
+		if opts.PostRenderer != nil {
+			client.PostRenderer = opts.PostRenderer
+		}
 	}
 
 	helmChart, chartPath, err := c.getChart(spec.ChartName, &client.ChartPathOptions)
@@ -327,7 +329,7 @@ func (c *HelmClient) install(ctx context.Context, spec *ChartSpec) (*release.Rel
 
 // upgrade upgrades a chart and CRDs.
 // Optionally lints the chart if the linting flag is set.
-func (c *HelmClient) upgrade(ctx context.Context, spec *ChartSpec) (*release.Release, error) {
+func (c *HelmClient) upgrade(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error) {
 	client := action.NewUpgrade(c.ActionConfig)
 	mergeUpgradeOptions(spec, client)
 	client.Install = true
@@ -336,8 +338,10 @@ func (c *HelmClient) upgrade(ctx context.Context, spec *ChartSpec) (*release.Rel
 		client.Version = ">0.0.0-0"
 	}
 
-	if spec.PostRenderer != nil {
-		client.PostRenderer = spec.PostRenderer
+	if opts != nil {
+		if opts.PostRenderer != nil {
+			client.PostRenderer = opts.PostRenderer
+		}
 	}
 
 	helmChart, chartPath, err := c.getChart(spec.ChartName, &client.ChartPathOptions)

client_test.go

@@ -115,7 +115,7 @@ func ExampleHelmClient_InstallOrUpgradeChart() {
 
 	// Install a chart release.
 	// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
-	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec); err != nil {
+	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
 		panic(err)
 	}
 }
@@ -130,7 +130,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useChartDirectory() {
 		Wait:        true,
 	}
 
-	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec); err != nil {
+	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
 		panic(err)
 	}
 }
@@ -145,7 +145,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useLocalChartArchive() {
 		Wait:        true,
 	}
 
-	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec); err != nil {
+	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
 		panic(err)
 	}
 }
@@ -160,7 +160,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useURL() {
 		Wait:        true,
 	}
 
-	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec); err != nil {
+	if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
 		panic(err)
 	}
 }

hack/boilerplate.go.txt

@@ -0,0 +1,15 @@
+/*
+Copyright 2022.
+
+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.
+*/

interface.go

@@ -15,9 +15,9 @@ import (
 type Client interface {
 	AddOrUpdateChartRepo(entry repo.Entry) error
 	UpdateChartRepos() error
-	InstallOrUpgradeChart(ctx context.Context, spec *ChartSpec) (*release.Release, error)
-	InstallChart(ctx context.Context, spec *ChartSpec) (*release.Release, error)
-	UpgradeChart(ctx context.Context, spec *ChartSpec) (*release.Release, error)
+	InstallOrUpgradeChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error)
+	InstallChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error)
+	UpgradeChart(ctx context.Context, spec *ChartSpec, opts *GenericHelmOptions) (*release.Release, error)
 	ListDeployedReleases() ([]*release.Release, error)
 	ListReleasesByStateMask(action.ListStates) ([]*release.Release, error)
 	GetRelease(name string) (*release.Release, error)

types.go

@@ -61,7 +61,14 @@ type HelmClient struct {
 	DebugLog     action.DebugLog
 }
 
+type GenericHelmOptions struct {
+	PostRenderer postrender.PostRenderer
+}
+
+//go:generate controller-gen object object:headerFile="./hack/boilerplate.go.txt" paths="./..." output:dir=.
+
 // ChartSpec defines the values of a helm chart
+// +kubebuilder:object:generate:=true
 type ChartSpec struct {
 	ReleaseName string `json:"release"`
 	ChartName   string `json:"chart"`
@@ -139,8 +146,4 @@ type ChartSpec struct {
 	// DryRun indicates whether to perform a dry run.
 	// +optional
 	DryRun bool `json:"dryRun,omitempty"`
-	// PostRenderer to run on the Helm Chart
-	// +kubebuilder:validation:Schemaless
-	// +optional
-	PostRenderer postrender.PostRenderer `json:"postRenderer,omitempty"`
 }