-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Update google_iap_brand
documentation about import and name formats
#6586
Update google_iap_brand
documentation about import and name formats
#6586
Conversation
Hello! I am a robot who works on Magic Modules PRs. I've detected that you're a community contributor. @ScottSuarez, a repository maintainer, has been assigned to assist you and help review your changes. ❓ First time contributing? Click here for more detailsYour assigned reviewer will help review your code by:
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. |
If there's a simple solution to stop the downstream having this third import format added to the docs I'm happy to remove the new import code, but I figured implementing it would be easier! $ terraform import google_iap_brand.default projects/{{project_id}}/brands/{{brand_id}}
$ terraform import google_iap_brand.default projects/{{project_number}}/brands/{{brand_id}}
- $ terraform import google_iap_brand.default {{project_number}}/{{brand_id}} |
Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are. Diff report:Terraform GA: Diff ( 2 files changed, 31 insertions(+), 12 deletions(-)) |
Tests analyticsTotal tests: Action takenTriggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed testsTestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample |
Tests failed during RECORDING mode: Please fix these to complete your PR |
Thanks! |
Closes hashicorp/terraform-provider-google#12600
PR makes the two possible import formats for the
google_iap_brand
resource more explicit.I also updated the description of the
name
attribute as I thought it'd be good to make it clear that it can take the two forms (but I think API returns project number for Read operations). Relevant documentation : https://cloud.google.com/iap/docs/reference/rest/v1/projects.brands/get#body.PATH_PARAMETERS.nameWhen I generated the downstream locally I saw that a third import format is added automatically :
{{project_number}}/{{brand_id}}
I couldn't figure out how to stop this happening, so I implemented the ability to import with that format of ID.I currently don't know how we'd make acceptance tests to test import with the different import formats, because we'd require knowledge of the the project number of the project made in the acceptance test.
For now, I've tested the import manually. See image below.
id
of{{project}}/{{brand_id}}
but the name is set asprojects/{{project}}/brands/{{brand_id}}
If this PR is for Terraform, I acknowledge that I have:
make test
andmake lint
to ensure it passes unit and linter tests.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).N/ARan relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).N/ARelease Note Template for Downstream PRs (will be copied)