Merge pull request #171 from prologic/fix_symlink_support

Adds support for Symlinks in all Tar decompressors

decompress_bzip2_test.go

@@ -12,6 +12,7 @@ func TestBzip2Decompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -21,6 +22,7 @@ func TestBzip2Decompressor(t *testing.T) {
 			true,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},

decompress_gzip_test.go

@@ -12,6 +12,7 @@ func TestGzipDecompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -21,6 +22,7 @@ func TestGzipDecompressor(t *testing.T) {
 			true,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},

decompress_tar.go

@@ -45,6 +45,15 @@ func untar(input io.Reader, dst, src string, dir bool) error {
 			path = filepath.Join(path, hdr.Name)
 		}
 
+		if hdr.Typeflag == tar.TypeSymlink {
+			// If the type is a symlink we re-write it and
+			// continue instead of attempting to copy the contents
+			if err := os.Symlink(hdr.Linkname, path); err != nil {
+				return fmt.Errorf("failed writing symbolic link: %s", err)
+			}
+			continue
+		}
+
 		if hdr.FileInfo().IsDir() {
 			if !dir {
 				return fmt.Errorf("expected a single file: %s", src)

decompress_tar_test.go

@@ -14,6 +14,7 @@ func TestTar(t *testing.T) {
 			true,
 			false,
 			[]string{"directory/", "directory/a", "directory/b"},
+			nil,
 			"",
 			nil,
 		},
@@ -22,6 +23,7 @@ func TestTar(t *testing.T) {
 			true,
 			false,
 			[]string{"directory/", "directory/sub/", "directory/sub/a", "directory/sub/b"},
+			nil,
 			"",
 			nil,
 		},
@@ -30,6 +32,16 @@ func TestTar(t *testing.T) {
 			true,
 			false,
 			[]string{"directory/", "directory/sub/", "directory/sub/a", "directory/sub/b"},
+			nil,
+			"",
+			&mtime,
+		},
+		{
+			"with-symlinks.tar",
+			true,
+			false,
+			[]string{"baz", "foo"},
+			map[string]string{"bar": "baz"},
 			"",
 			&mtime,
 		},

decompress_tbz2_test.go

@@ -14,6 +14,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -23,6 +24,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -32,6 +34,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file"},
+			nil,
 			"",
 			nil,
 		},
@@ -41,6 +44,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file1", "file2"},
+			nil,
 			"",
 			nil,
 		},
@@ -50,6 +54,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -60,6 +65,7 @@ func TestTarBzip2Decompressor(t *testing.T) {
 			true,
 			false,
 			orderingPaths,
+			nil,
 			"",
 			nil,
 		},

decompress_testing.go

