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.

Sign up for GitHub

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

tests(v3): add tests for template funcs #918

Open
wants to merge 2 commits into
base: v3
Choose a base branch
from
Open

tests(v3): add tests for template funcs #918

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93a364d
tests(v3): add tests for template funcs
ravsii Feb 13, 2025
c2f1639
fix: file tests
ravsii Feb 13, 2025
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
383 changes: 339 additions & 44 deletions template/template_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,347 @@ package template

import (
"go/types"
"os"
"strings"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestTemplateStringFuncs(t *testing.T) {
// For env tests
os.Setenv("MOCKERY_TEST_ENV", "TEST")

tests := []struct {
name string
inTemplate string
inData map[string]any
want string
}{
{
name: "contains",
inTemplate: "{{contains .TemplateData.sub .TemplateData.str}}",
inData: map[string]any{"str": "golang", "sub": "go"},
want: "true",
},
{
name: "hasPrefix",
inTemplate: "{{hasPrefix .TemplateData.pre .TemplateData.str}}",
inData: map[string]any{"str": "golang", "pre": "go"},
want: "true",
},
{
name: "hasSuffix",
inTemplate: "{{hasSuffix .TemplateData.suf .TemplateData.str}}",
inData: map[string]any{"str": "golang", "suf": "lang"},
want: "true",
},
{
name: "join",
inTemplate: "{{join .TemplateData.sep .TemplateData.elems}}",
inData: map[string]any{"elems": []string{"1", "2", "3"}, "sep": ","},
want: "1,2,3",
},
{
name: "replace",
inTemplate: "{{replace .TemplateData.old .TemplateData.new .TemplateData.n .TemplateData.s}}",
inData: map[string]any{"old": "old", "new": "new", "n": 2, "s": "oldoldold"},
want: "newnewold",
},
{
name: "replaceAll",
inTemplate: "{{replaceAll .TemplateData.old .TemplateData.new .TemplateData.s}}",
inData: map[string]any{"old": "old", "new": "new", "s": "oldoldold"},
want: "newnewnew",
},

// String splitting
{
name: "split",
inTemplate: "{{split .TemplateData.sep .TemplateData.s}}",
inData: map[string]any{"s": "a,b,c", "sep": ","},
want: "[a b c]",
},
{
name: "splitAfter",
inTemplate: "{{splitAfter .TemplateData.sep .TemplateData.s}}",
inData: map[string]any{"s": "a,b,c", "sep": ","},
want: "[a, b, c]",
},
{
name: "splitAfterN",
inTemplate: "{{splitAfterN .TemplateData.sep .TemplateData.n .TemplateData.s}}",
inData: map[string]any{"s": "a,b,c,d", "sep": ",", "n": 2},
want: "[a, b,c,d]",
},

// Trimming functions
{
name: "trim",
inTemplate: "{{trim .TemplateData.cutset .TemplateData.s}}",
inData: map[string]any{"s": "---hello---", "cutset": "-"},
want: "hello",
},
{
name: "trimLeft",
inTemplate: "{{trimLeft .TemplateData.cutset .TemplateData.s}}",
inData: map[string]any{"s": "---hello---", "cutset": "-"},
want: "hello---",
},
{
name: "trimRight",
inTemplate: "{{trimRight .TemplateData.cutset .TemplateData.s}}",
inData: map[string]any{"s": "---hello---", "cutset": "-"},
want: "---hello",
},
{
name: "trimPrefix",
inTemplate: "{{trimPrefix .TemplateData.prefix .TemplateData.s}}",
inData: map[string]any{"s": "prefix_text", "prefix": "prefix_"},
want: "text",
},
{
name: "trimSuffix",
inTemplate: "{{trimSuffix .TemplateData.suffix .TemplateData.s}}",
inData: map[string]any{"s": "text_suffix", "suffix": "_suffix"},
want: "text",
},
{
name: "trimSpace",
inTemplate: "{{trimSpace .TemplateData.s}}",
inData: map[string]any{"s": " hello world "},
want: "hello world",
},

// Casing functions
{
name: "lower",
inTemplate: "{{lower .TemplateData.s}}",
inData: map[string]any{"s": "GoLang"},
want: "golang",
},
{
name: "upper",
inTemplate: "{{upper .TemplateData.s}}",
inData: map[string]any{"s": "golang"},
want: "GOLANG",
},
{
name: "camelcase",
inTemplate: "{{camelcase .TemplateData.s}}",
inData: map[string]any{"s": "hello_world"},
want: "helloWorld",
},
{
name: "snakecase",
inTemplate: "{{snakecase .TemplateData.s}}",
inData: map[string]any{"s": "HelloWorld"},
want: "hello_world",
},
{
name: "kebabcase",
inTemplate: "{{kebabcase .TemplateData.s}}",
inData: map[string]any{"s": "HelloWorld"},
want: "hello-world",
},
{
name: "firstLower",
inTemplate: "{{firstLower .TemplateData.s}}",
inData: map[string]any{"s": "GoLang"},
want: "goLang",
},
{
name: "firstUpper",
inTemplate: "{{firstUpper .TemplateData.s}}",
inData: map[string]any{"s": "golang"},
want: "Golang",
},

// Regex functions
{
name: "matchString",
inTemplate: "{{matchString .TemplateData.pattern .TemplateData.s}}",
inData: map[string]any{"pattern": "go.*", "s": "golang"},
want: "true",
},
{
name: "quoteMeta",
inTemplate: "{{quoteMeta .TemplateData.s}}",
inData: map[string]any{"s": "1+1=2"},
want: `1\+1=2`,
},

// Filepath manipulation
{
name: "base",
inTemplate: "{{base .TemplateData.s}}",
inData: map[string]any{"s": "/home/user/file.txt"},
want: "file.txt",
},
{
name: "clean",
inTemplate: "{{clean .TemplateData.s}}",
inData: map[string]any{"s": "/home/user/../file.txt"},
want: "/home/file.txt",
},
{
name: "dir",
inTemplate: "{{dir .TemplateData.s}}",
inData: map[string]any{"s": "/home/user/file.txt"},
want: "/home/user",
},

// Environment variables
{
name: "getenv",
inTemplate: "{{getenv .TemplateData.s}}",
inData: map[string]any{"s": "MOCKERY_TEST_ENV"},
want: "TEST",
},
{
name: "expandEnv",
inTemplate: "{{expandEnv .TemplateData.s}}",
inData: map[string]any{"s": "${MOCKERY_TEST_ENV}"},
want: "TEST",
},

// Arithmetic
{
name: "add",
inTemplate: "{{add .TemplateData.i1 .TemplateData.i2}}",
inData: map[string]any{"i1": 5, "i2": 10},
want: "15",
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

tt, err := New(tc.inTemplate, tc.name)
require.NoError(t, err)

var sb strings.Builder
err = tt.Execute(&sb, Data{TemplateData: tc.inData})
require.NoError(t, err)
assert.Equal(t, tc.want, sb.String())
})
}
}

