Skip to content

Commit cb6e58c

Browse files
david22swandavid22swan
committed
(GH-cat-9) Update module to match current syntax standard
Module is now in compliance with the following rules: - optional_default - strict_indent - unquoted_string_in_case - parameter_documentation - relative_classname_inclusion - no-top_scope_facts-check - no-top_scope_variable-check - variable_scope The below exception has been left in place: - disable_anchor_resource
1 parent 5ce72ec commit cb6e58c

14 files changed

+129
-119
lines changed

‎.puppet-lint.rc

-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,2 @@
11
--relative
2-
--no-top_scope_facts-check
3-
--no-topscope_variable-check
4-
--no-relative_classname_inclusion-check
5-
--no-parameter_documentation-check
62
--no-anchor_resource-check
7-
--no-strict_indent-check
8-
--no-unquoted_string_in_case-check
9-
--no-optional_default-check

‎.sync.yml

-7
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,4 @@ spec/spec_helper.rb:
3333
changelog_since_tag: '5.0.1'
3434
Rakefile:
3535
extra_disabled_lint_checks:
36-
- top_scope_facts
37-
- topscope_variable
38-
- relative_classname_inclusion
39-
- parameter_documentation
4036
- anchor_resource
41-
- strict_indent
42-
- unquoted_string_in_case
43-
- optional_default

‎REFERENCE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,7 @@ Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+
605605
Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
606606
hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
607607

608-
Default value: `$::apt::keyserver`
608+
Default value: `$apt::keyserver`
609609

610610
##### <a name="weak_ssl"></a>`weak_ssl`
611611

@@ -621,7 +621,7 @@ Data type: `Optional[String]`
621621

622622
Passes additional options to `apt-key adv --keyserver-options`.
623623

624-
Default value: `$::apt::key_options`
624+
Default value: `$apt::key_options`
625625

626626
### <a name="aptmark"></a>`apt::mark`
627627

@@ -809,7 +809,7 @@ Data type: `Optional[Array[String]]`
809809

810810
Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
811811

812-
Default value: `$::apt::ppa_options`
812+
Default value: `$apt::ppa_options`
813813

814814
##### <a name="release"></a>`release`
815815

@@ -835,7 +835,7 @@ Data type: `Optional[String]`
835835

836836
Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
837837

838-
Default value: `$::apt::ppa_package`
838+
Default value: `$apt::ppa_package`
839839

840840
##### <a name="package_manage"></a>`package_manage`
841841

‎Rakefile

-8
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,7 @@ def changelog_future_release
4242
end
4343

4444
PuppetLint.configuration.send('disable_relative')
45-
PuppetLint.configuration.send('disable_top_scope_facts')
46-
PuppetLint.configuration.send('disable_topscope_variable')
47-
PuppetLint.configuration.send('disable_relative_classname_inclusion')
48-
PuppetLint.configuration.send('disable_parameter_documentation')
4945
PuppetLint.configuration.send('disable_anchor_resource')
50-
PuppetLint.configuration.send('disable_strict_indent')
51-
PuppetLint.configuration.send('disable_unquoted_string_in_case')
52-
PuppetLint.configuration.send('disable_optional_default')
53-
5446

5547
if Bundler.rubygems.find_name('github_changelog_generator').any?
5648
GitHubChangelogGenerator::RakeTask.new :changelog do |config|

‎manifests/backports.pp

+3-3
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
}
7777
}
7878
unless $location {
79-
$_location = $::apt::backports['location']
79+
$_location = $apt::backports['location']
8080
}
8181
unless $release {
8282
if fact('os.distro.codename') {
@@ -86,10 +86,10 @@
8686
}
8787
}
8888
unless $repos {
89-
$_repos = $::apt::backports['repos']
89+
$_repos = $apt::backports['repos']
9090
}
9191
unless $key {
92-
$_key = $::apt::backports['key']
92+
$_key = $apt::backports['key']
9393
}
9494

