#62: add new processors

Author: iignatevich

docs/actions.schema.md

@@ -274,3 +274,82 @@ plasma
 + id
 uid=1000(plasma) gid=1000(plasma) groups=1000(plasma)
 ```
+
+
+## Available Command Template Functions
+
+### `removeLine`
+**Description:** A special template directive that removes the entire line from the final output.
+
+**Usage:**
+
+``` yaml
+- "{{ if condition }}value{{ else }}{{ removeLine }}{{ end }}"
+```
+
+### `isNil`
+
+**Description:** Checks if a value is nil.
+
+**Usage:**
+
+```yaml
+- "{{ if not (isNil .param_name) }}--param={{ .param_name }}{{ else }}{{ removeLine }}{{ end }}"
+```
+
+### `isSet`
+
+**Description:** Checks if a value has been set (opposite of `isNil`).
+
+```yaml
+- "{{ if isSet .param_name }}--param={{ .param_name }}{{else}}{{ removeLine }}{{ end }}"
+```
+
+### `isChanged`
+
+**Description:** Checks if an option or argument value has been changed (dirty).
+
+**Usage:**
+
+```yaml
+- '{{ if isChanged "param_name"}}--param={{.param_name}}{{else}}{{ removeLine }}{{ end }}'
+```
+
+### `removeLineIfNil`
+**Description:** Removes the entire command line if the value is nil.
+
+**Usage:**
+
+```yaml
+- "{{ removeLineIfNil .param_name }}"
+```
+
+### `removeLineIfSet`
+**Description:** Removes the entire command line if the value is set (has no nil value).
+
+**Usage:**
+
+```yaml
+- "{{ removeLineIfSet .param_name }}"
+```
+
+### `removeLineIfChanged`
+
+**Description:** Removes the command line entry if the option/argument value has changed.
+
+**Usage:**
+
+``` yaml
+- '{{ removeLineIfChanged "param_name" }}'
+```
+
+### `removeLineIfNotChanged`
+
+**Description:** Removes the command line entry if the option/argument value has not changed by the user.
+Opposite of `removeLineIfChanged`
+
+**Usage:**
+
+``` yaml
+- '{{ removeLineIfNotChanged "param_name" }}'
+```

example/actions/arguments/action.yaml

@@ -18,6 +18,9 @@ action:
       description: Option to do something
       type: boolean
       default: false
+    - name: thirdoption
+      title: Third option
+      type: string
 
 runtime:
   type: container
@@ -31,3 +34,9 @@ runtime:
     - "{{ .arg2 }}"
     - "{{ .firstoption|removeLineIfNil }}"
     - "{{ if not (isNil .secondoption) }}--secondoption={{ .secondoption }}{{ else }}{{ removeLine }}{{ end }}"
+    - "{{ if isSet .thirdoption }}--thirdoption={{ .thirdoption }}{{else}}Third option is not set{{ end }}"
+    - "{{ removeLineIfSet .thirdoption }}"
+    - '{{ if not (isChanged "thirdoption")}}Third Option is not Changed{{else}}{{ removeLine }}{{ end }}'
+    - '{{ removeLineIfChanged "thirdoption" }}'
+    - '{{ if isChanged "thirdoption"}}Third Option is Changed{{else}}{{ removeLine }}{{ end }}'
+    - '{{ removeLineIfNotChanged "thirdoption" }}'

pkg/action/loader.go

@@ -12,7 +12,7 @@ import (
 	"github.com/launchrctl/launchr/internal/launchr"
 )
 
-const tokenRmLine = "<TOKEN_REMOVE_THIS_LINE>"
+const tokenRmLine = "<TOKEN_REMOVE_THIS_LINE>" //nolint:gosec // G101: Not a credential.
 
 var rgxTokenRmLine = regexp.MustCompile(`.*` + tokenRmLine + `.*\n?`)
 
@@ -95,19 +95,76 @@ func (err errMissingVar) Error() string {
 }
 
 // actionTplFuncs defined template functions available during parsing of an action yaml.
-func actionTplFuncs() template.FuncMap {
+func actionTplFuncs(input *Input) template.FuncMap {
+	// Helper function to get value by name from args or opts
+	getValue := func(name string) any {
+		args := input.Args()
+		if arg, ok := args[name]; ok {
+			return arg
+		}
+
+		opts := input.Opts()
+		if opt, ok := opts[name]; ok {
+			return opt
+		}
+
+		return nil
+	}
+
+	// Helper function to check if a parameter is changed
+	isParamChanged := func(name string) bool {
+		return input.IsOptChanged(name) || input.IsArgChanged(name)
+	}
+
 	return template.FuncMap{
 		// Checks if a value is nil. Used in conditions.
 		"isNil": func(v any) bool {
 			return v == nil
 		},
+		// Checks if a value is not nil. Used in conditions.
+		"isSet": func(v any) bool {
+			return v != nil
+		},
+		// Checks if a value is changed. Used in conditions.
+		"isChanged": func(v any) bool {
+			name, ok := v.(string)
+			if !ok {
+				return false
+			}
+
+			return isParamChanged(name)
+		},
 		// Removes a line if a given value is nil or pass through.
 		"removeLineIfNil": func(v any) any {
 			if v == nil {
 				return tokenRmLine
 			}
 			return v
 		},
+		// Removes a line if a given value is not nil or pass through.
+		"removeLineIfSet": func(v any) any {
+			if v != nil {
+				return tokenRmLine
+			}
+
+			return v
+		},
+		// Removes a line if a given value is changed or pass through.
+		"removeLineIfChanged": func(name string) any {
+			if isParamChanged(name) {
+				return tokenRmLine
+			}
+
+			return getValue(name)
+		},
+		// Removes a line if a given value is not changed or pass through.
+		"removeLineIfNotChanged": func(name string) any {
+			if !isParamChanged(name) {
+				return tokenRmLine
+			}
+
+			return getValue(name)
+		},
 		// Removes current line.
 		"removeLine": func() string {
 			return tokenRmLine
@@ -126,7 +183,7 @@ func (p inputProcessor) Process(ctx LoadContext, b []byte) ([]byte, error) {
 	addPredefinedVariables(data, a)
 
 	// Parse action without variables to validate
-	tpl := template.New(a.ID).Funcs(actionTplFuncs())
+	tpl := template.New(a.ID).Funcs(actionTplFuncs(a.Input()))
 
 	_, err := tpl.Parse(string(b))
 	if err != nil {

pkg/action/loader_test.go

@@ -86,8 +86,17 @@ func Test_InputProcessor(t *testing.T) {
 - "{{ .arg2 }}"
 - "{{ if not (isNil .arg1) }}arg1 is not nil{{end}}"
 - "{{ if (isNil .optUnd) }}{{ removeLine }}{{ end }}" # Function call without new line`
-	res, err = proc.Process(ctx, []byte(s))
+	_, err = proc.Process(ctx, []byte(s))
 	assert.Equal(t, errMissVars, err)
+
+	s = `- "{{ if isSet .arg1 }}arg1 is set"{{end}}
+- "{{ removeLineIfSet .arg1 }}" # Function call without new line
+- "{{ if isChanged .arg1 }}arg1 is changed{{end}}"
+- '{{ removeLineIfNotChanged "arg1" }}'
+- '{{ removeLineIfChanged "arg1" }}' # Function call without new line`
+	res, err = proc.Process(ctx, []byte(s))
+	assert.NoError(t, err)
+	assert.Equal(t, "- \"arg1 is set\"\n- \"arg1 is changed\"\n- 'arg1'\n", string(res))
 }
 
 func Test_YamlTplCommentsProcessor(t *testing.T) {