-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add acceptance tests for request_timeout
#11848
Open
SarahFrench
wants to merge
8
commits into
GoogleCloudPlatform:main
Choose a base branch
from
SarahFrench:mux-refactor-12-add-request-timeout-acctests
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+314
−4
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0a18afe
Add acceptance tests for request_timeout in the SDK provider
SarahFrench 61046ab
Fix some comments
SarahFrench 10e02ea
Expose `request_timeout` data via `FrameworkProviderConfig` struct an…
SarahFrench 8cc3271
Add acceptance tests for request_timeout in the PF provider, highligh…
SarahFrench 64fca87
Add test cases covering default values used when there's no input
SarahFrench 86828c9
Add test case for impact of the timeout, but only for the SDK tests
SarahFrench 792f8c4
Merge branch 'main' into mux-refactor-12-add-request-timeout-acctests
SarahFrench 72acfb6
Make random_suffix consistent
SarahFrench File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
mmv1/third_party/terraform/fwprovider/framework_provider_request_timeout_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
package fwprovider_test | ||
|
||
import ( | ||
"regexp" | ||
"testing" | ||
|
||
"github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
"github.com/hashicorp/terraform-provider-google/google/acctest" | ||
) | ||
|
||
// TestAccFwProvider_request_timeout is a series of acc tests asserting how the PF provider handles request_timeout arguments | ||
// It is PF specific because the HCL used provisions PF-implemented resources | ||
// It is a counterpart to TestAccSdkProvider_request_timeout | ||
func TestAccFwProvider_request_timeout(t *testing.T) { | ||
testCases := map[string]func(t *testing.T){ | ||
// Configuring the provider using inputs | ||
"a default value of 120s is used when there are no user inputs": testAccFwProvider_request_timeout_providerDefault, | ||
"request_timeout can be set in config in different formats, are NOT normalized to full-length format": testAccFwProvider_request_timeout_setInConfig, | ||
//no ENVs to test | ||
|
||
// Schema-level validation | ||
"when request_timeout is set to an empty string in the config the value fails validation, as it is not a duration": testAccFwProvider_request_timeout_emptyStringValidation, | ||
|
||
// Usage | ||
// We cannot test the impact of this field in an acc test until more resources/data sources are implemented with the plugin-framework | ||
} | ||
|
||
for name, tc := range testCases { | ||
// shadow the tc variable into scope so that when | ||
// the loop continues, if t.Run hasn't executed tc(t) | ||
// yet, we don't have a race condition | ||
// see https://github.com/golang/go/wiki/CommonMistakes#using-goroutines-on-loop-iterator-variables | ||
tc := tc | ||
t.Run(name, func(t *testing.T) { | ||
tc(t) | ||
}) | ||
} | ||
} | ||
|
||
func testAccFwProvider_request_timeout_providerDefault(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
defaultValue := "120s" | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccFwProvider_request_timeout_unset(), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_plugin_framework.default", "request_timeout", defaultValue), | ||
), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccFwProvider_request_timeout_setInConfig(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
providerTimeout1 := "3m0s" | ||
providerTimeout2 := "3m" | ||
|
||
// In the SDK version of the test expectedValue = "3m0s" only | ||
expectedValue1 := "3m0s" | ||
expectedValue2 := "3m" | ||
|
||
context1 := map[string]interface{}{ | ||
"request_timeout": providerTimeout1, | ||
} | ||
context2 := map[string]interface{}{ | ||
"request_timeout": providerTimeout2, | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccFwProvider_request_timeout_inProviderBlock(context1), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_plugin_framework.default", "request_timeout", expectedValue1), | ||
), | ||
}, | ||
{ | ||
Config: testAccFwProvider_request_timeout_inProviderBlock(context2), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_plugin_framework.default", "request_timeout", expectedValue2), | ||
), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccFwProvider_request_timeout_emptyStringValidation(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
context := map[string]interface{}{ | ||
"request_timeout": "", // empty string used | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccFwProvider_request_timeout_inProviderBlock(context), | ||
ExpectError: regexp.MustCompile("invalid duration"), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
// testAccFwProvider_request_timeout_inProviderBlock allows setting the request_timeout argument in a provider block. | ||
// This function uses data.google_provider_config_plugin_framework because it is implemented with the PF | ||
func testAccFwProvider_request_timeout_inProviderBlock(context map[string]interface{}) string { | ||
return acctest.Nprintf(` | ||
provider "google" { | ||
request_timeout = "%{request_timeout}" | ||
} | ||
|
||
data "google_provider_config_plugin_framework" "default" {} | ||
`, context) | ||
} | ||
|
||
// testAccFwProvider_request_timeout_inEnvsOnly allows testing when the request_timeout argument is not set | ||
func testAccFwProvider_request_timeout_unset() string { | ||
return ` | ||
data "google_provider_config_plugin_framework" "default" {} | ||
` | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
177 changes: 177 additions & 0 deletions
177
mmv1/third_party/terraform/provider/provider_request_timeout_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
package provider_test | ||
|
||
import ( | ||
"regexp" | ||
"testing" | ||
|
||
"github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
"github.com/hashicorp/terraform-provider-google/google/acctest" | ||
) | ||
|
||
// TestAccSdkProvider_request_timeout is a series of acc tests asserting how the SDK provider handles request_timeout arguments | ||
// It is SDK specific because the HCL used provisions SDK-implemented resources | ||
// It is a counterpart to TestAccFwProvider_request_timeout | ||
func TestAccSdkProvider_request_timeout(t *testing.T) { | ||
testCases := map[string]func(t *testing.T){ | ||
// Configuring the provider using inputs | ||
"a default value of 0s is used when there are no user inputs (it is overridden downstream)": testAccSdkProvider_request_timeout_providerDefault, | ||
"request_timeout can be set in config in different formats, are normalized to full-length format": testAccSdkProvider_request_timeout_setInConfig, | ||
//no ENVs to test | ||
|
||
// Schema-level validation | ||
"when request_timeout is set to an empty string in the config the value fails validation, as it is not a duration": testAccSdkProvider_request_timeout_emptyStringValidation, | ||
|
||
// Usage | ||
"short timeouts impact provisioning resources": testAccSdkProvider_request_timeout_usage, | ||
} | ||
|
||
for name, tc := range testCases { | ||
// shadow the tc variable into scope so that when | ||
// the loop continues, if t.Run hasn't executed tc(t) | ||
// yet, we don't have a race condition | ||
// see https://github.com/golang/go/wiki/CommonMistakes#using-goroutines-on-loop-iterator-variables | ||
tc := tc | ||
t.Run(name, func(t *testing.T) { | ||
tc(t) | ||
}) | ||
} | ||
} | ||
|
||
func testAccSdkProvider_request_timeout_providerDefault(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccSdkProvider_request_timeout_unset(), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_sdk.default", "request_timeout", "0s"), | ||
), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccSdkProvider_request_timeout_setInConfig(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
providerTimeout1 := "3m0s" | ||
providerTimeout2 := "3m" | ||
expectedValue := "3m0s" | ||
|
||
context1 := map[string]interface{}{ | ||
"request_timeout": providerTimeout1, | ||
} | ||
context2 := map[string]interface{}{ | ||
"request_timeout": providerTimeout2, | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccSdkProvider_request_timeout_inProviderBlock(context1), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_sdk.default", "request_timeout", expectedValue), | ||
), | ||
}, | ||
{ | ||
Config: testAccSdkProvider_request_timeout_inProviderBlock(context2), | ||
Check: resource.ComposeTestCheckFunc( | ||
resource.TestCheckResourceAttr("data.google_provider_config_sdk.default", "request_timeout", expectedValue), | ||
), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccSdkProvider_request_timeout_emptyStringValidation(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
context := map[string]interface{}{ | ||
"request_timeout": "", // empty string used | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccSdkProvider_request_timeout_inProviderBlock(context), | ||
ExpectError: regexp.MustCompile("invalid duration"), | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccSdkProvider_request_timeout_usage(t *testing.T) { | ||
acctest.SkipIfVcr(t) // Test doesn't interact with API | ||
|
||
shortTimeout := "10ms" // short time that will result in an error | ||
longTimeout := "120s" | ||
|
||
randomString := acctest.RandString(t, 10) | ||
context1 := map[string]interface{}{ | ||
"request_timeout": shortTimeout, | ||
"random_suffix": randomString, | ||
} | ||
context2 := map[string]interface{}{ | ||
"request_timeout": longTimeout, | ||
"random_suffix": randomString, | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
// No PreCheck for checking ENVs | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccSdkProvider_request_timeout_provisionWithTimeout(context1), | ||
// Effect of request_timeout value | ||
ExpectError: regexp.MustCompile("context deadline exceeded"), | ||
}, | ||
{ | ||
Config: testAccSdkProvider_request_timeout_provisionWithTimeout(context2), | ||
// No error; everything is fine with an appropriate timeout value | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
// testAccSdkProvider_request_timeout_inProviderBlock allows setting the request_timeout argument in a provider block. | ||
// This function uses data.google_provider_config_sdk because it is implemented with the SDKv2 | ||
func testAccSdkProvider_request_timeout_inProviderBlock(context map[string]interface{}) string { | ||
return acctest.Nprintf(` | ||
provider "google" { | ||
request_timeout = "%{request_timeout}" | ||
} | ||
|
||
data "google_provider_config_sdk" "default" {} | ||
`, context) | ||
} | ||
|
||
// testAccSdkProvider_request_timeout_provisionWithTimeout allows testing the effects of request_timeout on | ||
// provisioning a resource. | ||
func testAccSdkProvider_request_timeout_provisionWithTimeout(context map[string]interface{}) string { | ||
return acctest.Nprintf(` | ||
provider "google" { | ||
request_timeout = "%{request_timeout}" | ||
} | ||
|
||
data "google_provider_config_sdk" "default" {} | ||
|
||
resource "google_service_account" "default" { | ||
account_id = "tf-test-%{random_suffix}" | ||
display_name = "AccTest Service Account" | ||
} | ||
`, context) | ||
} | ||
|
||
// testAccSdkProvider_request_timeout_inEnvsOnly allows testing when the request_timeout argument is not set | ||
func testAccSdkProvider_request_timeout_unset() string { | ||
return ` | ||
data "google_provider_config_sdk" "default" {} | ||
` | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I forgot to put this comment in, explaining the different defaults for this field in the SDK vs PF code. I'll save adding it until after review, as it's something worth making explicit to the reviewer.