feat: support helm dryrun=server (#6691)

* feat: support helm dryrun=server Signed-off-by: Sam Wang (holyspectral) <sam.wang@suse.com> * fix: CI errors after test-sanity Signed-off-by: Sam Wang (holyspectral) <sam.wang@suse.com> * docs: update testdata/v3/memcached-operator to v4 Signed-off-by: Sam Wang (holyspectral) <sam.wang@suse.com> --------- Signed-off-by: Sam Wang (holyspectral) <sam.wang@suse.com>

Author: holyspectral

.cncf-maintainers

@@ -1,4 +1,5 @@
 approvers:
+- acornett21
 - anik120
 - everettraven
 - fabianvf
@@ -10,6 +11,7 @@ approvers:
 - theishshah
 - varshaprasad96
 reviewers:
+- acornett21
 - anik120
 - everettraven
 - fabianvf

internal/cmd/helm-operator/run/cmd.go

@@ -203,6 +203,7 @@ func run(cmd *cobra.Command, f *flags.Flags) {
 SuppressOverrideValues: f.SuppressOverrideValues,
 MaxConcurrentReconciles: f.MaxConcurrentReconciles,
 Selector: w.Selector,
+DryRunOption: w.DryRunOption,
 })
 if err != nil {
 log.Error(err, "Failed to add manager factory to controller.")

internal/helm/controller/controller.go

@@ -52,6 +52,7 @@ type WatchOptions struct {
 SuppressOverrideValues bool
 MaxConcurrentReconciles int
 Selector metav1.LabelSelector
+DryRunOption string
 }
 
 // Add creates a new helm operator controller and adds it to the manager
@@ -66,6 +67,7 @@ func Add(mgr manager.Manager, options WatchOptions) error {
 ReconcilePeriod: options.ReconcilePeriod,
 OverrideValues: options.OverrideValues,
 SuppressOverrideValues: options.SuppressOverrideValues,
+DryRunOption: options.DryRunOption,
 }
 
 c, err := controller.New(controllerName, mgr, controller.Options{

internal/helm/controller/reconcile.go

@@ -55,6 +55,7 @@ type HelmOperatorReconciler struct {
 OverrideValues map[string]string
 SuppressOverrideValues bool
 releaseHook ReleaseHookFunc
+DryRunOption string
 }
 
 const (
@@ -96,7 +97,7 @@ func (r HelmOperatorReconciler) Reconcile(ctx context.Context, request reconcile
 return reconcile.Result{}, err
 }
 
-manager, err := r.ManagerFactory.NewManager(o, r.OverrideValues)
+manager, err := r.ManagerFactory.NewManager(o, r.OverrideValues, r.DryRunOption)
 if err != nil {
 log.Error(err, "Failed to get release manager")
 return reconcile.Result{}, err

internal/helm/release/manager.go

@@ -75,6 +75,8 @@ type manager struct {
 isUpgradeRequired bool
 deployedRelease *rpb.Release
 chart *cpb.Chart
+
+dryRunOption string
 }
 
 type InstallOption func(*action.Install) error
@@ -159,6 +161,7 @@ func (m manager) getCandidateRelease(namespace, name string, chart *cpb.Chart,
 upgrade := action.NewUpgrade(m.actionConfig)
 upgrade.Namespace = namespace
 upgrade.DryRun = true
+upgrade.DryRunOption = m.dryRunOption
 return upgrade.Run(name, chart, values)
 }
 

internal/helm/release/manager_factory.go

@@ -33,7 +33,7 @@ import (
 // improves decoupling between reconciliation logic and the Helm backend
 // components used to manage releases.
 type ManagerFactory interface {
-NewManager(r *unstructured.Unstructured, overrideValues map[string]string) (Manager, error)
+NewManager(r *unstructured.Unstructured, overrideValues map[string]string, dryRunOption string) (Manager, error)
 }
 
 type managerFactory struct {
@@ -47,7 +47,7 @@ func NewManagerFactory(mgr crmanager.Manager, acg client.ActionConfigGetter, cha
 return &managerFactory{mgr, acg, chartDir}
 }
 
-func (f managerFactory) NewManager(cr *unstructured.Unstructured, overrideValues map[string]string) (Manager, error) {
+func (f managerFactory) NewManager(cr *unstructured.Unstructured, overrideValues map[string]string, dryRunOption string) (Manager, error) {
 actionConfig, err := f.acg.ActionConfigFor(cr)
 if err != nil {
 return nil, fmt.Errorf("failed to get helm action config: %w", err)
@@ -86,9 +86,10 @@ func (f managerFactory) NewManager(cr *unstructured.Unstructured, overrideValues
 releaseName: releaseName,
 namespace: cr.GetNamespace(),
 
-chart: crChart,
-values: values,
-status: types.StatusFor(cr),
+chart: crChart,
+values: values,
+status: types.StatusFor(cr),
+dryRunOption: dryRunOption,
 }, nil
 }
 

internal/helm/watches/watches.go

@@ -40,6 +40,7 @@ type Watch struct {
 OverrideValues map[string]string `json:"overrideValues,omitempty"`
 Selector metav1.LabelSelector `json:"selector"`
 ReconcilePeriod metav1.Duration `json:"reconcilePeriod,omitempty"`
+DryRunOption string `json:"dryRunOption,omitempty"`
 }
 
 // UnmarshalYAML unmarshals an individual watch from the Helm watches.yaml file

internal/helm/watches/watches_test.go

@@ -101,7 +101,30 @@ func TestLoadReader(t *testing.T) {
 },
 expectErr: false,
 },
-
+{
+name: "valid with dry run option",
+data: `---
+- group: mygroup
+ version: v1alpha1
+ kind: MyKind
+ chart: ../../../internal/plugins/helm/v1/chartutil/testdata/test-chart
+ watchDependentResources: false
+ overrideValues:
+ key: $MY_VALUE
+ dryRunOption: server
+`,
+env: map[string]string{"MY_VALUE": "value"},
+expectWatches: []Watch{
+{
+GroupVersionKind: schema.GroupVersionKind{Group: "mygroup", Version: "v1alpha1", Kind: "MyKind"},
+ChartDir: "../../../internal/plugins/helm/v1/chartutil/testdata/test-chart",
+WatchDependentResources: &falseVal,
+OverrideValues: map[string]string{"key": "value"},
+DryRunOption: "server",
+},
+},
+expectErr: false,
+},
 {
 name: "invalid with override template expansion",
 data: `---

testdata/go/v4/memcached-operator/Makefile

@@ -48,7 +48,7 @@ endif
 
 # Set the Operator SDK version to use. By default, what is installed on the system is used.
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
-OPERATOR_SDK_VERSION ?= v1.33.0
+OPERATOR_SDK_VERSION ?= v1.34.0
 
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest

testdata/go/v4/monitoring/memcached-operator/Makefile

@@ -48,7 +48,7 @@ endif
 
 # Set the Operator SDK version to use. By default, what is installed on the system is used.
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
-OPERATOR_SDK_VERSION ?= v1.33.0
+OPERATOR_SDK_VERSION ?= v1.34.0
 
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest