[no-release-notes] Change some tests to use t.TempDir instead of os.T…

…empDir so that their temporary files get cleaned up.
dolthub · Jan 25, 2025 · 41fe1ac · 41fe1ac
1 parent e75e954
commit 41fe1ac
Show file tree

Hide file tree

Showing 26 changed files with 96 additions and 102 deletions.
diff --git a/go/cmd/dolt/commands/signed_commits_test.go b/go/cmd/dolt/commands/signed_commits_test.go
@@ -45,10 +45,9 @@ func importKey(t *testing.T, ctx context.Context) {
 }
 
 func setupTestDB(t *testing.T, ctx context.Context, fs filesys.Filesys) string {
-	dir, err := os.MkdirTemp(os.TempDir(), "signed_commits")
-	require.NoError(t, err)
+	dir := t.TempDir()
 	dbDir := filepath.Join(dir, "db")
-	err = filesys.CopyDir("testdata/signed_commits/db/", dbDir, fs)
+	err := filesys.CopyDir("testdata/signed_commits/db/", dbDir, fs)
 	require.NoError(t, err)
 
 	log.Println(dbDir)
@@ -90,7 +89,7 @@ func TestSignAndVerifyCommit(t *testing.T) {
 			apr, err := cli.CreateCommitArgParser().Parse(test.commitArgs)
 			require.NoError(t, err)
 
-			_, err = execCommand(ctx, dbDir, CommitCmd{}, test.commitArgs, apr, map[string]string{}, global)
+			_, err = execCommand(ctx, t, dbDir, CommitCmd{}, test.commitArgs, apr, map[string]string{}, global)
 
 			if test.expectErr {
 				require.Error(t, err)
@@ -103,14 +102,14 @@ func TestSignAndVerifyCommit(t *testing.T) {
 			apr, err = cli.CreateLogArgParser(false).Parse(args)
 			require.NoError(t, err)
 
-			logOutput, err := execCommand(ctx, dbDir, LogCmd{}, args, apr, map[string]string{}, global)
+			logOutput, err := execCommand(ctx, t, dbDir, LogCmd{}, args, apr, map[string]string{}, global)
 			require.NoError(t, err)
 			require.Contains(t, logOutput, "Good signature from \"Test User <[email protected]>\"")
 		})
 	}
 }
 
