feat(apigee): Add support for NatAddress activation (#11698) (#8261)

[upstream:7d76b1ba0d9f366fae4fc5e1159952eee5087661]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/11698.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+apigee: Add support for NAT Address activation in `google_apigee_nat_address`.
+```

google-beta/services/apigee/apigee_utils.go

@@ -0,0 +1,49 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+package apigee
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
+	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
+)
+
+func resourceApigeeNatAddressActivate(config *transport_tpg.Config, d *schema.ResourceData, billingProject string, userAgent string) error {
+	// 1. check prepare for activation
+	name := d.Get("name").(string)
+
+	if d.Get("state").(string) != "RESERVED" {
+		return fmt.Errorf("Activating NAT address requires the state to become RESERVED")
+	}
+
+	// 2. activation
+	activateUrl, err := tpgresource.ReplaceVars(d, config, "{{ApigeeBasePath}}{{instance_id}}/natAddresses/{{name}}:activate")
+	if err != nil {
+		return err
+	}
+	log.Printf("[DEBUG] Activating NAT address: %s", name)
+	res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "POST",
+		Project:   billingProject,
+		RawURL:    activateUrl,
+		UserAgent: userAgent,
+	})
+	if err != nil {
+		return fmt.Errorf("Error activating NAT address: %s", err)
+	}
+
+	var opRes map[string]interface{}
+	err = ApigeeOperationWaitTimeWithResponse(
+		config, res, &opRes, "Activating NAT address", userAgent,
+		d.Timeout(schema.TimeoutCreate))
+	if err != nil {
+		return fmt.Errorf("Error waiting to actiavte NAT address: %s", err)
+	} else {
+		log.Printf("[DEBUG] Finished activating NatAddress %q: %#v", d.Id(), res)
+	}
+	return nil
+}

google-beta/services/apigee/resource_apigee_nat_address.go

@@ -24,16 +24,39 @@ import (
 	"reflect"
 	"time"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
 	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 )
 
+// waitForNatAddressReady waits for an NatAddress to leave the
+// "CREATING" state and become "RESERVED", to indicate that it's ready.
+func waitForNatAddressReserved(d *schema.ResourceData, config *transport_tpg.Config, timeout time.Duration) error {
+	return retry.Retry(timeout, func() *retry.RetryError {
+		if err := resourceApigeeNatAddressRead(d, config); err != nil {
+			return retry.NonRetryableError(err)
+		}
+
+		id := d.Id()
+		state := d.Get("state").(string)
+		if state == "CREATING" {
+			return retry.RetryableError(fmt.Errorf("NatAddress %q has state %q.", id, state))
+		} else if state == "RESERVED" {
+			log.Printf("[DEBUG] NatAddress %q has state %q.", id, state)
+			return nil
+		} else {
+			return retry.NonRetryableError(fmt.Errorf("NatAddress %q has state %q.", id, state))
+		}
+	})
+}
+
 func ResourceApigeeNatAddress() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceApigeeNatAddressCreate,
 		Read:   resourceApigeeNatAddressRead,
+		Update: resourceApigeeNatAddressUpdate,
 		Delete: resourceApigeeNatAddressDelete,
 
 		Importer: &schema.ResourceImporter{
@@ -42,6 +65,7 @@ func ResourceApigeeNatAddress() *schema.Resource {
 
 		Timeouts: &schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(30 * time.Minute),
+			Update: schema.DefaultTimeout(30 * time.Minute),
 			Delete: schema.DefaultTimeout(30 * time.Minute),
 		},
 
@@ -59,6 +83,12 @@ in the format 'organizations/{{org_name}}/instances/{{instance_name}}'.`,
 				ForceNew:    true,
 				Description: `Resource ID of the NAT address.`,
 			},
+			"activate": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Description: `Flag that specifies whether the reserved NAT address should be activate.`,
+				Default:     false,
+			},
 			"ip_address": {
 				Type:        schema.TypeString,
 				Computed:    true,
@@ -88,6 +118,17 @@ func resourceApigeeNatAddressCreate(d *schema.ResourceData, meta interface{}) er
 	} else if v, ok := d.GetOkExists("name"); !tpgresource.IsEmptyValue(reflect.ValueOf(nameProp)) && (ok || !reflect.DeepEqual(v, nameProp)) {
 		obj["name"] = nameProp
 	}
