Merge pull request #568 from vmware/vra_network

Add support for filters at vra_network datasource

Author: frodenas

Diff for: go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320
 	github.com/hashicorp/go-version v1.7.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.35.0
-	github.com/vmware/vra-sdk-go v0.6.1
+	github.com/vmware/vra-sdk-go v0.6.2
 )
 
 require (

Diff for: go.sum

@@ -176,8 +176,6 @@ github.com/hashicorp/terraform-registry-address v0.2.3 h1:2TAiKJ1A3MAkZlH1YI/aTV
 github.com/hashicorp/terraform-registry-address v0.2.3/go.mod h1:lFHA76T8jfQteVfT7caREqguFrW3c4MFSPhZB7HHgUM=
 github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ=
 github.com/hashicorp/terraform-svchost v0.1.1/go.mod h1:mNsjQfZyf/Jhz35v6/0LWcv26+X7JPS+buii2c9/ctc=
-github.com/hashicorp/yamux v0.1.1 h1:yrQxtgseBDrq9Y652vSRDvsKCJKOUD+GzTS4Y0Y8pvE=
-github.com/hashicorp/yamux v0.1.1/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
 github.com/hashicorp/yamux v0.1.2 h1:XtB8kyFOyHXYVFnwT5C3+Bdo8gArse7j2AQ0DA0Uey8=
 github.com/hashicorp/yamux v0.1.2/go.mod h1:C+zze2n6e/7wshOZep2A70/aQU6QBRWJO/G6FT1wIns=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
@@ -282,8 +280,8 @@ github.com/vmihailenco/msgpack/v5 v5.4.1 h1:cQriyiUvjTwOHg8QZaPihLWeRAAVoCpE00IU
 github.com/vmihailenco/msgpack/v5 v5.4.1/go.mod h1:GaZTsDaehaPpQVyxrf5mtQlH+pc21PIudVV/E3rRQok=
 github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
 github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds=
-github.com/vmware/vra-sdk-go v0.6.1 h1:2DscXG18be7MknOX1zIZFekB/NQV3eJyH1dEkX1E0+4=
-github.com/vmware/vra-sdk-go v0.6.1/go.mod h1:gUj5Z/+qvXEDk9+0NvW0ynDrMkTk3P5Bdt2JfN+AAC8=
+github.com/vmware/vra-sdk-go v0.6.2 h1:fJ03oxQj0q0wfDnVqs8vmo84L+91iZnI4cu8XXcR0b4=
+github.com/vmware/vra-sdk-go v0.6.2/go.mod h1:gUj5Z/+qvXEDk9+0NvW0ynDrMkTk3P5Bdt2JfN+AAC8=
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
 github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
 github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI=

Diff for: vra/data_source_network.go

@@ -5,8 +5,8 @@
 package vra
 
 import (
+	"errors"
 	"fmt"
-	"strings"
 
 	"github.com/vmware/vra-sdk-go/pkg/client/network"
 	"github.com/vmware/vra-sdk-go/pkg/models"
@@ -19,69 +19,90 @@ func dataSourceNetwork() *schema.Resource {
 		Read: dataSourceNetworkRead,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
+				Type:          schema.TypeString,
+				ConflictsWith: []string{"name", "filter"},
+				Optional:      true,
+				Computed:      true,
+				Description:   "The id of the network instance",
 			},
 			"name": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
-				DiffSuppressFunc: func(_, old, new string, _ *schema.ResourceData) bool {
-					return !strings.HasPrefix(new, old)
-				},
+				Type:          schema.TypeString,
+				ConflictsWith: []string{"id", "filter"},
+				Optional:      true,
+				Computed:      true,
+				Description:   "The human-friendly name of the network instance",
 			},
-			"cidr": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"filter": {
+				Type:          schema.TypeString,
+				ConflictsWith: []string{"id", "name"},
+				Optional:      true,
+				Description:   "The search criteria to narrow down the network instance",
 			},
-			"description": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"cidr": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "IPv4 address range of the network in CIDR format",
 			},
