wip: registry+v1 to helm chart

- handling for all install mode combinations is working
- subscription.spec.config support

Author: joelanford

cmd/registryv1-to-helm/main.go

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+	"helm.sh/helm/v3/pkg/chartutil"
+
+	v2 "github.com/operator-framework/operator-controller/internal/rukpak/convert/v2"
+)
+
+func main() {
+	if err := rootCmd().Execute(); err != nil {
+		os.Exit(1)
+	}
+}
+
+func rootCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:  "registryv1-to-helm <registry+v1-directory-path> [output-path]",
+		Args: cobra.RangeArgs(1, 2),
+		Run: func(cmd *cobra.Command, args []string) {
+			registryv1Path := args[0]
+
+			saveDir := "."
+			if len(args) == 2 {
+				saveDir = args[1]
+			}
+
+			chrt, err := v2.RegistryV1ToHelmChart(cmd.Context(), os.DirFS(registryv1Path))
+			if err != nil {
+				cmd.PrintErr(err)
+				os.Exit(1)
+			}
+
+			if err := chartutil.SaveDir(chrt, saveDir); err != nil {
+				cmd.PrintErr(err)
+				os.Exit(1)
+			}
+			cmd.Printf("Chart saved to %s\n", filepath.Join(saveDir, chrt.Metadata.Name))
+		},
+	}
+	return cmd
+}

cmd/registryv1-to-helm/values.yaml

@@ -0,0 +1,39 @@
+affinity:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: node-role.kubernetes.io/master
+          operator: Exists
+nodeSelector:
+  overrideKey1: overrideValue1
+
+selector:
+  overrideKey2: overrideValue2
+
+tolerations:
+ - effect: NoSchedule
+   key: node-role.kubernetes.io/master2
+
+volumes:
+    - name: argocd-operator-token-5z5z2
+      emptyDir: {}
+
+env:
+  - name: WATCH_NAMESPACE
+    value: BAR
+
+envFrom:
+  - configMapRef:
+      name: my-configmap
+  - secretRef:
+      name: my-secret
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 100Mi
+
+volumeMounts:
+  - name: tmp
+    mountPath: override

go.mod

