Skip to content

Commit

Permalink
Ww plan modifier tests (#338)
Browse files Browse the repository at this point in the history 
* test: witness group tests

* test: witness group tests and fix

* test: wip refactored code, dg tests, pg config test

* test: added more tests
  • Loading branch information
@wai-wong-edb
wai-wong-edb authored Oct 6, 2023
1 parent 8bad36b commit 530948d
Show file tree
Hide file tree
Showing 7 changed files with 629 additions and 45 deletions.
12 changes: 6 additions & 6 deletions pkg/plan_modifier/data_group_custom_diff.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ import (
)

func CustomDataGroupDiffConfig() planmodifier.Set {
return customDataGroupDiffModifier{}
return CustomDataGroupDiffModifier{}
}

// customDataGroupModifier implements the plan modifier.
type customDataGroupDiffModifier struct{}
// CustomDataGroupModifier implements the plan modifier.
type CustomDataGroupDiffModifier struct{}

// Description returns a human-readable description of the plan modifier.
func (m customDataGroupDiffModifier) Description(_ context.Context) string {
func (m CustomDataGroupDiffModifier) Description(_ context.Context) string {
return "Once set, the value of this attribute in state will not change."
}

// MarkdownDescription returns a markdown description of the plan modifier.
func (m customDataGroupDiffModifier) MarkdownDescription(_ context.Context) string {
func (m CustomDataGroupDiffModifier) MarkdownDescription(_ context.Context) string {
return "Once set, the value of this attribute in state will not change."
}

// PlanModifySet implements the plan modification logic.
func (m customDataGroupDiffModifier) PlanModifySet(ctx context.Context, req planmodifier.SetRequest, resp *planmodifier.SetResponse) {
func (m CustomDataGroupDiffModifier) PlanModifySet(ctx context.Context, req planmodifier.SetRequest, resp *planmodifier.SetResponse) {
if req.StateValue.IsNull() {
return
}
Expand Down
296 changes: 296 additions & 0 deletions pkg/plan_modifier/data_group_custom_diff_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,296 @@
package plan_modifier_test

import (
"context"
"reflect"
"testing"

"github.com/EnterpriseDB/terraform-provider-biganimal/pkg/plan_modifier"
"github.com/EnterpriseDB/terraform-provider-biganimal/pkg/provider"
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/provider/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)

func Test_customDataGroupDiffModifier_PlanModifySet(t *testing.T) {
t.Parallel()

ctx := context.Background()

pgdSchema := provider.PgdSchema(ctx)

regionType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["region"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
cloudProviderType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["cloud_provider"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
storageAttrType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["storage"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
conditionsElemType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["conditions"].(schema.Attribute).GetType().(types.SetType).ElemType
resizingPvcElemType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["resizing_pvc"].(schema.Attribute).GetType().(types.SetType).ElemType
allowedIpRangesElemType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["allowed_ip_ranges"].(schema.Attribute).GetType().(types.SetType).ElemType
allowedIpRangesElemObjectType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["allowed_ip_ranges"].(schema.Attribute).GetType().(types.SetType).ElemType.(types.ObjectType).AttributeTypes()
clusterArchAttrType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["cluster_architecture"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
instanceTypeType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["instance_type"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
pgTypeType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["pg_type"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
pgVersionType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["pg_version"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()
cmwType := pgdSchema.Attributes["data_groups"].(schema.NestedAttribute).GetNestedObject().GetAttributes()["maintenance_window"].(schema.Attribute).GetType().(types.ObjectType).AttributeTypes()

defaultRegion := map[string]attr.Value{
"region_id": basetypes.NewStringValue("us-east-1"),
}

defaultCloudProvider := map[string]attr.Value{
"cloud_provider_id": basetypes.NewStringValue("aws"),
}

defaultStorage := map[string]attr.Value{
"volume_type": basetypes.NewStringValue("gp3"),
"volume_properties": basetypes.NewStringValue("gp3"),
"size": basetypes.NewStringValue("4 Gi"),
"iops": basetypes.NewStringUnknown(),
"throughput": basetypes.NewStringUnknown(),
}

defaultAllowedIpRange := []attr.Value{
basetypes.NewObjectValueMust(allowedIpRangesElemObjectType, map[string]attr.Value{
"cidr_block": basetypes.NewStringValue("127.0.0.1/32"),
"description": basetypes.NewStringValue("test ip 1"),
}),
basetypes.NewObjectValueMust(allowedIpRangesElemObjectType, map[string]attr.Value{
"cidr_block": basetypes.NewStringValue("192.0.0.1/32"),
"description": basetypes.NewStringValue("test ip 2"),
}),
}

defaultClusterArch := map[string]attr.Value{
"cluster_architecture_id": basetypes.NewStringValue("pgd"),
"cluster_architecture_name": basetypes.NewStringUnknown(),
"nodes": basetypes.NewFloat64Value(3),
"witness_nodes": basetypes.NewFloat64Unknown(),
}

defaultInstanceType := map[string]attr.Value{
"instance_type_id": basetypes.NewStringValue("aws:m5.large"),
}

defaultPgType := map[string]attr.Value{
"pg_type_id": basetypes.NewStringValue("epas"),
}

defaultPgVersion := map[string]attr.Value{
"pg_version_id": basetypes.NewStringValue("15"),
}

defaultCmw := map[string]attr.Value{
"is_enabled": basetypes.NewBoolValue(true),
"start_day": basetypes.NewFloat64Value(1),
"start_time": basetypes.NewStringValue("03:00"),
}

defaultBackupRetentionPeriod := "3d"

defaultDgAttr := map[string]attr.Value{
"region": basetypes.NewObjectValueMust(regionType, defaultRegion),
"cloud_provider": basetypes.NewObjectValueMust(cloudProviderType, defaultCloudProvider),
"storage": basetypes.NewObjectValueMust(storageAttrType, defaultStorage),
"cluster_name": basetypes.NewStringUnknown(),
"cluster_type": basetypes.NewStringUnknown(),
"conditions": basetypes.NewSetUnknown(conditionsElemType),
"connection_uri": basetypes.NewStringUnknown(),
"created_at": basetypes.NewStringUnknown(),
"group_id": basetypes.NewStringUnknown(),
"logs_url": basetypes.NewStringUnknown(),
"metrics_url": basetypes.NewStringUnknown(),
"phase": basetypes.NewStringUnknown(),
"resizing_pvc": basetypes.NewSetUnknown(resizingPvcElemType),
"allowed_ip_ranges": basetypes.NewSetValueMust(allowedIpRangesElemType, defaultAllowedIpRange),
"backup_retention_period": basetypes.NewStringValue(defaultBackupRetentionPeriod),
"cluster_architecture": basetypes.NewObjectValueMust(clusterArchAttrType, defaultClusterArch),
"csp_auth": basetypes.NewBoolValue(false),
"instance_type": basetypes.NewObjectValueMust(instanceTypeType, defaultInstanceType),
"pg_type": basetypes.NewObjectValueMust(pgTypeType, defaultPgType),
"pg_version": basetypes.NewObjectValueMust(pgVersionType, defaultPgVersion),
"private_networking": basetypes.NewBoolValue(false),
"maintenance_window": basetypes.NewObjectValueMust(cmwType, defaultCmw),
}

defaultDgAttrTypes := map[string]attr.Type{
"region": defaultDgAttr["region"].Type(ctx),
"cloud_provider": defaultDgAttr["cloud_provider"].Type(ctx),
"storage": defaultDgAttr["storage"].Type(ctx),
"cluster_name": defaultDgAttr["cluster_name"].Type(ctx),
"cluster_type": defaultDgAttr["cluster_type"].Type(ctx),
"conditions": defaultDgAttr["conditions"].Type(ctx),
"connection_uri": defaultDgAttr["connection_uri"].Type(ctx),
"created_at": defaultDgAttr["created_at"].Type(ctx),
"group_id": defaultDgAttr["group_id"].Type(ctx),
"logs_url": defaultDgAttr["logs_url"].Type(ctx),
"metrics_url": defaultDgAttr["metrics_url"].Type(ctx),
"phase": defaultDgAttr["phase"].Type(ctx),
"resizing_pvc": defaultDgAttr["resizing_pvc"].Type(ctx),
"allowed_ip_ranges": defaultDgAttr["allowed_ip_ranges"].Type(ctx),
"backup_retention_period": defaultDgAttr["backup_retention_period"].Type(ctx),
"cluster_architecture": defaultDgAttr["cluster_architecture"].Type(ctx),
"csp_auth": defaultDgAttr["csp_auth"].Type(ctx),
"instance_type": defaultDgAttr["instance_type"].Type(ctx),
"pg_type": defaultDgAttr["pg_type"].Type(ctx),
"pg_version": defaultDgAttr["pg_version"].Type(ctx),
"private_networking": defaultDgAttr["private_networking"].Type(ctx),
"maintenance_window": defaultDgAttr["maintenance_window"].Type(ctx),
}

defaultDgObject := basetypes.NewObjectValueMust(defaultDgAttrTypes, defaultDgAttr)
defaultDgObjects := []attr.Value{}
defaultDgObjects = append(defaultDgObjects, defaultDgObject)
defaultDgSet := basetypes.NewSetValueMust(defaultDgObject.Type(ctx), defaultDgObjects)

addGroupObject := map[string]attr.Value{
"region": basetypes.NewObjectValueMust(regionType,
map[string]attr.Value{
"region_id": basetypes.NewStringValue("us-east-2"),
},
),
"cloud_provider": basetypes.NewObjectValueMust(cloudProviderType, defaultCloudProvider),
"storage": basetypes.NewObjectValueMust(storageAttrType, defaultStorage),
"cluster_name": basetypes.NewStringUnknown(),
"cluster_type": basetypes.NewStringUnknown(),
"conditions": basetypes.NewSetUnknown(conditionsElemType),
"connection_uri": basetypes.NewStringUnknown(),
"created_at": basetypes.NewStringUnknown(),
"group_id": basetypes.NewStringUnknown(),
"logs_url": basetypes.NewStringUnknown(),
"metrics_url": basetypes.NewStringUnknown(),
"phase": basetypes.NewStringUnknown(),
"resizing_pvc": basetypes.NewSetUnknown(resizingPvcElemType),
"allowed_ip_ranges": basetypes.NewSetValueMust(allowedIpRangesElemType, defaultAllowedIpRange),
"backup_retention_period": basetypes.NewStringValue(defaultBackupRetentionPeriod),
"cluster_architecture": basetypes.NewObjectValueMust(clusterArchAttrType, defaultClusterArch),
"csp_auth": basetypes.NewBoolValue(false),
"instance_type": basetypes.NewObjectValueMust(instanceTypeType, defaultInstanceType),
"pg_type": basetypes.NewObjectValueMust(pgTypeType, defaultPgType),
"pg_version": basetypes.NewObjectValueMust(pgVersionType, defaultPgVersion),
"private_networking": basetypes.NewBoolValue(false),
"maintenance_window": basetypes.NewObjectValueMust(cmwType,
map[string]attr.Value{
"is_enabled": basetypes.NewBoolValue(true),
"start_day": basetypes.NewFloat64Value(2),
"start_time": basetypes.NewStringValue("06:00"),
},
),
}

updateObjectAttr := map[string]attr.Value{}

for k, v := range defaultDgAttr {
updateObjectAttr[k] = v
}

updateObjectAttr["allowed_ip_ranges"] = basetypes.NewSetValueMust(allowedIpRangesElemType, []attr.Value{
basetypes.NewObjectValueMust(allowedIpRangesElemObjectType, map[string]attr.Value{
"cidr_block": basetypes.NewStringValue("168.0.0.1/32"),
"description": basetypes.NewStringValue("updated"),
}),
})
updateObjectAttr["backup_retention_period"] = basetypes.NewStringValue("5d")
updateObjectAttr["cluster_architecture"] = basetypes.NewObjectValueMust(clusterArchAttrType, map[string]attr.Value{
"cluster_architecture_id": basetypes.NewStringValue("pgd"),
"cluster_architecture_name": basetypes.NewStringUnknown(),
"nodes": basetypes.NewFloat64Value(1),
"witness_nodes": basetypes.NewFloat64Unknown(),
})

updateObject := basetypes.NewObjectValueMust(defaultDgAttrTypes, updateObjectAttr)
updateObjects := []attr.Value{}
updateObjects = append(updateObjects, updateObject)
updateSet := basetypes.NewSetValueMust(defaultDgObject.Type(ctx), updateObjects)

type args struct {
ctx context.Context
req planmodifier.SetRequest
resp *planmodifier.SetResponse
}
tests := []struct {
name string
m plan_modifier.CustomDataGroupDiffModifier
args args
expectedWarningsCount int
expectedWarningSummary []string
expectedPlanElements []attr.Value
}{
{
name: "Add dg expected success",
args: args{
req: planmodifier.SetRequest{
StateValue: defaultDgSet,
},
resp: &planmodifier.SetResponse{
PlanValue: basetypes.NewSetValueMust(defaultDgObject.Type(ctx),
append(defaultDgObjects, basetypes.NewObjectValueMust(defaultDgAttrTypes, addGroupObject)),
),
},
},
expectedWarningsCount: 1,
expectedWarningSummary: []string{"Adding new data group"},
expectedPlanElements: append(defaultDgObjects, basetypes.NewObjectValueMust(defaultDgAttrTypes,
addGroupObject,
)),
},
{
name: "Remove dg expected success",
args: args{
req: planmodifier.SetRequest{
StateValue: basetypes.NewSetValueMust(defaultDgObject.Type(ctx),
append(defaultDgObjects, basetypes.NewObjectValueMust(defaultDgAttrTypes, addGroupObject)),
),
},
resp: &planmodifier.SetResponse{
PlanValue: defaultDgSet,
},
},
expectedWarningsCount: 1,
expectedWarningSummary: []string{"Removing data group"},
expectedPlanElements: defaultDgObjects,
},
{
name: "Update object expected success",
args: args{
req: planmodifier.SetRequest{
StateValue: defaultDgSet,
},
resp: &planmodifier.SetResponse{
PlanValue: updateSet,
},
},
expectedWarningsCount: 3,
expectedWarningSummary: []string{
"Allowed IP ranges changed",
"Backup retention changed",
"Cluster architecture changed",
},
expectedPlanElements: updateObjects,
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()

tt.m.PlanModifySet(tt.args.ctx, tt.args.req, tt.args.resp)

if tt.args.resp.Diagnostics.WarningsCount() != tt.expectedWarningsCount {
t.Fatalf("expected warning count: %v, got: %v", tt.expectedWarningsCount, tt.args.resp.Diagnostics.WarningsCount())
}

if tt.args.resp.Diagnostics.WarningsCount() != 0 {
for k, v := range tt.args.resp.Diagnostics.Warnings() {
if tt.expectedWarningSummary[k] != v.Summary() {
t.Fatalf("expected warning summary: %v, got: %v", tt.expectedWarningSummary[k], v.Summary())
}
}
}

if !reflect.DeepEqual(tt.expectedPlanElements, tt.args.resp.PlanValue.Elements()) {
t.Fatalf("expected plan elements: %v, got: %v", tt.expectedPlanElements, tt.args.resp.PlanValue.Elements())
}
})
}
}
Loading

0 comments on commit 530948d

Please sign in to comment.