self_link 4.0.0 changes (#5314) (#3783)

* Remove several self link fields * Add note on snapshot * Remove uses of keyring.self_link in tests and docs * Unused var * Remove references in tests * Change kms key ring data source id format, add note to upgrade guide Signed-off-by: Modular Magician <[email protected]>
hashicorp · Oct 27, 2021 · b8c7f9b · b8c7f9b
1 parent 8a448e7
commit b8c7f9b
Show file tree

Hide file tree

Showing 27 changed files with 64 additions and 82 deletions.
diff --git a/.changelog/5314.txt b/.changelog/5314.txt
@@ -0,0 +1,9 @@
+```release-note:breaking-change
+pubsub: removed `path` field from `google_pubsub_subscription`
+```
+```release-note:breaking-change
+kms: removed `self_link` field from `google_kms_crypto_key` and `google_kms_key_ring`
+```
+```release-note:breaking-change
+compute: removed `source_disk_link` field from `google_compute_snapshot`
+```
diff --git a/google-beta/data_source_google_kms_crypto_key_test.go b/google-beta/data_source_google_kms_crypto_key_test.go
@@ -22,7 +22,7 @@ func TestAccDataSourceGoogleKmsCryptoKey_basic(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config: testAccDataSourceGoogleKmsCryptoKey_basic(kms.KeyRing.Name, cryptoKeyId),
-				Check:  resource.TestMatchResourceAttr("data.google_kms_crypto_key.kms_crypto_key", "self_link", regexp.MustCompile(kms.CryptoKey.Name)),
+				Check:  resource.TestMatchResourceAttr("data.google_kms_crypto_key.kms_crypto_key", "id", regexp.MustCompile(kms.CryptoKey.Name)),
 			},
 		},
 	})

diff --git a/google-beta/data_source_google_kms_key_ring.go b/google-beta/data_source_google_kms_key_ring.go
@@ -29,7 +29,7 @@ func dataSourceGoogleKmsKeyRingRead(d *schema.ResourceData, meta interface{}) er
 		Location: d.Get("location").(string),
 		Project:  project,
 	}
-	d.SetId(keyRingId.terraformId())
+	d.SetId(keyRingId.keyRingId())
 
 	return resourceKMSKeyRingRead(d, meta)
 }
diff --git a/google-beta/data_source_google_kms_key_ring_test.go b/google-beta/data_source_google_kms_key_ring_test.go
@@ -21,7 +21,7 @@ func TestAccDataSourceGoogleKmsKeyRing_basic(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config: testAccDataSourceGoogleKmsKeyRing_basic(keyRingId),
-				Check:  resource.TestMatchResourceAttr("data.google_kms_key_ring.kms_key_ring", "self_link", regexp.MustCompile(kms.KeyRing.Name)),
+				Check:  resource.TestMatchResourceAttr("data.google_kms_key_ring.kms_key_ring", "id", regexp.MustCompile(kms.KeyRing.Name)),
 			},
 		},
 	})

