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

fix: do not interpolate env variables in helm template options when forceString is true #20002

Closed
wants to merge 3 commits into from

Conversation

daengdaengLee
Copy link
Member

@daengdaengLee daengdaengLee commented Sep 19, 2024

related issue : #19269 (1 problem / 2 problems)

  • AS-IS: It performs environment variable interpolation for all parameters of the helm template, regardless of the forceString option.
  • TO-BE: When the forceString option is set to true, the environment variable interpolation is not performed.
  • REASON: I think the value of the helm parameter should be treated as a string when the forceString option is true. (explained in the docs) If this PR is merged, it will resolve part of the issue Commas and dollar signs improperly passed to Helm #19269 (the problem where the $ character is incorrectly encoded even when the forceString option is true).

If I've misunderstood something, please let me know in the comments or close the PR. Thank you! :)

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Copy link

bunnyshell bot commented Sep 19, 2024

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

Copy link

bunnyshell bot commented Sep 19, 2024

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

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

Thanks for the PR and for providing a workaround on the issue!
Can you add separate tests for the new functionality and preserve the original test?

@daengdaengLee daengdaengLee force-pushed the issue-19269 branch 3 times, most recently from 54ff712 to 06e3cf7 Compare September 20, 2024 04:36
Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@fb825f7). Learn more about missing BASE report.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master   #20002   +/-   ##
=========================================
  Coverage          ?   55.80%           
=========================================
  Files             ?      320           
  Lines             ?    44429           
  Branches          ?        0           
=========================================
  Hits              ?    24795           
  Misses            ?    17068           
  Partials          ?     2566           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@daengdaengLee daengdaengLee marked this pull request as ready for review September 21, 2024 03:46
@daengdaengLee daengdaengLee requested a review from a team as a code owner September 21, 2024 03:46
@daengdaengLee
Copy link
Member Author

Hello, @reggie-k.

I add/edit tests for changed code.
Please check the PR.

Thanks!

…orceString is true

Signed-off-by: daengdaengLee <gunho1020@gmail.com>
Signed-off-by: daengdaengLee <gunho1020@gmail.com>
Signed-off-by: daengdaengLee <gunho1020@gmail.com>
Copy link
Member

@agaudreault agaudreault left a comment

Choose a reason for hiding this comment

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

The goal of forceString is not to decide if the variable should be interpolated or not.

The main goal is to decide when boolean value, either the result of an interpolation or not, should be converted to a string.
This is because the quoting will be removed, and it is impossible to specify myparams: "true" where the value must be a string.

@agaudreault
Copy link
Member

Closing as this is not the desired behavior. The discussion on the correct implementation to fix the issue should happen in #19269

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants