Skip to content

Commit b2553e5

Browse files
committed
copier tests: fixup require/assert calls and format-specified errors
Fixup cases where we were passing a format specifier for the error detail when calling an assert or require helper function, but not using the variant of the helper function that expects a format specifier, and cases where we weren't passing a format specifier, but were using the variant that expects one. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
1 parent 4ac8195 commit b2553e5

2 files changed

Lines changed: 36 additions & 36 deletions

File tree

copier/copier_test.go

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ func testPut(ctx context.Context, t *testing.T, expectedError error) {
505505
if !reflect.DeepEqual(expected, fileList) && reflect.DeepEqual(moddedEnumeratedFiles(expected), moddedEnumeratedFiles(fileList)) {
506506
logrus.Warn("chmod() lost some bits and possibly timestamps on symlinks, otherwise we match the source archive")
507507
} else {
508-
require.Equal(t, expected, fileList, "list of files in context directory for archive %q under topdir %q should match the archived used to populate it", testArchives[i].name, topdir)
508+
require.Equalf(t, expected, fileList, "list of files in context directory for archive %q under topdir %q should match the archived used to populate it", testArchives[i].name, topdir)
509509
}
510510
})
511511
}
@@ -662,10 +662,10 @@ func testPut(ctx context.Context, t *testing.T, expectedError error) {
662662
}
663663
require.Nil(t, err, "unexpected error writing sample file", err)
664664
st, err := os.Stat(filepath.Join(tmp, "test"))
665-
require.Nilf(t, err, "unexpected error checking permissions of file", err)
666-
assert.Equalf(t, stripSetuidBit, st.Mode()&os.ModeSetuid == 0, "setuid bit was not set/stripped correctly")
667-
assert.Equalf(t, stripSetgidBit, st.Mode()&os.ModeSetgid == 0, "setgid bit was not set/stripped correctly")
668-
assert.Equalf(t, stripStickyBit, st.Mode()&os.ModeSticky == 0, "sticky bit was not set/stripped correctly")
665+
require.Nil(t, err, "unexpected error checking permissions of file", err)
666+
assert.Equal(t, stripSetuidBit, st.Mode()&os.ModeSetuid == 0, "setuid bit was not set/stripped correctly")
667+
assert.Equal(t, stripSetgidBit, st.Mode()&os.ModeSetgid == 0, "setgid bit was not set/stripped correctly")
668+
assert.Equal(t, stripStickyBit, st.Mode()&os.ModeSticky == 0, "sticky bit was not set/stripped correctly")
669669
})
670670
}
671671
}
@@ -737,8 +737,8 @@ func testStat(t *testing.T) {
737737
matches := 0
738738
for _, glob := range st.Globbed {
739739
matches++
740-
require.Equal(t, st.Glob, glob, "expected entry for %q", st.Glob)
741-
require.NotNil(t, st.Results[glob], "%q globbed %q, but there are no results for it", st.Glob, glob)
740+
require.Equalf(t, st.Glob, glob, "expected entry for %q", st.Glob)
741+
require.NotNilf(t, st.Results[glob], "%q globbed %q, but there are no results for it", st.Glob, glob)
742742
toStat := glob
743743
if !absolute {
744744
toStat = filepath.Join(root, topdir, name)
@@ -753,24 +753,24 @@ func testStat(t *testing.T) {
753753
testItem.Size = int64(len(actualContent))
754754
}
755755
checkStatInfoOwnership(t, result)
756-
require.Equal(t, testItem.Size, result.Size, "unexpected size difference for %q", name)
757-
require.True(t, result.IsRegular, "expected %q.IsRegular to be true", glob)
758-
require.False(t, result.IsDir, "expected %q.IsDir to be false", glob)
759-
require.False(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
756+
require.Equalf(t, testItem.Size, result.Size, "unexpected size difference for %q", name)
757+
require.Truef(t, result.IsRegular, "expected %q.IsRegular to be true", glob)
758+
require.Falsef(t, result.IsDir, "expected %q.IsDir to be false", glob)
759+
require.Falsef(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
760760
case tar.TypeDir:
761-
require.False(t, result.IsRegular, "expected %q.IsRegular to be false", glob)
762-
require.True(t, result.IsDir, "expected %q.IsDir to be true", glob)
763-
require.False(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
761+
require.Falsef(t, result.IsRegular, "expected %q.IsRegular to be false", glob)
762+
require.Truef(t, result.IsDir, "expected %q.IsDir to be true", glob)
763+
require.Falsef(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
764764
case tar.TypeSymlink:
765-
require.True(t, result.IsSymlink, "%q is supposed to be a symbolic link, but is not", name)
766-
require.Equal(t, filepath.FromSlash(testItem.Linkname), result.ImmediateTarget, "%q is supposed to point to %q, but points to %q", glob, testItem.Linkname, result.ImmediateTarget)
765+
require.Truef(t, result.IsSymlink, "%q is supposed to be a symbolic link, but is not", name)
766+
require.Equalf(t, filepath.FromSlash(testItem.Linkname), result.ImmediateTarget, "%q is supposed to point to %q, but points to %q", glob, testItem.Linkname, result.ImmediateTarget)
767767
case tar.TypeBlock, tar.TypeChar:
768-
require.False(t, result.IsRegular, "%q is a regular file, but is not supposed to be", name)
769-
require.False(t, result.IsDir, "%q is a directory, but is not supposed to be", name)
770-
require.False(t, result.IsSymlink, "%q is not supposed to be a symbolic link, but appears to be one", name)
768+
require.Falsef(t, result.IsRegular, "%q is a regular file, but is not supposed to be", name)
769+
require.Falsef(t, result.IsDir, "%q is a directory, but is not supposed to be", name)
770+
require.Falsef(t, result.IsSymlink, "%q is not supposed to be a symbolic link, but appears to be one", name)
771771
}
772772
}
773-
require.Equal(t, 1, matches, "non-glob %q matched %d items, not exactly one", name, matches)
773+
require.Equalf(t, 1, matches, "non-glob %q matched %d items, not exactly one", name, matches)
774774
}
775775
})
776776
}
@@ -895,7 +895,7 @@ func testGetSingle(ctx context.Context, t *testing.T, expectedError error) {
895895
if expectedMode != hdr.Mode && expectedMode&testModeMask == hdr.Mode&testModeMask {
896896
logrus.Warnf("chmod() lost some bits: expected 0%o, got 0%o", expectedMode, hdr.Mode)
897897
} else {
898-
assert.Equal(t, expectedMode, hdr.Mode, "expected item named %q %sto have mode 0%o, got 0%o", hdr.Name, modifier, expectedMode, hdr.Mode)
898+
assert.Equalf(t, expectedMode, hdr.Mode, "expected item named %q %sto have mode 0%o, got 0%o", hdr.Name, modifier, expectedMode, hdr.Mode)
899899
}
900900
if err != nil {
901901
break
@@ -1706,7 +1706,7 @@ func testGetMultiple(ctx context.Context, t *testing.T, expectedGetError error)
17061706
sort.Strings(expectedContents)
17071707
assert.ErrorIs(t, err, io.EOF, "expected EOF at end of archive")
17081708
assert.NoErrorf(t, getErr, "unexpected error from Get(%q)", testCase.pattern)
1709-
assert.Equal(t, expectedContents, actualContents, "Get(%q,excludes=%v) didn't produce the right set of items", testCase.pattern, excludes)
1709+
assert.Equalf(t, expectedContents, actualContents, "Get(%q,excludes=%v) didn't produce the right set of items", testCase.pattern, excludes)
17101710

17111711
expectedSymlinks := testCase.expectedSymlinks
17121712
if expectedSymlinks == nil {
@@ -2092,7 +2092,7 @@ func TestCleanerSubdirectory(t *testing.T) {
20922092
for _, testCase := range testCases {
20932093
t.Run(testCase[0], func(t *testing.T) {
20942094
cleaner := cleanerReldirectory(filepath.FromSlash(testCase[0]))
2095-
assert.Equal(t, testCase[1], filepath.ToSlash(cleaner), "expected to get %q, got %q", testCase[1], cleaner)
2095+
assert.Equalf(t, testCase[1], filepath.ToSlash(cleaner), "expected to get %q, got %q", testCase[1], cleaner)
20962096
})
20972097
}
20982098
}
@@ -2116,7 +2116,7 @@ func TestHandleRename(t *testing.T) {
21162116
for i, testCase := range testCases {
21172117
t.Run(strconv.Itoa(i), func(t *testing.T) {
21182118
renamed := handleRename(renames, testCase[0])
2119-
assert.Equal(t, testCase[1], renamed, "expected to get %q, got %q", testCase[1], renamed)
2119+
assert.Equalf(t, testCase[1], renamed, "expected to get %q, got %q", testCase[1], renamed)
21202120
})
21212121
}
21222122
}
@@ -2426,7 +2426,7 @@ func TestExtendedGlob(t *testing.T) {
24262426
expected2 = append(expected2, filepath.Join(tmpdir, "d", "d.dat"))
24272427
matched, err := extendedGlob(filepath.Join(tmpdir, "**", "*.dat"))
24282428
require.NoError(t, err, "globbing")
2429-
require.ElementsMatchf(t, expected1, matched, "**/*.dat")
2429+
require.ElementsMatch(t, expected1, matched, "**/*.dat")
24302430
matched, err = extendedGlob(filepath.Join(tmpdir, "**", "d", "*.dat"))
24312431
require.NoError(t, err, "globbing")
24322432
require.ElementsMatch(t, expected2, matched, "**/d/*.dat")
@@ -2593,7 +2593,7 @@ func testEnsure(t *testing.T) {
25932593
for _, item := range testCases[i].options.Paths {
25942594
target := filepath.Join(tmpdir, testCases[i].subdir, item.Path)
25952595
st, err := os.Stat(target)
2596-
require.NoError(t, err, "we supposedly created %q", item.Path)
2596+
require.NoErrorf(t, err, "we supposedly created %q", item.Path)
25972597
if item.Chmod != nil {
25982598
assert.Equalf(t, *item.Chmod, st.Mode().Perm(), "permissions look wrong on %q", item.Path)
25992599
}
@@ -2606,7 +2606,7 @@ func testEnsure(t *testing.T) {
26062606
if item.ModTime != nil {
26072607
assert.Equalf(t, item.ModTime.Unix(), st.ModTime().Unix(), "datestamp looks wrong on %q", item.Path)
26082608
} else {
2609-
assert.True(t, !testStarted.After(st.ModTime()), "datestamp is too old on %q: %v < %v", st.ModTime(), testStarted)
2609+
assert.Truef(t, !testStarted.After(st.ModTime()), "datestamp is too old on %q: %v < %v", target, st.ModTime(), testStarted)
26102610
}
26112611
}
26122612
})
@@ -3106,11 +3106,11 @@ func TestCannotChangeMultipleRequestsWithDifferentChroot(t *testing.T) {
31063106

31073107
require.NoError(t, encoder.Encode(&req), "failed to send first request to copier")
31083108
resp := receiveResponse()
3109-
require.Empty(t, resp.Error, "first request returned an error: %s", resp.Error)
3109+
require.Emptyf(t, resp.Error, "first request returned an error: %s", resp.Error)
31103110

31113111
require.NoError(t, encoder.Encode(&req), "failed to send second request to copier")
31123112
resp = receiveResponse()
3113-
require.Empty(t, resp.Error, "second request returned an error: %s", resp.Error)
3113+
require.Emptyf(t, resp.Error, "second request returned an error: %s", resp.Error)
31143114

31153115
require.NoError(t, encoder.Encode(&request{Request: requestQuit}))
31163116
require.NoError(t, cmd.Wait())
@@ -3253,7 +3253,7 @@ func testPutTimestamp(t *testing.T) {
32533253
for _, name := range []string{"subdir", "subdir/file.txt"} {
32543254
info, err := os.Lstat(filepath.Join(root, name))
32553255
require.NoError(t, err)
3256-
assert.Equal(t, override.Unix(), info.ModTime().Unix(), "%q should have overridden timestamp", name)
3256+
assert.Equalf(t, override.Unix(), info.ModTime().Unix(), "%q should have overridden timestamp", name)
32573257
}
32583258
})
32593259

@@ -3269,7 +3269,7 @@ func testPutTimestamp(t *testing.T) {
32693269
for _, name := range []string{"dest", "dest/nested", "dest/nested/a", "dest/nested/a/b", "dest/nested/a/b/file.txt"} {
32703270
info, err := os.Lstat(filepath.Join(root, name))
32713271
require.NoError(t, err)
3272-
assert.Equal(t, override.Unix(), info.ModTime().Unix(), "%q should have overridden timestamp", name)
3272+
assert.Equalf(t, override.Unix(), info.ModTime().Unix(), "%q should have overridden timestamp", name)
32733273
}
32743274
})
32753275

copier/xattrs_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func TestXattrs(t *testing.T) {
5656
for attribute, value := range testValues {
5757
t.Run(fmt.Sprintf("attribute=%s", attribute), func(t *testing.T) {
5858
f, err := os.CreateTemp(tmp, "copier-xattr-test-")
59-
if !assert.Nil(t, err, "error creating test file: %v", err) {
59+
if !assert.Nilf(t, err, "error creating test file: %v", err) {
6060
t.FailNow()
6161
}
6262
defer os.Remove(f.Name())
@@ -65,19 +65,19 @@ func TestXattrs(t *testing.T) {
6565
if errors.Is(err, syscall.ENOTSUP) {
6666
t.Skipf("extended attributes not supported on %q, skipping", tmp)
6767
}
68-
if !assert.Nil(t, err, "error setting attribute on file: %v", err) {
68+
if !assert.Nilf(t, err, "error setting attribute on file: %v", err) {
6969
t.FailNow()
7070
}
7171

7272
xattrs, err := Lgetxattrs(f.Name())
73-
if !assert.Nil(t, err, "error reading attributes of file: %v", err) {
73+
if !assert.Nilf(t, err, "error reading attributes of file: %v", err) {
7474
t.FailNow()
7575
}
7676
xvalue, ok := xattrs[attribute]
77-
if !assert.True(t, ok, "did not read back attribute %q for file", attribute) {
77+
if !assert.Truef(t, ok, "did not read back attribute %q for file", attribute) {
7878
t.FailNow()
7979
}
80-
if !assert.Equal(t, value, xvalue, "read back different value for attribute %q", attribute) {
80+
if !assert.Equalf(t, value, xvalue, "read back different value for attribute %q", attribute) {
8181
t.FailNow()
8282
}
8383
})

0 commit comments

Comments
 (0)