Copy the comments to Go yaml files

mmv1/products/accesscontextmanager/go_GcpUserAccessBinding.yaml

@@ -59,6 +59,7 @@ examples:
       org_id: 'ORG_ID'
       org_domain: 'ORG_DOMAIN'
       cust_id: 'CUST_ID'
+    # Has a handwritten test due to AccessPolicy-related tests needing to run synchronously
     exclude_test: true
 parameters:
   # Parent is a path parameter that _cannot_ be read or sent in the request at all.

mmv1/products/activedirectory/go_Domain.yaml

@@ -71,6 +71,7 @@ examples:
       domain_name: 'tfgen'
     ignore_read_extra:
       - 'deletion_protection'
+    # skip the test until Active Directory setup issue got resolved
     exclude_test: true
 virtual_fields:
   - name: 'deletion_protection'

mmv1/products/activedirectory/go_DomainTrust.yaml

@@ -66,6 +66,9 @@ custom_code:
 examples:
   - name: 'active_directory_domain_trust_basic'
     primary_resource_id: 'ad-domain-trust'
+      # Fine-grained resource need different autogenerated tests, as
+      # we need to check destroy during a test step where the parent resource
+      # still exists and we need to validate that child resource has been deleted
     exclude_test: true
 parameters:
   - name: 'domain'

mmv1/products/activedirectory/go_Peering.yaml

@@ -58,6 +58,7 @@ examples:
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
+      # skip the test until Active Directory setup issue got resolved
     exclude_test: true
     exclude_import_test: true
 parameters:

mmv1/products/alloydb/go_Backup.yaml

@@ -90,6 +90,7 @@ examples:
       - 'reconciling'
       - 'update_time'
     exclude_docs: true
+    # https://github.com/hashicorp/terraform-provider-google/issues/16231
     skip_vcr: true
 parameters:
   - name: 'backupId'

mmv1/products/apigee/go_EndpointAttachment.yaml

@@ -53,12 +53,15 @@ exclude_sweeper: true
 examples:
   - name: 'apigee_endpoint_attachment_basic'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_endpoint_attachment_basic_test'
     primary_resource_id: 'apigee_endpoint_attachment'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'orgId'

mmv1/products/apigee/go_Envgroup.yaml

@@ -54,12 +54,15 @@ examples:
     vars:
       envgroup_name: 'my-envgroup'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_environment_group_basic_test'
     primary_resource_id: 'apigee_environment_group'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'orgId'

mmv1/products/apigee/go_EnvgroupAttachment.yaml

@@ -65,6 +65,7 @@ examples:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'envgroupId'

mmv1/products/apigee/go_Environment.yaml

@@ -64,13 +64,16 @@ examples:
     vars:
       environment_name: 'my-environment'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_environment_basic_test'
     primary_resource_id: 'apigee_environment'
     primary_resource_name: 'fmt.Sprintf("organizations/tf-test%s", context["random_suffix"]), fmt.Sprintf("tf-test%s", context["random_suffix"])'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_environment_basic_deployment_apiproxy_type_test'
     primary_resource_id: 'apigee_environment'
@@ -79,6 +82,7 @@ examples:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_environment_patch_update_test'
     primary_resource_id: 'apigee_environment'
@@ -88,6 +92,7 @@ examples:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'orgId'

mmv1/products/apigee/go_Instance.yaml

@@ -60,53 +60,66 @@ examples:
     vars:
       instance_name: 'my-instance-name'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_instance_basic_test'
     primary_resource_id: 'apigee_instance'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_instance_cidr_range'
     vars:
       instance_name: 'my-instance-name'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_instance_cidr_range_test'
     primary_resource_id: 'apigee_instance'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_instance_ip_range'
     vars:
       instance_name: 'my-instance-name'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_instance_ip_range_test'
     primary_resource_id: 'apigee_instance'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_instance_full'
     vars:
       instance_name: 'my-instance-name'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_instance_full_test'
     primary_resource_id: 'apigee_instance'
     min_version: 'beta'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
   - name: 'apigee_instance_service_attachment_basic_test'
     primary_resource_id: 'apigee_instance'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'orgId'