diff --git a/google-beta/data_source_google_kms_secret_asymmetric_test.go b/google-beta/data_source_google_kms_secret_asymmetric_test.go
@@ -139,7 +139,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
   purpose  = "ASYMMETRIC_DECRYPT"
   version_template {
     algorithm = "RSA_DECRYPT_OAEP_4096_SHA256"

diff --git a/google-beta/provider_test.go b/google-beta/provider_test.go
@@ -804,7 +804,7 @@ resource "google_kms_key_ring" "project-2-keyring" {
 resource "google_kms_crypto_key" "project-2-key" {
 	provider = google.project-1-token
 	name     = "%s"
-	key_ring = google_kms_key_ring.project-2-keyring.self_link
+	key_ring = google_kms_key_ring.project-2-keyring.id
 }
 
 data "google_kms_secret_ciphertext" "project-2-ciphertext" {

diff --git a/google-beta/resource_compute_snapshot.go b/google-beta/resource_compute_snapshot.go
@@ -199,11 +199,6 @@ snapshot using a customer-supplied encryption key.`,
 storage, this number is expected to change with snapshot
 creation/deletion.`,
 			},
-			"source_disk_link": {
-				Type:       schema.TypeString,
-				Computed:   true,
-				Deprecated: "Deprecated in favor of source_disk, which contains a compatible value. This field will be removed in the next major release of the provider.",
-			},
 			"project": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -843,8 +838,5 @@ func resourceComputeSnapshotDecoder(d *schema.ResourceData, meta interface{}, re
 		res["sourceDiskEncryptionKey"] = transformed
 	}
 
-	if err := d.Set("source_disk_link", ConvertSelfLinkToV1(res["sourceDisk"].(string))); err != nil {
-		return nil, fmt.Errorf("Error setting source_disk_link: %s", err)
-	}
 	return res, nil
 }
diff --git a/google-beta/resource_container_analysis_occurrence_test.go b/google-beta/resource_container_analysis_occurrence_test.go
@@ -178,11 +178,11 @@ data "google_kms_key_ring" "keyring" {
 
 data "google_kms_crypto_key" "crypto-key" {
   name     = "%{crypto_key}"
-  key_ring = data.google_kms_key_ring.keyring.self_link
+  key_ring = data.google_kms_key_ring.keyring.id
 }
 
 data "google_kms_crypto_key_version" "version" {
-  crypto_key = data.google_kms_crypto_key.crypto-key.self_link
+  crypto_key = data.google_kms_crypto_key.crypto-key.id
 }
 
 resource "google_container_analysis_occurrence" "occurrence" {
@@ -240,12 +240,12 @@ data "google_kms_key_ring" "keyring" {
 
 data "google_kms_crypto_key" "crypto-key1" {
   name     = "%{key1}"
-  key_ring = data.google_kms_key_ring.keyring.self_link
+  key_ring = data.google_kms_key_ring.keyring.id
 }
 
 data "google_kms_crypto_key" "crypto-key2" {
   name     = "%{key2}"
-  key_ring = data.google_kms_key_ring.keyring.self_link
+  key_ring = data.google_kms_key_ring.keyring.id
 }
 
 data "google_kms_crypto_key_version" "version-key1" {

diff --git a/google-beta/resource_container_cluster_test.go b/google-beta/resource_container_cluster_test.go
@@ -3288,7 +3288,7 @@ resource "google_kms_key_ring" "keyring" {
 
 resource "google_kms_crypto_key" "example-key" {
   name            = "%s-kms-key"
-  key_ring        = google_kms_key_ring.keyring.self_link
+  key_ring        = google_kms_key_ring.keyring.id
   rotation_period = "100000s"
 }
 

diff --git a/google-beta/resource_container_node_pool_test.go b/google-beta/resource_container_node_pool_test.go
@@ -1755,7 +1755,7 @@ resource "google_kms_key_ring" "keyring" {
 
 resource "google_kms_crypto_key" "example-key" {
   name            = "%s-kms-key"
-  key_ring        = google_kms_key_ring.keyring.self_link
+  key_ring        = google_kms_key_ring.keyring.id
   rotation_period = "100000s"
 }
 

diff --git a/google-beta/resource_healthcare_dataset.go b/google-beta/resource_healthcare_dataset.go
@@ -322,14 +322,10 @@ func expandHealthcareDatasetTimeZone(v interface{}, d TerraformResourceData, con
 }
 
 func resourceHealthcareDatasetDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/google-beta/resource_healthcare_dicom_store.go b/google-beta/resource_healthcare_dicom_store.go
@@ -510,14 +510,10 @@ func expandHealthcareDicomStoreStreamConfigsBigqueryDestinationTableUri(v interf
 }
 
 func resourceHealthcareDicomStoreDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/google-beta/resource_healthcare_fhir_store.go b/google-beta/resource_healthcare_fhir_store.go
@@ -802,14 +802,10 @@ func expandHealthcareFhirStoreStreamConfigsBigqueryDestinationSchemaConfigRecurs
 }
 
 func resourceHealthcareFhirStoreDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/google-beta/resource_healthcare_hl7_v2_store.go b/google-beta/resource_healthcare_hl7_v2_store.go
@@ -682,14 +682,10 @@ func expandHealthcareHl7V2StoreNotificationConfigPubsubTopic(v interface{}, d Te
 }
 
 func resourceHealthcareHl7V2StoreDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/google-beta/resource_kms_crypto_key.go b/google-beta/resource_kms_crypto_key.go
@@ -139,12 +139,6 @@ See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v
 					},
 				},
 			},
-			"self_link": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Deprecated:  "Deprecated in favor of id, which contains an identical value. This field will be removed in the next major release of the provider.",
-				Description: "The self link of the created KeyRing in the format projects/{project}/locations/{location}/keyRings/{name}.",
-			},
 		},
 		UseJSONNumber: true,
 	}
