Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix behavior for StripComponents with leading ./ #106

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Fix behavior for StripComponents with leading ./ #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4195a79
Fix behavior for StripComponents with leading ./
ystros Dec 3, 2024
ccf95f5
Fix whitespace
ystros Dec 3, 2024
145cfe0
Fix StripComponents behavior on Windows
selzoc Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions fileutil/tarball_compressor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package fileutil

import (
"archive/tar"
"fmt"
"io"
"io/fs"
Expand All @@ -9,16 +10,16 @@ import (
"runtime"
"strings"

"archive/tar"

"github.com/klauspost/pgzip"

bosherr "github.com/cloudfoundry/bosh-utils/errors"
boshsys "github.com/cloudfoundry/bosh-utils/system"
)

const forwardSlash string = "/"

type tarballCompressor struct {
fs boshsys.FileSystem
fs boshsys.FileSystem
}

func NewTarballCompressor(
Expand Down Expand Up @@ -72,7 +73,7 @@ func (c tarballCompressor) CompressSpecificFilesInDir(dir string, files []string

header.Name = relPath
if runtime.GOOS == "windows" {
header.Name = strings.ReplaceAll(relPath, "\\", "/")
header.Name = strings.ReplaceAll(relPath, "\\", forwardSlash)
}

if err := tw.WriteHeader(header); err != nil {
Expand All @@ -98,7 +99,7 @@ func (c tarballCompressor) CompressSpecificFilesInDir(dir string, files []string
return "", bosherr.WrapError(err, "Creating tgz")
}

if err = tw.Close(); err != nil {
if err = tw.Close(); err != nil {
return "", bosherr.WrapError(err, "Closing tar writer")
}

Expand Down Expand Up @@ -140,13 +141,13 @@ func (c tarballCompressor) DecompressFileToDir(tarballPath string, dir string, o

if options.PathInArchive != "" && !strings.HasPrefix(
filepath.Clean(header.Name), filepath.Clean(options.PathInArchive)) {
continue
continue
}

fullName := filepath.Join(dir, filepath.FromSlash(header.Name))

if options.StripComponents > 0 {
components := strings.Split(filepath.Clean(header.Name), string(filepath.Separator))
components := strings.Split(header.Name, forwardSlash)
if len(components) <= options.StripComponents {
continue
}
Expand All @@ -171,12 +172,12 @@ func (c tarballCompressor) DecompressFileToDir(tarballPath string, dir string, o
}

case tar.TypeLink:
if err := c.fs.Symlink(header.Linkname, fullName); err != nil {
if err := c.fs.Symlink(header.Linkname, fullName); err != nil {
return bosherr.WrapError(err, "Decompressing link")
}

case tar.TypeSymlink:
if err := c.fs.Symlink(header.Linkname, fullName); err != nil {
case tar.TypeSymlink:
if err := c.fs.Symlink(header.Linkname, fullName); err != nil {
return bosherr.WrapError(err, "Decompressing symlink")
}

Expand Down
12 changes: 8 additions & 4 deletions fileutil/tarball_compressor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ var _ = Describe("tarballCompressor", func() {
"other_logs/more_logs/more.stdout.log",
))


content, err := fs.ReadFileString(filepath.FromSlash(dstDir + "/app.stdout.log"))
Expect(err).ToNot(HaveOccurred())
Expect(content).To(ContainSubstring("this is app stdout"))
Expand Down Expand Up @@ -250,7 +249,7 @@ var _ = Describe("tarballCompressor", func() {

var (
tarballPath string
fs *fakesys.FakeFileSystem
fs *fakesys.FakeFileSystem
)

BeforeEach(func() {
Expand All @@ -267,7 +266,6 @@ var _ = Describe("tarballCompressor", func() {
Expect(err).ToNot(HaveOccurred())
})


It("uses no same owner option", func() {
compressor := NewTarballCompressor(fs)
err := compressor.DecompressFileToDir(tarballPath, dstDir, CompressorOptions{})
Expand Down Expand Up @@ -353,9 +351,15 @@ var _ = Describe("tarballCompressor", func() {
dstElements, err := pathsInDir(dstDir)
Expect(err).ToNot(HaveOccurred())

// tar --strip-components treats a leading `./` in the file headers as its own component.
// So ./dir/some-file becomes dir/some-file with strip-components = 1.
// The example tar file in this test contains the leading ./ for each of its files.
Expect(dstElements).To(Equal([]string{
"./",
"double-nested-file",
"empty-nested-dir/",
"nested-dir/",
"nested-dir/double-nested-file",
"nested-file",
}))
})
})
Expand Down
Loading