-			"deployment_id": {
-				Type:     schema.TypeString,
-				Computed: true,
-			},
-			"project_id": {
-				Type:     schema.TypeString,
+			"cloud_account_ids": {
+				Type:     schema.TypeSet,
 				Computed: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				Description: "Set of ids of the cloud accounts this resource belongs to",
 			},
 			"custom_properties": {
-				Type:     schema.TypeMap,
-				Computed: true,
+				Type:        schema.TypeMap,
+				Computed:    true,
+				Description: "Additional properties that may be used to extend the base resource",
 			},
-			"constraints": constraintsSchema(),
-			"tags":        tagsSchema(),
-			"outbound_access": {
-				Type:     schema.TypeBool,
-				Computed: true,
+			"deployment_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "Deployment id that is associated with this resource",
 			},
-			"external_zone_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"description": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "A human-friendly description",
 			},
 			"external_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "External entity Id on the provider side",
 			},
-			"self_link": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"external_region_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The external regionId of the resource",
 			},
-			"updated_at": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"external_zone_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The external zoneId of the resource",
+			},
+			"links": linksSchema(),
+			"organization_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The id of the organization this entity belongs to",
 			},
 			"owner": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "Email of the user or display name of the group that owns the entity",
 			},
-			"organization_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+			"project_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The id of the project this resource belongs to",
+			},
+			"tags": tagsSchema(),
+			"updated_at": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "Date when the entity was last updated. The date is ISO 8601 and UTC",
 			},
-			"links": linksSchema(),
 		},
 	}
 }
@@ -91,41 +112,73 @@ func dataSourceNetworkRead(d *schema.ResourceData, meta interface{}) error {
 
 	id, idOk := d.GetOk("id")
 	name, nameOk := d.GetOk("name")
+	filter, filterOK := d.GetOk("filter")
 
-	if !idOk && !nameOk {
-		return fmt.Errorf("One of id or name must be assigned")
+	if !idOk && !nameOk && !filterOK {
+		return errors.New("one of id, name or filter must be assigned")
 	}
 
-	getResp, err := apiClient.Network.GetNetworks(network.NewGetNetworksParams())
-	if err != nil {
-		return err
-	}
+	var net *models.Network
+	if idOk {
+		getResp, err := apiClient.Network.GetNetwork(network.NewGetNetworkParams().WithID(id.(string)))
+		if err != nil {
+			switch err.(type) {
+			case *network.GetNetworkNotFound:
+				return fmt.Errorf("network with id '%s' not found", id)
+			default:
+				// nop
+			}
+			return err
+		}
 
-	setFields := func(network *models.Network) {
-		d.SetId(*network.ID)
-		d.Set("cidr", network.Cidr)
-		d.Set("custom_properties", network.CustomProperties)
-		d.Set("description", network.Description)
-		d.Set("deployment_id", network.DeploymentID)
-		d.Set("external_id", network.ExternalID)
-		d.Set("external_zone_id", network.ExternalZoneID)
-		d.Set("name", network.Name)
-		d.Set("organization_id", network.OrgID)
-		d.Set("owner", network.Owner)
-		d.Set("project_id", network.ProjectID)
-		d.Set("tags", network.Tags)
-		d.Set("updated_at", network.UpdatedAt)
-	}
-	for _, network := range getResp.Payload.Content {
-		if idOk && network.ID == id {
-			setFields(network)
-			return nil
+		net = getResp.GetPayload()
+	} else {
+		var filterParam string
+		if nameOk {
+			filterParam = fmt.Sprintf("name eq '%s'", name.(string))
+		} else {
+			filterParam = filter.(string)
 		}
-		if nameOk && network.Name == name {
-			setFields(network)
-			return nil
+		getResp, err := apiClient.Network.GetNetworks(network.NewGetNetworksParams().WithDollarFilter(&filterParam))
+		if err != nil {
+			return err
 		}
+		networks := getResp.GetPayload()
+		if len(networks.Content) > 1 {
+			if nameOk {
+				return fmt.Errorf("there are more than one network with name '%s'", name)
+			}
+			return errors.New("must filter to one network")
+		}
+		if len(networks.Content) == 0 {
+			if nameOk {
+				return fmt.Errorf("network with name '%s' not found", name)
+			}
+			return fmt.Errorf("filter doesn't match to any network")
+		}
+		net = networks.Content[0]
+	}
+
+	d.SetId(*net.ID)
+	d.Set("cidr", net.Cidr)
+	d.Set("cloud_account_ids", net.CloudAccountIds)
+	d.Set("created_at", net.CreatedAt)
+	d.Set("custom_properties", net.CustomProperties)
+	d.Set("deployment_id", net.DeploymentID)
+	d.Set("description", net.Description)
+	d.Set("external_id", net.ExternalID)
+	d.Set("external_region_id", net.ExternalRegionID)
+	d.Set("external_zone_id", net.ExternalZoneID)
+	d.Set("name", net.Name)
+	d.Set("organization_id", net.OrgID)
+	d.Set("owner", net.Owner)
+	d.Set("project_id", net.ProjectID)
+	d.Set("tags", net.Tags)
+	d.Set("updated_at", net.UpdatedAt)
+
+	if err := d.Set("links", flattenLinks(net.Links)); err != nil {
+		return fmt.Errorf("error setting network links - error: %#v", err)
 	}
 
-	return fmt.Errorf("network %s not found", name)
+	return nil
 }

Diff for: website/docs/d/vra_network.html.markdown

@@ -9,25 +9,43 @@ description: |-
 
 This is an example of how to read a network data source.
 
+**Network data source by id:**
+
 ```hcl
+data "vra_network" "test-network" {
+  id = var.network_id
+}
+```
 
+**Network data source by name:**
+
+```hcl
 data "vra_network" "test-network" {
   name = var.network_name
 }
+```
+
+**Network data source by filter:**
 
+```hcl
+data "vra_network" "test-network" {
+  filter = "name eq '${var.network_name}'"
+}
 ```
 
 ## Argument Reference
 
-* `id` - (Optional) The id of the image profile instance.
+* `id` - (Optional) The id of the network instance. Only one of 'id', 'name' or 'filter' must be specified.
+
+* `name` - (Optional) The human-friendly name of the network instance. Only one of 'id', 'name' or 'filter' must be specified.
 
-* `name` - (Optional) A human-friendly name used as an identifier in APIs that support this option.
+* `filter` - (Optional) The search criteria to narrow down the network instance. Only one of 'id', 'name' or 'filter' must be specified.
 
 ## Attribute Reference
 
 * `cidr` - IPv4 address range of the network in CIDR format.
 
-* `constraints` - List of storage, network and extensibility constraints to be applied when provisioning through this project.
+* `cloud_account_ids` - Set of ids of the cloud accounts this resource belongs to.
 
 * `custom_properties` - Additional properties that may be used to extend the base resource.
 
@@ -37,20 +55,18 @@ data "vra_network" "test-network" {
 
 * `external_id` - External entity Id on the provider side.
 
+* `external_region_id` - The external regionId of the resource.
+
 * `external_zone_id` - The external zoneId of the resource.
 
 * `links` - HATEOAS of the entity
 
 * `organization_id` - The id of the organization this entity belongs to.
 
-* `outbound_access` - Flag to indicate if the network needs to have outbound access or not. Default is true. This field will be ignored if there is proper input for networkType customProperty
-
-* `owner` - Email of the user that owns the entity.
+* `owner` - Email of the user or display name of the group that owns the entity.
 
 * `project_id` - The id of the project this resource belongs to.
 
-* `self_link` - Self link of this request.
-
 * `tags` - A set of tag keys and optional values that were set on this resource.
            example: `[ { "key" : "ownedBy", "value": "Rainpole" } ]`