fix: fix nested dirs in example tars (#5447)

deansheather · web-flow · commit 0c0e3f0e4d8d · 2022-12-17T02:19:19.000+10:00
diff --git a/examples/examples.go b/examples/examples.go
@@ -7,6 +7,7 @@ import (
 	"io"
 	"io/fs"
 	"path"
+	"strings"
 	"sync"
 
 	"github.com/gohugoio/hugo/parser/pageparser"
@@ -162,28 +163,36 @@ func Archive(exampleID string) ([]byte, error) {
 			if err != nil {
 				return err
 			}
+			if path == "." {
+				// Tar files don't have a root directory.
+				return nil
+			}
 
 			info, err := entry.Info()
 			if err != nil {
 				return xerrors.Errorf("stat file: %w", err)
 			}
 
-			header, err := tar.FileInfoHeader(info, entry.Name())
+			header, err := tar.FileInfoHeader(info, "")
 			if err != nil {
 				return xerrors.Errorf("get file header: %w", err)
 			}
+			header.Name = strings.TrimPrefix(path, "./")
 			header.Mode = 0644
 
 			if entry.IsDir() {
-				header.Name = path + "/"
-
+				// Trailing slash on entry name is not required. Our tar
+				// creation code for tarring up a local directory doesn't
+				// include slashes so this we don't include them here for
+				// consistency.
+				// header.Name += "/"
+				header.Mode = 0755
+				header.Typeflag = tar.TypeDir
 				err = tarWriter.WriteHeader(header)
 				if err != nil {
 					return xerrors.Errorf("write file: %w", err)
 				}
 			} else {
-				header.Name = path
-
 				file, err := exampleFiles.Open(path)
 				if err != nil {
 					return xerrors.Errorf("open file %s: %w", path, err)
diff --git a/examples/examples_test.go b/examples/examples_test.go
@@ -51,6 +51,6 @@ func TestSubdirs(t *testing.T) {
 		entryPaths[header.Typeflag] = append(entryPaths[header.Typeflag], header.Name)
 	}
 
-	require.Subset(t, entryPaths[tar.TypeDir], []string{"./", "images/"})
+	require.Subset(t, entryPaths[tar.TypeDir], []string{"images"})
 	require.Subset(t, entryPaths[tar.TypeReg], []string{"README.md", "main.tf", "images/base.Dockerfile"})
 }
diff --git a/provisionersdk/archive.go b/provisionersdk/archive.go
@@ -81,11 +81,11 @@ func Tar(directory string, limit int64) ([]byte, error) {
 				return filepath.SkipDir
 			}
 			// Don't archive hidden files!
-			return err
+			return nil
 		}
 		if strings.Contains(rel, ".tfstate") {
 			// Don't store tfstate!
-			return err
+			return nil
 		}
 		// Use unix paths in the tar archive.
 		header.Name = filepath.ToSlash(rel)

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@ func TestSubdirs(t *testing.T) {`
`51`	`51`	`entryPaths[header.Typeflag] = append(entryPaths[header.Typeflag], header.Name)`
`52`	`52`	`}`
`53`	`53`
`54`		`- require.Subset(t, entryPaths[tar.TypeDir], []string{"./", "images/"})`
	`54`	`+ require.Subset(t, entryPaths[tar.TypeDir], []string{"images"})`
`55`	`55`	`require.Subset(t, entryPaths[tar.TypeReg], []string{"README.md", "main.tf", "images/base.Dockerfile"})`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,11 +81,11 @@ func Tar(directory string, limit int64) ([]byte, error) {`
`81`	`81`	`return filepath.SkipDir`
`82`	`82`	`}`
`83`	`83`	`// Don't archive hidden files!`
`84`		`- return err`
	`84`	`+ return nil`
`85`	`85`	`}`
`86`	`86`	`if strings.Contains(rel, ".tfstate") {`
`87`	`87`	`// Don't store tfstate!`
`88`		`- return err`
	`88`	`+ return nil`
`89`	`89`	`}`
`90`	`90`	`// Use unix paths in the tar archive.`
`91`	`91`	`header.Name = filepath.ToSlash(rel)`