Merge branch 'main' into tpg-22214-set-computed-name-a-d

Author: melinath

.ci/magician/cmd/generate_downstream.go

@@ -1,3 +1,18 @@
+/*
+* Copyright 2025 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.
+ */
 package cmd
 
 import (
@@ -15,7 +30,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var changelogExp = regexp.MustCompile("(?s)```release-note.*?```")
+var changelogExp = regexp.MustCompile("(?s)```release-note:(?P<noteType>[a-zA-Z]+).*```")
 
 var gdEnvironmentVariables = [...]string{
 	"BASE_BRANCH",
@@ -354,8 +369,11 @@ func addChangelogEntry(downstreamRepo *source.Repo, pullRequest *github.PullRequ
 		return err
 	}
 	rnr.Mkdir(".changelog")
-	if err := rnr.WriteFile(filepath.Join(".changelog", fmt.Sprintf("%d.txt", pullRequest.Number)), strings.Join(changelogExp.FindAllString(pullRequest.Body, -1), "\n")); err != nil {
-		return err
+	matches := changelogExp.FindStringSubmatch(pullRequest.Body)
+	if matches != nil && matches[1] != "none" {
+		if err := rnr.WriteFile(filepath.Join(".changelog", fmt.Sprintf("%d.txt", pullRequest.Number)), strings.Join(changelogExp.FindAllString(pullRequest.Body, -1), "\n")); err != nil {
+			return err
+		}
 	}
 	return rnr.PopDir()
 }

.ci/magician/github/membership_data.go

@@ -64,13 +64,18 @@ var (
 		"BBBmau": {
 			vacations: []Vacation{
 				{
-					startDate: newDate(2025, 3, 1),
-					endDate:   newDate(2025, 3, 10),
+					startDate: newDate(2025, 4, 7),
+					endDate:   newDate(2025, 4, 11),
 				},
 			},
 		},
 		"c2thorn": {
-			vacations: []Vacation{},
+			vacations: []Vacation{
+				{
+					startDate: newDate(2025, 4, 9),
+					endDate:   newDate(2025, 4, 15),
+				},
+			},
 		},
 		"hao-nan-li": {
 			vacations: []Vacation{},

docs/content/develop/add-fields.md

@@ -167,6 +167,12 @@ Replace `String` in the field type with one of the following options:
     key_name: 'KEY_NAME'
     key_description: |
       MULTILINE_KEY_FIELD_DESCRIPTION
+  # Map of primitive values
+    value_type:
+      name: mapIntegerName
+      type: Integer
+
+  # Map of complex values
     value_type:
       name: mapObjectName
       type: NestedObject
@@ -177,7 +183,7 @@ Replace `String` in the field type with one of the following options:
           MULTI_LINE_FIELD_DESCRIPTION
 ```
 
-This type is only used for string -> complex type mappings, use "KeyValuePairs" for simple mappings. Complex maps can't be represented natively in Terraform, and this type is transformed into an associative array (TypeSet) with the key merged into the object alongside other top-level fields.
+This type is used for general-case string -> non-string type mappings, use "KeyValuePairs" for string -> string mappings. Complex maps can't be represented natively in Terraform, and this type is transformed into an associative array (TypeSet) with the key merged into the object alongside other top-level fields.
 
 For `key_name` and `key_description`, provide a domain-appropriate name and description. For example, a map that references a specific type of resource would generally use the singular resource kind as the key name (such as "topic" for PubSub Topic) and a descriptor of the expected format depending on the context (such as resourceId vs full resource name).
 

docs/content/reference/resource.md

@@ -325,6 +325,140 @@ Example:
 mutex: 'alloydb/instance/{{name}}'
 ```
 
+## Sweeper
+
+Sweepers are a testing infrastructure mechanism that automatically clean up resources created during tests. They run before tests start and can be run manually to clean up dangling resources. Sweepers help prevent test failures due to resource quota limits and reduce cloud infrastructure costs by removing test resources that were not properly cleaned up.
+
+Sweeper generation is enabled by default, except in the following conditions which require customization here:
+
+- Resources with custom deletion code
+- Resources with parent-child relationships (unless the parent relationship is configured)
+- Resources with complex URL parameters that aren't simple region/project parameters
+
+Define the sweeper block in a resource to override these exclusions and enable sweeper generation for that resource.
+
+### `exclude_sweeper`
+
+If set to `true`, no sweeper will be generated for this resource. This is useful for resources that cannot or should not be automatically cleaned up.
+
+Default: `false`
+
+Example:
+
+```yaml
+exclude_sweeper: true
+```
+
+### `sweeper`
+
+Configures how test resources are swept (cleaned up) after tests. The sweeper system helps ensure resources created during tests are properly removed, even when tests fail unexpectedly. All fields within the `sweeper` block are optional, with reasonable defaults provided when not specified. See [sweeper.go ↗](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/api/resource/sweeper.go) for the implementation.
+
+- `identifier_field`: Specifies which field in the API resource object should be used to identify resources for deletion. If not specified, defaults to "name" if present in the resource, otherwise falls back to "id".
+
+- `prefixes`: Specifies name prefixes that identify resources eligible for sweeping. Resources whose names start with any of these prefixes will be deleted. By default, resources with the `tf-test-` prefix are automatically eligible for sweeping even if no prefixes are specified.
+
+- `url_substitutions`: Allows customizing URL parameters when listing resources. Each map entry represents a set of key-value pairs to substitute in the URL template. This is commonly used to specify regions to sweep in. If not specified, the sweeper will only run in the default region (us-central1) and zone (us-central1-a).
+
+- `dependencies`: Lists other resource types that must be swept before this one. This ensures proper cleanup order for resources with dependencies. If not specified, no dependencies are assumed.
+
+- `parent`: Configures sweeping for resources that depend on parent resources (like a nodepool that belongs to a cluster).
+
+  Required fields:
+  - `resource_type`: The type of the parent resource (for example, "google_container_cluster")
+  - `child_field`: The field in your resource that references the parent (for example, "cluster")
+  - At least one of `parent_field` or `template` is required
+
+  Options for getting parent reference:
+  - `parent_field`: The field from parent to use (typically "name" or "id")
+  - `template`: A template string like "projects/{{project}}/locations/{{location}}/clusters/{{value}}" 
+  
+  Options for processing the parent field value:
+  - `parent_field_extract_name`: When set to true, extracts just the resource name from a self_link URL by taking the portion after the last slash. This is useful when the parent field contains a fully-qualified resource URL (like "https://www.googleapis.com/compute/v1/projects/my-project/global/networks/my-network" or "projects/my-project/zones/us-central1-a/instances/my-instance") but you only need the final resource name component ("my-network" or "my-instance").
+  
+  - `parent_field_regex`: A regex pattern with a capture group to extract a specific portion of the parent field value. This is useful when you need more control over extracting parts of complex resource identifiers. The pattern must contain at least one capture group (in parentheses), and the first capture group's match will be used as the extracted value.
+
+- `query_string`: Allows appending additional query parameters to the resource's delete URL when performing delete operations. Format should include the starting character, for example, "?force=true" or "&verbose=true". If not specified, no additional query parameters are added.
+
+- `ensure_value`: Specifies a field that must be set to a specific value before deletion. Used for resources that have fields like 'deletionProtectionEnabled' that must be explicitly disabled before the resource can be deleted. All fields within the `ensure_value` block are required except `include_full_resource`:
+  
+  - `field`: The API field name that needs to be updated before deletion. Can include dot notation for nested fields (for example, "settings.deletionProtectionEnabled").
+  
+  - `value`: The required value that `field` must be set to before deletion. For boolean fields use "true" or "false", for integers use string representation, for string fields use the exact string value required.
+  
+  - `include_full_resource`: Determines whether to send the entire resource object with the updated field (true) or to send just the field that needs updating (false). Some APIs require the full resource to be sent in update operations. Default: `false`.
+
+Examples:
+
+Basic sweeper configuration:
+
+```yaml
+sweeper:
+  prefixes:
+    - "tf-test-"
+    - "tmp-"
+```
+
+Sweeper with parent-child relationship (basic):
+
+```yaml
+sweeper:
+  dependencies: # sweep google_compute_instance before attempting to sweep this resource
+    - "google_compute_instance"
+  parent:
+    resource_type: "google_container_cluster"
+    parent_field: "name"
+    child_field: "cluster"
+```
+
+Sweeper with parent_field_extract_name:
+
+```yaml
+sweeper:
+  parent:
+    resource_type: "google_compute_network"
+    parent_field: "selfLink"  # Contains: "projects/my-project/global/networks/my-network"
+    parent_field_extract_name: true  # Extracts just "my-network"
+    child_field: "network"
+```
+
+Sweeper with parent template and pre-deletion field update:
+
+```yaml
+sweeper:
+  parent:
+    resource_type: "google_container_cluster"
+    template: "projects/{{project}}/locations/{{location}}/clusters/{{value}}"
+    parent_field: "displayName"  # Provides the value for {{value}}
+    child_field: "cluster"
+  ensure_value:
+    field: "deletionProtection"
+    value: "false"
+    include_full_resource: false
+
+```
+
+Sweeper with URL substitutions for multiple regions:
+
+```yaml
+sweeper:
+  url_substitutions:
+    - collection_id: default_collection
+      region: global
+    - collection_id: default_collection
+      region: eu
+```
+
+Sweeper with URL substitutions specifying only regions:
+
+```yaml
+sweeper:
+  identifier_field: "displayName"
+  url_substitutions:
+    - region: "us-central1"
+    - region: "us-east1"
+    - region: "europe-west1"
+```
+
 ## Fields
 
 ### `virtual_fields`

mmv1/api/resource.go

@@ -1217,6 +1217,24 @@ func (r Resource) InIdFormat(prop Type) bool {
 	return slices.Contains(fields, google.Underscore(prop.Name))
 }
 
+// Returns true if at least one of the fields in the ID format is computed
+func (r Resource) HasComputedIdFormatFields() bool {
+	idFormatFields := map[string]struct{}{}
+	for _, f := range r.ExtractIdentifiers(r.GetIdFormat()) {
+		idFormatFields[f] = struct{}{}
+	}
+	for _, p := range r.GettableProperties() {
+		// Skip fields not in the id format
+		if _, ok := idFormatFields[google.Underscore(p.Name)]; !ok {
+			continue
+		}
+		if (p.Output || p.DefaultFromApi) && !p.IgnoreRead {
+			return true
+		}
+	}
+	return false
+}
+
 // ====================
 // Template Methods
 // ====================