Eliminate params.pp and create_resources()
#1172
Merged
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
kenyon
commented
Apr 9, 2024
kenyon
commented
- init: trim trailing whitespace
- init, source: improve hash formatting
- eliminate params.pp and create_resources()
- regenerate REFERENCE.md
The $auth_conf_tmp line should be multiple lines for readability and easier to read diffs when changes occur. Double-indented blocks look wrong. Placing the opening bracket on its own line fixes this.
Merged
kenyon
force-pushed
the
modernization
branch
3 times, most recently
from
3044a63 to
cb843a2
Compare
params.pp and create_resources() are obsolete. This module was converted to non-params.pp style puppetlabs#667, but was reverted in puppetlabs#680. Using Hiera in modules and no params.pp are the preferred styles these days.
smortex
approved these changes
Apr 9, 2024
Comment on lines
+152
to
+176
| Hash $update_defaults = { | ||
| 'frequency' => 'reluctantly', | ||
| 'loglevel' => undef, | ||
| 'timeout' => undef, | ||
| 'tries' => undef, | ||
| }, | ||
| Hash $purge_defaults = { | ||
| 'sources.list' => false, | ||
| 'sources.list.d' => false, | ||
| 'preferences' => false, | ||
| 'preferences.d' => false, | ||
| 'apt.conf.d' => false, | ||
| }, | ||
| Hash $proxy_defaults = { | ||
| 'ensure' => undef, | ||
| 'host' => undef, | ||
| 'port' => 8080, | ||
| 'https' => false, | ||
| 'https_acng' => false, | ||
| 'direct' => false, | ||
| }, | ||
| Hash $include_defaults = { | ||
| 'deb' => true, | ||
| 'src' => false, | ||
| }, |
There was a problem hiding this comment.
Instead of Hash maybe we can have custom types which Struct to validate both keys and values?
E.g. something like (untested):
# types/include.pp
type Apt::Include = Struct[
Optional[deb] => Boolean,
Optional[src] => Boolean,
]# manifests/init.pp
Apt::Include $include_defaults = {
'deb' => true,
'src' => false,
},| 'deb' => true, | ||
| 'src' => false, | ||
| }, | ||
| String $provider = '/usr/bin/apt-get', |
There was a problem hiding this comment.
Stdlib::Absolutepath might be more suitable (some more bellow)
| String $provider = '/usr/bin/apt-get', | ||
| String $keyserver = 'keyserver.ubuntu.com', | ||
| Optional[String] $key_options = undef, | ||
| Optional[Array[String]] $ppa_options = undef, |
There was a problem hiding this comment.
It is generally more simple to have these parameters as:
Suggested change
| Optional[Array[String]] $ppa_options = undef, | |
| Array[String] $ppa_options = [], |
| 'src' => false, | ||
| }, | ||
| String $provider = '/usr/bin/apt-get', | ||
| String $keyserver = 'keyserver.ubuntu.com', |
There was a problem hiding this comment.
Empty string is an error, so we can set a lower bound.
Suggested change
| String $keyserver = 'keyserver.ubuntu.com', | |
| String[1] $keyserver = 'keyserver.ubuntu.com', |
4 tasks
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.