feat(gcp): add a test_connection method
#4616
Conversation
github-actions
bot
added
the
provider/gcp
MrCloudSec
changed the title
test_connection method
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4616 +/- ##
==========================================
- Coverage 89.12% 89.02% -0.11%
==========================================
Files 913 913
Lines 27866 27890 +24
==========================================
- Hits 24836 24828 -8
- Misses 3030 3062 +32 ☔ View full report in Codecov by Sentry. |
| os.environ["GOOGLE_APPLICATION_CREDENTIALS"] = client_secrets_path | ||
| @staticmethod | ||
| def test_connection( | ||
| credentials_file: str, service_account: str, raise_on_exception: bool = True |
There was a problem hiding this comment.
Is it mandatory to set the credentials_file or service_account? If not please set some default values.
| credentials_file: str, service_account: str, raise_on_exception: bool = True | ||
| ) -> Connection: | ||
| """ | ||
| Test the connection with the provided credentials file or service account to impersonate |
There was a problem hiding this comment.
Improve the docstring with the possible exceptions raised, what the method do and more about the args and returns please.
| logger.critical( | ||
| "Cloud Resource Manager API has not been used before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/cloudresourcemanager.googleapis.com/ then retry." | ||
| ) | ||
| raise Exception( |
There was a problem hiding this comment.
Remember to add if raise_on_exception.
There was a problem hiding this comment.
Please add tests for the test_connection method.
Context
We need to be able to test the connection to each provider using one of the available authentication methods, starting from the environment variables.
Description
Add a
test_connectionmethod for the GCP provider.Create a
test_connectionabstract method in the Provider class but not enforced for now not to break anything.Checklist
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.