Add an environment variable to enable CI-only tests (that are skipped locally)

[rileykarson]

What kind of contribution is this issue about?

Other (specify in details)

Details

Tests like

terraform-provider-google/google/services/pubsub/resource_pubsub_topic_generated_test.go

Line 188 in 2152e73

# Outside of automated terraform-provider-google CI tests, these values must be of actual AWS resources for the test to pass.

can only pass in CI, and will always fail locally, preventing developers from using resource wildcards (i.e. TestAccComputeInstance_) to run tests, forcing them to run them one-by-one.

Similar to tests dependent on environment variables like GOOGLE_ORG having a value, we should check for a variable like GOOGLE_CI_ENVIRONMENT=true, skipping the test if not enabled. That'll mean that contributors can run resource suites locally successfully, and if they need to run these advanced tests they can break glass by providing the specific env var.

References

No response

[wyardley]

https://github.com/GoogleCloudPlatform/magic-modules/blob/e1694376f735ab3c6c587baff0551b51a28a0904/mmv1/third_party/terraform/services/container/resource_container_cluster_test.go.erb#L10018-L10023

☝️ here's one good extreme example (GoogleCloudPlatform/magic-modules#11475)

[rileykarson]

As discussed in @wyardley's comment- we could consider adding a gate on some particularly high cost (possibly just within an otherwise lower cost product) as well, whether it's one or multiple vars.