Skip to content

Commit 6f9063f

Browse files
Juneezeeanik120
authored andcommitted
test: use T.TempDir to create temporary test directory (#1004)
This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <[email protected]> Upstream-commit: 43e43240dd9c32dcb7742e96afb1ab3fd63a9ce2 Upstream-repository: operator-registry
1 parent 9d43f72 commit 6f9063f

File tree

9 files changed

+18
-45
lines changed

9 files changed

+18
-45
lines changed

staging/operator-registry/alpha/action/migrate_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func TestMigrate(t *testing.T) {
3737
err := generateSqliteFile(dbFile, sqliteBundles)
3838
require.NoError(t, err)
3939

40-
reg, err := newMigrateRegistry(sqliteBundles)
40+
reg, err := newMigrateRegistry(t, sqliteBundles)
4141
require.NoError(t, err)
4242

4343
specs := []spec{
@@ -118,8 +118,8 @@ func TestMigrate(t *testing.T) {
118118
}
119119
}
120120

121-
func newMigrateRegistry(imageMap map[image.Reference]string) (image.Registry, error) {
122-
subSqliteImage, err := generateSqliteFS(imageMap)
121+
func newMigrateRegistry(t *testing.T, imageMap map[image.Reference]string) (image.Registry, error) {
122+
subSqliteImage, err := generateSqliteFS(t, imageMap)
123123
if err != nil {
124124
return nil, err
125125
}

staging/operator-registry/alpha/action/render_test.go

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func TestRender(t *testing.T) {
3333
assertion require.ErrorAssertionFunc
3434
}
3535

36-
reg, err := newRegistry()
36+
reg, err := newRegistry(t)
3737
require.NoError(t, err)
3838
foov1csv, err := bundleImageV1.ReadFile("testdata/foo-bundle-v0.1.0/manifests/foo.v0.1.0.csv.yaml")
3939
require.NoError(t, err)
@@ -563,7 +563,7 @@ func TestAllowRefMask(t *testing.T) {
563563
expectErr error
564564
}
565565

566-
reg, err := newRegistry()
566+
reg, err := newRegistry(t)
567567
require.NoError(t, err)
568568

569569
dir := t.TempDir()
@@ -766,13 +766,13 @@ var bundleImageV2NoCSVRelatedImages embed.FS
766766
//go:embed testdata/foo-index-v0.2.0-declcfg/foo/*
767767
var declcfgImage embed.FS
768768

769-
func newRegistry() (image.Registry, error) {
769+
func newRegistry(t *testing.T) (image.Registry, error) {
770770
imageMap := map[image.Reference]string{
771771
image.SimpleReference("test.registry/foo-operator/foo-bundle:v0.1.0"): "testdata/foo-bundle-v0.1.0",
772772
image.SimpleReference("test.registry/foo-operator/foo-bundle:v0.2.0"): "testdata/foo-bundle-v0.2.0",
773773
}
774774

775-
subSqliteImage, err := generateSqliteFS(imageMap)
775+
subSqliteImage, err := generateSqliteFS(t, imageMap)
776776
if err != nil {
777777
return nil, err
778778
}
@@ -828,12 +828,8 @@ func newRegistry() (image.Registry, error) {
828828
}, nil
829829
}
830830

831-
func generateSqliteFS(imageMap map[image.Reference]string) (fs.FS, error) {
832-
dir, err := os.MkdirTemp("", "opm-render-test-")
833-
if err != nil {
834-
return nil, err
835-
}
836-
defer os.RemoveAll(dir)
831+
func generateSqliteFS(t *testing.T, imageMap map[image.Reference]string) (fs.FS, error) {
832+
dir := t.TempDir()
837833

838834
dbFile := filepath.Join(dir, "index.db")
839835
if err := generateSqliteFile(dbFile, imageMap); err != nil {

staging/operator-registry/alpha/property/property_test.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,7 @@ func TestFile_GetData(t *testing.T) {
209209

210210
for _, s := range specs {
211211
t.Run(s.name, func(t *testing.T) {
212-
dir, err := ioutil.TempDir("", "operator-registry-test-file-")
213-
require.NoError(t, err)
214-
defer os.RemoveAll(dir)
212+
dir := t.TempDir()
215213

216214
if s.createFile != nil {
217215
require.NoError(t, s.createFile(dir))

staging/operator-registry/pkg/image/mock_test.go

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package image
22

33
import (
44
"context"
5-
"io/ioutil"
65
"os"
76
"path/filepath"
87
"testing"
@@ -16,9 +15,7 @@ func TestMockRegistry(t *testing.T) {
1615
dne := SimpleReference("dne")
1716
ctx := context.Background()
1817

19-
tmpDir, err := ioutil.TempDir("", "reg-test-mock-")
20-
require.NoError(t, err)
21-
defer os.RemoveAll(tmpDir)
18+
tmpDir := t.TempDir()
2219

2320
r := MockRegistry{
2421
RemoteImages: map[Reference]*MockImage{
@@ -44,7 +41,7 @@ func TestMockRegistry(t *testing.T) {
4441

4542
// Test unpack and labels of unpulled ref
4643
require.Error(t, r.Unpack(ctx, exists, tmpDir))
47-
_, err = r.Labels(ctx, exists)
44+
_, err := r.Labels(ctx, exists)
4845
require.Error(t, err)
4946

5047
// Test pull of existing ref

staging/operator-registry/pkg/lib/bundle/generate_test.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,7 @@ COPY x/y/z /metadata/
181181
}
182182

183183
func TestCopyYamlOutput(t *testing.T) {
184-
testOutputDir, _ := ioutil.TempDir("./", "test-generate")
185-
defer os.RemoveAll(testOutputDir)
184+
testOutputDir := t.TempDir()
186185

187186
testContent := []byte{0, 1, 0, 0}
188187
testManifestDir := "./testdata/generate/manifests"
@@ -224,8 +223,7 @@ func TestCopyYamlOutput_NoOutputDir(t *testing.T) {
224223
}
225224

226225
func TestCopyYamlOutput_NestedCopy(t *testing.T) {
227-
testOutputDir, _ := ioutil.TempDir("./", "test-generate")
228-
defer os.RemoveAll(testOutputDir)
226+
testOutputDir := t.TempDir()
229227

230228
testContent := []byte{0, 1, 0, 0}
231229
testManifestDir := "./testdata/generate/nested_manifests"

staging/operator-registry/pkg/lib/registry/registry_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -630,8 +630,7 @@ func TestCheckForBundles(t *testing.T) {
630630

631631
for _, tt := range tests {
632632
t.Run(tt.description, func(t *testing.T) {
633-
tmpdir, err := os.MkdirTemp(".", "tmpdir-*")
634-
defer os.RemoveAll(tmpdir)
633+
tmpdir := t.TempDir()
635634
db, cleanup := CreateTestDb(t)
636635
defer cleanup()
637636
load, err := sqlite.NewSQLLiteLoader(db)

staging/operator-registry/pkg/registry/populator_test.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,9 +1184,7 @@ func TestDeprecatePackage(t *testing.T) {
11841184
}
11851185

11861186
func TestAddAfterDeprecate(t *testing.T) {
1187-
tmpdir, err := os.MkdirTemp(".", "add-after-deprecate-*")
1188-
require.NoError(t, err)
1189-
defer os.RemoveAll(tmpdir)
1187+
tmpdir := t.TempDir()
11901188

11911189
/*
11921190
(0.1) 0.1.2 <- 0.1.1 <- 0.1.0

staging/operator-registry/pkg/sqlite/conversion_test.go

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ package sqlite
22

33
import (
44
"context"
5-
"io/ioutil"
6-
"os"
75
"path/filepath"
86
"testing"
97

@@ -12,11 +10,7 @@ import (
1210
)
1311

1412
func TestToModel(t *testing.T) {
15-
tmpDir, err := ioutil.TempDir("", "server_test-")
16-
if err != nil {
17-
logrus.Fatal(err)
18-
}
19-
defer os.RemoveAll(tmpDir)
13+
tmpDir := t.TempDir()
2014
dbPath := filepath.Join(tmpDir, "test.db")
2115

2216
db, err := Open(dbPath)

staging/operator-registry/pkg/sqlite/directory_test.go

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package sqlite
22

33
import (
44
"context"
5-
"io/ioutil"
65
"os"
76
"path/filepath"
87
"testing"
@@ -38,13 +37,7 @@ func TestDirectoryLoaderWithBadPackageData(t *testing.T) {
3837
require.NoError(t, store.Migrate(context.TODO()))
3938

4039
// Copy golden manifests to a temp dir
41-
dir, err := ioutil.TempDir("testdata", "manifests-")
42-
require.NoError(t, err)
43-
defer func() {
44-
if err := os.RemoveAll(dir); err != nil {
45-
t.Fatal(err)
46-
}
47-
}()
40+
dir := t.TempDir()
4841
require.NoError(t, copy.Copy("./testdata/loader_data", dir))
4942

5043
// Point the first channel at a CSV that doesn't exist

0 commit comments

Comments
 (0)