_codegen/main.go - external/github.com/stretchr/testify - Git at Google

 /*
 The MIT License (MIT)

 Copyright (c) 2015,2016 Ernesto Jiménez
 Copyright (c) 2019 Leigh McCulloch
 Copyright (c) 2020 Matt Gorzka
 Copyright (c) 2024 Simon Schulte
 Copyright (c) 2023,2025 Olivier Mengué

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */

 // This program reads all assertion functions from the assert package and
 // automatically generates the corresponding requires and forwarded assertions

 package main

 import (
 	"bytes"
 	"flag"
 	"fmt"
 	"go/ast"
 	"go/build"
 	"go/doc"
 	"go/format"
 	"go/importer"
 	"go/parser"
 	"go/token"
 	"go/types"
 	"io"
 	"log"
 	"os"
 	"path"
 	"regexp"
 	"strings"
 	"text/template"
 )

 var (
 	pkg       = flag.String("assert-path", "github.com/stretchr/testify/assert", "Path to the assert package")
 	includeF  = flag.Bool("include-format-funcs", false, "include format functions such as Errorf and Equalf")
 	outputPkg = flag.String("output-package", "", "package for the resulting code")
 	tmplFile  = flag.String("template", "", "What file to load the function template from")
 	out       = flag.String("out", "", "What file to write the source code to")
 )

 func main() {
 	flag.Parse()

 	scope, docs, err := parsePackageSource(*pkg)
 	if err != nil {
 		log.Fatal(err)
 	}

 	imports, funcs, err := analyzeCode(scope, docs)
 	if err != nil {
 		log.Fatal(err)
 	}

 	if err := generateCode(imports, funcs); err != nil {
 		log.Fatal(err)
 	}
 }

 func generateCode(imports *imports, funcs []testFunc) error {
 	buff := bytes.NewBuffer(nil)

 	tmplHead, tmplFunc, err := parseTemplates()
 	if err != nil {
 		return err
 	}

 	// Generate header
 	if err := tmplHead.Execute(buff, struct {
 		Name    string
 		Imports map[string]string
 	}{
 		*outputPkg,
 		imports.imports,
 	}); err != nil {
 		return err
 	}

 	// Generate funcs
 	for _, fn := range funcs {
 		buff.Write([]byte("\n\n"))
 		if err := tmplFunc.Execute(buff, &fn); err != nil {
 			return err
 		}
 	}

 	code, err := format.Source(buff.Bytes())
 	if err != nil {
 		return err
 	}

 	// Write file
 	output, err := outputFile()
 	if err != nil {
 		return err
 	}
 	defer output.Close()
 	_, err = io.Copy(output, bytes.NewReader(code))
 	return err
 }

 func parseTemplates() (*template.Template, *template.Template, error) {
 	tmplHead, err := template.New("header").Parse(headerTemplate)
 	if err != nil {
 		return nil, nil, err
 	}
 	if *tmplFile != "" {
 		f, err := os.ReadFile(*tmplFile)
 		if err != nil {
 			return nil, nil, err
 		}
 		funcTemplate = string(f)
 	}
 	tmpl, err := template.New("function").Funcs(template.FuncMap{
 		"replace": strings.ReplaceAll,
 	}).Parse(funcTemplate)
 	if err != nil {
 		return nil, nil, err
 	}
 	return tmplHead, tmpl, nil
 }

 func outputFile() (*os.File, error) {
 	filename := *out
 	if filename == "-" || (filename == "" && *tmplFile == "") {
 		return os.Stdout, nil
 	}
 	if filename == "" {
 		filename = strings.TrimSuffix(strings.TrimSuffix(*tmplFile, ".tmpl"), ".go") + ".go"
 	}
 	return os.Create(filename)
 }

 // analyzeCode takes the types scope and the docs and returns the import
 // information and information about all the assertion functions.
 func analyzeCode(scope *types.Scope, docs *doc.Package) (*imports, []testFunc, error) {
 	testingT := scope.Lookup("TestingT").Type().Underlying().(*types.Interface)

 	importer := &imports{
 		currentPkg: *outputPkg,
 		imports:    map[string]string{},
 	}
 	var funcs []testFunc
 	// Go through all the top level functions
 	for _, fdocs := range docs.Funcs {
 		// Find the function
 		obj := scope.Lookup(fdocs.Name)

 		fn, ok := obj.(*types.Func)
 		if !ok {
 			continue
 		}
 		// Check function signature has at least two arguments
 		sig := fn.Type().(*types.Signature)
 		if sig.Params().Len() < 2 {
 			continue
 		}
 		// Check first argument is of type testingT
 		first, ok := sig.Params().At(0).Type().(*types.Named)
 		if !ok {
 			continue
 		}
 		firstType, ok := first.Underlying().(*types.Interface)
 		if !ok {
 			continue
 		}
 		if !types.Implements(firstType, testingT) {
 			continue
 		}

 		// Skip functions ending with f
 		if strings.HasSuffix(fdocs.Name, "f") && !*includeF {
 			continue
 		}

 		funcs = append(funcs, testFunc{*outputPkg, fdocs, fn})
 		importer.addImportsFrom(sig.Params())
 	}
 	return importer, funcs, nil
 }

 // imports collects a map of imported packages for a source file.
 //
 // This code has been copied from package github.com/ernesto-jimenez/gogen/imports
 type imports struct {
 	currentPkg string
 	imports    map[string]string
 }

 func (imp *imports) addImportsFrom(t types.Type) {
 	switch el := t.(type) {
 	case *types.Basic:
 	case *types.Slice:
 		imp.addImportsFrom(el.Elem())
 	case *types.Pointer:
 		imp.addImportsFrom(el.Elem())
 	case *types.Named:
 		pkg := el.Obj().Pkg()
 		if pkg == nil {
 			return
 		}
 		if pkg.Name() == imp.currentPkg {
 			return
 		}
 		imp.imports[pkg.Path()] = pkg.Name()
 	case *types.Tuple:
 		for i := 0; i < el.Len(); i++ {
 			imp.addImportsFrom(el.At(i).Type())
 		}
 	default:
 	}
 }

 // parsePackageSource returns the types scope and the package documentation from the package
 func parsePackageSource(pkg string) (*types.Scope, *doc.Package, error) {
 	pd, err := build.Import(pkg, ".", 0)
 	if err != nil {
 		return nil, nil, err
 	}

 	fset := token.NewFileSet()
 	files := make(map[string]*ast.File)
 	fileList := make([]*ast.File, len(pd.GoFiles))
 	for i, fname := range pd.GoFiles {
 		src, err := os.ReadFile(path.Join(pd.Dir, fname))
 		if err != nil {
 			return nil, nil, err
 		}
 		f, err := parser.ParseFile(fset, fname, src, parser.ParseComments|parser.AllErrors)
 		if err != nil {
 			return nil, nil, err
 		}
 		files[fname] = f
 		fileList[i] = f
 	}

 	cfg := types.Config{
 		Importer: importer.For("source", nil),
 	}
 	info := types.Info{
 		Defs: make(map[*ast.Ident]types.Object),
 	}
 	tp, err := cfg.Check(pkg, fset, fileList, &info)
 	if err != nil {
 		return nil, nil, err
 	}

 	scope := tp.Scope()

 	ap, _ := ast.NewPackage(fset, files, nil, nil)
 	docs := doc.New(ap, pkg, 0)

 	return scope, docs, nil
 }

 type testFunc struct {
 	CurrentPkg string
 	DocInfo    *doc.Func
 	TypeInfo   *types.Func
 }

 func (f *testFunc) Qualifier(p *types.Package) string {
 	if p == nil || p.Name() == f.CurrentPkg {
 		return ""
 	}
 	return p.Name()
 }

 func (f *testFunc) Params() string {
 	sig := f.TypeInfo.Type().(*types.Signature)
 	params := sig.Params()
 	p := ""
 	comma := ""
 	to := params.Len()
 	var i int

 	if sig.Variadic() {
 		to--
 	}
 	for i = 1; i < to; i++ {
 		param := params.At(i)
 		p += fmt.Sprintf("%s%s %s", comma, param.Name(), types.TypeString(param.Type(), f.Qualifier))
 		comma = ", "
 	}
 	if sig.Variadic() {
 		param := params.At(params.Len() - 1)
 		p += fmt.Sprintf("%s%s ...%s", comma, param.Name(), types.TypeString(param.Type().(*types.Slice).Elem(), f.Qualifier))
 	}
 	return p
 }

 func (f *testFunc) ForwardedParams() string {
 	sig := f.TypeInfo.Type().(*types.Signature)
 	params := sig.Params()
 	p := ""
 	comma := ""
 	to := params.Len()
 	var i int

 	if sig.Variadic() {
 		to--
 	}
 	for i = 1; i < to; i++ {
 		param := params.At(i)
 		p += fmt.Sprintf("%s%s", comma, param.Name())
 		comma = ", "
 	}
 	if sig.Variadic() {
 		param := params.At(params.Len() - 1)
 		p += fmt.Sprintf("%s%s...", comma, param.Name())
 	}
 	return p
 }

 func (f *testFunc) ParamsFormat() string {
 	return strings.Replace(f.Params(), "msgAndArgs", "msg string, args", 1)
 }

 func (f *testFunc) ForwardedParamsFormat() string {
 	return strings.Replace(f.ForwardedParams(), "msgAndArgs", "append([]interface{}{msg}, args...)", 1)
 }

 func (f *testFunc) Comment() string {
 	return "// " + strings.Replace(strings.TrimSpace(f.DocInfo.Doc), "\n", "\n// ", -1)
 }

 func (f *testFunc) CommentFormat() string {
 	search := fmt.Sprintf("%s", f.DocInfo.Name)
 	replace := fmt.Sprintf("%sf", f.DocInfo.Name)
 	comment := strings.Replace(f.Comment(), search, replace, -1)
 	exp := regexp.MustCompile(replace + `\(((\(\)|[^\n])+)\)`)
 	return exp.ReplaceAllString(comment, replace+`($1, "error message %s", "formatted")`)
 }

 func (f *testFunc) CommentWithoutT(receiver string) string {
 	search := fmt.Sprintf("assert.%s(t, ", f.DocInfo.Name)
 	replace := fmt.Sprintf("%s.%s(", receiver, f.DocInfo.Name)
 	return strings.Replace(f.Comment(), search, replace, -1)
 }

 // Standard header https://go.dev/s/generatedcode.
 var headerTemplate = `// Code generated with github.com/stretchr/testify/_codegen; DO NOT EDIT.

 package {{.Name}}

 import (
 {{range $path, $name := .Imports}}
 	{{$name}} "{{$path}}"{{end}}
 )
 `

 var funcTemplate = `{{.Comment}}
 func (fwd *AssertionsForwarder) {{.DocInfo.Name}}({{.Params}}) bool {
 	return assert.{{.DocInfo.Name}}({{.ForwardedParams}})
 }`
	/*
	The MIT License (MIT)

	Copyright (c) 2015,2016 Ernesto Jiménez
	Copyright (c) 2019 Leigh McCulloch
	Copyright (c) 2020 Matt Gorzka
	Copyright (c) 2024 Simon Schulte
	Copyright (c) 2023,2025 Olivier Mengué

	Permission is hereby granted, free of charge, to any person obtaining a copy
	of this software and associated documentation files (the "Software"), to deal
	in the Software without restriction, including without limitation the rights
	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	copies of the Software, and to permit persons to whom the Software is
	furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in all
	copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	SOFTWARE.
	*/

	// This program reads all assertion functions from the assert package and
	// automatically generates the corresponding requires and forwarded assertions

	package main

	import (
	"bytes"
	"flag"
	"fmt"
	"go/ast"
	"go/build"
	"go/doc"
	"go/format"
	"go/importer"
	"go/parser"
	"go/token"
	"go/types"
	"io"
	"log"
	"os"
	"path"
	"regexp"
	"strings"
	"text/template"
	)

	var (
	pkg = flag.String("assert-path", "github.com/stretchr/testify/assert", "Path to the assert package")
	includeF = flag.Bool("include-format-funcs", false, "include format functions such as Errorf and Equalf")
	outputPkg = flag.String("output-package", "", "package for the resulting code")
	tmplFile = flag.String("template", "", "What file to load the function template from")
	out = flag.String("out", "", "What file to write the source code to")
	)

	func main() {
	flag.Parse()

	scope, docs, err := parsePackageSource(*pkg)
	if err != nil {
	log.Fatal(err)
	}

	imports, funcs, err := analyzeCode(scope, docs)
	if err != nil {
	log.Fatal(err)
	}

	if err := generateCode(imports, funcs); err != nil {
	log.Fatal(err)
	}
	}

	func generateCode(imports *imports, funcs []testFunc) error {
	buff := bytes.NewBuffer(nil)

	tmplHead, tmplFunc, err := parseTemplates()
	if err != nil {
	return err
	}

	// Generate header
	if err := tmplHead.Execute(buff, struct {
	Name string
	Imports map[string]string
	}{
	*outputPkg,
	imports.imports,
	}); err != nil {
	return err
	}

	// Generate funcs
	for _, fn := range funcs {
	buff.Write([]byte("\n\n"))
	if err := tmplFunc.Execute(buff, &fn); err != nil {
	return err
	}
	}

	code, err := format.Source(buff.Bytes())
	if err != nil {
	return err
	}

	// Write file
	output, err := outputFile()
	if err != nil {
	return err
	}
	defer output.Close()
	_, err = io.Copy(output, bytes.NewReader(code))
	return err
	}

	func parseTemplates() (template.Template, template.Template, error) {
	tmplHead, err := template.New("header").Parse(headerTemplate)
	if err != nil {
	return nil, nil, err
	}
	if *tmplFile != "" {
	f, err := os.ReadFile(*tmplFile)
	if err != nil {
	return nil, nil, err
	}
	funcTemplate = string(f)
	}
	tmpl, err := template.New("function").Funcs(template.FuncMap{
	"replace": strings.ReplaceAll,
	}).Parse(funcTemplate)
	if err != nil {
	return nil, nil, err
	}
	return tmplHead, tmpl, nil
	}

	func outputFile() (*os.File, error) {
	filename := *out
	if filename == "-" \|\| (filename == "" && *tmplFile == "") {
	return os.Stdout, nil
	}
	if filename == "" {
	filename = strings.TrimSuffix(strings.TrimSuffix(*tmplFile, ".tmpl"), ".go") + ".go"
	}
	return os.Create(filename)
	}

	// analyzeCode takes the types scope and the docs and returns the import
	// information and information about all the assertion functions.
	func analyzeCode(scope types.Scope, docs doc.Package) (*imports, []testFunc, error) {
	testingT := scope.Lookup("TestingT").Type().Underlying().(*types.Interface)

	importer := &imports{
	currentPkg: *outputPkg,
	imports: map[string]string{},
	}
	var funcs []testFunc
	// Go through all the top level functions
	for _, fdocs := range docs.Funcs {
	// Find the function
	obj := scope.Lookup(fdocs.Name)

	fn, ok := obj.(*types.Func)
	if !ok {
	continue
	}
	// Check function signature has at least two arguments
	sig := fn.Type().(*types.Signature)
	if sig.Params().Len() < 2 {
	continue
	}
	// Check first argument is of type testingT
	first, ok := sig.Params().At(0).Type().(*types.Named)
	if !ok {
	continue
	}
	firstType, ok := first.Underlying().(*types.Interface)
	if !ok {
	continue
	}
	if !types.Implements(firstType, testingT) {
	continue
	}

	// Skip functions ending with f
	if strings.HasSuffix(fdocs.Name, "f") && !*includeF {
	continue
	}

	funcs = append(funcs, testFunc{*outputPkg, fdocs, fn})
	importer.addImportsFrom(sig.Params())
	}
	return importer, funcs, nil
	}

	// imports collects a map of imported packages for a source file.
	//
	// This code has been copied from package github.com/ernesto-jimenez/gogen/imports
	type imports struct {
	currentPkg string
	imports map[string]string
	}

	func (imp *imports) addImportsFrom(t types.Type) {
	switch el := t.(type) {
	case *types.Basic:
	case *types.Slice:
	imp.addImportsFrom(el.Elem())
	case *types.Pointer:
	imp.addImportsFrom(el.Elem())
	case *types.Named:
	pkg := el.Obj().Pkg()
	if pkg == nil {
	return
	}
	if pkg.Name() == imp.currentPkg {
	return
	}
	imp.imports[pkg.Path()] = pkg.Name()
	case *types.Tuple:
	for i := 0; i < el.Len(); i++ {
	imp.addImportsFrom(el.At(i).Type())
	}
	default:
	}
	}

	// parsePackageSource returns the types scope and the package documentation from the package
	func parsePackageSource(pkg string) (types.Scope, doc.Package, error) {
	pd, err := build.Import(pkg, ".", 0)
	if err != nil {
	return nil, nil, err
	}

	fset := token.NewFileSet()
	files := make(map[string]*ast.File)
	fileList := make([]*ast.File, len(pd.GoFiles))
	for i, fname := range pd.GoFiles {
	src, err := os.ReadFile(path.Join(pd.Dir, fname))
	if err != nil {
	return nil, nil, err
	}
	f, err := parser.ParseFile(fset, fname, src, parser.ParseComments\|parser.AllErrors)
	if err != nil {
	return nil, nil, err
	}
	files[fname] = f
	fileList[i] = f
	}

	cfg := types.Config{
	Importer: importer.For("source", nil),
	}
	info := types.Info{
	Defs: make(map[*ast.Ident]types.Object),
	}
	tp, err := cfg.Check(pkg, fset, fileList, &info)
	if err != nil {
	return nil, nil, err
	}

	scope := tp.Scope()

	ap, _ := ast.NewPackage(fset, files, nil, nil)
	docs := doc.New(ap, pkg, 0)

	return scope, docs, nil
	}

	type testFunc struct {
	CurrentPkg string
	DocInfo *doc.Func
	TypeInfo *types.Func
	}

	func (f testFunc) Qualifier(p types.Package) string {
	if p == nil \|\| p.Name() == f.CurrentPkg {
	return ""
	}
	return p.Name()
	}

	func (f *testFunc) Params() string {
	sig := f.TypeInfo.Type().(*types.Signature)
	params := sig.Params()
	p := ""
	comma := ""
	to := params.Len()
	var i int

	if sig.Variadic() {
	to--
	}
	for i = 1; i < to; i++ {
	param := params.At(i)
	p += fmt.Sprintf("%s%s %s", comma, param.Name(), types.TypeString(param.Type(), f.Qualifier))
	comma = ", "
	}
	if sig.Variadic() {
	param := params.At(params.Len() - 1)
	p += fmt.Sprintf("%s%s ...%s", comma, param.Name(), types.TypeString(param.Type().(*types.Slice).Elem(), f.Qualifier))
	}
	return p
	}

	func (f *testFunc) ForwardedParams() string {
	sig := f.TypeInfo.Type().(*types.Signature)
	params := sig.Params()
	p := ""
	comma := ""
	to := params.Len()
	var i int

	if sig.Variadic() {
	to--
	}
	for i = 1; i < to; i++ {
	param := params.At(i)
	p += fmt.Sprintf("%s%s", comma, param.Name())
	comma = ", "
	}
	if sig.Variadic() {
	param := params.At(params.Len() - 1)
	p += fmt.Sprintf("%s%s...", comma, param.Name())
	}
	return p
	}

	func (f *testFunc) ParamsFormat() string {
	return strings.Replace(f.Params(), "msgAndArgs", "msg string, args", 1)
	}

	func (f *testFunc) ForwardedParamsFormat() string {
	return strings.Replace(f.ForwardedParams(), "msgAndArgs", "append([]interface{}{msg}, args...)", 1)
	}

	func (f *testFunc) Comment() string {
	return "// " + strings.Replace(strings.TrimSpace(f.DocInfo.Doc), "\n", "\n// ", -1)
	}

	func (f *testFunc) CommentFormat() string {
	search := fmt.Sprintf("%s", f.DocInfo.Name)
	replace := fmt.Sprintf("%sf", f.DocInfo.Name)
	comment := strings.Replace(f.Comment(), search, replace, -1)
	exp := regexp.MustCompile(replace + `\(((\(\)\|[^\n])+)\)`)
	return exp.ReplaceAllString(comment, replace+`($1, "error message %s", "formatted")`)
	}

	func (f *testFunc) CommentWithoutT(receiver string) string {
	search := fmt.Sprintf("assert.%s(t, ", f.DocInfo.Name)
	replace := fmt.Sprintf("%s.%s(", receiver, f.DocInfo.Name)
	return strings.Replace(f.Comment(), search, replace, -1)
	}

	// Standard header https://go.dev/s/generatedcode.
	var headerTemplate = `// Code generated with github.com/stretchr/testify/_codegen; DO NOT EDIT.

	package {{.Name}}

	import (
	{{range $path, $name := .Imports}}
	{{$name}} "{{$path}}"{{end}}
	)
	`

	var funcTemplate = `{{.Comment}}
	func (fwd *AssertionsForwarder) {{.DocInfo.Name}}({{.Params}}) bool {
	return assert.{{.DocInfo.Name}}({{.ForwardedParams}})
	}`