9595
if $pin =~ Hash {

‎manifests/init.pp

+34-13
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@
5555
# @option update [Integer] :tries
5656
# Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
5757
#
58+
# @param update_defaults
59+
# The default update settings that are combined and merged with the passed `update` value
60+
#
5861
# @param purge
5962
# Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
6063
#
@@ -70,9 +73,15 @@
7073
# @option purge [Boolean] :preferences.d.
7174
# Specifies whether to purge any unmanaged entries from preferences.d. Default false.
7275
#
76+
# @param purge_defaults
77+
# The default purge settings that are combined and merged with the passed `purge` value
78+
#
7379
# @param proxy
7480
# Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
7581
#
82+
# @param proxy_defaults
83+
# The default proxy settings that are combined and merged with the passed `proxy` value
84+
#
7685
# @param sources
7786
# Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
7887
#
@@ -125,6 +134,14 @@
125134
# @param sources_list_force
126135
# Specifies whether to perform force purge or delete. Default false.
127136
#
137+
# @param include_defaults
138+
#
139+
# @param apt_conf_d
140+
# The path to the file `apt.conf.d`
141+
#
142+
# @param source_key_defaults
143+
# The fault `source_key` settings
144+
#
128145
class apt (
129146
Hash $update_defaults = $apt::params::update_defaults,
130147
Hash $purge_defaults = $apt::params::purge_defaults,
@@ -183,8 +200,8 @@
183200
assert_type(Integer, $update['tries'])
184201
}
185202

186-
$_update = merge($::apt::update_defaults, $update)
187-
include ::apt::update
203+
$_update = merge($apt::update_defaults, $update)
204+
include apt::update
188205

189206
if $purge['sources.list'] {
190207
assert_type(Boolean, $purge['sources.list'])
@@ -205,24 +222,28 @@
205222
assert_type(Boolean, $purge['apt.conf.d'])
206223
}
207224

208-
$_purge = merge($::apt::purge_defaults, $purge)
225+
$_purge = merge($apt::purge_defaults, $purge)
209226

210227
if $proxy['perhost'] {
211228
$_perhost = $proxy['perhost'].map |$item| {
212229
$_item = merge($apt::proxy_defaults, $item)
213230
$_scheme = $_item['https'] ? {
214231
true => 'https',
215-
default => 'http' }
232+
default => 'http',
233+
}
216234
$_port = $_item['port'] ? {
217235
Integer => ":${_item['port']}",
218236
default => ''
219237
}
220238
$_target = $_item['direct'] ? {
221239
true => 'DIRECT',
222-
default => "${_scheme}://${_item['host']}${_port}/" }
240+
default => "${_scheme}://${_item['host']}${_port}/",
241+
}
223242
merge($item, {
224-
'scheme' => $_scheme,
225-
'target' => $_target })
243+
'scheme' => $_scheme,
244+
'target' => $_target,
245+
}
246+
)
226247
}
227248
} else {
228249
$_perhost = {}
@@ -260,7 +281,7 @@
260281
true => "# Repos managed by puppet.\n",
261282
default => undef,
262283
}
263-
}
284+
}
264285

