Merge pull request #29 from jumppad-labs/f-defaults

Set default values on resources if set on struct annotation

Author: eveld

dag.go

@@ -3,6 +3,7 @@ package hclconfig
 import (
 	"fmt"
 
+	"github.com/creasty/defaults"
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/gohcl"
 
@@ -267,6 +268,9 @@ func createCallback(c *Config, wf WalkCallback) func(v dag.Vertex) (diags dag.Di
 		ul := getContextLock(ctx)
 		defer ul()
 
+		// if there are defaults defined on the resource set them
+		defaults.Set(r)
+
 		diag := gohcl.DecodeBody(bdy, ctx, r)
 		if diag.HasErrors() {
 			pe := &errors.ParserError{}

go.mod

@@ -28,6 +28,7 @@ require (
 	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
 	github.com/aws/aws-sdk-go v1.55.5 // indirect
 	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
+	github.com/creasty/defaults v1.8.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect

go.sum

@@ -221,6 +221,8 @@ github.com/cncf/xds/go v0.0.0-20210805033703-aa0b78936158/go.mod h1:eXthEFrGJvWH
 github.com/cncf/xds/go v0.0.0-20210922020428-25de7278fc84/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
 github.com/cncf/xds/go v0.0.0-20211001041855-01bcc9b48dfe/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
 github.com/cncf/xds/go v0.0.0-20211011173535-cb28da3451f1/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
+github.com/creasty/defaults v1.8.0 h1:z27FJxCAa0JKt3utc0sCImAEb+spPucmKoOdLHvHYKk=
+github.com/creasty/defaults v1.8.0/go.mod h1:iGzKe6pbEHnpMPtfDXZEr0NVxWnPTjb1bbDy08fPzYM=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

parse_test.go

@@ -181,6 +181,26 @@ func TestParseResolvesArrayReferences(t *testing.T) {
 	require.Equal(t, float64(12), out.Value.([]interface{})[2].(float64))
 }
 
+func TestParseSetsDefaultValues(t *testing.T) {
+	absoluteFolderPath, err := filepath.Abs("./test_fixtures/defaults/container.hcl")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	p := setupParser(t)
+
+	c, err := p.ParseFile(absoluteFolderPath)
+	require.NoError(t, err)
+
+	r, err := c.FindResource("resource.container.default")
+	require.NoError(t, err)
+	require.NotNil(t, r)
+
+	// check default values have been set
+	cont := r.(*structs.Container)
+	require.Equal(t, "hello world", cont.Default)
+}
+
 func TestLoadsVariableFilesInOptionsOverridingVariableDefaults(t *testing.T) {
 	absoluteFolderPath, err := filepath.Abs("./test_fixtures/simple")
 	require.NoError(t, err)

test_fixtures/defaults/container.hcl

@@ -0,0 +1,2 @@
+resource "container" "default" {
+}

test_fixtures/structs/container.go

@@ -12,6 +12,8 @@ type Container struct {
 	// embedded type holding name, etc
 	types.ResourceBase `hcl:"rm,remain"`
 
+	Default string `hcl:"default,optional" json:"default,omitempty" default:"hello world"` // A default value
+
 	Networks   []NetworkAttachment `hcl:"network,block" json:"networks,omitempty"`         // Attach to the correct network // only when Image is specified
 	NetworkObj Network             `hcl:"networkobj,optional" json:"networkobj,omitempty"` // Reference to an object