PORT-3191-terraform-provider-support-many-relation-embedded-url-authentication (#39)

Author: dvirsegev

docs/resources/blueprint.md

@@ -61,6 +61,17 @@ Optional:
 - `items` (Map of String) A metadata of an array's items, in case the type is an array
 - `required` (Boolean) Whether or not the property is required
 - `spec` (String) The specification of the property, one of "async-api", "open-api", "embedded-url"
+- `spec_authentication` (Block List, Max: 1) The authentication of the specification (see [below for nested schema](#nestedblock--properties--spec_authentication))
+
+<a id="nestedblock--properties--spec_authentication"></a>
+
+### Nested Schema for `properties.spec_authentication`
+
+Required:
+
+- `authorization_url` (String) The authorization url of the specification
+- `client_id` (String) The client id of the specification
+- `token_url` (String) The token url of the specification
 
 <a id="nestedblock--calculation_properties"></a>
 

docs/resources/entity.md

@@ -56,7 +56,11 @@ Optional:
 
 Required:
 
-- `identifier` (String) The id of the connected entity
 - `name` (String) The name of the relation
 
+Optional:
+
+- `identifier` (String) The id of the connected entity
+- `identifiers` (Set of String) The ids of the connected entities
+
 

port/cli/models.go

@@ -24,24 +24,31 @@ type (
 		Blueprint  string                 `json:"blueprint"`
 		Team       []string               `json:"team,omitempty"`
 		Properties map[string]interface{} `json:"properties"`
-		Relations  map[string]string      `json:"relations"`
+		Relations  map[string]interface{} `json:"relations"`
 		// TODO: add the rest of the fields.
 	}
 
 	BlueprintProperty struct {
-		Type        string            `json:"type,omitempty"`
-		Title       string            `json:"title,omitempty"`
-		Identifier  string            `json:"identifier,omitempty"`
-		Items       map[string]any    `json:"items,omitempty"`
-		Default     interface{}       `json:"default,omitempty"`
-		Icon        string            `json:"icon,omitempty"`
-		Format      string            `json:"format,omitempty"`
-		Description string            `json:"description,omitempty"`
-		Blueprint   string            `json:"blueprint,omitempty"`
-		Pattern     string            `json:"pattern,omitempty"`
-		Enum        []string          `json:"enum,omitempty"`
-		Spec        string            `json:"spec,omitempty"`
-		EnumColors  map[string]string `json:"enumColors,omitempty"`
+		Type               string              `json:"type,omitempty"`
+		Title              string              `json:"title,omitempty"`
+		Identifier         string              `json:"identifier,omitempty"`
+		Items              map[string]any      `json:"items,omitempty"`
+		Default            interface{}         `json:"default,omitempty"`
+		Icon               string              `json:"icon,omitempty"`
+		Format             string              `json:"format,omitempty"`
+		Description        string              `json:"description,omitempty"`
+		Blueprint          string              `json:"blueprint,omitempty"`
+		Pattern            string              `json:"pattern,omitempty"`
+		Enum               []string            `json:"enum,omitempty"`
+		Spec               string              `json:"spec,omitempty"`
+		SpecAuthentication *SpecAuthentication `json:"specAuthentication,omitempty"`
+		EnumColors         map[string]string   `json:"enumColors,omitempty"`
+	}
+
+	SpecAuthentication struct {
+		ClientId         string `json:"clientId,omitempty"`
+		AuthorizationUrl string `json:"authorizationUrl,omitempty"`
+		TokenUrl         string `json:"tokenUrl,omitempty"`
 	}
 
 	BlueprintCalculationProperty struct {

port/resource_port_blueprint.go

@@ -151,6 +151,32 @@ func newBlueprintResource() *schema.Resource {
 							ValidateFunc: validation.StringInSlice([]string{"async-api", "open-api", "embedded-url"}, false),
 							Description:  "The specification of the property, one of \"async-api\", \"open-api\", \"embedded-url\"",
 						},
+						"spec_authentication": {
+							Type:     schema.TypeList,
+							Optional: true,
+							MinItems: 1,
+							MaxItems: 1,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"client_id": {
+										Type:        schema.TypeString,
+										Required:    true,
+										Description: "The client id of the specification",
+									},
+									"authorization_url": {
+										Type:        schema.TypeString,
+										Required:    true,
+										Description: "The authorization url of the specification",
+									},
+									"token_url": {
+										Type:        schema.TypeString,
+										Required:    true,
+										Description: "The token url of the specification",
+									},
+								},
+							},
+							Description: "The authentication of the specification",
+						},
 						"enum": {
 							Elem: &schema.Schema{
 								Type: schema.TypeString,
@@ -419,6 +445,14 @@ func writeBlueprintFieldsToResource(d *schema.ResourceData, b *cli.Blueprint) {
 			writeDefaultFieldToResource(v, k, d, p)
 		}
 
+		if v.SpecAuthentication != nil {
+			p["spec_authentication"] = []any{map[string]any{
+				"token_url":         v.SpecAuthentication.TokenUrl,
+				"client_id":         v.SpecAuthentication.ClientId,
+				"authorization_url": v.SpecAuthentication.AuthorizationUrl,
+			}}
+		}
+
 		properties.Add(p)
 	}
 
@@ -591,6 +625,21 @@ func blueprintResourceToBody(d *schema.ResourceData) (*cli.Blueprint, error) {
 			propFields.Spec = s.(string)
 		}
 
+		if s, ok := p["spec_authentication"]; ok && len(s.([]any)) > 0 {
+			if propFields.Spec != "embedded-url" {
+				return nil, fmt.Errorf("spec_authentication can only be used when spec is embedded-url for property %s", p["identifier"].(string))
+			}
+
+			if propFields.SpecAuthentication == nil {
+				propFields.SpecAuthentication = &cli.SpecAuthentication{}
+			}
+
+			propFields.SpecAuthentication.TokenUrl = s.([]any)[0].(map[string]interface{})["token_url"].(string)
+			propFields.SpecAuthentication.AuthorizationUrl = s.([]any)[0].(map[string]interface{})["authorization_url"].(string)
+			propFields.SpecAuthentication.ClientId = s.([]any)[0].(map[string]interface{})["client_id"].(string)
+
+		}
+
 		if r, ok := p["required"]; ok && r.(bool) {
 			required = append(required, p["identifier"].(string))
 		}

port/resource_port_blueprint_test.go

@@ -179,6 +179,11 @@ func TestAccBlueprintWithSpecification(t *testing.T) {
 			type = "string"
 			format = "url"
 			spec = "embedded-url"
+			spec_authentication {
+				token_url = "https://getport.io"
+				client_id = "123"
+				authorization_url = "https://getport.io"
+			}
 		}
 	}
 `, identifier)
@@ -191,6 +196,7 @@ func TestAccBlueprintWithSpecification(t *testing.T) {
 				Config: testAccActionConfigCreate,
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("port-labs_blueprint.microservice", "properties.0.spec", "embedded-url"),
+					resource.TestCheckResourceAttr("port-labs_blueprint.microservice", "properties.0.spec_authentication.0.token_url", "https://getport.io"),
 				),
 			},
 		},

port/resource_port_entity.go

@@ -67,9 +67,17 @@ func newEntityResource() *schema.Resource {
 						},
 						"identifier": {
 							Type:        schema.TypeString,
-							Required:    true,
+							Optional:    true,
 							Description: "The id of the connected entity",
 						},
+						"identifiers": {
+							Type:        schema.TypeSet,
+							Optional:    true,
+							Description: "The ids of the connected entities",
+							Elem: &schema.Schema{
+								Type: schema.TypeString,
+							},
+						},
 					},
 				},
 				Optional: true,
@@ -163,6 +171,18 @@ func convert(prop map[string]interface{}, bp *cli.Blueprint) (interface{}, error
 	return "", fmt.Errorf("unsupported type %s", valType)
 }
 
+func validateRelation(rel map[string]interface{}) error {
+	if rel["identifier"] == "" && len(rel["identifiers"].(*schema.Set).List()) == 0 {
+		return fmt.Errorf("either relation identifier or identifiers is required for %s", rel["name"])
+	}
+
+	if rel["identifier"] != "" && len(rel["identifiers"].(*schema.Set).List()) > 0 {
+		return fmt.Errorf("either relation identifier or identifiers is required for %s", rel["name"])
+	}
+
+	return nil
+}
+
 func entityResourceToBody(d *schema.ResourceData, bp *cli.Blueprint) (*cli.Entity, error) {
 	e := &cli.Entity{}
 	if identifier, ok := d.GetOk("identifier"); ok {
@@ -190,11 +210,23 @@ func entityResourceToBody(d *schema.ResourceData, bp *cli.Blueprint) (*cli.Entit
 	e.Team = teams
 
 	rels := d.Get("relations").(*schema.Set)
-	relations := make(map[string]string)
+	relations := make(map[string]interface{})
 	for _, rel := range rels.List() {
 		r := rel.(map[string]interface{})
-		relations[r["name"].(string)] = r["identifier"].(string)
+		identifier := r["identifier"].(string)
+		identifiers := r["identifiers"].(*schema.Set).List()
+		err := validateRelation(r)
+		if err != nil {
+			return nil, err
+		}
+
+		if identifier != "" {
+			relations[r["name"].(string)] = identifier
+		} else {
+			relations[r["name"].(string)] = identifiers
+		}
 	}
+
 	e.Relations = relations
 	props := d.Get("properties").(*schema.Set)
 	properties := make(map[string]interface{}, props.Len())
@@ -269,6 +301,28 @@ func writeEntityFieldsToResource(d *schema.ResourceData, e *cli.Entity) {
 		properties.Add(p)
 	}
 	d.Set("properties", &properties)
+
+	relations := schema.Set{F: func(i interface{}) int {
+		name := (i.(map[string]interface{}))["name"].(string)
+		return schema.HashString(name)
+	}}
+
+	for k, v := range e.Relations {
+		if v == nil {
+			continue
+		}
+		r := map[string]interface{}{}
+		r["name"] = k
+		switch t := v.(type) {
+		case []interface{}:
+			r["identifiers"] = t
+		case string:
+			r["identifier"] = t
+		}
+		relations.Add(r)
+
+	}
+	d.Set("relations", &relations)
 }
 
 func createEntity(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {

port/resource_port_entity_test.go

@@ -289,3 +289,81 @@ func TestAccPortEntitiesRelation(t *testing.T) {
 		},
 	})
 }
+
+func TestAccPortEntitiesManyRelation(t *testing.T) {
+	identifier1 := genID()
+	identifier2 := genID()
+	var testAccActionConfigCreate = fmt.Sprintf(`
+	resource "port-labs_blueprint" "microservice" {
+		title = "TF Provider Test BP0"
+		icon = "Terraform"
+		identifier = "%s"
+		properties {
+			identifier = "text"
+			type = "string"
+			title = "text"
+		}
+		relations {
+			identifier = "tf-relation"
+			title = "Test Relation"
+			target = port-labs_blueprint.env.identifier
+			many = true
+		}
+	}
+	resource "port-labs_blueprint" "env" {
+		title = "TF Provider Test BP0"
+		icon = "Terraform"
+		identifier = "%s"
+		properties {
+			identifier = "str"
+			type = "string"
+			title = "text"
+		}
+	}
+	resource "port-labs_entity" "microservice" {
+		title = "monolith"
+		blueprint = port-labs_blueprint.microservice.id
+		relations {
+			name = "tf-relation"
+			identifiers = ["production","staging"]
+		}
+		properties {
+			name = "text"
+			value = "test-relation"
+		}
+	}
+	resource "port-labs_entity" "env" {
+		title = "staging"
+		identifier = "staging"
+		blueprint = port-labs_blueprint.env.id
+		properties {
+			name = "str"
+			value = "test-many-relation"
+		}
+	}
+
+	resource "port-labs_entity" "env2" {
+		title = "production"
+		identifier = "production"
+		blueprint = port-labs_blueprint.env.id
+		properties {
+			name = "str"
+			value = "test-many-relation"
+		}
+	}
+`, identifier1, identifier2)
+	resource.Test(t, resource.TestCase{
+		Providers: map[string]*schema.Provider{
+			"port-labs": Provider(),
+		},
+		Steps: []resource.TestStep{
+			{
+				Config: testAccActionConfigCreate,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("port-labs_entity.microservice", "relations.0.identifiers.0", "production"),
+					resource.TestCheckResourceAttr("port-labs_entity.microservice", "relations.0.identifiers.1", "staging"),
+				),
+			},
+		},
+	})
+}