feat: arguments references

Signed-off-by: peefy <[email protected]>

Author: Peefy

api/v1alpha1/kclrun_types.go

@@ -130,7 +130,7 @@ type KCLRunSpec struct {
 	// ConfigReference holds references to ConfigMaps and Secrets containing
 	// the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
 	// +optional
-	ConfigReference *ConfigReference `json:"configReference,omitempty" yaml:"configReference,omitempty"`
+	ArgumentsReferences []ArgumentReference `json:"argumentsReferences,omitempty" yaml:"argumentsReferences,omitempty"`
 
 	// Prune enables garbage collection.
 	// +required
@@ -194,8 +194,8 @@ type ConfigSpec struct {
 	DisableNone bool `json:"disableNone,omitempty" yaml:"disableNone,omitempty"`
 }
 
-// ConfigReference contains a reference to a resource containing the KCL compile config.
-type ConfigReference struct {
+// ArgumentReference contains a reference to a resource containing the KCL compile config.
+type ArgumentReference struct {
 	// Kind of the values referent, valid values are ('Secret', 'ConfigMap').
 	// +kubebuilder:validation:Enum=Secret;ConfigMap
 	// +required

api/v1alpha1/kclrun_types_test.go

@@ -35,7 +35,7 @@ func TestKCLRunDeserialize(t *testing.T) {
 	assert.Equal(t, "/path/to/kcl_mod_file_path", kclRun.Spec.Path)
 	assert.NotNil(t, kclRun.Spec.Config)
 	assert.Contains(t, kclRun.Spec.Config.Arguments, "env=\"prod\"")
-	assert.NotNil(t, kclRun.Spec.ConfigReference)
-	assert.Equal(t, "ConfigMap", kclRun.Spec.ConfigReference.Kind)
-	assert.Equal(t, "config-map-reference", kclRun.Spec.ConfigReference.Name)
+	assert.NotNil(t, kclRun.Spec.ArgumentsReferences)
+	assert.Equal(t, "ConfigMap", kclRun.Spec.ArgumentsReferences[0].Kind)
+	assert.Equal(t, "config-map-reference", kclRun.Spec.ArgumentsReferences[0].Name)
 }

api/v1alpha1/testdata/kclrun.yaml

@@ -39,10 +39,10 @@ spec:
     sortKeys: true
     showHidden: false
     disableNone: true
-  configReference:
-    kind: ConfigMap
-    name: config-map-reference
-    optional: false
+  argumentsReferences:
+    - kind: ConfigMap
+      name: config-map-reference
+      optional: false
   prune: true
   healthChecks:
     - kind: Pod

config/crd/bases/krm.kcl.dev.fluxcd_kclruns.yaml

@@ -39,6 +39,40 @@ spec:
           spec:
             description: KCLRunSpec defines the desired state of KCLRun
             properties:
+              argumentsReferences:
+                description: |-
+                  ConfigReference holds references to ConfigMaps and Secrets containing
+                  the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
+                items:
+                  description: ArgumentReference contains a reference to a resource
+                    containing the KCL compile config.
+                  properties:
+                    kind:
+                      description: Kind of the values referent, valid values are ('Secret',
+                        'ConfigMap').
+                      enum:
+                      - Secret
+                      - ConfigMap
+                      type: string
+                    name:
+                      description: |-
+                        Name of the values referent. Should reside in the same namespace as the
+                        referring resource.
+                      maxLength: 253
+                      minLength: 1
+                      type: string
+                    optional:
+                      default: false
+                      description: |-
+                        Optional indicates whether the referenced resource must exist, or whether to
+                        tolerate its absence. If true and the referenced resource is absent, proceed
+                        as if the resource was present but empty, without any variables defined.
+                      type: boolean
+                  required:
+                  - kind
+                  - name
+                  type: object
+                type: array
               commonMetadata:
                 description: |-
                   CommonMetadata specifies the common labels and annotations that are
@@ -99,36 +133,6 @@ spec:
                     description: Vendor denotes running kcl in the vendor mode.
                     type: boolean
                 type: object
-              configReference:
-                description: |-
-                  ConfigReference holds references to ConfigMaps and Secrets containing
-                  the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
-                properties:
-                  kind:
-                    description: Kind of the values referent, valid values are ('Secret',
-                      'ConfigMap').
-                    enum:
-                    - Secret
-                    - ConfigMap
-                    type: string
-                  name:
-                    description: |-
-                      Name of the values referent. Should reside in the same namespace as the
-                      referring resource.
-                    maxLength: 253
-                    minLength: 1
-                    type: string
-                  optional:
-                    default: false
-                    description: |-
-                      Optional indicates whether the referenced resource must exist, or whether to
-                      tolerate its absence. If true and the referenced resource is absent, proceed
-                      as if the resource was present but empty, without any variables defined.
-                    type: boolean
-                required:
-                - kind
-                - name
-                type: object
               dependsOn:
                 description: |-
                   DependsOn may contain a meta.NamespacedObjectReference slice

internal/controller/kclrun_controller.go

@@ -278,8 +278,40 @@ func (r *KCLRunReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res
 		conditions.MarkFalse(&obj, meta.ReadyCondition, meta.ArtifactFailedReason, "%s", err)
 		return ctrl.Result{}, err
 	}
+	vars := make(map[string]string)
+	for _, reference := range obj.Spec.ArgumentsReferences {
+		namespacedName := types.NamespacedName{Namespace: obj.GetNamespace(), Name: reference.Name}
+		switch reference.Kind {
+		case "ConfigMap":
+			cm := &corev1.ConfigMap{}
+			if err := r.Client.Get(ctx, namespacedName, cm); err != nil {
+				if reference.Optional && apierrors.IsNotFound(err) {
+					// If optional, skip the not found error.
+					continue
+				} else {
+					return ctrl.Result{}, fmt.Errorf("config reference from 'ConfigMap/%s' error: %w", reference.Name, err)
+				}
+			}
+			for k, v := range cm.Data {
+				vars[k] = strings.ReplaceAll(v, "\n", "")
+			}
+		case "Secret":
+			secret := &corev1.Secret{}
+			if err := r.Client.Get(ctx, namespacedName, secret); err != nil {
+				if reference.Optional && apierrors.IsNotFound(err) {
+					// If optional, skip the not found error.
+					continue
+				} else {
+					return ctrl.Result{}, fmt.Errorf("config reference from 'Secret/%s' error: %w", reference.Name, err)
+				}
+			}
+			for k, v := range secret.Data {
+				vars[k] = strings.ReplaceAll(string(v), "\n", "")
+			}
+		}
+	}
 	// Compile the KCL source code into the Kubernetes manifests
-	res, err := kcl.CompileKclPackage(&obj, dirPath)
+	res, err := kcl.CompileKclPackage(&obj, dirPath, vars)
 	if err != nil {
 		conditions.MarkFalse(&obj, meta.ReadyCondition, "FetchFailed", err.Error())
 		log.Error(err, "failed to compile the KCL source code")

internal/kcl/kcl.go

@@ -13,7 +13,7 @@ import (
 )
 
 // Compile the KCL source code into kubernetes manifests.
-func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string) (*kcl.KCLResultList, error) {
+func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string, vars map[string]string) (*kcl.KCLResultList, error) {
 	cli, _ := client.NewKpmClient()
 	opts := opt.DefaultCompileOptions()
 
@@ -29,15 +29,21 @@ func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string) (*kcl.KCLResultList
 		opts.Merge(kcl.WithSettings(settings))
 		opts.SetHasSettingsYaml(true)
 	}
+	// Build KCL top level arguments
+	var options []string
+	for k, v := range vars {
+		options = append(options, fmt.Sprintf("%s=%s", k, v))
+	}
 	if obj != nil {
+		options = append(options, obj.Spec.Config.Arguments...)
 		if obj.Spec.Config != nil {
 			for _, s := range obj.Spec.Config.Settings {
 				opts.Merge(kcl.WithSettings(s))
 				opts.SetHasSettingsYaml(true)
 			}
 			opts.SetVendor(obj.Spec.Config.Vendor)
 			opts.Merge(
-				kcl.WithOptions(obj.Spec.Config.Arguments...),
+				kcl.WithOptions(options...),
 				kcl.WithOverrides(obj.Spec.Config.Overrides...),
 				kcl.WithSelectors(obj.Spec.Config.PathSelectors...),
 				kcl.WithSortKeys(obj.Spec.Config.SortKeys),