Fix firewall rule to support empty descritpion on update

[r-teller]

Fixed google_compute_firewall to support updating description field to empty or null value, currently when the value changes to null/empty updates are not pushed

Release Note Template for Downstream PRs (will be copied)

compute: fixed `description` field in `google_compute_firewall` to support empty/null values on update

[github-actions]

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

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

[slevenick]

Can you add a test that would specifically update this field to empty and check that it works?

[modular-magician]

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 ( 1 file changed, 2 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 1 file changed, 2 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 1 insertion(+), 1 deletion(-))

[modular-magician]

Tests analytics

Total tests: 956
Passed tests: 881
Skipped tests: 74
Affected tests: 1

Click here to see the affected service packages

• compute

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

[modular-magician]

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy[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

[r-teller]

I have modify TestAccComputeFirewall_update to verify that description can be set to null/empty

[modular-magician]

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, 35 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 2 files changed, 35 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 1 insertion(+), 1 deletion(-))

[modular-magician]

Tests analytics

Total tests: 960
Passed tests: 884
Skipped tests: 74
Affected tests: 2

Click here to see the affected service packages

• compute

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeFirewall_update|TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

[modular-magician]

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

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

---

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy[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

[slevenick]

Can you explain why setting the description to empty is desirable? I get that it's technically correct, but it may introduce unexpected behavior as most of our resources with descriptions don't behave like this

Are you running into a specific issue around the description field?

[r-teller]

I noticed that for most resources within GCP, the description is an immutable field, but for firewall rules, it is not. Through the console or gcloud command, you can set this to empty. However, when using Terraform, it provides a different experience.

In my organization, I observed that you could create a firewall rule without a description, but once a rule has a description, you couldn't set it back to empty. The goal for this merge was to align Terraform functionality with the expected experience provided through other interactions

[github-actions]

@slevenick This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

[slevenick]

This is causing a failure in TGC (which you don't need to know about) but I think the way to fix it is to add a description to this file: https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/tgc/tests/data/firewall.json

Can you try that and we'll see if the tests pass? I'm not entirely sure how to fix it, so I'm kind of guessing here

[r-teller]

I believe i have updated all firewall rules that would have failed based on missing descriptions

[modular-magician]

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, 35 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 2 files changed, 35 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 4 files changed, 5 insertions(+), 1 deletion(-))

[modular-magician]

Tests analytics

Total tests: 960
Passed tests: 885
Skipped tests: 74
Affected tests: 1

Click here to see the affected service packages

• compute

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

[modular-magician]

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy[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