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 certificate manager certificate to deal with locations #7825

Conversation

felipegc
Copy link
Contributor

@felipegc felipegc commented Apr 24, 2023

Enhancing certificate manager certificate to deal with location property instead of global only.

issue tracker: hashicorp/terraform-provider-google#13090

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)

certificatemanager: added `location` field to `certificatemanager` certificate resource

@modular-magician
Copy link
Collaborator

Oops! It looks like you're using an unknown release-note type in your changelog entries:

  • REPLACEME

Please only use the types listed in https://github.com/GoogleCloudPlatform/magic-modules/blob/master/.ci/RELEASE_NOTES_GUIDE.md.

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


@modular-magician modular-magician added the awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests label Apr 24, 2023
@felipegc
Copy link
Contributor Author

felipegc commented Apr 24, 2023

Hi @ScottSuarez

I am wondering if you can be the reviewer for this PR since you are aware of this one: #7661

I am opening this pull request which contains the migration for that as you requested. There is a long time there is no update in that P.R and I need to have this enhancement because is dependent on this one: hashicorp/terraform-provider-google#14324

After the regional enhancement is merged I will be able to generate the proper integration tests for SWG.

Thanks

@felipegc felipegc changed the title Update certificate manager regional Update certificate manager certificate to deal with locations Apr 24, 2023
@rileykarson rileykarson requested review from ScottSuarez and removed request for megan07 April 24, 2023 21:22
Copy link
Member

@rileykarson rileykarson left a comment

Choose a reason for hiding this comment

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

Trading reviewers + free drive-by comment because I was interested in how this got tackled.

# limitations under the License.
-%>
// Force legacy id format for global triggers.
id = strings.ReplaceAll(id, "/locations/global/", "/")
Copy link
Member

Choose a reason for hiding this comment

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

note: I think the old id string was projects/{{project}}/locations/global/certificates/{{name}} so this replacement probably isn't necessary!

Copy link
Member

Choose a reason for hiding this comment

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

Ah- preserving the old import format may be the issue. We may want to define a custom_import to compartmentalize the logic if so (since I think we could eliminate the pre_read too)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In fact, none of them are necessary. The "StateUpgraders" will set the "location" to its default value "global" so the replacements will have the value properly on time when they need to build the id or url.

The import is not preserving the old format and it requires to have the location in the id which means the user needs to use these formats for example:
"projects/{{project}}/locations/{{location}}/certificates/{{certificate}}"
"{{project}}/{{location}}/{{certificate}}"

@modular-magician modular-magician removed the awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests label Apr 25, 2023
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 394 insertions(+), 20 deletions(-))
Terraform Beta: Diff ( 5 files changed, 394 insertions(+), 20 deletions(-))
TF Conversion: Diff ( 3 files changed, 4 insertions(+), 4 deletions(-))
TF OiCS: Diff ( 5 files changed, 111 insertions(+), 1 deletion(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2675
Passed tests 2388
Skipped tests: 279
Affected tests: 8

Action taken

Found 8 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccAlloydbBackup_missingLocation|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccCertificateManagerCertificate_certificateManagerSelfManagedCertificateRegionalExample|TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example|TestAccCertificateManagerCertificate_certificateManagerSelfManagedCertificateExample|TestAccAlloydbCluster_missingLocation|TestAccDataSourceAlloydbLocations_basic|TestAccDataSourceGoogleFirebaseAndroidAppConfig

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccAlloydbBackup_missingLocation[Debug log]
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccCertificateManagerCertificate_certificateManagerSelfManagedCertificateRegionalExample[Debug log]
TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example[Debug log]
TestAccCertificateManagerCertificate_certificateManagerSelfManagedCertificateExample[Debug log]
TestAccAlloydbCluster_missingLocation[Debug log]
TestAccDataSourceAlloydbLocations_basic[Debug log]
TestAccDataSourceGoogleFirebaseAndroidAppConfig[Debug log]

All tests passed
View the build log or the debug log for each test

@modular-magician modular-magician added awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests and removed awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests labels Apr 25, 2023
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 391 insertions(+), 20 deletions(-))
Terraform Beta: Diff ( 5 files changed, 391 insertions(+), 20 deletions(-))
TF Conversion: Diff ( 3 files changed, 4 insertions(+), 4 deletions(-))
TF OiCS: Diff ( 5 files changed, 111 insertions(+), 1 deletion(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2678
Passed tests 2392
Skipped tests: 279
Affected tests: 7

Action taken

Found 7 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccFirebaserulesRelease_BasicRelease|TestAccAlloydbCluster_missingLocation|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccAlloydbBackup_missingLocation|TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example|TestAccDataSourceGoogleFirebaseAndroidAppConfig|TestAccDataSourceAlloydbLocations_basic

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccAlloydbCluster_missingLocation[Debug log]
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccAlloydbBackup_missingLocation[Debug log]
TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example[Debug log]
TestAccDataSourceGoogleFirebaseAndroidAppConfig[Debug log]
TestAccDataSourceAlloydbLocations_basic[Debug log]

All tests passed
View the build log or the debug log for each test

Copy link
Contributor

@ScottSuarez ScottSuarez left a comment

Choose a reason for hiding this comment

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

Cool, tested locally.. This looks good !

maphad pushed a commit to maphad/magic-modules that referenced this pull request Apr 27, 2023
maphad pushed a commit to maphad/magic-modules that referenced this pull request Apr 27, 2023
maphad pushed a commit to maphad/magic-modules that referenced this pull request Apr 27, 2023
rainshen49 pushed a commit to rainshen49/magic-modules that referenced this pull request Apr 28, 2023
ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023
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.

4 participants