func TestTemplateMockFuncs(t *testing.T) {
t.Run("Exported", func(t *testing.T) {
f := TemplateMockFuncs["exported"].(func(string) string)
if f("") != "" {
t.Errorf("Exported(...) want: ``; got: `%s`", f(""))
}
if f("var") != "Var" {
t.Errorf("Exported(...) want: `Var`; got: `%s`", f("var"))
}
})

t.Run("ImportStatement", func(t *testing.T) {
f := TemplateMockFuncs["importStatement"].(func(*Package) string)
pkg := NewPackage(types.NewPackage("xyz", "xyz"))
if f(pkg) != `"xyz"` {
t.Errorf("ImportStatement(...): want: `\"xyz\"`; got: `%s`", f(pkg))
}

pkg.Alias = "x"
if f(pkg) != `x "xyz"` {
t.Errorf("ImportStatement(...): want: `x \"xyz\"`; got: `%s`", f(pkg))
}
})

t.Run("SyncPkgQualifier", func(t *testing.T) {
f := TemplateMockFuncs["syncPkgQualifier"].(func([]*Package) string)
if f(nil) != "sync" {
t.Errorf("SyncPkgQualifier(...): want: `sync`; got: `%s`", f(nil))
}
imports := []*Package{
NewPackage(types.NewPackage("sync", "sync")),
NewPackage(types.NewPackage("github.com/some/module", "module")),
}
if f(imports) != "sync" {
t.Errorf("SyncPkgQualifier(...): want: `sync`; got: `%s`", f(imports))
}

syncPkg := NewPackage(types.NewPackage("sync", "sync"))
syncPkg.Alias = "stdsync"
otherSyncPkg := NewPackage(types.NewPackage("github.com/someother/sync", "sync"))
imports = []*Package{otherSyncPkg, syncPkg}
if f(imports) != "stdsync" {
t.Errorf("SyncPkgQualifier(...): want: `stdsync`; got: `%s`", f(imports))
}
})
tests := []struct {
name string
inTemplate string
dataInit func() Data
want string
}{
{
name: "importStatement",
inTemplate: "{{- range .Imports}}{{. | importStatement}}{{- end}}",
dataInit: func() Data {
imprt := NewPackage(types.NewPackage("xyz", "xyz"))
imprt.Alias = "x"
return Data{Imports: []*Package{imprt}}
},
want: `x "xyz"`,
},
{
name: "syncPkgQualifier",
inTemplate: "{{$.Imports | syncPkgQualifier}}",
dataInit: func() Data {
return Data{Imports: []*Package{
NewPackage(types.NewPackage("sync", "sync")),
NewPackage(types.NewPackage("github.com/some/module", "module")),
}}
},
want: "sync",
},
{
name: "syncPkgQualifier renamed",
inTemplate: "{{$.Imports | syncPkgQualifier}}",
dataInit: func() Data {
stdSync := NewPackage(types.NewPackage("sync", "sync"))
stdSync.Alias = "stdSync"
otherSyncPkg := NewPackage(types.NewPackage("github.com/someother/sync", "sync"))

return Data{Imports: []*Package{stdSync, otherSyncPkg}}
},
want: "stdSync",
},
{
name: "exported empty",
inTemplate: "{{exported .TemplateData.var}}",
dataInit: func() Data { return Data{TemplateData: map[string]any{"var": ""}} },
want: "",
},
{
name: "exported var",
inTemplate: "{{exported .TemplateData.var}}",
dataInit: func() Data { return Data{TemplateData: map[string]any{"var": "someVar"}} },
want: "SomeVar",
},
{
name: "exported acronym",
inTemplate: "{{exported .TemplateData.var}}",
dataInit: func() Data { return Data{TemplateData: map[string]any{"var": "sql"}} },
want: "SQL",
},
{
name: "mocksSomeMethod",
inTemplate: "{{mocksSomeMethod .Mocks}}",
dataInit: func() Data {
// MethodData has to have at least 1 element to pass.
return Data{Mocks: []MockData{{Methods: []MethodData{{}}}}}
},
want: "true",
},
{
name: "typeConstraint",
inTemplate: "{{index .Mocks 0 | typeConstraintTest}}",
dataInit: func() Data {
return Data{Mocks: []MockData{{
TypeParams: []TypeParamData{{
ParamData: ParamData{
Var: &Var{Name: "t", typ: &types.Slice{}},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couldn't find a better type that implements that interface, and I can't change the underlying type of a slice element, so it's []<nil> in the tests

},
}},
}}}
},
want: "[T []<nil>]",
},
{
name: "readFile",
inTemplate: "{{readFile .TemplateData.f}}",
dataInit: func() Data {
f, err := os.CreateTemp(".", "readFileTest")
require.NoError(t, err)

t.Cleanup(func() {
os.Remove(f.Name())
})

_, err = f.WriteString("content")
require.NoError(t, err)

return Data{TemplateData: map[string]any{"f": f.Name()}}
},
want: "content",
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

tt, err := New(tc.inTemplate, tc.name)
require.NoError(t, err)

var sb strings.Builder
err = tt.Execute(&sb, tc.dataInit())
require.NoError(t, err)
assert.Equal(t, tc.want, sb.String())
})
}
}