Add Named option to makes tests a map (#152)

* feature(named): Table Data as map (aka `named`) * added `named` arguments to produce map instead of the slice with names as keys * help records updated (readme and main.go) * dev: adding tests minor tests adjustments * fix: attempt to fix testify imports Resolves #153 * tests: some of the tests (named=off) removed As this functionality most probably already covered.
cweill · Mar 27, 2021 · d503102 · d503102
1 parent d408325
commit d503102
Show file tree

Hide file tree

Showing 22 changed files with 298 additions and 82 deletions.
diff --git a/gotests.go b/gotests.go
@@ -24,6 +24,7 @@ type Options struct {
 	PrintInputs    bool                   // Print function parameters in error messages
 	Subtests       bool                   // Print tests using Go 1.7 subtests
 	Parallel       bool                   // Print tests that runs the subtests in parallel.
+	Named          bool                   // Create Map instead of slice
 	Importer       func() types.Importer  // A custom importer.
 	Template       string                 // Name of custom template set
 	TemplateDir    string                 // Path to custom template set
@@ -118,10 +119,12 @@ func generateTest(src models.Path, files []models.Path, opt *Options) (*Generate
 	if len(funcs) == 0 {
 		return nil, nil
 	}
+
 	b, err := output.Process(h, funcs, &output.Options{
 		PrintInputs:    opt.PrintInputs,
 		Subtests:       opt.Subtests,
 		Parallel:       opt.Parallel,
+		Named:          opt.Named,
 		Template:       opt.Template,
 		TemplateDir:    opt.TemplateDir,
 		TemplateParams: opt.TemplateParams,

diff --git a/gotests/main.go b/gotests/main.go
@@ -19,12 +19,14 @@
 //
 //   -i                    print test inputs in error messages
 //
+//   -named                switch table tests from using slice to map (with test name for the key)
+//
 //   -only                 regexp. generate tests for functions and methods that match only.
 //                         Takes precedence over -all
 //
-//   -nosubtests           disable subtest generation when >= Go 1.7
+//   -nosubtests           disable generating tests using the Go 1.7 subtests feature
 //
-//   -parallel             enable parallel subtest generation when >= Go 1.7.
+//   -parallel             enable generating parallel subtests using the Go 1.7 feature
 //
 //   -w                    write output to (test) files instead of stdout
 //
@@ -37,7 +39,7 @@
 //
 //   -template_params_file read external parameters to template by json with file
 //
-//   -template_params	   read external parameters to template by json with stdin
+//   -template_params      read external parameters to template by json with stdin
 package main
 
 import (
@@ -68,6 +70,9 @@ var (
 
 	// parallel is default false.
 	parallel bool
+
+	// use map instead of slice for table tests.
+	named bool
 )
 
 func main() {
@@ -82,6 +87,7 @@ func main() {
 		PrintInputs:        *printInputs,
 		Subtests:           !nosubtests,
 		Parallel:           parallel,
+		Named:              named,
 		WriteOutput:        *writeOutput,
 		Template:           valOrGetenv(*template, "GOTESTS_TEMPLATE"),
 		TemplateDir:        valOrGetenv(*templateDir, "GOTESTS_TEMPLATE_DIR"),

diff --git a/gotests/process/process.go b/gotests/process/process.go
@@ -30,6 +30,7 @@ type Options struct {
 	PrintInputs        bool     // Print function parameters as part of error messages.
 	Subtests           bool     // Print tests using Go 1.7 subtests
 	Parallel           bool     // Print tests that runs the subtests in parallel.
+	Named              bool     // Create Map instead of slice
 	WriteOutput        bool     // Write output to test file(s).
 	Template           string   // Name of custom template set
 	TemplateDir        string   // Path to custom template set
@@ -96,6 +97,7 @@ func parseOptions(out io.Writer, opt *Options) *gotests.Options {
 		PrintInputs:    opt.PrintInputs,
 		Subtests:       opt.Subtests,
 		Parallel:       opt.Parallel,
+		Named:          opt.Named,
 		Template:       opt.Template,
 		TemplateDir:    opt.TemplateDir,
 		TemplateParams: templateParams,

diff --git a/gotests/subtests.go b/gotests/subtests.go
@@ -6,5 +6,6 @@ import "flag"
 
 func init() {
 	flag.BoolVar(&nosubtests, "nosubtests", false, "disable generating tests using the Go 1.7 subtests feature")
-	flag.BoolVar(&parallel, "parallel", false, "enable generating parallel subtests")
+	flag.BoolVar(&parallel, "parallel", false, "enable generating parallel subtests using the Go 1.7 feature")
+	flag.BoolVar(&named, "named", false, "switch table tests from using slice to map (with test name for the key)")
 }
diff --git a/gotests_test.go b/gotests_test.go
@@ -25,6 +25,7 @@ func TestGenerateTests(t *testing.T) {
 		printInputs        bool
 		subtests           bool
 		parallel           bool
+		named              bool
 		importer           types.Importer
 		templateDir        string
 		template           string
@@ -561,7 +562,7 @@ func TestGenerateTests(t *testing.T) {
 		{
 			name: "Entire testdata directory",
 			args: args{
-				srcPath: `testdata/`,
+				srcPath:  `testdata/`,
 				template: "testify",
 			},
 			wantMultipleTests: true,
@@ -812,6 +813,64 @@ func TestGenerateTests(t *testing.T) {
 			},
 			want: mustReadAndFormatGoFile(t, "testdata/goldens/function_with_return_value_template_data.go"),
 		},
+		{
+			name: "named_named=on",
+			args: args{
+				srcPath: "testdata/test038.go",
+				named:   true,
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on.go"),
+		},
+		{
+			name: "named_named=on,template=testify",
+			args: args{
+				srcPath:  "testdata/test038.go",
+				template: "testify",
+				named:    true,
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on_template_testify.go"),
+		},
+
+		{
+			name: "named_named=on,subtests=on",
+			args: args{
+				srcPath:  "testdata/test038.go",
+				subtests: true,
+				named:    true,
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on_subtests_on.go"),
+		},
+		{
+			name: "named_named=on,subtests=on,template=testify",
+			args: args{
+				srcPath:  "testdata/test038.go",
+				subtests: true,
+				named:    true,
+				template: "testify",
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on_subtests_on_template_testify.go"),
+		},
+		{
+			name: "named_named=on,subtests=on,parallel=on",
+			args: args{
+				srcPath:  "testdata/test038.go",
+				subtests: true,
+				parallel: true,
+				named:    true,
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on_subtests_on_parallel_on.go"),
+		},
+		{
+			name: "named_named=on,subtests=on,parallel=on,template=testify",
+			args: args{
+				srcPath:  "testdata/test038.go",
+				subtests: true,
+				parallel: true,
+				named:    true,
+				template: "testify",
+			},
+			want: mustReadAndFormatGoFile(t, "testdata/named/named_on_subtests_on_parallel_on_template_testify.go"),
+		},
 	}
 	tmp, err := ioutil.TempDir("", "gotests_test")
 	if err != nil {
@@ -836,6 +895,7 @@ func TestGenerateTests(t *testing.T) {
 				PrintInputs:    tt.args.printInputs,
 				Subtests:       tt.args.subtests,
 				Parallel:       tt.args.parallel,
+				Named:          tt.args.named,
 				Importer:       func() types.Importer { return tt.args.importer },
 				TemplateDir:    tt.args.templateDir,
 				Template:       tt.args.template,

diff --git a/internal/output/output.go b/internal/output/output.go
@@ -14,10 +14,16 @@ import (
 	"github.com/cweill/gotests/internal/render"
 )
 
+// we do not need support for aliases in import for now.
+var importsMap = map[string]string{
+	"testify": "github.com/stretchr/testify/assert",
+}
+
 type Options struct {
 	PrintInputs    bool
 	Subtests       bool
 	Parallel       bool
+	Named          bool
 	Template       string
 	TemplateDir    string
 	TemplateParams map[string]interface{}
@@ -68,12 +74,19 @@ func IsFileExist(path string) bool {
 }
 
 func writeTests(w io.Writer, head *models.Header, funcs []*models.Function, opt *Options) error {
+	if path, ok := importsMap[opt.Template]; ok {
+		head.Imports = append(head.Imports, &models.Import{
+			Path: fmt.Sprintf(`"%s"`, path),
+		})
+	}
+
 	b := bufio.NewWriter(w)
 	if err := render.Header(b, head); err != nil {
 		return fmt.Errorf("render.Header: %v", err)
 	}
+
 	for _, fun := range funcs {
-		if err := render.TestFunction(b, fun, opt.PrintInputs, opt.Subtests, opt.Parallel, opt.TemplateParams); err != nil {
+		if err := render.TestFunction(b, fun, opt.PrintInputs, opt.Subtests, opt.Named, opt.Parallel, opt.TemplateParams); err != nil {
 			return fmt.Errorf("render.TestFunction: %v", err)
 		}
 	}

diff --git a/internal/render/bindata/esc.go b/internal/render/bindata/esc.go
diff --git a/internal/render/render.go b/internal/render/render.go
@@ -19,9 +19,7 @@ const (
 	nFile = 7
 )
 
-var (
-	tmpls *template.Template
-)
+var tmpls *template.Template
 
 func init() {
 	Reset()
@@ -169,18 +167,20 @@ func Header(w io.Writer, h *models.Header) error {
 	return err
 }
 
-func TestFunction(w io.Writer, f *models.Function, printInputs, subtests, parallel bool, templateParams map[string]interface{}) error {
+func TestFunction(w io.Writer, f *models.Function, printInputs, subtests, named, parallel bool, templateParams map[string]interface{}) error {
 	return tmpls.ExecuteTemplate(w, "function", struct {
 		*models.Function
 		PrintInputs    bool
 		Subtests       bool
 		Parallel       bool
+		Named          bool
 		TemplateParams map[string]interface{}
 	}{
 		Function:       f,
 		PrintInputs:    printInputs,
 		Subtests:       subtests,
 		Parallel:       parallel,
+		Named:          named,
 		TemplateParams: templateParams,
 	})
 }
diff --git a/internal/render/templates/function.tmpl b/internal/render/templates/function.tmpl
@@ -20,8 +20,8 @@ func {{.TestName}}(t *testing.T) {
 		{{- end}}
 	}
 	{{- end}}
-	tests := []struct {
-		name string
+	tests := {{ if .Named}}map[string]struct{{else}}[]struct{{end}} {
+		{{ if (not .Named)}}name string{{end}}
 		{{- with .Receiver}}
 			{{- if and .IsStruct .Fields}}
 				fields fields
@@ -41,10 +41,11 @@ func {{.TestName}}(t *testing.T) {
 	}{
 		// TODO: Add test cases.
 	}
-	for {{if (or .Subtests (not .IsNaked))}} _, tt := {{end}} range tests {
+	for {{if (or .Subtests (not .IsNaked))}} {{if .Named}}name{{else}}_{{end}}, tt := {{end}} range tests {
 		{{- if .Subtests}}
-		{{- if .Parallel}}tt := tt{{end}}
-		t.Run(tt.name, func(t *testing.T) {
+		{{- if .Parallel}}tt := tt;{{end}}
+		{{- if and .Parallel .Named}}name := name;{{ end }}
+		t.Run({{if .Named}}name{{else}}tt.name{{end}}, func(t *testing.T) {
 			{{- if .Parallel}}t.Parallel(){{end}}
 		{{- end}}
 			{{- with .Receiver}}

diff --git a/internal/render/templates/inputs.tmpl b/internal/render/templates/inputs.tmpl
@@ -1 +1 @@
-{{define "inputs"}}{{$f := .}}{{if not .Subtests}}tt.name, {{end}}{{if $f.PrintInputs}}{{range $f.Parameters}}tt.args.{{Param .}}, {{end}}{{end}}{{end}}
+{{define "inputs"}}{{$f := .}}{{if not .Subtests}}{{if not .Named}}tt.{{end}}name, {{end}}{{if $f.PrintInputs}}{{range $f.Parameters}}tt.args.{{Param .}}, {{end}}{{end}}{{end}}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{{define "inputs"}}{{$f := .}}{{if not .Subtests}}tt.name, {{end}}{{if $f.PrintInputs}}{{range $f.Parameters}}tt.args.{{Param .}}, {{end}}{{end}}{{end}}
		{{define "inputs"}}{{$f := .}}{{if not .Subtests}}{{if not .Named}}tt.{{end}}name, {{end}}{{if $f.PrintInputs}}{{range $f.Parameters}}tt.args.{{Param .}}, {{end}}{{end}}{{end}}