Merge pull request #1558 from jsanant/add-trim-functions

Added trim functions.
hashicorp · Apr 12, 2022 · 0a8d8e2 · 0a8d8e2
2 parents 19156b3 + 03ed5d7
commit 0a8d8e2
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 0 deletions.
diff --git a/docs/templating-language.md b/docs/templating-language.md
@@ -58,6 +58,9 @@ provides the following functions:
   - [mergeMap](#mergemap)
   - [mergeMapWithOverride](#mergemapwithoverride)
   - [trimSpace](#trimspace)
+  - [trim](#trim)
+  - [trimPrefix](#trimprefix)
+  - [trimSuffix](#trimsuffix)  
   - [parseBool](#parsebool)
   - [parseFloat](#parsefloat)
   - [parseInt](#parseint)
@@ -1276,6 +1279,30 @@ Takes the provided input and trims all whitespace, tabs and newlines:
 {{ file "/etc/ec2_version" | trimSpace }}
 ```
 
+### `trim`
+
+Takes the provided input and trims all leading and trailing unicode:
+
+```golang
+{{ "hello world!!" | trim "!!" }}
+```
+
+### `trimPrefix`
+
+Takes the provided input and trims leading prefix string:
+
+```golang
+{{ "hello world!!" | trimPrefix "hello" }}
+```
+
+### `trimSuffix`
+
+Takes the provided input and trims trailing suffix string:
+
+```golang
+{{ "hello world!!" | trimSuffix "world!!" }}
+```
+
 ### `parseBool`
 
 Takes the given string and parses it as a boolean:

diff --git a/template/funcs.go b/template/funcs.go
@@ -987,6 +987,21 @@ func join(sep string, a []string) (string, error) {
 	return strings.Join(a, sep), nil
 }
 
+// trim is a version of strings.Trim that can be piped
+func trim(cutset string, s string) (string, error) {
+	return strings.Trim(s, cutset), nil
+}
+
+// trimPrefix is a version of strings.TrimPrefix that can be piped
+func trimPrefix(prefix string, s string) (string, error) {
+	return strings.TrimPrefix(s, prefix), nil
+}
+
+// trimSuffix is a version of strings.TrimSuffix that can be piped
+func trimSuffix(suffix string, s string) (string, error) {
+	return strings.TrimSuffix(s, suffix), nil
+}
+
 // TrimSpace is a version of strings.TrimSpace that can be piped
 func trimSpace(s string) (string, error) {
 	return strings.TrimSpace(s), nil

diff --git a/template/template.go b/template/template.go
@@ -294,6 +294,9 @@ func funcMap(i *funcMapInput) template.FuncMap {
 		"indent":                indent,
 		"loop":                  loop,
 		"join":                  join,
+		"trim":                  trim,
+		"trimPrefix":            trimPrefix,
+		"trimSuffix":            trimSuffix,
 		"trimSpace":             trimSpace,
 		"parseBool":             parseBool,
 		"parseFloat":            parseFloat,

diff --git a/template/template_test.go b/template/template_test.go
@@ -1455,6 +1455,39 @@ func TestTemplate_Execute(t *testing.T) {
 			"a;b;c",
 			false,
 		},
+		{
+			"helper_trim",
+			&NewTemplateInput{
+				Contents: `{{ "!!hello world!!" | trim "!!" }}`,
+			},
+			&ExecuteInput{
+				Brain: NewBrain(),
+			},
+			"hello world",
+			false,
+		},
+		{
+			"helper_trimPrefix",
+			&NewTemplateInput{
+				Contents: `{{ "hello world!!" | trimPrefix "hello " }}`,
+			},
+			&ExecuteInput{
+				Brain: NewBrain(),
+			},
+			"world!!",
+			false,
+		},
+		{
+			"helper_trimSuffix",
+			&NewTemplateInput{
+				Contents: `{{ "hello world!!" | trimSuffix " world!!" }}`,
+			},
+			&ExecuteInput{
+				Brain: NewBrain(),
+			},
+			"hello",
+			false,
+		},
 		{
 			"helper_parseBool",
 			&NewTemplateInput{