Merge branch 'FEATURE-BRANCH-resource-identity' into sync-main-dec-8-FEATURE-BRANCH-resource-identity

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.
@@ -660,6 +665,32 @@ 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"})
+		}
+	}
+
+	if len(r.CustomCode.CustomIdentity) > 0 {
+		for _, fieldName := range r.CustomCode.CustomIdentity {
+			props = append(props, &Type{Name: google.Underscore(fieldName), Type: "string", Required: true})
+		}
+	}
+
+	return props
+}
+
 func (r Resource) SensitiveProps() []*Type {
 	props := r.AllNestedProperties(r.RootProperties())
 	return google.Select(props, func(p *Type) bool {
@@ -1089,6 +1120,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
 // ====================
@@ -1348,7 +1383,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
@@ -1394,6 +1428,7 @@ func ImportIdFormats(importFormat, identity []string, baseUrl string) []string {
 	uniq = google.Reject(slices.Compact(uniq), func(i string) bool {
 		return i == ""
 	})
+
 	return uniq
 }
 
@@ -2153,6 +2188,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 {
 	return r.ProductMetadata.ServiceBaseUrl()
 }

mmv1/api/resource/custom_code.go

@@ -128,6 +128,10 @@ type CustomCode struct {
 	// inserts that for you - do not include it in your custom code.
 	CustomImport string `yaml:"custom_import,omitempty"`
 
+	// 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.
+	CustomIdentity []string `yaml:"custom_identity,omitempty"`
+
 	// 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:
+    - 'org'
 examples:
   - name: 'apigee_addons_basic'
     exclude_test: true

mmv1/products/iap/Brand.yaml

@@ -57,6 +57,8 @@ identity:
   - name
 custom_code:
   custom_import: 'templates/terraform/custom_import/iap_brand.go.tmpl'
+  custom_identity:
+    - 'project'
 examples:
   - name: 'iap_brand'
     primary_resource_id: 'project_brand'

mmv1/templates/terraform/examples/base_configs/test_file.go.tmpl

@@ -110,6 +110,12 @@ func TestAcc{{ $e.TestSlug $.Res.ProductMetadata.Name $.Res.Name }}(t *testing.T
 				ImportStateVerifyIgnore: {{ $.Res.IgnoreReadPropertiesToStringLegacy $e }},
 		{{- end }}
 			},
+			{
+				ResourceName:       "{{ $.Res.TerraformName }}.{{ $e.PrimaryResourceId }}",
+				RefreshState:       true,
+				ExpectNonEmptyPlan: true,
+				ImportStateKind:    resource.ImportBlockWithResourceIdentity,
+			},
 	{{- end }}
 		},
 	})

mmv1/templates/terraform/resource.go.tmpl

@@ -163,6 +163,34 @@ func Resource{{ $.ResourceName -}}() *schema.Resource {
         DeprecationMessage: "{{ $.DeprecationMessage -}}",
 {{- end}}
 
+        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 }}
+        },
         Schema: map[string]*schema.Schema{
 			{{- range $prop := $.OrderProperties $.AllUserProperties }}
 {{template "SchemaFields" $prop -}}
@@ -718,8 +746,21 @@ func resource{{ $.ResourceName -}}Read(d *schema.ResourceData, meta interface{})
     }
 {{- end}}
 
+	identity, err := d.Identity()
+    if err != nil && identity != nil {
+    {{- 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 }}
+    } else {
+        log.Printf("[DEBUG] identity not set: %s", err)
+    }
+{{- end }}
     return nil
-{{  end -}}
 }
 
 {{if $.Updatable -}}
@@ -1254,6 +1295,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)

mmv1/templates/terraform/resource.html.markdown.tmpl

@@ -191,6 +191,18 @@ This resource does not support import.
 * `{{replaceAll $idFormat "%" "" }}`
 {{- end }}
 
+In Terraform v1.12.0 and later, use an [`identity` block](https://developer.hashicorp.com/terraform/language/resources/identities) to import {{$.Name}} using identity values. For example:
+
+```tf
+import {
+  identity = {
+    {{- range $identity := $.IdentityProperties }}
+    {{ $identity.Name }} = "<-{{ if $identity.Required }}required{{ else }}optional{{ end }} value->"
+    {{- end }}
+  }
+  to = {{$.TerraformName}}.default
+}
+```
 
 In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import {{$.Name}} using one of the formats above. For example:
 

mmv1/third_party/terraform/go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-mux v0.20.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.38.1
-	github.com/hashicorp/terraform-plugin-testing v1.5.1
+	github.com/hashicorp/terraform-plugin-testing v1.13.3
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/mitchellh/hashstructure v1.1.0
 	github.com/sirupsen/logrus v1.8.1
@@ -99,7 +99,7 @@ require (
 	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
 	github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
-	github.com/zclconf/go-cty v1.17.0 // indirect
+	github.com/zclconf/go-cty v1.16.3 // indirect
 	github.com/zeebo/errs v1.4.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.61.0 // indirect

mmv1/third_party/terraform/go.sum

@@ -179,10 +179,10 @@ github.com/hashicorp/terraform-plugin-mux v0.20.0 h1:3QpBnI9uCuL0Yy2Rq/kR9cOdmOF
 github.com/hashicorp/terraform-plugin-mux v0.20.0/go.mod h1:wSIZwJjSYk86NOTX3fKUlThMT4EAV1XpBHz9SAvjQr4=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.38.1 h1:mlAq/OrMlg04IuJT7NpefI1wwtdpWudnEmjuQs04t/4=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.38.1/go.mod h1:GQhpKVvvuwzD79e8/NZ+xzj+ZpWovdPAe8nfV/skwNU=
-github.com/hashicorp/terraform-plugin-testing v1.5.1 h1:T4aQh9JAhmWo4+t1A7x+rnxAJHCDIYW9kXyo4sVO92c=
-github.com/hashicorp/terraform-plugin-testing v1.5.1/go.mod h1:dg8clO6K59rZ8w9EshBmDp1CxTIPu3yA4iaDpX1h5u0=
 github.com/hashicorp/terraform-registry-address v0.4.0 h1:S1yCGomj30Sao4l5BMPjTGZmCNzuv7/GDTDX99E9gTk=
 github.com/hashicorp/terraform-registry-address v0.4.0/go.mod h1:LRS1Ay0+mAiRkUyltGT+UHWkIqTFvigGn/LbMshfflE=
+github.com/hashicorp/terraform-plugin-testing v1.13.3 h1:QLi/khB8Z0a5L54AfPrHukFpnwsGL8cwwswj4RZduCo=
+github.com/hashicorp/terraform-plugin-testing v1.13.3/go.mod h1:WHQ9FDdiLoneey2/QHpGM/6SAYf4A7AZazVg7230pLE=
 github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ=
 github.com/hashicorp/terraform-svchost v0.1.1/go.mod h1:mNsjQfZyf/Jhz35v6/0LWcv26+X7JPS+buii2c9/ctc=
 github.com/hashicorp/yamux v0.1.2 h1:XtB8kyFOyHXYVFnwT5C3+Bdo8gArse7j2AQ0DA0Uey8=