feat(provisionersdk,provisioner): add support for .tf.json templates

TECHNOFAB11 · TECHNOFAB11 · commit 90d7e1b354c4 · 2023-06-04T13:56:55.000+02:00
diff --git a/provisioner/terraform/parameters.go b/provisioner/terraform/parameters.go
@@ -27,13 +27,17 @@ func rawRichParameterNames(workdir string) ([]string, error) {
 
 	var coderParameterNames []string
 	for _, entry := range entries {
-		if !strings.HasSuffix(entry.Name(), ".tf") {
+		if !strings.HasSuffix(entry.Name(), ".tf") || !strings.HasSuffix(entry.Name(), ".tf.json") {
 			continue
 		}
 
 		hclFilepath := path.Join(workdir, entry.Name())
 		parser := hclparse.NewParser()
-		parsedHCL, diags := parser.ParseHCLFile(hclFilepath)
+		if strings.HasSuffix(entry.Name(), ".tf.json") {
+			parsedHCL, diags := parser.ParseJSONFile(hclFilepath)
+		} else {
+			parsedHCL, diags := parser.ParseHCLFile(hclFilepath)
+		}
 		if diags.HasErrors() {
 			return nil, hcl.Diagnostics{
 				{
diff --git a/provisioner/terraform/parse.go b/provisioner/terraform/parse.go
@@ -103,7 +103,7 @@ func loadEnabledFeatures(moduleDir string) (map[string]bool, hcl.Diagnostics) {
 
 	var found bool
 	for _, entry := range entries {
-		if !strings.HasSuffix(entry.Name(), ".tf") {
+		if !strings.HasSuffix(entry.Name(), ".tf") || !strings.HasSuffix(entry.Name(), ".tf.json") {
 			continue
 		}
 
@@ -131,7 +131,11 @@ func parseFeatures(hclFilepath string) (map[string]bool, bool, hcl.Diagnostics)
 	}
 
 	parser := hclparse.NewParser()
-	parsedHCL, diags := parser.ParseHCLFile(hclFilepath)
+	if strings.HasSuffix(hclFilepath, ".tf.json") {
+		parsedHCL, diags := parser.ParseJSONFile(hclFilepath)
+	} else {
+		parsedHCL, diags := parser.ParseHCLFile(hclFilepath)
+	}
 	if diags.HasErrors() {
 		return flags, false, diags
 	}
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
`@@ -103,7 +103,7 @@ func loadEnabledFeatures(moduleDir string) (map[string]bool, hcl.Diagnostics) {`
`103`	`103`
`104`	`104`	`var found bool`
`105`	`105`	`for _, entry := range entries {`
`106`		`- if !strings.HasSuffix(entry.Name(), ".tf") {`
	`106`	`+ if !strings.HasSuffix(entry.Name(), ".tf") \|\| !strings.HasSuffix(entry.Name(), ".tf.json") {`
`107`	`107`	`continue`
`108`	`108`	`}`
`109`	`109`
`@@ -131,7 +131,11 @@ func parseFeatures(hclFilepath string) (map[string]bool, bool, hcl.Diagnostics)`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`parser := hclparse.NewParser()`
`134`		`- parsedHCL, diags := parser.ParseHCLFile(hclFilepath)`
	`134`	`+ if strings.HasSuffix(hclFilepath, ".tf.json") {`
	`135`	`+ parsedHCL, diags := parser.ParseJSONFile(hclFilepath)`
	`136`	`+ } else {`
	`137`	`+ parsedHCL, diags := parser.ParseHCLFile(hclFilepath)`
	`138`	`+ }`
`135`	`139`	`if diags.HasErrors() {`
`136`	`140`	`return flags, false, diags`
`137`	`141`	`}`
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`