Introduce user_data_file helper method for YAML ERB templates
#377
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orien
force-pushed
the
yaml-template-userdata
branch
from
d61039c to
166a4a6
Compare
orien
commented
Feb 4, 2024
| # this capability to enrich user data scripts with data and parameters pulled | ||
| # from the AWS CloudFormation service. The evaluation produces an array of | ||
| # objects ready for use in a CloudFormation `Fn::Join` intrinsic function. | ||
| class CloudFormationInterpolatingEruby < Erubis::Eruby |
There was a problem hiding this comment.
Extract this class out of the stack_master/sparkle_formation/template_file.rb file.
Allow the functionality to be reused between the SparkleFormation and YAML ERB template compilers.
orien
commented
Feb 4, 2024
| # This class is a modified version of `Erubis::Eruby`. It provides extra | ||
| # helper methods to ease the dynamic creation of CloudFormation templates | ||
| # with ERB. These helper methods are available within `<%= %>` expressions. | ||
| class CloudFormationTemplateEruby < Erubis::Eruby |
There was a problem hiding this comment.
Extend Eruby with helper methods exposed to the YAML ERB templates.
orien
commented
Feb 4, 2024
Comment on lines
+1
to
+7
| Description: A test case for storing the userdata script in a dedicated file | ||
|
|
||
| Resources: | ||
| LaunchConfig: | ||
| Type: 'AWS::AutoScaling::LaunchConfiguration' | ||
| Properties: | ||
| UserData: <%= user_data_file(File.join(__dir__, 'user_data.sh.erb')) %> |
There was a problem hiding this comment.
This test fixture shows how the user_data_file helper method can be used.
viraptor
reviewed
Feb 5, 2024
Comment on lines
+53
to
+56
| newlines = Array.new(lines.count("\n"), "\n") | ||
| newlines = lines.split("\n").map { |line| "#{line}#{newlines.pop}" } | ||
| newlines.insert(0, "\n") if lines.start_with?("\n") | ||
| newlines |
There was a problem hiding this comment.
I found this pretty hard to read. How about this?
Suggested change
| newlines = Array.new(lines.count("\n"), "\n") | |
| newlines = lines.split("\n").map { |line| "#{line}#{newlines.pop}" } | |
| newlines.insert(0, "\n") if lines.start_with?("\n") | |
| newlines | |
| lines.scan(/[^\n]*\n?/).reject { |x| x=="" } |
This should cover the same idea.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
The StackMaster SparkleFormation template compiler provides a neat
_user_data_fileconvenience method that provides an easy way to include userdata script files in CloudFormation templates.stack_master/lib/stack_master/sparkle_formation/template_file.rb
Lines 105 to 108 in feab2eb
Change
Introduce a similar
user_data_filemethod for the YAML ERB template compiler. This will allow users to do something like this within a.yml.erbtemplate:Resources: LaunchConfig: Type: 'AWS::AutoScaling::LaunchConfiguration' Properties: UserData: <%= user_data_file('path/to/my/userdata.sh') %>