fixing permadiff create_without_validation #14543

luckyswaminathan · 2025-07-16T18:03:13Z

Fixes hashicorp/terraform-provider-google#21780 - a permadiff regarding the create_without_validation field within datastream

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

datastore: Fixed a permadiff related to datastream 'create_without_validation' field

modular-magician · 2025-07-16T18:16:55Z

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.

google provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 14 insertions(+))

modular-magician · 2025-07-16T18:20:02Z

Tests analytics

Total tests: 9
Passed tests: 1
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🔴 Errors occurred during REPLAYING mode. Please fix them to complete your PR.

View the build log

modular-magician · 2025-07-16T18:21:13Z

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.

google provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 14 insertions(+))

modular-magician · 2025-07-16T18:24:15Z

Tests analytics

Total tests: 9
Passed tests: 1
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🔴 Errors occurred during REPLAYING mode. Please fix them to complete your PR.

View the build log

trodge · 2025-07-16T19:18:51Z

mmv1/templates/terraform/constants/datastream_connection_profile.go.tmpl

+	// If the old value was "false" and the new value is now unset (empty string),
+	// return true to suppress the diff.
+	if (old == "" && new == "false") || (old == "false" && new == "") {
+		d.Set("create_without_validation", "false")


This is what's causing the panic, because terraform expects a boolean. I would try putting

d.Set("create_without_validation", false)

in a post_import.

modular-magician · 2025-07-16T22:14:11Z

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.

google provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-16T22:18:02Z

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.

google provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 22 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-16T22:29:20Z

Tests analytics

Total tests: 15
Passed tests: 3
Skipped tests: 8
Affected tests: 4

Click here to see the affected service packages

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

Get to know how VCR tests work

modular-magician · 2025-07-16T22:33:10Z

Tests analytics

Total tests: 15
Passed tests: 3
Skipped tests: 8
Affected tests: 4

Click here to see the affected service packages

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

Get to know how VCR tests work

modular-magician · 2025-07-16T22:49:02Z

🔴 Tests failed during RECORDING mode:
TestAccDatastreamConnectionProfile_datastreamConnectionProfileBasicExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_datastreamConnectionProfileFullExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_datastreamConnectionProfilePostgresSecretManagerExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_sshKey_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

modular-magician · 2025-07-16T22:53:38Z

🔴 Tests failed during RECORDING mode:
TestAccDatastreamConnectionProfile_datastreamConnectionProfileBasicExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_datastreamConnectionProfileFullExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_datastreamConnectionProfilePostgresSecretManagerExample [Error message] [Debug log]
TestAccDatastreamConnectionProfile_sshKey_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

modular-magician · 2025-07-17T17:07:58Z

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.

google provider: Diff ( 2 files changed, 25 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 25 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-17T17:28:22Z

Tests analytics

Total tests: 15
Passed tests: 7
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

modular-magician · 2025-07-17T22:03:56Z

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.

google provider: Diff ( 2 files changed, 26 insertions(+), 9 deletions(-))
google-beta provider: Diff ( 2 files changed, 26 insertions(+), 9 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-17T22:24:34Z

Tests analytics

Total tests: 15
Passed tests: 7
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

trodge · 2025-07-18T21:52:31Z

mmv1/templates/terraform/constants/datastream_connection_profile.go.tmpl

+	// If the old value was "false" and the new value is now unset (empty string),
+	// return true to suppress the diff.


This describes what the conditional does, but the important thing to explain here is why we need to do it. You can either link the issue in the comment or summarize it.

trodge · 2025-07-18T22:52:44Z

mmv1/templates/terraform/pre_create/datastream_connection_profile.go.tmpl

+_, exists := d.GetOk("create_without_validation")
+if !exists {
+	url += "false"
+	d.Set("create_without_validation", false)
+}


Sorry for the back and forth here, but after reviewing a discussion about GetOkExists I think our best approach is actually to get the url parameters out of the base URL entirely.

So that would mean deleting &force={{create_without_validation}} from the create_url and calling transport.AddQueryParams here with something like map[string]string{"force": "true"} only if d.Get("create_without_validation") returns true.

We might also want to make sure there's at least one test that creates the resource with the field set to false or unspecified.

would this not be a breaking change?

Is the force url parameter required in the API endpoint?

It would also be a breaking change if force=false has different behavior than omitting force altogether. Keeping it as is should be safest.

trodge · 2025-07-21T21:33:07Z

mmv1/templates/terraform/pre_create/datastream_connection_profile.go.tmpl

+		url, err = transport_tpg.AddQueryParams(url, map[string]string{"force": "true"})
+	} else {
+		url, err = transport_tpg.AddQueryParams(url, map[string]string{"force": "false"})
+	}


nit: the indentation is looking weird to me, although it should be fine as long as gofmt still works on it.

modular-magician · 2025-07-21T21:42:07Z

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.

google provider: Diff ( 2 files changed, 27 insertions(+), 10 deletions(-))
google-beta provider: Diff ( 2 files changed, 27 insertions(+), 10 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-21T21:55:00Z

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.

google provider: Diff ( 2 files changed, 27 insertions(+), 10 deletions(-))
google-beta provider: Diff ( 2 files changed, 27 insertions(+), 10 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 13 insertions(+))

modular-magician · 2025-07-21T22:02:32Z

Tests analytics

Total tests: 15
Passed tests: 7
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

modular-magician · 2025-07-21T22:15:25Z

Tests analytics

Total tests: 15
Passed tests: 7
Skipped tests: 8
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

luckyswaminathan added 2 commits July 16, 2025 11:02

new branch to fix the issue with last

92580d3

added both ways for diff supp

3b30533

modular-magician added the service/datastream label Jul 16, 2025

trodge reviewed Jul 16, 2025

View reviewed changes

luckyswaminathan added 2 commits July 16, 2025 15:00

changed the custom diff so that the url for the request was correct

259508e

lint errors

183ebce

luckyswaminathan marked this pull request as ready for review July 16, 2025 22:05

github-actions bot requested a review from trodge July 16, 2025 22:06

changed create logic to make url correcT

4460a1d

handles false existence case

9245831

trodge reviewed Jul 18, 2025

View reviewed changes

changed url construction with create_wo_validation

a6d6e40

github-actions bot requested a review from trodge July 21, 2025 21:29

trodge reviewed Jul 21, 2025

View reviewed changes

fixed indentation

10a0d65

github-actions bot requested a review from trodge July 21, 2025 21:42

trodge approved these changes Jul 24, 2025

View reviewed changes

trodge added this pull request to the merge queue Jul 24, 2025

Merged via the queue into GoogleCloudPlatform:main with commit 326baa9 Jul 24, 2025
27 checks passed

luckyswaminathan deleted the lakshman-datastore-create-wo-validation branch July 25, 2025 22:45

		// If the old value was "false" and the new value is now unset (empty string),
		// return true to suppress the diff.

fixing permadiff create_without_validation #14543

fixing permadiff create_without_validation #14543

Uh oh!

Conversation

luckyswaminathan commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

modular-magician commented Jul 16, 2025

Diff report

Uh oh!

modular-magician commented Jul 16, 2025

Tests analytics

Uh oh!

modular-magician commented Jul 16, 2025

Diff report

Uh oh!

modular-magician commented Jul 16, 2025

Tests analytics

Uh oh!

trodge Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

modular-magician commented Jul 16, 2025

Diff report

Uh oh!

modular-magician commented Jul 16, 2025

Diff report

Uh oh!

modular-magician commented Jul 16, 2025

Tests analytics

Uh oh!

modular-magician commented Jul 16, 2025

Tests analytics

Uh oh!

modular-magician commented Jul 16, 2025

Uh oh!

modular-magician commented Jul 16, 2025

Uh oh!

modular-magician commented Jul 17, 2025

Diff report

Uh oh!

modular-magician commented Jul 17, 2025

Tests analytics

Uh oh!

modular-magician commented Jul 17, 2025

Diff report

Uh oh!

modular-magician commented Jul 17, 2025

Tests analytics

Uh oh!

trodge Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trodge Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

luckyswaminathan Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

trodge Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

trodge Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

trodge Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

modular-magician commented Jul 21, 2025

Diff report

Uh oh!

modular-magician commented Jul 21, 2025

Diff report

Uh oh!

modular-magician commented Jul 21, 2025

Tests analytics

Uh oh!

modular-magician commented Jul 21, 2025

Tests analytics

luckyswaminathan commented Jul 16, 2025 •

edited

Loading

trodge Jul 18, 2025 •

edited

Loading