e2e: say the timeout is too short instead of panicking eleven minutes in !237
2 files changed, +45 −3
Layout: unified · split
CONTRIBUTING.org +6 −3
| @@ -24,9 +24,12 @@ at [[https://gitbay.org/register][gitbay.org/register]] for a browser. | ||
| 24 | 24 | gitbay repo clone you/gitbay && cd gitbay |
| 25 | 25 | git checkout -b my-change |
| 26 | 26 | #+end_src |
| 27 | 2. Make the change. =go build ./...= and =go test ./...= must be green — | |
| 28 | the e2e suite drives real =git=, =ssh=, =sshd=, and =gpg= binaries and | |
| 29 | takes about two minutes. | |
| 27 | 2. Make the change. =go build ./...= and =make test= must be green. Use | |
| 28 | =make test=, not a bare =go test ./...=: the e2e suite drives real | |
| 29 | =git=, =ssh=, =sshd= and =gpg= binaries and takes six to fifteen | |
| 30 | minutes depending on the machine, which is past =go test='s ten-minute | |
| 31 | default. The bare command panics part way through and names whichever | |
| 32 | test was running, which is not the one at fault. | |
| 30 | 33 | 3. **Sign your commits.** =main= requires verified signatures: register |
| 31 | 34 | your signing key (=gitbay auth pgp add= for OpenPGP, or sign with a |
| 32 | 35 | registered SSH key) and make sure your author email is verified on |
e2e/main_test.go added +39
| @@ -0,0 +1,39 @@ | ||
| 1 | package e2e | |
| 2 | ||
| 3 | import ( | |
| 4 | "flag" | |
| 5 | "fmt" | |
| 6 | "os" | |
| 7 | "testing" | |
| 8 | "time" | |
| 9 | ) | |
| 10 | ||
| 11 | // This suite drives real git, ssh, sshd and gpg, and takes six to fifteen | |
| 12 | // minutes depending on the machine — past `go test`'s ten-minute default. | |
| 13 | // Exceeding it panics with the name of whichever test happened to be | |
| 14 | // running, which is never the one at fault and reads like a hang (#143). | |
| 15 | // | |
| 16 | // make test passes -timeout 30m and .gitbay/ci.yml passes -timeout 20m. | |
| 17 | // A bare `go test ./...` gets the default, so say so up front rather than | |
| 18 | // eleven minutes later. | |
| 19 | const minTimeout = 15 * time.Minute | |
| 20 | ||
| 21 | func TestMain(m *testing.M) { | |
| 22 | flag.Parse() | |
| 23 | // Only for a whole-package run: `-run TestOneThing -timeout 2m` is a | |
| 24 | // reasonable thing to type and none of this applies to it. | |
| 25 | if run := flag.Lookup("test.run"); run == nil || run.Value.String() == "" { | |
| 26 | if f := flag.Lookup("test.timeout"); f != nil { | |
| 27 | d, err := time.ParseDuration(f.Value.String()) | |
| 28 | if err == nil && d > 0 && d < minTimeout { | |
| 29 | fmt.Fprintf(os.Stderr, | |
| 30 | "e2e: -timeout is %s; this suite needs about %s.\n"+ | |
| 31 | "Run `make test` (which passes -timeout 30m), or pass -timeout yourself.\n"+ | |
| 32 | "Without this check the run panics part way through and blames whichever\n"+ | |
| 33 | "test was executing at the deadline.\n", d, minTimeout) | |
| 34 | os.Exit(1) | |
| 35 | } | |
| 36 | } | |
| 37 | } | |
| 38 | os.Exit(m.Run()) | |
| 39 | } | |