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

Create data sources for tag_keys and tag_values #6042

Merged
merged 9 commits into from
May 24, 2022

Conversation

nphilbrook
Copy link
Contributor

@nphilbrook nphilbrook commented May 17, 2022

This PR creates data sources for google_tags_tag_key and google_tags_tag_value resources, so that they can be looked up by parent and short_name and one can avoid opaque magic numbers in one's Terraform configuration using tags.

Part of hashicorp/terraform-provider-google#11367 - the end goal of that issue may not be addressed unless the GCP IAM Tags API changes; until then these resources will accomplish the same goal, albeit in a roundabout fashion.

I borrowed heavily from the google_active_folder data source when writing this code. Hopefully I didn't miss any copypasta.

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).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
    • Note there were several lint errors unrelated to my new code.
  • 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).
  • Ran relevant acceptance tests (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)

`google_tags_tag_key`
`google_tags_tag_value`

@google-cla
Copy link

google-cla bot commented May 17, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

For more information, open the CLA check for this pull request.

@modular-magician
Copy link
Collaborator

Hello! I am a robot who works on Magic Modules PRs.

I've detected that you're a community contributor. @shuyama1, a repository maintainer, has been assigned to assist you and help review your changes.

❓ First time contributing? Click here for more details

Your assigned reviewer will help review your code by:

  • Ensuring it's backwards compatible, covers common error cases, etc.
  • Summarizing the change into a user-facing changelog note.
  • Passes tests, either our "VCR" suite, a set of presubmit tests, or with manual test runs.

You can help make sure that review is quick by running local tests and ensuring they're passing in between each push you make to your PR's branch. Also, try to leave a comment with each push you make, as pushes generally don't generate emails.

If your reviewer doesn't get back to you within a week after your most recent change, please feel free to leave a comment on the issue asking them to take a look! In the absence of a dedicated review dashboard most maintainers manage their pending reviews through email, and those will sometimes get lost in their inbox.


@nphilbrook nphilbrook marked this pull request as ready for review May 17, 2022 18:44
@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 6 files changed, 409 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 7 files changed, 411 insertions(+), 4 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 10 files changed, 529 insertions(+), 10 deletions(-))
Terraform Beta: Diff ( 10 files changed, 529 insertions(+), 10 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2023
Passed tests 1791
Skipped tests: 226
Failed tests: 6

Action taken

Triggering VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccDataSourceGoogleTagsTagKey_default|TestAccDataSourceGoogleTagsTagKey_dot|TestAccDataSourceGoogleTagsTagValue_default|TestAccDataSourceGoogleTagsTagValue_dot|TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample|TestAccFirebaserulesRelease_BasicRelease

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccDataSourceGoogleTagsTagKey_default[view]
TestAccDataSourceGoogleTagsTagKey_dot[view]
TestAccDataSourceGoogleTagsTagValue_default[view]
TestAccDataSourceGoogleTagsTagValue_dot[view]
TestAccFirebaserulesRelease_BasicRelease[view]

Tests failed during RECORDING mode:
TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample[view]

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

@nphilbrook
Copy link
Contributor Author

Hi @shuyama1 , is there a procedure to get access to the GCS buckets where the VCR test results are stored? I would like to see that failing test which is likely unrelated to my PR, but I don't have access to the URL

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 9 files changed, 521 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 9 files changed, 521 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2023
Passed tests 1796
Skipped tests: 226
Failed tests: 1

Action taken

Triggering VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample

@modular-magician
Copy link
Collaborator

Tests failed during RECORDING mode:
TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample[view]

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

@shuyama1
Copy link
Member

@nphilbrook Looks like the failing test is unrelated.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 10 files changed, 527 insertions(+), 8 deletions(-))
Terraform Beta: Diff ( 9 files changed, 521 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2023
Passed tests 1796
Skipped tests: 226
Failed tests: 1

Action taken

Triggering VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample

@modular-magician
Copy link
Collaborator

Tests failed during RECORDING mode:
TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample[view]

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

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 10 files changed, 525 insertions(+), 6 deletions(-))
Terraform Beta: Diff ( 10 files changed, 525 insertions(+), 6 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2026
Passed tests 1797
Skipped tests: 226
Failed tests: 3

Action taken

Triggering VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccServiceNetworkingPeeredDNSDomain_basic|TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample|TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic[view]
TestAccServiceNetworkingPeeredDNSDomain_basic[view]

Tests failed during RECORDING mode:
TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample[view]

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

@shuyama1
Copy link
Member

Hi @nphilbrook! A quick question: any reasons that we would use list instead of get to look up the resource in these two data source?

@nphilbrook
Copy link
Contributor Author

Hi @nphilbrook! A quick question: any reasons that we would use list instead of get to look up the resource in these two data source?

Hi @shuyama1, thank you for reviewing my PR!

The get API calls require the numeric ID (tagKeys/12345 or tagValues/12345) for both objects:
https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys/get
https://cloud.google.com/resource-manager/reference/rest/v3/tagValues/get

The goal of this PR is to make these objects available via their descriptive short names, and the only way to do that is to list them, and filter.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 8 files changed, 519 insertions(+))
Terraform Beta: Diff ( 8 files changed, 519 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2026
Passed tests 1800
Skipped tests: 226
Failed tests: 0

All tests passed in REPLAYING mode
View the build log

@shuyama1
Copy link
Member

Hi @nphilbrook! A quick question: any reasons that we would use list instead of get to look up the resource in these two data source?

Hi @shuyama1, thank you for reviewing my PR!

The get API calls require the numeric ID (tagKeys/12345 or tagValues/12345) for both objects: cloud.google.com/resource-manager/reference/rest/v3/tagKeys/get cloud.google.com/resource-manager/reference/rest/v3/tagValues/get

The goal of this PR is to make these objects available via their descriptive short names, and the only way to do that is to list them, and filter.

Got it! Sorry, I didn’t realize that short_name was not name. Thanks for the explanation!

Copy link
Member

@shuyama1 shuyama1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you so much for your contribution!

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

Successfully merging this pull request may close these issues.

3 participants