Skip to content

Update apigee keystore resource names to be consistent#7665

Merged
rileykarson merged 4 commits into
GoogleCloudPlatform:mainfrom
rileykarson:rename-apigee-resources
Apr 7, 2023
Merged

Update apigee keystore resource names to be consistent#7665
rileykarson merged 4 commits into
GoogleCloudPlatform:mainfrom
rileykarson:rename-apigee-resources

Conversation

@rileykarson

@rileykarson rileykarson commented Apr 7, 2023

Copy link
Copy Markdown
Member

#7518 was released in https://github.com/hashicorp/terraform-provider-google-beta/releases/tag/v4.60.0 adding google_apigee_keystores_aliases_key_cert_file. That resource is a fine-grained resource of https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.keystores.aliases, a custom endpoint that supports multiple different kind of aliases.

That resource probably should have been called google_apigee_keystore_alias_key_cert_file, or google_apigee_env_keystore_alias_key_cert_file based on google_apigee_env_keystore. See discussion in #7472 (work on another of those FGRs that was started before that change, but took longer to finish).

4.61.0 is set to include:
* google_apigee_env_keystore_alias_pkcs12 from #7519
* google_apigee_env_keystore_alias_self_signed_cert from #7488

However, these are subresources of the same resource. This PR corrects them to be self-consistent with the released resource (google_apigee_keystores_aliases_key_cert_file). Therefore the new resources will be:

  • google_apigee_keystores_aliases_pkcs12
  • google_apigee_keystores_aliases_self_signed_cert

I'm not sure how to catch these situations faster- there were multiple PRs, multiple authors, multiple reviewers, and PRs took different lengths of time to go through review.

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)

No changelog entry- this will be cherry-picked to `4.61.0` and affects unreleased resources. The changelog will need to be amended, though.

@rileykarson rileykarson requested a review from a team as a code owner April 7, 2023 18:43
@rileykarson rileykarson requested review from slevenick and removed request for a team April 7, 2023 18:43
@rileykarson rileykarson changed the title Update apigee keystore names to be consistent Update apigee keystore resource names to be consistent Apr 7, 2023
@modular-magician

Copy link
Copy Markdown
Collaborator

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

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Resource google_apigee_env_keystore_alias_pkcs12 was either removed or renamed - reference
  • Resource google_apigee_env_keystore_alias_self_signed_cert was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

Diff report

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

Terraform GA: Diff ( 6 files changed, 106 insertions(+), 106 deletions(-))
Terraform Beta: Diff ( 6 files changed, 106 insertions(+), 106 deletions(-))
TF Conversion: Diff ( 3 files changed, 220 insertions(+), 3 deletions(-))
TF Validator: Diff ( 3 files changed, 220 insertions(+), 3 deletions(-))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_apigee_keystores_aliases_self_signed_cert (1 total tests)
Untested fields: subject_alternative_dns_names.subject_alternative_name, subject.email, subject.state

Please add acceptance tests which include these fields.

@rileykarson rileykarson added the override-breaking-change Allows a potential breaking change to be merged label Apr 7, 2023
@rileykarson

rileykarson commented Apr 7, 2023

Copy link
Copy Markdown
Member Author

Override: These are unreleased.

Tests: These were not added in this PR (but they seem like they were- the missing test detection is behaving correctly)

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2559
Passed tests 2279
Skipped tests: 275
Affected tests: 5

Action taken

Found 5 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|TestAccDataSourceGoogleFirebaseAndroidAppConfig|TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example|TestAccApigeeKeystoresAliasesSelfSignedCert_apigeeEnvKeystoreAliasSelfSignedCertExample|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample

Get to know how VCR tests work

Comment thread mmv1/products/apigee/EnvKeystoreAliasSelfSignedCert.yaml
Comment thread mmv1/third_party/terraform/utils/provider.go.erb Outdated
@modular-magician

Copy link
Copy Markdown
Collaborator

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

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

  • Resource google_apigee_env_keystore_alias_pkcs12 was either removed or renamed - reference
  • Resource google_apigee_env_keystore_alias_self_signed_cert was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

Diff report

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

Terraform GA: Diff ( 7 files changed, 123 insertions(+), 123 deletions(-))
Terraform Beta: Diff ( 7 files changed, 123 insertions(+), 123 deletions(-))
TF Conversion: Diff ( 3 files changed, 220 insertions(+), 3 deletions(-))
TF Validator: Diff ( 3 files changed, 220 insertions(+), 3 deletions(-))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_apigee_keystores_aliases_self_signed_cert (1 total tests)
Untested fields: subject.state, subject.email, subject_alternative_dns_names.subject_alternative_name

Please add acceptance tests which include these fields.

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2562
Passed tests 2282
Skipped tests: 275
Affected tests: 5

Action taken

Found 5 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccDataSourceGoogleFirebaseAndroidAppConfig|TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example|TestAccApigeeKeystoresAliasesSelfSignedCert_apigeeEnvKeystoreAliasSelfSignedCertExample|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccComputeForwardingRule_update

Get to know how VCR tests work

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests passed during RECORDING mode:
TestAccDataSourceGoogleFirebaseAndroidAppConfig[Debug log]
TestAccApigeeKeystoresAliasesPkcs12_ApigeeKeystoresAliasesPkcs12Example[Debug log]
TestAccApigeeKeystoresAliasesSelfSignedCert_apigeeEnvKeystoreAliasSelfSignedCertExample[Debug log]
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccComputeForwardingRule_update[Debug log]

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

override-breaking-change Allows a potential breaking change to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants