provider/azure: added local network gateway resource

aznashwan · aznashwan · commit 1eb129a99b89 · 2015-12-23T18:49:21.000+02:00
diff --git a/builtin/providers/azurerm/provider.go b/builtin/providers/azurerm/provider.go
@@ -37,8 +37,9 @@ func Provider() terraform.ResourceProvider {
 		},
 
 		ResourcesMap: map[string]*schema.Resource{
-			"azurerm_resource_group":  resourceArmResourceGroup(),
-			"azurerm_virtual_network": resourceArmVirtualNetwork(),
+			"azurerm_resource_group":        resourceArmResourceGroup(),
+			"azurerm_virtual_network":       resourceArmVirtualNetwork(),
+			"azurerm_local_network_gateway": resourceArmLocalNetworkGateway(),
 		},
 
 		ConfigureFunc: providerConfigure,
diff --git a/builtin/providers/azurerm/resource_arm_local_network_gateway.go b/builtin/providers/azurerm/resource_arm_local_network_gateway.go
@@ -0,0 +1,158 @@
+package azurerm
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/Azure/azure-sdk-for-go/arm/network"
+	"github.com/Azure/azure-sdk-for-go/core/http"
+	"github.com/hashicorp/terraform/helper/schema"
+)
+
+// resourceArmLocalNetworkGateway returns the schema.Resource
+// associated to an Azure local network gateway.
+func resourceArmLocalNetworkGateway() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceArmLocalNetworkGatewayCreate,
+		Read:   resourceArmLocalNetworkGatewayRead,
+		Update: resourceArmLocalNetworkGatewayUpdate,
+		Delete: resourceArmLocalNetworkGatewayDelete,
+
+		Schema: map[string]*schema.Schema{
+			"name": &schema.Schema{
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+
+			"location": &schema.Schema{
+				Type:      schema.TypeString,
+				Optional:  true,
+				ForceNew:  true,
+				StateFunc: azureRMNormalizeLocation,
+			},
+
+			"resource_group_name": &schema.Schema{
+				Type:     schema.TypeString,
+				Optional: true,
+				ForceNew: true,
+			},
+
+			"resource_guid": &schema.Schema{
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+
+			"gateway_address": &schema.Schema{
+				Type:     schema.TypeString,
+				Required: true,
+			},
+
+			"address_space": &schema.Schema{
+				Type:     schema.TypeList,
+				Required: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
+		},
+	}
+}
+
+// resourceArmLocalNetworkGatewayCreate goes ahead and creates the specified ARM local network gateway.
+func resourceArmLocalNetworkGatewayCreate(d *schema.ResourceData, meta interface{}) error {
+	lnetClient := meta.(*ArmClient).localNetConnClient
+
+	name := d.Get("name").(string)
+	location := d.Get("location").(string)
+	resGroup := d.Get("resource_group_name").(string)
+	ipAddress := d.Get("gateway_address").(string)
+
+	// NOTE: due to the including-but-different relationship between the ASM
+	// and ARM APIs, one may set the following local network gateway type to
+	// "Classic" and basically get an old ASM local network connection through
+	// the ARM API. This functionality is redundant with respect to the old
+	// ASM-based implementation which we already have, so we just use the
+	// new Resource Manager APIs here:
+	typ := "Resource Manager"
+
+	// fetch the 'address_space_prefix'es:
+	prefixes := []string{}
+	for _, pref := range d.Get("addres_space").([]interface{}) {
+		prefixes = append(prefixes, pref.(string))
+	}
+
+	// NOTE: result ignored here; review below...
+	resp, err := lnetClient.CreateOrUpdate(resGroup, name, network.LocalNetworkGateway{
+		Name:     &name,
+		Location: &location,
+		Type:     &typ,
+		Properties: &network.LocalNetworkGatewayPropertiesFormat{
+			LocalNetworkAddressSpace: &network.AddressSpace{
+				AddressPrefixes: &prefixes,
+			},
+			GatewayIPAddress: &ipAddress,
+		},
+	})
+	if err != nil {
+		return fmt.Errorf("Error reading the state of Azure ARM Local Network Gateway '%s': %s", name, err)
+	}
+
+	// NOTE: we either call read here or basically repeat the reading process
+	// with the ignored network.LocalNetworkGateway result of the above:
+	d.SetId(*resp.ID)
+	return resourceArmLocalNetworkGatewayRead(d, meta)
+}
+
+// resourceArmLocalNetworkGatewayRead goes ahead and reads the state of the corresponding ARM local network gateway.
+func resourceArmLocalNetworkGatewayRead(d *schema.ResourceData, meta interface{}) error {
+	lnetClient := meta.(*ArmClient).localNetConnClient
+
+	name := d.Get("name").(string)
+	resGroup := d.Get("resource_group_name").(string)
+
+	log.Printf("[INFO] Sending GET request to Azure ARM for local network gateway '%s'.", name)
+	lnet, err := lnetClient.Get(resGroup, name)
+	if lnet.StatusCode == http.StatusNotFound {
+		// it means that the resource has been deleted in the meantime...
+		d.SetId("")
+		return nil
+	}
+	if err != nil {
+		return fmt.Errorf("Error reading the state of Azure ARM local network gateway '%s': %s", name, err)
+	}
+
+	d.Set("resource_guid", *lnet.Properties.ResourceGUID)
+	d.Set("gateway_address", *lnet.Properties.GatewayIPAddress)
+
+	prefs := []string{}
+	if ps := *lnet.Properties.LocalNetworkAddressSpace.AddressPrefixes; ps != nil {
+		prefs = ps
+	}
+	d.Set("address_space", prefs)
+
+	return nil
+}
+
+// resourceArmLocalNetworkGatewayUpdate goes ahead and updates the corresponding ARM local network gateway.
+func resourceArmLocalNetworkGatewayUpdate(d *schema.ResourceData, meta interface{}) error {
+	// NOTE: considering the idempotency, we can safely call create again on
+	// update. This has been written out in order to ensure clarity,
+	return resourceArmLocalNetworkGatewayCreate(d, meta)
+}
+
+// resourceArmLocalNetworkGatewayDelete deletes the specified ARM local network gateway.
+func resourceArmLocalNetworkGatewayDelete(d *schema.ResourceData, meta interface{}) error {
+	lnetClient := meta.(*ArmClient).localNetConnClient
+
+	name := d.Get("name").(string)
+	resGroup := d.Get("resource_group_name").(string)
+
+	log.Printf("[INFO] Sending Azure ARM delete request for local network gateway '%s'.", name)
+	_, err := lnetClient.Delete(resGroup, name)
+	if err != nil {
+		return fmt.Errorf("Error issuing Azure ARM delete request of local network gateway '%s': %s", name, err)
+	}
+
+	return nil
+}
diff --git a/builtin/providers/azurerm/resource_arm_local_network_gateway_test.go b/builtin/providers/azurerm/resource_arm_local_network_gateway_test.go
@@ -0,0 +1,106 @@
+package azurerm
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/Azure/azure-sdk-for-go/core/http"
+	"github.com/hashicorp/terraform/helper/resource"
+	"github.com/hashicorp/terraform/terraform"
+)
+
+func TestAccAzureRMLocalNetworkGateway_basic(t *testing.T) {
+	name := "azurerm_local_network_gateway.test"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testCheckAzureRMLocalNetworkGatewayDestroy,
+		Steps: []resource.TestStep{
+			resource.TestStep{
+				Config: testAccAzureRMLocalNetworkGatewayConfig_basic,
+				Check: resource.ComposeTestCheckFunc(
+					testCheckAzureRMLocalNetworkGatewayExists(name),
+					resource.TestCheckResourceAttr(name, "gateway_address", "127.0.0.1"),
+					resource.TestCheckResourceAttr(name, "address_space.0", "127.0.0.0/8"),
+				),
+			},
+		},
+	})
+}
+
+// testCheckAzureRMLocalNetworkGatewayExists returns the resurce.TestCheckFunc
+// which checks whether or not the expected local network gateway exists both
+// in the schema, and on Azure.
+func testCheckAzureRMLocalNetworkGatewayExists(name string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		// first check within the schema for the local network gateway:
+		res, ok := s.RootModule().Resources[name]
+		if !ok {
+			return fmt.Errorf("Local network gateway '%s' not found.", name)
+		}
+
+		// then, extranct the name and the resource group:
+		localNetName := res.Primary.Attributes["name"]
+		resGrp, hasResGrp := res.Primary.Attributes["resource_group_name"]
+		if !hasResGrp {
+			return fmt.Errorf("Local network gateway '%s' has no resource group set.", name)
+		}
+
+		// and finally, check that it exists on Azure:
+		lnetClient := testAccProvider.Meta().(*ArmClient).localNetConnClient
+
+		resp, err := lnetClient.Get(resGrp, name)
+		if resp.StatusCode == http.StatusNotFound {
+			return fmt.Errorf("Local network gateway '%s' (resource group '%s') does not exist on Azure.", localNetName, resGrp)
+		}
+
+		if err != nil {
+			return fmt.Errorf("Error reading the state of local network gateway '%s'.", localNetName)
+		}
+
+		return nil
+	}
+}
+
+// testCheckAzureRMLocalNetworkGatewayDestroy is the resurce.TestCheckFunc
+// which checks whether or not the expected local network gateway still
+// exists on Azure.
+func testCheckAzureRMLocalNetworkGatewayDestroy(s *terraform.State) error {
+	for _, rs := range s.RootModule().Resources {
+		if rs.Type != "azurerm_local_network_gateway" {
+			continue
+		}
+
+		name := rs.Primary.Attributes["name"]
+		resourceGroup := rs.Primary.Attributes["resource_group_name"]
+
+		lnetClient := testAccProvider.Meta().(*ArmClient).localNetConnClient
+		resp, err := lnetClient.Get(resourceGroup, name)
+
+		if err != nil {
+			return nil
+		}
+
+		if resp.StatusCode != http.StatusNotFound {
+			return fmt.Errorf("Local network gateway still exists:\n%#v", resp.Properties)
+		}
+	}
+
+	return nil
+}
+
+var testAccAzureRMLocalNetworkGatewayConfig_basic = `
+resource "azurerm_resource_group" "test" {
+    name = "tftestingResourceGroup"
+    location = "West US"
+}
+
+resource "azurerm_local_network_gateway" "test" {
+	name = "tftestingLocalNetworkGateway"
+	location = "${azurerm_resource_group.test.location}"
+	resource_group_name = "${azurerm_resource_group.test.name}"
+	gateway_address = "127.0.0.1"
+	address_space = ["127.0.0.0/8"]
+}
+`
diff --git a/website/source/docs/providers/azurerm/r/local_network_gateway.html.markdown b/website/source/docs/providers/azurerm/r/local_network_gateway.html.markdown
@@ -0,0 +1,48 @@
+---
+layout: "azurerm"
+page_title: "Azure Resource Manager: azurerm_local_network_gateway"
+sidebar_current: "docs-azurerm-resource-local-network-gateway"
+description: |-
+  Creates a new local network gateway connection over which specific connections can be configured.
+---
+
+# azurerm\_local\_network\_gateway
+
+Creates a new local network gateway connection over which specific connections can be configured.
+
+## Example Usage
+
+```
+resource "azurerm_local_network_gateway" "home" {
+  name = "backHome"
+  resource_group_name = "${azurerm_resource_group.test.name}"
+  location = "${azurerm_resource_group.test.location}"
+  gateway_address = "12.13.14.15"
+  address_space = ["10.0.0.0/16"]
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `name` - (Required) The name of the local network gateway. Changing this
+    forces a new resource to be created.
+
+* `resource_group_name` - (Required) The name of the resource group in which to
+    create the local network gateway.
+
+* `location` - (Required) The location/region where the local network gatway is
+    created. Changing this forces a new resource to be created.
+
+* `gateway_address` - (Required) The IP address of the gatway to which to
+    connect.
+
+* `address_space` - (Required) The list of string CIDRs representing the
+    addredss spaces the gateway exposes.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `id` - The local network gateway unique ID within Azure.
diff --git a/website/source/layouts/azurerm.erb b/website/source/layouts/azurerm.erb
@@ -13,13 +13,18 @@
                 <li<%= sidebar_current(/^docs-azurerm-resource/) %>>
                     <a href="#">Resources</a>
                     <ul class="nav nav-visible">
-                        <li<%= sidebar_current("docs-azure-resource-resource-group") %>>
+                        <li<%= sidebar_current("docs-azurerm-resource-resource-group") %>>
                             <a href="/docs/providers/azurerm/r/resource_group.html">azurerm_resource_group</a>
                         </li>
 
-                        <li<%= sidebar_current("docs-azure-resource-virtual-network") %>>
+                        <li<%= sidebar_current("docs-azurerm-resource-virtual-network") %>>
                             <a href="/docs/providers/azurerm/r/virtual_network.html">azurerm_virtual_network</a>
                         </li>
+
+                        <li<%= sidebar_current("docs-azurerm-resource-local-network-gateway") %>>
+                            <a href="/docs/providers/azurerm/r/local_network_gateway.html">azurerm_local_network_gateway</a>
+                        </li>
+
                     </ul>
                 </li>
             </ul>
