resourceIdentity: add Identity support in MMv1/DCL resources (#14125)

Author: BBBmau

mmv1/api/resource.go

@@ -249,6 +249,11 @@ type Resource struct {
 	// used for maintaining state stability with resources first provisioned on older api versions.
 	SchemaVersion int `yaml:"schema_version,omitempty"`
 
+	// The version of the identity schema for the resource.
+	IdentitySchemaVersion int `yaml:"identity_schema_version,omitempty"`
+
+	IdentityUpgraders bool `yaml:"identity_upgraders,omitempty"`
+
 	// From this schema version on, state_upgrader code is generated for the resource.
 	// When unset, state_upgrade_base_schema_version defauts to 0.
 	// Normally, it is not needed to be set.
@@ -598,6 +603,26 @@ func (r Resource) AllNestedProperties(props []*Type) []*Type {
 	return nested
 }
 
+func (r Resource) IdentityProperties() []*Type {
+	props := make([]*Type, 0)
+	importFormat := r.ExtractIdentifiers(ImportIdFormats(r.ImportFormat, r.Identity, r.BaseUrl)[0])
+	optionalValues := map[string]bool{"project": false, "zone": false, "region": false}
+	for _, p := range r.AllProperties() {
+		if slices.Contains(importFormat, google.Underscore(p.Name)) {
+			props = append(props, p)
+			optionalValues[p.Name] = true
+		}
+	}
+
+	for _, field := range []string{"project", "zone", "region"} { // prevents duplicates
+		if slices.Contains(importFormat, field) && !optionalValues[field] {
+			props = append(props, &Type{Name: field, Type: "string"})
+		}
+	}
+
+	return props
+}
+
 func (r Resource) SensitiveProps() []*Type {
 	props := r.AllNestedProperties(r.RootProperties())
 	return google.Select(props, func(p *Type) bool {
@@ -886,6 +911,10 @@ func (r Resource) StateMigrationFile() string {
 	return fmt.Sprintf("templates/terraform/state_migrations/%s_%s.go.tmpl", google.Underscore(r.ProductMetadata.Name), google.Underscore(r.Name))
 }
 
+func (r Resource) IdentityUpgraderFile() string {
+	return fmt.Sprintf("templates/terraform/identity_upgraders/%s_%s.go.tmpl", google.Underscore(r.ProductMetadata.Name), google.Underscore(r.Name))
+}
+
 // ====================
 // Version-related methods
 // ====================
@@ -1145,7 +1174,6 @@ func ImportIdFormats(importFormat, identity []string, baseUrl string) []string {
 	// short id: {{project}}/{{zone}}/{{name}}
 	fieldMarkers := regexp.MustCompile(`{{[[:word:]]+}}`).FindAllString(idFormats[0], -1)
 	shortIdFormat := strings.Join(fieldMarkers, "/")
-
 	// short ids without fields with provider-level defaults:
 
 	// without project
@@ -1191,6 +1219,7 @@ func ImportIdFormats(importFormat, identity []string, baseUrl string) []string {
 	uniq = google.Reject(slices.Compact(uniq), func(i string) bool {
 		return i == ""
 	})
+
 	return uniq
 }
 
@@ -1835,6 +1864,21 @@ func (r Resource) StateUpgradersCount() []int {
 	return nums
 }
 
+func (r Resource) IdentityUpgradersCount() []int {
+	var nums []int
+	for i := 1; i < r.IdentitySchemaVersion; i++ {
+		nums = append(nums, i)
+	}
+	return nums
+}
+
+func (r Resource) GetIdentitySchemaVersion() int {
+	if r.IdentitySchemaVersion == 0 { // default to 1 if not set; a resource with no identity support has a version of 0
+		return 1
+	}
+	return r.IdentitySchemaVersion
+}
+
 func (r Resource) CaiProductBaseUrl() string {
 	version := r.ProductMetadata.VersionObjOrClosest(r.TargetVersionName)
 	baseUrl := version.CaiBaseUrl

mmv1/api/resource/custom_code.go

@@ -128,6 +128,13 @@ type CustomCode struct {
 	// inserts that for you - do not include it in your custom code.
 	CustomImport string `yaml:"custom_import"`
 
+	// This code replaces the entire identity schema method.  Since the identity schema method's function header can't be changed, the template
+	// inserts that for you - do not include it in your custom code.
+	CustomIdentitySchema *string `yaml:"custom_identity_schema,omitempty"`
+
+	// This code is run in the Read method to set the identity.
+	CustomIdentityRead string `yaml:"custom_identity_read"`
+
 	// This code is run just after the import method succeeds - it
 	// is useful for parsing attributes that are necessary for
 	// the Read() method to succeed.

mmv1/products/apigee/AddonsConfig.yaml

@@ -41,6 +41,8 @@ async:
 custom_code:
   custom_import: 'templates/terraform/custom_import/apigee_addons.go.tmpl'
   test_check_destroy: 'templates/terraform/custom_check_destroy/apigee_addons_override.go.tmpl'
+  custom_identity_schema: 'templates/terraform/custom_identity_schema/apigee_addons.go.tmpl'
+  custom_identity_read: 'templates/terraform/custom_identity_read/apigee_addons.go.tmpl'
 examples:
   - name: 'apigee_addons_basic'
     exclude_test: true

mmv1/products/iap/Brand.yaml

@@ -53,6 +53,8 @@ identity:
   - name
 custom_code:
   custom_import: 'templates/terraform/custom_import/iap_brand.go.tmpl'
+  custom_identity_schema: 'templates/terraform/custom_identity_schema/iap_brand.go.tmpl'
+  custom_identity_read: 'templates/terraform/custom_identity_read/iap_brand.go.tmpl'
 examples:
   - name: 'iap_brand'
     primary_resource_id: 'project_brand'

mmv1/templates/terraform/custom_identity_read/apigee_addons.go.tmpl

@@ -0,0 +1,10 @@
+	identity, err := d.Identity()
+	if err != nil {
+		return fmt.Errorf("Error getting identity: %s", err)
+	}
+	if v, ok := identity.GetOk("org"); ok && v != "" {
+		err = identity.Set("org", d.Get("org").(string))
+		if err != nil {
+			return fmt.Errorf("Error setting org: %s", err)
+		}
+	}

mmv1/templates/terraform/custom_identity_read/iap_brand.go.tmpl

@@ -0,0 +1,10 @@
+	identity, err := d.Identity()
+	if err != nil {
+		return fmt.Errorf("Error getting identity: %s", err)
+	}
+	if v, ok := identity.GetOk("project"); ok && v != "" {
+		err = identity.Set("project", d.Get("project").(string))
+		if err != nil {
+			return fmt.Errorf("Error setting project: %s", err)
+		}
+	}

mmv1/templates/terraform/custom_identity_schema/addons_config.go.tmpl

@@ -0,0 +1,11 @@
+Identity: &schema.ResourceIdentity{
+  Version: 1,
+  SchemaFunc: func() map[string]*schema.Schema {
+    return map[string]*schema.Schema{
+      "org": {
+        Type:     schema.TypeString,
+        RequiredForImport: true,
+      },
+    }
+  },
+},

mmv1/templates/terraform/custom_identity_schema/apigee_addons.go.tmpl

@@ -0,0 +1,11 @@
+Identity: &schema.ResourceIdentity{
+  Version: 1,
+  SchemaFunc: func() map[string]*schema.Schema {
+    return map[string]*schema.Schema{
+      "org": {
+        Type:     schema.TypeString,
+        RequiredForImport: true,
+      },
+    }
+  },
+},

mmv1/templates/terraform/custom_identity_schema/iap_brand.go.tmpl

@@ -0,0 +1,11 @@
+Identity: &schema.ResourceIdentity{
+  Version: 1,
+  SchemaFunc: func() map[string]*schema.Schema {
+    return map[string]*schema.Schema{
+      "name": {
+        Type:     schema.TypeString,
+        RequiredForImport: true,
+      },
+    }
+  },
+},

mmv1/templates/terraform/resource.go.tmpl

@@ -131,6 +131,38 @@ func Resource{{ $.ResourceName -}}() *schema.Resource {
         DeprecationMessage: "{{ $.DeprecationMessage -}}",
 {{- end}}
 
+{{ if $.CustomCode.CustomIdentitySchema }}
+    {{ $.CustomTemplate $.CustomCode.CustomIdentitySchema false -}}
+{{ else }}
+        Identity: &schema.ResourceIdentity{
+          Version: {{ $.GetIdentitySchemaVersion }},
+          SchemaFunc: func() map[string]*schema.Schema {
+            return map[string]*schema.Schema{
+              {{- range $p := .IdentityProperties }}
+              "{{ underscore $p.Name}}": {
+                Type:     schema.TypeString,
+                {{- if or $p.Required $p.Output }}
+                RequiredForImport: true,
+                {{- else }}
+                OptionalForImport: true,
+                {{- end }}
+              },
+              {{- end }}
+            }
+          },
+{{- if $.IdentityUpgraders }}
+          IdentityUpgraders: []schema.IdentityUpgrader{
+{{- range $v := $.IdentityUpgradersCount }}
+              {
+                Type: identity{{ $.ResourceName }}ResourceV{{$v}}(),
+                Upgrade: Identity{{ $.ResourceName }}UpgradeV{{$v}},
+                Version: {{$v}},
+              },
+{{- end }}
+          },
+{{- end }}
+        },
+{{- end }}
         Schema: map[string]*schema.Schema{
 			{{- range $prop := $.OrderProperties $.AllUserProperties }}
 {{template "SchemaFields" $prop -}}
@@ -686,8 +718,24 @@ func resource{{ $.ResourceName -}}Read(d *schema.ResourceData, meta interface{})
     }
 {{- end}}
 
-    return nil
+{{- if $.CustomCode.CustomIdentityRead }}
+    {{ $.CustomTemplate $.CustomCode.CustomIdentityRead true -}}
+{{- else }}
+	identity, err := d.Identity()
+	if err != nil {
+		return fmt.Errorf("Error getting identity: %s", err)
+	}
+    {{- range $p := $.IdentityProperties }}
+    if v, ok := identity.GetOk("{{ underscore $p.Name}}"); ok && v != "" {
+        err = identity.Set("{{ underscore $p.Name}}", d.Get("{{ underscore $p.Name}}").(string))
+            if err != nil {
+                return fmt.Errorf("Error setting {{ underscore $p.Name}}: %s", err)
+            }     
+    }
+    {{- end }}
+{{- end }}
 {{  end -}}
+    return nil
 }
 
 {{if $.Updatable -}}
@@ -1222,6 +1270,12 @@ func resource{{ $.ResourceName -}}PostCreateFailure(d *schema.ResourceData, meta
 
     {{ $.CustomTemplate $.StateMigrationFile false -}}
 {{- end }}
+
+{{- if and $.IdentitySchemaVersion $.IdentityUpgraders }}
+
+    {{ $.CustomTemplate $.IdentityUpgraderFile false -}}
+{{- end }}
+
 {{- if and $.HasPostCreateComputedFields (or (or (not $.GetAsync) (not ($.GetAsync.Allow "Create"))) (and $.GetAsync (and ($.GetAsync.IsA "PollAsync") ($.GetAsync.Allow "Create"))))}}
 func resource{{ $.ResourceName -}}PostCreateSetComputedFields(d *schema.ResourceData, meta interface{}, res map[string]interface{}) error {
     config := meta.(*transport_tpg.Config)