Add support for TestMain function in test mode #380

flimzy · 2016-01-19T19:52:11Z

This adds support for the TestMain function in test mode, described here, and requested in issue #239. Naturally, I took inspiration from the relevant official go source.

I have tested it to the extent I know to. It's possible I may have missed some functionality. Any other suggestions or feedback is welcome.

neelance · 2016-01-19T20:01:53Z

LGTM. Thanks for the contribution!
@shurcooL PTAL

dmitshur · 2016-01-21T10:18:57Z

For reference, this is the commit that added this feature to Go: golang/go@182d131.

So far, the changes in this PR look good, but I see a few things missing from that commit.

dmitshur · 2016-01-21T10:21:37Z

tool.go

@@ -319,11 +319,13 @@ func main() {
 					}

 					for _, decl := range testPkg.Archive.Declarations {
-						if strings.HasPrefix(decl.FullName, testPkg.ImportPath+".Test") {
+						switch {
+						case decl.FullName == testPkg.ImportPath+".TestMain":


This only checks that the func name matches "TestMain", but doesn't check that the func signature takes m *testing.M parameters and has no return variables, does it?

That potentially means that some Go package that has a func TestMain(t *testing.T) will get interpreted differently by go and gopherjs, if I understand this correctly.

Confirmed, if the signature is func TestMain(t *testing.T) then the go tool treats it like a normal test:

31 $ go test -v === RUN TestMain --- PASS: TestMain (0.00s) === RUN Test1 --- PASS: Test1 (0.00s) PASS ok github.com/shurcooL/play/31 0.022s

dmitshur · 2016-01-21T10:27:53Z

I think if you add those 2 pieces of missing functionality I mentioned in inline comments above, this should be good to merge.

A test would be helpful too, if possible. Thank you!

flimzy · 2016-01-21T19:14:37Z

Thanks, @shurcooL, for your critique. My original work included the extra error message, but somehow I missed that in my final cut. I've added it back in.

The other issue will be more involved, as the GopherJS implementation differs significantly from the Go implementation at this point. Let me see what I can come up with.

dmitshur · 2016-01-21T19:38:46Z

Thanks.

I've looked a little into it, and I saw that the original Go code works with the Go AST, while here in GopherJS you're ranging over testPkg.Archive.Declarations, which has type Decl.

Unfortunately, it's not documented, so it's hard to tell, but I hope/suspect you can find the func signature in the Vars field.

Finally, if you don't mind, please do the additional changes in separate commits, and squash at the end when we're ready to merge. That makes the PR easier to review as it changes.

flimzy · 2016-01-23T13:15:44Z

My latest commit probably needs some work. It is in some ways a blind copy-and-paste of the relevant bits of logic from Go into GopherJS, adapting them where necessary.

This means that we now run parser.ParseFile() on test files a second time, but it appears this is the way Go does it, too--and perhaps there's a reason for this (beyond simply being easier to write) that would be revealed with further investigation.

Also, Go builds 'test' as a separate executable, which lends itself to a clean separation from the other go commands. GopherJS is more monolythic, meaning that adding this functionality into tool.go might be considered more clutter. A simple step toward clarity might be just to create a test.go, but within the same main package. I think @neelance has hinted at some long-term plans to potentially refactor parts of tool.go, so I don't know how this might fit into that larger picture.

This also gets us much closer to supporting Examples, which depends on an *ast.File argument to doc.Examples to extract the expected output for each example function. This commit doesn't yet make Examples fully functional, though (so I have some of that commented out), but I don't think it will be terribly hard to get it working (which I'll work on next).

But this seemed like a good place to solicit feedback.

neelance · 2016-03-31T22:21:14Z

What's the status of this PR?

flimzy · 2016-04-02T13:55:45Z

I have not been following closely all the work happening with GopherJS lately, in particular the long-term plans to be more compatible with upstream tools, so I don't know if this PR is, or will be, obsoleted by some of that work.

If the approach I took in this PR is appropriate, I would be happy to try to resolve the conflicts and get it back into a mergable state.

dmitshur · 2016-04-02T16:51:55Z

I think I went a little trigger-happy with that label. It applies to issues only, and this is a PR. I'll remove it.

It's true this issue will become resolved once we move to using a modified version of cmd/go, but the timeline for that is unclear and it may not happen very soon. There's still value in resolving this. But it's good to be aware of which issues are relevant to the build tool and not the compiler.

bep · 2016-05-10T23:10:27Z

This PR would be really useful.

flimzy · 2016-05-11T09:36:26Z

My personal hacking time has been limited lately, but I'll try to get to this again soon, and bring the PR up to date.

If someone else wants to get to it before I do, please feel free.

Specifically, we now borrow Go's testFuncs.load(), isTestMain, and isTest functions, instead of relying on our own, less robust, implementation. In terms of functionality, this means that we: - We require the first character after the 'Test' prefix to be capital. e.g. don't treat TesticularCancer() as a test. - We don't treat TestMain(t *testing.T) as TestMain(m *testing.M) - We should be able to support Examples as well (issue gopherjs#239) with minimal effort

flimzy · 2016-05-15T10:53:35Z

This PR is now up to date, and as far as I know, ready to merge. Both of @shurcooL's issues have been addressed: Proper function signature checking on TestMain(), and the TestMain-related error message 'multiple definitions of TestMain' takes priority over the standard 'TestMain redeclared in this block' message.

I welcome any further feedback or suggestions.

dmitshur · 2016-06-05T22:10:41Z

tool.go

@@ -18,11 +20,14 @@ import (
 	"path"
 	"path/filepath"
 	"runtime"
+	// 	"sort"


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.)

dmitshur · 2016-06-05T22:20:29Z

Thank you for working on this and your patience @flimzy.

I've left 2 minor comments, but if this works, I see no reason not merge this. It has LGTM from @neelance, and even though there have been changes since then, as long as it works, we can merge.

Sorry for letting this drag on for longer than it should've; I've been focusing on other work and did not have enough time to spend on this.

dmitshur · 2016-06-05T22:35:24Z

Tested locally, gopherjs test still works and TestMain is working. Merging. I'll apply the 2 comments I left above myself. Edit: Applied in a3087f6.

Thanks a lot again! :)

Followup to #380.

flimzy · 2016-06-06T05:32:35Z

Thanks for merging!

dmitshur reviewed Jan 21, 2016
View reviewed changes

flimzy force-pushed the testmain branch from cb59054 to 0a0228b Compare January 21, 2016 19:02

flimzy force-pushed the testmain branch 2 times, most recently from 4641452 to d77d525 Compare January 23, 2016 13:00

flimzy mentioned this pull request Jan 24, 2016

defer + go routine/channel + blocking = possible crash #381

Closed

dmitshur added the gopherjs-tool Related to the gopherjs tool or its build system (but not the compiler itself). label Apr 1, 2016

dmitshur removed the gopherjs-tool Related to the gopherjs tool or its build system (but not the compiler itself). label Apr 2, 2016

flimzy added 4 commits May 15, 2016 12:15

Add support for TestMain function in test mode

a465044

Ignore archive return value from BuildPackage for tests

15d38c0

Re-order logic to give TestMain-specific error messages precedence

6c270ae

flimzy force-pushed the testmain branch from d77d525 to 6c270ae Compare May 15, 2016 10:41

dmitshur reviewed Jun 5, 2016
View reviewed changes

dmitshur merged commit dbe4e14 into gopherjs:master Jun 5, 2016

dmitshur added a commit that referenced this pull request Jun 5, 2016

Remove commented out code.

a3087f6

Followup to #380.

flimzy deleted the testmain branch June 6, 2016 05:32

flimzy mentioned this pull request Sep 29, 2016

Add support for executing examples #528

Merged

Add support for TestMain function in test mode #380

Add support for TestMain function in test mode #380

Uh oh!

Conversation

flimzy commented Jan 19, 2016

Uh oh!

neelance commented Jan 19, 2016

Uh oh!

dmitshur commented Jan 21, 2016

Uh oh!

dmitshur Jan 21, 2016

Choose a reason for hiding this comment

Uh oh!

dmitshur Jan 21, 2016

Choose a reason for hiding this comment

Uh oh!

dmitshur commented Jan 21, 2016

Uh oh!

flimzy commented Jan 21, 2016

Uh oh!

dmitshur commented Jan 21, 2016

Uh oh!

flimzy commented Jan 23, 2016

Uh oh!

neelance commented Mar 31, 2016

Uh oh!

flimzy commented Apr 2, 2016

Uh oh!

dmitshur commented Apr 2, 2016

Uh oh!

bep commented May 10, 2016

Uh oh!

flimzy commented May 11, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flimzy commented May 15, 2016

Uh oh!

dmitshur Jun 5, 2016

Choose a reason for hiding this comment

Uh oh!

dmitshur commented Jun 5, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitshur commented Jun 5, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flimzy commented Jun 6, 2016

Uh oh!

Uh oh!

flimzy commented May 11, 2016 •

edited

Loading

dmitshur commented Jun 5, 2016 •

edited

Loading

dmitshur commented Jun 5, 2016 •

edited

Loading