Merge pull request #41 from evilmarty/funcs

Add helper functions to script templates

README.md

@@ -277,6 +277,14 @@ The expression to reference an input value. ie. '{{ .Input.my_input }}'
 
 The expression to reference an environment variable. ie. '{{ .Env.HOME }}'
 
+### input "input_name"
+
+A function to retrieve the input by its name. ie. '{{input "my_input"}}'
+
+### env "variable_name"
+
+A function to retrieve the environment variable by its name. ie. '{{env "HOME"}}'
+
 ## Example config with single command
 
 ```yaml

command_set.go

@@ -103,7 +103,7 @@ func (cs CommandSet) RenderScript(data TemplateData) (string, error) {
 			continue
 		}
 		if tmpl == nil {
-			tmpl = template.New(command.Name)
+			tmpl = template.New(command.Name).Funcs(data.Funcs())
 		} else {
 			tmpl = tmpl.New(command.Name)
 		}

command_set_test.go

@@ -321,6 +321,30 @@ func TestCommandSetRenderScript(t *testing.T) {
 		assert.NoError(t, err, "CommandSet.RenderScript() returned an unexpected error")
 		assert.Equal(t, expected, actual, "CommandSet.RenderScript() returned unexpected result")
 	})
+	t.Run("helper functions", func(t *testing.T) {
+		data := TemplateData{
+			Input: map[string]any{
+				"A": "a",
+				"B": "b",
+			},
+			Env: map[string]string{
+				"C": "c",
+				"D": "d",
+			},
+		}
+		cs := CommandSet{
+			Commands: []ConfigCommand{
+				{
+					Name: "foobar",
+					Run:  "echo {{input \"A\"}} {{env \"C\"}}",
+				},
+			},
+		}
+		expected := "echo a c"
+		actual, err := cs.RenderScript(data)
+		assert.NoError(t, err, "CommandSet.RenderScript() returned an unexpected error")
+		assert.Equal(t, expected, actual, "CommandSet.RenderScript() returned unexpected result")
+	})
 }
 
 func TestCommandSetRenderScriptToTemp(t *testing.T) {

utils.go

@@ -13,6 +13,29 @@ type TemplateData struct {
 	Env   map[string]string
 }
 
+func (td TemplateData) getInput(name string) any {
+	if v, ok := td.Input[name]; ok {
+		return v
+	} else {
+		return nil
+	}
+}
+
+func (td TemplateData) getEnv(name string) any {
+	if v, ok := td.Env[name]; ok {
+		return v
+	} else {
+		return nil
+	}
+}
+
+func (td *TemplateData) Funcs() template.FuncMap {
+	return template.FuncMap{
+		"input": td.getInput,
+		"env":   td.getEnv,
+	}
+}
+
 func NewTemplateData(input map[string]any, env []string) TemplateData {
 	safeInputs := make(map[string]any)
 	for name, value := range input {