cmd/go: isolate some very long tests

These tests are exceptionally slow. Move them out of the normal cmd/go
test suite to try to make it more reasonable to run 'go test cmd/go' in
a regular dev cycle. More tests can be moved here as needed. (Hopefully
this can also help longtest sharding)

Change-Id: I4ca0696d0afe72aa0234ed4ed87679ab6a6a6964
Reviewed-on: https://go-review.googlesource.com/c/go/+/753860
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Michael Matloob <matloob@golang.org>
Reviewed-by: Michael Matloob <matloob@google.com>
This commit is contained in:
Michael Matloob
2026-03-10 17:34:02 -04:00
committed by Gopher Robot
parent 75cfb36608
commit 9e2189ef8e
5 changed files with 327 additions and 12 deletions

View File

@@ -0,0 +1,26 @@
// Copyright 2026 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 verylongtest
import (
"cmd/internal/script/scripttest"
"flag"
"internal/testenv"
"testing"
)
//go:generate go test cmd/go/internal/verylongtest -v -run=TestScript/README --fixreadme
var fixReadme = flag.Bool("fixreadme", false, "if true, update README for script tests")
func TestScript(t *testing.T) {
if testing.Short() {
// Don't bother setting up the script engine. None of these are short tests.
t.Skip()
}
testenv.MustHaveGoBuild(t)
testenv.SkipIfShortAndSlow(t)
scripttest.RunToolScriptTest(t, nil, "testdata/script", *fixReadme)
}

View File

