Skip to content

testing: allow specify temp dir by GOTMPDIR environment variable #74844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/cmd/go/alldocs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions src/cmd/go/internal/help/helpdoc.go
Original file line number Diff line number Diff line change
Expand Up @@ -573,8 +573,9 @@ General-purpose environment variables:
The name of checksum database to use and optionally its public key and
URL. See https://golang.org/ref/mod#authenticating.
GOTMPDIR
The directory where the go command will write
temporary source files, packages, and binaries.
The directory where the go command will write temporary source files,
packages, and binaries.
Also used to specify the prefix of TmpDir function in testing package.
GOTOOLCHAIN
Controls which Go toolchain is used. See https://go.dev/doc/toolchain.
GOVCS
Expand Down
2 changes: 1 addition & 1 deletion src/testing/testing.go
Original file line number Diff line number Diff line change
Expand Up @@ -1362,7 +1362,7 @@ func (c *common) TempDir() string {
return -1
}
pattern = strings.Map(mapper, pattern)
c.tempDir, c.tempDirErr = os.MkdirTemp("", pattern)
c.tempDir, c.tempDirErr = os.MkdirTemp(os.Getenv("GOTMPDIR"), pattern)
if c.tempDirErr == nil {
c.Cleanup(func() {
if err := removeAll(c.tempDir); err != nil {
Expand Down
34 changes: 34 additions & 0 deletions src/testing/testing_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,40 @@ func testTempDir(t *testing.T) {
}
}

func TestTempDirGOTMPDIR(t *testing.T) {
customTmpDir := filepath.Join(os.TempDir(), "custom-gotmpdir-test")
if err := os.MkdirAll(customTmpDir, 0777); err != nil {
t.Fatal(err)
}
defer os.RemoveAll(customTmpDir)

t.Setenv("GOTMPDIR", customTmpDir)

dir := t.TempDir()
if dir == "" {
t.Fatal("expected dir")
}

if !strings.HasPrefix(dir, customTmpDir) {
t.Errorf("TempDir did not use GOTMPDIR: got %q, want prefix %q", dir, customTmpDir)
}

fi, err := os.Stat(dir)
if err != nil {
t.Fatal(err)
}
if !fi.IsDir() {
t.Errorf("dir %q is not a dir", dir)
}

t.Setenv("GOTMPDIR", "another-custom-gotmpdir-test")

dir2 := t.TempDir()
if filepath.Dir(dir) != filepath.Dir(dir2) {
t.Fatalf("calls to TempDir after changed GOTMPDIR do not share a parent; got %q, %q", dir, dir2)
}
}

func TestSetenv(t *testing.T) {
tests := []struct {
name string
Expand Down