Merge branch 'main' of https://github.com/GoogleCloudPlatform/magic-modules

Author: actions-user

docs/content/convert/add-new-resource-tgc.md

@@ -72,14 +72,15 @@ func ResourceGoogleProject() *schema.Resource {
 		}
 	}
 }
-```
-
-You will also need to add an entry to [`tgc_next/provider/provider_mmv1_resources.go.tmpl`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/templates/tgc_next/provider/provider_mmv1_resources.go.tmpl), which is used to generate [`pkg/provider/provider_mmv1_resources.go`](https://github.com/GoogleCloudPlatform/terraform-google-conversion/blob/main/pkg/provider/provider_mmv1_resources.go). Each entry in `provider_mmv1_resources.go.tmpl` maps a terraform resource name to a function that returns the resource schema - in this case:
 
-```golang
-// ...
-"google_product_resource": product.ResourceName(),
-// ...
+func init() {
+	registry.Schema{
+		Name:        "google_product_resource",
+		ProductName: "product",
+		Type:        registry.SchemaTypeResource,
+		Schema:      ResourceGoogleProject(),
+	}.Register()
+}
 ```
 
 ##### Resource_tfplan2cai.go file

docs/content/develop/add-handwritten-datasource.md

@@ -169,16 +169,6 @@ added to that resource. You can create a new datasource of this type as follows:
    - If there is `labels` field with type `KeyValueLabels` in the corresponding resource: After calling the resource read method, call the function `tpgresource.SetDataSourceLabels(d)` to make `labels` and `terraform_labels` have all of the labels on the resource.
    - If there is `annotations` field with type `KeyValueAnnotations` in the corresponding resource: After calling the resource read method, call the function `tpgresource.SetDataSourceAnnotations(d)` to make `annotations` have all of the annotations on the resource.
 
-1. Add the datasource to `handwrittenDatasources` in [`magic-modules/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl)
-   ```go
-   var handwrittenDatasources = map[string]*schema.Resource{
-     // ...
-     "google_memorystore_instance": registry.DataSource("google_memorystore_instance"),
-     "google_memcache_instance":    registry.DataSource("google_memcache_instance"),
-     "google_redis_instance":       registry.DataSource("google_redis_instance"),
-     // ...
-   }
-   ```
 1. [Add documentation](#add-documentation)
 
 For creating a datasource based off an existing resource you can [make use of the

docs/content/develop/add-iam-support.md

@@ -92,8 +92,6 @@ iam_policy:
    - If any of the added Go code is beta-only:
      - Change the file suffix to `.go.tmpl`
      - Wrap each beta-only code block (including any imports) in a separate version guard: `{{- if ne $.TargetVersionName "ga" -}}...{{- else }}...{{- end }}`
-4. Register the binding, member, and policy resources `handwrittenIAMResources` in [`magic-modules/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl)
-   - Add a version guard for any beta-only resources.
 {{< /tab >}}
 {{% /tabs %}}
 

docs/content/develop/add-resource.md

@@ -165,12 +165,10 @@ For more information about types of resources and the generation process overall
    - Remove the comments at the top of the file.
    - If any of the added Go code (including any imports) is beta-only, change the file suffix to `.go.tmpl` and wrap the beta-only code in a version guard: `{{- if ne $.TargetVersionName "ga" -}}...{{- else }}...{{- end }}`.
      - If the whole resource is beta-only, wrap everything except package declarations. Otherwise, individually wrap each logically-related block of code in a version guard (field, test, etc) rather than grouping adjacent version-guarded sections - it's easier to read and easier to modify as things move out of beta.
-5. Register the resource `handwrittenResources` in [`magic-modules/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl)
-   - Add a version guard for any beta-only resources.
-6. Optional: Complete other handwritten tasks that require the MMv1 configuration file.
+5. Optional: Complete other handwritten tasks that require the MMv1 configuration file.
     - [Add resource tests]({{< ref "/test/test" >}})
     - [Add IAM support]({{<ref "/develop/add-iam-support" >}})
-7. Delete the MMv1 configuration file.
+6. Delete the MMv1 configuration file.
 {{< /tab >}}
 {{% /tabs %}}
 

mmv1/api/product.go

@@ -80,6 +80,10 @@ type Product struct {
 
 	// ImportPath contains the prefix used for importing packages in generated files.
 	ImportPath string `yaml:"-"`
+
+	// RepByDefault is if this product should default to REP endpoints if
+	// available. Changing this requires REP to be supported in *ALL* regions
+	RepByDefault bool `yaml:"rep_by_default,omitempty"`
 }
 
 func (p *Product) UnmarshalYAML(value *yaml.Node) error {

mmv1/api/product/version.go

@@ -30,6 +30,7 @@ type Version struct {
 	CaiLegacyBaseUrl string `yaml:"cai_legacy_base_url,omitempty"`
 	BaseUrl          string `yaml:"base_url"`
 	Name             string
+	RepUrl           string `yaml:"rep_url,omitempty"`
 }
 
 func (v *Version) Validate(pName string) {
@@ -44,3 +45,9 @@ func (v *Version) Validate(pName string) {
 func (v *Version) CompareTo(other *Version) int {
 	return slices.Index(ORDER, v.Name) - slices.Index(ORDER, other.Name)
 }
+
+// Whether this version supports regionalized endpoints (REP). The default
+// of regional vs global is controlled at the product level
+func (v *Version) RepEnabled() bool {
+	return v.RepUrl != ""
+}

mmv1/products/artifactregistry/product.yaml

@@ -17,8 +17,10 @@ display_name: 'Artifact Registry'
 versions:
   - name: 'beta'
     base_url: 'https://artifactregistry.googleapis.com/v1/'
+    rep_url: 'https://artifactregistry.{{location}}.rep.googleapis.com/v1/'
   - name: 'ga'
     base_url: 'https://artifactregistry.googleapis.com/v1/'
+    rep_url: 'https://artifactregistry.{{location}}.rep.googleapis.com/v1/'
 scopes:
   - 'https://www.googleapis.com/auth/cloud-platform'
 async:

mmv1/products/metastore/Service.yaml

@@ -101,7 +101,6 @@ examples:
       metastore_service_name: 'metastore-srv'
       network_name: 'my-network'
       subnet_name: 'my-subnetwork'
-    exclude_test: true
   - name: 'dataproc_metastore_service_private_service_connect_custom_routes'
     primary_resource_id: 'default'
     min_version: 'beta'

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

@@ -152,11 +152,26 @@ func testAccCheck{{ $.Res.ResourceName }}DestroyProducer(t *testing.T) func(s *t
 	{{- else }}
 
 		config := acctest.GoogleProviderConfig(t)
+		{{ if $.Res.ProductMetadata.Version.RepEnabled }}
 
+		urlFormatted, err := tpgresource.ReplaceVarsForTest(config, rs, "{{$.Res.SelfLinkUri}}")
+
+		if err != nil {
+			return err
+		}
+
+		loc := tpgresource.LocationFromId(urlFormatted)
+		basePath, err := transport_tpg.ResourceBasePath(config.{{$.Res.ProductMetadata.Name}}BasePath, config.{{$.Res.ProductMetadata.Name}}RepBasePath, "{{$.Res.ProductMetadata.Name}}", config, loc)
+		if err != nil {
+			return err
+		}
+		url := fmt.Sprintf("%s%s", basePath, urlFormatted)
+		{{- else }}
 		url, err := tpgresource.ReplaceVarsForTest(config, rs, "{{"{{"}}{{$.Res.ProductMetadata.Name}}{{"BasePath}}"}}{{$.Res.SelfLinkUri}}")
 		if err != nil {
 			return err
 		}
+		{{- end }}
 
 		billingProject := ""
 

mmv1/templates/terraform/operation.go.tmpl

@@ -50,6 +50,9 @@ type {{ $.ProductMetadata.Name }}OperationWaiter struct {
 {{- if $.IncludeProjectForOperation }}
   Project string
 {{- end }}
+{{- if $.ProductMetadata.Version.RepEnabled }}
+  Location string
+{{- end }}
 {{- if $.ProductMetadata.OperationRetry }}
   retryCount int
 {{- end }}
@@ -60,9 +63,16 @@ func (w *{{ $.ProductMetadata.Name }}OperationWaiter) QueryOp() (interface{}, er
   if w == nil {
     return nil, fmt.Errorf("Cannot query operation, it's unset or nil.")
   }
+{{- if $.ProductMetadata.Version.RepEnabled }}
+  basePath, err := transport_tpg.ResourceBasePath(w.Config.{{$.ProductMetadata.Name}}BasePath, w.Config.{{$.ProductMetadata.Name}}RepBasePath, "{{$.ProductMetadata.Name}}", w.Config, w.Location)
+  if err != nil {
+    return nil, err
+  }
+  url := fmt.Sprintf("%s{{ replaceAll $.GetAsync.Operation.BaseUrl "{{op_id}}" "%s" }}", basePath, w.CommonOperationWaiter.Op.Name)
+{{ else }}
   // Returns the proper get.
   url := fmt.Sprintf("%s{{ replaceAll $.GetAsync.Operation.BaseUrl "{{op_id}}" "%s" }}", w.Config.{{ $.ProductMetadata.Name }}BasePath, w.CommonOperationWaiter.Op.Name)
-
+{{ end }}
   return transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
     Config: w.Config,
     Method: "GET",
@@ -87,12 +97,15 @@ func (w *{{ $.ProductMetadata.Name }}OperationWaiter) IsRetryable(err error) boo
 {{- end }}
 
 
-func create{{ $.ProductMetadata.Name }}Waiter(config *transport_tpg.Config, op map[string]interface{}, {{- if $.IncludeProjectForOperation }} project, {{- end }} activity, userAgent string) (*{{ $.ProductMetadata.Name }}OperationWaiter, error) {
+func create{{ $.ProductMetadata.Name }}Waiter(config *transport_tpg.Config, op map[string]interface{}, {{- if $.IncludeProjectForOperation }} project,{{- end }}{{- if $.ProductMetadata.Version.RepEnabled }} location, {{- end }} activity, userAgent string) (*{{ $.ProductMetadata.Name }}OperationWaiter, error) {
   w := &{{ $.ProductMetadata.Name }}OperationWaiter{
     Config:    config,
     UserAgent: userAgent,
 {{- if $.IncludeProjectForOperation }}
     Project: project,
+{{- end }}
+{{- if $.ProductMetadata.Version.RepEnabled }}
+    Location: location,
 {{- end }}
   }
   if err := w.CommonOperationWaiter.SetOp(op); err != nil {
@@ -107,8 +120,8 @@ func create{{ $.ProductMetadata.Name }}Waiter(config *transport_tpg.Config, op m
 */}}
 
 // nolint: deadcode,unused {{/* TODO rewrite: remove the comment */}}
-func {{ camelize $.ProductMetadata.Name "upper" }}OperationWaitTimeWithResponse(config *transport_tpg.Config, op map[string]interface{}, response *map[string]interface{},{{- if $.IncludeProjectForOperation }} project,{{- end }} activity, userAgent string, timeout time.Duration) error {
-  w, err := create{{ $.ProductMetadata.Name }}Waiter(config, op, {{- if $.IncludeProjectForOperation }} project, {{ end }} activity, userAgent)
+func {{ camelize $.ProductMetadata.Name "upper" }}OperationWaitTimeWithResponse(config *transport_tpg.Config, op map[string]interface{}, response *map[string]interface{},{{- if $.IncludeProjectForOperation }} project,{{- end }}{{- if $.ProductMetadata.Version.RepEnabled }} location,{{- end }} activity, userAgent string, timeout time.Duration) error {
+  w, err := create{{ $.ProductMetadata.Name }}Waiter(config, op, {{- if $.IncludeProjectForOperation }} project, {{- end }}{{- if $.ProductMetadata.Version.RepEnabled }} location, {{ end }} activity, userAgent)
   if err != nil {
       return err
   }
@@ -122,12 +135,12 @@ func {{ camelize $.ProductMetadata.Name "upper" }}OperationWaitTimeWithResponse(
   return json.Unmarshal(rawResponse, response)
 }
 
-func {{ camelize $.ProductMetadata.Name "upper" }}OperationWaitTime(config *transport_tpg.Config, op map[string]interface{}, {{- if $.IncludeProjectForOperation }} project,{{- end }} activity, userAgent string, timeout time.Duration) error {
+func {{ camelize $.ProductMetadata.Name "upper" }}OperationWaitTime(config *transport_tpg.Config, op map[string]interface{}, {{- if $.IncludeProjectForOperation }} project,{{- end }}{{- if $.ProductMetadata.Version.RepEnabled }} location,{{- end }} activity, userAgent string, timeout time.Duration) error {
   if val, ok := op["name"]; !ok || val == "" {
     // This was a synchronous call - there is no operation to wait for.
     return nil
   }
-  w, err := create{{ $.ProductMetadata.Name }}Waiter(config, op, {{- if $.IncludeProjectForOperation }} project, {{ end }} activity, userAgent)
+  w, err := create{{ $.ProductMetadata.Name }}Waiter(config, op, {{- if $.IncludeProjectForOperation }} project, {{- end }}{{- if $.ProductMetadata.Version.RepEnabled }} location, {{ end }} activity, userAgent)
   if err != nil {
       // If w is nil, the op was synchronous.
       return err