summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/stretchr/testify/_codegen/main.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/stretchr/testify/_codegen/main.go')
-rw-r--r--vendor/github.com/stretchr/testify/_codegen/main.go287
1 files changed, 287 insertions, 0 deletions
diff --git a/vendor/github.com/stretchr/testify/_codegen/main.go b/vendor/github.com/stretchr/testify/_codegen/main.go
new file mode 100644
index 000000000..328009f84
--- /dev/null
+++ b/vendor/github.com/stretchr/testify/_codegen/main.go
@@ -0,0 +1,287 @@
+// This program reads all assertion functions from the assert package and
+// automatically generates the corersponding requires and forwarded assertions
+
+package main
+
+import (
+ "bytes"
+ "flag"
+ "fmt"
+ "go/ast"
+ "go/build"
+ "go/doc"
+ "go/importer"
+ "go/parser"
+ "go/token"
+ "go/types"
+ "io"
+ "io/ioutil"
+ "log"
+ "os"
+ "path"
+ "strings"
+ "text/template"
+
+ "github.com/ernesto-jimenez/gogen/imports"
+)
+
+var (
+ pkg = flag.String("assert-path", "github.com/stretchr/testify/assert", "Path to the assert package")
+ 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)
+ }
+
+ importer, funcs, err := analyzeCode(scope, docs)
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ if err := generateCode(importer, funcs); err != nil {
+ log.Fatal(err)
+ }
+}
+
+func generateCode(importer imports.Importer, 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,
+ importer.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
+ }
+ }
+
+ // Write file
+ output, err := outputFile()
+ if err != nil {
+ return err
+ }
+ defer output.Close()
+ _, err = io.Copy(output, buff)
+ 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 := ioutil.ReadFile(*tmplFile)
+ if err != nil {
+ return nil, nil, err
+ }
+ funcTemplate = string(f)
+ }
+ tmpl, err := template.New("function").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.Importer, []testFunc, error) {
+ testingT := scope.Lookup("TestingT").Type().Underlying().(*types.Interface)
+
+ importer := imports.New(*outputPkg)
+ 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 signatuer 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
+ }
+
+ funcs = append(funcs, testFunc{*outputPkg, fdocs, fn})
+ importer.AddImportsFrom(sig.Params())
+ }
+ return importer, funcs, nil
+}
+
+// parsePackageSource returns the types scope and the package documentation from the pa
+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 := ioutil.ReadFile(path.Join(pd.SrcRoot, pd.ImportPath, 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.Default(),
+ }
+ 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) Comment() string {
+ return "// " + strings.Replace(strings.TrimSpace(f.DocInfo.Doc), "\n", "\n// ", -1)
+}
+
+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)
+}
+
+var headerTemplate = `/*
+* CODE GENERATED AUTOMATICALLY WITH github.com/stretchr/testify/_codegen
+* THIS FILE MUST NOT BE EDITED BY HAND
+*/
+
+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}})
+}`