DockerCLI/templates/templates_test.go

package templates

import (
	"bytes"
	"testing"

	"gotest.tools/v3/assert"
	is "gotest.tools/v3/assert/cmp"
)

// GitHub #32120
func TestParseJSONFunctions(t *testing.T) {
	tm, err := Parse(`{{json .Ports}}`)
	assert.NilError(t, err)

	var b bytes.Buffer
	assert.NilError(t, tm.Execute(&b, map[string]string{"Ports": "0.0.0.0:2->8/udp"}))
	want := "\"0.0.0.0:2->8/udp\""
	assert.Check(t, is.Equal(want, b.String()))
}

func TestParseStringFunctions(t *testing.T) {
	tm, err := Parse(`{{join (split . ":") "/"}}`)
	assert.NilError(t, err)

	var b bytes.Buffer
	assert.NilError(t, tm.Execute(&b, "text:with:colon"))
	want := "text/with/colon"
	assert.Check(t, is.Equal(want, b.String()))
}

func TestNewParse(t *testing.T) {
	tm, err := NewParse("foo", "this is a {{ . }}")
	assert.NilError(t, err)

	var b bytes.Buffer
	assert.NilError(t, tm.Execute(&b, "string"))
	want := "this is a string"
	assert.Check(t, is.Equal(want, b.String()))
}

func TestParseTruncateFunction(t *testing.T) {
	source := "tupx5xzf6hvsrhnruz5cr8gwp"

	testCases := []struct {
		template string
		expected string
	}{
		{
			template: `{{truncate . 5}}`,
			expected: "tupx5",
		},
		{
			template: `{{truncate . 25}}`,
			expected: "tupx5xzf6hvsrhnruz5cr8gwp",
		},
		{
			template: `{{truncate . 30}}`,
			expected: "tupx5xzf6hvsrhnruz5cr8gwp",
		},
		{
			template: `{{pad . 3 3}}`,
			expected: "   tupx5xzf6hvsrhnruz5cr8gwp   ",
		},
	}

	for _, tc := range testCases {
		tm, err := Parse(tc.template)
		assert.NilError(t, err)

		t.Run("Non Empty Source Test with template: "+tc.template, func(t *testing.T) {
			var b bytes.Buffer
			assert.NilError(t, tm.Execute(&b, source))
			assert.Check(t, is.Equal(tc.expected, b.String()))
		})

		t.Run("Empty Source Test with template: "+tc.template, func(t *testing.T) {
			var c bytes.Buffer
			assert.NilError(t, tm.Execute(&c, ""))
			assert.Check(t, is.Equal("", c.String()))
		})

		t.Run("Nil Source Test with template: "+tc.template, func(t *testing.T) {
			var c bytes.Buffer
			assert.Check(t, tm.Execute(&c, nil) != nil)
			assert.Check(t, is.Equal("", c.String()))
		})
	}
}

func TestHeaderFunctions(t *testing.T) {
	const source = "hello world"

	tests := []struct {
		doc      string
		template string
	}{
		{
			doc:      "json",
			template: `{{ json .}}`,
		},
		{
			doc:      "split",
			template: `{{ split . ","}}`,
		},
		{
			doc:      "join",
			template: `{{ join . ","}}`,
		},
		{
			doc:      "title",
			template: `{{ title .}}`,
		},
		{
			doc:      "lower",
			template: `{{ lower .}}`,
		},
		{
			doc:      "upper",
			template: `{{ upper .}}`,
		},
		{
			doc:      "truncate",
			template: `{{ truncate . 2}}`,
		},
	}

	for _, tc := range tests {
		t.Run(tc.doc, func(t *testing.T) {
			tmpl, err := New("").Funcs(HeaderFunctions).Parse(tc.template)
			assert.NilError(t, err)

			var b bytes.Buffer
			assert.NilError(t, tmpl.Execute(&b, source))

			// All header-functions are currently stubs, and don't modify the input.
			expected := source
			assert.Equal(t, expected, b.String())
		})
	}
}