@@ -577,14 +571,10 @@ func resourceKMSCryptoKeyUpdateEncoder(d *schema.ResourceData, meta interface{},
 }
 
 func resourceKMSCryptoKeyDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }

diff --git a/google-beta/resource_kms_crypto_key_test.go b/google-beta/resource_kms_crypto_key_test.go
@@ -457,7 +457,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
   labels = {
     key = "value"
   }
@@ -487,7 +487,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name            = "%s"
-  key_ring        = google_kms_key_ring.key_ring.self_link
+  key_ring        = google_kms_key_ring.key_ring.id
   rotation_period = "%s"
 }
 `, projectId, projectId, projectOrg, projectBillingAccount, keyRingName, cryptoKeyName, rotationPeriod)
@@ -515,7 +515,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
 }
 `, projectId, projectId, projectOrg, projectBillingAccount, keyRingName, cryptoKeyName)
 }
@@ -542,7 +542,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
   purpose  = "ASYMMETRIC_SIGN"
 
   version_template {
@@ -596,7 +596,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
   labels = {
     key = "value"
   }
@@ -627,7 +627,7 @@ resource "google_kms_key_ring" "key_ring" {
 
 resource "google_kms_crypto_key" "crypto_key" {
   name     = "%s"
-  key_ring = google_kms_key_ring.key_ring.self_link
+  key_ring = google_kms_key_ring.key_ring.id
   labels = {
     key = "value"
   }

diff --git a/google-beta/resource_kms_key_ring.go b/google-beta/resource_kms_key_ring.go
@@ -52,12 +52,6 @@ A full list of valid locations can be found by running 'gcloud kms locations lis
 				ForceNew:    true,
 				Description: `The resource name for the KeyRing.`,
 			},
-			"self_link": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Deprecated:  "Deprecated in favor of id, which contains an identical value. This field will be removed in the next major release of the provider.",
-				Description: "The self link of the created KeyRing in the format projects/{project}/locations/{location}/keyRings/{name}.",
-			},
 			"project": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -230,14 +224,10 @@ func resourceKMSKeyRingEncoder(d *schema.ResourceData, meta interface{}, obj map
 }
 
 func resourceKMSKeyRingDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/google-beta/resource_pubsub_subscription_test.go b/google-beta/resource_pubsub_subscription_test.go
@@ -61,7 +61,6 @@ func TestAccPubsubSubscription_update(t *testing.T) {
 
 	topic := fmt.Sprintf("tf-test-topic-%s", randString(t, 10))
 	subscriptionShort := fmt.Sprintf("tf-test-sub-%s", randString(t, 10))
-	subscriptionLong := fmt.Sprintf("projects/%s/subscriptions/%s", getTestProjectFromEnv(), subscriptionShort)
 
 	vcrTest(t, resource.TestCase{
 		PreCheck:     func() { testAccPreCheck(t) },

diff --git a/google-beta/resource_vpc_access_connector.go b/google-beta/resource_vpc_access_connector.go
@@ -624,14 +624,10 @@ func resourceVPCAccessConnectorEncoder(d *schema.ResourceData, meta interface{},
 }
 
 func resourceVPCAccessConnectorDecoder(d *schema.ResourceData, meta interface{}, res map[string]interface{}) (map[string]interface{}, error) {
-	// Take the returned long form of the name and use it as `self_link`.
-	// Then modify the name to be the user specified form.
+	// Modify the name to be the user specified form.
 	// We can't just ignore_read on `name` as the linter will
 	// complain that the returned `res` is never used afterwards.
 	// Some field needs to be actually set, and we chose `name`.
-	if err := d.Set("self_link", res["name"].(string)); err != nil {
-		return nil, fmt.Errorf("Error setting self_link: %s", err)
-	}
 	res["name"] = d.Get("name").(string)
 	return res, nil
 }
diff --git a/website/docs/d/kms_crypto_key.html.markdown b/website/docs/d/kms_crypto_key.html.markdown
@@ -27,7 +27,7 @@ data "google_kms_key_ring" "my_key_ring" {
 
 data "google_kms_crypto_key" "my_crypto_key" {
   name     = "my-crypto-key"
-  key_ring = data.google_kms_key_ring.my_key_ring.self_link
+  key_ring = data.google_kms_key_ring.my_key_ring.id
 }
 ```
 

diff --git a/website/docs/d/kms_secret.html.markdown b/website/docs/d/kms_secret.html.markdown
@@ -33,7 +33,7 @@ resource "google_kms_key_ring" "my_key_ring" {
 
 resource "google_kms_crypto_key" "my_crypto_key" {
   name     = "my-crypto-key"
-  key_ring = google_kms_key_ring.my_key_ring.self_link
+  key_ring = google_kms_key_ring.my_key_ring.id
 }
 ```
 

diff --git a/website/docs/d/kms_secret_asymmetric.html.markdown b/website/docs/d/kms_secret_asymmetric.html.markdown
@@ -36,7 +36,7 @@ resource "google_kms_key_ring" "my_key_ring" {
 
 resource "google_kms_crypto_key" "my_crypto_key" {
   name     = "my-crypto-key"
-  key_ring = google_kms_key_ring.my_key_ring.self_link
+  key_ring = google_kms_key_ring.my_key_ring.id
   purpose  = "ASYMMETRIC_DECRYPT"
   version_template {
     algorithm = "RSA_DECRYPT_OAEP_4096_SHA256"

diff --git a/website/docs/d/kms_secret_ciphertext.html.markdown b/website/docs/d/kms_secret_ciphertext.html.markdown
@@ -35,7 +35,7 @@ resource "google_kms_key_ring" "my_key_ring" {
 
 resource "google_kms_crypto_key" "my_crypto_key" {
   name     = "my-crypto-key"
-  key_ring = google_kms_key_ring.my_key_ring.self_link
+  key_ring = google_kms_key_ring.my_key_ring.id
 }
 ```
 

diff --git a/website/docs/guides/version_4_upgrade.html.markdown b/website/docs/guides/version_4_upgrade.html.markdown
@@ -402,6 +402,32 @@ This field was incorrectly included in the GA `google` provider in past releases
 In order to continue to use the feature, add `provider = google-beta` to your
 resource definition.
 
+## Resource: `google_compute_snapshot`
+
+### `source_disk_link` is now removed
+
+Removed in favor of `source_disk`.
+
+## Resource: `google_kms_crypto_key`
+
+### `self_link` is now removed
+
+Removed in favor of `id`.
+
+## Resource: `google_kms_key_ring`
+
+### `self_link` is now removed
+
+Removed in favor of `id`.
+
+## Datasource: `google_kms_key_ring`
+
+### `id` now matches the `google_kms_key_ring` id format
+
+The format has changed to better match the resource's ID format.
+
+Interpolations based on the `id` of the datasource may require updates.
+
 ## Resource: `google_data_loss_prevention_trigger`
 
 ### Exactly one of `inspect_job.0.storage_config.0.cloud_storage_options.0.file_set.0.url` or `inspect_job.0.storage_config.0.cloud_storage_options.0.file_set.0.regex_file_set` is required