Extend breaking change detector to work on new required and new optional with default#14059
Merged
ScottSuarez merged 13 commits intoGoogleCloudPlatform:mainfrom May 22, 2025
Merged
Conversation
…toplevel optional with default
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1199 Click here to see the affected service packages
Action takenFound 1115 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
debug_test_new_optional_with_default = # value needed
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1199 Click here to see the affected service packages
Action takenFound 1115 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
melinath
requested changes
May 21, 2025
| for field, fieldDiff := range resourceDiff.Fields { | ||
| for _, rule := range FieldDiffRules { | ||
| for _, message := range rule.Messages(resource, field, fieldDiff) { | ||
| for _, message := range rule.Messages(resource, field, fieldDiff, isPreExistingResource) { |
Member
There was a problem hiding this comment.
Rather than passing a bool isPreExistingResource, what would you think of passing the entire resourceDiff object? That would be a simple change that would give us more flexibility for potentially introducing more complex logic in the future.
Contributor
Author
There was a problem hiding this comment.
changed to pass interface, would rather not pass entire object, difficult to unit test
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
initialize_params {
debug_test_new_required = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1199 Click here to see the affected service packages
Action takenFound 1115 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1200 Click here to see the affected service packages
Found 1116 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1200 Click here to see the affected service packages
Found 1116 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
Contributor
Author
|
checks are failing due to noop virtual fields (will be removed before checkin) |
melinath
requested changes
May 22, 2025
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1204 Click here to see the affected service packages
Found 1120 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
melinath
approved these changes
May 22, 2025
| package breaking_changes | ||
|
|
||
| // MockSchemaDiff implements the diff.SchemaDiff interface for testing | ||
| type MockSchemaDiff struct { |
Member
There was a problem hiding this comment.
I would prefer to not mock per go/choose-test-double?polyglot=go#prefer-real-implementations, but I'm not blocking on it.
Contributor
Author
There was a problem hiding this comment.
ack, this is checked upstream (parent package) in another integration test. I would like to keep these simple and relevant to the logic they need to check.
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
Breaking Change(s) DetectedThe following breaking change(s) were detected within your pull request.
If you believe this detection to be incorrect please raise the concern with your reviewer. Missing test reportYour PR includes resource fields which are not covered by any test. Resource: resource "google_compute_instance" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_machine_image" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_instance_from_template" "primary" {
boot_disk {
initialize_params {
debug_test_new_nested_optional_with_default_nested = # value needed
debug_test_new_required_nested = # value needed
}
new_obj {
debug_test_new_nested_optional_with_default_nested_ignore = # value needed
debug_test_new_required_nested_ignore = # value needed
}
}
debug_test_new_optional_with_default = # value needed
}
Resource: resource "google_compute_router_interface" "primary" {
debug_test_new_required = # value needed
}
Missing doc report (experimental)The following resources have fields missing in documents.
|
Collaborator
Tests analyticsTotal tests: 1204 Click here to see the affected service packages
Found 1120 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
|
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR hasn't generated any diffs, but I'll let you know if a future commit does. |
Merged
via the queue into
GoogleCloudPlatform:main
with commit May 22, 2025
29dd6c8
27 checks passed
NandiniAgrawal15
pushed a commit
to NandiniAgrawal15/magic-modules
that referenced
this pull request
Jun 5, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jun 25, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jun 25, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
jingqizz
pushed a commit
to jingqizz/magic-modules
that referenced
this pull request
Jul 9, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jul 28, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jul 28, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jul 28, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
BBBmau
pushed a commit
to BBBmau/magic-modules
that referenced
this pull request
Jul 28, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
NandiniAgrawal15
pushed a commit
to NandiniAgrawal15/magic-modules
that referenced
this pull request
Sep 4, 2025
…nal with default (GoogleCloudPlatform#14059) Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes b/300515447
Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.