visor/test/runtimes/proctor/lib/go.go

// Copyright 2019 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package lib

import (
	"fmt"
	"os"
	"os/exec"
	"regexp"
	"strings"
)

var (
	goTestRegEx = regexp.MustCompile(`^.+\.go$`)

	// Directories with .dir contain helper files for tests.
	// Exclude benchmarks and stress tests.
	goDirFilter = regexp.MustCompile(`^(bench|stress)\/.+$|^.+\.dir.+$`)
)

// Location of Go tests on disk.
const goTestDir = "/usr/local/go/test"

// goRunner implements TestRunner for Go.
//
// There are two types of Go tests: "Go tool tests" and "Go tests on disk".
// "Go tool tests" are found and executed using `go tool dist test`. "Go tests
// on disk" are found in the /usr/local/go/test directory and are executed
// using `go run run.go`.
type goRunner struct{}

var _ TestRunner = goRunner{}

// ListTests implements TestRunner.ListTests.
func (goRunner) ListTests() ([]string, error) {
	// Go tool dist test tests.
	args := []string{"run", "cmd/dist", "test", "-list"}
	cmd := exec.Command("go", args...)
	cmd.Stderr = os.Stderr
	out, err := cmd.Output()
	if err != nil {
		return nil, fmt.Errorf("failed to list: %v", err)
	}
	var toolSlice []string
	toolSlice = append(toolSlice, strings.Split(string(out), "\n")...)

	// Go tests on disk.
	diskSlice, err := Search(goTestDir, goTestRegEx)
	if err != nil {
		return nil, err
	}
	// Remove items from /bench/, /stress/ and .dir files
	diskFiltered := diskSlice[:0]
	for _, file := range diskSlice {
		if !goDirFilter.MatchString(file) {
			diskFiltered = append(diskFiltered, file)
		}
	}

	return append(toolSlice, diskFiltered...), nil
}

// TestCmds implements TestRunner.TestCmds.
func (goRunner) TestCmds(tests []string) []*exec.Cmd {
	var toolTests, onDiskTests []string
	for _, test := range tests {
		if strings.HasSuffix(test, ".go") {
			onDiskTests = append(onDiskTests, test)
		} else {
			toolTests = append(toolTests, "^"+test+"$")
		}
	}

	var cmds []*exec.Cmd
	if len(toolTests) > 0 {
		cmd := exec.Command("go", "run", "cmd/dist", "test", "-v", "-no-rebuild", "-run", strings.Join(toolTests, "|"))
		// Bump up timeout. Some go tool tests take more than 3 minutes to run.
		// golang/go/src/cmd/dist/test.go:registerStdTest() sets default timeout to
		// 3 minutes which can only be increased via GO_TEST_TIMEOUT_SCALE.
		cmd.Env = append(cmd.Environ(), "GO_TEST_TIMEOUT_SCALE=2")
		cmds = append(cmds, cmd)
	}
	if len(onDiskTests) > 0 {
		cmd := exec.Command("go", []string{"test", "cmd/internal/testdir", fmt.Sprintf("-run='Test/(%s)'", strings.Join(onDiskTests, "|"))}...)
		cmds = append(cmds, cmd)
	}

	return cmds
}