Normalize name field (#8360) (#5905)

* Normalize name field

* Fix import

* Support previous import id

* Also shorten name in encoder

* Add long form test

* Add upgrade state function

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

Author: modular-magician

.changelog/8360.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+monitoring: fixed an issue which occurred when `name` field of `google_monitoring_monitored_project` was long-form
+```

google-beta/resource_monitoring_monitored_project_generated_test.go

@@ -74,6 +74,48 @@ resource "google_project" "basic" {
 `, context)
 }
 
+func TestAccMonitoringMonitoredProject_monitoringMonitoredProjectLongFormExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"org_id":        envvar.GetTestOrgFromEnv(t),
+		"project_id":    envvar.GetTestProjectFromEnv(),
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckMonitoringMonitoredProjectDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccMonitoringMonitoredProject_monitoringMonitoredProjectLongFormExample(context),
+			},
+			{
+				ResourceName:            "google_monitoring_monitored_project.primary",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"metrics_scope"},
+			},
+		},
+	})
+}
+
+func testAccMonitoringMonitoredProject_monitoringMonitoredProjectLongFormExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_monitoring_monitored_project" "primary" {
+  metrics_scope = "%{project_id}"
+  name          = "locations/global/metricsScopes/%{project_id}/projects/${google_project.basic.project_id}"
+}
+
+resource "google_project" "basic" {
+  project_id = "tf-test-m-id%{random_suffix}"
+  name       = "tf-test-m-id%{random_suffix}-display"
+  org_id     = "%{org_id}"
+}
+`, context)
+}
+
 func testAccCheckMonitoringMonitoredProjectDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

google-beta/services/monitoring/resource_monitoring_monitored_project.go

@@ -18,9 +18,11 @@
 package monitoring
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"reflect"
+	"strings"
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -44,6 +46,16 @@ func ResourceMonitoringMonitoredProject() *schema.Resource {
 			Delete: schema.DefaultTimeout(20 * time.Minute),
 		},
 
+		SchemaVersion: 1,
+
+		StateUpgraders: []schema.StateUpgrader{
+			{
+				Type:    resourceMonitoringMonitoredProjectResourceV0().CoreConfigSchema().ImpliedType(),
+				Upgrade: ResourceMonitoringMonitoredProjectUpgradeV0,
+				Version: 0,
+			},
+		},
+
 		Schema: map[string]*schema.Schema{
 			"metrics_scope": {
 				Type:             schema.TypeString,
@@ -53,10 +65,11 @@ func ResourceMonitoringMonitoredProject() *schema.Resource {
 				Description:      `Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`,
 			},
 			"name": {
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-				Description: `Immutable. The resource name of the 'MonitoredProject'. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: 'locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}'`,
+				Type:             schema.TypeString,
+				Required:         true,
+				ForceNew:         true,
+				DiffSuppressFunc: tpgresource.CompareResourceNames,
+				Description:      `Immutable. The resource name of the 'MonitoredProject'. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: 'locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}'`,
 			},
 			"create_time": {
 				Type:        schema.TypeString,
@@ -116,7 +129,7 @@ func resourceMonitoringMonitoredProjectCreate(d *schema.ResourceData, meta inter
 	}
 
 	// Store the ID now
-	id, err := tpgresource.ReplaceVars(d, config, "v1/locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}")
+	id, err := tpgresource.ReplaceVars(d, config, "locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}")
 	if err != nil {
 		return fmt.Errorf("Error constructing id: %s", err)
 	}
@@ -146,6 +159,9 @@ func resourceMonitoringMonitoredProjectRead(d *schema.ResourceData, meta interfa
 		billingProject = bp
 	}
 
+	name := d.Get("name").(string)
+	name = tpgresource.GetResourceNameFromSelfLink(name)
+	d.Set("name", name)
 	metricsScope := d.Get("metrics_scope").(string)
 	metricsScope = tpgresource.GetResourceNameFromSelfLink(metricsScope)
 	d.Set("metrics_scope", metricsScope)
@@ -240,16 +256,23 @@ func resourceMonitoringMonitoredProjectDelete(d *schema.ResourceData, meta inter
 }
 
 func resourceMonitoringMonitoredProjectImport(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+	name := d.Get("name").(string)
+	name = tpgresource.GetResourceNameFromSelfLink(name)
+	d.Set("name", name)
+	metricsScope := d.Get("metrics_scope").(string)
+	metricsScope = tpgresource.GetResourceNameFromSelfLink(metricsScope)
+	d.Set("metrics_scope", metricsScope)
 	config := meta.(*transport_tpg.Config)
 	if err := tpgresource.ParseImportId([]string{
+		"locations/global/metricsScopes/(?P<metrics_scope>[^/]+)/projects/(?P<name>[^/]+)",
 		"v1/locations/global/metricsScopes/(?P<metrics_scope>[^/]+)/projects/(?P<name>[^/]+)",
 		"(?P<metrics_scope>[^/]+)/(?P<name>[^/]+)",
 	}, d, config); err != nil {
 		return nil, err
 	}
 
 	// Replace import id for the resource id
-	id, err := tpgresource.ReplaceVars(d, config, "v1/locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}")
+	id, err := tpgresource.ReplaceVars(d, config, "locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}")
 	if err != nil {
 		return nil, fmt.Errorf("Error constructing id: %s", err)
 	}
@@ -273,6 +296,7 @@ func expandNestedMonitoringMonitoredProjectName(v interface{}, d tpgresource.Ter
 func resourceMonitoringMonitoredProjectEncoder(d *schema.ResourceData, meta interface{}, obj map[string]interface{}) (map[string]interface{}, error) {
 	name := d.Get("name").(string)
 	name = tpgresource.GetResourceNameFromSelfLink(name)
+	d.Set("name", name)
 	metricsScope := d.Get("metrics_scope").(string)
 	metricsScope = tpgresource.GetResourceNameFromSelfLink(metricsScope)
 	d.Set("metrics_scope", metricsScope)
@@ -350,3 +374,39 @@ func resourceMonitoringMonitoredProjectDecoder(d *schema.ResourceData, meta inte
 	}
 	return res, nil
 }
+
+func resourceMonitoringMonitoredProjectResourceV0() *schema.Resource {
+	return &schema.Resource{
+		Schema: map[string]*schema.Schema{
+			"metrics_scope": {
+				Type:             schema.TypeString,
+				Required:         true,
+				ForceNew:         true,
+				DiffSuppressFunc: tpgresource.CompareResourceNames,
+				Description:      `Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}`,
+			},
+			"name": {
+				Type:             schema.TypeString,
+				Required:         true,
+				ForceNew:         true,
+				DiffSuppressFunc: tpgresource.CompareResourceNames,
+				Description:      `Immutable. The resource name of the 'MonitoredProject'. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent project numbers. Example: 'locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}'`,
+			},
+			"create_time": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: `Output only. The time when this 'MonitoredProject' was created.`,
+			},
+		},
+		UseJSONNumber: true,
+	}
+}
+
+func ResourceMonitoringMonitoredProjectUpgradeV0(_ context.Context, rawState map[string]any, meta any) (map[string]any, error) {
+	log.Printf("[DEBUG] Attributes before migration: %#v", rawState)
+
+	rawState["id"] = strings.TrimPrefix(rawState["id"].(string), "v1/")
+
+	log.Printf("[DEBUG] Attributes after migration: %#v", rawState)
+	return rawState, nil
+}

website/docs/r/monitoring_monitored_project.html.markdown

@@ -66,7 +66,7 @@ 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 `v1/locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}`
+* `id` - an identifier for the resource with format `locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}`
 
 * `create_time` -
   Output only. The time when this `MonitoredProject` was created.
@@ -86,6 +86,6 @@ This resource provides the following
 MonitoredProject can be imported using any of these accepted formats:
 
 ```
-$ terraform import google_monitoring_monitored_project.default v1/locations/global/metricsScopes/{{metrics_scope}}/projects/{{name}}
-$ terraform import google_monitoring_monitored_project.default {{metrics_scope}}/{{name}}
+$ terraform import google_monitoring_monitored_project.default v1/locations/global/metricsScopes/{{name}}
+$ terraform import google_monitoring_monitored_project.default {{name}}
 ```