+	activateProp, err := expandApigeeNatAddressActivate(d.Get("activate"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("activate"); !tpgresource.IsEmptyValue(reflect.ValueOf(activateProp)) && (ok || !reflect.DeepEqual(v, activateProp)) {
+		obj["activate"] = activateProp
+	}
+
+	obj, err = resourceApigeeNatAddressEncoder(d, meta, obj)
+	if err != nil {
+		return err
+	}
 
 	url, err := tpgresource.ReplaceVars(d, config, "{{ApigeeBasePath}}{{instance_id}}/natAddresses")
 	if err != nil {
@@ -137,6 +178,14 @@ func resourceApigeeNatAddressCreate(d *schema.ResourceData, meta interface{}) er
 		return fmt.Errorf("Error waiting to create NatAddress: %s", err)
 	}
 
+	opRes, err = resourceApigeeNatAddressDecoder(d, meta, opRes)
+	if err != nil {
+		return fmt.Errorf("Error decoding response from operation: %s", err)
+	}
+	if opRes == nil {
+		return fmt.Errorf("Error decoding response from operation, could not find object")
+	}
+
 	if err := d.Set("name", flattenApigeeNatAddressName(opRes["name"], d, config)); err != nil {
 		return err
 	}
@@ -148,6 +197,17 @@ func resourceApigeeNatAddressCreate(d *schema.ResourceData, meta interface{}) er
 	}
 	d.SetId(id)
 
+	if d.Get("activate").(bool) {
+		if err := waitForNatAddressReserved(d, config, d.Timeout(schema.TimeoutCreate)-time.Minute); err != nil {
+			return fmt.Errorf("Error waiting for NatAddress %q to be RESERVED during creation: %q", d.Id(), err)
+		}
+
+		log.Printf("[DEBUG] Activating for NatAddress %q to become ACTIVE", d.Id())
+		if err := resourceApigeeNatAddressActivate(config, d, billingProject, userAgent); err != nil {
+			return fmt.Errorf("Error activating NatAddress: %s", err)
+		}
+	}
+
 	log.Printf("[DEBUG] Finished creating NatAddress %q: %#v", d.Id(), res)
 
 	return resourceApigeeNatAddressRead(d, meta)
@@ -185,9 +245,24 @@ func resourceApigeeNatAddressRead(d *schema.ResourceData, meta interface{}) erro
 		return transport_tpg.HandleNotFoundError(err, d, fmt.Sprintf("ApigeeNatAddress %q", d.Id()))
 	}
 
+	res, err = resourceApigeeNatAddressDecoder(d, meta, res)
+	if err != nil {
+		return err
+	}
+
+	if res == nil {
+		// Decoding the object has resulted in it being gone. It may be marked deleted
+		log.Printf("[DEBUG] Removing ApigeeNatAddress because it no longer exists.")
+		d.SetId("")
+		return nil
+	}
+
 	if err := d.Set("name", flattenApigeeNatAddressName(res["name"], d, config)); err != nil {
 		return fmt.Errorf("Error reading NatAddress: %s", err)
 	}
+	if err := d.Set("activate", flattenApigeeNatAddressActivate(res["activate"], d, config)); err != nil {
+		return fmt.Errorf("Error reading NatAddress: %s", err)
+	}
 	if err := d.Set("ip_address", flattenApigeeNatAddressIpAddress(res["ipAddress"], d, config)); err != nil {
 		return fmt.Errorf("Error reading NatAddress: %s", err)
 	}
@@ -198,6 +273,44 @@ func resourceApigeeNatAddressRead(d *schema.ResourceData, meta interface{}) erro
 	return nil
 }
 
+func resourceApigeeNatAddressUpdate(d *schema.ResourceData, meta interface{}) error {
+	config := meta.(*transport_tpg.Config)
+	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
+	if err != nil {
+		return err
+	}
+
+	billingProject := ""
+
+	obj := make(map[string]interface{})
+	nameProp, err := expandApigeeNatAddressName(d.Get("name"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("name"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, nameProp)) {
+		obj["name"] = nameProp
+	}
+
+	log.Printf("[DEBUG] Updating NatAddress %q: %#v", d.Id(), obj)
+
+	// err == nil indicates that the billing_project value was found
+	if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
+		billingProject = bp
+	}
+
+	if d.HasChange("activate") {
+		if !d.Get("activate").(bool) {
+			return fmt.Errorf("NatAddress %q allows only the activation action", d.Id())
+		} else if d.Get("state").(string) == "RESERVED" {
+			log.Printf("[DEBUG] Activating for NatAddress %q to become ACTIVE", d.Id())
+			if err := resourceApigeeNatAddressActivate(config, d, billingProject, userAgent); err != nil {
+				return fmt.Errorf("Error activating NatAddress: %s", err)
+			}
+		}
+	}
+
+	return resourceApigeeNatAddressRead(d, meta)
+}
+
 func resourceApigeeNatAddressDelete(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*transport_tpg.Config)
 	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