-func execCommand(ctx context.Context, wd string, cmd cli.Command, args []string, apr *argparser.ArgParseResults, local, global map[string]string) (output string, err error) {
+func execCommand(ctx context.Context, t *testing.T, wd string, cmd cli.Command, args []string, apr *argparser.ArgParseResults, local, global map[string]string) (output string, err error) {
 	err = os.Chdir(wd)
 	if err != nil {
 		err = fmt.Errorf("error changing directory to %s: %w", wd, err)
@@ -157,7 +156,7 @@ func execCommand(ctx context.Context, wd string, cmd cli.Command, args []string,
 
 	initialOut := os.Stdout
 	initialErr := os.Stderr
-	f, err := os.CreateTemp(os.TempDir(), "signed-commit-test-*")
+	f, err := os.CreateTemp(t.TempDir(), "signed-commit-test-*")
 	if err != nil {
 		err = fmt.Errorf("error creating temp file: %w", err)
 		return

diff --git a/go/libraries/doltcore/doltdb/commit_hooks_test.go b/go/libraries/doltcore/doltdb/commit_hooks_test.go
@@ -43,7 +43,7 @@ func TestPushOnWriteHook(t *testing.T) {
 	ctx := context.Background()
 
 	// destination repo
-	testDir, err := test.ChangeToTestDir("TestReplicationDest")
+	testDir, err := test.ChangeToTestDir(t.TempDir(), "TestReplicationDest")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")
@@ -62,7 +62,7 @@ func TestPushOnWriteHook(t *testing.T) {
 	destDB, _ := LoadDoltDB(context.Background(), types.Format_Default, LocalDirDoltDB, filesys.LocalFS)
 
 	// source repo
-	testDir, err = test.ChangeToTestDir("TestReplicationSource")
+	testDir, err = test.ChangeToTestDir(t.TempDir(), "TestReplicationSource")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")
@@ -183,7 +183,7 @@ func TestAsyncPushOnWrite(t *testing.T) {
 	ctx := context.Background()
 
 	// destination repo
-	testDir, err := test.ChangeToTestDir("TestReplicationDest")
+	testDir, err := test.ChangeToTestDir(t.TempDir(), "TestReplicationDest")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")
@@ -202,7 +202,7 @@ func TestAsyncPushOnWrite(t *testing.T) {
 	destDB, _ := LoadDoltDB(context.Background(), types.Format_Default, LocalDirDoltDB, filesys.LocalFS)
 
 	// source repo
-	testDir, err = test.ChangeToTestDir("TestReplicationSource")
+	testDir, err = test.ChangeToTestDir(t.TempDir(), "TestReplicationSource")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")

diff --git a/go/libraries/doltcore/doltdb/doltdb_test.go b/go/libraries/doltcore/doltdb/doltdb_test.go
@@ -219,7 +219,7 @@ func TestEmptyInMemoryRepoCreation(t *testing.T) {
 }
 
 func TestLoadNonExistentLocalFSRepo(t *testing.T) {
-	_, err := test.ChangeToTestDir("TestLoadRepo")
+	_, err := test.ChangeToTestDir(t.TempDir(), "TestLoadRepo")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")
@@ -231,7 +231,7 @@ func TestLoadNonExistentLocalFSRepo(t *testing.T) {
 }
 
 func TestLoadBadLocalFSRepo(t *testing.T) {
-	testDir, err := test.ChangeToTestDir("TestLoadRepo")
+	testDir, err := test.ChangeToTestDir(t.TempDir(), "TestLoadRepo")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")
@@ -246,7 +246,7 @@ func TestLoadBadLocalFSRepo(t *testing.T) {
 }
 
 func TestLDNoms(t *testing.T) {
-	testDir, err := test.ChangeToTestDir("TestLoadRepo")
+	testDir, err := test.ChangeToTestDir(t.TempDir(), "TestLoadRepo")
 
 	if err != nil {
 		panic("Couldn't change the working directory to the test directory.")

diff --git a/go/libraries/doltcore/dtestutils/environment.go b/go/libraries/doltcore/dtestutils/environment.go
@@ -16,7 +16,6 @@ package dtestutils
 
 import (
 	"context"
-	"os"
 	"path/filepath"
 
 	"github.com/dolthub/dolt/go/libraries/doltcore/doltdb"
@@ -41,12 +40,7 @@ func CreateTestEnv() *env.DoltEnv {
 // CreateTestEnvForLocalFilesystem creates a new DoltEnv for testing, using a local FS, instead of an in-memory
 // filesystem, for persisting files. This is useful for tests that require a disk-based filesystem and will not
 // work correctly with an in-memory filesystem and in-memory blob store (e.g. dolt_undrop() tests).
-func CreateTestEnvForLocalFilesystem() *env.DoltEnv {
-	tempDir, err := os.MkdirTemp(os.TempDir(), "dolt-*")
-	if err != nil {
-		panic(err)
-	}
-
+func CreateTestEnvForLocalFilesystem(tempDir string) *env.DoltEnv {
 	fs, err := filesys.LocalFilesysWithWorkingDir(tempDir)
 	if err != nil {
 		panic(err)

diff --git a/go/libraries/doltcore/dtestutils/sql_server_driver/cmd.go b/go/libraries/doltcore/dtestutils/sql_server_driver/cmd.go
@@ -76,13 +76,9 @@ type DoltUser struct {
 var _ DoltCmdable = DoltUser{}
 var _ DoltDebuggable = DoltUser{}
 
-func NewDoltUser() (DoltUser, error) {
-	tmpdir, err := os.MkdirTemp("", "go-sql-server-driver-")
-	if err != nil {
-		return DoltUser{}, err
-	}
+func NewDoltUser(tmpdir string) (DoltUser, error) {
 	res := DoltUser{tmpdir}
-	err = res.DoltExec("config", "--global", "--add", "metrics.disabled", "true")
+	err := res.DoltExec("config", "--global", "--add", "metrics.disabled", "true")
 	if err != nil {
 		return DoltUser{}, err
 	}

diff --git a/go/libraries/doltcore/env/multi_repo_env_test.go b/go/libraries/doltcore/env/multi_repo_env_test.go
@@ -115,7 +115,7 @@ func initRepoWithRelativePath(t *testing.T, envPath string, hdp HomeDirProvider)
 }
 
 func TestMultiEnvForDirectory(t *testing.T) {
-	rootPath, err := test.ChangeToTestDir("TestDoltEnvAsMultiEnv")
+	rootPath, err := test.ChangeToTestDir(t.TempDir(), "TestDoltEnvAsMultiEnv")
 	require.NoError(t, err)
 
 	hdp := func() (string, error) { return rootPath, nil }
@@ -150,7 +150,7 @@ func TestMultiEnvForDirectory(t *testing.T) {
 }
 
 func TestMultiEnvForDirectoryWithMultipleRepos(t *testing.T) {
-	rootPath, err := test.ChangeToTestDir("TestDoltEnvAsMultiEnvWithMultipleRepos")
+	rootPath, err := test.ChangeToTestDir(t.TempDir(), "TestDoltEnvAsMultiEnvWithMultipleRepos")
 	require.NoError(t, err)
 
 	hdp := func() (string, error) { return rootPath, nil }
@@ -177,7 +177,7 @@ func TestMultiEnvForDirectoryWithMultipleRepos(t *testing.T) {
 }
 
 func initMultiEnv(t *testing.T, testName string, names []string) (string, HomeDirProvider, map[string]*DoltEnv) {
-	rootPath, err := test.ChangeToTestDir(testName)
+	rootPath, err := test.ChangeToTestDir(t.TempDir(), testName)
 	require.NoError(t, err)
 
 	hdp := func() (string, error) { return rootPath, nil }

diff --git a/go/libraries/doltcore/sqle/enginetest/dolt_harness.go b/go/libraries/doltcore/sqle/enginetest/dolt_harness.go
@@ -515,7 +515,7 @@ func (d *DoltHarness) newProvider() sql.MutableDatabaseProvider {
 
 	var dEnv *env.DoltEnv
 	if d.useLocalFilesystem {
-		dEnv = dtestutils.CreateTestEnvForLocalFilesystem()
+		dEnv = dtestutils.CreateTestEnvForLocalFilesystem(d.t.TempDir())
 	} else {
 		dEnv = dtestutils.CreateTestEnv()
 	}

diff --git a/go/libraries/events/event_flush_test.go b/go/libraries/events/event_flush_test.go
@@ -105,7 +105,7 @@ func TestEventFlushing(t *testing.T) {
 						fs := filesys.LocalFS
 
 						path := filepath.Join(dPath, evtPath)
-						dDir := testLib.TestDir(path)
+						dDir := testLib.TestDir(t.TempDir(), path)
 
 						ft = createFlushTester(fs, "", dDir)
 					}

diff --git a/go/libraries/utils/filesys/fs_test.go b/go/libraries/utils/filesys/fs_test.go
@@ -41,8 +41,8 @@ var filesysetmsToTest = map[string]Filesys{
 }
 
 func TestFilesystems(t *testing.T) {
-	dir := test.TestDir("filesys_test")
-	newLocation := test.TestDir("newLocation")
+	dir := test.TestDir(t.TempDir(), "filesys_test")
+	newLocation := test.TestDir(t.TempDir(), "newLocation")
 	subdir := filepath.Join(dir, "subdir")
 	subdirFile := filepath.Join(subdir, testSubdirFilename)
 	fp := filepath.Join(dir, testFilename)
@@ -186,7 +186,7 @@ func TestNewInMemFS(t *testing.T) {
 }
 
 func TestRecursiveFSIteration(t *testing.T) {
-	dir := test.TestDir("TestRecursiveFSIteration")
+	dir := test.TestDir(t.TempDir(), "TestRecursiveFSIteration")
 
 	for fsName, fs := range filesysetmsToTest {
 		var expectedDirs []string
@@ -215,7 +215,7 @@ func TestRecursiveFSIteration(t *testing.T) {
 }
 
 func TestFSIteration(t *testing.T) {
-	dir := test.TestDir("TestFSIteration")
+	dir := test.TestDir(t.TempDir(), "TestFSIteration")
 
 	for fsName, fs := range filesysetmsToTest {
 		var expectedDirs []string
@@ -249,7 +249,7 @@ func TestFSIteration(t *testing.T) {
 }
 
 func TestDeletes(t *testing.T) {
-	dir := test.TestDir("TestDeletes")
+	dir := test.TestDir(t.TempDir(), "TestDeletes")
 
 	for fsName, fs := range filesysetmsToTest {
 		var ignored []string

diff --git a/go/libraries/utils/test/files.go b/go/libraries/utils/test/files.go
@@ -22,27 +22,19 @@ import (
 )
 
 // TestDir creates a subdirectory inside the systems temp directory
-func TestDir(testName string) string {
-	id, err := uuid.NewRandom()
-
-	if err != nil {
-		panic(ShouldNeverHappen)
-	}
-
-	return filepath.Join(os.TempDir(), testName, id.String())
+func TestDir(dir, testName string) string {
+	return filepath.Join(dir, testName, uuid.NewString())
 }
 
 // ChangeToTestDir creates a new test directory and changes the current directory to be
-func ChangeToTestDir(testName string) (string, error) {
-	dir := TestDir(testName)
+func ChangeToTestDir(tempDir, testName string) (string, error) {
+	dir := TestDir(tempDir, testName)
 	err := os.MkdirAll(dir, os.ModePerm)
-
 	if err != nil {
 		return "", err
 	}
 
 	err = os.Chdir(dir)
-
 	if err != nil {
 		return "", err
 	}

diff --git a/go/libraries/utils/test/test_test.go b/go/libraries/utils/test/test_test.go
@@ -24,7 +24,7 @@ import (
 // test your tests so you can test while you test
 
 func TestLDTestUtils(t *testing.T) {
-	dir, err := ChangeToTestDir("TestLDTestUtils")
+	dir, err := ChangeToTestDir(t.TempDir(), "TestLDTestUtils")
 
 	if err != nil {
 		t.Fatal("Couldn't change to test dir")

diff --git a/go/performance/import_benchmarker/cmd/main.go b/go/performance/import_benchmarker/cmd/main.go
@@ -42,9 +42,16 @@ func main() {
 	if err != nil {
 		log.Fatalln(err)
 	}
+	defer os.RemoveAll(tmpdir)
+
+	userdir, err := os.MkdirTemp("", "import-benchmarker-")
+	if err != nil {
+		log.Fatalln(err)
+	}
+	defer os.RemoveAll(userdir)
 
 	results := new(ib.ImportResults)
-	u, err := driver.NewDoltUser()
+	u, err := driver.NewDoltUser(userdir)
 	for _, test := range def.Tests {
 		test.Results = results
 		test.InitWithTmpDir(tmpdir)
@@ -73,5 +80,4 @@ func main() {
 	} else {
 		fmt.Println(results.SqlDump())
 	}
-	os.Exit(0)
 }
diff --git a/go/performance/import_benchmarker/testdef.go b/go/performance/import_benchmarker/testdef.go
@@ -214,7 +214,7 @@ func (test *ImportTest) Run(t *testing.T) {
 		test.InitWithTmpDir(tmp)
 	}
 
-	u, err := driver.NewDoltUser()
+	u, err := driver.NewDoltUser(t.TempDir())
 	for _, r := range test.Repos {
 		if r.ExternalServer != nil {
 			err := test.RunExternalServerTests(r.Name, r.ExternalServer)

diff --git a/go/performance/sysbench/cmd/main.go b/go/performance/sysbench/cmd/main.go
@@ -52,9 +52,16 @@ func main() {
 	if err != nil {
 		log.Fatalln(err)
 	}
+	defer os.RemoveAll(tmpdir)
+
+	userdir, err := os.MkdirTemp("", "sysbench-user-dir_")
+	if err != nil {
+		log.Fatalln(err)
+	}
+	defer os.RemoveAll(userdir)
 
 	results := new(sysbench.Results)
-	u, err := driver.NewDoltUser()
+	u, err := driver.NewDoltUser(userdir)
 	for _, test := range defs.Tests {
 		test.InitWithTmpDir(tmpdir)
 
@@ -83,5 +90,4 @@ func main() {
 	} else {
 		fmt.Println(results.SqlDump())
 	}
-	os.Exit(0)
 }
diff --git a/go/performance/sysbench/testdef.go b/go/performance/sysbench/testdef.go
@@ -440,7 +440,7 @@ func (test *Script) Run(t *testing.T) {
 	}
 
 	results := new(Results)
-	u, err := driver.NewDoltUser()
+	u, err := driver.NewDoltUser(t.TempDir())
 	test.Results = results
 	test.InitWithTmpDir(tmpdir)
 	for _, r := range test.Repos {