Merge pull request #47 from yeahdongcn/feat/conditions

Update config to support conditions and operator

Author: yeahdongcn

Makefile

@@ -52,7 +52,7 @@ examples: build kubernetes-split-yaml ## Test the binary against the examples.
 	cd examples/memcached-operator; KUSTOHELMIZE=../../bin/kustohelmize make helm
 
 .PHONY: test
-test: go-test build kubernetes-split-yaml 0100 0200 0300 0400 0500 0600 0700 0800 0900 ## Test the binary.
+test: go-test build kubernetes-split-yaml 0100 0200 0300 0400 0500 0600 0700 0800 0900 1000 ## Test the binary.
 
 .PHONY: go-test
 go-test:
@@ -112,6 +112,12 @@ go-test:
 	$(HELM) lint test/output/0900/mychart
 	$(HELM) install --dry-run --generate-name test/output/0900/mychart -n default
 
+.PHONY: 1000
+1000: build
+	$(KUSTOHELMIZE) create --from=test/testdata/0800_deployment.yaml test/output/1000/mychart
+	$(HELM) lint test/output/1000/mychart
+	$(HELM) install --dry-run --generate-name test/output/1000/mychart -n default
+
 ##@ Tools
 
 KUBERNETES-SPLIT-YAML = $(shell pwd)/bin/kubernetes-split-yaml

examples/README.md

@@ -252,6 +252,33 @@ We also introduce the `strategy` in the configuration file.
     {{- end }}
     ```
 
+    The `control-if` strategy also supports specifying one or more conditions:
+
+    ```yaml
+    spec.template.spec.containers[0].ports[2]:
+    - strategy: control-if
+      conditions:
+      - key: "!sharedValues.webhook.disabled"
+      - key: sharedValues.tls.enabled
+      conditionOperator: and
+    ```
+
+    A condition can be negated by prefixing the key with `!`. The `conditionOperator` can be `and` or `or`.</br>
+
+    This generates the following Helm template:
+
+    ```yaml
+    {{- if and (not .Values.webhook.disabled) .Values.tls.enabled }}
+    - containerPort: 9443
+      name: webhook-server
+      protocol: TCP
+    {{- end }}
+    ```
+
+    > __Note__: The following `condition` and `conditionValue` are deprecated in version `0.5.0`. Use `conditions` instead.
+
+    <details>
+
     The `control-if` strategy also supports specifying a condition:
 
     ```yaml
@@ -287,7 +314,9 @@ We also introduce the `strategy` in the configuration file.
     {{- end }}
     ```
 
-1. `control-if-yaml`
+    </details>
+
+2. `control-if-yaml`
 
     ```
     {{- if .Values.operator.initContainer.imagePullSecrets }}
@@ -316,7 +345,7 @@ We also introduce the `strategy` in the configuration file.
     {{- end }}
     ```
 
-1. `control-range`
+3. `control-range`
 
     ```
     imagePullSecrets:
@@ -325,7 +354,7 @@ We also introduce the `strategy` in the configuration file.
     {{- end }}
     ```
 
-1. `file-if`
+4. `file-if`
 
     Conditionally includes or omits an entire resource manifest.
 
@@ -352,7 +381,7 @@ We also introduce the `strategy` in the configuration file.
         key: sharedValues.promethues.enabled
     ```
 
-1. `inline-regex`
+5. `inline-regex`
 
     Allows insertion of a templated value as part of an overall string, such as the value for a pod's command line argument.
 
@@ -382,7 +411,7 @@ We also introduce the `strategy` in the configuration file.
     This is how to do it.
 
     1. Edit the kustohelmize configuration file.
-    1. Set up the deployment's configuration like this:
+    2. Set up the deployment's configuration like this:
 
         ```yaml
         fileConfig:
@@ -400,7 +429,7 @@ We also introduce the `strategy` in the configuration file.
               key: manager.probe.port
         ```
 
