HCCP91 hvn routes data source

docs/data-sources/hvn_route.md

@@ -0,0 +1,49 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "hcp_hvn_route Data Source - terraform-provider-hcp"
+subcategory: ""
+description: |-
+  The HVN route data source provides information about an existing HVN route.
+---
+
+# hcp_hvn_route (Data Source)
+
+The HVN route data source provides information about an existing HVN route.
+
+## Example Usage
+
+```terraform
+data "hcp_hvn_route" "example" {
+  hvn              = var.hvn
+  destination_cidr = var.destination_cidr
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **destination_cidr** (String) The destination CIDR of the HVN route
+- **hvn** (String) The `self_link` of the HashiCorp Virtual Network (HVN).
+
+### Optional
+
+- **id** (String) The ID of this resource.
+- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
+
+### Read-Only
+
+- **created_at** (String) The time that the HVN route was created.
+- **self_link** (String) A unique URL identifying the HVN route.
+- **state** (String) The state of the HVN route.
+- **target_link** (String) A unique URL identifying the target of the HVN route.
+
+<a id="nestedblock--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- **default** (String)
+
+

examples/data-sources/hcp_hvn_route/data-source.tf

@@ -0,0 +1,4 @@
+data "hcp_hvn_route" "example" {
+  hvn              = var.hvn
+  destination_cidr = var.destination_cidr
+}

examples/data-sources/hcp_hvn_route/variables.tf

@@ -0,0 +1,9 @@
+variable "hvn" {
+  description = "The `self_link` of the HashiCorp Virtual Network (HVN)."
+  type        = string
+}
+
+variable "destination_cidr" {
+  description = "The destination CIDR of the HVN route."
+  type        = string
+}

go.mod

@@ -3,12 +3,19 @@ module github.com/hashicorp/terraform-provider-hcp
 go 1.15
 
 require (
+	github.com/armon/go-radix v1.0.0 // indirect
+	github.com/aws/aws-sdk-go v1.37.0 // indirect
 	github.com/go-openapi/runtime v0.19.28
 	github.com/go-openapi/strfmt v0.20.1
 	github.com/google/uuid v1.2.0
 	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320
-	github.com/hashicorp/hcp-sdk-go v0.6.0
+	github.com/hashicorp/hcl/v2 v2.8.2 // indirect
+	github.com/hashicorp/hcp-sdk-go v0.7.0
+	github.com/hashicorp/terraform-exec v0.13.3 // indirect
 	github.com/hashicorp/terraform-plugin-docs v0.4.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.5.0
+	github.com/posener/complete v1.2.1 // indirect
 	github.com/stretchr/testify v1.7.0
+	golang.org/x/tools v0.0.0-20201028111035-eafbe7b904eb // indirect
+	google.golang.org/api v0.34.0 // indirect
 )

internal/clients/hvn_route.go

@@ -0,0 +1,30 @@
+package clients
+
+import (
+	"context"
+
+	"github.com/hashicorp/hcp-sdk-go/clients/cloud-network/preview/2020-09-07/client/network_service"
+	networkmodels "github.com/hashicorp/hcp-sdk-go/clients/cloud-network/preview/2020-09-07/models"
+	sharedmodels "github.com/hashicorp/hcp-sdk-go/clients/cloud-shared/v1/models"
+)
+
+// ListHVNRoutes lists the routes for an HVN.
+func ListHVNRoutes(ctx context.Context, client *Client, hvnID string,
+	destination string, targetID string, targetType string,
+	loc *sharedmodels.HashicorpCloudLocationLocation) ([]*networkmodels.HashicorpCloudNetwork20200907HVNRoute, error) {
+	listHVNRoutesParams := network_service.NewListHVNRoutesParams()
+	listHVNRoutesParams.Context = ctx
+	listHVNRoutesParams.HvnID = hvnID
+	listHVNRoutesParams.HvnLocationOrganizationID = loc.OrganizationID
+	listHVNRoutesParams.HvnLocationProjectID = loc.ProjectID
+	listHVNRoutesParams.Destination = &destination
+	listHVNRoutesParams.TargetID = &targetID
+	listHVNRoutesParams.TargetType = &targetType
+
+	listHVNRoutesResponse, err := client.Network.ListHVNRoutes(listHVNRoutesParams, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return listHVNRoutesResponse.Payload.Routes, nil
+}

internal/provider/data_source_hvn_route.go

@@ -0,0 +1,102 @@
+package provider
+
+import (
+	"context"
+	"log"
+
+	sharedmodels "github.com/hashicorp/hcp-sdk-go/clients/cloud-shared/v1/models"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-hcp/internal/clients"
+)
+
+func dataSourceHVNRoute() *schema.Resource {
+	return &schema.Resource{
+		Description: "The HVN route data source provides information about an existing HVN route.",
+		ReadContext: dataSourceHVNRouteRead,
+		Timeouts: &schema.ResourceTimeout{
+			Default: &hvnRouteDefaultTimeout,
+		},
+		Schema: map[string]*schema.Schema{
+			// Required inputs
+			"hvn": {
+				Description: "The `self_link` of the HashiCorp Virtual Network (HVN).",
+				Type:        schema.TypeString,
+				Required:    true,
+			},
+			"destination_cidr": {
+				Description:      "The destination CIDR of the HVN route",
+				Type:             schema.TypeString,
+				Required:         true,
+				ValidateDiagFunc: validateIsStartOfPrivateCIDRRange,
+			},
+			// Computed outputs
+			"self_link": {
+				Description: "A unique URL identifying the HVN route.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"target_link": {
+				Description: "A unique URL identifying the target of the HVN route.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"state": {
+				Description: "The state of the HVN route.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"created_at": {
+				Description: "The time that the HVN route was created.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+		},
+	}
+}
+
+func dataSourceHVNRouteRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*clients.Client)
+
+	hvn := d.Get("hvn").(string)
+	var hvnLink *sharedmodels.HashicorpCloudLocationLink
+
+	hvnLink, err := parseLinkURL(hvn, HvnResourceType)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	loc := &sharedmodels.HashicorpCloudLocationLocation{
+		OrganizationID: client.Config.OrganizationID,
+		ProjectID:      client.Config.ProjectID,
+	}
+	destination := d.Get("destination_cidr").(string)
+
+	log.Printf("[INFO] Reading HVN route for HVN (%s) with destination_cidr=%s ", hvn, destination)
+	route, err := clients.ListHVNRoutes(ctx, client, hvnLink.ID, destination, "", "", loc)
+	if err != nil {
+		return diag.Errorf("unable to retrieve HVN route for HVN (%s) with destination_cidr=%s: %v",
+			hvn, destination, err)
+	}
+
+	// ListHVNRoutes call should return 1 and only 1 HVN route.
+	if len(route) > 1 {
+		return diag.Errorf("Unexpected number of HVN routes returned for destination_cidr=%s: %d", destination, len(route))
+	}
+	if len(route) == 0 {
+		return diag.Errorf("No HVN route found for destionation_cidr=%s", destination)
+	}
+
+	link := newLink(loc, HVNRouteResourceType, route[0].ID)
+	url, err := linkURL(link)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	d.SetId(url)
+
+	if err := setHVNRouteResourceData(d, route[0], loc); err != nil {
+		return diag.FromErr(err)
+	}
+
+	return nil
+}

internal/provider/link.go

@@ -31,6 +31,9 @@ const (
 	// TgwAttachmentResourceType is the resource type of a TGW attachment
 	TgwAttachmentResourceType = "hashicorp.network.tgw-attachment"
 
+	// HVNRouteResourceType is the resource type of an HVN route
+	HVNRouteResourceType = "hashicorp.network.route"
+
 	// ConsulSnapshotResourceType is the resource type of a Consul snapshot
 	ConsulSnapshotResourceType = "hashicorp.consul.snapshot"
 

internal/provider/provider.go

@@ -25,6 +25,7 @@ func New() func() *schema.Provider {
 				"hcp_consul_cluster":                 dataSourceConsulCluster(),
 				"hcp_consul_versions":                dataSourceConsulVersions(),
 				"hcp_hvn":                            dataSourceHvn(),
+				"hcp_hvn_route":                      dataSourceHVNRoute(),
 				"hcp_vault_cluster":                  dataSourceVaultCluster(),
 			},
 			ResourcesMap: map[string]*schema.Resource{

internal/provider/resource_hvn_route.go

@@ -0,0 +1,51 @@
+package provider
+
+import (
+	"time"
+
+	networkmodels "github.com/hashicorp/hcp-sdk-go/clients/cloud-network/preview/2020-09-07/models"
+	sharedmodels "github.com/hashicorp/hcp-sdk-go/clients/cloud-shared/v1/models"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+var hvnRouteDefaultTimeout = time.Minute * 1
+
+func setHVNRouteResourceData(d *schema.ResourceData, route *networkmodels.HashicorpCloudNetwork20200907HVNRoute,
+	loc *sharedmodels.HashicorpCloudLocationLocation) error {
+
+	// Set self_link for the HVN route.
+	link := newLink(loc, HVNRouteResourceType, route.ID)
+	selfLink, err := linkURL(link)
+	if err != nil {
+		return err
+	}
+
+	if err := d.Set("self_link", selfLink); err != nil {
+		return err
+	}
+
+	// Set self_link identifying the target of the HVN route.
+	hvnLink := newLink(loc, route.Target.HvnConnection.Type, route.Target.HvnConnection.ID)
+	targetLink, err := linkURL(hvnLink)
+	if err != nil {
+		return err
+	}
+
+	if err := d.Set("target_link", targetLink); err != nil {
+		return err
+	}
+
+	if err := d.Set("destination_cidr", route.Destination); err != nil {
+		return err
+	}
+
+	if err := d.Set("state", route.State); err != nil {
+		return err
+	}
+
+	if err := d.Set("created_at", route.CreatedAt.String()); err != nil {
+		return err
+	}
+
+	return nil
+}

internal/provider/validators.go

@@ -2,6 +2,7 @@ package provider
 
 import (
 	"fmt"
+	"net"
 	"regexp"
 	"strings"
 
@@ -148,3 +149,60 @@ func validateConsulClusterSize(v interface{}, path cty.Path) diag.Diagnostics {
 
 	return diagnostics
 }
+
+// validateIsStartOfPrivateCIDRRange validates that a value passed is (a)a valid
+// CIDR, (b)a valid RFC 1819 address, and (c)at the start of the CIDR range.
+func validateIsStartOfPrivateCIDRRange(v interface{}, path cty.Path) diag.Diagnostics {
+	var diagnostics diag.Diagnostics
+
+	// Validation fails if value is not string.
+	s, ok := v.(string)
+	if !ok {
+		msg := fmt.Sprintf("expected type of %v to be string", v)
+		diagnostics = append(diagnostics, diag.Diagnostic{
+			Severity:      diag.Error,
+			Summary:       msg,
+			Detail:        msg,
+			AttributePath: path,
+		})
+		return diagnostics
+	}
+
+	// Validation fails if string cannot be parsed as CIDR.
+	ip, net, err := net.ParseCIDR(s)
+	if err != nil {
+		msg := fmt.Sprintf("expected \"%v\" to be a valid IPv4 value", v)
+		diagnostics = append(diagnostics, diag.Diagnostic{
+			Severity:      diag.Error,
+			Summary:       msg,
+			Detail:        msg,
+			AttributePath: path,
+		})
+		return diagnostics
+	}
+
+	// Validation fails if address is not within valid RFC 1819 ranges
+	if !regexp.MustCompile(`^(10|172\.(1[6-9]|2[0-9]|3[0-1])|192\.168)\..*`).MatchString(v.(string)) {
+		msg := "must be within 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16"
+		diagnostics = append(diagnostics, diag.Diagnostic{
+			Severity:      diag.Error,
+			Summary:       msg,
+			Detail:        msg,
+			AttributePath: path,
+		})
+		return diagnostics
+	}
+
+	// Validation fails if value is not at the beginning of the CIDR range.
+	if !ip.Equal(net.IP) {
+		msg := fmt.Sprintf("invalid CIDR range start %v, should have been %v", ip, net.IP)
+		diagnostics = append(diagnostics, diag.Diagnostic{
+			Severity:      diag.Error,
+			Summary:       msg,
+			Detail:        msg + "; CIDR value must be at the start of the range",
+			AttributePath: path,
+		})
+	}
+
+	return diagnostics
+}