[AVM Module Issue]: whitespace following heredoc closing delimiter causes issues with module parsing in some IDEs

[MikeDembek]

Check for previous/existing GitHub issues

• I have checked for previous/existing GitHub issues

Issue Type?

Bug

(Optional) Module Version

0.18.0

(Optional) Correlation Id

No response

Description

Hey, I've been seeing some issues with multiple AVMs showing unexpected errors for a subset of properties when using IntelliJ IDEA as my IDE. there are several of those in the VM module, and it looks like that's an issue with trailing whitespace in heredoc strings.

This issue from the resource group AVM describes the same underlying issue:
Azure/terraform-azurerm-avm-res-resources-resourcegroup#62

If the delimiter has a trailing space following the close IntelliJ doesn't treat it as a valid closure. As a result it treats subsequent code as part of the heredoc string and throws errors as a result. Removing the trailing space following delimiter clears that up.

This issue talks about a broadly similar challenge:
hashicorp/terraform#25410

This doc covers heredoc strings in TF:

https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings

While it isn't entirely clear from the doc, this bit makes me think a trailing space could be an issue:

"Terraform then processes the following lines until it finds one that consists entirely of the identifier given in the introducer."

I'll submit a PR to try to address this.

[microsoft-github-policy-service]

Warning

Tagging the AVM Core Team (@Azure/avm-core-team-technical-terraform) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly.

Tip

• To prevent further actions to take effect, the "Status: Response Overdue 🚩" label must be removed, once this issue has been responded to.
• To avoid this rule being (re)triggered, the ""Needs: Triage 🔍" label must be removed as part of the triage process (when the issue is first responded to)!

[microsoft-github-policy-service]

Warning

Tagging the AVM Core Team (@Azure/avm-core-team-technical-terraform) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly.

Tip

• To prevent further actions to take effect, the "Status: Response Overdue 🚩" label must be removed, once this issue has been responded to.
• To avoid this rule being (re)triggered, the ""Needs: Triage 🔍" label must be removed as part of the triage process (when the issue is first responded to)!

[microsoft-github-policy-service]

Caution

**This issue requires the AVM Core Team's (@Azure/avm-core-team-technical-terraform) immediate attention as it hasn't been responded to within 6 business days. **

Tip

• To avoid this rule being (re)triggered, the "Needs: Triage 🔍" and "Status: Response Overdue 🚩" labels must be removed when the issue is first responded to!
• Remove the "Needs: Immediate Attention ‼️" label once the issue has been responded to.

[microsoft-github-policy-service]

Warning

Tagging the AVM Core Team (@Azure/avm-core-team-technical-terraform) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly.

Tip

• To prevent further actions to take effect, the "Status: Response Overdue 🚩" label must be removed, once this issue has been responded to.
• To avoid this rule being (re)triggered, the ""Needs: Triage 🔍" label must be removed as part of the triage process (when the issue is first responded to)!

[microsoft-github-policy-service]

Caution

**This issue requires the AVM Core Team's (@Azure/avm-core-team-technical-terraform) immediate attention as it hasn't been responded to within 6 business days. **

Tip

• To avoid this rule being (re)triggered, the "Needs: Triage 🔍" and "Status: Response Overdue 🚩" labels must be removed when the issue is first responded to!
• Remove the "Needs: Immediate Attention ‼️" label once the issue has been responded to.

[jchancellor-ms]

@MikeDembek - Let me bring this up with our core team to see if we can add something into the pre-commit pipeline that will correct this for all modules so we don't have to make individual module corrections. Thanks for highlighting this issue.