Skip to content
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

Fix empty string credentials validation issue, increase test coverage of credential validation #7690

Merged

Conversation

SarahFrench
Copy link
Collaborator

@SarahFrench SarahFrench commented Apr 11, 2023

Fixes hashicorp/terraform-provider-google#14255

This PR:

  • Improves testing for credential validation in the SDK provider config code
  • Makes the tests for the plugin framework provider's config code match the new SDK tests
  • Changes the new credential validator to allow empty strings as values of credentials in the provider config

Here are details of old tests that I replaced with test cases in a table-driven test

Removed test Equivalent test case in new test
TestProvider_loadCredentialsFromFile (SDK version) TestProvider_validateCredentials's "configuring credentials as a path to a credentials JSON file is valid"
TestProvider_loadCredentialsFromJSON (SDK version) TestProvider_validateCredentials's "configuring credentials as a credentials JSON string is valid"
TestFrameworkProvider_loadCredentialsFromFile TestFrameworkProvider_CredentialsValidator's "configuring credentials as a path to a credentials JSON file is valid"
TestFrameworkProvider_loadCredentialsFromJSON TestFrameworkProvider_CredentialsValidator's "configuring credentials as a credentials JSON string is valid"

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

provider: fixed bug where `credentials` field could not be set as an empty string

@SarahFrench
Copy link
Collaborator Author

I'm not sure about how to word the change in the release note in my PR description - I'd appreciate any edits people see fit!

@SarahFrench SarahFrench marked this pull request as ready for review April 11, 2023 12:10
@SarahFrench SarahFrench requested a review from a team as a code owner April 11, 2023 12:10
@SarahFrench SarahFrench requested review from melinath and megan07 and removed request for a team April 11, 2023 12:11
@SarahFrench SarahFrench requested review from trodge and removed request for megan07 April 11, 2023 12:17
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 128 insertions(+), 60 deletions(-))
Terraform Beta: Diff ( 3 files changed, 128 insertions(+), 60 deletions(-))
TF Conversion: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2564
Passed tests 2286
Skipped tests: 275
Affected tests: 3

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example|TestAccDataSourceGoogleFirebaseAndroidAppConfig

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example[Debug log]

Tests failed during RECORDING mode:
TestAccDataSourceGoogleFirebaseAndroidAppConfig[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

@melinath melinath removed their request for review April 11, 2023 15:42
@SarahFrench
Copy link
Collaborator Author

Saving any testing of Application Default Credentials for a separate PR to this one- merging now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants