Fix postgresql::default() return value for unknown parameters
#1530
Conversation
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
smortex
force-pushed
the
fix-postgresql_default
branch
2 times, most recently
from
9ce58b1 to
587e488
Compare
When calling `postgresql::default()` with a name that has no corresponding parameter, the function returns the string "postgresql::globals::<parameter-name>" which is probably not intended given the comment above the code. The usage of pick seems to indicate that an exception should be raised when a parameter is not found in `params` nor `globals.pp`, so adjust the code accordingly.
`postgresql::params` inherits from `postgresql::globals` so any variable defined in `postgresql::globals` can be accessed by reading it from `postgresql::params`, making it redundant to check both. diff --git a/functions/default.pp b/functions/default.pp index e36610b..41b5006 100644 --- a/functions/default.pp +++ b/functions/default.pp @@ -8,8 +8,7 @@ function postgresql::default( ) { include postgresql::params - #search for the variable name in params first - #then fall back to globals if not found - pick(getvar("postgresql::params::${parameter_name}"), - getvar("postgresql::globals::${parameter_name}")) + # Search for the variable name in params. + # params inherits from globals, so it will also catch these variables. + pick(getvar("postgresql::params::${parameter_name}")) }
smortex
force-pushed
the
fix-postgresql_default
branch
from
587e488 to
6cb50cb
Compare
smortex
requested review from
alexjfisher,
bastelfreak,
deric,
ekohl,
SimonHoenscheid and
a team
as code owners
bastelfreak
reviewed
Oct 11, 2023
bastelfreak
approved these changes
Oct 11, 2023
SimonHoenscheid
approved these changes
Oct 12, 2023
deric
approved these changes
Oct 12, 2023
ekohl
reviewed
Oct 12, 2023
| "postgresql::globals::${parameter_name}") | ||
| # Search for the variable name in params. | ||
| # params inherits from globals, so it will also catch these variables. | ||
| pick(getvar("postgresql::params::${parameter_name}")) |
There was a problem hiding this comment.
Late to the party, but what's the point of using pick() with a single parameter? Isn't just getvar() the same?
There was a problem hiding this comment.
getvar('nothing_here') returns undef. Since pick was already there, I assumed we wanted to have a strong failure with an exception in that case.
There was a problem hiding this comment.
I suspected that, but good to hear that explicitly.
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.
When calling
postgresql::default()with a name that has no corresponding parameter, the function returns the string "postgresql::globals::" which is probably not intended given the comment above the code.The usage of pick seems to indicate that an exception should be raised when a parameter is not found in
paramsnorglobals.pp, so adjust the code accordingly.