- Notifications
You must be signed in to change notification settings - Fork928
chore(coderd): improve tests for tar<->zip conversion#12477
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
51dd5a0 chore(coderd): improve tests for tar<->zip conversion
johnstcn16b96a4 fixup! chore(coderd): improve tests for tar<->zip conversion
johnstcn0094b96 fixup! fixup! chore(coderd): improve tests for tar<->zip conversion
johnstcnad47dc9 fix(coderd): set mode and modtime correctly when converting from zip …
johnstcn28f8e52 Merge remote-tracking branch 'origin/main' into cj/fileszip-tests
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
31 changes: 15 additions & 16 deletionscoderd/files_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
10 changes: 7 additions & 3 deletionscoderd/fileszip.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
213 changes: 213 additions & 0 deletionscoderd/fileszip_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| package coderd_test | ||
| import ( | ||
| "archive/tar" | ||
| "archive/zip" | ||
| "bytes" | ||
| "io" | ||
| "io/fs" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "runtime" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "golang.org/x/xerrors" | ||
| "github.com/coder/coder/v2/coderd" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
| func TestCreateTarFromZip(t *testing.T) { | ||
| t.Parallel() | ||
| if runtime.GOOS != "linux" { | ||
| t.Skip("skipping this test on non-Linux platform") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Windows is no bueno? MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Generally yes, but I'm not going to assume the presence of | ||
| } | ||
| // Read a zip file we prepared earlier | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| zipBytes, err := os.ReadFile(filepath.Join("testdata", "test.zip")) | ||
| require.NoError(t, err, "failed to read sample zip file") | ||
| // Assert invariant | ||
| assertSampleZipFile(t, zipBytes) | ||
| zr, err := zip.NewReader(bytes.NewReader(zipBytes), int64(len(zipBytes))) | ||
| require.NoError(t, err, "failed to parse sample zip file") | ||
| tarBytes, err := coderd.CreateTarFromZip(zr) | ||
| require.NoError(t, err, "failed to convert zip to tar") | ||
| assertSampleTarFile(t, tarBytes) | ||
| tempDir := t.TempDir() | ||
| tempFilePath := filepath.Join(tempDir, "test.tar") | ||
| err = os.WriteFile(tempFilePath, tarBytes, 0o600) | ||
| require.NoError(t, err, "failed to write converted tar file") | ||
| cmd := exec.CommandContext(ctx, "tar", "--extract", "--verbose", "--file", tempFilePath, "--directory", tempDir) | ||
| require.NoError(t, cmd.Run(), "failed to extract converted tar file") | ||
| assertExtractedFiles(t, tempDir, true) | ||
| } | ||
| func TestCreateZipFromTar(t *testing.T) { | ||
| t.Parallel() | ||
| if runtime.GOOS != "linux" { | ||
| t.Skip("skipping this test on non-Linux platform") | ||
| } | ||
| tarBytes, err := os.ReadFile(filepath.Join("testdata", "test.tar")) | ||
| require.NoError(t, err, "failed to read sample tar file") | ||
| tr := tar.NewReader(bytes.NewReader(tarBytes)) | ||
| zipBytes, err := coderd.CreateZipFromTar(tr) | ||
| require.NoError(t, err) | ||
| assertSampleZipFile(t, zipBytes) | ||
| tempDir := t.TempDir() | ||
| tempFilePath := filepath.Join(tempDir, "test.zip") | ||
| err = os.WriteFile(tempFilePath, zipBytes, 0o600) | ||
| require.NoError(t, err, "failed to write converted zip file") | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| cmd := exec.CommandContext(ctx, "unzip", tempFilePath, "-d", tempDir) | ||
| require.NoError(t, cmd.Run(), "failed to extract converted zip file") | ||
| assertExtractedFiles(t, tempDir, false) | ||
| } | ||
| // nolint:revive // this is a control flag but it's in a unit test | ||
| func assertExtractedFiles(t *testing.T, dir string, checkModePerm bool) { | ||
| t.Helper() | ||
| _ = filepath.Walk(dir, func(path string, info fs.FileInfo, err error) error { | ||
| relPath := strings.TrimPrefix(path, dir) | ||
| switch relPath { | ||
| case "", "/test.zip", "/test.tar": // ignore | ||
| case "/test": | ||
| stat, err := os.Stat(path) | ||
| assert.NoError(t, err, "failed to stat path %q", path) | ||
| assert.True(t, stat.IsDir(), "expected path %q to be a directory") | ||
| if checkModePerm { | ||
| assert.Equal(t, fs.ModePerm&0o755, stat.Mode().Perm(), "expected mode 0755 on directory") | ||
| } | ||
| assert.Equal(t, archiveRefTime(t).UTC(), stat.ModTime().UTC(), "unexpected modtime of %q", path) | ||
| case "/test/hello.txt": | ||
| stat, err := os.Stat(path) | ||
| assert.NoError(t, err, "failed to stat path %q", path) | ||
| assert.False(t, stat.IsDir(), "expected path %q to be a file") | ||
| if checkModePerm { | ||
| assert.Equal(t, fs.ModePerm&0o644, stat.Mode().Perm(), "expected mode 0644 on file") | ||
| } | ||
| bs, err := os.ReadFile(path) | ||
| assert.NoError(t, err, "failed to read file %q", path) | ||
| assert.Equal(t, "hello", string(bs), "unexpected content in file %q", path) | ||
| case "/test/dir": | ||
| stat, err := os.Stat(path) | ||
| assert.NoError(t, err, "failed to stat path %q", path) | ||
| assert.True(t, stat.IsDir(), "expected path %q to be a directory") | ||
| if checkModePerm { | ||
| assert.Equal(t, fs.ModePerm&0o755, stat.Mode().Perm(), "expected mode 0755 on directory") | ||
| } | ||
| case "/test/dir/world.txt": | ||
| stat, err := os.Stat(path) | ||
| assert.NoError(t, err, "failed to stat path %q", path) | ||
| assert.False(t, stat.IsDir(), "expected path %q to be a file") | ||
| if checkModePerm { | ||
| assert.Equal(t, fs.ModePerm&0o644, stat.Mode().Perm(), "expected mode 0644 on file") | ||
| } | ||
| bs, err := os.ReadFile(path) | ||
| assert.NoError(t, err, "failed to read file %q", path) | ||
| assert.Equal(t, "world", string(bs), "unexpected content in file %q", path) | ||
| default: | ||
| assert.Fail(t, "unexpected path", relPath) | ||
| } | ||
| return nil | ||
| }) | ||
| } | ||
| func assertSampleTarFile(t *testing.T, tarBytes []byte) { | ||
| t.Helper() | ||
| tr := tar.NewReader(bytes.NewReader(tarBytes)) | ||
| for { | ||
| hdr, err := tr.Next() | ||
| if err != nil { | ||
| if err == io.EOF { | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
| } | ||
| // Note: ignoring timezones here. | ||
| require.Equal(t, archiveRefTime(t).UTC(), hdr.ModTime.UTC()) | ||
| switch hdr.Name { | ||
| case "test/": | ||
| require.Equal(t, hdr.Typeflag, byte(tar.TypeDir)) | ||
| case "test/hello.txt": | ||
| require.Equal(t, hdr.Typeflag, byte(tar.TypeReg)) | ||
| bs, err := io.ReadAll(tr) | ||
| if err != nil && !xerrors.Is(err, io.EOF) { | ||
| require.NoError(t, err) | ||
| } | ||
| require.Equal(t, "hello", string(bs)) | ||
| case "test/dir/": | ||
| require.Equal(t, hdr.Typeflag, byte(tar.TypeDir)) | ||
| case "test/dir/world.txt": | ||
| require.Equal(t, hdr.Typeflag, byte(tar.TypeReg)) | ||
| bs, err := io.ReadAll(tr) | ||
| if err != nil && !xerrors.Is(err, io.EOF) { | ||
| require.NoError(t, err) | ||
| } | ||
| require.Equal(t, "world", string(bs)) | ||
| default: | ||
| require.Failf(t, "unexpected file in tar", hdr.Name) | ||
| } | ||
| } | ||
| } | ||
| func assertSampleZipFile(t *testing.T, zipBytes []byte) { | ||
| t.Helper() | ||
| zr, err := zip.NewReader(bytes.NewReader(zipBytes), int64(len(zipBytes))) | ||
| require.NoError(t, err) | ||
| for _, f := range zr.File { | ||
| // Note: ignoring timezones here. | ||
| require.Equal(t, archiveRefTime(t).UTC(), f.Modified.UTC()) | ||
| switch f.Name { | ||
| case "test/", "test/dir/": | ||
| // directory | ||
| case "test/hello.txt": | ||
| rc, err := f.Open() | ||
| require.NoError(t, err) | ||
| bs, err := io.ReadAll(rc) | ||
| _ = rc.Close() | ||
| require.NoError(t, err) | ||
| require.Equal(t, "hello", string(bs)) | ||
| case "test/dir/world.txt": | ||
| rc, err := f.Open() | ||
| require.NoError(t, err) | ||
| bs, err := io.ReadAll(rc) | ||
| _ = rc.Close() | ||
| require.NoError(t, err) | ||
| require.Equal(t, "world", string(bs)) | ||
| default: | ||
| require.Failf(t, "unexpected file in zip", f.Name) | ||
| } | ||
| } | ||
| } | ||
| // archiveRefTime is the Go reference time. The contents of the sample tar and zip files | ||
| // in testdata/ all have their modtimes set to the below in some timezone. | ||
| func archiveRefTime(t *testing.T) time.Time { | ||
| locMST, err := time.LoadLocation("MST") | ||
| require.NoError(t, err, "failed to load MST timezone") | ||
| return time.Date(2006, 1, 2, 3, 4, 5, 0, locMST) | ||
| } | ||
Binary file addedcoderd/testdata/test.tar
Binary file not shown.
Binary file addedcoderd/testdata/test.zip
Binary file not shown.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.