mmv1/products/apigee/go_InstanceAttachment.yaml

@@ -59,12 +59,15 @@ examples:
       instance_name: 'my-instance-name'
       environment_name: 'my-environment-name'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_instance_attachment_basic_test'
     primary_resource_id: 'apigee_instance_attachment'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'instanceId'

mmv1/products/apigee/go_NatAddress.yaml

@@ -56,12 +56,15 @@ examples:
     vars:
       nat_address_name: 'my-nat-address'
     exclude_test: true
+      # This is a more verbose version of the above that creates all
+      # the resources needed for the acceptance test.
   - name: 'apigee_nat_address_basic_test'
     primary_resource_id: 'apigee_nat_address'
     test_env_vars:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'instanceId'

mmv1/products/apigee/go_Organization.yaml

@@ -53,6 +53,8 @@ custom_code:
 examples:
   - name: 'apigee_organization_cloud_basic'
     exclude_test: true
+  # This is a more verbose version of the above that creates all
+  # the resources needed for the acceptance test.
   - name: 'apigee_organization_cloud_basic_test'
     primary_resource_id: 'org'
     test_env_vars:
@@ -61,9 +63,12 @@ examples:
     ignore_read_extra:
       - 'properties'
     exclude_docs: true
+    # Resource creation race
     skip_vcr: true
   - name: 'apigee_organization_cloud_basic_disable_vpc_peering'
     exclude_test: true
+  # This is a more verbose version of the above that creates all
+  # the resources needed for the acceptance test.
   - name: 'apigee_organization_cloud_basic_disable_vpc_peering_test'
     primary_resource_id: 'org'
     test_env_vars:
@@ -72,9 +77,14 @@ examples:
     ignore_read_extra:
       - 'properties'
     exclude_docs: true
+    # Resource creation race
     skip_vcr: true
   - name: 'apigee_organization_cloud_full'
     exclude_test: true
+  # This is a more verbose version of the above that creates all
+  # the resources needed for the acceptance test. While all Apigee
+  # resources in this test are in the GA API, we depend on a service
+  # identity resource which is only available in the beta provider.
   - name: 'apigee_organization_cloud_full_test'
     primary_resource_id: 'org'
     min_version: 'beta'
@@ -84,9 +94,14 @@ examples:
     ignore_read_extra:
       - 'properties'
     exclude_docs: true
+    # Resource creation race
     skip_vcr: true
   - name: 'apigee_organization_cloud_full_disable_vpc_peering'
     exclude_test: true
+  # This is a more verbose version of the above that creates all
+  # the resources needed for the acceptance test. While all Apigee
+  # resources in this test are in the GA API, we depend on a service
+  # identity resource which is only available in the beta provider.
   - name: 'apigee_organization_cloud_full_disable_vpc_peering_test'
     primary_resource_id: 'org'
     min_version: 'beta'
@@ -96,6 +111,7 @@ examples:
     ignore_read_extra:
       - 'properties'
     exclude_docs: true
+    # Resource creation race
     skip_vcr: true
   - name: 'apigee_organization_retention_test'
     primary_resource_id: 'org'
@@ -104,6 +120,7 @@ examples:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+    # Resource creation race
     skip_vcr: true
   - name: 'apigee_organization_drz_test'
     primary_resource_id: 'org'
@@ -112,6 +129,7 @@ examples:
       org_id: 'ORG_ID'
       billing_account: 'BILLING_ACCT'
     exclude_docs: true
+      # Resource creation race
     skip_vcr: true
 parameters:
   - name: 'projectId'

mmv1/products/appengine/go_FlexibleAppVersion.yaml

@@ -76,6 +76,7 @@ examples:
     ignore_read_extra:
       - 'noop_on_destroy'
       - 'deployment.0.zip'
+    # https://github.com/hashicorp/terraform-provider-google/issues/19040
     exclude_test: true
 virtual_fields:
   - name: 'noop_on_destroy'

mmv1/products/artifactregistry/go_VPCSCConfig.yaml

