Add labels property to HA VPN Gateway (#12866) (#9309)

[upstream:2346615efcf8e86f961bf6b92987f574682e11fb]

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

Author: modular-magician

.changelog/12866.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+compute: added `labels` field to `google_compute_ha_vpn_gateway` resource
+```

google-beta/services/compute/resource_compute_ha_vpn_gateway.go

@@ -37,6 +37,7 @@ func ResourceComputeHaVpnGateway() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceComputeHaVpnGatewayCreate,
 		Read:   resourceComputeHaVpnGatewayRead,
+		Update: resourceComputeHaVpnGatewayUpdate,
 		Delete: resourceComputeHaVpnGatewayDelete,
 
 		Importer: &schema.ResourceImporter{
@@ -45,6 +46,7 @@ func ResourceComputeHaVpnGateway() *schema.Resource {
 
 		Timeouts: &schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(20 * time.Minute),
+			Update: schema.DefaultTimeout(20 * time.Minute),
 			Delete: schema.DefaultTimeout(20 * time.Minute),
 		},
 
@@ -58,6 +60,7 @@ func ResourceComputeHaVpnGateway() *schema.Resource {
 			},
 		},
 		CustomizeDiff: customdiff.All(
+			tpgresource.SetLabelsDiff,
 			tpgresource.DefaultProviderProject,
 		),
 
@@ -96,6 +99,17 @@ character, which cannot be a dash.`,
 				Description:  `The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. Default value: "IPV4" Possible values: ["IPV4", "IPV6"]`,
 				Default:      "IPV4",
 			},
