Add wrapper function for go-sockaddr templating

hashicorp · Aug 10, 2019 · 5870f91 · 5870f91
1 parent ece8cee
commit 5870f91
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1705,6 +1705,18 @@ minconns: "2"
 
 Note: Consul stores all KV data as strings. Thus true is "true", 1 is "1", etc.
 
+##### `sockaddr`
+
+Takes a quote-escaped template string as an argument and passes it on to
+[hashicorp/go-sockaddr](https://github.com/hashicorp/go-sockaddr) templating engine.
+
+```liquid
+{{ sockaddr "GetPrivateIP" }}
+```
+
+See [hashicorp/go-sockaddr documentation](https://godoc.org/github.com/hashicorp/go-sockaddr)
+for more information.
+
 ---
 
 #### Math Functions

diff --git a/go.mod b/go.mod
@@ -14,6 +14,7 @@ require (
 	github.com/hashicorp/go-msgpack v0.5.5 // indirect
 	github.com/hashicorp/go-multierror v1.0.0
 	github.com/hashicorp/go-rootcerts v1.0.1
+	github.com/hashicorp/go-sockaddr v1.0.2
 	github.com/hashicorp/go-syslog v1.0.0
 	github.com/hashicorp/golang-lru v0.5.3 // indirect
 	github.com/hashicorp/hcl v1.0.0

diff --git a/template/funcs.go b/template/funcs.go
@@ -18,6 +18,7 @@ import (
 
 	"github.com/BurntSushi/toml"
 	dep "github.com/hashicorp/consul-template/dependency"
+	socktmpl "github.com/hashicorp/go-sockaddr/template"
 	"github.com/pkg/errors"
 	yaml "gopkg.in/yaml.v2"
 )
@@ -1189,3 +1190,13 @@ func sandboxedPath(sandbox, s string) (string, error) {
 	}
 	return path, nil
 }
+
+// sockaddr wraps go-sockaddr templating
+func sockaddr(args ...string) (string, error) {
+	t := fmt.Sprintf("{{ %s }} ", strings.Join(args, " "))
+	k, err := socktmpl.Parse(t)
+	if err != nil {
+		return "", err
+	}
+	return k, nil
+}
diff --git a/template/template.go b/template/template.go
@@ -280,6 +280,7 @@ func funcMap(i *funcMapInput) template.FuncMap {
 		"toUpper":         toUpper,
 		"toYAML":          toYAML,
 		"split":           split,
+		"sockaddr":        sockaddr,
 
 		// Math functions
 		"add":      add,

diff --git a/template/template_test.go b/template/template_test.go
@@ -1481,6 +1481,17 @@ func TestTemplate_Execute(t *testing.T) {
 			"hi",
 			false,
 		},
+		{
+			"helper_sockaddr",
+			&NewTemplateInput{
+				Contents: `{{ sockaddr "GetAllInterfaces | include \"type\" \"IPv4\"" | contains "127.0.0.1" }}`,
+			},
+			&ExecuteInput{
+				Brain: NewBrain(),
+			},
+			"true",
+			false,
+		},
 		{
 			"math_add",
 			&NewTemplateInput{