Use go-cmp instead of reflect.DeepEqual

.github/workflows/go.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: [ 1.16.x, 1.15.x, 1.14.x, 1.13.x, 1.12.x, 1.11.x, 1.10.x, 1.9.x ]
+        go: [ 1.17.x, 1.16.x, 1.15.x, 1.14.x]
     env:
       GOPATH: ${{ github.workspace }}
       GO111MODULE: auto
@@ -35,6 +35,9 @@ jobs:
     - name: Get Dependencies (github.com/golang.org/x/tools/imports)
       run: go get -v ./...
 
+    - name: Get go-cmp
+      run: go get github.com/google/go-cmp/cmp
+
     - name: Test
       run: |
         go test -v ./...

README.md

@@ -39,6 +39,8 @@ Available options:
 
   -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
 
@@ -58,6 +60,8 @@ Available options:
   -template_params_file read external parameters to template by json with file
 
   -template_params      read external parameters to template by json with stdin
+
+  -use_go_cmp           use cmp.Equal (google/go-cmp) instead of reflect.DeepEqual
 ```
 
 ## Contributions

go.mod

@@ -1,5 +1,8 @@
 module github.com/cweill/gotests
 
-require golang.org/x/tools v0.0.0-20191109212701-97ad0ed33101
+require (
+	github.com/google/go-cmp v0.5.7
+	golang.org/x/tools v0.0.0-20191109212701-97ad0ed33101
+)
 
 go 1.6

go.sum

@@ -1,3 +1,5 @@
+github.com/google/go-cmp v0.5.7 h1:81/ik6ipDQS2aGcBfIN5dHDB36BwrStyeAQquSYCV4o=
+github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -6,3 +8,5 @@ golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/tools v0.0.0-20191109212701-97ad0ed33101 h1:LCmXVkvpQCDj724eX6irUTPCJP5GelFHxqGSWL2D1R0=
 golang.org/x/tools v0.0.0-20191109212701-97ad0ed33101/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

gotests.go

@@ -16,6 +16,11 @@ import (
 	"github.com/cweill/gotests/internal/output"
 )
 
+var cmpImport = &models.Import{
+	Name: "",
+	Path: `"github.com/google/go-cmp/cmp"`,
+}
+
 // Options provides custom filters and parameters for generating tests.
 type Options struct {
 	Only           *regexp.Regexp         // Includes only functions that match.
@@ -30,6 +35,7 @@ type Options struct {
 	TemplateDir    string                 // Path to custom template set
 	TemplateParams map[string]interface{} // Custom external parameters
 	TemplateData   [][]byte               // Data slice for templates
+	UseGoCmp       bool                   // Use google/go-cmp instead of reflect.DeepEquals
 }
 
 // A GeneratedTest contains information about a test file with generated tests.
@@ -129,6 +135,7 @@ func generateTest(src models.Path, files []models.Path, opt *Options) (*Generate
 		TemplateDir:    opt.TemplateDir,
 		TemplateParams: opt.TemplateParams,
 		TemplateData:   opt.TemplateData,
+		UseGoCmp:       opt.UseGoCmp,
 	}
 
 	b, err := options.Process(h, funcs)
@@ -155,8 +162,20 @@ func parseTestFile(p *goparser.Parser, testPath string, h *models.Header) (*mode
 		return nil, nil, fmt.Errorf("Parser.Parse test file: %v", err)
 	}
 	var testFuncs []string
+	cmpImportNeeded := false
 	for _, fun := range tr.Funcs {
 		testFuncs = append(testFuncs, fun.Name)
+		if cmpImportNeeded {
+			continue
+		}
+		for _, field := range fun.Parameters {
+			if !(field.IsWriter() || field.IsBasicType()) {
+				cmpImportNeeded = true
+			}
+		}
+	}
+	if cmpImportNeeded {
+		tr.Header.Imports = append(tr.Header.Imports, cmpImport)
 	}
 	tr.Header.Imports = append(tr.Header.Imports, h.Imports...)
 	h = tr.Header

gotests/main.go

@@ -40,6 +40,8 @@
 //   -template_params_file read external parameters to template by json with file
 //
 //   -template_params      read external parameters to template by json with stdin
+//
+//   -use_go_cmp		   use cmp.Equal (google/go-cmp) instead of reflect.DeepEqual
 package main
 
 import (
@@ -60,6 +62,7 @@ var (
 	template           = flag.String("template", "", `optional. Specify custom test code templates, e.g. testify. This can also be set via environment variable GOTESTS_TEMPLATE`)
 	templateParamsPath = flag.String("template_params_file", "", "read external parameters to template by json with file")
 	templateParams     = flag.String("template_params", "", "read external parameters to template by json with stdin")
+	useGoCmp           = flag.Bool("use_go_cmp", false, `use cmp.Equal (google/go-cmp) instead of reflect.DeepEqual to perform equality checks`)
 )
 
 var (
@@ -92,6 +95,7 @@ func main() {
 		Template:           valOrGetenv(*template, "GOTESTS_TEMPLATE"),
 		TemplateDir:        valOrGetenv(*templateDir, "GOTESTS_TEMPLATE_DIR"),
 		TemplateParamsPath: *templateParamsPath,
+		UseGoCmp:           *useGoCmp,
 	})
 }
 

gotests/main_test.go

@@ -3,6 +3,8 @@ package main
 import (
 	"os"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_valOrGetenv(t *testing.T) {
@@ -65,8 +67,8 @@ func Test_valOrGetenv(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := valOrGetenv(tt.args.val, tt.args.key); got != tt.want {
-				t.Errorf("valOrGetenv() = %v, want %v", got, tt.want)
+			if got := valOrGetenv(tt.args.val, tt.args.key); !cmp.Equal(tt.want, got) {
+				t.Errorf("valOrGetenv() = %v, want %v\ndiff=%s", got, tt.want, cmp.Diff(tt.want, got))
 			}
 		})
 	}

gotests/process/process.go

@@ -36,6 +36,7 @@ type Options struct {
 	TemplateDir        string   // Path to custom template set
 	TemplateParamsPath string   // Path to custom parameters json file(s).
 	TemplateData       [][]byte // Data slice for templates
+	UseGoCmp           bool     // Use google/go-cmp instead of reflect.DeepEquals
 }
 
 // Generates tests for the Go files defined in args with the given options.
@@ -102,6 +103,7 @@ func parseOptions(out io.Writer, opt *Options) *gotests.Options {
 		TemplateDir:    opt.TemplateDir,
 		TemplateParams: templateParams,
 		TemplateData:   opt.TemplateData,
+		UseGoCmp:       opt.UseGoCmp,
 	}
 }
 

gotests/process/process_test.go

@@ -3,6 +3,8 @@ package process
 import (
 	"bytes"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestRun(t *testing.T) {
@@ -53,8 +55,8 @@ func TestRun(t *testing.T) {
 	for _, tt := range tests {
 		out := &bytes.Buffer{}
 		Run(out, tt.args, tt.opts)
-		if got := out.String(); got != tt.want {
-			t.Errorf("%q. Run() =\n%v, want\n%v", tt.name, got, tt.want)
+		if got := out.String(); !cmp.Equal(tt.want, got) {
+			t.Errorf("%q. Run() =\n%v, want\n%v\ndiff=%s", tt.name, got, tt.want, cmp.Diff(tt.want, got))
 		}
 	}
 }