Add sprig functions (#4)

* Add calculation functions * Add test CI * cleanup * Migrate to sprig * fix fallback
home-assistant · Jan 22, 2021 · 69e3e79 · 69e3e79
1 parent 1995814
commit 69e3e79
Show file tree

Hide file tree

Showing 8 changed files with 125 additions and 26 deletions.
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -11,7 +11,7 @@ env:
 
 jobs:
   golangci:
-    name: lint
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,23 @@
+name: golang-tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  GOLANG_VERSION: "1.14"
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ${{ env.GOLANG_VERSION }}
+      - shell: bash
+        run: |
+          go test
diff --git a/README.md b/README.md
@@ -1,16 +1,10 @@
 # tempio
-A template helper for docker images which using [text/template](https://golang.org/pkg/text/template/) golang engine.
+A template helper for docker images which using [text/template](https://golang.org/pkg/text/template/) golang engine with [sprig functions](http://masterminds.github.io/sprig/).
 
 Support conf format:
 
 - json
 
-Custom template commands
-
-| Command                        | Description                                                                        |
-|------------------------------- |----------------------------------------------------------------------------------- |
-| **JoinString** .value ", "     | Join a array of strings with an seperator.                                         |
-
 ## Basic Example
 
 ```bash

diff --git a/config.go b/config.go
@@ -35,8 +35,14 @@ func readConfigFile(file string) *map[string]interface{} {
 	}
 
 	// Parse json
+	return readConfigBuffer(configFile)
+}
+
+func readConfigBuffer(buffer []byte) *map[string]interface{} {
 	var config map[string]interface{}
-	err = json.Unmarshal(configFile, &config)
+
+	// Parse json
+	err := json.Unmarshal(buffer, &config)
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/go.mod b/go.mod
@@ -2,4 +2,10 @@ module github.com/home-assistant/tempio
 
 go 1.15
 
-require ()
+require (
+	github.com/Masterminds/sprig/v3 v3.2.0
+	github.com/google/uuid v1.1.5 // indirect
+	github.com/huandu/xstrings v1.3.2 // indirect
+	github.com/stretchr/testify v1.7.0
+	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,49 @@
+github.com/Masterminds/goutils v1.1.0 h1:zukEsf/1JZwCMgHiK3GZftabmxiCw4apj3a28RPBiVg=
+github.com/Masterminds/goutils v1.1.0/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU=
+github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
+github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
+github.com/Masterminds/sprig/v3 v3.2.0 h1:P1ekkbuU73Ui/wS0nK1HOM37hh4xdfZo485UPf8rc+Y=
+github.com/Masterminds/sprig/v3 v3.2.0/go.mod h1:tWhwTbUTndesPNeF0C900vKoq283u6zp4APT9vaF3SI=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.1.5 h1:kxhtnfFVi+rYdOALN0B3k9UT86zVJKfBimRaciULW4I=
+github.com/google/uuid v1.1.5/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/huandu/xstrings v1.3.1/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
+github.com/huandu/xstrings v1.3.2 h1:L18LIDzqlW6xN2rEkpdV8+oL/IXWJ1APd+vsdYy4Wdw=
+github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
+github.com/imdario/mergo v0.3.11 h1:3tnifQM4i+fbajXKBHXWEH+KvNHqojZ778UH75j3bGA=
+github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
+github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ=
+github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
+github.com/mitchellh/reflectwalk v1.0.0 h1:9D+8oIskB4VJBN5SFlmc27fSlIBZaov1Wpk/IfikLNY=
+github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ=
+github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
+github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng=
+github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20200414173820-0848c9571904/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad h1:DN0cp81fZ3njFcrLCytUHRSUkqBjfTo4Tx9RJTWs0EY=
+golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
+gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/main_test.go b/main_test.go
@@ -0,0 +1,27 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestTemplatesJoin(t *testing.T) {
+	dataJson := []byte(`{"list": ["hallo", "welt", "bla"]}`)
+	dataTemplate := []byte(`{{ join ";" .list }}`)
+
+	test_config := readConfigBuffer(dataJson)
+	rendered := renderTemplateBuffer(test_config, dataTemplate)
+
+	assert.Equal(t, string(rendered), "hallo;welt;bla")
+}
+
+func TestTemplatesCalc(t *testing.T) {
+	dataJson := []byte(`{"num": 3}`)
+	dataTemplate := []byte(`{{ add .num 3 }}-{{ mul .num 3 }}`)
+
+	test_config := readConfigBuffer(dataJson)
+	rendered := renderTemplateBuffer(test_config, dataTemplate)
+
+	assert.Equal(t, string(rendered), "6-9")
+}
diff --git a/template.go b/template.go
@@ -4,36 +4,30 @@ import (
 	"bytes"
 	"io/ioutil"
 	"log"
-	"strings"
 	"text/template"
-)
 
-func JoinString(a []interface{}, delimiter string) string {
-	var paramSlice []string
-	for _, param := range a {
-		paramSlice = append(paramSlice, param.(string))
-	}
-	return strings.Join(paramSlice, delimiter)
-}
+	sprig "github.com/Masterminds/sprig/v3"
+)
 
 func renderTemplateFile(config *map[string]interface{}, file string) []byte {
-	buf := &bytes.Buffer{}
-
 	// read Template
 	templateFile, err := ioutil.ReadFile(file)
 	if err != nil {
 		log.Fatalf("Cant read file %s - %s", file, err)
 	}
 
-	// helper
-	funcMap := template.FuncMap{"JoinString": JoinString}
+	return renderTemplateBuffer(config, templateFile)
+}
+
+func renderTemplateBuffer(config *map[string]interface{}, templateData []byte) []byte {
+	buf := &bytes.Buffer{}
 
 	// generate template
-	coreTemplate := template.New("tempIO").Funcs(funcMap)
-	template.Must(coreTemplate.Parse(string(templateFile)))
+	coreTemplate := template.New("tempIO").Funcs(sprig.TxtFuncMap())
+	template.Must(coreTemplate.Parse(string(templateData)))
 
 	// render
-	err = coreTemplate.Execute(buf, *config)
+	err := coreTemplate.Execute(buf, *config)
 	if err != nil {
 		log.Fatal(err)
 	}