@@ -0,0 +1,286 @@
This file is generated by 'go generate'. DO NOT EDIT.
This directory holds test scripts *.txt run during 'go test cmd/<toolname>'.
To run a specific script foo.txt
go test cmd/<toolname> -run=Script/^foo$
In general script files should have short names: a few words,
not whole sentences.
The first word should be the general category of behavior being tested,
often the name of a go subcommand (build, link, compile, ...) or concept (vendor, pattern).
Each script is a text archive (go doc internal/txtar).
The script begins with an actual command script to run
followed by the content of zero or more supporting files to
create in the script's temporary file system before it starts executing.
As an example, run_hello.txt says:
# hello world
go run hello.go
stderr 'hello world'
! stdout .
-- hello.go --
package main
func main() { println("hello world") }
Each script runs in a fresh temporary work directory tree, available to scripts as $WORK.
Scripts also have access to other environment variables, including:
GOARCH=<target GOARCH>
GOOS=<target GOOS>
TMPDIR=$WORK/tmp
devnull=<value of os.DevNull>
goversion=<current Go version; for example, 1.12>
On Plan 9, the variables $path and $home are set instead of $PATH and $HOME.
On Windows, the variables $USERPROFILE and $TMP are set instead of
$HOME and $TMPDIR.
The lines at the top of the script are a sequence of commands to be executed by
a small script engine configured in .../cmd/internal/script/scripttest/run.go (not the system shell).
Each line of a script is parsed into a sequence of space-separated command
words, with environment variable expansion within each word and # marking
an end-of-line comment. Additional variables named ':' and '/' are expanded
within script arguments (expanding to the value of os.PathListSeparator and
os.PathSeparator respectively) but are not inherited in subprocess environments.
Adding single quotes around text keeps spaces in that text from being treated
as word separators and also disables environment variable expansion. Inside a
single-quoted block of text, a repeated single quote indicates a literal single
quote, as in:
'Don''t communicate by sharing memory.'
A line beginning with # is a comment and conventionally explains what is being
done or tested at the start of a new section of the script.
Commands are executed one at a time, and errors are checked for each command;
if any command fails unexpectedly, no subsequent commands in the script are
executed. The command prefix ! indicates that the command on the rest of the
line (typically go or a matching predicate) must fail instead of succeeding.
The command prefix ? indicates that the command may or may not succeed, but the
script should continue regardless.
The command prefix [cond] indicates that the command on the rest of the line
should only run when the condition is satisfied.
A condition can be negated: [!root] means to run the rest of the line only if
the user is not root. Multiple conditions may be given for a single command,
for example, '[linux] [amd64] skip'. The command will run if all conditions are
satisfied.
When TestScript runs a script and the script fails, by default TestScript shows
the execution of the most recent phase of the script (since the last # comment)
and only shows the # comments for earlier phases.
Note also that in reported output, the actual name of the per-script temporary directory
has been consistently replaced with the literal string $WORK.
The available commands are:
cat files...
concatenate files and print to the script's stdout buffer
cc args...
run the platform C compiler
cd dir
change the working directory
chmod perm paths...
change file mode bits
Changes the permissions of the named files or directories to
be equal to perm.
Only numerical permissions are supported.
cmp [-q] file1 file2
compare files for differences
By convention, file1 is the actual data and file2 is the
expected data.
The command succeeds if the file contents are identical.
File1 can be 'stdout' or 'stderr' to compare the stdout or
stderr buffer from the most recent command.
cmpenv [-q] file1 file2
compare files for differences, with environment expansion
By convention, file1 is the actual data and file2 is the
expected data.
The command succeeds if the file contents are identical
after substituting variables from the script environment.
File1 can be 'stdout' or 'stderr' to compare the script's
stdout or stderr buffer.
cp src... dst
copy files to a target file or directory
src can include 'stdout' or 'stderr' to copy from the
script's stdout or stderr buffer.
echo string...
display a line of text
env [key[=value]...]
set or log the values of environment variables
With no arguments, print the script environment to the log.
Otherwise, add the listed key=value pairs to the environment
or print the listed keys.
exec program [args...] [&]
run an executable program with arguments
Note that 'exec' does not terminate the script (unlike Unix
shells).
exists [-readonly] [-exec] file...
check that files exist
go [args...] [&]
run the 'go' program provided by the script host
grep [-count=N] [-q] 'pattern' file
find lines in a file that match a pattern
The command succeeds if at least one match (or the exact
count, if given) is found.
The -q flag suppresses printing of matches.
help [-v] name...
log help text for commands and conditions
To display help for a specific condition, enclose it in
brackets: 'help [amd64]'.
To display complete documentation when listing all commands,
pass the -v flag.
mkdir path...
create directories, if they do not already exist
Unlike Unix mkdir, parent directories are always created if
needed.
mv old new
rename a file or directory to a new path
OS-specific restrictions may apply when old and new are in
different directories.
replace [old new]... file
replace strings in a file
The 'old' and 'new' arguments are unquoted as if in quoted
Go strings.
rm path...
remove a file or directory
If the path is a directory, its contents are removed
recursively.
skip [msg]
skip the current test
sleep duration [&]
sleep for a specified duration
The duration must be given as a Go time.Duration string.
stderr [-count=N] [-q] 'pattern' file
find lines in the stderr buffer that match a pattern
The command succeeds if at least one match (or the exact
count, if given) is found.
The -q flag suppresses printing of matches.
stdout [-count=N] [-q] 'pattern' file
find lines in the stdout buffer that match a pattern
The command succeeds if at least one match (or the exact
count, if given) is found.
The -q flag suppresses printing of matches.
stop [msg]
stop execution of the script
The message is written to the script log, but no error is
reported from the script engine.
symlink path -> target
create a symlink
Creates path as a symlink to target.
The '->' token (like in 'ls -l' output on Unix) is required.
wait
wait for completion of background commands
Waits for all background commands to complete.
The output (and any error) from each command is printed to
the log in the order in which the commands were started.
After the call to 'wait', the script's stdout and stderr
buffers contain the concatenation of the background
commands' outputs.
The available conditions are:
[GOARCH:*]
runtime.GOARCH == <suffix>
[GODEBUG:*]
GODEBUG contains <suffix>
[GOEXPERIMENT:*]
GOEXPERIMENT <suffix> is enabled
[GOOS:*]
runtime.GOOS == <suffix>
[asan]
GOOS/GOARCH supports -asan
[buildmode:*]
go supports -buildmode=<suffix>
[cgo]
host CGO_ENABLED
[cgolinkext]
platform requires external linking for cgo
[compiler:*]
runtime.Compiler == <suffix>
[cross]
cmd/go GOOS/GOARCH != GOHOSTOS/GOHOSTARCH
[exec:*]
<suffix> names an executable in the test binary's PATH
[fuzz]
GOOS/GOARCH supports -fuzz
[fuzz-instrumented]
GOOS/GOARCH supports -fuzz with instrumentation
[go-builder]
GO_BUILDER_NAME is non-empty
[link]
testenv.HasLink()
[msan]
GOOS/GOARCH supports -msan
[mustlinkext]
platform always requires external linking
[pielinkext]
platform requires external linking for PIE
[race]
GOOS/GOARCH supports -race
[root]
os.Geteuid() == 0
[short]
testing.Short()
[symlink]
testenv.HasSymlink()
[verbose]
testing.Verbose()

View File

@@ -6,8 +6,9 @@
[!symlink] skip
# Symlink the compiler to a local path
env TEST_GOROOT=$GOROOT
env GOROOT=$WORK/goroot1
symlink $GOROOT -> $TESTGO_GOROOT
symlink $GOROOT -> $TEST_GOROOT
# Set up fresh GOCACHE
env GOCACHE=$WORK/gocache1
@@ -18,7 +19,7 @@ go build -o binary1 -trimpath -x main.go
# Now repeat the same process with the compiler at a different local path
env GOROOT=$WORK/goroot2
symlink $GOROOT -> $TESTGO_GOROOT
symlink $GOROOT -> $TEST_GOROOT
env GOCACHE=$WORK/gocache2
mkdir $GOCACHE

View File

@@ -1,4 +1,6 @@
env GO111MODULE=off
env GOPATH=$WORK/gopath
cd $WORK/gopath/src
# Test that cached test results are invalidated in response to
# changes to the external inputs to the test.
@@ -103,7 +105,7 @@ go test testcache -run=ExternalFile
go test testcache -run=ExternalFile
stdout '\(cached\)'
rm $WORK/external.txt
rm external.txt
go test testcache -run=ExternalFile
stdout '\(cached\)'
@@ -191,20 +193,20 @@ go test testcache -run=Exec
go test testcache -run=Exec
stdout '\(cached\)'
-- testcache/file.txt --
-- gopath/src/testcache/file.txt --
xx
-- 4x.txt --
-- gopath/src/4x.txt --
xxxx
-- 6x.txt --
-- gopath/src/6x.txt --
xxxxxx
-- 2y.txt --
-- gopath/src/2y.txt --
yy
-- $WORK/external.txt --
-- external.txt --
This file is outside of GOPATH.
-- testcache/script.sh --
-- gopath/src/testcache/script.sh --
#!/bin/sh
exit 0
-- testcache/hello.go --
-- gopath/src/testcache/hello.go --
package testcache
import "fmt"
@@ -216,7 +218,7 @@ func HelloWorld(name string) string {
return fmt.Sprintf("Hello, %s!", name)
}
-- testcache/testcache_test.go --
-- gopath/src/testcache/testcache_test.go --
// Copyright 2017 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.
@@ -331,7 +333,7 @@ func TestCoverageCache(t *testing.T) {
}
}
-- mkold.go --
-- gopath/src/mkold.go --
package main
import (