Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove non-hermetic sprig functions #2201

Merged
merged 1 commit into from
Feb 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{ $t1 := title .input }}
{{ $t1 := nospace $t1 }}
{{ $t2 := upper $t1 }}
{{ $t2 := upper $t1 }}
{{ $t3 := cat $t1 "," $t2 }}
{{ nospace $t3 }}
8 changes: 4 additions & 4 deletions courier/template/load_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ func loadRemoteTemplate(ctx context.Context, d templateDependencies, url string,

var t Template
if html {
t, err = htemplate.New(url).Funcs(sprig.HtmlFuncMap()).Parse(string(b))
t, err = htemplate.New(url).Funcs(sprig.HermeticHtmlFuncMap()).Parse(string(b))
if err != nil {
return nil, errors.WithStack(err)
}
} else {
t, err = template.New(url).Funcs(sprig.TxtFuncMap()).Parse(string(b))
t, err = template.New(url).Funcs(sprig.HermeticTxtFuncMap()).Parse(string(b))
if err != nil {
return nil, errors.WithStack(err)
}
Expand Down Expand Up @@ -132,13 +132,13 @@ func loadTemplate(filesystem fs.FS, name, pattern string, html bool) (Template,

var tpl Template
if html {
t, err := htemplate.New(filepath.Base(name)).Funcs(sprig.HtmlFuncMap()).ParseFS(filesystem, glob)
t, err := htemplate.New(filepath.Base(name)).Funcs(sprig.HermeticHtmlFuncMap()).ParseFS(filesystem, glob)
if err != nil {
return nil, errors.WithStack(err)
}
tpl = t
} else {
t, err := template.New(filepath.Base(name)).Funcs(sprig.TxtFuncMap()).ParseFS(filesystem, glob)
t, err := template.New(filepath.Base(name)).Funcs(sprig.HermeticTxtFuncMap()).ParseFS(filesystem, glob)
if err != nil {
return nil, errors.WithStack(err)
}
Expand Down
17 changes: 17 additions & 0 deletions courier/template/load_template_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package template_test
import (
"context"
"encoding/base64"
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
Expand Down Expand Up @@ -60,6 +61,22 @@ func TestLoadTextTemplate(t *testing.T) {
assert.Contains(t, actual, "HelloWorld,HELLOWORLD")
})

t.Run("method=sprig should not support non-hermetic", func(t *testing.T) {
template.Cache, _ = lru.New(16)
ctx := context.Background()
_, reg := internal.NewFastRegistryWithMocks(t)

nonhermetic := []string{"date", "date_in_zone", "date_modify", "now", "htmlDate", "htmlDateInZone", "dateInZone", "dateModify", "env", "expandenv", "getHostByName", "uuidv4", "randNumeric", "randAscii", "randAlpha", "randAlphaNum"}

for _, tc := range nonhermetic {
t.Run("case=should not support function: "+tc, func(t *testing.T) {
_, err := template.LoadTextTemplate(ctx, reg, x.NewStubFS(tc, []byte(fmt.Sprintf("{{ %s }}", tc))), tc, "", map[string]interface{}{}, "")
require.Error(t, err)
require.Contains(t, err.Error(), fmt.Sprintf("function \"%s\" not defined", tc))
})
}
})

t.Run("method=html with nested templates", func(t *testing.T) {
template.Cache, _ = lru.New(16) // prevent Cache hit
m := map[string]interface{}{"lang": "en_US"} // create a simple model
Expand Down
65 changes: 65 additions & 0 deletions x/stub_fs.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package x

import (
"io"
"io/fs"
"time"
)

type StubFS struct {
name string
data []byte
offset int
}

func NewStubFS(name string, data []byte) fs.FS {
return &StubFS{
name: name,
data: data,
}
}

func (stub *StubFS) Mode() fs.FileMode {
return 0444
}

func (stub *StubFS) ModTime() time.Time {
return time.Time{}
}

func (stub *StubFS) IsDir() bool {
return false
}

func (stub *StubFS) Sys() interface{} {
return nil
}

func (stub *StubFS) Stat() (fs.FileInfo, error) {
return stub, nil
}

func (stub *StubFS) Read(bytes []byte) (int, error) {
if stub.offset >= len(stub.data) {
return 0, io.EOF
}
n := copy(bytes, stub.data[stub.offset:])
stub.offset += n
return n, nil
}

func (stub *StubFS) Close() error {
return nil
}

func (stub *StubFS) Open(name string) (fs.File, error) {
return stub, nil
}

func (stub *StubFS) Name() string {
return stub.name
}

func (stub *StubFS) Size() int64 {
return int64(len(stub.data))
}