add the ability to wrap CRDs in a conditional

Author: arcanez

.gitignore

@@ -28,3 +28,4 @@ testbin/*
 
 dist/
 
+vendor/

cmd/helmify/flags.go

@@ -61,16 +61,18 @@ func ReadFlags() config.Config {
 	flag.BoolVar(&result.Verbose, "v", false, "Enable verbose output (print WARN & INFO). Example: helmify -v")
 	flag.BoolVar(&result.VeryVerbose, "vv", false, "Enable very verbose output. Same as verbose but with DEBUG. Example: helmify -vv")
 	flag.BoolVar(&crd, "crd-dir", false, "Enable crd install into 'crds' directory.\nWarning: CRDs placed in 'crds' directory will not be templated by Helm.\nSee https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations\nExample: helmify -crd-dir")
-	flag.BoolVar(&result.ImagePullSecrets, "image-pull-secrets", false, "Allows the user to use existing secrets as imagePullSecrets in values.yaml")
+	flag.BoolVar(&result.ImagePullSecrets, "image-pull-secrets", false, "Allows the user to use existing secrets as imagePullSecrets in values.yaml.")
 	flag.BoolVar(&result.GenerateDefaults, "generate-defaults", false, "Allows the user to add empty placeholders for typical customization options in values.yaml. Currently covers: topology constraints, node selectors, tolerances")
 	flag.BoolVar(&result.CertManagerAsSubchart, "cert-manager-as-subchart", false, "Allows the user to add cert-manager as a subchart")
 	flag.StringVar(&result.CertManagerVersion, "cert-manager-version", "v1.12.2", "Allows the user to specify cert-manager subchart version. Only useful with cert-manager-as-subchart.")
 	flag.BoolVar(&result.CertManagerInstallCRD, "cert-manager-install-crd", true, "Allows the user to install cert-manager CRD. Only useful with cert-manager-as-subchart.")
 	flag.BoolVar(&result.FilesRecursively, "r", false, "Scan dirs from -f option recursively")
 	flag.BoolVar(&result.OriginalName, "original-name", false, "Use the object's original name instead of adding the chart's release name as the common prefix.")
-	flag.Var(&files, "f", "File or directory containing k8s manifests")
-	flag.BoolVar(&preservens, "preserve-ns", false, "Use the object's original namespace instead of adding all the resources to a common namespace")
-	flag.BoolVar(&result.AddWebhookOption, "add-webhook-option", false, "Allows the user to add webhook option in values.yaml")
+	flag.Var(&files, "f", "File or directory containing k8s manifests.")
+	flag.BoolVar(&preservens, "preserve-ns", false, "Use the object's original namespace instead of adding all the resources to a common namespace.")
+	flag.BoolVar(&result.AddWebhookOption, "add-webhook-option", false, "Allows the user to add webhook option in values.yaml.")
+	flag.BoolVar(&result.WrapCRDs, "wrap-crds", false, "Allows the user to wrap CRDs in a conditional.")
+	flag.StringVar(&result.WrapCRDsCondition, "wrap-crds-condition", "crds.enabled", "Allows the user to wrap CRDs in helm chart by specifying a condition name.")
 
 	flag.Parse()
 	if h || help {

pkg/config/config.go

@@ -41,8 +41,12 @@ type Config struct {
 	OriginalName bool
 	// PreserveNs retains the namespaces on the Kubernetes manifests
 	PreserveNs bool
-	// AddWebhookOption enables the generation of a webhook option in values.yamlß
+	// AddWebhookOption enables the generation of a webhook option in values.yaml
 	AddWebhookOption bool
+	// WrapCRDs wraps Custom Resource Definitions in a conditional
+	WrapCRDs bool
+	// WrapCRDsCondition is the condition used to wrap the Custom Resource Definitions
+	WrapCRDsCondition string
 }
 
 func (c *Config) Validate() error {

pkg/processor/crd/crd.go

@@ -3,10 +3,11 @@ package crd
 import (
 	"bytes"
 	"fmt"
-	"github.com/sirupsen/logrus"
 	"io"
 	"strings"
 
+	"github.com/sirupsen/logrus"
+
 	v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -129,23 +130,35 @@ func (c crd) Process(appMeta helmify.AppMetadata, obj *unstructured.Unstructured
 	res := fmt.Sprintf(crdTeml, obj.GetName(), appMeta.ChartName(), annotations, labels, string(specYaml))
 	res = strings.ReplaceAll(res, "\n\n", "\n")
 
+	values := helmify.Values{}
+
+	if appMeta.Config().WrapCRDs {
+
+		cond := appMeta.Config().WrapCRDsCondition
+		res = fmt.Sprintf("{{- if .Values.%s }}\n%s\n{{- end }}", cond, res)
+		_, _ = values.Add(true, strings.Split(appMeta.Config().WrapCRDsCondition, ".")...)
+		logrus.WithField("crd", name).WithField("condition", cond).Info("wrapping CRDs in conditional")
+	}
+
 	return true, &result{
-		name: name + "-crd.yaml",
-		data: []byte(res),
+		name:   name + "-crd.yaml",
+		data:   []byte(res),
+		values: values,
 	}, nil
 }
 
 type result struct {
-	name string
-	data []byte
+	name   string
+	data   []byte
+	values helmify.Values
 }
 
 func (r *result) Filename() string {
 	return r.name
 }
 
 func (r *result) Values() helmify.Values {
-	return helmify.Values{}
+	return r.values
 }
 
 func (r *result) Write(writer io.Writer) error {

pkg/processor/crd/crd_test.go

@@ -3,6 +3,7 @@ package crd
 import (
 	"testing"
 
+	"github.com/arttor/helmify/pkg/config"
 	"github.com/arttor/helmify/pkg/metadata"
 
 	"github.com/arttor/helmify/internal"
@@ -45,4 +46,30 @@ func Test_crd_Process(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, false, processed)
 	})
+
+	t.Run("wrapped with condition", func(t *testing.T) {
+		obj := internal.GenerateObj(strCRD)
+
+		conditions := []string{"create", "enabled", "install"}
+
+		for _, cond := range conditions {
+			t.Run(cond, func(t *testing.T) {
+				meta := metadata.New(config.Config{WrapCRDs: true, WrapCRDsCondition: cond})
+				processed, tmpl, err := testInstance.Process(meta, obj)
+				assert.NoError(t, err)
+				assert.True(t, processed)
+				assert.NotNil(t, tmpl)
+
+				data := string(tmpl.(*result).data)
+
+				assert.Contains(t, data, "{{- if .Values.crds."+cond+" }}", "template should start with conditional")
+				assert.Contains(t, data, "{{- end }}", "template should end with conditional")
+
+				values := tmpl.(*result).values
+				val, ok := values["crds"].(map[string]any)
+				assert.True(t, ok, "expected crds key in values")
+				assert.Equal(t, true, val[cond])
+			})
+		}
+	})
 }