// Copyright 2015 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 testenv provides information about what functionality // is available in different testing environments run by the Go team. // // It is an internal package because these details are specific // to the Go team's test setup (on build.golang.org) and not // fundamental to tests in general.
package testenv import ( ) // Builder reports the name of the builder running this test // (for example, "linux-amd64" or "windows-386-gce"). // If the test is not running on the build infrastructure, // Builder returns the empty string. func () string { return os.Getenv("GO_BUILDER_NAME") } // HasGoBuild reports whether the current system can build programs with ``go build'' // and then run them with os.StartProcess or exec.Command. func () bool { if os.Getenv("GO_GCFLAGS") != "" { // It's too much work to require every caller of the go command // to pass along "-gcflags="+os.Getenv("GO_GCFLAGS"). // For now, if $GO_GCFLAGS is set, report that we simply can't // run go build. return false } switch runtime.GOOS { case "android", "js", "ios": return false } return true } // MustHaveGoBuild checks that the current system can build programs with ``go build'' // and then run them with os.StartProcess or exec.Command. // If not, MustHaveGoBuild calls t.Skip with an explanation. func ( testing.TB) { if os.Getenv("GO_GCFLAGS") != "" { .Skipf("skipping test: 'go build' not compatible with setting $GO_GCFLAGS") } if !HasGoBuild() { .Skipf("skipping test: 'go build' not available on %s/%s", runtime.GOOS, runtime.GOARCH) } } // HasGoRun reports whether the current system can run programs with ``go run.'' func () bool { // For now, having go run and having go build are the same. return HasGoBuild() } // MustHaveGoRun checks that the current system can run programs with ``go run.'' // If not, MustHaveGoRun calls t.Skip with an explanation. func ( testing.TB) { if !HasGoRun() { .Skipf("skipping test: 'go run' not available on %s/%s", runtime.GOOS, runtime.GOARCH) } } // GoToolPath reports the path to the Go tool. // It is a convenience wrapper around GoTool. // If the tool is unavailable GoToolPath calls t.Skip. // If the tool should be available and isn't, GoToolPath calls t.Fatal. func ( testing.TB) string { MustHaveGoBuild() , := GoTool() if != nil { .Fatal() } // Add all environment variables that affect the Go command to test metadata. // Cached test results will be invalidate when these variables change. // See golang.org/issue/32285. for , := range strings.Fields(cfg.KnownEnv) { os.Getenv() } return } // GoTool reports the path to the Go tool. func () (string, error) { if !HasGoBuild() { return "", errors.New("platform cannot run go tool") } var string if runtime.GOOS == "windows" { = ".exe" } := filepath.Join(runtime.GOROOT(), "bin", "go"+) if , := os.Stat(); == nil { return , nil } , := exec.LookPath("go" + ) if != nil { return "", errors.New("cannot find go tool: " + .Error()) } return , nil } // HasExec reports whether the current system can start new processes // using os.StartProcess or (more commonly) exec.Command. func () bool { switch runtime.GOOS { case "js", "ios": return false } return true } // HasSrc reports whether the entire source tree is available under GOROOT. func () bool { switch runtime.GOOS { case "ios": return false } return true } // MustHaveExec checks that the current system can start new processes // using os.StartProcess or (more commonly) exec.Command. // If not, MustHaveExec calls t.Skip with an explanation. func ( testing.TB) { if !HasExec() { .Skipf("skipping test: cannot exec subprocess on %s/%s", runtime.GOOS, runtime.GOARCH) } } var execPaths sync.Map // path -> error // MustHaveExecPath checks that the current system can start the named executable // using os.StartProcess or (more commonly) exec.Command. // If not, MustHaveExecPath calls t.Skip with an explanation. func ( testing.TB, string) { MustHaveExec() , := execPaths.Load() if ! { _, = exec.LookPath() , _ = execPaths.LoadOrStore(, ) } if != nil { .Skipf("skipping test: %s: %s", , ) } } // HasExternalNetwork reports whether the current system can use // external (non-localhost) networks. func () bool { return !testing.Short() && runtime.GOOS != "js" } // MustHaveExternalNetwork checks that the current system can use // external (non-localhost) networks. // If not, MustHaveExternalNetwork calls t.Skip with an explanation. func ( testing.TB) { if runtime.GOOS == "js" { .Skipf("skipping test: no external network on %s", runtime.GOOS) } if testing.Short() { .Skipf("skipping test: no external network in -short mode") } } var haveCGO bool // HasCGO reports whether the current system can use cgo. func () bool { return haveCGO } // MustHaveCGO calls t.Skip if cgo is not available. func ( testing.TB) { if !haveCGO { .Skipf("skipping test: no cgo") } } // CanInternalLink reports whether the current system can link programs with // internal linking. // (This is the opposite of cmd/internal/sys.MustLinkExternal. Keep them in sync.) func () bool { switch runtime.GOOS { case "android": if runtime.GOARCH != "arm64" { return false } case "ios": if runtime.GOARCH == "arm64" { return false } } return true } // MustInternalLink checks that the current system can link programs with internal // linking. // If not, MustInternalLink calls t.Skip with an explanation. func ( testing.TB) { if !CanInternalLink() { .Skipf("skipping test: internal linking on %s/%s is not supported", runtime.GOOS, runtime.GOARCH) } } // HasSymlink reports whether the current system can use os.Symlink. func () bool { , := hasSymlink() return } // MustHaveSymlink reports whether the current system can use os.Symlink. // If not, MustHaveSymlink calls t.Skip with an explanation. func ( testing.TB) { , := hasSymlink() if ! { .Skipf("skipping test: cannot make symlinks on %s/%s%s", runtime.GOOS, runtime.GOARCH, ) } } // HasLink reports whether the current system can use os.Link. func () bool { // From Android release M (Marshmallow), hard linking files is blocked // and an attempt to call link() on a file will return EACCES. // - https://code.google.com/p/android-developer-preview/issues/detail?id=3150 return runtime.GOOS != "plan9" && runtime.GOOS != "android" } // MustHaveLink reports whether the current system can use os.Link. // If not, MustHaveLink calls t.Skip with an explanation. func ( testing.TB) { if !HasLink() { .Skipf("skipping test: hardlinks are not supported on %s/%s", runtime.GOOS, runtime.GOARCH) } } var flaky = flag.Bool("flaky", false, "run known-flaky tests too") func ( testing.TB, int) { .Helper() if !*flaky { .Skipf("skipping known flaky test without the -flaky flag; see golang.org/issue/%d", ) } } func ( testing.TB) { .Helper() if , := strconv.ParseBool(os.Getenv("GO_BUILDER_FLAKY_NET")); { .Skip("skipping test on builder known to have frequent network failures") } } // CleanCmdEnv will fill cmd.Env with the environment, excluding certain // variables that could modify the behavior of the Go tools such as // GODEBUG and GOTRACEBACK. func ( *exec.Cmd) *exec.Cmd { if .Env != nil { panic("environment already set") } for , := range os.Environ() { // Exclude GODEBUG from the environment to prevent its output // from breaking tests that are trying to parse other command output. if strings.HasPrefix(, "GODEBUG=") { continue } // Exclude GOTRACEBACK for the same reason. if strings.HasPrefix(, "GOTRACEBACK=") { continue } .Env = append(.Env, ) } return } // CPUIsSlow reports whether the CPU running the test is suspected to be slow. func () bool { switch runtime.GOARCH { case "arm", "mips", "mipsle", "mips64", "mips64le": return true } return false } // SkipIfShortAndSlow skips t if -short is set and the CPU running the test is // suspected to be slow. // // (This is useful for CPU-intensive tests that otherwise complete quickly.) func ( testing.TB) { if testing.Short() && CPUIsSlow() { .Helper() .Skipf("skipping test in -short mode on %s", runtime.GOARCH) } }