Add support for TestMain function in test mode #380
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,11 @@ package main | |
|
|
||
| import ( | ||
| "bytes" | ||
| "errors" | ||
| "fmt" | ||
| "go/ast" | ||
| "go/build" | ||
| "go/doc" | ||
| "go/parser" | ||
| "go/scanner" | ||
| "go/token" | ||
|
|
@@ -18,11 +20,14 @@ import ( | |
| "path" | ||
| "path/filepath" | ||
| "runtime" | ||
| // "sort" | ||
| "strconv" | ||
| "strings" | ||
| "syscall" | ||
| "text/template" | ||
| "time" | ||
| "unicode" | ||
| "unicode/utf8" | ||
|
|
||
| gbuild "github.com/gopherjs/gopherjs/build" | ||
| "github.com/gopherjs/gopherjs/compiler" | ||
|
|
@@ -325,25 +330,27 @@ func main() { | |
| fmt.Printf("? \t%s\t[no test files]\n", pkg.ImportPath) | ||
| continue | ||
| } | ||
| s := gbuild.NewSession(options) | ||
|
|
||
| tests := &testFuncs{Package: pkg.Package} | ||
| collectTests := func(testPkg *gbuild.PackageData, testPkgName string, needVar *bool) error { | ||
| if testPkgName == "_test" { | ||
| for _, file := range pkg.TestGoFiles { | ||
| if err := tests.load(filepath.Join(pkg.Package.Dir, file), testPkgName, &tests.ImportTest, &tests.NeedTest); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } else { | ||
| for _, file := range pkg.XTestGoFiles { | ||
| if err := tests.load(filepath.Join(pkg.Package.Dir, file), "_xtest", &tests.ImportXtest, &tests.NeedXtest); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| _, err := s.BuildPackage(testPkg) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
|
|
@@ -770,12 +777,15 @@ func runNode(script string, args []string, dir string, quiet bool) error { | |
| } | ||
|
|
||
| type testFuncs struct { | ||
| Tests []testFunc | ||
| Benchmarks []testFunc | ||
| Examples []testFunc | ||
| TestMain *testFunc | ||
| Package *build.Package | ||
| ImportTest bool | ||
| NeedTest bool | ||
| ImportXtest bool | ||
| NeedXtest bool | ||
| } | ||
|
|
||
| type testFunc struct { | ||
|
|
@@ -784,18 +794,111 @@ type testFunc struct { | |
| Output string // output, for examples | ||
| } | ||
|
|
||
| var testFileSet = token.NewFileSet() | ||
|
|
||
| func (t *testFuncs) load(filename, pkg string, doImport, seen *bool) error { | ||
| f, err := parser.ParseFile(testFileSet, filename, nil, parser.ParseComments) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, d := range f.Decls { | ||
| n, ok := d.(*ast.FuncDecl) | ||
| if !ok { | ||
| continue | ||
| } | ||
| if n.Recv != nil { | ||
| continue | ||
| } | ||
| name := n.Name.String() | ||
| switch { | ||
| case isTestMain(n): | ||
| if t.TestMain != nil { | ||
| return errors.New("multiple definitions of TestMain") | ||
| } | ||
| t.TestMain = &testFunc{pkg, name, ""} | ||
| *doImport, *seen = true, true | ||
| case isTest(name, "Test"): | ||
| t.Tests = append(t.Tests, testFunc{pkg, name, ""}) | ||
| *doImport, *seen = true, true | ||
| case isTest(name, "Benchmark"): | ||
| t.Benchmarks = append(t.Benchmarks, testFunc{pkg, name, ""}) | ||
| *doImport, *seen = true, true | ||
| } | ||
| } | ||
| // ex := doc.Examples(f) | ||
| // sort.Sort(byOrder(ex)) | ||
| // for _, e := range ex { | ||
| // *doImport = true // import test file whether executed or not | ||
| // if e.Output == "" && !e.EmptyOutput { | ||
| // // Don't run examples with no output. | ||
| // continue | ||
| // } | ||
| // t.Examples = append(t.Examples, testFunc{pkg, "Example" + e.Name, e.Output}) | ||
| // *seen = true | ||
| // } | ||
|
There was a problem hiding this comment. Is this the code to support examples that's commented out because it's blocked on #381, right? I have a simple request. Either remove the code and just make note of it in the PR (in a comment or so), so we can look it up and add it later after #381 is resolved. Either that, or, if you want to keep it, then please add a comment explaining why this is commented out. E.g.: // This is the code to support examples. It's blocked on https://github.com/gopherjs/gopherjs/issues/381 being resolved.
/*ex := doc.Examples(f)
sort.Sort(byOrder(ex))
for _, e := range ex {
*doImport = true // import test file whether executed or not
if e.Output == "" && !e.EmptyOutput {
// Don't run examples with no output.
continue
}
t.Examples = append(t.Examples, testFunc{pkg, "Example" + e.Name, e.Output})
*seen = true
}*/If you're indifferent, I prefer removing it (just make sure a copy of it is accessible somewhere in this PR for lookup at a later time). |
||
| return nil | ||
| } | ||
|
|
||
| type byOrder []*doc.Example | ||
|
|
||
| func (x byOrder) Len() int { return len(x) } | ||
| func (x byOrder) Swap(i, j int) { x[i], x[j] = x[j], x[i] } | ||
| func (x byOrder) Less(i, j int) bool { return x[i].Order < x[j].Order } | ||
|
|
||
| // isTestMain tells whether fn is a TestMain(m *testing.M) function. | ||
| func isTestMain(fn *ast.FuncDecl) bool { | ||
| if fn.Name.String() != "TestMain" || | ||
| fn.Type.Results != nil && len(fn.Type.Results.List) > 0 || | ||
| fn.Type.Params == nil || | ||
| len(fn.Type.Params.List) != 1 || | ||
| len(fn.Type.Params.List[0].Names) > 1 { | ||
| return false | ||
| } | ||
| ptr, ok := fn.Type.Params.List[0].Type.(*ast.StarExpr) | ||
| if !ok { | ||
| return false | ||
| } | ||
| // We can't easily check that the type is *testing.M | ||
| // because we don't know how testing has been imported, | ||
| // but at least check that it's *M or *something.M. | ||
| if name, ok := ptr.X.(*ast.Ident); ok && name.Name == "M" { | ||
| return true | ||
| } | ||
| if sel, ok := ptr.X.(*ast.SelectorExpr); ok && sel.Sel.Name == "M" { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // isTest tells whether name looks like a test (or benchmark, according to prefix). | ||
| // It is a Test (say) if there is a character after Test that is not a lower-case letter. | ||
| // We don't want TesticularCancer. | ||
| func isTest(name, prefix string) bool { | ||
| if !strings.HasPrefix(name, prefix) { | ||
| return false | ||
| } | ||
| if len(name) == len(prefix) { // "Test" is ok | ||
| return true | ||
| } | ||
| rune, _ := utf8.DecodeRuneInString(name[len(prefix):]) | ||
| return !unicode.IsLower(rune) | ||
| } | ||
|
|
||
| var testmainTmpl = template.Must(template.New("main").Parse(` | ||
| package main | ||
|
|
||
| import ( | ||
| {{if not .TestMain}} | ||
| "os" | ||
| {{end}} | ||
| "regexp" | ||
| "testing" | ||
|
|
||
| {{if .ImportTest}} | ||
| {{if .NeedTest}}_test{{else}}_{{end}} {{.Package.ImportPath | printf "%q"}} | ||
| {{end}} | ||
| {{if .ImportXtest}} | ||
| {{if .NeedXtest}}_xtest{{else}}_{{end}} {{.Package.ImportPath | printf "%s_test" | printf "%q"}} | ||
| {{end}} | ||
| ) | ||
|
|
||
|
|
@@ -832,7 +935,12 @@ func matchString(pat, str string) (result bool, err error) { | |
| } | ||
|
|
||
| func main() { | ||
| m := testing.MainStart(matchString, tests, benchmarks, examples) | ||
| {{with .TestMain}} | ||
| {{.Package}}.{{.Name}}(m) | ||
| {{else}} | ||
| os.Exit(m.Run()) | ||
| {{end}} | ||
| } | ||
|
|
||
| `)) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this.
(I guess it's commented out because of the example code being commented out, right? In any case, it's unclear when examples will work, so this may stay here for a while, and it's not helpful. Better to remove it now and add it when it's needed.)