-
Notifications
You must be signed in to change notification settings - Fork 583
deferrable epp function simplifying deferred templates #1253
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# This function returns either a rendered template or a deferred function to render at runtime. | ||
# If any of the values in the variables hash are deferred, then the template will be deferred. | ||
# | ||
# Note: this function requires all parameters to be explicitly passed in. It cannot expect to | ||
# use facts, class variables, and other variables in scope. This is because when deferred, we | ||
# have to explicitly pass the entire scope to the client. | ||
# | ||
function stdlib::deferrable_epp(String $template, Hash $variables) >> Variant[String, Deferred] { | ||
if $variables.any |$key, $value| { $value.is_a(Deferred) } { | ||
Deferred( | ||
'inline_epp', | ||
[find_template($template).file, $variables], | ||
) | ||
} | ||
else { | ||
epp($template, $variables) | ||
} | ||
} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
require 'spec_helper' | ||
|
||
describe 'stdlib::deferrable_epp' do | ||
context 'call epp on non-deferred input' do | ||
let(:pre_condition) do | ||
'function epp($str, $data) { return "rendered"}' | ||
end | ||
it { | ||
is_expected.to run.with_params('mymod/template.epp', {'foo' => 'bar'}).and_return('rendered') | ||
} | ||
end | ||
|
||
context 'defers rendering with deferred input' do | ||
let(:pre_condition) do (<<~END) | ||
function epp($str, $data) { fail("should not have invoked epp()") } | ||
function find_template($str) { return "path" } | ||
function file($path) { return "foo: <%= foo %>" } | ||
END | ||
end | ||
it { | ||
foo = Puppet::Pops::Types::TypeFactory.deferred.create('join', [1,2,3]) | ||
is_expected.to run.with_params('mymod/template.epp', {'foo' => foo }) #.and_return(a_kind_of Puppet::Pops::Evaluator::DeferredValue) | ||
} | ||
end | ||
end |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@joshcooper I couldn't quite get the return type here. Suggestions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Never mind. I figured out the return type and submitted an rspec-puppet PR to actually allow this matcher to work.
puppetlabs/rspec-puppet#24