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

resource/aws_quicksight_analysis: Fix inconsistent text content handling #40512

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

richardissailing
Copy link

Description of Changes

Fixes an issue where using heredoc in QuickSight Analysis text content fields causes endless plan updates. The issue occurs because QuickSight requires a specific text formatting style which was not being consistently maintained.

When using a non-breaking space character in heredoc in the content field of definition.sheets.text_boxes block in aws_quicksight_analysis resource, Terraform would detect changes on every plan even though no actual changes were made.

Fixes #33080

Example Usage

resource "aws_quicksight_analysis" "example" {
  analysis_id = "test"
  name        = "test"
  theme_arn   = "arn:aws:quicksight::aws:theme/CLASSIC"

  definition {
    data_set_identifiers_declarations {
      identifier   = aws_quicksight_data_set.test.name
      data_set_arn = aws_quicksight_data_set.test.arn
    }

    sheets {
      sheet_id = "sheet1"
      text_boxes {
        sheet_text_box_id = "text1"
        content = "<text-box>\n  <inline font-size=\"20px\">\n    <b>Title</b>\n  </inline>\n  <br/>\n  Some text.\n  <br/>\n  Some text, and here is a link:\n  <a href=\"https://example.com\" target=\"_blank\">link</a>\n</text-box>"
      }
    }
  }
}

Testing Done

  1. Added acceptance test to verify text content handling
  2. Verified that multiple applies with the same configuration do not cause plan changes
  3. Tested with both heredoc and double-quoted string formats

Test Output:

make testacc TESTS=TestAccQuickSightAnalysis_textContent PKG=quicksight
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.3 test ./internal/service/quicksight/... -v -count 1 -parallel 20 -run='TestAccQuickSightAnalysis_textContent' -timeout 360m
2024/12/11 07:39:48 Initializing Terraform AWS Provider...
=== RUN   TestAccQuickSightAnalysis_textContent
=== PAUSE TestAccQuickSightAnalysis_textContent
=== CONT  TestAccQuickSightAnalysis_textContent
--- PASS: TestAccQuickSightAnalysis_textContent (69.06s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/quicksight  58.425s

Fixes an issue where using heredoc in QuickSight Analysis text content
fields causes endless plan updates. The issue occurs because QuickSight
requires a specific text formatting style which was not being consistently
maintained.
@richardissailing richardissailing requested a review from a team as a code owner December 10, 2024 21:11
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/quicksight Issues and PRs that pertain to the quicksight service. needs-triage Waiting for first response or review from a maintainer. labels Dec 10, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome @richardissailing 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

@justinretzolk justinretzolk added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Addresses a defect in current functionality. service/quicksight Issues and PRs that pertain to the quicksight service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Endless plan updates when using a non-breaking space character in heredoc in aws_quicksight_analysis
2 participants