@@ -273,6 +386,10 @@ func flattenApigeeNatAddressName(v interface{}, d *schema.ResourceData, config *
 	return v
 }
 
+func flattenApigeeNatAddressActivate(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func flattenApigeeNatAddressIpAddress(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
 	return v
 }
@@ -284,3 +401,18 @@ func flattenApigeeNatAddressState(v interface{}, d *schema.ResourceData, config
 func expandApigeeNatAddressName(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
+
+func expandApigeeNatAddressActivate(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func resourceApigeeNatAddressEncoder(d *schema.ResourceData, meta interface{}, obj map[string]interface{}) (map[string]interface{}, error) {
+	// cannot include activate prop in the body
+	delete(obj, "activate")
+	return obj, nil
+}
+
+func resourceApigeeNatAddressDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
+	res["activate"] = res["state"].(string) == "ACTIVE"
+	return res, nil
+}

google-beta/services/apigee/resource_apigee_nat_address_generated_test.go

@@ -123,7 +123,7 @@ resource "google_apigee_instance" "apigee_instance" {
 }
 
 resource "google_apigee_nat_address" "apigee_nat_address" {
-  name     = "tf-test%{random_suffix}"
+  name        = "tf-test%{random_suffix}"
   instance_id = google_apigee_instance.apigee_instance.id
 }
 `, context)

google-beta/services/apigee/resource_apigee_nat_address_update_test.go

@@ -0,0 +1,120 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+package apigee_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/envvar"
+)
+
+func TestAccApigeeNatAddress_apigeeNatAddressUpdateTest(t *testing.T) {
+	acctest.SkipIfVcr(t)
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"billing_account": envvar.GetTestBillingAccountFromEnv(t),
+		"org_id":          envvar.GetTestOrgFromEnv(t),
+		"random_suffix":   acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckApigeeNatAddressDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccApigeeNatAddress_apigeeNatAddressBasicTestExample(context),
+			},
+			{
+				ResourceName:            "google_apigee_nat_address.apigee_nat_address",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"activate", "instance_id"},
+			},
+			{
+				Config: testAccApigeeNatAddress_apigeeNatAddressUpdateTest(context),
+			},
+			{
+				ResourceName:            "google_apigee_nat_address.apigee_nat_address",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"activate", "instance_id"},
+			},
+		},
+	})
+}
+
+func testAccApigeeNatAddress_apigeeNatAddressUpdateTest(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_project" "project" {
+  project_id      = "tf-test%{random_suffix}"
+  name            = "tf-test%{random_suffix}"
+  org_id          = "%{org_id}"
+  billing_account = "%{billing_account}"
+  deletion_policy = "DELETE"
+}
+
+resource "google_project_service" "apigee" {
+  project = google_project.project.project_id
+  service = "apigee.googleapis.com"
+}
+
+resource "google_project_service" "compute" {
+  project = google_project.project.project_id
+  service = "compute.googleapis.com"
+}
+
+resource "google_project_service" "servicenetworking" {
+  project = google_project.project.project_id
+  service = "servicenetworking.googleapis.com"
+}
+
+resource "google_compute_network" "apigee_network" {
+  name       = "apigee-network"
+  project    = google_project.project.project_id
+  depends_on = [google_project_service.compute]
+}
+
+resource "google_compute_global_address" "apigee_range" {
+  name          = "apigee-range"
+  purpose       = "VPC_PEERING"
+  address_type  = "INTERNAL"
+  prefix_length = 21
+  network       = google_compute_network.apigee_network.id
+  project       = google_project.project.project_id
+}
+
+resource "google_service_networking_connection" "apigee_vpc_connection" {
+  network                 = google_compute_network.apigee_network.id
+  service                 = "servicenetworking.googleapis.com"
+  reserved_peering_ranges = [google_compute_global_address.apigee_range.name]
+  depends_on              = [google_project_service.servicenetworking]
+}
+
+resource "google_apigee_organization" "apigee_org" {
+  analytics_region   = "us-central1"
+  project_id         = google_project.project.project_id
+  authorized_network = google_compute_network.apigee_network.id
+  depends_on         = [
+    google_service_networking_connection.apigee_vpc_connection,
+    google_project_service.apigee,
+  ]
+}
+
+resource "google_apigee_instance" "apigee_instance" {
+  name     = "apigee-instance"
+  location = "us-central1"
+  org_id   = google_apigee_organization.apigee_org.id
+}
+
+resource "google_apigee_nat_address" "apigee_nat_address" {
+  name        = "tf-test%{random_suffix}"
+  activate    = true
+  instance_id = google_apigee_instance.apigee_instance.id
+}
+`, context)
+}