unit tests (#848)

Author: jhsinger-klotho

Makefile

@@ -29,4 +29,4 @@ engine_test:
 
 .PHONY: regen_tests
 regen_tests:
-	find pkg/engine2/testdata -type f -name '*.input.yaml' -exec ./create_test.sh {} \;
+	find pkg/engine2/testdata -type f -name '*.input.yaml' -exec ./create_test.sh {} \;

go.mod

@@ -31,6 +31,7 @@ require (
 	github.com/stretchr/testify v1.8.2
 	github.com/vmware-labs/yaml-jsonpath v0.3.2
 	go.uber.org/atomic v1.9.0
+	go.uber.org/mock v0.4.0
 	go.uber.org/zap v1.19.1
 	golang.org/x/tools v0.7.0
 	gopkg.in/yaml.v2 v2.4.0
@@ -49,7 +50,7 @@ require (
 	github.com/mattn/go-sqlite3 v2.0.3+incompatible // indirect
 	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
-	golang.org/x/mod v0.9.0 // indirect
+	golang.org/x/mod v0.11.0 // indirect
 	golang.org/x/oauth2 v0.4.0 // indirect
 	k8s.io/client-go v0.26.0 // indirect
 )

go.sum

@@ -655,6 +655,8 @@ go.uber.org/atomic v1.9.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/goleak v1.1.11-0.20210813005559-691160354723/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
 go.uber.org/goleak v1.2.0 h1:xqgm/S+aQvhWFTtR0XK3Jvg7z8kGV8P4X14IzwN3Eqk=
 go.uber.org/goleak v1.2.0/go.mod h1:XJYK+MuIchqpmGmUSAzotztawfKvYLUIgg7guXrwVUo=
+go.uber.org/mock v0.4.0 h1:VcM4ZOtdbR4f6VXfiOpwpVJDL6lCReaZ6mw31wqh7KU=
+go.uber.org/mock v0.4.0/go.mod h1:a6FSlNadKUHUa9IP5Vyt1zh4fC7uAwxMutEAscFbkZc=
 go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
 go.uber.org/multierr v1.7.0 h1:zaiO/rmgFjbmCXdSYJWQcdvOCsthmdaHfr3Gm2Kx4Ec=
 go.uber.org/multierr v1.7.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak=
@@ -712,8 +714,8 @@ golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
-golang.org/x/mod v0.9.0 h1:KENHtAZL2y3NLMYZeHY9DW8HW8V+kQyJsY/V9JlKvCs=
-golang.org/x/mod v0.9.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/mod v0.11.0 h1:bUO06HqtnRcc/7l71XBe4WcqTZ+3AH1J59zWDDwLKgU=
+golang.org/x/mod v0.11.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=

pkg/engine2/operational_eval/operational_rule_mock_test.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/dominikbraun/graph"
 	construct "github.com/klothoplatform/klotho/pkg/construct2"
 	"github.com/klothoplatform/klotho/pkg/engine2/constraints"
 	"github.com/klothoplatform/klotho/pkg/engine2/operational_rule"
@@ -119,21 +120,24 @@ func (v *propertyVertex) Evaluate(eval *Evaluator) error {
 	if err := v.evaluateConstraints(sol, res); err != nil {
 		return err
 	}
+	opCtx := operational_rule.OperationalRuleContext{
+		Solution: sol,
+		Property: v.Template,
+		Data:     knowledgebase.DynamicValueData{Resource: res.ID},
+	}
 
 	// we know we cannot change properties of imported resources only users through constraints
 	// we still want to be able to update ids in case they are setting the property of a namespaced resource
 	// so we just conditionally run the edge operational rules
 	//
 	// we still need to run the resource operational rules though,
 	// to make sure dependencies exist where properties have operational rules set
-	if err := v.evaluateResourceOperational(sol, res); err != nil {
+	if err := v.evaluateResourceOperational(res, &opCtx); err != nil {
 		return err
 	}
 
-	if !res.Imported {
-		if err := v.evaluateEdgeOperational(sol, res); err != nil {
-			return err
-		}
+	if err := v.evaluateEdgeOperational(res, &opCtx); err != nil {
+		return err
 	}
 
 	if err := eval.UpdateId(v.Ref.Resource, res.ID); err != nil {
@@ -271,17 +275,14 @@ func (v *propertyVertex) evaluateConstraints(sol solution_context.SolutionContex
 	return nil
 }
 
-func (v *propertyVertex) evaluateResourceOperational(sol solution_context.SolutionContext, res *construct.Resource) error {
+func (v *propertyVertex) evaluateResourceOperational(
+	res *construct.Resource,
+	opCtx operational_rule.OpRuleHandler,
+) error {
 	if v.Template == nil || v.Template.Details().OperationalRule == nil {
 		return nil
 	}
 
-	opCtx := operational_rule.OperationalRuleContext{
-		Solution: sol,
-		Property: v.Template,
-		Data:     knowledgebase.DynamicValueData{Resource: res.ID},
-	}
-
 	err := opCtx.HandlePropertyRule(*v.Template.Details().OperationalRule)
 	if err != nil {
 		return fmt.Errorf("could not apply operational rule for %s: %w", v.Ref, err)
@@ -290,25 +291,22 @@ func (v *propertyVertex) evaluateResourceOperational(sol solution_context.Soluti
 	return nil
 }
 
-func (v *propertyVertex) evaluateEdgeOperational(sol solution_context.SolutionContext, res *construct.Resource) error {
+func (v *propertyVertex) evaluateEdgeOperational(
+	res *construct.Resource,
+	opCtx operational_rule.OpRuleHandler,
+) error {
 	oldId := v.Ref.Resource
-
-	opCtx := operational_rule.OperationalRuleContext{
-		Solution: sol,
-		Property: v.Template,
-		Data:     knowledgebase.DynamicValueData{Resource: res.ID},
-	}
-
 	var errs error
 	for edge, rules := range v.EdgeRules {
 		for _, rule := range rules {
 			// In case one of the previous rules changed the ID, update it
 			edge = UpdateEdgeId(edge, oldId, res.ID)
 
-			opCtx.Data.Edge = &construct.Edge{
-				Source: edge.Source,
-				Target: edge.Target,
-			}
+			opCtx.SetData(knowledgebase.DynamicValueData{
+				Resource: res.ID,
+				Edge:     &graph.Edge[construct.ResourceId]{Source: edge.Source, Target: edge.Target},
+			})
+
 			err := opCtx.HandleOperationalRule(rule)
 			if err != nil {
 				errs = errors.Join(errs, fmt.Errorf(

pkg/engine2/operational_eval/vertex_property.go

@@ -0,0 +1,115 @@
+package operational_eval
+
+import (
+	"testing"
+
+	"github.com/dominikbraun/graph"
+	construct "github.com/klothoplatform/klotho/pkg/construct2"
+	knowledgebase "github.com/klothoplatform/klotho/pkg/knowledge_base2"
+	"github.com/klothoplatform/klotho/pkg/knowledge_base2/properties"
+	"github.com/stretchr/testify/assert"
+	gomock "go.uber.org/mock/gomock"
+)
+
+func Test_propertyVertex_evaluateResourceOperational(t *testing.T) {
+	rule := &knowledgebase.PropertyRule{
+		Value: "test",
+	}
+	type args struct {
+		v   *propertyVertex
+		res *construct.Resource
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "property rule",
+			args: args{
+				v: &propertyVertex{
+					Ref: construct.PropertyRef{
+						Property: "test",
+						Resource: construct.ResourceId{Name: "test"},
+					},
+					Template: &properties.StringProperty{
+						PropertyDetails: knowledgebase.PropertyDetails{
+							OperationalRule: rule,
+						},
+					},
+				},
+				res: &construct.Resource{ID: construct.ResourceId{Name: "test"}},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert := assert.New(t)
+			ctrl := gomock.NewController(t)
+			opctx := NewMockOpRuleHandler(ctrl)
+			opctx.EXPECT().HandlePropertyRule(*rule).Return(nil).Times(1)
+			err := tt.args.v.evaluateResourceOperational(tt.args.res, opctx)
+			if tt.wantErr {
+				assert.Error(err)
+				return
+			}
+			assert.NoError(err)
+			ctrl.Finish()
+		})
+	}
+}
+
+func Test_propertyVertex_evaluateEdgeOperational(t *testing.T) {
+	rule := knowledgebase.OperationalRule{
+		If: "test",
+	}
+	type args struct {
+		v   *propertyVertex
+		res *construct.Resource
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "property rule",
+			args: args{
+				v: &propertyVertex{
+					Ref: construct.PropertyRef{
+						Property: "test",
+						Resource: construct.ResourceId{Name: "test"},
+					},
+					EdgeRules: map[construct.SimpleEdge][]knowledgebase.OperationalRule{
+						{
+							Source: construct.ResourceId{Name: "test"},
+							Target: construct.ResourceId{Name: "test2"},
+						}: {
+							rule,
+						},
+					},
+				},
+				res: &construct.Resource{ID: construct.ResourceId{Name: "test"}},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert := assert.New(t)
+			ctrl := gomock.NewController(t)
+			opctx := NewMockOpRuleHandler(ctrl)
+			opctx.EXPECT().SetData(knowledgebase.DynamicValueData{
+				Resource: tt.args.v.Ref.Resource,
+				Edge:     &graph.Edge[construct.ResourceId]{Source: construct.ResourceId{Name: "test"}, Target: construct.ResourceId{Name: "test2"}},
+			}).Times(1)
+			opctx.EXPECT().HandleOperationalRule(rule).Return(nil).Times(1)
+			err := tt.args.v.evaluateEdgeOperational(tt.args.res, opctx)
+			if tt.wantErr {
+				assert.Error(err)
+				return
+			}
+			assert.NoError(err)
+			ctrl.Finish()
+		})
+	}
+}

pkg/engine2/operational_eval/vertex_property_test.go

@@ -13,15 +13,23 @@ import (
 	"go.uber.org/zap"
 )
 
+//go:generate 	mockgen -source=./operational_rule.go --destination=../operational_eval/operational_rule_mock_test.go --package=operational_eval
+
 type (
 	OperationalRuleContext struct {
 		Solution solution_context.SolutionContext
 		Property knowledgebase.Property
 		Data     knowledgebase.DynamicValueData
 	}
+
+	OpRuleHandler interface {
+		HandleOperationalRule(rule knowledgebase.OperationalRule) error
+		HandlePropertyRule(rule knowledgebase.PropertyRule) error
+		SetData(data knowledgebase.DynamicValueData)
+	}
 )
 
-func (ctx OperationalRuleContext) HandleOperationalRule(rule knowledgebase.OperationalRule) error {
+func (ctx *OperationalRuleContext) HandleOperationalRule(rule knowledgebase.OperationalRule) error {
 	shouldRun, err := EvaluateIfCondition(rule.If, ctx.Solution, ctx.Data)
 	if err != nil {
 		return err
@@ -49,7 +57,7 @@ func (ctx OperationalRuleContext) HandleOperationalRule(rule knowledgebase.Opera
 	return errs
 }
 
-func (ctx OperationalRuleContext) HandlePropertyRule(rule knowledgebase.PropertyRule) error {
+func (ctx *OperationalRuleContext) HandlePropertyRule(rule knowledgebase.PropertyRule) error {
 	if ctx.Property == nil {
 		return fmt.Errorf("property rule has no property")
 	}
@@ -99,6 +107,10 @@ func (ctx OperationalRuleContext) HandlePropertyRule(rule knowledgebase.Property
 	return errs
 }
 
+func (ctx *OperationalRuleContext) SetData(data knowledgebase.DynamicValueData) {
+	ctx.Data = data
+}
+
 // CleanProperty clears the property associated with the rule if it no longer matches the rule.
 // For array properties, each element must match at least one step selector and non-matching
 // elements will be removed.

pkg/engine2/operational_rule/operational_rule.go

@@ -23,7 +23,6 @@ type (
 
 		SetCtx(ctx OperationalRuleContext)
 	}
-
 	SpreadPlacer struct {
 		ctx OperationalRuleContext
 	}