Networking V2: add description to the router resource (#529)

terraform-provider-openstack · Dec 15, 2018 · 33a2225 · 33a2225
1 parent 99d22ce
commit 33a2225
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/openstack/resource_openstack_networking_router_v2.go b/openstack/resource_openstack_networking_router_v2.go
@@ -40,6 +40,11 @@ func resourceNetworkingRouterV2() *schema.Resource {
 				Optional: true,
 				ForceNew: false,
 			},
+			"description": &schema.Schema{
+				Type:     schema.TypeString,
+				Optional: true,
+				ForceNew: false,
+			},
 			"admin_state_up": &schema.Schema{
 				Type:     schema.TypeBool,
 				Optional: true,
@@ -143,6 +148,7 @@ func resourceNetworkingRouterV2Create(d *schema.ResourceData, meta interface{})
 	createOpts := RouterCreateOpts{
 		routers.CreateOpts{
 			Name:                  d.Get("name").(string),
+			Description:           d.Get("description").(string),
 			TenantID:              d.Get("tenant_id").(string),
 			AvailabilityZoneHints: resourceNetworkingAvailabilityZoneHintsV2(d),
 		},
@@ -273,6 +279,7 @@ func resourceNetworkingRouterV2Read(d *schema.ResourceData, meta interface{}) er
 	log.Printf("[DEBUG] Retrieved Router %s: %+v", d.Id(), n)
 
 	d.Set("name", n.Name)
+	d.Set("description", n.Description)
 	d.Set("admin_state_up", n.AdminStateUp)
 	d.Set("distributed", n.Distributed)
 	d.Set("tenant_id", n.TenantID)
@@ -320,6 +327,11 @@ func resourceNetworkingRouterV2Update(d *schema.ResourceData, meta interface{})
 		hasChange = true
 		updateOpts.Name = d.Get("name").(string)
 	}
+	if d.HasChange("description") {
+		hasChange = true
+		description := d.Get("description").(string)
+		updateOpts.Description = &description
+	}
 	if d.HasChange("admin_state_up") {
 		hasChange = true
 		asu := d.Get("admin_state_up").(bool)

diff --git a/openstack/resource_openstack_networking_router_v2_test.go b/openstack/resource_openstack_networking_router_v2_test.go
@@ -22,13 +22,17 @@ func TestAccNetworkingV2Router_basic(t *testing.T) {
 				Config: testAccNetworkingV2Router_basic,
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckNetworkingV2RouterExists("openstack_networking_router_v2.router_1", &router),
+					resource.TestCheckResourceAttr(
+						"openstack_networking_router_v2.router_1", "description", "router description"),
 				),
 			},
 			resource.TestStep{
 				Config: testAccNetworkingV2Router_update,
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(
 						"openstack_networking_router_v2.router_1", "name", "router_2"),
+					resource.TestCheckResourceAttr(
+						"openstack_networking_router_v2.router_1", "description", ""),
 				),
 			},
 		},
@@ -158,8 +162,9 @@ func testAccCheckNetworkingV2RouterExists(n string, router *routers.Router) reso
 
 const testAccNetworkingV2Router_basic = `
 resource "openstack_networking_router_v2" "router_1" {
-	name = "router_1"
-	admin_state_up = "true"
+  name = "router_1"
+  description = "router description"
+  admin_state_up = "true"
 
   timeouts {
     create = "5m"
@@ -170,8 +175,8 @@ resource "openstack_networking_router_v2" "router_1" {
 
 const testAccNetworkingV2Router_update = `
 resource "openstack_networking_router_v2" "router_1" {
-	name = "router_2"
-	admin_state_up = "true"
+  name = "router_2"
+  admin_state_up = "true"
 
   timeouts {
     create = "5m"

diff --git a/website/docs/r/networking_router_v2.html.markdown b/website/docs/r/networking_router_v2.html.markdown
@@ -32,6 +32,8 @@ The following arguments are supported:
 * `name` - (Optional) A unique name for the router. Changing this
     updates the `name` of an existing router.
 
+* `description` - (Optional) Human-readable description for the router.
+
 * `admin_state_up` - (Optional) Administrative up/down status for the router
     (must be "true" or "false" if provided). Changing this updates the
     `admin_state_up` of an existing router.
@@ -92,6 +94,7 @@ The following attributes are exported:
 * `id` - ID of the router.
 * `region` - See Argument Reference above.
 * `name` - See Argument Reference above.
+* `description` - See Argument Reference above.
 * `admin_state_up` - See Argument Reference above.
 * `external_gateway` - See Argument Reference above.
 * `external_network_id` - See Argument Reference above.