fix: Ignore all hidden files and folders in archive (#4382)

kylecarbs · web-flow · commit bbe2baf3f624 · 2022-10-06T00:36:45.000Z
This also adds a suite of tests to ensure this cannot happen again!
diff --git a/provisionersdk/archive.go b/provisionersdk/archive.go
@@ -75,7 +75,7 @@ func Tar(directory string, limit int64) ([]byte, error) {
 		if err != nil {
 			return err
 		}
-		if strings.HasPrefix(rel, ".") {
+		if strings.HasPrefix(rel, ".") || strings.HasPrefix(filepath.Base(rel), ".") {
 			if fileInfo.IsDir() && rel != "." {
 				// Don't archive hidden files!
 				return filepath.SkipDir
diff --git a/provisionersdk/archive_test.go b/provisionersdk/archive_test.go
@@ -1,6 +1,7 @@
 package provisionersdk_test
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 	"testing"
@@ -30,6 +31,62 @@ func TestTar(t *testing.T) {
 		_, err = provisionersdk.Tar(dir, 1024)
 		require.NoError(t, err)
 	})
+	t.Run("HiddenFiles", func(t *testing.T) {
+		t.Parallel()
+		dir := t.TempDir()
+		type file struct {
+			Name     string
+			Archives bool
+		}
+		files := []*file{{
+			Name:     "*.tf",
+			Archives: true,
+		}, {
+			Name:     ".*",
+			Archives: false,
+		}, {
+			Name:     "./testing/.test/*.tf",
+			Archives: false,
+		}, {
+			Name:     "./testing/asd.*",
+			Archives: true,
+		}, {
+			Name:     ".terraform/.*",
+			Archives: false,
+		}, {
+			Name:     "example/.terraform/*",
+			Archives: false,
+		}}
+		for _, file := range files {
+			newDir := dir
+			if filepath.Base(file.Name) != file.Name {
+				newDir = filepath.Join(newDir, filepath.Dir(file.Name))
+				err := os.MkdirAll(newDir, 0755)
+				require.NoError(t, err)
+				file.Name = filepath.Base(file.Name)
+			}
+			tmpFile, err := os.CreateTemp(newDir, file.Name)
+			require.NoError(t, err)
+			_ = tmpFile.Close()
+			file.Name, err = filepath.Rel(dir, tmpFile.Name())
+			require.NoError(t, err)
+			fmt.Printf("rel")
+		}
+		content, err := provisionersdk.Tar(dir, 1024)
+		require.NoError(t, err)
+		dir = t.TempDir()
+		err = provisionersdk.Untar(dir, content)
+		require.NoError(t, err)
+		for _, file := range files {
+			_, err = os.Stat(filepath.Join(dir, file.Name))
+			t.Logf("stat %q %+v", file.Name, err)
+			if file.Archives {
+				require.NoError(t, err)
+			} else {
+				require.ErrorIs(t, err, os.ErrNotExist)
+			}
+		}
+	})
 }
 
 func TestUntar(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ func Tar(directory string, limit int64) ([]byte, error) {`
`75`	`75`	`if err != nil {`
`76`	`76`	`return err`
`77`	`77`	`}`
`78`		`- if strings.HasPrefix(rel, ".") {`
	`78`	`+ if strings.HasPrefix(rel, ".") \|\| strings.HasPrefix(filepath.Base(rel), ".") {`
`79`	`79`	`if fileInfo.IsDir() && rel != "." {`
`80`	`80`	`// Don't archive hidden files!`
`81`	`81`	`return filepath.SkipDir`