265286
$preferences_ensure = $_purge['preferences'] ? {
266287
true => absent,
@@ -274,7 +295,7 @@
274295

275296
file { 'sources.list':
276297
ensure => $sources_list_ensure,
277-
path => $::apt::sources_list,
298+
path => $apt::sources_list,
278299
owner => root,
279300
group => root,
280301
content => $sources_list_content,
@@ -283,7 +304,7 @@
283304

284305
file { 'sources.list.d':
285306
ensure => directory,
286-
path => $::apt::sources_list_d,
307+
path => $apt::sources_list_d,
287308
owner => root,
288309
group => root,
289310
purge => $_purge['sources.list.d'],
@@ -293,15 +314,15 @@
293314

294315
file { 'preferences':
295316
ensure => $preferences_ensure,
296-
path => $::apt::preferences,
317+
path => $apt::preferences,
297318
owner => root,
298319
group => root,
299320
notify => Class['apt::update'],
300321
}
301322

302323
file { 'preferences.d':
303324
ensure => directory,
304-
path => $::apt::preferences_d,
325+
path => $apt::preferences_d,
305326
owner => root,
306327
group => root,
307328
purge => $_purge['preferences.d'],
@@ -311,7 +332,7 @@
311332

312333
file { 'apt.conf.d':
313334
ensure => directory,
314-
path => $::apt::apt_conf_d,
335+
path => $apt::apt_conf_d,
315336
owner => root,
316337
group => root,
317338
purge => $_purge['apt.conf.d'],

‎manifests/key.pp

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@
4040
Enum['present', 'absent', 'refreshed'] $ensure = present,
4141
Optional[String] $content = undef,
4242
Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]] $source = undef,
43-
Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/] $server = $::apt::keyserver,
43+
Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/] $server = $apt::keyserver,
4444
Boolean $weak_ssl = false,
45-
Optional[String] $options = $::apt::key_options,
46-
) {
45+
Optional[String] $options = $apt::key_options,
46+
) {
4747
case $ensure {
4848
/^(refreshed|present)$/: {
4949
if defined(Anchor["apt_key ${id} absent"]) {
@@ -82,7 +82,7 @@
8282
}
8383
}
8484

85-
absent: {
85+
/^absent$/: {
8686
if defined(Anchor["apt_key ${id} present"]) {
8787
fail("key with id ${id} already ensured as present")
8888
}

‎manifests/params.pp

+4-4
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@
7777

7878
case $facts['os']['name'] {
7979
'Debian': {
80-
$backports = {
81-
'location' => 'http://deb.debian.org/debian',
82-
'repos' => 'main contrib non-free',
83-
}
80+
$backports = {
81+
'location' => 'http://deb.debian.org/debian',
82+
'repos' => 'main contrib non-free',
83+
}
8484
$ppa_options = undef
8585
$ppa_package = undef
8686
$auth_conf_owner = '_apt'

‎manifests/pin.pp

+26-17
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,29 @@
3333
# @param label
3434
# Names the label of the packages in the directory tree of the Release file.
3535
#
36+
# @param origin
37+
# The package origin
38+
#
39+
# @param version
40+
# The version of the package
41+
#
42+
# @param codename
43+
# The codename of the package
44+
#
3645
define apt::pin (
37-
Enum['file', 'present', 'absent'] $ensure = present,
38-
Optional[String] $explanation = undef,
39-
Variant[Integer] $order = 50,
40-
Variant[String, Array] $packages = '*',
41-
Variant[Numeric, String] $priority = 0,
42-
Optional[String] $release = '', # a=
43-
Optional[String] $origin = '',
44-
Optional[String] $version = '',
45-
Optional[String] $codename = '', # n=
46-
Optional[String] $release_version = '', # v=
47-
Optional[String] $component = '', # c=
48-
Optional[String] $originator = '', # o=
49-
Optional[String] $label = '', # l=
46+
Enum['file', 'present', 'absent'] $ensure = present,
47+
Optional[String] $explanation = undef,
48+
Variant[Integer] $order = 50,
49+
Variant[String, Array] $packages = '*',
50+
Variant[Numeric, String] $priority = 0,
51+
Optional[String] $release = undef, # a=
52+
Optional[String] $origin = undef,
53+
Optional[String] $version = undef,
54+
Optional[String] $codename = undef, # n=
55+
Optional[String] $release_version = undef, # v=
56+
Optional[String] $component = undef, # c=
57+
Optional[String] $originator = undef, # o=
58+
Optional[String] $label = undef, # l=
5059
) {
5160
if $explanation {
5261
$_explanation = $explanation
@@ -78,15 +87,15 @@
7887
}
7988

8089
if $packages_string != '*' { # specific form
81-
if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
82-
( $version != '' and ( $pin_release != '' or $origin != '' )) {
90+
if ( $pin_release != '' and ( $origin or $version )) or
91+
( $version and ( $pin_release != '' or $origin )) {
8392
fail('parameters release, origin, and version are mutually exclusive')
8493
}
8594
} else { # general form
86-
if $version != '' {
95+
if $version {
8796
fail('parameter version cannot be used in general form')
8897
}
89-
if ( $pin_release != '' and $origin != '' ) {
98+
if ( $pin_release != '' and $origin ) {
9099
fail('parameters release and origin are mutually exclusive')
91100
}
92101
}

‎manifests/ppa.pp

+10-9
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
#
2626
define apt::ppa (
2727
String $ensure = 'present',
28-
Optional[Array[String]] $options = $::apt::ppa_options,
28+
Optional[Array[String]] $options = $apt::ppa_options,
2929
Optional[String] $release = fact('os.distro.codename'),
3030
Optional[String] $dist = $facts['os']['name'],
31-
Optional[String] $package_name = $::apt::ppa_package,
31+
Optional[String] $package_name = $apt::ppa_package,
3232
Boolean $package_manage = false,
3333
) {
3434
unless $release {
@@ -61,7 +61,7 @@
6161
$sources_list_d_filename = "${dash_filename_no_specialchars}-${release}.list"
6262

6363
if versioncmp($facts['os']['release']['full'], '15.10') >= 0 and
64-
versioncmp($facts['os']['release']['full'], '21.04') < 0 {
64+
versioncmp($facts['os']['release']['full'], '21.04') < 0 {
6565
$trusted_gpg_d_filename = "${underscore_filename_no_specialchars}.gpg"
6666
} else {
6767
$trusted_gpg_d_filename = "${dash_filename_no_specialchars}.gpg"
@@ -78,7 +78,7 @@
7878
$_require = File['sources.list.d']
7979
}
8080

81-
$_proxy = $::apt::_proxy
81+
$_proxy = $apt::_proxy
8282
if $_proxy['host'] {
8383
if $_proxy['https'] {
8484
$_proxy_env = ["http_proxy=http://${$_proxy['host']}:${$_proxy['port']}", "https_proxy=https://${$_proxy['host']}:${$_proxy['port']}"]
@@ -91,10 +91,11 @@
9191

9292
unless $sources_list_d_filename in $facts['apt_sources'] {
9393
$script_content = epp('apt/add-apt-repository.sh.epp', {
94-
command => ['/usr/bin/add-apt-repository', shell_join($options), $name],
95-
sources_list_d_path => $::apt::sources_list_d,
96-
sources_list_d_filename => $sources_list_d_filename,
97-
})
94+
command => ['/usr/bin/add-apt-repository', shell_join($options), $name],
95+
sources_list_d_path => $apt::sources_list_d,
96+
sources_list_d_filename => $sources_list_d_filename,
97+
}
98+
)
9899

99100
file { "add-apt-repository-script-${name}":
100101
ensure => 'file',
@@ -118,7 +119,7 @@
118119
}
119120

120121
tidy { "remove-apt-repository-${name}":
121-
path => "${::apt::sources_list_d}/${sources_list_d_filename}",
122+
path => "${apt::sources_list_d}/${sources_list_d_filename}",
122123
notify => Class['apt::update'],
123124
}
124125
}

0 commit comments

Comments
 (0)