package testenv

Import Path
	internal/testenv (on go.dev)

Dependency Relation
	imports 18 packages, and imported by 0 packages


Involved Source Files

	    exec.go
	    opt.go
	
		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.

	    testenv_notwin.go
	    testenv_unix.go


Package-Level Functions (total 35)


	
		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.


	
		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.


	
		Command is like exec.Command, but applies the same changes as
		testenv.CommandContext (with a default Context).


	
		CommandContext is like exec.CommandContext, but:
		  - skips t if the platform does not support os/exec,
		  - sends SIGQUIT (if supported by the platform) instead of SIGKILL
		    in its Cancel function
		  - if the test has a deadline, adds a Context timeout and WaitDelay
		    for an arbitrary grace period before the test's deadline expires,
		  - fails the test if the command does not complete before the test's deadline, and
		  - sets a Cleanup function that verifies that the test did not leak a subprocess.


	
		CPUIsSlow reports whether the CPU running the test is suspected to be slow.


	
		GOROOT reports the path to the directory containing the root of the Go
		project source tree. This is normally equivalent to runtime.GOROOT, but
		works even if the test binary was built with -trimpath and cannot exec
		'go env GOROOT'.
		
		If GOROOT cannot be found, GOROOT skips t if t is non-nil,
		or panics otherwise.


	
		GoTool reports the path to the Go tool.


	
		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.


	
		HasCGO reports whether the current system can use cgo.


	
		HasExternalNetwork reports whether the current system can use
		external (non-localhost) networks.


	
		HasGoBuild reports whether the current system can build programs with “go build”
		and then run them with os.StartProcess or exec.Command.


	
		HasGoRun reports whether the current system can run programs with “go run.”


	
		HasParallelism reports whether the current system can execute multiple
		threads in parallel.
		There is a copy of this function in cmd/dist/test.go.


	
		HasSrc reports whether the entire source tree is available under GOROOT.


	
		MustHaveBuildMode reports whether the current system can build programs in
		the given build mode.
		If not, MustHaveBuildMode calls t.Skip with an explanation.


	
		MustHaveCGO calls t.Skip if cgo is not available.


	
		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.
		
		On some platforms MustHaveExec checks for exec support by re-executing the
		current executable, which must be a binary built by 'go test'.
		We intentionally do not provide a HasExec function because of the risk of
		inappropriate recursion in TestMain functions.
		
		To check for exec support outside of a test, just try to exec the command.
		If exec is not supported, testenv.SyscallIsNotSupported will return true
		for the resulting 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.


	
		MustHaveExternalNetwork checks that the current system can use
		external (non-localhost) networks.
		If not, MustHaveExternalNetwork calls t.Skip with an explanation.


	
		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.


	
		MustHaveGoRun checks that the current system can run programs with “go run.”
		If not, MustHaveGoRun calls t.Skip with an explanation.


	
		MustHaveParallelism checks that the current system can execute multiple
		threads in parallel. If not, MustHaveParallelism calls t.Skip with an explanation.


	
		OptimizationOff reports whether optimization is disabled.


	 func SkipFlaky(t testing.TB, issue int)
	
		SkipIfOptimizationOff skips t if optimization is disabled.


	
		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.)


	
		SyscallIsNotSupported reports whether err may indicate that a system call is
		not supported by the current platform or execution environment.


	
		WriteImportcfg writes an importcfg file used by the compiler or linker to
		dstPath containing entries for the file mappings in packageFiles, as well
		as for the packages transitively imported by the package(s) in pkgs.
		
		pkgs may include any package pattern that is valid to pass to 'go list',
		so it may also be a list of Go source files all in the same directory.




Package-Level Variables (only one)


	
		Sigquit is the signal to send to kill a hanging subprocess.
		Send SIGQUIT to get a stack trace.