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 #14279

Conversation

modular-magician
Copy link
Collaborator

Fixes #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

Derived from GoogleCloudPlatform/magic-modules#7690

… of credential validation (hashicorp#7690)

Signed-off-by: Modular Magician <magic-modules@google.com>
@modular-magician modular-magician merged commit 6330964 into hashicorp:main Apr 11, 2023
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
1 participant