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

Update google_iap_brand documentation about import and name formats #6586

Merged
merged 5 commits into from
Sep 23, 2022

Conversation

SarahFrench
Copy link
Contributor

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.name

When 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.

  1. Removing the resource from state
  2. Attempting import with the latest provider release
  3. Attempting import with developer override using a build of this PR
    • The resource in state has an id of {{project}}/{{brand_id}} but the name is set as projects/{{project}}/brands/{{brand_id}}

Screenshot 2022-09-21 at 21 02 03


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.
  • 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/A
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know). N/A
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

iap: added ability to import `google_iap_brand` using ID in {{project}}/{{brand_id}} format

@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. @ScottSuarez, 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.


@SarahFrench
Copy link
Contributor Author

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}}

@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 ( 2 files changed, 31 insertions(+), 12 deletions(-))
Terraform Beta: Diff ( 2 files changed, 31 insertions(+), 12 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2176
Passed tests 1936
Skipped tests: 238
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccComputeInstance_soleTenantNodeAffinities|TestAccCGCSnippet_eventarcWorkflowsExample

@modular-magician
Copy link
Collaborator

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

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

@SarahFrench
Copy link
Contributor Author

Thanks!

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.

google_iap_brand documentation is wrong about import
3 participants