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

Remove deprecated fields from Cloud Run v2 resources #8529

Conversation

yanweiguo
Copy link
Member

@yanweiguo yanweiguo commented Aug 2, 2023

Fixes hashicorp/terraform-provider-google#13506.

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 Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

cloudrunv2: Removed deprecated fields `startup_probe` and `liveness_probe` from `google_cloud_run_v2_job` resource.
cloudrunv2: Removed deprecated field `liveness_probe.tcp_socket` from `google_cloud_run_v2_service` resource. 

@modular-magician
Copy link
Collaborator

Hello! I am a robot. It looks like you are a community contributor. @melinath, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@modular-magician
Copy link
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.

  • Field template.containers.liveness_probe.tcp_socket.port within resource google_cloud_run_v2_service was either removed or renamed - reference
  • Field template.containers.liveness_probe.tcp_socket within resource google_cloud_run_v2_service was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.failure_threshold within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.http_get.http_headers.name within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.http_get.http_headers.value within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.http_get.http_headers within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.http_get.path within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.http_get within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.initial_delay_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.period_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.tcp_socket.port within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.tcp_socket within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe.timeout_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.liveness_probe within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.failure_threshold within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.http_get.http_headers.name within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.http_get.http_headers.value within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.http_get.http_headers within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.http_get.path within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.http_get within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.initial_delay_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.period_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.tcp_socket.port within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.tcp_socket within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe.timeout_seconds within resource google_cloud_run_v2_job was either removed or renamed - reference
  • Field template.template.containers.startup_probe within resource google_cloud_run_v2_job 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 ( 4 files changed, 121 insertions(+), 1192 deletions(-))
Terraform Beta: Diff ( 4 files changed, 121 insertions(+), 1192 deletions(-))
TF Conversion: Diff ( 3 files changed, 1 insertion(+), 390 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2873
Passed tests 2569
Skipped tests: 300
Affected tests: 4

Action taken

Found 4 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccContainerAwsNodePool_BetaBasicHandWritten|TestAccCloudRunV2Service_cloudrunv2ServiceGRPCProbesUpdate|TestAccCloudRunV2Service_cloudrunv2ServiceTCPProbesUpdate|TestAccCloudRunV2Service_cloudrunv2ServiceProbesExample

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccCloudRunV2Service_cloudrunv2ServiceGRPCProbesUpdate[Debug log]
TestAccCloudRunV2Service_cloudrunv2ServiceTCPProbesUpdate[Debug log]
TestAccCloudRunV2Service_cloudrunv2ServiceProbesExample[Debug log]

Rerun these tests in REPLAYING mode to catch issues

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerAwsNodePool_BetaBasicHandWritten[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

@melinath melinath added the override-breaking-change Allows a potential breaking change to be merged label Aug 4, 2023
Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

Please add multiple release note blocks since this impacts multiple resources - see https://googlecloudplatform.github.io/magic-modules/contribute/release-notes/ for more details.

@yanweiguo
Copy link
Member Author

Please add multiple release note blocks since this impacts multiple resources - see https://googlecloudplatform.github.io/magic-modules/contribute/release-notes/ for more details.

done

@melinath melinath self-requested a review August 4, 2023 23:01
Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

@c2thorn
Copy link
Member

c2thorn commented Aug 9, 2023

Hi @yanweiguo, if you haven't already, can you add an upgrade guide entry to the main branch here: https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/website/docs/guides/version_5_upgrade.html.markdown

It should describe the breaking change and any manual steps user's will need to do as they upgrade. Examples are in registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_4_upgrade

@yanweiguo
Copy link
Member Author

Hi @yanweiguo, if you haven't already, can you add an upgrade guide entry to the main branch here: https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/website/docs/guides/version_5_upgrade.html.markdown

It should describe the breaking change and any manual steps user's will need to do as they upgrade. Examples are in registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_4_upgrade

Will do.

rainshen49 pushed a commit to rainshen49/magic-modules that referenced this pull request Aug 14, 2023
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.

4 participants