List support mmv1

mmv1/api/resource.go

@@ -245,6 +245,8 @@ type Resource struct {
 	// EXPERIMENTAL: If true, resource should be autogenerated as a data source
 	Datasource *resource.Datasource `yaml:"datasource_experimental,omitempty"`
 
+	GenerateListResource bool `yaml:"generate_list_resource,omitempty"`
+
 	// If true, skip sweeper generation for this resource
 	ExcludeSweeper bool `yaml:"exclude_sweeper,omitempty"`
 
@@ -697,6 +699,28 @@ func (r Resource) IdentityProperties() []*Type {
 	return props
 }
 
+func (r Resource) ListScopeProperties() []*Type {
+	scope := r.ExtractIdentifiers(r.CollectionUrl())
+	return google.Select(r.IdentityProperties(), func(p *Type) bool {
+		return slices.Contains(scope, google.Underscore(p.Name))
+	})
+}
+
+func (r Resource) ListResultDisplayNameKeyStrings() []string {
+	var keys []string
+	for _, p := range r.RootProperties() {
+		if p.Name == "display_name" {
+			keys = append(keys, "display_name")
+			break
+		}
+	}
+	markers := regexp.MustCompile(`\{\{(\w+)\}\}`).FindAllStringSubmatch(r.IdFormat, -1)
+	if len(markers) > 0 {
+		keys = append(keys, markers[len(markers)-1][1])
+	}
+	return keys
+}
+
 func (r Resource) SensitiveProps() []*Type {
 	props := r.AllNestedProperties(r.RootProperties())
 	return google.Select(props, func(p *Type) bool {

mmv1/products/cloudbuild/Trigger.yaml

@@ -14,6 +14,7 @@
 ---
 name: 'Trigger'
 api_resource_type_kind: BuildTrigger
+collection_url_key: 'triggers'
 api_variant_patterns:
   - 'projects/{project}/locations/{location}/triggers/{trigger}'
 description: |
@@ -38,6 +39,7 @@ timeouts:
   insert_minutes: 20
   update_minutes: 20
   delete_minutes: 20
+generate_list_resource: true
 custom_code:
   constants: 'templates/terraform/constants/cloudbuild_trigger.tmpl'
   post_create: 'templates/terraform/post_create/cloudbuild_trigger_id.go.tmpl'

mmv1/products/cloudrun/Service.yaml

@@ -33,6 +33,7 @@ import_format:
 datasource_experimental:
   generate: true
   exclude_test: true
+generate_list_resource: true
 timeouts:
   insert_minutes: 20
   update_minutes: 20

mmv1/products/storage/Folder.yaml

@@ -24,6 +24,7 @@ timeouts:
   update_minutes: 20
   delete_minutes: 20
 exclude_sweeper: true
+generate_list_resource: true
 import_format:
   - '{{bucket}}/folders/{{%name}}'
   - '{{bucket}}/{{%name}}'

mmv1/provider/template_data.go

@@ -282,6 +282,16 @@ func (td *TemplateData) GenerateIamPolicyTestFile(filePath string, resource api.
 	td.GenerateFile(filePath, templatePath, resource, true, templates...)
 }
 
+// GenerateQueryTestFile emits a Terraform query-mode acceptance test for list resources (generate_list_resource).
+func (td *TemplateData) GenerateQueryTestFile(filePath string, resource api.Resource) {
+	templatePath := "templates/terraform/samples/base_configs/query_test_file.go.tmpl"
+	templates := []string{
+		templatePath,
+		"templates/terraform/env_var_context.go.tmpl",
+	}
+	td.GenerateFile(filePath, templatePath, resource, true, templates...)
+}
+
 func (td *TemplateData) GenerateSweeperFile(filePath string, resource api.Resource) {
 	templatePath := "templates/terraform/sweeper_file.go.tmpl"
 	templates := []string{

mmv1/provider/terraform.go

@@ -113,6 +113,9 @@ func (t *Terraform) GenerateObject(object api.Resource, outputFolder, productPat
 			t.GenerateSingularDataSourceTests(object, *templateData, outputFolder)
 			// log.Printf("Generating %s metadata", object.Name)
 			t.GenerateResourceMetadata(object, *templateData, outputFolder)
+			if object.GenerateListResource {
+				t.GenerateListResourceQueryTest(object, *templateData, outputFolder)
+			}
 		}
 	}
 
@@ -151,6 +154,19 @@ func (t *Terraform) GenerateResource(object api.Resource, templateData TemplateD
 			targetFilePath := path.Join(targetFolder, fmt.Sprintf("resource_%s.go", t.ResourceGoFilename(object)))
 			templateData.GenerateResourceFile(targetFilePath, object)
 		}
+		if object.GenerateListResource {
+			if object.ExcludeIdentityGeneration {
+				log.Fatalf("generate_list_resource requires identity support; remove exclude_identity_generation from resource %q or disable generate_list_resource", object.Name)
+			}
+			if object.ExcludeRead {
+				log.Fatalf("generate_list_resource requires read support; remove exclude_read from resource %q or disable generate_list_resource", object.Name)
+			}
+			targetFilePath := path.Join(targetFolder, fmt.Sprintf("list_%s.go", t.ResourceGoFilename(object)))
+			templateData.GenerateFile(targetFilePath, "templates/terraform/list_resource.go.tmpl", object, true,
+				"templates/terraform/list_resource.go.tmpl",
+				"templates/terraform/list_resource_method.go.tmpl",
+			)
+		}
 	}
 
 	if generateDocs {
@@ -254,6 +270,36 @@ func (t *Terraform) GenerateResourceTests(object api.Resource, templateData Temp
 	templateData.GenerateTestFile(targetFilePath, object)
 }
 
+func (t *Terraform) GenerateListResourceQueryTest(object api.Resource, templateData TemplateData, outputFolder string) {
+	if object.Samples != nil && object.Examples != nil {
+		log.Fatalf("Both Samples and Examples block exist in %v", object.Name)
+	}
+	if object.Examples == nil {
+		return
+	}
+
+	eligibleExample := false
+	for _, example := range object.Examples {
+		if !example.ExcludeTest {
+			if object.ProductMetadata.VersionObjOrClosest(t.Product.Version.Name).CompareTo(object.ProductMetadata.VersionObjOrClosest(example.MinVersion)) >= 0 {
+				eligibleExample = true
+				break
+			}
+		}
+	}
+	if !eligibleExample {
+		return
+	}
+
+	productName := t.Product.ApiName
+	targetFolder := path.Join(outputFolder, t.FolderName(), "services", productName)
+	if err := os.MkdirAll(targetFolder, os.ModePerm); err != nil {
+		log.Println(fmt.Errorf("error creating parent directory %v: %v", targetFolder, err))
+	}
+	targetFilePath := path.Join(targetFolder, fmt.Sprintf("list_%s_generated_test.go", t.ResourceGoFilename(object)))
+	templateData.GenerateQueryTestFile(targetFilePath, object)
+}
+
 func (t *Terraform) GenerateResourceSweeper(object api.Resource, templateData TemplateData, outputFolder string) {
 	if !object.ShouldGenerateSweepers() {
 		return
@@ -1092,3 +1138,47 @@ type ProviderWithProducts struct {
 	Compiler string
 	Products []*api.Product
 }
+
+// GeneratedListResourceRegistration describes one MMv1-generated list resource constructor
+// for framework_provider_mmv1_resources.go.tmpl.
+type GeneratedListResourceRegistration struct {
+	Package string // Go service package name (product ApiName), e.g. "cloudrun"
+	NewFunc string // e.g. "NewCloudRunServiceListResource"
+}
+
+func (t Terraform) GetGeneratedListResourcesInVersion(products []*api.Product) []GeneratedListResourceRegistration {
+	var out []GeneratedListResourceRegistration
+	for _, productDefinition := range products {
+		for _, object := range productDefinition.Objects {
+			if object.NotInVersion(productDefinition.VersionObjOrClosest(t.TargetVersionName)) || object.IsExcluded() || !object.GenerateListResource {
+				continue
+			}
+			out = append(out, GeneratedListResourceRegistration{
+				Package: productDefinition.ApiName,
+				NewFunc: fmt.Sprintf("New%sListResource", object.ResourceName()),
+			})
+		}
+	}
+	slices.SortFunc(out, func(a, b GeneratedListResourceRegistration) int {
+		if c := strings.Compare(a.Package, b.Package); c != 0 {
+			return c
+		}
+		return strings.Compare(a.NewFunc, b.NewFunc)
+	})
+	return out
+}
+
+func (t Terraform) GetListResourceImportPackages(products []*api.Product) []string {
+	reg := t.GetGeneratedListResourcesInVersion(products)
+	seen := make(map[string]struct{}, len(reg))
+	var pkgs []string
+	for _, r := range reg {
+		if _, ok := seen[r.Package]; ok {
+			continue
+		}
+		seen[r.Package] = struct{}{}
+		pkgs = append(pkgs, r.Package)
+	}
+	slices.Sort(pkgs)
+	return pkgs
+}

mmv1/templates/terraform/list_resource.go.tmpl

@@ -0,0 +1,127 @@
+{{/* The license inside this block applies to this file
+  Copyright 2024 Google LLC. All Rights Reserved.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License. */ -}}
+// Copyright IBM Corp. 2014, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+{{$.CodeHeader TemplatePath}}
+
+package {{ lower $.ProductMetadata.Name }}
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+{{- if and $.HasProject $.LegacyLongFormProject }}
+	"strings"
+{{- end }}
+
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/list"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+
+	"{{ $.ImportPath }}/tpgresource"
+	transport_tpg "{{ $.ImportPath }}/transport"
+)
+
+var _ list.ListResource = &{{ $.ResourceName -}}ListResource{}
+
+type {{ $.ResourceName -}}ListResource struct {
+	tpgresource.ListResourceMetadata
+}
+
+func New{{ $.ResourceName -}}ListResource() list.ListResource {
+	listR := &{{ $.ResourceName -}}ListResource{}
+	listR.TypeName = "{{ $.TerraformName }}"
+	listR.SDKv2Resource = Resource{{ $.ResourceName -}}()
+	listR.ListConfigFields = []tpgresource.ListConfigField{
+{{- range $scope := $.ListScopeProperties }}
+		{Name: "{{ underscore $scope.Name }}", Kind: tpgresource.ListConfigKindString, Optional: {{ if $scope.Required }}false{{ else }}true{{ end }}},
+{{- end }}
+	}
+	return listR
+}
+
+// {{ $.ResourceName }}ListModel matches ListResourceMetadata.ListConfigFields (tfsdk names and types).
+type {{ $.ResourceName -}}ListModel struct {
+{{- range $scope := $.ListScopeProperties }}
+	{{ $scope.TitlelizeProperty }} types.String `tfsdk:"{{ underscore $scope.Name }}"`
+{{- end }}
+}
+
+func (listR *{{ $.ResourceName -}}ListResource) List(ctx context.Context, listReq list.ListRequest, stream *list.ListResultsStream) {
+	var data {{ $.ResourceName -}}ListModel
+	diags := listReq.Config.Get(ctx, &data)
+	if diags.HasError() {
+		stream.Results = list.ListResultsStreamDiagnostics(diags)
+		return
+	}
+	if listR.Client == nil {
+		diags = append(diags, diag.NewErrorDiagnostic(
+			"Provider not configured",
+			"The Google provider client is not available; ensure the provider is configured (e.g. credentials and default project).",
+		))
+		stream.Results = list.ListResultsStreamDiagnostics(diags)
+		return
+	}
+
+{{- range $scope := $.ListScopeProperties }}
+{{- if eq $scope.Name "project" }}
+	{{ $scope.CamelizeProperty }} := listR.GetProject(data.{{ $scope.TitlelizeProperty }})
+{{- else if eq $scope.Name "region" }}
+	{{ $scope.CamelizeProperty }} := listR.GetRegion(data.{{ $scope.TitlelizeProperty }})
+{{- else if eq $scope.Name "zone" }}
+	{{ $scope.CamelizeProperty }} := listR.GetZone(data.{{ $scope.TitlelizeProperty }})
+{{- else if eq $scope.Name "location" }}
+	{{ $scope.CamelizeProperty }} := listR.GetLocation(data.{{ $scope.TitlelizeProperty }})
+{{- else }}
+	var {{ $scope.CamelizeProperty }} string
+	if !data.{{ $scope.TitlelizeProperty }}.IsNull() && !data.{{ $scope.TitlelizeProperty }}.IsUnknown() {
+		{{ $scope.CamelizeProperty }} = data.{{ $scope.TitlelizeProperty }}.ValueString()
+	}
+{{- end }}
+{{- end }}
+
+	stream.Results = func(push func(list.ListResult) bool) {
+		err := List{{ $.ResourceName }}s(
+			listR.Client,
+{{- range $scope := $.ListScopeProperties }}
+			{{ $scope.CamelizeProperty }},
+{{- end }}
+			func(rd *schema.ResourceData) error {
+				result := listReq.NewListResult(ctx)
+
+				if err := listR.SetResult(ctx, listReq.IncludeResource, &result, rd{{- range $k := $.ListResultDisplayNameKeyStrings }}, "{{ $k }}"{{- end }}); err != nil {
+					return err
+				}
+
+				if !push(result) {
+					return errors.New("stream closed")
+				}
+				return nil
+			},
+		)
+		if err != nil {
+			diags.AddError("API Error", err.Error())
+			result := listReq.NewListResult(ctx)
+			result.Diagnostics = diags
+			push(result)
+		}
+	}
+}
+
+{{ template "listResourceMethod" $ }}