add tests and comments

coadler · coadler · commit 348f785300e3 · 2023-06-07T21:45:38.000Z
diff --git a/provisioner/terraform/parameters.go b/provisioner/terraform/parameters.go
@@ -27,35 +27,44 @@ func rawRichParameterNames(workdir string) ([]string, error) {
 
 	var coderParameterNames []string
 	for _, entry := range entries {
-		if !strings.HasSuffix(entry.Name(), ".tf") || !strings.HasSuffix(entry.Name(), ".tf.json") {
+		if !strings.HasSuffix(entry.Name(), ".tf") && !strings.HasSuffix(entry.Name(), ".tf.json") {
 			continue
 		}
 
-		var parsedHCL *hcl.File
-		var diags hcl.Diagnostics
-		hclFilepath := path.Join(workdir, entry.Name())
-		parser := hclparse.NewParser()
+		var (
+			parsedTF   *hcl.File
+			diags      hcl.Diagnostics
+			tfFilepath = path.Join(workdir, entry.Name())
+			parser     = hclparse.NewParser()
+		)
+
+		// Support .tf.json files.
+		// Warning: since JSON parsing in Go automatically sorts maps
+		// alphabetically, we can't preserve the original order of parameters
+		// like in HCL.
 		if strings.HasSuffix(entry.Name(), ".tf.json") {
-			parsedHCL, diags = parser.ParseJSONFile(hclFilepath)
+			parsedTF, diags = parser.ParseJSONFile(tfFilepath)
 		} else {
-			parsedHCL, diags = parser.ParseHCLFile(hclFilepath)
+			parsedTF, diags = parser.ParseHCLFile(tfFilepath)
 		}
+
 		if diags.HasErrors() {
 			return nil, hcl.Diagnostics{
 				{
 					Severity: hcl.DiagError,
 					Summary:  "Failed to parse HCL file",
-					Detail:   fmt.Sprintf("parser.ParseHCLFile can't parse %q file", hclFilepath),
+					Detail:   fmt.Sprintf("parser.ParseHCLFile can't parse %q file", tfFilepath),
 				},
 			}
 		}
 
-		content, _, _ := parsedHCL.Body.PartialContent(terraformWithCoderParametersSchema)
+		content, _, _ := parsedTF.Body.PartialContent(terraformWithCoderParametersSchema)
 		for _, block := range content.Blocks {
 			if block.Type == "data" && block.Labels[0] == "coder_parameter" && len(block.Labels) == 2 {
 				coderParameterNames = append(coderParameterNames, block.Labels[1])
 			}
 		}
 	}
+
 	return coderParameterNames, nil
 }
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") || !strings.HasSuffix(entry.Name(), ".tf.json") {
+		if !strings.HasSuffix(entry.Name(), ".tf") && !strings.HasSuffix(entry.Name(), ".tf.json") {
 			continue
 		}
 
diff --git a/provisioner/terraform/provision_test.go b/provisioner/terraform/provision_test.go
@@ -254,6 +254,31 @@ func TestProvision(t *testing.T) {
 			},
 			Apply: true,
 		},
+		{
+			Name: "single-resource-json",
+			Files: map[string]string{
+				"main.tf.json": `{
+					"resource": {
+						"null_resource": {
+							"A": [
+								{}
+							]
+						}
+					}
+				}`,
+			},
+			Response: &proto.Provision_Response{
+				Type: &proto.Provision_Response_Complete{
+					Complete: &proto.Provision_Complete{
+						Resources: []*proto.Resource{{
+							Name: "A",
+							Type: "null_resource",
+						}},
+					},
+				},
+			},
+			Apply: true,
+		},
 		{
 			Name: "bad-syntax-1",
 			Files: map[string]string{
@@ -349,6 +374,88 @@ func TestProvision(t *testing.T) {
 				},
 			},
 		},
+		{
+			Name: "rich-parameter-with-value-json",
+			Files: map[string]string{
+				"main.tf.json": `{
+					"data": {
+						"coder_parameter": {
+							"example": [
+								{
+									"default": "foobar",
+									"name": "Example",
+									"type": "string"
+								}
+							],
+							"sample": [
+								{
+									"default": "foobaz",
+									"name": "Sample",
+									"type": "string"
+								}
+							]
+						}
+					},
+					"resource": {
+						"null_resource": {
+							"example": [
+								{
+									"triggers": {
+										"misc": "${data.coder_parameter.example.value}"
+									}
+								}
+							]
+						}
+					},
+					"terraform": [
+						{
+							"required_providers": [
+								{
+									"coder": {
+										"source": "coder/coder",
+										"version": "0.6.20"
+									}
+								}
+							]
+						}
+					]
+				}`,
+			},
+			Request: &proto.Provision_Plan{
+				RichParameterValues: []*proto.RichParameterValue{
+					{
+						Name:  "Example",
+						Value: "foobaz",
+					},
+					{
+						Name:  "Sample",
+						Value: "foofoo",
+					},
+				},
+			},
+			Response: &proto.Provision_Response{
+				Type: &proto.Provision_Response_Complete{
+					Complete: &proto.Provision_Complete{
+						Parameters: []*proto.RichParameter{
+							{
+								Name:         "Example",
+								Type:         "string",
+								DefaultValue: "foobar",
+							},
+							{
+								Name:         "Sample",
+								Type:         "string",
+								DefaultValue: "foobaz",
+							},
+						},
+						Resources: []*proto.Resource{{
+							Name: "example",
+							Type: "null_resource",
+						}},
+					},
+				},
+			},
+		},
 		{
 			Name: "git-auth",
 			Files: map[string]string{

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") \|\| !strings.HasSuffix(entry.Name(), ".tf.json") {`
	`106`	`+ if !strings.HasSuffix(entry.Name(), ".tf") && !strings.HasSuffix(entry.Name(), ".tf.json") {`
`107`	`107`	`continue`
`108`	`108`	`}`
`109`	`109`