Port 10156 bug terraform blueprint unable to add property of type enum list (#267)

* add dynamic unknown fields to the blueprint property types

* use reflaction to get the known fields

* use any instead of interface

* fix eyal pr comments

* add support for array enum properties

* add docs

* remove redundant lines

* remove redundant lines

* fix comments

Author: itamar-smirra-port

docs/resources/port_blueprint.md

@@ -405,6 +405,8 @@ Optional:
 Optional:
 
 - `default` (List of String) The default of the items
+- `enum` (List of String) The enum of the string array items
+- `enum_colors` (Map of String) The enum colors of the string array items
 - `format` (String) The format of the items
 - `pattern` (String) The pattern of the string array items
 

docs/resources/port_system_blueprint.md

@@ -117,6 +117,8 @@ Optional:
 Optional:
 
 - `default` (List of String) The default of the items
+- `enum` (List of String) The enum of the string array items
+- `enum_colors` (Map of String) The enum colors of the string array items
 - `format` (String) The format of the items
 - `pattern` (String) The pattern of the string array items
 

examples/resources/port_blueprint/main.tf

@@ -42,6 +42,19 @@ resource "port_blueprint" "microservice" {
   icon       = "GPU"
   identifier = "hedwig-microservice"
   properties = {
+    array_props = {
+      enum = {
+        type  = "array"
+        title = "enum"
+        string_items = {
+          enum        = ["default", "default2"]
+          enum_colors = {
+            default  = "red"
+            default2 = "green"
+          }
+        }
+      }
+    }
     string_props = {
       name = {
         type  = "string"
@@ -113,9 +126,9 @@ resource "port_blueprint" "pull_request_blueprint" {
     }
   }
   relations = {
-    "repository" = {
-      title  = "Repository"
-      target = port_blueprint.repository_blueprint.identifier
+    "self" = {
+      title  = "Self"
+      target = "pull_request"
     }
   }
 }

port/blueprint/array.go

@@ -2,6 +2,7 @@ package blueprint
 
 import (
 	"context"
+
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
@@ -59,6 +60,26 @@ func arrayPropResourceToBody(ctx context.Context, state *PropertiesModel, props
 
 					property.Default = defaultList
 				}
+				if !prop.StringItems.Enum.IsNull() {
+					enumList, err := utils.TerraformListToGoArray(ctx, prop.StringItems.Enum, "string")
+					if err != nil {
+						return err
+					}
+					items["enum"] = enumList
+				}
+				if !prop.StringItems.EnumColors.IsNull() {
+					enumColors := map[string]string{}
+					for k, v := range prop.StringItems.EnumColors.Elements() {
+						value, _ := v.ToTerraformValue(ctx)
+						var keyValue string
+						err := value.As(&keyValue)
+						if err != nil {
+							return err
+						}
+						enumColors[k] = keyValue
+					}
+					items["enumColors"] = enumColors
+				}
 				property.Items = items
 			}
 
@@ -112,7 +133,7 @@ func arrayPropResourceToBody(ctx context.Context, state *PropertiesModel, props
 	return nil
 }
 
-func AddArrayPropertiesToState(v *cli.BlueprintProperty, jsonEscapeHTML bool) *ArrayPropModel {
+func AddArrayPropertiesToState(ctx context.Context, v *cli.BlueprintProperty, jsonEscapeHTML bool) *ArrayPropModel {
 	arrayProp := &ArrayPropModel{
 		MinItems: flex.GoInt64ToFramework(v.MinItems),
 		MaxItems: flex.GoInt64ToFramework(v.MaxItems),
@@ -142,6 +163,20 @@ func AddArrayPropertiesToState(v *cli.BlueprintProperty, jsonEscapeHTML bool) *A
 				if value, ok := v.Items["pattern"]; ok && value != nil {
 					arrayProp.StringItems.Pattern = types.StringValue(v.Items["pattern"].(string))
 				}
+				if value, ok := v.Items["enum"]; ok && value != nil {
+					attrs := make([]attr.Value, 0, len(value.([]interface{})))
+					for _, enumValue := range value.([]interface{}) {
+						attrs = append(attrs, basetypes.NewStringValue(enumValue.(string)))
+					}
+					arrayProp.StringItems.Enum, _ = types.ListValue(types.StringType, attrs)
+				} else {
+					arrayProp.StringItems.Enum = types.ListNull(types.StringType)
+				}
+				if value, ok := v.Items["enumColors"]; ok && value != nil {
+					arrayProp.StringItems.EnumColors, _ = types.MapValueFrom(ctx, types.StringType, value)
+				} else {
+					arrayProp.StringItems.EnumColors = types.MapNull(types.StringType)
+				}
 			case "number":
 				arrayProp.NumberItems = &NumberItems{}
 				if v.Default != nil {

port/blueprint/model.go

@@ -61,9 +61,11 @@ type BooleanPropModel struct {
 }
 
 type StringItems struct {
-	Format  types.String `tfsdk:"format"`
-	Default types.List   `tfsdk:"default"`
-	Pattern types.String `tfsdk:"pattern"`
+	Format  types.String  `tfsdk:"format"`
+	Default types.List    `tfsdk:"default"`
+	Pattern types.String  `tfsdk:"pattern"`
+	Enum    types.List    `tfsdk:"enum"`
+	EnumColors types.Map  `tfsdk:"enum_colors"`
 }
 
 type NumberItems struct {

port/blueprint/resource_test.go

@@ -3,7 +3,6 @@ package blueprint_test
 import (
 	"context"
 	"fmt"
-	"github.com/stretchr/testify/require"
 	"math/rand"
 	"net/http"
 	"os"
@@ -14,6 +13,8 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/cli"
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/consts"
 	"github.com/port-labs/terraform-provider-port-labs/v2/version"
@@ -248,6 +249,16 @@ func TestAccPortBlueprintArrayProperty(t *testing.T) {
 						default = [jsonencode({"a": "b"}), jsonencode({"c": "d"})]
 					}
 				}
+				myEnumArrayIdentifier = {
+					title = "enum"
+					string_items = {
+						enum        = ["default", "default2"]
+						enum_colors = {
+							default  = "red"
+							default2 = "green"
+						}
+					}
+				}	
 			}
 		}
 	}`, identifier)
@@ -279,6 +290,10 @@ func TestAccPortBlueprintArrayProperty(t *testing.T) {
 					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myBooleanArrayIdentifier.boolean_items.default.1", "true"),
 					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myObjectArrayIdentifier.object_items.default.0", "{\"a\":\"b\"}"),
 					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myObjectArrayIdentifier.object_items.default.1", "{\"c\":\"d\"}"),
+					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myEnumArrayIdentifier.string_items.enum.0", "default"),
+					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myEnumArrayIdentifier.string_items.enum.1", "default2"),
+					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myEnumArrayIdentifier.string_items.enum_colors.default", "red"),
+					resource.TestCheckResourceAttr("port_blueprint.microservice", "properties.array_props.myEnumArrayIdentifier.string_items.enum_colors.default2", "green"),
 				),
 			},
 		},

port/blueprint/schema.go

@@ -213,6 +213,17 @@ func ArrayPropertySchema() schema.MapNestedAttribute {
 						stringvalidator.RegexMatches(regexp.MustCompile(`^.*$`), "must be a valid regular expression"),
 					},
 				},
+				"enum": schema.ListAttribute{
+					MarkdownDescription: "The enum of the string array items",
+					Optional:            true,
+					ElementType:         types.StringType,
+					Validators:          []validator.List{listvalidator.UniqueValues(), listvalidator.SizeAtLeast(1)},
+				},
+				"enum_colors": schema.MapAttribute{
+					MarkdownDescription: "The enum colors of the string array items",
+					Optional:            true,
+					ElementType:         types.StringType,
+				},
 			},
 		},
 		"number_items": schema.SingleNestedAttribute{

port/blueprint/updatePropertiesToState.go

@@ -2,6 +2,7 @@ package blueprint
 
 import (
 	"context"
+
 	"github.com/port-labs/terraform-provider-port-labs/v2/internal/utils"
 
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -113,7 +114,7 @@ func (r *BlueprintResource) updatePropertiesToState(ctx context.Context, b *cli.
 				properties.ArrayProps = make(map[string]ArrayPropModel)
 			}
 
-			arrayProp := AddArrayPropertiesToState(&v, r.portClient.JSONEscapeHTML)
+			arrayProp := AddArrayPropertiesToState(ctx, &v, r.portClient.JSONEscapeHTML)
 
 			if lo.Contains(b.Schema.Required, k) {
 				arrayProp.Required = types.BoolValue(true)

port/system_blueprint/updatePropertiesToState.go

@@ -60,7 +60,7 @@ func (r *Resource) updatePropertiesToState(ctx context.Context, b *cli.Blueprint
 				properties.ArrayProps = make(map[string]blueprint.ArrayPropModel)
 			}
 
-			arrayProp := blueprint.AddArrayPropertiesToState(&v, r.client.JSONEscapeHTML)
+			arrayProp := blueprint.AddArrayPropertiesToState(ctx, &v, r.client.JSONEscapeHTML)
 
 			if lo.Contains(b.Schema.Required, k) {
 				arrayProp.Required = types.BoolValue(true)