refactor: replace docker-gen functions with sprig identical functions

(2/2)

Author: buchdag

internal/template/functions.go

@@ -7,12 +7,8 @@ import (
 	"reflect"
 	"regexp"
 	"strings"
-
-	"github.com/Masterminds/sprig/v3"
 )
 
-var sprigFuncMap = sprig.TxtFuncMap()
-
 func keys(input interface{}) (interface{}, error) {
 	if input == nil {
 		return nil, nil
@@ -81,18 +77,6 @@ func contains(input interface{}, key interface{}) bool {
 	return false
 }
 
-func hashSha1(input string) string {
-	return sprigFuncMap["sha1sum"].(func(string) string)(input)
-}
-
-func marshalJson(input interface{}) (string, error) {
-	return sprigFuncMap["mustToJson"].(func(interface{}) (string, error))(input)
-}
-
-func unmarshalJson(input string) (interface{}, error) {
-	return sprigFuncMap["mustFromJson"].(func(string) (interface{}, error))(input)
-}
-
 // arrayClosest find the longest matching substring in values
 // that matches input
 func arrayClosest(values []string, input string) string {
@@ -119,21 +103,6 @@ func dirList(path string) ([]string, error) {
 	return names, nil
 }
 
-// coalesce returns the first non nil argument
-func coalesce(input ...interface{}) interface{} {
-	return sprigFuncMap["coalesce"].(func(...interface{}) interface{})(input...)
-}
-
-// trimPrefix returns a string without the prefix, if present
-func trimPrefix(prefix, s string) string {
-	return sprigFuncMap["trimPrefix"].(func(string, string) string)(prefix, s)
-}
-
-// trimSuffix returns a string without the suffix, if present
-func trimSuffix(suffix, s string) string {
-	return sprigFuncMap["trimSuffix"].(func(string, string) string)(suffix, s)
-}
-
 // when returns the trueValue when the condition is true and the falseValue otherwise
 func when(condition bool, trueValue, falseValue interface{}) interface{} {
 	if condition {

internal/template/functions_test.go

@@ -1,14 +1,11 @@
 package template
 
 import (
-	"bytes"
-	"encoding/json"
 	"os"
 	"path"
 	"reflect"
 	"testing"
 
-	"github.com/nginx-proxy/docker-gen/internal/context"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -130,73 +127,6 @@ func TestSplitN(t *testing.T) {
 	tests.run(t)
 }
 
-func TestTrimPrefix(t *testing.T) {
-	const prefix = "tcp://"
-	const str = "tcp://127.0.0.1:2375"
-	const trimmed = "127.0.0.1:2375"
-	got := trimPrefix(prefix, str)
-	if got != trimmed {
-		t.Fatalf("expected trimPrefix(%s,%s) to be %s, got %s", prefix, str, trimmed, got)
-	}
-}
-
-func TestTrimSuffix(t *testing.T) {
-	const suffix = ".local"
-	const str = "myhost.local"
-	const trimmed = "myhost"
-	got := trimSuffix(suffix, str)
-	if got != trimmed {
-		t.Fatalf("expected trimSuffix(%s,%s) to be %s, got %s", suffix, str, trimmed, got)
-	}
-}
-
-func TestSha1(t *testing.T) {
-	sum := hashSha1("/path")
-	if sum != "4f26609ad3f5185faaa9edf1e93aa131e2131352" {
-		t.Fatal("Incorrect SHA1 sum")
-	}
-}
-
-func TestJson(t *testing.T) {
-	containers := []*context.RuntimeContainer{
-		{
-			Env: map[string]string{
-				"VIRTUAL_HOST": "demo1.localhost",
-			},
-			ID: "1",
-		},
-		{
-			Env: map[string]string{
-				"VIRTUAL_HOST": "demo1.localhost,demo3.localhost",
-			},
-			ID: "2",
-		},
-		{
-			Env: map[string]string{
-				"VIRTUAL_HOST": "demo2.localhost",
-			},
-			ID: "3",
-		},
-	}
-	output, err := marshalJson(containers)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	buf := bytes.NewBufferString(output)
-	dec := json.NewDecoder(buf)
-	if err != nil {
-		t.Fatal(err)
-	}
-	var decoded []*context.RuntimeContainer
-	if err := dec.Decode(&decoded); err != nil {
-		t.Fatal(err)
-	}
-	if len(decoded) != len(containers) {
-		t.Fatalf("Incorrect unmarshaled container count. Expected %d, got %d.", len(containers), len(decoded))
-	}
-}
-
 func TestParseJson(t *testing.T) {
 	tests := templateTestList{
 		{`{{parseJson .}}`, `null`, `<no value>`},
@@ -306,11 +236,3 @@ func TestDirList(t *testing.T) {
 	filesList, _ = dirList("/wrong/path")
 	assert.Equal(t, []string{}, filesList)
 }
-
-func TestCoalesce(t *testing.T) {
-	v := coalesce(nil, "second", "third")
-	assert.Equal(t, "second", v, "Expected second value")
-
-	v = coalesce(nil, nil, nil)
-	assert.Nil(t, v, "Expected nil value")
-}

internal/template/template.go

@@ -57,7 +57,10 @@ func newTemplate(name string) *template.Template {
 		}
 		return buf.String(), nil
 	}
-	tmpl.Funcs(sprig.TxtFuncMap()).Funcs(template.FuncMap{
+
+	sprigFuncMap := sprig.TxtFuncMap()
+
+	return tmpl.Funcs(sprigFuncMap).Funcs(template.FuncMap{
 		"closest":                 arrayClosest,
 		"comment":                 comment,
 		"contains":                contains,
@@ -86,8 +89,6 @@ func newTemplate(name string) *template.Template {
 		"sortStringsDesc":         sortStringsDesc,
 		"sortObjectsByKeysAsc":    sortObjectsByKeysAsc,
 		"sortObjectsByKeysDesc":   sortObjectsByKeysDesc,
-		"trimPrefix":              trimPrefix,
-		"trimSuffix":              trimSuffix,
 		"toLower":                 strings.ToLower,
 		"toUpper":                 strings.ToUpper,
 		"when":                    when,
@@ -100,14 +101,12 @@ func newTemplate(name string) *template.Template {
 		"whereLabelExists":        whereLabelExists,
 		"whereLabelDoesNotExist":  whereLabelDoesNotExist,
 		"whereLabelValueMatches":  whereLabelValueMatches,
-	}).Funcs(template.FuncMap{
-		// docker-gen template function replaced by their Sprig clone
-		"coalesce":  coalesce,
-		"json":      marshalJson,
-		"parseJson": unmarshalJson,
-		"sha1":      hashSha1,
+
+		// docker-gen template function aliased to their Sprig clone
+		"json":      sprigFuncMap["mustToJson"],
+		"parseJson": sprigFuncMap["mustFromJson"],
+		"sha1":      sprigFuncMap["sha1sum"],
 	})
-	return tmpl
 }
 
 func isBlank(str string) bool {