Add comment to GoogleProviderConfig test util function (#10541) (#7300)

modular-magician · web-flow · commit fcbbe949b01d · 2024-04-26T12:13:19.000-07:00
[upstream:705f3f2a38cf4c367ff063863f466f20822ae81c]

Signed-off-by: Modular Magician &lt;magic-modules@google.com&gt;
diff --git a/google-beta/acctest/provider_test_utils.go b/google-beta/acctest/provider_test_utils.go
@@ -33,6 +33,9 @@ func init() {
 	}
 }
 
+// GoogleProviderConfig returns a configured SDKv2 provider.
+// This function is typically used in CheckDestroy functions in acceptance tests. The provider client is used to make GET requests to check a resource is destroyed.
+// Either a preexisting configured SDKv2 provider for the given test name is returned, or a new one is configured with empty (but non-nil) terraform.ResourceConfig
 func GoogleProviderConfig(t *testing.T) *transport_tpg.Config {
 	configsLock.RLock()
 	config, ok := configs[t.Name()]

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ func init() {`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
	`36`	`+// GoogleProviderConfig returns a configured SDKv2 provider.`
	`37`	`+// This function is typically used in CheckDestroy functions in acceptance tests. The provider client is used to make GET requests to check a resource is destroyed.`
	`38`	`+// Either a preexisting configured SDKv2 provider for the given test name is returned, or a new one is configured with empty (but non-nil) terraform.ResourceConfig`
`36`	`39`	`func GoogleProviderConfig(t testing.T) transport_tpg.Config {`
`37`	`40`	`configsLock.RLock()`
`38`	`41`	`config, ok := configs[t.Name()]`