@@ -11,15 +11,19 @@ require (
 	github.com/containers/image/v5 v5.32.2
 	github.com/fsnotify/fsnotify v1.7.0
 	github.com/go-logr/logr v1.4.2
+	github.com/go-openapi/loads v0.22.0
+	github.com/go-openapi/spec v0.21.0
 	github.com/google/go-cmp v0.6.0
 	github.com/google/go-containerregistry v0.20.2
+	github.com/joeycumines/go-dotnotation v0.0.0-20180131115956-2d3612e36c5d
 	github.com/onsi/ginkgo/v2 v2.20.2
 	github.com/onsi/gomega v1.34.2
 	github.com/opencontainers/go-digest v1.0.0
 	github.com/operator-framework/api v0.27.0
 	github.com/operator-framework/catalogd v0.35.0
 	github.com/operator-framework/helm-operator-plugins v0.7.0
 	github.com/operator-framework/operator-registry v1.48.0
+	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
@@ -101,9 +105,7 @@ require (
 	github.com/go-openapi/errors v0.22.0 // indirect
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect
-	github.com/go-openapi/loads v0.22.0 // indirect
 	github.com/go-openapi/runtime v0.28.0 // indirect
-	github.com/go-openapi/spec v0.21.0 // indirect
 	github.com/go-openapi/strfmt v0.23.0 // indirect
 	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/go-openapi/validate v0.24.0 // indirect
@@ -193,7 +195,6 @@ require (
 	github.com/sigstore/sigstore v1.8.4 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/cast v1.7.0 // indirect
-	github.com/spf13/cobra v1.8.1 // indirect
 	github.com/stefanberger/go-pkcs11uri v0.0.0-20230803200340-78284954bff6 // indirect
 	github.com/stoewer/go-strcase v1.3.0 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect

go.sum

@@ -392,6 +392,8 @@ github.com/jmoiron/sqlx v1.4.0 h1:1PLqN7S1UYp5t4SrVVnt4nUVNemrDAtxlulVe+Qgm3o=
 github.com/jmoiron/sqlx v1.4.0/go.mod h1:ZrZ7UsYB/weZdl2Bxg6jCRO9c3YHl8r3ahlKmRT4JLY=
 github.com/joelanford/ignore v0.1.0 h1:VawbTDeg5EL+PN7W8gxVzGerfGpVo3gFdR5ZAqnkYRk=
 github.com/joelanford/ignore v0.1.0/go.mod h1:Vb0PQMAQXK29fmiPjDukpO8I2NTcp1y8LbhFijD1/0o=
+github.com/joeycumines/go-dotnotation v0.0.0-20180131115956-2d3612e36c5d h1:ljoJyU5NEhe3LWXrRSHnYqWtQehQSJ+9d9tfIGNbpSw=
+github.com/joeycumines/go-dotnotation v0.0.0-20180131115956-2d3612e36c5d/go.mod h1:siHz7M0dAufA9aNRidkfckDSVB/S+Ld7allyOe5uxVg=
 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=

internal/rukpak/convert/registryv1.go

@@ -39,7 +39,7 @@ type Plain struct {
 	Objects []client.Object
 }
 
-func RegistryV1ToHelmChart(ctx context.Context, rv1 fs.FS, installNamespace string, watchNamespaces []string) (*chart.Chart, error) {
+func LoadRegistryV1(ctx context.Context, rv1 fs.FS) (*RegistryV1, error) {
 	l := log.FromContext(ctx)
 
 	reg := RegistryV1{}
@@ -100,8 +100,16 @@ func RegistryV1ToHelmChart(ctx context.Context, rv1 fs.FS, installNamespace stri
 	}); err != nil {
 		return nil, err
 	}
+	return &reg, nil
+}
+
+func RegistryV1ToHelmChart(ctx context.Context, rv1 fs.FS, installNamespace string, watchNamespaces []string) (*chart.Chart, error) {
+	reg, err := LoadRegistryV1(ctx, rv1)
+	if err != nil {
+		return nil, err
+	}
 
-	return toChart(reg, installNamespace, watchNamespaces)
+	return toChart(*reg, installNamespace, watchNamespaces)
 }
 
 func toChart(in RegistryV1, installNamespace string, watchNamespaces []string) (*chart.Chart, error) {
@@ -195,17 +203,17 @@ func Convert(in RegistryV1, installNamespace string, targetNamespaces []string)
 	for _, depSpec := range in.CSV.Spec.InstallStrategy.StrategySpec.DeploymentSpecs {
 		annotations := util.MergeMaps(in.CSV.Annotations, depSpec.Spec.Template.Annotations)
 		annotations["olm.targetNamespaces"] = strings.Join(targetNamespaces, ",")
+		depSpec.Spec.Template.Annotations = annotations
 		deployments = append(deployments, appsv1.Deployment{
 			TypeMeta: metav1.TypeMeta{
 				Kind:       "Deployment",
 				APIVersion: appsv1.SchemeGroupVersion.String(),
 			},
 
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace:   installNamespace,
-				Name:        depSpec.Name,
-				Labels:      depSpec.Label,
-				Annotations: annotations,
+				Namespace: installNamespace,
+				Name:      depSpec.Name,
+				Labels:    depSpec.Label,
 			},
 			Spec: depSpec.Spec,
 		})

internal/rukpak/convert/v2/internal/parametrize/block.go

@@ -0,0 +1,116 @@
+package parametrize
+
+import (
+	"bytes"
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/joeycumines/go-dotnotation/dotnotation"
+	"k8s.io/apimachinery/pkg/util/uuid"
+	"sigs.k8s.io/yaml"
+)
+
+var _ Instruction = (*block)(nil)
+
+// Wrap the given field path into a template block.
+func Block(exp string, fieldPath string) Instruction {
+	return &block{
+		marker:    string(uuid.NewUUID()),
+		pipeline:  exp,
+		fieldPath: fieldPath,
+	}
+}
+
+// block represents the instruction to wrap the YAML structure
+// at the given fieldPath into a template block.
+type block struct {
+	marker    string
+	pipeline  string
+	fieldPath string
+
+	mapKey        string      // map key to merge structures on.
+	originalValue interface{} // YAML object found at position.
+	writeValue    interface{} // YAML object to write out.
+}
+
+func (b *block) Mark(obj map[string]interface{}) error {
+	var parentValue interface{}
+	lastDotIdx := strings.LastIndex(b.fieldPath, ".")
+	if lastDotIdx != -1 {
+		var err error
+		parentPath := b.fieldPath[:lastDotIdx]
+		parentValue, err = dotnotation.Get(obj, parentPath)
+		if err != nil {
+			return err
+		}
+	} else {
+		parentValue = obj
+	}
+
+	origValue, err := dotnotation.Get(obj, b.fieldPath)
+	if err != nil {
+		return err
+	}
+	b.originalValue = origValue
+	if _, ok := parentValue.([]interface{}); ok {
+		// wrap array items in an array again.
+		b.mapKey = b.fieldPath
+		if _, ok := origValue.([]interface{}); !ok {
+			origValue = []interface{}{origValue}
+		}
+	} else {
+		b.mapKey = b.fieldPath
+		if lastDotIdx != -1 {
+			b.mapKey = b.fieldPath[lastDotIdx+1:]
+		}
+		// wrap field values in map key.
+		origValue = map[string]interface{}{
+			b.mapKey: origValue,
+		}
+	}
+
+	b.writeValue = origValue
+	return dotnotation.Set(obj, b.fieldPath, b.marker)
+}
+
+func (b *block) Replace(in []byte) ([]byte, error) {
+	re := regexp.MustCompile(`(?m).*` + b.marker + `\n*`)
+	found := re.Find(in)
+	if found == nil {
+		// marker not found -> do nothing.
+		return nil, nil
+	}
+
+	il := indentLevel(found)
+	origB, err := yaml.Marshal(b.writeValue)
+	if err != nil {
+		return nil, err
+	}
+
+	i := strings.Repeat(" ", il)
+	var replacement string
+	replacement += fmt.Sprintf("%s{{- %s }}\n", i, b.pipeline)
+	for _, l := range bytes.Split(bytes.TrimSpace(origB), []byte("\n")) {
+		replacement += fmt.Sprintf("%s%s\n", i, l)
+	}
+	replacement += i + "{{- end }}\n"
+
+	return re.ReplaceAll(in, []byte(replacement)), nil
+}
+
+func (b *block) Priority() int {
+	return 100
+}
+
+func indentLevel(b []byte) int {
+	var indentLevel int
+	for _, c := range b {
+		if rune(c) == rune(' ') {
+			indentLevel++
+		} else {
+			break
+		}
+	}
+	return indentLevel
+}

internal/rukpak/convert/v2/internal/parametrize/mergeblock.go

@@ -0,0 +1,77 @@
+package parametrize
+
+import (
+	"bytes"
+	"fmt"
+	"regexp"
+	"strings"
+
+	"k8s.io/apimachinery/pkg/util/uuid"
+	"sigs.k8s.io/yaml"
+)
+
+var _ Instruction = (*mergeBlock)(nil)
+
+// Wrap the given field path into a template block merging data structures.
+func MergeBlock(pipeline string, fieldPath string) Instruction {
+	return &mergeBlock{
+		block: block{
+			marker:    string(uuid.NewUUID()),
+			pipeline:  pipeline,
+			fieldPath: fieldPath,
+		},
+	}
+}
+
+// mergeBlock represents the instruction to wrap the YAML structure
+// at the given fieldPath into a template block merging data structures.
+type mergeBlock struct {
+	block
+}
+
+func (b *mergeBlock) Replace(in []byte) ([]byte, error) {
+	re := regexp.MustCompile(`(?m).*` + b.marker + `\n*`)
+	found := re.Find(in)
+	if found == nil {
+		// marker not found -> do nothing.
+		return nil, nil
+	}
+
+	il := indentLevel(found)
+	origB, err := yaml.Marshal(b.writeValue)
+	if err != nil {
+		return nil, err
+	}
+
+	i := strings.Repeat(" ", il)
+	var replacement bytes.Buffer
+	if _, err = fmt.Fprintf(&replacement, "%s{{- define %q }}\n", i, b.marker); err != nil {
+		return nil, err
+	}
+	for _, l := range bytes.Split(bytes.TrimSpace(origB), []byte("\n")) {
+		if _, err = fmt.Fprintf(&replacement, "%s%s\n", i, l); err != nil {
+			return nil, err
+		}
+	}
+	if _, err = fmt.Fprintf(&replacement, `%s{{- end }}{{"\n"}}`+"\n", i); err != nil {
+		return nil, err
+	}
+	if _, isSlice := b.originalValue.([]interface{}); isSlice {
+		// assume data is a slice.
+		if _, err = fmt.Fprintf(&replacement,
+			`%s{{- dict %q (concat (fromYaml (include %q .)).%s (%s)) | toYaml | indent %d }}`+"\n",
+			i, b.mapKey, b.marker, b.mapKey, b.pipeline, len(i),
+		); err != nil {
+			return nil, err
+		}
+		return re.ReplaceAll(in, replacement.Bytes()), nil
+	}
+	// assume data is a map.
+	if _, err = fmt.Fprintf(&replacement,
+		`%s{{- mergeOverwrite (fromYaml (include %q .)) (%s)  | toYaml | indent %d }}`+"\n",
+		i, b.marker, b.pipeline, len(i),
+	); err != nil {
+		return nil, err
+	}
+	return re.ReplaceAll(in, replacement.Bytes()), nil
+}