feat(provisionersdk): add support for .tf.json templates (#7744)

coadler · web-flow · commit 9b8e5c2d8a99 · 2023-06-02T00:03:59.000Z
diff --git a/provisionersdk/archive.go b/provisionersdk/archive.go
@@ -15,15 +15,17 @@ const (
 	TemplateArchiveLimit = 1 << 20
 )
 
-func dirHasExt(dir string, ext string) (bool, error) {
+func dirHasExt(dir string, exts ...string) (bool, error) {
 	dirEnts, err := os.ReadDir(dir)
 	if err != nil {
 		return false, err
 	}
 
 	for _, fi := range dirEnts {
-		if strings.HasSuffix(fi.Name(), ext) {
-			return true, nil
+		for _, ext := range exts {
+			if strings.HasSuffix(fi.Name(), ext) {
+				return true, nil
+			}
 		}
 	}
 
@@ -35,8 +37,8 @@ func Tar(w io.Writer, directory string, limit int64) error {
 	tarWriter := tar.NewWriter(w)
 	totalSize := int64(0)
 
-	const tfExt = ".tf"
-	hasTf, err := dirHasExt(directory, tfExt)
+	tfExts := []string{".tf", ".tf.json"}
+	hasTf, err := dirHasExt(directory, tfExts...)
 	if err != nil {
 		return err
 	}
@@ -50,7 +52,7 @@ func Tar(w io.Writer, directory string, limit int64) error {
 		// useless.
 		return xerrors.Errorf(
 			"%s is not a valid template since it has no %s files",
-			absPath, tfExt,
+			absPath, tfExts,
 		)
 	}
 
diff --git a/provisionersdk/archive_test.go b/provisionersdk/archive_test.go
@@ -33,6 +33,15 @@ func TestTar(t *testing.T) {
 		err = provisionersdk.Tar(io.Discard, dir, 1024)
 		require.NoError(t, err)
 	})
+	t.Run("ValidJSON", func(t *testing.T) {
+		t.Parallel()
+		dir := t.TempDir()
+		file, err := os.CreateTemp(dir, "*.tf.json")
+		require.NoError(t, err)
+		_ = file.Close()
+		err = provisionersdk.Tar(io.Discard, dir, 1024)
+		require.NoError(t, err)
+	})
 	t.Run("HiddenFiles", func(t *testing.T) {
 		t.Parallel()
 		dir := t.TempDir()

Original file line number	Diff line number	Diff line change
`@@ -15,15 +15,17 @@ const (`
`15`	`15`	`TemplateArchiveLimit = 1 << 20`
`16`	`16`	`)`
`17`	`17`
`18`		`-func dirHasExt(dir string, ext string) (bool, error) {`
	`18`	`+func dirHasExt(dir string, exts ...string) (bool, error) {`
`19`	`19`	`dirEnts, err := os.ReadDir(dir)`
`20`	`20`	`if err != nil {`
`21`	`21`	`return false, err`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`for _, fi := range dirEnts {`
`25`		`- if strings.HasSuffix(fi.Name(), ext) {`
`26`		`- return true, nil`
	`25`	`+ for _, ext := range exts {`
	`26`	`+ if strings.HasSuffix(fi.Name(), ext) {`
	`27`	`+ return true, nil`
	`28`	`+ }`
`27`	`29`	`}`
`28`	`30`	`}`
`29`	`31`
`@@ -35,8 +37,8 @@ func Tar(w io.Writer, directory string, limit int64) error {`
`35`	`37`	`tarWriter := tar.NewWriter(w)`
`36`	`38`	`totalSize := int64(0)`
`37`	`39`
`38`		`- const tfExt = ".tf"`
`39`		`- hasTf, err := dirHasExt(directory, tfExt)`
	`40`	`+ tfExts := []string{".tf", ".tf.json"}`
	`41`	`+ hasTf, err := dirHasExt(directory, tfExts...)`
`40`	`42`	`if err != nil {`
`41`	`43`	`return err`
`42`	`44`	`}`
`@@ -50,7 +52,7 @@ func Tar(w io.Writer, directory string, limit int64) error {`
`50`	`52`	`// useless.`
`51`	`53`	`return xerrors.Errorf(`
`52`	`54`	`"%s is not a valid template since it has no %s files",`
`53`		`- absPath, tfExt,`
	`55`	`+ absPath, tfExts,`
`54`	`56`	`)`
`55`	`57`	`}`
`56`	`58`