Skip to content

Commit

Permalink
cmd/vet: parallelize tests
Browse files Browse the repository at this point in the history
Was 2.3 seconds. Now 1.4 seconds.

Next win would be not running a child process and refactoring main so
it could be called from tests easily. But that would also require
rewriting the errchk written in Perl. This appears to be the last user
of errchk in the tree.

Updates #17751

Change-Id: Id7c3cec76f438590789b994e756f55b5397be07f
Reviewed-on: https://go-review.googlesource.com/32754
Run-TryBot: Brad Fitzpatrick <[email protected]>
TryBot-Result: Gobot Gobot <[email protected]>
Reviewed-by: Rob Pike <[email protected]>
  • Loading branch information
bradfitz committed Nov 6, 2016
1 parent 2b445c7 commit e017802
Show file tree
Hide file tree
Showing 15 changed files with 92 additions and 34 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions src/cmd/vet/testdata/testingpkg/tests.go
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package testdata
File renamed without changes.
125 changes: 91 additions & 34 deletions src/cmd/vet/vet_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"os/exec"
"path/filepath"
"runtime"
"sync"
"testing"
)

Expand Down Expand Up @@ -40,19 +41,22 @@ func MustHavePerl(t *testing.T) {
}

var (
built = false // We have built the binary.
failed = false // We have failed to build the binary, don't try again.
buildMu sync.Mutex // guards following
built = false // We have built the binary.
failed = false // We have failed to build the binary, don't try again.
)

func Build(t *testing.T) {
testenv.MustHaveGoBuild(t)
MustHavePerl(t)
buildMu.Lock()
defer buildMu.Unlock()
if built {
return
}
if failed {
t.Skip("cannot run on this environment")
}
testenv.MustHaveGoBuild(t)
MustHavePerl(t)
cmd := exec.Command(testenv.GoToolPath(t), "build", "-o", binary)
output, err := cmd.CombinedOutput()
if err != nil {
Expand Down Expand Up @@ -83,69 +87,122 @@ func Vet(t *testing.T, files []string) {
// rm testvet
//

// TestVet tests self-contained files in testdata/*.go.
//
// If a file contains assembly or has inter-dependencies, it should be
// in its own test, like TestVetAsm, TestDivergentPackagesExamples,
// etc below.
func TestVet(t *testing.T) {
Build(t)
t.Parallel()

// errchk ./testvet
gos, err := filepath.Glob(filepath.Join(dataDir, "*.go"))
if err != nil {
t.Fatal(err)
}
asms, err := filepath.Glob(filepath.Join(dataDir, "*.s"))
if err != nil {
t.Fatal(err)
wide := runtime.GOMAXPROCS(0)
if wide > len(gos) {
wide = len(gos)
}
batch := make([][]string, wide)
for i, file := range gos {
batch[i%wide] = append(batch[i%wide], file)
}
for i, files := range batch {
files := files
t.Run(fmt.Sprint(i), func(t *testing.T) {
t.Parallel()
t.Logf("files: %q", files)
Vet(t, files)
})
}
files := append(gos, asms...)
Vet(t, files)
}

func TestDivergentPackagesExamples(t *testing.T) {
func TestVetAsm(t *testing.T) {
Build(t)

asmDir := filepath.Join(dataDir, "asm")
gos, err := filepath.Glob(filepath.Join(asmDir, "*.go"))
if err != nil {
t.Fatal(err)
}
asms, err := filepath.Glob(filepath.Join(asmDir, "*.s"))
if err != nil {
t.Fatal(err)
}

t.Parallel()
// errchk ./testvet
Vet(t, []string{"testdata/divergent"})
Vet(t, append(gos, asms...))
}

func TestIncompleteExamples(t *testing.T) {
func TestVetDirs(t *testing.T) {
t.Parallel()
Build(t)
// errchk ./testvet
Vet(t, []string{"testdata/incomplete/examples_test.go"})
for _, dir := range []string{
"testingpkg",
"divergent",
"buildtag",
"incomplete", // incomplete examples
} {
dir := dir
t.Run(dir, func(t *testing.T) {
t.Parallel()
gos, err := filepath.Glob(filepath.Join("testdata", dir, "*.go"))
if err != nil {
t.Fatal(err)
}
Vet(t, gos)
})
}
}

func run(c *exec.Cmd, t *testing.T) bool {
output, err := c.CombinedOutput()
os.Stderr.Write(output)
if err != nil {
t.Logf("vet output:\n%s", output)
t.Fatal(err)
}
// Errchk delights by not returning non-zero status if it finds errors, so we look at the output.
// It prints "BUG" if there is a failure.
if !c.ProcessState.Success() {
t.Logf("vet output:\n%s", output)
return false
}
return !bytes.Contains(output, []byte("BUG"))
ok := !bytes.Contains(output, []byte("BUG"))
if !ok {
t.Logf("vet output:\n%s", output)
}
return ok
}

// TestTags verifies that the -tags argument controls which files to check.
func TestTags(t *testing.T) {
t.Parallel()
Build(t)
for _, tag := range []string{"testtag", "x testtag y", "x,testtag,y"} {
t.Logf("-tags=%s", tag)
args := []string{
"-tags=" + tag,
"-v", // We're going to look at the files it examines.
"testdata/tagtest",
}
cmd := exec.Command("./"+binary, args...)
output, err := cmd.CombinedOutput()
if err != nil {
t.Fatal(err)
}
// file1 has testtag and file2 has !testtag.
if !bytes.Contains(output, []byte(filepath.Join("tagtest", "file1.go"))) {
t.Error("file1 was excluded, should be included")
}
if bytes.Contains(output, []byte(filepath.Join("tagtest", "file2.go"))) {
t.Error("file2 was included, should be excluded")
}
tag := tag
t.Run(tag, func(t *testing.T) {
t.Parallel()
t.Logf("-tags=%s", tag)
args := []string{
"-tags=" + tag,
"-v", // We're going to look at the files it examines.
"testdata/tagtest",
}
cmd := exec.Command("./"+binary, args...)
output, err := cmd.CombinedOutput()
if err != nil {
t.Fatal(err)
}
// file1 has testtag and file2 has !testtag.
if !bytes.Contains(output, []byte(filepath.Join("tagtest", "file1.go"))) {
t.Error("file1 was excluded, should be included")
}
if bytes.Contains(output, []byte(filepath.Join("tagtest", "file2.go"))) {
t.Error("file2 was included, should be excluded")
}
})
}
}

0 comments on commit e017802

Please sign in to comment.