Add resource tests #

1. Using an editor of your choice, create a *.tf.erb file in mmv1/templates/terraform/examples/. The name of the file should include the service name, resource name, and a descriptor. For example, compute_subnetwork_basic.tf.erb.
2. Write the Terraform configuration for your test. This should include all of the required dependencies. For example, google_compute_subnetwork has a dependency on google_compute_network:

   resource "google_compute_subnetwork" "primary" {
     name          = "my-subnet"
     ip_cidr_range = "10.1.0.0/16"
     region        = "us-central1"
     network       = google_compute_network.network.name
   }
   
   resource "google_compute_network" "network" {
     name                    = "my-network"
     auto_create_subnetworks = false
   }
   

3. If beta-only fields are being tested:
   • Add provider = google-beta to every resource in the file.
4. Modify the configuration to use templated values.
   • Replace the id of the primary resource you are testing with <%= ctx[:primary_resource_id] %>.
   • Replace fields that are identifiers, like id or name, with an appropriately named variable. For example, <%= ctx[:vars]['subnetwork_name'] %>.
   • The resulting configuration for the above example would look like this:

   resource "google_compute_subnetwork" "<%= ctx[:primary_resource_id] %>" {
     name          = "<%= ctx[:vars]['subnetwork_name'] %>"
     ip_cidr_range = "10.1.0.0/16"
     region        = "us-central1"
     network       = google_compute_network.network.name
   }
   
   resource "google_compute_network" "network" {
     name                    = "<%= ctx[:vars]['network_name'] %>"
     auto_create_subnetworks = false
   }
   

5. Modify the relevant RESOURCE_NAME.yaml file under magic-modules/mmv1/products to include an examples block with your test. The name must match the name of your *.tf.erb file. For example:

   examples:
     - !ruby/object:Provider::Terraform::Examples
       name: "compute_subnetwork_basic"
       primary_resource_id: "example"
       vars:
         subnetwork_name: "example-subnet"
         network_name: "example-network"
   

Warning: Values in vars must include a - (or _). They trigger the addition of a tf-test prefix, which the sweeper uses to clean them up after tests run.

6. If beta-only fields are being tested:
   • Add min_version: beta to the examples block in RESOURCE_NAME.yaml.

This section assumes you’ve used the Add a resource guide to create your handwritten resource, and you have a working MMv1 config.

Note: If not, you can create one now, or skip this guide and construct the test by hand. Writing tests by hand can sometimes be a better option if there is a similar test you can copy from.

1. Add the test in MMv1. Repeat for all the create tests you will need.
2. Generate the beta provider.
3. From the beta provider, copy and paste the generated *_generated_test.go file into the appropriate service folder inside magic-modules/mmv1/third_party/terraform/services as a new file call *_test.go.
4. Modify the tests as needed.
   • Replace all occurrences of github.com/hashicorp/terraform-provider-google-beta/google-beta with github.com/hashicorp/terraform-provider-google/google
   • Remove the comments at the top of the file.
   • Remove the Example suffix from all function names.
   • If beta-only fields are being tested, do the following:
     • Change the file suffix to .go.erb
     • Add <% autogen_exception -%> to the top of the file
     • Wrap each beta-only test in a separate version guard: <% unless version == 'ga' -%>...<% else -%>...<% end -%>

1. Generate the beta provider.
2. From the beta provider, copy and paste the generated *_generated_test.go file into the appropriate service folder inside magic-modules/mmv1/third_party/terraform/services as a new file call *_test.go.
3. Using an editor of your choice, delete the *DestroyProducer function, and all but one test. The remaining test should be the “full” test, or if there is no “full” test, the “basic” test. This will be the starting point for your new update test.
4. Modify the TestAcc* test function to support updates.
   • Change the suffix of the test function to _update.
   • Copy the 2 TestStep blocks and paste them immediately after, so that there are 4 total test steps.
   • Change the suffix of the first Config value to _full (or _basic).
   • Change the suffix of the second Config value to _update.
   • The resulting test function would look similar to this:

   func TestAccPubsubTopic_update(t *testing.T) {
      ...
      acctest.VcrTest(t, resource.TestCase{
         ...
         Steps: []resource.TestStep{
            {
               Config: testAccPubsubTopic_full(...),
            },
            {
               ...
            },
            {
               Config: testAccPubsubTopic_update(...),
            },
            {
               ...
            },
         },
      })
   }
   

5. Modify the testAcc* Terraform template function to support updates.
   • Copy the template function and paste it immediately after so that there are 2 template functions.
   • Change the suffix of the first template function to _full (or _basic).
   • Change the suffix of the second template function to _update.
   • The resulting template functions would look similar to this:

   func testAccPubsubTopic_full(...) string {
       ...
   }
   
   func testAccPubsubTopic_update(...) string {
       ...
   }
   

6. Modify the test as needed.
   • Replace all occurrences of github.com/hashicorp/terraform-provider-google-beta/google-beta with github.com/hashicorp/terraform-provider-google/google
   • Modify the template function ending in _update so that updatable fields are changed or removed. This may require additions to the context map in the test function.
   • Remove the comments at the top of the file.
   • If beta-only fields are being tested, do the following:
     • Change the file suffix to .go.erb
     • Add <% autogen_exception -%> to the top of the file
     • Wrap each beta-only test in a separate version guard: <% unless version == 'ga' -%>...<% else -%>...<% end -%>
     • In each beta-only test, ensure that the TestCase sets ProtoV5ProviderFactories: acctest.ProtoV5ProviderBetaFactories(t)
     • In each beta-only test, ensure that all Terraform resources in all configs have provider = google-beta set

1. Using an editor of your choice, open the existing *_test.go or *_test.go.erb file in the appropriate service folder inside magic-modules/mmv1/third_party/terraform/services which contains your create tests.
2. Copy the TestAcc* test function for the existing “full” test. If there is no “full” test, use the “basic” test. This will be the starting point for your new update test.
3. Modify the test function to support updates.
   • Change the suffix of the test function to _update.
   • Copy the 2 TestStep blocks and paste them immediately after, so that there are 4 total test steps.
   • Change the suffix of the second Config value to _update.
   • The resulting test function would look similar to this:

   func TestAccPubsubTopic_update(t *testing.T) {
      ...
      acctest.VcrTest(t, resource.TestCase{
         ...
         Steps: []resource.TestStep{
            {
               Config: testAccPubsubTopic_full(...),
            },
            {
               ...
            },
            {
               Config: testAccPubsubTopic_update(...),
            },
            {
               ...
            },
         },
      })
   }
   

4. Add a Terraform template function to support updates.
   • Copy the full (or basic) testAcc* template function.
   • Change the suffix of the new template function to _update.
   • The new template function would look similar to this:

   func testAccPubsubTopic_update(...) string {
       ...
   }
   

5. Modify the test as needed.
   • Modify the new template function so that updatable fields are changed or removed. This may require additions to the context map in the test function.
   • Remove the comments at the top of the file.
   • If beta-only fields are being tested, do the following:
     • Change the file suffix to .go.erb
     • Add <% autogen_exception -%> to the top of the file
     • Wrap each beta-only test in a separate version guard: <% unless version == 'ga' -%>...<% else -%>...<% end -%>
     • In each beta-only test, ensure that the TestCase sets ProtoV5ProviderFactories: acctest.ProtoV5ProviderBetaFactories(t)
     • In each beta-only test, ensure that all Terraform resources in all configs have provider = google-beta set