+			"labels": {
+				Type:     schema.TypeMap,
+				Optional: true,
+				Description: `Labels for this resource. These can only be added or modified by the setLabels method.
+Each label key/value pair must comply with RFC1035. Label values may be empty.
+
+
+**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+Please refer to the field 'effective_labels' for all of the labels present on the resource.`,
+				Elem: &schema.Schema{Type: schema.TypeString},
+			},
 			"region": {
 				Type:             schema.TypeString,
 				Computed:         true,
@@ -148,6 +162,28 @@ Not currently available publicly.`,
 					},
 				},
 			},
+			"effective_labels": {
+				Type:        schema.TypeMap,
+				Computed:    true,
+				Description: `All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.`,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+			},
+			"label_fingerprint": {
+				Type:     schema.TypeString,
+				Computed: true,
+				Description: `A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash
+of the labels set used for optimistic locking. The fingerprint is initially generated by
+Compute Engine and changes after every request to modify or update labels.
+You must always provide an up-to-date fingerprint hash in order to update or change labels,
+otherwise the request will fail with error 412 conditionNotMet.`,
+			},
+			"terraform_labels": {
+				Type:     schema.TypeMap,
+				Computed: true,
+				Description: `The combination of labels configured directly on the resource
+ and default labels configured on the provider.`,
+				Elem: &schema.Schema{Type: schema.TypeString},
+			},
 			"project": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -207,6 +243,18 @@ func resourceComputeHaVpnGatewayCreate(d *schema.ResourceData, meta interface{})
 	} else if v, ok := d.GetOkExists("vpn_interfaces"); !tpgresource.IsEmptyValue(reflect.ValueOf(vpnInterfacesProp)) && (ok || !reflect.DeepEqual(v, vpnInterfacesProp)) {
 		obj["vpnInterfaces"] = vpnInterfacesProp
 	}
+	labelFingerprintProp, err := expandComputeHaVpnGatewayLabelFingerprint(d.Get("label_fingerprint"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("label_fingerprint"); !tpgresource.IsEmptyValue(reflect.ValueOf(labelFingerprintProp)) && (ok || !reflect.DeepEqual(v, labelFingerprintProp)) {
+		obj["labelFingerprint"] = labelFingerprintProp
+	}
+	labelsProp, err := expandComputeHaVpnGatewayEffectiveLabels(d.Get("effective_labels"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("effective_labels"); !tpgresource.IsEmptyValue(reflect.ValueOf(labelsProp)) && (ok || !reflect.DeepEqual(v, labelsProp)) {
+		obj["labels"] = labelsProp
+	}
 	regionProp, err := expandComputeHaVpnGatewayRegion(d.Get("region"), d, config)
 	if err != nil {
 		return err
@@ -330,6 +378,18 @@ func resourceComputeHaVpnGatewayRead(d *schema.ResourceData, meta interface{}) e
 	if err := d.Set("vpn_interfaces", flattenComputeHaVpnGatewayVpnInterfaces(res["vpnInterfaces"], d, config)); err != nil {
 		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
 	}
+	if err := d.Set("labels", flattenComputeHaVpnGatewayLabels(res["labels"], d, config)); err != nil {
+		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
+	}
+	if err := d.Set("label_fingerprint", flattenComputeHaVpnGatewayLabelFingerprint(res["labelFingerprint"], d, config)); err != nil {
+		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
+	}
+	if err := d.Set("terraform_labels", flattenComputeHaVpnGatewayTerraformLabels(res["labels"], d, config)); err != nil {
+		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
+	}
+	if err := d.Set("effective_labels", flattenComputeHaVpnGatewayEffectiveLabels(res["labels"], d, config)); err != nil {
+		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
+	}
 	if err := d.Set("region", flattenComputeHaVpnGatewayRegion(res["region"], d, config)); err != nil {
 		return fmt.Errorf("Error reading HaVpnGateway: %s", err)
 	}
@@ -340,6 +400,80 @@ func resourceComputeHaVpnGatewayRead(d *schema.ResourceData, meta interface{}) e
 	return nil
 }
 
+func resourceComputeHaVpnGatewayUpdate(d *schema.ResourceData, meta interface{}) error {
+	config := meta.(*transport_tpg.Config)
+	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
+	if err != nil {
+		return err
+	}
+
+	billingProject := ""
+
+	project, err := tpgresource.GetProject(d, config)
+	if err != nil {
+		return fmt.Errorf("Error fetching project for HaVpnGateway: %s", err)
+	}
+	billingProject = project
+
+	d.Partial(true)
+
+	if d.HasChange("label_fingerprint") || d.HasChange("effective_labels") {
+		obj := make(map[string]interface{})
+
+		labelFingerprintProp, err := expandComputeHaVpnGatewayLabelFingerprint(d.Get("label_fingerprint"), d, config)
+		if err != nil {
+			return err
+		} else if v, ok := d.GetOkExists("label_fingerprint"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, labelFingerprintProp)) {
+			obj["labelFingerprint"] = labelFingerprintProp
+		}
+		labelsProp, err := expandComputeHaVpnGatewayEffectiveLabels(d.Get("effective_labels"), d, config)
+		if err != nil {
+			return err
+		} else if v, ok := d.GetOkExists("effective_labels"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, labelsProp)) {
+			obj["labels"] = labelsProp
+		}
+
+		url, err := tpgresource.ReplaceVars(d, config, "{{ComputeBasePath}}projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}/setLabels")
+		if err != nil {
+			return err
+		}
+
+		headers := make(http.Header)
+
+		// err == nil indicates that the billing_project value was found
+		if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
+			billingProject = bp
+		}
+
+		res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "POST",
+			Project:   billingProject,
+			RawURL:    url,
+			UserAgent: userAgent,
+			Body:      obj,
+			Timeout:   d.Timeout(schema.TimeoutUpdate),
+			Headers:   headers,
+		})
+		if err != nil {
+			return fmt.Errorf("Error updating HaVpnGateway %q: %s", d.Id(), err)
+		} else {
+			log.Printf("[DEBUG] Finished updating HaVpnGateway %q: %#v", d.Id(), res)
+		}
+
+		err = ComputeOperationWaitTime(
+			config, res, project, "Updating HaVpnGateway", userAgent,
+			d.Timeout(schema.TimeoutUpdate))
+		if err != nil {
+			return err
+		}
+	}
+
+	d.Partial(false)
+
+	return resourceComputeHaVpnGatewayRead(d, meta)
+}
+
 func resourceComputeHaVpnGatewayDelete(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*transport_tpg.Config)
 	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
@@ -496,6 +630,44 @@ func flattenComputeHaVpnGatewayVpnInterfacesInterconnectAttachment(v interface{}
 	return tpgresource.ConvertSelfLinkToV1(v.(string))
 }
 
+func flattenComputeHaVpnGatewayLabels(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return v
+	}
+
+	transformed := make(map[string]interface{})
+	if l, ok := d.GetOkExists("labels"); ok {
+		for k := range l.(map[string]interface{}) {
+			transformed[k] = v.(map[string]interface{})[k]
+		}
+	}
+
+	return transformed
+}
+
+func flattenComputeHaVpnGatewayLabelFingerprint(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
+func flattenComputeHaVpnGatewayTerraformLabels(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	if v == nil {
+		return v
+	}
+
+	transformed := make(map[string]interface{})
+	if l, ok := d.GetOkExists("terraform_labels"); ok {
+		for k := range l.(map[string]interface{}) {
+			transformed[k] = v.(map[string]interface{})[k]
+		}
+	}
+
+	return transformed
+}
+
+func flattenComputeHaVpnGatewayEffectiveLabels(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func flattenComputeHaVpnGatewayRegion(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
 	if v == nil {
 		return v
@@ -579,6 +751,21 @@ func expandComputeHaVpnGatewayVpnInterfacesInterconnectAttachment(v interface{},
 	return f.RelativeLink(), nil
 }
 
+func expandComputeHaVpnGatewayLabelFingerprint(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}
+
+func expandComputeHaVpnGatewayEffectiveLabels(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (map[string]string, error) {
+	if v == nil {
+		return map[string]string{}, nil
+	}
+	m := make(map[string]string)
+	for k, val := range v.(map[string]interface{}) {
+		m[k] = val.(string)
+	}
+	return m, nil
+}
+
 func expandComputeHaVpnGatewayRegion(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	f, err := tpgresource.ParseGlobalFieldValue("regions", v.(string), "project", d, config, true)
 	if err != nil {

google-beta/services/compute/resource_compute_ha_vpn_gateway_generated_meta.yaml

@@ -6,11 +6,17 @@ api_version: 'beta'
 api_resource_type_kind: 'VpnGateway'
 fields:
   - field: 'description'
+  - field: 'effective_labels'
+    provider_only: true
   - field: 'gateway_ip_version'
+  - field: 'label_fingerprint'
+  - field: 'labels'
   - field: 'name'
   - field: 'network'
   - field: 'region'
   - field: 'stack_type'
+  - field: 'terraform_labels'
+    provider_only: true
   - field: 'vpn_interfaces.id'
   - field: 'vpn_interfaces.interconnect_attachment'
   - field: 'vpn_interfaces.ip_address'

google-beta/services/compute/resource_compute_ha_vpn_gateway_generated_test.go

@@ -49,7 +49,7 @@ func TestAccComputeHaVpnGateway_haVpnGatewayBasicExample(t *testing.T) {
 				ResourceName:            "google_compute_ha_vpn_gateway.ha_gateway1",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"network", "region"},
+				ImportStateVerifyIgnore: []string{"labels", "network", "region", "terraform_labels"},
 			},
 		},
 	})
@@ -89,7 +89,7 @@ func TestAccComputeHaVpnGateway_haVpnGatewayIpv6Example(t *testing.T) {
 				ResourceName:            "google_compute_ha_vpn_gateway.ha_gateway1",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"network", "region"},
+				ImportStateVerifyIgnore: []string{"labels", "network", "region", "terraform_labels"},
 			},
 		},
 	})
@@ -102,6 +102,9 @@ resource "google_compute_ha_vpn_gateway" "ha_gateway1" {
   name     = "tf-test-ha-vpn-1%{random_suffix}"
   network  = google_compute_network.network1.id
   stack_type = "IPV4_IPV6"
+  labels = {
+    mykey = "myvalue"
+  }
 }
 
 resource "google_compute_network" "network1" {

website/docs/r/compute_ha_vpn_gateway.html.markdown

@@ -65,6 +65,9 @@ resource "google_compute_ha_vpn_gateway" "ha_gateway1" {
   name     = "ha-vpn-1"
   network  = google_compute_network.network1.id
   stack_type = "IPV4_IPV6"
+  labels = {
+    mykey = "myvalue"
+  }
 }
 
 resource "google_compute_network" "network1" {
@@ -189,6 +192,14 @@ The following arguments are supported:
   A list of interfaces on this VPN gateway.
   Structure is [documented below](#nested_vpn_interfaces).
 
+* `labels` -
+  (Optional)
+  Labels for this resource. These can only be added or modified by the setLabels method.
+  Each label key/value pair must comply with RFC1035. Label values may be empty.
+
+  **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+  Please refer to the field `effective_labels` for all of the labels present on the resource.
+
 * `region` -
   (Optional)
   The region this gateway should sit in.
@@ -221,6 +232,20 @@ The following arguments are supported:
 In addition to the arguments listed above, the following computed attributes are exported:
 
 * `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}`
+
+* `label_fingerprint` -
+  A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash
+  of the labels set used for optimistic locking. The fingerprint is initially generated by
+  Compute Engine and changes after every request to modify or update labels.
+  You must always provide an up-to-date fingerprint hash in order to update or change labels,
+  otherwise the request will fail with error 412 conditionNotMet.
+
+* `terraform_labels` -
+  The combination of labels configured directly on the resource
+   and default labels configured on the provider.
+
+* `effective_labels` -
+  All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
 * `self_link` - The URI of the created resource.
 
 
@@ -230,6 +255,7 @@ This resource provides the following
 [Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
 
 - `create` - Default is 20 minutes.
+- `update` - Default is 20 minutes.
 - `delete` - Default is 20 minutes.
 
 ## Import