add some debugging tools

Author: Emyrk

cli/root.go

@@ -1,12 +1,15 @@
 package cli
 
 import (
+	"bytes"
+	"encoding/json"
 	"fmt"
 	"os"
 	"strings"
 
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/hclsyntax"
+	ctyjson "github.com/zclconf/go-cty/cty/json"
 
 	"github.com/coder/preview"
 	"github.com/coder/preview/cli/clidisplay"
@@ -102,6 +105,14 @@ func (r *RootCmd) Root() *serpent.Command {
 
 			clidisplay.Parameters(os.Stdout, output.Parameters, output.Files)
 
+			if !output.ModuleOutput.IsNull() && !(output.ModuleOutput.Type().IsObjectType() && output.ModuleOutput.LengthInt() == 0) {
+				fmt.Println("Module output")
+				data, _ := ctyjson.Marshal(output.ModuleOutput, output.ModuleOutput.Type())
+				var buf bytes.Buffer
+				_ = json.Indent(&buf, data, "", "  ")
+				fmt.Println(buf.String())
+			}
+
 			return nil
 		},
 	}

hclext/references.go

@@ -5,9 +5,41 @@ import (
 	"strings"
 
 	"github.com/hashicorp/hcl/v2"
+	"github.com/hashicorp/hcl/v2/hclsyntax"
 	"github.com/zclconf/go-cty/cty"
 )
 
+type ReferenceBuilder []hcl.Traverser
+
+func NewReferenceBuilder(path ...string) *ReferenceBuilder {
+	return (&ReferenceBuilder{}).AddPath(path...)
+}
+
+func (b *ReferenceBuilder) AddPath(path ...string) *ReferenceBuilder {
+	for _, p := range path {
+		if len(*b) == 0 {
+			*b = append(*b, hcl.TraverseRoot{Name: p})
+		} else {
+			*b = append(*b, hcl.TraverseAttr{Name: p})
+		}
+	}
+	return b
+}
+
+func (b *ReferenceBuilder) AddIndex(idx int) *ReferenceBuilder {
+	*b = append(*b, hcl.TraverseIndex{Key: cty.NumberIntVal(int64(idx))})
+	return b
+}
+
+func (b *ReferenceBuilder) AddKey(key string) *ReferenceBuilder {
+	*b = append(*b, hcl.TraverseIndex{Key: cty.StringVal(key)})
+	return b
+}
+
+func (b ReferenceBuilder) Expression() hcl.Expression {
+	return &hclsyntax.ScopeTraversalExpr{Traversal: hcl.Traversal(b)}
+}
+
 func ReferenceNames(exp hcl.Expression) []string {
 	if exp == nil {
 		return []string{}

preview.go

@@ -11,6 +11,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/iac/scanners/terraform/parser"
 	"github.com/aquasecurity/trivy/pkg/log"
 	"github.com/hashicorp/hcl/v2"
+	"github.com/zclconf/go-cty/cty"
 
 	"github.com/coder/preview/types"
 )
@@ -22,6 +23,7 @@ type Input struct {
 }
 
 type Output struct {
+	ModuleOutput  cty.Value
 	Parameters    []types.Parameter
 	WorkspaceTags types.TagBlocks
 	Files         map[string]*hcl.File
@@ -99,12 +101,11 @@ func Preview(ctx context.Context, input Input, dir fs.FS) (*Output, hcl.Diagnost
 		}
 	}
 
-	var _ = outputs
-
 	diags := make(hcl.Diagnostics, 0)
 	rp, rpDiags := RichParameters(modules)
 	tags, tagDiags := WorkspaceTags(modules, p.Files())
 	return &Output{
+		ModuleOutput:  outputs,
 		Parameters:    rp,
 		WorkspaceTags: tags,
 		Files:         p.Files(),

preview_test.go

@@ -271,21 +271,32 @@ func Test_Extract(t *testing.T) {
 			params: map[string]assertParam{},
 		},
 		{
-			skip: "Broken until https://github.com/aquasecurity/trivy/pull/8479 fixed",
 			name: "demo",
 			dir:  "demo",
 			expTags: map[string]string{
 				"cluster": "confidential",
+				"hash":    "52bb4d943694f2f5867a251780f85e5a68906787b4ffa3157e29b9ef510b1a97",
 			},
 			input: preview.Input{
-				PlanJSONPath:    "",
-				ParameterValues: map[string]string{},
+				PlanJSONPath: "plan.json",
+				ParameterValues: map[string]string{
+					"hash": "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9",
+				},
 				Owner: types.WorkspaceOwner{
 					Groups: []string{"admin"},
 				},
 			},
 			unknownTags: []string{},
-			params:      map[string]assertParam{},
+			params: map[string]assertParam{
+				"hash": ap().
+					value("b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"),
+				"security_level": ap(),
+				"region":         ap(),
+				"cpu":            ap(),
+				"browser":        ap(),
+				"team":           ap().optVals("frontend", "backend", "fullstack"),
+				"jetbrains_ide":  ap(),
+			},
 		},
 		{
 			name: "demo_flat",
@@ -378,15 +389,25 @@ func Test_Extract(t *testing.T) {
 			input: preview.Input{
 				PlanJSONPath: "",
 				ParameterValues: map[string]string{
-					"first": "curse",
+					"first": "curs",
 				},
 				Owner: types.WorkspaceOwner{},
 			},
 			unknownTags: []string{},
 			params: map[string]assertParam{
-				"first": ap().value("curse"),
+				"first": ap().value("curs"),
 			},
 		},
+		{
+			name:    "submodcount",
+			dir:     "submodcount",
+			expTags: map[string]string{},
+			input: preview.Input{
+				ParameterValues: map[string]string{},
+			},
+			unknownTags: []string{},
+			params:      map[string]assertParam{},
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()

testdata/demo/parameters.tf

@@ -1,5 +1,6 @@
 data "coder_parameter" "team" {
-  name        = "Team"
+  name        = "team"
+  display_name = "Team"
   description = "Which team are you on?"
   type        = "string"
   default     = "fullstack"
@@ -96,7 +97,8 @@ data "coder_workspace_tags" "test" {
 // Advanced admin parameter
 data "coder_parameter" "image_hash" {
   count       = local.isAdmin ? 1 : 0
-  name        = "Image Hash"
+  name = "hash"
+  display_name        = "Image Hash"
   description = "Override the hash of the image to use. Only available to admins."
   // Value can get stale
   default     = trimprefix(data.docker_registry_image.coder.sha256_digest, "sha256:")
@@ -113,7 +115,7 @@ data "docker_registry_image" "coder" {
 }
 
 data "coder_parameter" "region" {
-  name         = "Region"
+  name         = "region"
   display_name = "Region"
   description  = "What region are you in?"
   default      = local.default_region