@@ -18,12 +18,13 @@ import (
 
 // TestDecompressCase is a single test case for testing decompressors
 type TestDecompressCase struct {
-	Input   string     // Input is the complete path to the input file
-	Dir     bool       // Dir is whether or not we're testing directory mode
-	Err     bool       // Err is whether we expect an error or not
-	DirList []string   // DirList is the list of files for Dir mode
-	FileMD5 string     // FileMD5 is the expected MD5 for a single file
-	Mtime   *time.Time // Mtime is the optionally expected mtime for a single file (or all files if in Dir mode)
+	Input    string            // Input is the complete path to the input file
+	Dir      bool              // Dir is whether or not we're testing directory mode
+	Err      bool              // Err is whether we expect an error or not
+	DirList  []string          // DirList is the list of files for Dir mode
+	Symlinks map[string]string // Optional map of symlinks to test
+	FileMD5  string            // FileMD5 is the expected MD5 for a single file
+	Mtime    *time.Time        // Mtime is the optionally expected mtime for a single file (or all files if in Dir mode)
 }
 
 // TestDecompressor is a helper function for testing generic decompressors.
@@ -97,11 +98,17 @@ func TestDecompressor(t testing.T, d Decompressor, cases []TestDecompressCase) {
 
 			// Directory, check for the correct contents
 			actual := testListDir(t, dst)
-			if !reflect.DeepEqual(actual, expected) {
-				t.Fatalf("bad %s\n\n%#v\n\n%#v", tc.Input, actual, expected)
+			if !reflect.DeepEqual(actual.files, expected) {
+				t.Fatalf("bad %s\n\n%#v\n\n%#v", tc.Input, actual.files, expected)
 			}
+
+			// Symlinks, check that symlinks match
+			if tc.Symlinks != nil && !reflect.DeepEqual(actual.symlinks, tc.Symlinks) {
+				t.Fatalf("bad %s\n\n%#v\n\n%#v", tc.Input, actual.symlinks, tc.Symlinks)
+			}
+
 			// Check for correct atime/mtime
-			for _, dir := range actual {
+			for _, dir := range actual.files {
 				path := filepath.Join(dst, dir)
 				if tc.Mtime != nil {
 					fi, err := os.Stat(path)
@@ -124,8 +131,32 @@ func TestDecompressor(t testing.T, d Decompressor, cases []TestDecompressCase) {
 	}
 }
 
-func testListDir(t testing.T, path string) []string {
-	var result []string
+type testResult struct {
+	files    []string
+	symlinks map[string]string
+}
+
+func (tr *testResult) AddFile(name string) {
+	tr.files = append(tr.files, name)
+}
+
+func (tr *testResult) AddSymlink(name, link string) {
+	tr.symlinks[name] = link
+}
+
+func (tr *testResult) SortFiles() {
+	sort.Strings(tr.files)
+}
+
+func newTestResult() *testResult {
+	return &testResult{
+		files:    make([]string, 0),
+		symlinks: make(map[string]string),
+	}
+}
+
+func testListDir(t testing.T, path string) *testResult {
+	result := newTestResult()
 	err := filepath.Walk(path, func(sub string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
@@ -140,16 +171,24 @@ func testListDir(t testing.T, path string) []string {
 		// If it is a dir, add trailing sep
 		if info.IsDir() {
 			sub += string(os.PathSeparator)
+			result.AddFile(sub)
+		} else if info.Mode()&os.ModeSymlink != 0 {
+			link, err := os.Readlink(filepath.Join(path, info.Name()))
+			if err != nil {
+				return err
+			}
+			result.AddSymlink(sub, link)
+		} else {
+			result.AddFile(sub)
 		}
 
-		result = append(result, sub)
 		return nil
 	})
 	if err != nil {
 		t.Fatalf("err: %s", err)
 	}
 
-	sort.Strings(result)
+	result.SortFiles()
 	return result
 }
 

decompress_tgz_test.go

@@ -16,6 +16,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -25,6 +26,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -34,6 +36,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file"},
+			nil,
 			"",
 			nil,
 		},
@@ -43,6 +46,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file1", "file2"},
+			nil,
 			"",
 			nil,
 		},
@@ -52,6 +56,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -61,6 +66,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			true,
 			false,
 			multiplePaths,
+			nil,
 			"",
 			nil,
 		},
@@ -71,6 +77,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			true,
 			false,
 			orderingPaths,
+			nil,
 			"",
 			nil,
 		},
@@ -82,6 +89,7 @@ func TestTarGzipDecompressor(t *testing.T) {
 			true,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},

decompress_txz_test.go

@@ -16,6 +16,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -25,6 +26,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -34,6 +36,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file"},
+			nil,
 			"",
 			nil,
 		},
@@ -43,6 +46,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			true,
 			false,
 			[]string{"file1", "file2"},
+			nil,
 			"",
 			nil,
 		},
@@ -52,6 +56,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			false,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},
@@ -61,6 +66,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			true,
 			false,
 			multiplePaths,
+			nil,
 			"",
 			nil,
 		},
@@ -71,6 +77,7 @@ func TestTarXzDecompressor(t *testing.T) {
 			true,
 			false,
 			orderingPaths,
+			nil,
 			"",
 			nil,
 		},

decompress_xz_test.go

@@ -12,6 +12,7 @@ func TestXzDecompressor(t *testing.T) {
 			false,
 			false,
 			nil,
+			nil,
 			"d3b07384d113edec49eaa6238ad5ff00",
 			nil,
 		},
@@ -21,6 +22,7 @@ func TestXzDecompressor(t *testing.T) {
 			true,
 			true,
 			nil,
+			nil,
 			"",
 			nil,
 		},