Skip to content

Commit e522f51

Browse files
LukasAudLukasAud
committed
Parameter documentation rule
1 parent 655ac5e commit e522f51

33 files changed

+313
-312
lines changed

Diff for: ‎.puppet-lint.rc

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
--relative
2-
--no-parameter_documentation-check
32
--no-anchor_resource-check
43
--no-params_empty_string_assignment-check

Diff for: ‎.sync.yml

-1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,5 @@ spec/spec_helper.rb:
6363
delete: true
6464
Rakefile:
6565
extra_disabled_lint_checks:
66-
- parameter_documentation
6766
- anchor_resource
6867
- params_empty_string_assignment

Diff for: ‎Rakefile

-2
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@ def changelog_future_release
4242
end
4343

4444
PuppetLint.configuration.send('disable_relative')
45-
PuppetLint.configuration.send('disable_parameter_documentation')
4645
PuppetLint.configuration.send('disable_anchor_resource')
4746
PuppetLint.configuration.send('disable_params_empty_string_assignment')
4847

49-
5048
if Bundler.rubygems.find_name('github_changelog_generator').any?
5149
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
5250
raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?

Diff for: ‎manifests/backup/pg_dump.pp

+26-26
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
# Manage creation of the backup user.
2828
# @param optional_args
2929
# Specifies an array of optional arguments which should be passed through to the backup tool. These options are not validated, unsupported options may break the backup.
30-
# @param postscript
30+
# @param post_script
3131
# One or more scripts that are executed when the backup is finished. This could be used to sync the backup to a central store.
32-
# @param prescript
32+
# @param pre_script
3333
# One or more scripts that are executed before the backup begins.
3434
# @param rotate
3535
# Backup rotation interval in 24 hour periods.
@@ -41,30 +41,30 @@
4141
# Weekdays on which the backup job should run. Defaults to `*`. This parameter is passed directly to the cron resource.
4242
#
4343
class postgresql::backup::pg_dump (
44-
String[1] $dir,
45-
Boolean $compress = true,
46-
Array $databases = [],
47-
Boolean $delete_before_dump = false,
48-
String[1] $dir_group = '0',
49-
String[1] $dir_mode = '0700',
50-
String[1] $dir_owner = 'root',
51-
Enum['present','absent'] $ensure = 'present',
52-
Enum['plain','custom','directory','tar'] $format = 'plain',
53-
Boolean $install_cron = true,
54-
Boolean $manage_user = false,
55-
Array $optional_args = [],
56-
Stdlib::Absolutepath $pgpass_path = '/root/.pgpass',
57-
Integer $rotate = 30,
58-
Stdlib::Absolutepath $script_path = '/usr/local/sbin/pg_dump.sh',
59-
Stdlib::Absolutepath $success_file_path = '/tmp/pgbackup_success',
60-
String[1] $template = 'postgresql/pg_dump.sh.epp',
61-
Array $time = ['23', '5'],
62-
String[1] $weekday = '*',
63-
Optional[Variant[String, Sensitive[String]]] $db_password = undef,
64-
Optional[String[1]] $db_user = undef,
65-
Optional[String[1]] $package_name = undef,
66-
Optional[String[1]] $post_script = undef,
67-
Optional[String[1]] $pre_script = undef,
44+
String[1] $dir,
45+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $ensure = 'present',
46+
Boolean $compress = true,
47+
Array $databases = [],
48+
Boolean $delete_before_dump = false,
49+
String[1] $dir_group = '0',
50+
String[1] $dir_mode = '0700',
51+
String[1] $dir_owner = 'root',
52+
Enum['plain','custom','directory','tar'] $format = 'plain',
53+
Boolean $install_cron = true,
54+
Boolean $manage_user = false,
55+
Array $optional_args = [],
56+
Stdlib::Absolutepath $pgpass_path = '/root/.pgpass',
57+
Integer $rotate = 30,
58+
Stdlib::Absolutepath $script_path = '/usr/local/sbin/pg_dump.sh',
59+
Stdlib::Absolutepath $success_file_path = '/tmp/pgbackup_success',
60+
String[1] $template = 'postgresql/pg_dump.sh.epp',
61+
Array $time = ['23', '5'],
62+
String[1] $weekday = '*',
63+
Optional[Variant[String, Sensitive[String]]] $db_password = undef,
64+
Optional[String[1]] $db_user = undef,
65+
Optional[String[1]] $package_name = undef,
66+
Optional[String[1]] $post_script = undef,
67+
Optional[String[1]] $pre_script = undef,
6868
) {
6969
# Install required packages
7070
if $package_name {

Diff for: ‎manifests/client.pp

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
# @param package_ensure
1313
# Ensure the client package is installed
1414
class postgresql::client (
15-
Enum['file', 'absent'] $file_ensure = 'file',
16-
Stdlib::Absolutepath $validcon_script_path = $postgresql::params::validcon_script_path,
17-
String[1] $package_name = $postgresql::params::client_package_name,
18-
Enum['present', 'absent', 'latest'] $package_ensure = 'present'
15+
Enum['file', 'absent'] $file_ensure = 'file',
16+
Stdlib::Absolutepath $validcon_script_path = $postgresql::params::validcon_script_path,
17+
String[1] $package_name = $postgresql::params::client_package_name,
18+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
1919
) inherits postgresql::params {
2020
if $package_name != 'UNSET' {
2121
package { 'postgresql-client':

Diff for: ‎manifests/dnfmodule.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77
# @api private
88
class postgresql::dnfmodule (
9-
String[1] $ensure = 'installed',
9+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $ensure = 'installed',
1010
String[1] $module = 'postgresql',
1111
) {
1212
package { 'postgresql dnf module':

Diff for: ‎manifests/globals.pp

+55-54
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
# Whether to manage the postgresql conf file permissions. This means owner,
8282
# group and mode. Contents are not managed but should be managed through
8383
# postgresql::server::config_entry.
84+
# @param manage_selinux Allows Puppet to manage the appropriate configuration file for selinux.
8485
#
8586
# @param manage_datadir Set to false if you have file{ $datadir: } already defined
8687
# @param manage_logdir Set to false if you have file{ $logdir: } already defined
@@ -95,72 +96,72 @@
9596
#
9697
#
9798
class postgresql::globals (
98-
Optional[String[1]] $client_package_name = undef,
99-
Optional[String[1]] $server_package_name = undef,
100-
Optional[String[1]] $contrib_package_name = undef,
101-
Optional[String[1]] $devel_package_name = undef,
102-
Optional[String[1]] $java_package_name = undef,
103-
Optional[String[1]] $docs_package_name = undef,
104-
Optional[String[1]] $perl_package_name = undef,
105-
Optional[String[1]] $plperl_package_name = undef,
106-
Optional[String[1]] $plpython_package_name = undef,
107-
Optional[String[1]] $python_package_name = undef,
108-
Optional[String[1]] $postgis_package_name = undef,
99+
Optional[String[1]] $client_package_name = undef,
100+
Optional[String[1]] $server_package_name = undef,
101+
Optional[String[1]] $contrib_package_name = undef,
102+
Optional[String[1]] $devel_package_name = undef,
103+
Optional[String[1]] $java_package_name = undef,
104+
Optional[String[1]] $docs_package_name = undef,
105+
Optional[String[1]] $perl_package_name = undef,
106+
Optional[String[1]] $plperl_package_name = undef,
107+
Optional[String[1]] $plpython_package_name = undef,
108+
Optional[String[1]] $python_package_name = undef,
109+
Optional[String[1]] $postgis_package_name = undef,
109110

110-
Optional[String[1]] $service_name = undef,
111-
Optional[String[1]] $service_provider = undef,
112-
Optional[String[1]] $service_status = undef,
113-
Optional[String[1]] $default_database = undef,
111+
Optional[String[1]] $service_name = undef,
112+
Optional[String[1]] $service_provider = undef,
113+
Optional[String[1]] $service_status = undef,
114+
Optional[String[1]] $default_database = undef,
114115

115-
Optional[String[1]] $validcon_script_path = undef,
116+
Optional[String[1]] $validcon_script_path = undef,
116117

117-
Optional[String[1]] $initdb_path = undef,
118-
Optional[String[1]] $createdb_path = undef,
119-
Optional[String[1]] $psql_path = undef,
120-
Optional[String[1]] $pg_hba_conf_path = undef,
121-
Optional[String[1]] $pg_ident_conf_path = undef,
122-
Optional[String[1]] $postgresql_conf_path = undef,
123-
Optional[Stdlib::Filemode] $postgresql_conf_mode = undef,
124-
Optional[String[1]] $recovery_conf_path = undef,
125-
Hash $default_connect_settings = {},
118+
Optional[Variant[String[1], Stdlib::Absolutepath]] $initdb_path = undef,
119+
Optional[Variant[String[1], Stdlib::Absolutepath]] $createdb_path = undef,
120+
Optional[Variant[String[1], Stdlib::Absolutepath]] $psql_path = undef,
121+
Optional[Variant[String[1], Stdlib::Absolutepath]] $pg_hba_conf_path = undef,
122+
Optional[Variant[String[1], Stdlib::Absolutepath]] $pg_ident_conf_path = undef,
123+
Optional[Variant[String[1], Stdlib::Absolutepath]] $postgresql_conf_path = undef,
124+
Optional[Stdlib::Filemode] $postgresql_conf_mode = undef,
125+
Optional[Variant[String[1], Stdlib::Absolutepath]] $recovery_conf_path = undef,
126+
Hash $default_connect_settings = {},
126127

127-
Optional[Boolean] $pg_hba_conf_defaults = undef,
128+
Optional[Boolean] $pg_hba_conf_defaults = undef,
128129

129-
Optional[String[1]] $datadir = undef,
130-
Optional[String[1]] $confdir = undef,
131-
Optional[String[1]] $bindir = undef,
132-
Optional[String[1]] $xlogdir = undef,
133-
Optional[String[1]] $logdir = undef,
134-
Optional[String[1]] $log_line_prefix = undef,
135-
Optional[Boolean] $manage_datadir = undef,
136-
Optional[Boolean] $manage_logdir = undef,
137-
Optional[Boolean] $manage_xlogdir = undef,
130+
Optional[String[1]] $datadir = undef,
131+
Optional[String[1]] $confdir = undef,
132+
Optional[String[1]] $bindir = undef,
133+
Optional[String[1]] $xlogdir = undef,
134+
Optional[String[1]] $logdir = undef,
135+
Optional[String[1]] $log_line_prefix = undef,
136+
Optional[Boolean] $manage_datadir = undef,
137+
Optional[Boolean] $manage_logdir = undef,
138+
Optional[Boolean] $manage_xlogdir = undef,
138139

139-
Optional[String[1]] $user = undef,
140-
Optional[String[1]] $group = undef,
140+
Optional[String[1]] $user = undef,
141+
Optional[String[1]] $group = undef,
141142

142-
Optional[String[1]] $version = undef,
143-
Optional[String[1]] $postgis_version = undef,
144-
Optional[String[1]] $repo_proxy = undef,
145-
Optional[String[1]] $repo_baseurl = undef,
146-
Optional[String[1]] $yum_repo_commonurl = undef,
143+
Optional[String[1]] $version = undef,
144+
Optional[String[1]] $postgis_version = undef,
145+
Optional[String[1]] $repo_proxy = undef,
146+
Optional[String[1]] $repo_baseurl = undef,
147+
Optional[String[1]] $yum_repo_commonurl = undef,
147148

148-
Optional[Boolean] $needs_initdb = undef,
149+
Optional[Boolean] $needs_initdb = undef,
149150

150-
Optional[String[1]] $encoding = undef,
151-
Optional[String[1]] $locale = undef,
152-
Optional[String[1]] $data_checksums = undef,
153-
Optional[String[1]] $timezone = undef,
151+
Optional[String[1]] $encoding = undef,
152+
Optional[String[1]] $locale = undef,
153+
Optional[String[1]] $data_checksums = undef,
154+
Optional[String[1]] $timezone = undef,
154155

155-
Optional[Boolean] $manage_pg_hba_conf = undef,
156-
Optional[Boolean] $manage_pg_ident_conf = undef,
157-
Optional[Boolean] $manage_recovery_conf = undef,
158-
Optional[Boolean] $manage_postgresql_conf_perms = undef,
159-
Optional[Boolean] $manage_selinux = undef,
156+
Optional[Boolean] $manage_pg_hba_conf = undef,
157+
Optional[Boolean] $manage_pg_ident_conf = undef,
158+
Optional[Boolean] $manage_recovery_conf = undef,
159+
Optional[Boolean] $manage_postgresql_conf_perms = undef,
160+
Optional[Boolean] $manage_selinux = undef,
160161

161-
Optional[Boolean] $manage_package_repo = undef,
162+
Optional[Boolean] $manage_package_repo = undef,
162163
Boolean $manage_dnf_module = false,
163-
Optional[String[1]] $module_workdir = undef,
164+
Optional[String[1]] $module_workdir = undef,
164165
) {
165166
# We are determining this here, because it is needed by the package repo
166167
# class.

Diff for: ‎manifests/lib/devel.pp

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
#
1010
#
1111
class postgresql::lib::devel (
12-
String $package_name = $postgresql::params::devel_package_name,
13-
Enum['present', 'absent', 'latest'] $package_ensure = 'present',
14-
Boolean $link_pg_config = $postgresql::params::link_pg_config
12+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
13+
String $package_name = $postgresql::params::devel_package_name,
14+
Boolean $link_pg_config = $postgresql::params::link_pg_config,
1515
) inherits postgresql::params {
1616
if $facts['os']['family'] == 'Gentoo' {
1717
fail('osfamily Gentoo does not have a separate "devel" package, postgresql::lib::devel is not supported')

Diff for: ‎manifests/lib/docs.pp

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
#
1111
#
1212
class postgresql::lib::docs (
13-
String $package_name = $postgresql::params::docs_package_name,
14-
Enum['present', 'absent', 'latest'] $package_ensure = 'present',
13+
String $package_name = $postgresql::params::docs_package_name,
14+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
1515
) inherits postgresql::params {
1616
package { 'postgresql-docs':
1717
ensure => $package_ensure,

Diff for: ‎manifests/lib/java.pp

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# Specifies whether the package is present.
1010
#
1111
class postgresql::lib::java (
12-
String $package_name = $postgresql::params::java_package_name,
13-
Enum['present', 'absent', 'latest'] $package_ensure = 'present'
12+
String $package_name = $postgresql::params::java_package_name,
13+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
1414
) inherits postgresql::params {
1515
package { 'postgresql-jdbc':
1616
ensure => $package_ensure,

Diff for: ‎manifests/lib/perl.pp

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
# Ensure the perl libs for postgresql are installed.
77
#
88
class postgresql::lib::perl (
9-
String $package_name = $postgresql::params::perl_package_name,
10-
Enum['present', 'absent', 'latest'] $package_ensure = 'present'
9+
String $package_name = $postgresql::params::perl_package_name,
10+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
1111
) inherits postgresql::params {
1212
package { 'perl-DBD-Pg':
1313
ensure => $package_ensure,

Diff for: ‎manifests/lib/python.pp

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
# Ensure the python libs for postgresql are installed.
77
#
88
class postgresql::lib::python (
9-
String[1] $package_name = $postgresql::params::python_package_name,
10-
Enum['present', 'absent', 'latest'] $package_ensure = 'present'
9+
String[1] $package_name = $postgresql::params::python_package_name,
10+
Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]] $package_ensure = 'present',
1111
) inherits postgresql::params {
1212
package { 'python-psycopg2':
1313
ensure => $package_ensure,

0 commit comments

Comments
 (0)