blob: 8d68591982a5032df664e81450011b808cbf0ee8 [file] [log] [blame]
// Copyright 2012 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package testdir_test runs tests in the GOROOT/test directory.
package testdir_test
import (
"bytes"
"encoding/json"
"errors"
"flag"
"fmt"
"go/build"
"go/build/constraint"
"hash/fnv"
"internal/testenv"
"io"
"io/fs"
"log"
"os"
"os/exec"
"path"
"path/filepath"
"regexp"
"runtime"
"slices"
"sort"
"strconv"
"strings"
"sync"
"testing"
"time"
"unicode"
)
var (
allCodegen = flag.Bool("all_codegen", defaultAllCodeGen(), "run all goos/goarch for codegen")
runSkips = flag.Bool("run_skips", false, "run skipped tests (ignore skip and build tags)")
linkshared = flag.Bool("linkshared", false, "")
updateErrors = flag.Bool("update_errors", false, "update error messages in test file based on compiler output")
runoutputLimit = flag.Int("l", defaultRunOutputLimit(), "number of parallel runoutput tests to run")
force = flag.Bool("f", false, "ignore expected-failure test lists")
target = flag.String("target", "", "cross-compile tests for `goos/goarch`")
shard = flag.Int("shard", 0, "shard index to run. Only applicable if -shards is non-zero.")
shards = flag.Int("shards", 0, "number of shards. If 0, all tests are run. This is used by the continuous build.")
)
// defaultAllCodeGen returns the default value of the -all_codegen
// flag. By default, we prefer to be fast (returning false), except on
// the linux-amd64 builder that's already very fast, so we get more
// test coverage on trybots. See https://go.dev/issue/34297.
func defaultAllCodeGen() bool {
return os.Getenv("GO_BUILDER_NAME") == "linux-amd64"
}
var (
// Package-scoped variables that are initialized at the start of Test.
goTool string
goos string // Target GOOS
goarch string // Target GOARCH
cgoEnabled bool
goExperiment string
goDebug string
// dirs are the directories to look for *.go files in.
// TODO(bradfitz): just use all directories?
dirs = []string{".", "ken", "chan", "interface", "syntax", "dwarf", "fixedbugs", "codegen", "runtime", "abi", "typeparam", "typeparam/mdempsky", "arenas"}
)
// Test is the main entrypoint that runs tests in the GOROOT/test directory.
//
// Each .go file test case in GOROOT/test is registered as a subtest with a
// a full name like "Test/fixedbugs/bug000.go" ('/'-separated relative path).
func Test(t *testing.T) {
if *target != "" {
// When -target is set, propagate it to GOOS/GOARCH in our environment
// so that all commands run with the target GOOS/GOARCH.
//
// We do this before even calling "go env", because GOOS/GOARCH can
// affect other settings we get from go env (notably CGO_ENABLED).
goos, goarch, ok := strings.Cut(*target, "/")
if !ok {
t.Fatalf("bad -target flag %q, expected goos/goarch", *target)
}
t.Setenv("GOOS", goos)
t.Setenv("GOARCH", goarch)
}
goTool = testenv.GoToolPath(t)
cmd := exec.Command(goTool, "env", "-json")
stdout, err := cmd.StdoutPipe()
if err != nil {
t.Fatal("StdoutPipe:", err)
}
if err := cmd.Start(); err != nil {
t.Fatal("Start:", err)
}
var env struct {
GOOS string
GOARCH string
GOEXPERIMENT string
GODEBUG string
CGO_ENABLED string
}
if err := json.NewDecoder(stdout).Decode(&env); err != nil {
t.Fatal("Decode:", err)
}
if err := cmd.Wait(); err != nil {
t.Fatal("Wait:", err)
}
goos = env.GOOS
goarch = env.GOARCH
cgoEnabled, _ = strconv.ParseBool(env.CGO_ENABLED)
goExperiment = env.GOEXPERIMENT
goDebug = env.GODEBUG
common := testCommon{
gorootTestDir: filepath.Join(testenv.GOROOT(t), "test"),
runoutputGate: make(chan bool, *runoutputLimit),
}
// cmd/distpack deletes GOROOT/test, so skip the test if it isn't present.
// cmd/distpack also requires GOROOT/VERSION to exist, so use that to
// suppress false-positive skips.
if _, err := os.Stat(common.gorootTestDir); os.IsNotExist(err) {
if _, err := os.Stat(filepath.Join(testenv.GOROOT(t), "VERSION")); err == nil {
t.Skipf("skipping: GOROOT/test not present")
}
}
for _, dir := range dirs {
for _, goFile := range goFiles(t, dir) {
test := test{testCommon: common, dir: dir, goFile: goFile}
t.Run(path.Join(dir, goFile), func(t *testing.T) {
t.Parallel()
test.T = t
testError := test.run()
wantError := test.expectFail() && !*force
if testError != nil {
if wantError {
t.Log(testError.Error() + " (expected)")
} else {
t.Fatal(testError)
}
} else if wantError {
t.Fatal("unexpected success")
}
})
}
}
}
func shardMatch(name string) bool {
if *shards <= 1 {
return true
}
h := fnv.New32()
io.WriteString(h, name)
return int(h.Sum32()%uint32(*shards)) == *shard
}
func goFiles(t *testing.T, dir string) []string {
f, err := os.Open(filepath.Join(testenv.GOROOT(t), "test", dir))
if err != nil {
t.Fatal(err)
}
dirnames, err := f.Readdirnames(-1)
f.Close()
if err != nil {
t.Fatal(err)
}
names := []string{}
for _, name := range dirnames {
if !strings.HasPrefix(name, ".") && strings.HasSuffix(name, ".go") && shardMatch(name) {
names = append(names, name)
}
}
sort.Strings(names)
return names
}
type runCmd func(...string) ([]byte, error)
func compileFile(runcmd runCmd, longname string, flags []string) (out []byte, err error) {
cmd := []string{goTool, "tool", "compile", "-e", "-p=p", "-importcfg=" + stdlibImportcfgFile()}
cmd = append(cmd, flags...)
if *linkshared {
cmd = append(cmd, "-dynlink", "-installsuffix=dynlink")
}
cmd = append(cmd, longname)
return runcmd(cmd...)
}
func compileInDir(runcmd runCmd, dir string, flags []string, importcfg string, pkgname string, names ...string) (out []byte, err error) {
if importcfg == "" {
importcfg = stdlibImportcfgFile()
}
cmd := []string{goTool, "tool", "compile", "-e", "-D", "test", "-importcfg=" + importcfg}
if pkgname == "main" {
cmd = append(cmd, "-p=main")
} else {
pkgname = path.Join("test", strings.TrimSuffix(names[0], ".go"))
cmd = append(cmd, "-o", pkgname+".a", "-p", pkgname)
}
cmd = append(cmd, flags...)
if *linkshared {
cmd = append(cmd, "-dynlink", "-installsuffix=dynlink")
}
for _, name := range names {
cmd = append(cmd, filepath.Join(dir, name))
}
return runcmd(cmd...)
}
var stdlibImportcfgStringOnce sync.Once // TODO(#56102): Use sync.OnceValue once available. Also below.
var stdlibImportcfgString string
func stdlibImportcfg() string {
stdlibImportcfgStringOnce.Do(func() {
output, err := exec.Command(goTool, "list", "-export", "-f", "{{if .Export}}packagefile {{.ImportPath}}={{.Export}}{{end}}", "std").Output()
if err != nil {
log.Fatal(err)
}
stdlibImportcfgString = string(output)
})
return stdlibImportcfgString
}
var stdlibImportcfgFilenameOnce sync.Once
var stdlibImportcfgFilename string
func stdlibImportcfgFile() string {
stdlibImportcfgFilenameOnce.Do(func() {
tmpdir, err := os.MkdirTemp("", "importcfg")
if err != nil {
log.Fatal(err)
}
filename := filepath.Join(tmpdir, "importcfg")
err = os.WriteFile(filename, []byte(stdlibImportcfg()), 0644)
if err != nil {
log.Fatal(err)
}
stdlibImportcfgFilename = filename
})
return stdlibImportcfgFilename
}
func linkFile(runcmd runCmd, goname string, importcfg string, ldflags []string) (err error) {
if importcfg == "" {
importcfg = stdlibImportcfgFile()
}
pfile := strings.Replace(goname, ".go", ".o", -1)
cmd := []string{goTool, "tool", "link", "-w", "-o", "a.exe", "-importcfg=" + importcfg}
if *linkshared {
cmd = append(cmd, "-linkshared", "-installsuffix=dynlink")
}
if ldflags != nil {
cmd = append(cmd, ldflags...)
}
cmd = append(cmd, pfile)
_, err = runcmd(cmd...)
return
}
type testCommon struct {
// gorootTestDir is the GOROOT/test directory path.
gorootTestDir string
// runoutputGate controls the max number of runoutput tests
// executed in parallel as they can each consume a lot of memory.
runoutputGate chan bool
}
// test is a single test case in the GOROOT/test directory.
type test struct {
testCommon
*testing.T
// dir and goFile identify the test case.
// For example, "fixedbugs", "bug000.go".
dir, goFile string
}
// expectFail reports whether the (overall) test recipe is
// expected to fail under the current build+test configuration.
func (t test) expectFail() bool {
failureSets := []map[string]bool{types2Failures}
// Note: gccgo supports more 32-bit architectures than this, but
// hopefully the 32-bit failures are fixed before this matters.
switch goarch {
case "386", "arm", "mips", "mipsle":
failureSets = append(failureSets, types2Failures32Bit)
}
testName := path.Join(t.dir, t.goFile) // Test name is '/'-separated.
for _, set := range failureSets {
if set[testName] {
return true
}
}
return false
}
func (t test) goFileName() string {
return filepath.Join(t.dir, t.goFile)
}
func (t test) goDirName() string {
return filepath.Join(t.dir, strings.Replace(t.goFile, ".go", ".dir", -1))
}
// goDirFiles returns .go files in dir.
func goDirFiles(dir string) (filter []fs.DirEntry, _ error) {
files, err := os.ReadDir(dir)
if err != nil {
return nil, err
}
for _, goFile := range files {
if filepath.Ext(goFile.Name()) == ".go" {
filter = append(filter, goFile)
}
}
return filter, nil
}
var packageRE = regexp.MustCompile(`(?m)^package ([\p{Lu}\p{Ll}\w]+)`)
func getPackageNameFromSource(fn string) (string, error) {
data, err := os.ReadFile(fn)
if err != nil {
return "", err
}
pkgname := packageRE.FindStringSubmatch(string(data))
if pkgname == nil {
return "", fmt.Errorf("cannot find package name in %s", fn)
}
return pkgname[1], nil
}
// goDirPkg represents a Go package in some directory.
type goDirPkg struct {
name string
files []string
}
// goDirPackages returns distinct Go packages in dir.
// If singlefilepkgs is set, each file is considered a separate package
// even if the package names are the same.
func goDirPackages(t *testing.T, dir string, singlefilepkgs bool) []*goDirPkg {
files, err := goDirFiles(dir)
if err != nil {
t.Fatal(err)
}
var pkgs []*goDirPkg
m := make(map[string]*goDirPkg)
for _, file := range files {
name := file.Name()
pkgname, err := getPackageNameFromSource(filepath.Join(dir, name))
if err != nil {
t.Fatal(err)
}
p, ok := m[pkgname]
if singlefilepkgs || !ok {
p = &goDirPkg{name: pkgname}
pkgs = append(pkgs, p)
m[pkgname] = p
}
p.files = append(p.files, name)
}
return pkgs
}
type context struct {
GOOS string
GOARCH string
cgoEnabled bool
noOptEnv bool
}
// shouldTest looks for build tags in a source file and returns
// whether the file should be used according to the tags.
func shouldTest(src string, goos, goarch string) (ok bool, whyNot string) {
if *runSkips {
return true, ""
}
for _, line := range strings.Split(src, "\n") {
if strings.HasPrefix(line, "package ") {
break
}
if expr, err := constraint.Parse(line); err == nil {
gcFlags := os.Getenv("GO_GCFLAGS")
ctxt := &context{
GOOS: goos,
GOARCH: goarch,
cgoEnabled: cgoEnabled,
noOptEnv: strings.Contains(gcFlags, "-N") || strings.Contains(gcFlags, "-l"),
}
if !expr.Eval(ctxt.match) {
return false, line
}
}
}
return true, ""
}
func (ctxt *context) match(name string) bool {
if name == "" {
return false
}
// Tags must be letters, digits, underscores or dots.
// Unlike in Go identifiers, all digits are fine (e.g., "386").
for _, c := range name {
if !unicode.IsLetter(c) && !unicode.IsDigit(c) && c != '_' && c != '.' {
return false
}
}
if slices.Contains(build.Default.ReleaseTags, name) {
return true
}
if strings.HasPrefix(name, "goexperiment.") {
return slices.Contains(build.Default.ToolTags, name)
}
if name == "cgo" && ctxt.cgoEnabled {
return true
}
if name == ctxt.GOOS || name == ctxt.GOARCH || name == "gc" {
return true
}
if ctxt.noOptEnv && name == "gcflags_noopt" {
return true
}
if name == "test_run" {
return true
}
return false
}
// goGcflags returns the -gcflags argument to use with go build / go run.
// This must match the flags used for building the standard library,
// or else the commands will rebuild any needed packages (like runtime)
// over and over.
func (test) goGcflags() string {
return "-gcflags=all=" + os.Getenv("GO_GCFLAGS")
}
func (test) goGcflagsIsEmpty() bool {
return "" == os.Getenv("GO_GCFLAGS")
}
var errTimeout = errors.New("command exceeded time limit")
// run runs the test case.
//
// When there is a problem, run uses t.Fatal to signify that it's an unskippable
// infrastructure error (such as failing to read an input file or the test recipe
// being malformed), or it returns a non-nil error to signify a test case error.
//
// t.Error isn't used here to give the caller the opportunity to decide whether
// the test case failing is expected before promoting it to a real test failure.
// See expectFail and -f flag.
func (t test) run() error {
srcBytes, err := os.ReadFile(filepath.Join(t.gorootTestDir, t.goFileName()))
if err != nil {
t.Fatal("reading test case .go file:", err)
} else if bytes.HasPrefix(srcBytes, []byte{'\n'}) {
t.Fatal(".go file source starts with a newline")
}
src := string(srcBytes)
// Execution recipe is contained in a comment in
// the first non-empty line that is not a build constraint.
var action string
for actionSrc := src; action == "" && actionSrc != ""; {
var line string
line, actionSrc, _ = strings.Cut(actionSrc, "\n")
if constraint.IsGoBuild(line) || constraint.IsPlusBuild(line) {
continue
}
action = strings.TrimSpace(strings.TrimPrefix(line, "//"))
}
if action == "" {
t.Fatalf("execution recipe not found in GOROOT/test/%s", t.goFileName())
}
// Check for build constraints only up to the actual code.
header, _, ok := strings.Cut(src, "\npackage")
if !ok {
header = action // some files are intentionally malformed
}
if ok, why := shouldTest(header, goos, goarch); !ok {
t.Skip(why)
}
var args, flags, runenv []string
var tim int
wantError := false
wantAuto := false
singlefilepkgs := false
f, err := splitQuoted(action)
if err != nil {
t.Fatal("invalid test recipe:", err)
}
if len(f) > 0 {
action = f[0]
args = f[1:]
}
// TODO: Clean up/simplify this switch statement.
switch action {
case "compile", "compiledir", "build", "builddir", "buildrundir", "run", "buildrun", "runoutput", "rundir", "runindir", "asmcheck":
// nothing to do
case "errorcheckandrundir":
wantError = false // should be no error if also will run
case "errorcheckwithauto":
action = "errorcheck"
wantAuto = true
wantError = true
case "errorcheck", "errorcheckdir", "errorcheckoutput":
wantError = true
case "skip":
if *runSkips {
break
}
t.Skip("skip")
default:
t.Fatalf("unknown pattern: %q", action)
}
goexp := goExperiment
godebug := goDebug
// collect flags
for len(args) > 0 && strings.HasPrefix(args[0], "-") {
switch args[0] {
case "-1":
wantError = true
case "-0":
wantError = false
case "-s":
singlefilepkgs = true
case "-t": // timeout in seconds
args = args[1:]
var err error
tim, err = strconv.Atoi(args[0])
if err != nil {
t.Fatalf("need number of seconds for -t timeout, got %s instead", args[0])
}
if s := os.Getenv("GO_TEST_TIMEOUT_SCALE"); s != "" {
timeoutScale, err := strconv.Atoi(s)
if err != nil {
t.Fatalf("failed to parse $GO_TEST_TIMEOUT_SCALE = %q as integer: %v", s, err)
}
tim *= timeoutScale
}
case "-goexperiment": // set GOEXPERIMENT environment
args = args[1:]
if goexp != "" {
goexp += ","
}
goexp += args[0]
runenv = append(runenv, "GOEXPERIMENT="+goexp)
case "-godebug": // set GODEBUG environment
args = args[1:]
if godebug != "" {
godebug += ","
}
godebug += args[0]
runenv = append(runenv, "GODEBUG="+godebug)
default:
flags = append(flags, args[0])
}
args = args[1:]
}
if action == "errorcheck" {
found := false
for i, f := range flags {
if strings.HasPrefix(f, "-d=") {
flags[i] = f + ",ssa/check/on"
found = true
break
}
}
if !found {
flags = append(flags, "-d=ssa/check/on")
}
}
tempDir := t.TempDir()
err = os.Mkdir(filepath.Join(tempDir, "test"), 0755)
if err != nil {
t.Fatal(err)
}
err = os.WriteFile(filepath.Join(tempDir, t.goFile), srcBytes, 0644)
if err != nil {
t.Fatal(err)
}
var (
runInDir = tempDir
tempDirIsGOPATH = false
)
runcmd := func(args ...string) ([]byte, error) {
cmd := exec.Command(args[0], args[1:]...)
var buf bytes.Buffer
cmd.Stdout = &buf
cmd.Stderr = &buf
cmd.Env = append(os.Environ(), "GOENV=off", "GOFLAGS=")
if runInDir != "" {
cmd.Dir = runInDir
// Set PWD to match Dir to speed up os.Getwd in the child process.
cmd.Env = append(cmd.Env, "PWD="+cmd.Dir)
} else {
// Default to running in the GOROOT/test directory.
cmd.Dir = t.gorootTestDir
// Set PWD to match Dir to speed up os.Getwd in the child process.
cmd.Env = append(cmd.Env, "PWD="+cmd.Dir)
}
if tempDirIsGOPATH {
cmd.Env = append(cmd.Env, "GOPATH="+tempDir)
}
cmd.Env = append(cmd.Env, "STDLIB_IMPORTCFG="+stdlibImportcfgFile())
cmd.Env = append(cmd.Env, runenv...)
var err error
if tim != 0 {
err = cmd.Start()
// This command-timeout code adapted from cmd/go/test.go
// Note: the Go command uses a more sophisticated timeout
// strategy, first sending SIGQUIT (if appropriate for the
// OS in question) to try to trigger a stack trace, then
// finally much later SIGKILL. If timeouts prove to be a
// common problem here, it would be worth porting over
// that code as well. See https://do.dev/issue/50973
// for more discussion.
if err == nil {
tick := time.NewTimer(time.Duration(tim) * time.Second)
done := make(chan error)
go func() {
done <- cmd.Wait()
}()
select {
case err = <-done:
// ok
case <-tick.C:
cmd.Process.Signal(os.Interrupt)
time.Sleep(1 * time.Second)
cmd.Process.Kill()
<-done
err = errTimeout
}
tick.Stop()
}
} else {
err = cmd.Run()
}
if err != nil && err != errTimeout {
err = fmt.Errorf("%s\n%s", err, buf.Bytes())
}
return buf.Bytes(), err
}
importcfg := func(pkgs []*goDirPkg) string {
cfg := stdlibImportcfg()
for _, pkg := range pkgs {
pkgpath := path.Join("test", strings.TrimSuffix(pkg.files[0], ".go"))
cfg += "\npackagefile " + pkgpath + "=" + filepath.Join(tempDir, pkgpath+".a")
}
filename := filepath.Join(tempDir, "importcfg")
err := os.WriteFile(filename, []byte(cfg), 0644)
if err != nil {
t.Fatal(err)
}
return filename
}
long := filepath.Join(t.gorootTestDir, t.goFileName())
switch action {
default:
t.Fatalf("unimplemented action %q", action)
panic("unreachable")
case "asmcheck":
// Compile Go file and match the generated assembly
// against a set of regexps in comments.
ops := t.wantedAsmOpcodes(long)
self := runtime.GOOS + "/" + runtime.GOARCH
for _, env := range ops.Envs() {
// Only run checks relevant to the current GOOS/GOARCH,
// to avoid triggering a cross-compile of the runtime.
if string(env) != self && !strings.HasPrefix(string(env), self+"/") && !*allCodegen {
continue
}
// -S=2 forces outermost line numbers when disassembling inlined code.
cmdline := []string{"build", "-gcflags", "-S=2"}
// Append flags, but don't override -gcflags=-S=2; add to it instead.
for i := 0; i < len(flags); i++ {
flag := flags[i]
switch {
case strings.HasPrefix(flag, "-gcflags="):
cmdline[2] += " " + strings.TrimPrefix(flag, "-gcflags=")
case strings.HasPrefix(flag, "--gcflags="):
cmdline[2] += " " + strings.TrimPrefix(flag, "--gcflags=")
case flag == "-gcflags", flag == "--gcflags":
i++
if i < len(flags) {
cmdline[2] += " " + flags[i]
}
default:
cmdline = append(cmdline, flag)
}
}
cmdline = append(cmdline, long)
cmd := exec.Command(goTool, cmdline...)
cmd.Env = append(os.Environ(), env.Environ()...)
if len(flags) > 0 && flags[0] == "-race" {
cmd.Env = append(cmd.Env, "CGO_ENABLED=1")
}
var buf bytes.Buffer
cmd.Stdout, cmd.Stderr = &buf, &buf
if err := cmd.Run(); err != nil {
t.Log(env, "\n", cmd.Stderr)
return err
}
err := t.asmCheck(buf.String(), long, env, ops[env])
if err != nil {
return err
}
}
return nil
case "errorcheck":
// Compile Go file.
// Fail if wantError is true and compilation was successful and vice versa.
// Match errors produced by gc against errors in comments.
// TODO(gri) remove need for -C (disable printing of columns in error messages)
cmdline := []string{goTool, "tool", "compile", "-p=p", "-d=panic", "-C", "-e", "-importcfg=" + stdlibImportcfgFile(), "-o", "a.o"}
// No need to add -dynlink even if linkshared if we're just checking for errors...
cmdline = append(cmdline, flags...)
cmdline = append(cmdline, long)
out, err := runcmd(cmdline...)
if wantError {
if err == nil {
return fmt.Errorf("compilation succeeded unexpectedly\n%s", out)
}
if err == errTimeout {
return fmt.Errorf("compilation timed out")
}
} else {
if err != nil {
return err
}
}
if *updateErrors {
t.updateErrors(string(out), long)
}
return t.errorCheck(string(out), wantAuto, long, t.goFile)
case "compile":
// Compile Go file.
_, err := compileFile(runcmd, long, flags)
return err
case "compiledir":
// Compile all files in the directory as packages in lexicographic order.
longdir := filepath.Join(t.gorootTestDir, t.goDirName())
pkgs := goDirPackages(t.T, longdir, singlefilepkgs)
importcfgfile := importcfg(pkgs)
for _, pkg := range pkgs {
_, err := compileInDir(runcmd, longdir, flags, importcfgfile, pkg.name, pkg.files...)
if err != nil {
return err
}
}
return nil
case "errorcheckdir", "errorcheckandrundir":
flags = append(flags, "-d=panic")
// Compile and errorCheck all files in the directory as packages in lexicographic order.
// If errorcheckdir and wantError, compilation of the last package must fail.
// If errorcheckandrundir and wantError, compilation of the package prior the last must fail.
longdir := filepath.Join(t.gorootTestDir, t.goDirName())
pkgs := goDirPackages(t.T, longdir, singlefilepkgs)
errPkg := len(pkgs) - 1
if wantError && action == "errorcheckandrundir" {
// The last pkg should compiled successfully and will be run in next case.
// Preceding pkg must return an error from compileInDir.
errPkg--
}
importcfgfile := importcfg(pkgs)
for i, pkg := range pkgs {
out, err := compileInDir(runcmd, longdir, flags, importcfgfile, pkg.name, pkg.files...)
if i == errPkg {
if wantError && err == nil {
return fmt.Errorf("compilation succeeded unexpectedly\n%s", out)
} else if !wantError && err != nil {
return err
}
} else if err != nil {
return err
}
var fullshort []string
for _, name := range pkg.files {
fullshort = append(fullshort, filepath.Join(longdir, name), name)
}
err = t.errorCheck(string(out), wantAuto, fullshort...)
if err != nil {
return err
}
}
if action == "errorcheckdir" {
return nil
}
fallthrough
case "rundir":
// Compile all files in the directory as packages in lexicographic order.
// In case of errorcheckandrundir, ignore failed compilation of the package before the last.
// Link as if the last file is the main package, run it.
// Verify the expected output.
longdir := filepath.Join(t.gorootTestDir, t.goDirName())
pkgs := goDirPackages(t.T, longdir, singlefilepkgs)
// Split flags into gcflags and ldflags
ldflags := []string{}
for i, fl := range flags {
if fl == "-ldflags" {
ldflags = flags[i+1:]
flags = flags[0:i]
break
}
}
importcfgfile := importcfg(pkgs)
for i, pkg := range pkgs {
_, err := compileInDir(runcmd, longdir, flags, importcfgfile, pkg.name, pkg.files...)
// Allow this package compilation fail based on conditions below;
// its errors were checked in previous case.
if err != nil && !(wantError && action == "errorcheckandrundir" && i == len(pkgs)-2) {
return err
}
if i == len(pkgs)-1 {
err = linkFile(runcmd, pkg.files[0], importcfgfile, ldflags)
if err != nil {
return err
}
var cmd []string
cmd = append(cmd, findExecCmd()...)
cmd = append(cmd, filepath.Join(tempDir, "a.exe"))
cmd = append(cmd, args...)
out, err := runcmd(cmd...)
if err != nil {
return err
}
t.checkExpectedOutput(out)
}
}
return nil
case "runindir":
// Make a shallow copy of t.goDirName() in its own module and GOPATH, and
// run "go run ." in it. The module path (and hence import path prefix) of
// the copy is equal to the basename of the source directory.
//
// It's used when test a requires a full 'go build' in order to compile
// the sources, such as when importing multiple packages (issue29612.dir)
// or compiling a package containing assembly files (see issue15609.dir),
// but still needs to be run to verify the expected output.
tempDirIsGOPATH = true
srcDir := filepath.Join(t.gorootTestDir, t.goDirName())
modName := filepath.Base(srcDir)
gopathSrcDir := filepath.Join(tempDir, "src", modName)
runInDir = gopathSrcDir
if err := overlayDir(gopathSrcDir, srcDir); err != nil {
t.Fatal(err)
}
modFile := fmt.Sprintf("module %s\ngo 1.14\n", modName)
if err := os.WriteFile(filepath.Join(gopathSrcDir, "go.mod"), []byte(modFile), 0666); err != nil {
t.Fatal(err)
}
cmd := []string{goTool, "run", t.goGcflags()}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
cmd = append(cmd, flags...)
cmd = append(cmd, ".")
out, err := runcmd(cmd...)
if err != nil {
return err
}
return t.checkExpectedOutput(out)
case "build":
// Build Go file.
cmd := []string{goTool, "build", t.goGcflags()}
cmd = append(cmd, flags...)
cmd = append(cmd, "-o", "a.exe", long)
_, err := runcmd(cmd...)
return err
case "builddir", "buildrundir":
// Build an executable from all the .go and .s files in a subdirectory.
// Run it and verify its output in the buildrundir case.
longdir := filepath.Join(t.gorootTestDir, t.goDirName())
files, err := os.ReadDir(longdir)
if err != nil {
t.Fatal(err)
}
var gos []string
var asms []string
for _, file := range files {
switch filepath.Ext(file.Name()) {
case ".go":
gos = append(gos, filepath.Join(longdir, file.Name()))
case ".s":
asms = append(asms, filepath.Join(longdir, file.Name()))
}
}
if len(asms) > 0 {
emptyHdrFile := filepath.Join(tempDir, "go_asm.h")
if err := os.WriteFile(emptyHdrFile, nil, 0666); err != nil {
t.Fatalf("write empty go_asm.h: %v", err)
}
cmd := []string{goTool, "tool", "asm", "-p=main", "-gensymabis", "-o", "symabis"}
cmd = append(cmd, asms...)
_, err = runcmd(cmd...)
if err != nil {
return err
}
}
var objs []string
cmd := []string{goTool, "tool", "compile", "-p=main", "-e", "-D", ".", "-importcfg=" + stdlibImportcfgFile(), "-o", "go.o"}
if len(asms) > 0 {
cmd = append(cmd, "-asmhdr", "go_asm.h", "-symabis", "symabis")
}
cmd = append(cmd, gos...)
_, err = runcmd(cmd...)
if err != nil {
return err
}
objs = append(objs, "go.o")
if len(asms) > 0 {
cmd = []string{goTool, "tool", "asm", "-p=main", "-e", "-I", ".", "-o", "asm.o"}
cmd = append(cmd, asms...)
_, err = runcmd(cmd...)
if err != nil {
return err
}
objs = append(objs, "asm.o")
}
cmd = []string{goTool, "tool", "pack", "c", "all.a"}
cmd = append(cmd, objs...)
_, err = runcmd(cmd...)
if err != nil {
return err
}
cmd = []string{goTool, "tool", "link", "-importcfg=" + stdlibImportcfgFile(), "-o", "a.exe", "all.a"}
_, err = runcmd(cmd...)
if err != nil {
return err
}
if action == "builddir" {
return nil
}
cmd = append(findExecCmd(), filepath.Join(tempDir, "a.exe"))
out, err := runcmd(cmd...)
if err != nil {
return err
}
return t.checkExpectedOutput(out)
case "buildrun":
// Build an executable from Go file, then run it, verify its output.
// Useful for timeout tests where failure mode is infinite loop.
// TODO: not supported on NaCl
cmd := []string{goTool, "build", t.goGcflags(), "-o", "a.exe"}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
longDirGoFile := filepath.Join(filepath.Join(t.gorootTestDir, t.dir), t.goFile)
cmd = append(cmd, flags...)
cmd = append(cmd, longDirGoFile)
_, err := runcmd(cmd...)
if err != nil {
return err
}
cmd = []string{"./a.exe"}
out, err := runcmd(append(cmd, args...)...)
if err != nil {
return err
}
return t.checkExpectedOutput(out)
case "run":
// Run Go file if no special go command flags are provided;
// otherwise build an executable and run it.
// Verify the output.
runInDir = ""
var out []byte
var err error
if len(flags)+len(args) == 0 && t.goGcflagsIsEmpty() && !*linkshared && goarch == runtime.GOARCH && goos == runtime.GOOS && goexp == goExperiment && godebug == goDebug {
// If we're not using special go command flags,
// skip all the go command machinery.
// This avoids any time the go command would
// spend checking whether, for example, the installed
// package runtime is up to date.
// Because we run lots of trivial test programs,
// the time adds up.
pkg := filepath.Join(tempDir, "pkg.a")
if _, err := runcmd(goTool, "tool", "compile", "-p=main", "-importcfg="+stdlibImportcfgFile(), "-o", pkg, t.goFileName()); err != nil {
return err
}
exe := filepath.Join(tempDir, "test.exe")
cmd := []string{goTool, "tool", "link", "-s", "-w", "-importcfg=" + stdlibImportcfgFile()}
cmd = append(cmd, "-o", exe, pkg)
if _, err := runcmd(cmd...); err != nil {
return err
}
out, err = runcmd(append([]string{exe}, args...)...)
} else {
cmd := []string{goTool, "run", t.goGcflags()}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
cmd = append(cmd, flags...)
cmd = append(cmd, t.goFileName())
out, err = runcmd(append(cmd, args...)...)
}
if err != nil {
return err
}
return t.checkExpectedOutput(out)
case "runoutput":
// Run Go file and write its output into temporary Go file.
// Run generated Go file and verify its output.
t.runoutputGate <- true
defer func() {
<-t.runoutputGate
}()
runInDir = ""
cmd := []string{goTool, "run", t.goGcflags()}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
cmd = append(cmd, t.goFileName())
out, err := runcmd(append(cmd, args...)...)
if err != nil {
return err
}
tfile := filepath.Join(tempDir, "tmp__.go")
if err := os.WriteFile(tfile, out, 0666); err != nil {
t.Fatalf("write tempfile: %v", err)
}
cmd = []string{goTool, "run", t.goGcflags()}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
cmd = append(cmd, tfile)
out, err = runcmd(cmd...)
if err != nil {
return err
}
return t.checkExpectedOutput(out)
case "errorcheckoutput":
// Run Go file and write its output into temporary Go file.
// Compile and errorCheck generated Go file.
runInDir = ""
cmd := []string{goTool, "run", t.goGcflags()}
if *linkshared {
cmd = append(cmd, "-linkshared")
}
cmd = append(cmd, t.goFileName())
out, err := runcmd(append(cmd, args...)...)
if err != nil {
return err
}
tfile := filepath.Join(tempDir, "tmp__.go")
err = os.WriteFile(tfile, out, 0666)
if err != nil {
t.Fatalf("write tempfile: %v", err)
}
cmdline := []string{goTool, "tool", "compile", "-importcfg=" + stdlibImportcfgFile(), "-p=p", "-d=panic", "-e", "-o", "a.o"}
cmdline = append(cmdline, flags...)
cmdline = append(cmdline, tfile)
out, err = runcmd(cmdline...)
if wantError {
if err == nil {
return fmt.Errorf("compilation succeeded unexpectedly\n%s", out)
}
} else {
if err != nil {
return err
}
}
return t.errorCheck(string(out), false, tfile, "tmp__.go")
}
}
var execCmdOnce sync.Once
var execCmd []string
func findExecCmd() []string {
execCmdOnce.Do(func() {
if goos == runtime.GOOS && goarch == runtime.GOARCH {
// Do nothing.
} else if path, err := exec.LookPath(fmt.Sprintf("go_%s_%s_exec", goos, goarch)); err == nil {
execCmd = []string{path}
}
})
return execCmd
}
// checkExpectedOutput compares the output from compiling and/or running with the contents
// of the corresponding reference output file, if any (replace ".go" with ".out").
// If they don't match, fail with an informative message.
func (t test) checkExpectedOutput(gotBytes []byte) error {
got := string(gotBytes)
filename := filepath.Join(t.dir, t.goFile)
filename = filename[:len(filename)-len(".go")]
filename += ".out"
b, err := os.ReadFile(filepath.Join(t.gorootTestDir, filename))
if errors.Is(err, fs.ErrNotExist) {
// File is allowed to be missing, in which case output should be empty.
b = nil
} else if err != nil {
return err
}
got = strings.Replace(got, "\r\n", "\n", -1)
if got != string(b) {
if err == nil {
return fmt.Errorf("output does not match expected in %s. Instead saw\n%s", filename, got)
} else {
return fmt.Errorf("output should be empty when (optional) expected-output file %s is not present. Instead saw\n%s", filename, got)
}
}
return nil
}
func splitOutput(out string, wantAuto bool) []string {
// gc error messages continue onto additional lines with leading tabs.
// Split the output at the beginning of each line that doesn't begin with a tab.
// <autogenerated> lines are impossible to match so those are filtered out.
var res []string
for _, line := range strings.Split(out, "\n") {
if strings.HasSuffix(line, "\r") { // remove '\r', output by compiler on windows
line = line[:len(line)-1]
}
if strings.HasPrefix(line, "\t") {
res[len(res)-1] += "\n" + line
} else if strings.HasPrefix(line, "go tool") || strings.HasPrefix(line, "#") || !wantAuto && strings.HasPrefix(line, "<autogenerated>") {
continue
} else if strings.TrimSpace(line) != "" {
res = append(res, line)
}
}
return res
}
// errorCheck matches errors in outStr against comments in source files.
// For each line of the source files which should generate an error,
// there should be a comment of the form // ERROR "regexp".
// If outStr has an error for a line which has no such comment,
// this function will report an error.
// Likewise if outStr does not have an error for a line which has a comment,
// or if the error message does not match the <regexp>.
// The <regexp> syntax is Perl but it's best to stick to egrep.
//
// Sources files are supplied as fullshort slice.
// It consists of pairs: full path to source file and its base name.
func (t test) errorCheck(outStr string, wantAuto bool, fullshort ...string) (err error) {
defer func() {
if testing.Verbose() && err != nil {
t.Logf("gc output:\n%s", outStr)
}
}()
var errs []error
out := splitOutput(outStr, wantAuto)
// Cut directory name.
for i := range out {
for j := 0; j < len(fullshort); j += 2 {
full, short := fullshort[j], fullshort[j+1]
out[i] = strings.Replace(out[i], full, short, -1)
}
}
var want []wantedError
for j := 0; j < len(fullshort); j += 2 {
full, short := fullshort[j], fullshort[j+1]
want = append(want, t.wantedErrors(full, short)...)
}
for _, we := range want {
var errmsgs []string
if we.auto {
errmsgs, out = partitionStrings("<autogenerated>", out)
} else {
errmsgs, out = partitionStrings(we.prefix, out)
}
if len(errmsgs) == 0 {
errs = append(errs, fmt.Errorf("%s:%d: missing error %q", we.file, we.lineNum, we.reStr))
continue
}
matched := false
n := len(out)
for _, errmsg := range errmsgs {
// Assume errmsg says "file:line: foo".
// Cut leading "file:line: " to avoid accidental matching of file name instead of message.
text := errmsg
if _, suffix, ok := strings.Cut(text, " "); ok {
text = suffix
}
if we.re.MatchString(text) {
matched = true
} else {
out = append(out, errmsg)
}
}
if !matched {
errs = append(errs, fmt.Errorf("%s:%d: no match for %#q in:\n\t%s", we.file, we.lineNum, we.reStr, strings.Join(out[n:], "\n\t")))
continue
}
}
if len(out) > 0 {
errs = append(errs, fmt.Errorf("Unmatched Errors:"))
for _, errLine := range out {
errs = append(errs, fmt.Errorf("%s", errLine))
}
}
if len(errs) == 0 {
return nil
}
if len(errs) == 1 {
return errs[0]
}
var buf bytes.Buffer
fmt.Fprintf(&buf, "\n")
for _, err := range errs {
fmt.Fprintf(&buf, "%s\n", err.Error())
}
return errors.New(buf.String())
}
func (test) updateErrors(out, file string) {
base := path.Base(file)
// Read in source file.
src, err := os.ReadFile(file)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
lines := strings.Split(string(src), "\n")
// Remove old errors.
for i := range lines {
lines[i], _, _ = strings.Cut(lines[i], " // ERROR ")
}
// Parse new errors.
errors := make(map[int]map[string]bool)
tmpRe := regexp.MustCompile(`autotmp_\d+`)
for _, errStr := range splitOutput(out, false) {
errFile, rest, ok := strings.Cut(errStr, ":")
if !ok || errFile != file {
continue
}
lineStr, msg, ok := strings.Cut(rest, ":")
if !ok {
continue
}
line, err := strconv.Atoi(lineStr)
line--
if err != nil || line < 0 || line >= len(lines) {
continue
}
msg = strings.Replace(msg, file, base, -1) // normalize file mentions in error itself
msg = strings.TrimLeft(msg, " \t")
for _, r := range []string{`\`, `*`, `+`, `?`, `[`, `]`, `(`, `)`} {
msg = strings.Replace(msg, r, `\`+r, -1)
}
msg = strings.Replace(msg, `"`, `.`, -1)
msg = tmpRe.ReplaceAllLiteralString(msg, `autotmp_[0-9]+`)
if errors[line] == nil {
errors[line] = make(map[string]bool)
}
errors[line][msg] = true
}
// Add new errors.
for line, errs := range errors {
var sorted []string
for e := range errs {
sorted = append(sorted, e)
}
sort.Strings(sorted)
lines[line] += " // ERROR"
for _, e := range sorted {
lines[line] += fmt.Sprintf(` "%s$"`, e)
}
}
// Write new file.
err = os.WriteFile(file, []byte(strings.Join(lines, "\n")), 0640)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
// Polish.
exec.Command(goTool, "fmt", file).CombinedOutput()
}
// matchPrefix reports whether s is of the form ^(.*/)?prefix(:|[),
// That is, it needs the file name prefix followed by a : or a [,
// and possibly preceded by a directory name.
func matchPrefix(s, prefix string) bool {
i := strings.Index(s, ":")
if i < 0 {
return false
}
j := strings.LastIndex(s[:i], "/")
s = s[j+1:]
if len(s) <= len(prefix) || s[:len(prefix)] != prefix {
return false
}
switch s[len(prefix)] {
case '[', ':':
return true
}
return false
}
func partitionStrings(prefix string, strs []string) (matched, unmatched []string) {
for _, s := range strs {
if matchPrefix(s, prefix) {
matched = append(matched, s)
} else {
unmatched = append(unmatched, s)
}
}
return
}
type wantedError struct {
reStr string
re *regexp.Regexp
lineNum int
auto bool // match <autogenerated> line
file string
prefix string
}
var (
errRx = regexp.MustCompile(`// (?:GC_)?ERROR (.*)`)
errAutoRx = regexp.MustCompile(`// (?:GC_)?ERRORAUTO (.*)`)
errQuotesRx = regexp.MustCompile(`"([^"]*)"`)
lineRx = regexp.MustCompile(`LINE(([+-])(\d+))?`)
)
func (t test) wantedErrors(file, short string) (errs []wantedError) {
cache := make(map[string]*regexp.Regexp)
src, _ := os.ReadFile(file)
for i, line := range strings.Split(string(src), "\n") {
lineNum := i + 1
if strings.Contains(line, "////") {
// double comment disables ERROR
continue
}
var auto bool
m := errAutoRx.FindStringSubmatch(line)
if m != nil {
auto = true
} else {
m = errRx.FindStringSubmatch(line)
}
if m == nil {
continue
}
all := m[1]
mm := errQuotesRx.FindAllStringSubmatch(all, -1)
if mm == nil {
t.Fatalf("%s:%d: invalid errchk line: %s", t.goFileName(), lineNum, line)
}
for _, m := range mm {
rx := lineRx.ReplaceAllStringFunc(m[1], func(m string) string {
n := lineNum
if strings.HasPrefix(m, "LINE+") {
delta, _ := strconv.Atoi(m[5:])
n += delta
} else if strings.HasPrefix(m, "LINE-") {
delta, _ := strconv.Atoi(m[5:])
n -= delta
}
return fmt.Sprintf("%s:%d", short, n)
})
re := cache[rx]
if re == nil {
var err error
re, err = regexp.Compile(rx)
if err != nil {
t.Fatalf("%s:%d: invalid regexp \"%s\" in ERROR line: %v", t.goFileName(), lineNum, rx, err)
}
cache[rx] = re
}
prefix := fmt.Sprintf("%s:%d", short, lineNum)
errs = append(errs, wantedError{
reStr: rx,
re: re,
prefix: prefix,
auto: auto,
lineNum: lineNum,
file: short,
})
}
}
return
}
const (
// Regexp to match a single opcode check: optionally begin with "-" (to indicate
// a negative check), followed by a string literal enclosed in "" or ``. For "",
// backslashes must be handled.
reMatchCheck = `-?(?:\x60[^\x60]*\x60|"(?:[^"\\]|\\.)*")`
)
var (
// Regexp to split a line in code and comment, trimming spaces
rxAsmComment = regexp.MustCompile(`^\s*(.*?)\s*(?://\s*(.+)\s*)?$`)
// Regexp to extract an architecture check: architecture name (or triplet),
// followed by semi-colon, followed by a comma-separated list of opcode checks.
// Extraneous spaces are ignored.
//
// An example: arm64/v8.1 : -`ADD` , `SUB`
// "(\w+)" matches "arm64" (architecture name)
// "(/[\w.]+)?" matches "v8.1" (architecture version)
// "(/\w*)?" doesn't match anything here (it's an optional part of the triplet)
// "\s*:\s*" matches " : " (semi-colon)
// "(" starts a capturing group
// first reMatchCheck matches "-`ADD`"
// `(?:" starts a non-capturing group
// "\s*,\s*` matches " , "
// second reMatchCheck matches "`SUB`"
// ")*)" closes started groups; "*" means that there might be other elements in the comma-separated list
rxAsmPlatform = regexp.MustCompile(`(\w+)(/[\w.]+)?(/\w*)?\s*:\s*(` + reMatchCheck + `(?:\s*,\s*` + reMatchCheck + `)*)`)
// Regexp to extract a single opcoded check
rxAsmCheck = regexp.MustCompile(reMatchCheck)
// List of all architecture variants. Key is the GOARCH architecture,
// value[0] is the variant-changing environment variable, and values[1:]
// are the supported variants.
archVariants = map[string][]string{
"386": {"GO386", "sse2", "softfloat"},
"amd64": {"GOAMD64", "v1", "v2", "v3", "v4"},
"arm": {"GOARM", "5", "6", "7", "7,softfloat"},
"arm64": {"GOARM64", "v8.0", "v8.1"},
"loong64": {},
"mips": {"GOMIPS", "hardfloat", "softfloat"},
"mips64": {"GOMIPS64", "hardfloat", "softfloat"},
"ppc64": {"GOPPC64", "power8", "power9", "power10"},
"ppc64le": {"GOPPC64", "power8", "power9", "power10"},
"ppc64x": {}, // A pseudo-arch representing both ppc64 and ppc64le
"s390x": {},
"wasm": {},
"riscv64": {"GORISCV64", "rva20u64", "rva22u64"},
}
)
// wantedAsmOpcode is a single asmcheck check
type wantedAsmOpcode struct {
fileline string // original source file/line (eg: "/path/foo.go:45")
line int // original source line
opcode *regexp.Regexp // opcode check to be performed on assembly output
negative bool // true if the check is supposed to fail rather than pass
found bool // true if the opcode check matched at least one in the output
}
// A build environment triplet separated by slashes (eg: linux/386/sse2).
// The third field can be empty if the arch does not support variants (eg: "plan9/amd64/")
type buildEnv string
// Environ returns the environment it represents in cmd.Environ() "key=val" format
// For instance, "linux/386/sse2".Environ() returns {"GOOS=linux", "GOARCH=386", "GO386=sse2"}
func (b buildEnv) Environ() []string {
fields := strings.Split(string(b), "/")
if len(fields) != 3 {
panic("invalid buildEnv string: " + string(b))
}
env := []string{"GOOS=" + fields[0], "GOARCH=" + fields[1]}
if fields[2] != "" {
env = append(env, archVariants[fields[1]][0]+"="+fields[2])
}
return env
}
// asmChecks represents all the asmcheck checks present in a test file
// The outer map key is the build triplet in which the checks must be performed.
// The inner map key represent the source file line ("filename.go:1234") at which the
// checks must be performed.
type asmChecks map[buildEnv]map[string][]wantedAsmOpcode
// Envs returns all the buildEnv in which at least one check is present
func (a asmChecks) Envs() []buildEnv {
var envs []buildEnv
for e := range a {
envs = append(envs, e)
}
sort.Slice(envs, func(i, j int) bool {
return string(envs[i]) < string(envs[j])
})
return envs
}
func (t test) wantedAsmOpcodes(fn string) asmChecks {
ops := make(asmChecks)
comment := ""
src, err := os.ReadFile(fn)
if err != nil {
t.Fatal(err)
}
for i, line := range strings.Split(string(src), "\n") {
matches := rxAsmComment.FindStringSubmatch(line)
code, cmt := matches[1], matches[2]
// Keep comments pending in the comment variable until
// we find a line that contains some code.
comment += " " + cmt
if code == "" {
continue
}
// Parse and extract any architecture check from comments,
// made by one architecture name and multiple checks.
lnum := fn + ":" + strconv.Itoa(i+1)
for _, ac := range rxAsmPlatform.FindAllStringSubmatch(comment, -1) {
archspec, allchecks := ac[1:4], ac[4]
var arch, subarch, os string
switch {
case archspec[2] != "": // 3 components: "linux/386/sse2"
os, arch, subarch = archspec[0], archspec[1][1:], archspec[2][1:]
case archspec[1] != "": // 2 components: "386/sse2"
os, arch, subarch = "linux", archspec[0], archspec[1][1:]
default: // 1 component: "386"
os, arch, subarch = "linux", archspec[0], ""
if arch == "wasm" {
os = "js"
}
}
if _, ok := archVariants[arch]; !ok {
t.Fatalf("%s:%d: unsupported architecture: %v", t.goFileName(), i+1, arch)
}
// Create the build environments corresponding the above specifiers
envs := make([]buildEnv, 0, 4)
arches := []string{arch}
// ppc64x is a pseudo-arch, generate tests for both endian variants.
if arch == "ppc64x" {
arches = []string{"ppc64", "ppc64le"}
}
for _, arch := range arches {
if subarch != "" {
envs = append(envs, buildEnv(os+"/"+arch+"/"+subarch))
} else {
subarchs := archVariants[arch]
if len(subarchs) == 0 {
envs = append(envs, buildEnv(os+"/"+arch+"/"))
} else {
for _, sa := range archVariants[arch][1:] {
envs = append(envs, buildEnv(os+"/"+arch+"/"+sa))
}
}
}
}
for _, m := range rxAsmCheck.FindAllString(allchecks, -1) {
negative := false
if m[0] == '-' {
negative = true
m = m[1:]
}
rxsrc, err := strconv.Unquote(m)
if err != nil {
t.Fatalf("%s:%d: error unquoting string: %v", t.goFileName(), i+1, err)
}
// Compile the checks as regular expressions. Notice that we
// consider checks as matching from the beginning of the actual
// assembler source (that is, what is left on each line of the
// compile -S output after we strip file/line info) to avoid
// trivial bugs such as "ADD" matching "FADD". This
// doesn't remove genericity: it's still possible to write
// something like "F?ADD", but we make common cases simpler
// to get right.
oprx, err := regexp.Compile("^" + rxsrc)
if err != nil {
t.Fatalf("%s:%d: %v", t.goFileName(), i+1, err)
}
for _, env := range envs {
if ops[env] == nil {
ops[env] = make(map[string][]wantedAsmOpcode)
}
ops[env][lnum] = append(ops[env][lnum], wantedAsmOpcode{
negative: negative,
fileline: lnum,
line: i + 1,
opcode: oprx,
})
}
}
}
comment = ""
}
return ops
}
func (t test) asmCheck(outStr string, fn string, env buildEnv, fullops map[string][]wantedAsmOpcode) error {
// The assembly output contains the concatenated dump of multiple functions.
// the first line of each function begins at column 0, while the rest is
// indented by a tabulation. These data structures help us index the
// output by function.
functionMarkers := make([]int, 1)
lineFuncMap := make(map[string]int)
lines := strings.Split(outStr, "\n")
rxLine := regexp.MustCompile(fmt.Sprintf(`\((%s:\d+)\)\s+(.*)`, regexp.QuoteMeta(fn)))
for nl, line := range lines {
// Check if this line begins a function
if len(line) > 0 && line[0] != '\t' {
functionMarkers = append(functionMarkers, nl)
}
// Search if this line contains a assembly opcode (which is prefixed by the
// original source file/line in parenthesis)
matches := rxLine.FindStringSubmatch(line)
if len(matches) == 0 {
continue
}
srcFileLine, asm := matches[1], matches[2]
// Associate the original file/line information to the current
// function in the output; it will be useful to dump it in case
// of error.
lineFuncMap[srcFileLine] = len(functionMarkers) - 1
// If there are opcode checks associated to this source file/line,
// run the checks.
if ops, found := fullops[srcFileLine]; found {
for i := range ops {
if !ops[i].found && ops[i].opcode.FindString(asm) != "" {
ops[i].found = true
}
}
}
}
functionMarkers = append(functionMarkers, len(lines))
var failed []wantedAsmOpcode
for _, ops := range fullops {
for _, o := range ops {
// There's a failure if a negative match was found,
// or a positive match was not found.
if o.negative == o.found {
failed = append(failed, o)
}
}
}
if len(failed) == 0 {
return nil
}
// At least one asmcheck failed; report them.
lastFunction := -1
var errbuf bytes.Buffer
fmt.Fprintln(&errbuf)
sort.Slice(failed, func(i, j int) bool { return failed[i].line < failed[j].line })
for _, o := range failed {
// Dump the function in which this opcode check was supposed to
// pass but failed.
funcIdx := lineFuncMap[o.fileline]
if funcIdx != 0 && funcIdx != lastFunction {
funcLines := lines[functionMarkers[funcIdx]:functionMarkers[funcIdx+1]]
t.Log(strings.Join(funcLines, "\n"))
lastFunction = funcIdx // avoid printing same function twice
}
if o.negative {
fmt.Fprintf(&errbuf, "%s:%d: %s: wrong opcode found: %q\n", t.goFileName(), o.line, env, o.opcode.String())
} else {
fmt.Fprintf(&errbuf, "%s:%d: %s: opcode not found: %q\n", t.goFileName(), o.line, env, o.opcode.String())
}
}
return errors.New(errbuf.String())
}
// defaultRunOutputLimit returns the number of runoutput tests that
// can be executed in parallel.
func defaultRunOutputLimit() int {
const maxArmCPU = 2
cpu := runtime.NumCPU()
if runtime.GOARCH == "arm" && cpu > maxArmCPU {
cpu = maxArmCPU
}
return cpu
}
func TestShouldTest(t *testing.T) {
if *shard != 0 {
t.Skipf("nothing to test on shard index %d", *shard)
}
assert := func(ok bool, _ string) {
t.Helper()
if !ok {
t.Error("test case failed")
}
}
assertNot := func(ok bool, _ string) { t.Helper(); assert(!ok, "") }
// Simple tests.
assert(shouldTest("// +build linux", "linux", "arm"))
assert(shouldTest("// +build !windows", "linux", "arm"))
assertNot(shouldTest("// +build !windows", "windows", "amd64"))
// A file with no build tags will always be tested.
assert(shouldTest("// This is a test.", "os", "arch"))
// Build tags separated by a space are OR-ed together.
assertNot(shouldTest("// +build arm 386", "linux", "amd64"))
// Build tags separated by a comma are AND-ed together.
assertNot(shouldTest("// +build !windows,!plan9", "windows", "amd64"))
assertNot(shouldTest("// +build !windows,!plan9", "plan9", "386"))
// Build tags on multiple lines are AND-ed together.
assert(shouldTest("// +build !windows\n// +build amd64", "linux", "amd64"))
assertNot(shouldTest("// +build !windows\n// +build amd64", "windows", "amd64"))
// Test that (!a OR !b) matches anything.
assert(shouldTest("// +build !windows !plan9", "windows", "amd64"))
// Test that //go:build tag match.
assert(shouldTest("//go:build go1.4", "linux", "amd64"))
}
// overlayDir makes a minimal-overhead copy of srcRoot in which new files may be added.
func overlayDir(dstRoot, srcRoot string) error {
dstRoot = filepath.Clean(dstRoot)
if err := os.MkdirAll(dstRoot, 0777); err != nil {
return err
}
srcRoot, err := filepath.Abs(srcRoot)
if err != nil {
return err
}
return filepath.WalkDir(srcRoot, func(srcPath string, d fs.DirEntry, err error) error {
if err != nil || srcPath == srcRoot {
return err
}
suffix := strings.TrimPrefix(srcPath, srcRoot)
for len(suffix) > 0 && suffix[0] == filepath.Separator {
suffix = suffix[1:]
}
dstPath := filepath.Join(dstRoot, suffix)
var info fs.FileInfo
if d.Type()&os.ModeSymlink != 0 {
info, err = os.Stat(srcPath)
} else {
info, err = d.Info()
}
if err != nil {
return err
}
perm := info.Mode() & os.ModePerm
// Always copy directories (don't symlink them).
// If we add a file in the overlay, we don't want to add it in the original.
if info.IsDir() {
return os.MkdirAll(dstPath, perm|0200)
}
// If the OS supports symlinks, use them instead of copying bytes.
if err := os.Symlink(srcPath, dstPath); err == nil {
return nil
}
// Otherwise, copy the bytes.
src, err := os.Open(srcPath)
if err != nil {
return err
}
defer src.Close()
dst, err := os.OpenFile(dstPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, perm)
if err != nil {
return err
}
_, err = io.Copy(dst, src)
if closeErr := dst.Close(); err == nil {
err = closeErr
}
return err
})
}
// The following sets of files are excluded from testing depending on configuration.
// The types2Failures(32Bit) files pass with the 1.17 compiler but don't pass with
// the 1.18 compiler using the new types2 type checker, or pass with sub-optimal
// error(s).
// List of files that the compiler cannot errorcheck with the new typechecker (types2).
var types2Failures = setOf(
"shift1.go", // types2 reports two new errors which are probably not right
"fixedbugs/issue10700.go", // types2 should give hint about ptr to interface
"fixedbugs/issue18331.go", // missing error about misuse of //go:noescape (irgen needs code from noder)
"fixedbugs/issue18419.go", // types2 reports no field or method member, but should say unexported
"fixedbugs/issue20233.go", // types2 reports two instead of one error (preference: 1.17 compiler)
"fixedbugs/issue20245.go", // types2 reports two instead of one error (preference: 1.17 compiler)
"fixedbugs/issue31053.go", // types2 reports "unknown field" instead of "cannot refer to unexported field"
"fixedbugs/notinheap.go", // types2 doesn't report errors about conversions that are invalid due to //go:notinheap
)
var types2Failures32Bit = setOf(
"printbig.go", // large untyped int passed to print (32-bit)
"fixedbugs/bug114.go", // large untyped int passed to println (32-bit)
"fixedbugs/issue23305.go", // large untyped int passed to println (32-bit)
)
// In all of these cases, the 1.17 compiler reports reasonable errors, but either the
// 1.17 or 1.18 compiler report extra errors, so we can't match correctly on both. We
// now set the patterns to match correctly on all the 1.18 errors.
// This list remains here just as a reference and for comparison - these files all pass.
var _ = setOf(
"import1.go", // types2 reports extra errors
"initializerr.go", // types2 reports extra error
"typecheck.go", // types2 reports extra error at function call
"fixedbugs/bug176.go", // types2 reports all errors (pref: types2)
"fixedbugs/bug195.go", // types2 reports slight different errors, and an extra error
"fixedbugs/bug412.go", // types2 produces a follow-on error
"fixedbugs/issue11614.go", // types2 reports an extra error
"fixedbugs/issue17038.go", // types2 doesn't report a follow-on error (pref: types2)
"fixedbugs/issue23732.go", // types2 reports different (but ok) line numbers
"fixedbugs/issue4510.go", // types2 reports different (but ok) line numbers
"fixedbugs/issue7525b.go", // types2 reports init cycle error on different line - ok otherwise
"fixedbugs/issue7525c.go", // types2 reports init cycle error on different line - ok otherwise
"fixedbugs/issue7525d.go", // types2 reports init cycle error on different line - ok otherwise
"fixedbugs/issue7525e.go", // types2 reports init cycle error on different line - ok otherwise
"fixedbugs/issue7525.go", // types2 reports init cycle error on different line - ok otherwise
)
func setOf(keys ...string) map[string]bool {
m := make(map[string]bool, len(keys))
for _, key := range keys {
m[key] = true
}
return m
}
// splitQuoted splits the string s around each instance of one or more consecutive
// white space characters while taking into account quotes and escaping, and
// returns an array of substrings of s or an empty list if s contains only white space.
// Single quotes and double quotes are recognized to prevent splitting within the
// quoted region, and are removed from the resulting substrings. If a quote in s
// isn't closed err will be set and r will have the unclosed argument as the
// last element. The backslash is used for escaping.
//
// For example, the following string:
//
// a b:"c d" 'e''f' "g\""
//
// Would be parsed as:
//
// []string{"a", "b:c d", "ef", `g"`}
//
// [copied from src/go/build/build.go]
func splitQuoted(s string) (r []string, err error) {
var args []string
arg := make([]rune, len(s))
escaped := false
quoted := false
quote := '\x00'
i := 0
for _, rune := range s {
switch {
case escaped:
escaped = false
case rune == '\\':
escaped = true
continue
case quote != '\x00':
if rune == quote {
quote = '\x00'
continue
}
case rune == '"' || rune == '\'':
quoted = true
quote = rune
continue
case unicode.IsSpace(rune):
if quoted || i > 0 {
quoted = false
args = append(args, string(arg[:i]))
i = 0
}
continue
}
arg[i] = rune
i++
}
if quoted || i > 0 {
args = append(args, string(arg[:i]))
}
if quote != 0 {
err = errors.New("unclosed quote")
} else if escaped {
err = errors.New("unfinished escaping")
}
return args, err
}