@@ -49,6 +49,7 @@ custom_code:
 examples:
   - name: 'artifact_registry_vpcsc_config'
     primary_resource_id: 'my-config'
+    # Requires VPC SC Policy configured on organization
     exclude_test: true
 parameters:
   - name: 'location'

mmv1/products/bigquery/go_DatasetAccess.yaml

@@ -73,26 +73,30 @@ examples:
     vars:
       dataset_id: 'example_dataset'
       account_name: 'bqowner'
+ # not importable
     exclude_test: true
   - name: 'bigquery_dataset_access_view'
     primary_resource_id: 'access'
     vars:
       dataset_id: 'example_dataset'
       dataset_id2: 'example_dataset2'
       table_id: 'example_table'
+ # not importable
     exclude_test: true
   - name: 'bigquery_dataset_access_authorized_dataset'
     primary_resource_id: 'access'
     vars:
       private: 'private'
       public: 'public'
+ # not importable
     exclude_test: true
   - name: 'bigquery_dataset_access_authorized_routine'
     primary_resource_id: 'authorized_routine'
     vars:
       private_dataset: 'private_dataset'
       public_dataset: 'public_dataset'
       public_routine: 'public_routine'
+ # not importable
     exclude_test: true
 parameters:
 properties:

mmv1/products/bigquery/go_Job.yaml

@@ -101,6 +101,7 @@ examples:
       - 'etag'
       - 'load.0.destination_table.0.table_id'
       - 'status.0.state'
+ # there are a lot of examples for this resource, so omitting some that are similar to others
     exclude_docs: true
   - name: 'bigquery_job_copy'
     primary_resource_id: 'job'
@@ -129,6 +130,7 @@ examples:
       - 'copy.0.source_tables.0.table_id'
       - 'copy.0.source_tables.1.table_id'
       - 'status.0.state'
+ # there are a lot of examples for this resource, so omitting some that are similar to others
     exclude_docs: true
   - name: 'bigquery_job_extract'
     primary_resource_id: 'job'
@@ -147,6 +149,7 @@ examples:
       - 'etag'
       - 'extract.0.source_table.0.table_id'
       - 'status.0.state'
+ # there are a lot of examples for this resource, so omitting some that are similar to others
     exclude_docs: true
 parameters:
 properties:

mmv1/products/clouddomains/go_Registration.yaml

@@ -59,7 +59,18 @@ custom_code:
 examples:
   - name: 'clouddomains_registration_full'
     primary_resource_id: 'my_registration'
+    # Must be tested in staging environment with all-time unique domains
     exclude_test: true
+    # ignore_read_extra:
+    #   - 'contact_settings.0.registrant_contact.0.phone_number'
+    #   - 'contact_settings.0.registrant_contact.0.fax_number'
+    #   - 'contact_settings.0.registrant_contact.0.postal_address'
+    #   - 'contact_settings.0.admin_contact.0.phone_number'
+    #   - 'contact_settings.0.admin_contact.0.fax_number'
+    #   - 'contact_settings.0.admin_contact.0.postal_address'
+    #   - 'contact_settings.0.technical_contact.0.phone_number'
+    #   - 'contact_settings.0.technical_contact.0.fax_number'
+    #   - 'contact_settings.0.technical_contact.0.postal_address'
 parameters:
   - name: 'location'
     type: String

mmv1/products/cloudfunctions2/go_Function.yaml

@@ -240,6 +240,7 @@ examples:
     ignore_read_extra:
       - 'build_config.0.source.0.storage_source.0.object'
       - 'build_config.0.source.0.storage_source.0.bucket'
+ # the example file is written in a repetitive way to help acc tests, so exclude
     exclude_docs: true
     skip_vcr: true
   - name: 'cloudfunctions2_cmek_docs'
@@ -254,6 +255,7 @@ examples:
       unencoded-ar-repo: 'ar-repo'
       kms_key_name: 'cmek-key'
       project: 'my-project-name'
+ # this example file will cause IAM conflicts between tests if used to make a test
     exclude_test: true
   - name: 'cloudfunctions2_abiu'
     primary_resource_id: 'function'