From 8cf76f5e113879430ca77bafc579bc3f9e3c8ff1 Mon Sep 17 00:00:00 2001
From: Eng Zer Jun <engzerjun@gmail.com>
Date: Sun, 30 Jan 2022 00:24:56 +0800
Subject: [PATCH] test: use `T.TempDir` to create temporary test directory
The directory created by `T.TempDir` is automatically removed when the
test and all its subtests complete.
Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
---
backend/drive/drive_internal_test.go | 18 +++---------------
backend/union/union_internal_test.go | 18 ++++--------------
backend/union/union_test.go | 18 ++++++------------
cmd/mountlib/rc_test.go | 11 +++--------
cmd/serve/restic/restic_appendonly_test.go | 11 +----------
cmd/serve/restic/restic_privaterepos_test.go | 11 +----------
cmdtest/cmdtest_test.go | 3 +--
fs/rc/webgui/rc_test.go | 6 ++----
lib/file/file_test.go | 18 +++---------------
lib/file/mkdir_windows_test.go | 6 ++----
10 files changed, 26 insertions(+), 94 deletions(-)
diff --git a/backend/drive/drive_internal_test.go b/backend/drive/drive_internal_test.go
index cd06d15cd..2a21fd574 100644
--- a/backend/drive/drive_internal_test.go
+++ b/backend/drive/drive_internal_test.go
@@ -422,11 +422,7 @@ func (f *Fs) InternalTestCopyID(t *testing.T) {
require.NoError(t, err)
o := obj.(*Object)
- dir, err := ioutil.TempDir("", "rclone-drive-copyid-test")
- require.NoError(t, err)
- defer func() {
- _ = os.RemoveAll(dir)
- }()
+ dir := t.TempDir()
checkFile := func(name string) {
filePath := filepath.Join(dir, name)
@@ -491,19 +487,11 @@ func (f *Fs) InternalTestAgeQuery(t *testing.T) {
subFs, isDriveFs := subFsResult.(*Fs)
require.True(t, isDriveFs)
- tempDir1, err := ioutil.TempDir("", "rclone-drive-agequery1-test")
- require.NoError(t, err)
- defer func() {
- _ = os.RemoveAll(tempDir1)
- }()
+ tempDir1 := t.TempDir()
tempFs1, err := fs.NewFs(defCtx, tempDir1)
require.NoError(t, err)
- tempDir2, err := ioutil.TempDir("", "rclone-drive-agequery2-test")
- require.NoError(t, err)
- defer func() {
- _ = os.RemoveAll(tempDir2)
- }()
+ tempDir2 := t.TempDir()
tempFs2, err := fs.NewFs(defCtx, tempDir2)
require.NoError(t, err)
diff --git a/backend/union/union_internal_test.go b/backend/union/union_internal_test.go
index 8171f593f..22443dd05 100644
--- a/backend/union/union_internal_test.go
+++ b/backend/union/union_internal_test.go
@@ -4,8 +4,6 @@ import (
"bytes"
"context"
"fmt"
- "io/ioutil"
- "os"
"testing"
"time"
@@ -20,19 +18,12 @@ import (
)
// MakeTestDirs makes directories in /tmp for testing
-func MakeTestDirs(t *testing.T, n int) (dirs []string, clean func()) {
+func MakeTestDirs(t *testing.T, n int) (dirs []string) {
for i := 1; i <= n; i++ {
- dir, err := ioutil.TempDir("", fmt.Sprintf("rclone-union-test-%d", n))
- require.NoError(t, err)
+ dir := t.TempDir()
dirs = append(dirs, dir)
}
- clean = func() {
- for _, dir := range dirs {
- err := os.RemoveAll(dir)
- assert.NoError(t, err)
- }
- }
- return dirs, clean
+ return dirs
}
func (f *Fs) TestInternalReadOnly(t *testing.T) {
@@ -95,8 +86,7 @@ func TestMoveCopy(t *testing.T) {
t.Skip("Skipping as -remote set")
}
ctx := context.Background()
- dirs, clean := MakeTestDirs(t, 1)
- defer clean()
+ dirs := MakeTestDirs(t, 1)
fsString := fmt.Sprintf(":union,upstreams='%s :memory:bucket':", dirs[0])
f, err := fs.NewFs(ctx, fsString)
require.NoError(t, err)
diff --git a/backend/union/union_test.go b/backend/union/union_test.go
index c58936e9d..8b69c4c27 100644
--- a/backend/union/union_test.go
+++ b/backend/union/union_test.go
@@ -27,8 +27,7 @@ func TestStandard(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + " " + dirs[2]
name := "TestUnion"
fstests.Run(t, &fstests.Opt{
@@ -49,8 +48,7 @@ func TestRO(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + ":ro " + dirs[2] + ":ro"
name := "TestUnionRO"
fstests.Run(t, &fstests.Opt{
@@ -71,8 +69,7 @@ func TestNC(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + ":nc " + dirs[2] + ":nc"
name := "TestUnionNC"
fstests.Run(t, &fstests.Opt{
@@ -93,8 +90,7 @@ func TestPolicy1(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + " " + dirs[2]
name := "TestUnionPolicy1"
fstests.Run(t, &fstests.Opt{
@@ -115,8 +111,7 @@ func TestPolicy2(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + " " + dirs[2]
name := "TestUnionPolicy2"
fstests.Run(t, &fstests.Opt{
@@ -137,8 +132,7 @@ func TestPolicy3(t *testing.T) {
if *fstest.RemoteName != "" {
t.Skip("Skipping as -remote set")
}
- dirs, clean := union.MakeTestDirs(t, 3)
- defer clean()
+ dirs := union.MakeTestDirs(t, 3)
upstreams := dirs[0] + " " + dirs[1] + " " + dirs[2]
name := "TestUnionPolicy3"
fstests.Run(t, &fstests.Opt{
diff --git a/cmd/mountlib/rc_test.go b/cmd/mountlib/rc_test.go
index 030a89a5a..5513ce4a7 100644
--- a/cmd/mountlib/rc_test.go
+++ b/cmd/mountlib/rc_test.go
@@ -35,19 +35,14 @@ func TestRc(t *testing.T) {
getMountTypes := rc.Calls.Get("mount/types")
assert.NotNil(t, getMountTypes)
- localDir, err := ioutil.TempDir("", "rclone-mountlib-localDir")
- require.NoError(t, err)
- defer func() { _ = os.RemoveAll(localDir) }()
- err = ioutil.WriteFile(filepath.Join(localDir, "file.txt"), []byte("hello"), 0666)
+ localDir := t.TempDir()
+ err := ioutil.WriteFile(filepath.Join(localDir, "file.txt"), []byte("hello"), 0666)
require.NoError(t, err)
- mountPoint, err := ioutil.TempDir("", "rclone-mountlib-mountPoint")
- require.NoError(t, err)
+ mountPoint := t.TempDir()
if runtime.GOOS == "windows" {
// Windows requires the mount point not to exist
require.NoError(t, os.RemoveAll(mountPoint))
- } else {
- defer func() { _ = os.RemoveAll(mountPoint) }()
}
out, err := getMountTypes.Fn(ctx, nil)
diff --git a/cmd/serve/restic/restic_appendonly_test.go b/cmd/serve/restic/restic_appendonly_test.go
index f2090b2e4..c190da329 100644
--- a/cmd/serve/restic/restic_appendonly_test.go
+++ b/cmd/serve/restic/restic_appendonly_test.go
@@ -7,9 +7,7 @@ import (
"crypto/rand"
"encoding/hex"
"io"
- "io/ioutil"
"net/http"
- "os"
"strings"
"testing"
@@ -113,14 +111,7 @@ func TestResticHandler(t *testing.T) {
}
// setup rclone with a local backend in a temporary directory
- tempdir, err := ioutil.TempDir("", "rclone-restic-test-")
- require.NoError(t, err)
-
- // make sure the tempdir is properly removed
- defer func() {
- err := os.RemoveAll(tempdir)
- require.NoError(t, err)
- }()
+ tempdir := t.TempDir()
// globally set append-only mode
prev := appendOnly
diff --git a/cmd/serve/restic/restic_privaterepos_test.go b/cmd/serve/restic/restic_privaterepos_test.go
index 7fd2a5c6b..fd59e181d 100644
--- a/cmd/serve/restic/restic_privaterepos_test.go
+++ b/cmd/serve/restic/restic_privaterepos_test.go
@@ -7,9 +7,7 @@ import (
"context"
"crypto/rand"
"io"
- "io/ioutil"
"net/http"
- "os"
"strings"
"testing"
@@ -35,14 +33,7 @@ func TestResticPrivateRepositories(t *testing.T) {
require.NoError(t, err)
// setup rclone with a local backend in a temporary directory
- tempdir, err := ioutil.TempDir("", "rclone-restic-test-")
- require.NoError(t, err)
-
- // make sure the tempdir is properly removed
- defer func() {
- err := os.RemoveAll(tempdir)
- require.NoError(t, err)
- }()
+ tempdir := t.TempDir()
// globally set private-repos mode & test user
prev := privateRepos
diff --git a/cmdtest/cmdtest_test.go b/cmdtest/cmdtest_test.go
index f8c6adbbb..1d0c8487e 100644
--- a/cmdtest/cmdtest_test.go
+++ b/cmdtest/cmdtest_test.go
@@ -102,8 +102,7 @@ var envInitial []string
// sets testConfig to testFolder/rclone.config.
func createTestEnvironment(t *testing.T) {
//Set temporary folder for config and test data
- tempFolder, err := ioutil.TempDir("", "rclone_cmdtest_")
- require.NoError(t, err)
+ tempFolder := t.TempDir()
testFolder = filepath.ToSlash(tempFolder)
// Set path to temporary config file
diff --git a/fs/rc/webgui/rc_test.go b/fs/rc/webgui/rc_test.go
index 72de1b34b..4ba6b5cdb 100644
--- a/fs/rc/webgui/rc_test.go
+++ b/fs/rc/webgui/rc_test.go
@@ -2,7 +2,6 @@ package webgui
import (
"context"
- "io/ioutil"
"os"
"path/filepath"
"strings"
@@ -24,13 +23,12 @@ func init() {
}
func setCacheDir(t *testing.T) string {
- cacheDir, err := ioutil.TempDir("", "rclone-cache-dir")
- assert.Nil(t, err)
+ cacheDir := t.TempDir()
PluginsPath = filepath.Join(cacheDir, "plugins")
pluginsConfigPath = filepath.Join(cacheDir, "config")
loadedPlugins = newPlugins(availablePluginsJSONPath)
- err = loadedPlugins.readFromFile()
+ err := loadedPlugins.readFromFile()
assert.Nil(t, err)
return cacheDir
}
diff --git a/lib/file/file_test.go b/lib/file/file_test.go
index 4aef72650..933fb4ca7 100644
--- a/lib/file/file_test.go
+++ b/lib/file/file_test.go
@@ -13,15 +13,6 @@ import (
"github.com/stretchr/testify/require"
)
-// Create a test directory then tidy up
-func testDir(t *testing.T) (string, func()) {
- dir, err := ioutil.TempDir("", "rclone-test")
- require.NoError(t, err)
- return dir, func() {
- assert.NoError(t, os.RemoveAll(dir))
- }
-}
-
// This lists dir and checks the listing is as expected without checking the size
func checkListingNoSize(t *testing.T, dir string, want []string) {
var got []string
@@ -46,8 +37,7 @@ func checkListing(t *testing.T, dir string, want []string) {
// Test we can rename an open file
func TestOpenFileRename(t *testing.T) {
- dir, tidy := testDir(t)
- defer tidy()
+ dir := t.TempDir()
filepath := path.Join(dir, "file1")
f, err := Create(filepath)
@@ -71,8 +61,7 @@ func TestOpenFileRename(t *testing.T) {
// Test we can delete an open file
func TestOpenFileDelete(t *testing.T) {
- dir, tidy := testDir(t)
- defer tidy()
+ dir := t.TempDir()
filepath := path.Join(dir, "file1")
f, err := Create(filepath)
@@ -103,8 +92,7 @@ func TestOpenFileDelete(t *testing.T) {
// Smoke test the Open, OpenFile and Create functions
func TestOpenFileOperations(t *testing.T) {
- dir, tidy := testDir(t)
- defer tidy()
+ dir := t.TempDir()
filepath := path.Join(dir, "file1")
diff --git a/lib/file/mkdir_windows_test.go b/lib/file/mkdir_windows_test.go
index 9342f3c2e..e6daf1d49 100644
--- a/lib/file/mkdir_windows_test.go
+++ b/lib/file/mkdir_windows_test.go
@@ -15,8 +15,7 @@ import (
// Basic test from golang's os/path_test.go
func TestMkdirAll(t *testing.T) {
- tmpDir, tidy := testDir(t)
- defer tidy()
+ tmpDir := t.TempDir()
path := tmpDir + "/dir/./dir2"
err := MkdirAll(path, 0777)
@@ -99,8 +98,7 @@ func checkMkdirAllSubdirs(t *testing.T, path string, valid bool, errormsg string
// Testing paths on existing drive
func TestMkdirAllOnDrive(t *testing.T) {
- path, tidy := testDir(t)
- defer tidy()
+ path := t.TempDir()
dir, err := os.Stat(path)
require.NoError(t, err)