-    1. The emitted Helm template will be:
+    3. The emitted Helm template will be:
 
       ```yaml
           - args:
@@ -423,7 +452,7 @@ We also introduce the `strategy` in the configuration file.
 
     The match group in the regex `(\d+)` is templated with the `.Values` identified by `key`. Currently, only one replacement per list item is possible.
 
-1. `append-with`
+6. `append-with`
 
     Allows appending a list of values to an existing list in the Helm template.
 

pkg/config/config.go

@@ -42,23 +42,31 @@ const (
 	XPathStrategyAppendWith    XPathStrategy = "append-with"
 )
 
+type Condition struct {
+	Key   string `yaml:"key,omitempty"`
+	Value bool   `yaml:"value,omitempty"`
+}
+
 type XPathConfig struct {
-	Strategy       XPathStrategy   `yaml:"strategy"`
-	Key            string          `yaml:"key"`
-	Value          interface{}     `yaml:"value,omitempty"`
-	DefaultValue   interface{}     `yaml:"defaultValue,omitempty"`
-	Regex          string          `yaml:"regex,omitempty"`
-	RegexCompiled  *regexp2.Regexp `yaml:"-"`
-	Condition      string          `yaml:"condition,omitempty"`
-	ConditionValue bool            `yaml:"conditionValue,omitempty" default:"false"`
+	Strategy          XPathStrategy   `yaml:"strategy"`
+	Key               string          `yaml:"key"`
+	Value             interface{}     `yaml:"value,omitempty"`
+	DefaultValue      interface{}     `yaml:"defaultValue,omitempty"`
+	Regex             string          `yaml:"regex,omitempty"`
+	RegexCompiled     *regexp2.Regexp `yaml:"-"`
+	Conditions        []Condition     `yaml:"conditions,omitempty"`
+	ConditionOperator *string         `yaml:"conditionOperator,omitempty"`
+	// Deprecated
+	Condition      string `yaml:"condition,omitempty"`
+	ConditionValue bool   `yaml:"conditionValue,omitempty"`
 }
 
-func (x *XPathConfig) ValueRequiresQuote() bool {
-	if x.Value == nil {
+func (xc *XPathConfig) ValueRequiresQuote() bool {
+	if xc.Value == nil {
 		return false
 	}
 
-	switch value := x.Value.(type) {
+	switch value := xc.Value.(type) {
 	case bool, int, float64:
 		return true
 	case string:
@@ -206,8 +214,12 @@ func (cc *ChartConfig) Values() (string, error) {
 
 				kvs := []kvPair{{c.Key, c.Value}}
 				if c.Condition != "" {
-					condition := strings.TrimPrefix(c.Condition, "!")
-					kvs = append(kvs, kvPair{condition, c.ConditionValue})
+					conditionKey := strings.TrimPrefix(c.Condition, "!")
+					kvs = append(kvs, kvPair{conditionKey, c.ConditionValue})
+				}
+				for _, condition := range c.Conditions {
+					conditionKey := strings.TrimPrefix(condition.Key, "!")
+					kvs = append(kvs, kvPair{conditionKey, condition.Value})
 				}
 				for _, kv := range kvs {
 					substrings := strings.Split(kv.Key, XPathSeparator)
@@ -295,14 +307,40 @@ func (c *ChartConfig) formatKey(key, prefix string, keyType KeyType, strategy XP
 }
 
 func (c *ChartConfig) GetFormattedCondition(xc *XPathConfig, prefix string) (string, bool) {
-	not := strings.HasPrefix(xc.Condition, "!")
-	condition := strings.TrimPrefix(xc.Condition, "!")
-	key, keyType := c.determineKeyType(condition)
-	if key == "" {
-		return key, not
+	formatCondition := func(condition string) (string, bool) {
+		not := strings.HasPrefix(condition, "!")
+		conditionKey := strings.TrimPrefix(condition, "!")
+		key, keyType := c.determineKeyType(conditionKey)
+		if key == "" {
+			return "", not
+		}
+		return c.formatKey(key, prefix, keyType, xc.Strategy), not
 	}
-	key = c.formatKey(key, prefix, keyType, xc.Strategy)
-	return key, not
+
+	formatMultipleConditions := func(conditions []Condition) (string, bool) {
+		keys := make([]string, len(conditions))
+		for i, condition := range conditions {
+			key, not := formatCondition(condition.Key)
+			if key != "" {
+				if not {
+					key = fmt.Sprintf("(not %s)", key)
+				}
+				keys[i] = key
+			}
+		}
+
+		return fmt.Sprintf("%s %s", *xc.ConditionOperator, strings.Join(keys, " ")), false
+	}
+
+	if xc.Condition != "" {
+		return formatCondition(xc.Condition)
+	} else if len(xc.Conditions) > 0 {
+		if len(xc.Conditions) == 1 {
+			return formatCondition(xc.Conditions[0].Key)
+		}
+		return formatMultipleConditions(xc.Conditions)
+	}
+	return "", false
 }
 
 func (c *ChartConfig) GetFormattedKeyWithDefaultValue(xc *XPathConfig, prefix string) (string, KeyType) {
@@ -322,6 +360,10 @@ func (c *ChartConfig) Validate() error {
 	// - file-if can only be present at root level file configs
 	// - globalConfig cannot contain a root level entry
 	// - inline-regex must have regex property, and the regex must compile and contain exactly one capture group
+	// - control-if and control-if-yaml with multiple conditions:
+	//   - must have conditionOperator property
+	//   - conditionOperator must be 'and' or 'or'
+	// - other strategies cannot have condition or conditions property
 	if _, ok := c.GlobalConfig[XPathRoot]; ok {
 		return fmt.Errorf("cannot have root level config in GlobalConfig")
 	}
@@ -343,6 +385,21 @@ func (c *ChartConfig) Validate() error {
 						return fmt.Errorf("'%s' strategy '%s': regular expression '%s' must have exactly one replacement group", manifest, strategy, xpathConfig.Regex)
 					}
 					xpathConfigs[i].RegexCompiled = rx
+				} else if strategy == XPathStrategyControlIf || strategy == XPathStrategyControlIfYAML {
+					if len(xpathConfig.Conditions) > 1 {
+						if xpathConfig.ConditionOperator == nil {
+							return fmt.Errorf("'%s' strategy '%s' must have 'conditionOperator' property", manifest, strategy)
+						}
+					}
+					if xpathConfig.ConditionOperator != nil {
+						if *xpathConfig.ConditionOperator != "and" && *xpathConfig.ConditionOperator != "or" {
+							return fmt.Errorf("'%s' strategy '%s' conditionOperator must be 'and' or 'or'", manifest, strategy)
+						}
+					}
+				} else {
+					if xpathConfig.Condition != "" || len(xpathConfig.Conditions) > 0 {
+						return fmt.Errorf("'%s' strategy '%s' cannot have 'condition' or 'conditions' property", manifest, strategy)
+					}
 				}
 			}
 		}

pkg/config/config_test.go

@@ -13,8 +13,7 @@ func TestKeyExist2(t *testing.T) {
 	config := NewChartConfig(logger, "chart")
 	config.SharedValues["replicas"] = 1
 	xc := XPathConfig{
-		Strategy: XPathStrategyInline,
-		Key:      fmt.Sprintf("%s%s%s", sharedValuesPrefix, XPathSeparator, "replicas"),
+		Key: fmt.Sprintf("%s%s%s", sharedValuesPrefix, XPathSeparator, "replicas"),
 	}
 	key, exist := config.keyExist(xc.Key)
 	require.True(t, exist)

test/output/0800/mychart-generated/nginx-deployment-deployment.yaml

@@ -26,3 +26,6 @@ spec:
         - name: https
           containerPort: 443
           protocol: TCP
+        - containerPort: 9443
+          name: webhook-server
+          protocol: TCP

test/output/0800/mychart/templates/nginx-deployment-deployment.yaml

@@ -35,3 +35,6 @@ spec:
               name: https
               protocol: TCP
             {{- end }}
+            - containerPort: 9443
+              name: webhook-server
+              protocol: TCP

test/output/0900/mychart-generated/nginx-deployment-deployment.yaml

@@ -26,3 +26,6 @@ spec:
         - name: https
           containerPort: 443
           protocol: TCP
+        - containerPort: 9443
+          name: webhook-server
+          protocol: TCP

test/output/0900/mychart.config

@@ -31,7 +31,6 @@ fileConfig:
       condition: sharedValues.arg0.enabled
     spec.template.spec.containers[0].ports[0]:
     - strategy: control-if
-      key: ""
       condition: sharedValues.http.enabled
     spec.template.spec.containers[0].ports:
     - strategy: append-with

test/output/0900/mychart/templates/nginx-deployment-deployment.yaml

@@ -31,6 +31,9 @@ spec:
             - containerPort: 443
               name: https
               protocol: TCP
+            - containerPort: 9443
+              name: webhook-server
+              protocol: TCP
             {{- with .Values.ports }}
             {{- toYaml . | nindent 12 }}
             {{- end }}

test/output/1000/mychart-generated/nginx-deployment-deployment.yaml

@@ -0,0 +1,31 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  namespace: default
+spec:
+  selector:
+    matchLabels:
+      app: nginx
+  replicas: 2
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:latest
+        args:
+        - arg0
+        - arg1
+        ports:
+        - name: http
+          containerPort: 80
+          protocol: TCP
+        - name: https
+          containerPort: 443
+          protocol: TCP
+        - containerPort: 9443
+          name: webhook-server
+          protocol: TCP

test/output/1000/mychart.config

@@ -0,0 +1,47 @@
+logger: {}
+chartname: mychart
+sharedValues:
+  affinity: {}
+  arg0:
+    enabled: false
+  http:
+    enabled: true
+  https:
+    enabled: true
+  webhook:
+    disabled: false
+  tls:
+    enabled: true
+  nodeSelector: {}
+  podSecurityContext: {}
+  ports:
+  - containerPort: 6666
+    name: some_other_port
+    protocol: TCP
+  resources: {}
+  securityContext: {}
+  tolerations: {}
+globalConfig:
+  metadata.labels:
+  - strategy: newline
+    key: mychart.labels
+  metadata.name:
+  - strategy: inline
+    key: mychart.fullname
+fileConfig:
+  test/output/1000/mychart-generated/nginx-deployment-deployment.yaml:
+    spec.template.spec.containers[0].args[0]:
+    - strategy: control-if
+      condition: sharedValues.arg0.enabled
+    spec.template.spec.containers[0].ports[0]:
+    - strategy: control-if
+      condition: sharedValues.http.enabled
+    spec.template.spec.containers[0].ports[2]:
+    - strategy: control-if
+      conditions:
+      - key: "!sharedValues.webhook.disabled"
+      - key: sharedValues.tls.enabled
+      conditionOperator: and
+    spec.template.spec.containers[0].ports:
+    - strategy: append-with
+      key: sharedValues.ports