lint fixes and params validation

example42 · Sep 24, 2024 · 179b67a · 179b67a
1 parent 83b2fd2
commit 179b67a
Show file tree

Hide file tree

Showing 44 changed files with 1,058 additions and 1,166 deletions.
diff --git a/.puppet-lint.rc b/.puppet-lint.rc
@@ -1 +1,2 @@
 --relative
+--ignore-lint-parameter_documentation
diff --git a/manifests/check.pp b/manifests/check.pp
@@ -13,13 +13,13 @@
 # :include:../README.check
 #
 define puppi::check (
-  $command,
-  $base_dir = '',
-  $hostwide = 'no',
-  $priority = '50',
-  $project  = 'default',
-  $enable   = true ) {
-
+  String $command,
+  String $base_dir = '',
+  String $hostwide = 'no',
+  Variant[String,Integer] $priority  = '50',
+  String $project  = 'default',
+  Boolean $enable  = true,
+) {
   require puppi
   require puppi::params
 
@@ -46,5 +46,4 @@
     content => "${real_base_dir}/${command}\n",
     tag     => 'puppi_check',
   }
-
 }
diff --git a/manifests/configure.pp b/manifests/configure.pp
@@ -14,13 +14,13 @@
 # :include:../README.deploy
 #
 define puppi::configure (
-  $command,
-  $project,
-  $arguments = '',
-  $priority  = '50',
-  $user      = 'root',
-  $enable    = true ) {
-
+  String $command,
+  String $project,
+  String $arguments = '',
+  Variant[String,Integer] $priority  = '50',
+  String $user      = 'root',
+  Boolean $enable   = true,
+) {
   require puppi
   require puppi::params
 
@@ -35,6 +35,4 @@
     content => "su - ${user} -c \"export project=${project} && ${puppi::params::scriptsdir}/${command} ${arguments}\"\n",
     tag     => 'puppi_deploy',
   }
-
 }
-
diff --git a/manifests/dependencies.pp b/manifests/dependencies.pp
@@ -8,7 +8,6 @@
 #   install_dependencies => false
 #
 class puppi::dependencies {
-
   require puppi::params
 
   if ! defined(Package['curl']) {
@@ -34,5 +33,4 @@
   if ! defined(Package[$puppi::params::package_mail]) {
     package { $puppi::params::package_mail : ensure => present }
   }
-
 }
diff --git a/manifests/deploy.pp b/manifests/deploy.pp
@@ -14,13 +14,13 @@
 # :include:../README.deploy
 #
 define puppi::deploy (
-  $command,
-  $project,
-  $arguments = '',
-  $priority  = '50',
-  $user      = 'root',
-  $enable    = true ) {
-
+  String $command,
+  String $project,
+  String $arguments = '',
+  Variant[String,Integer] $priority  = '50',
+  String $user      = 'root',
+  Boolean $enable   = true,
+) {
   require puppi
   require puppi::params
 
@@ -35,6 +35,4 @@
     content => "su - ${user} -c \"export project=${project} && ${puppi::params::scriptsdir}/${command} ${arguments}\"\n",
     tag     => 'puppi_deploy',
   }
-
 }
-
diff --git a/manifests/extras.pp b/manifests/extras.pp
@@ -7,7 +7,6 @@
 #   extra_class=> 'example42::puppi::extras',
 #
 class puppi::extras {
-
   # Default Checks
 
   puppi::check { 'NTP_Sync':
@@ -52,64 +51,63 @@
     hostwide => 'yes' ,
   }
 
-
   # Info Pages
-  $network_run = $::os['name'] ? {
-    'Solaris' => [ 'ifconfig -a' , 'netstat -nr' , 'cat /etc/resolv.conf' , 'arp -an' , 'netstat -na' ],
-    default   => [ 'ifconfig' , 'route -n' , 'cat /etc/resolv.conf' , 'arp -an' , 'netstat -natup | grep LISTEN' ],
+  $network_run = $facts['os']['name'] ? {
+    'Solaris' => ['ifconfig -a' , 'netstat -nr' , 'cat /etc/resolv.conf' , 'arp -an' , 'netstat -na'],
+    default   => ['ifconfig' , 'route -n' , 'cat /etc/resolv.conf' , 'arp -an' , 'netstat -natup | grep LISTEN'],
   }
 
   puppi::info { 'network':
     description => 'Network settings and stats' ,
     run         => $network_run,
   }
 
-  $users_run = $::os['name'] ? {
-    'Solaris' => [ 'who' , 'last' ],
-    default   => [ 'who' , 'last' , 'LANG=C lastlog | grep -v \'Never logged in\'' ],
+  $users_run = $facts['os']['name'] ? {
+    'Solaris' => ['who' , 'last'],
+    default   => ['who' , 'last' , 'LANG=C lastlog | grep -v \'Never logged in\''],
   }
 
   puppi::info { 'users':
     description => 'Users and logins information' ,
     run         => $users_run,
   }
 
-  $perf_run = $::os['name'] ? {
-    'Solaris' => [ 'uptime' , 'vmstat 1 5' ],
-    default   => [ 'uptime' , 'free' , 'vmstat 1 5' ],
+  $perf_run = $facts['os']['name'] ? {
+    'Solaris' => ['uptime' , 'vmstat 1 5'],
+    default   => ['uptime' , 'free' , 'vmstat 1 5'],
   }
 
   puppi::info { 'perf':
     description => 'System performances and resources utilization' ,
     run         => $perf_run,
   }
 
-  $disks_run = $::os['name'] ? {
-    'Solaris' => [ 'df -h' , 'mount' ],
-    default   => [ 'df -h' , 'mount' , 'blkid' , 'fdisk -l' ],
+  $disks_run = $facts['os']['name'] ? {
+    'Solaris' => ['df -h' , 'mount'],
+    default   => ['df -h' , 'mount' , 'blkid' , 'fdisk -l'],
   }
 
   puppi::info { 'disks':
     description => 'Disks and filesystem information' ,
     run         => $disks_run,
   }
 
-  $hardware_run = $::os['name'] ? {
-    'Solaris' => [ 'find /devices/' ],
-    default   => [ 'lspci' , 'cat /proc/cpuinfo' ],
+  $hardware_run = $facts['os']['name'] ? {
+    'Solaris' => ['find /devices/'],
+    default   => ['lspci' , 'cat /proc/cpuinfo'],
   }
 
   puppi::info { 'hardware':
     description => 'Hardware information' ,
     run         => $hardware_run,
   }
 
-  $packages_run = $::os['name'] ? {
-    /(?i:RedHat|CentOS|Scientific|Amazon|Linux)/ => [ 'yum repolist' , 'rpm -qa' ] ,
-    /(?i:Debian|Ubuntu|Mint)/                    => [ 'apt-config dump' , 'apt-cache stats' , 'apt-key list' , 'dpkg -l' ],
-    /(Solaris)/                                  => [ 'pkginfo' ],
-    /(Archlinux)/                                => [ 'pacman -Qet' ],
-    default                                      => [ 'echo' ],
+  $packages_run = $facts['os']['name'] ? {
+    /(?i:RedHat|CentOS|Scientific|Amazon|Linux)/ => ['yum repolist' , 'rpm -qa'],
+    /(?i:Debian|Ubuntu|Mint)/                    => ['apt-config dump' , 'apt-cache stats' , 'apt-key list' , 'dpkg -l'],
+    /(Solaris)/                                  => ['pkginfo'],
+    /(Archlinux)/                                => ['pacman -Qet'],
+    default                                      => ['echo'],
   }
 
   puppi::info { 'packages':
@@ -128,8 +126,7 @@
   }
 
   ### Default Logs
-  case $::os['family'] {
-
+  case $facts['os']['family'] {
     'Debian': {
       puppi::log { 'system':
         description => 'General System Messages',
@@ -201,8 +198,6 @@
       }
     }
 
-    default: { }
-
+    default: {}
   }
-
 }
diff --git a/manifests/helper.pp b/manifests/helper.pp
@@ -11,9 +11,9 @@
 # }
 #
 define puppi::helper (
-  $template,
-  $ensure = 'present' ) {
-
+  String $template,
+  String $ensure = 'present',
+) {
   require puppi
   require puppi::params
 
@@ -25,5 +25,4 @@
     group   => $puppi::params::configfile_group,
     content => template($template),
   }
-
 }
diff --git a/manifests/helpers.pp b/manifests/helpers.pp
@@ -7,10 +7,8 @@
 # Automatically included by Puppi
 #
 class puppi::helpers {
-
   # Standard helper for Example42 modules
   puppi::helper { 'standard':
     template => 'puppi/helpers/standard.yml.erb',
   }
-
 }
diff --git a/manifests/info.pp b/manifests/info.pp
@@ -18,10 +18,10 @@
 # :include:../README.info
 #
 define puppi::info (
-  $description  = '',
-  $templatefile = 'puppi/info.erb',
-  $run          = '' ) {
-
+  String $description  = '',
+  String $templatefile = 'puppi/info.erb',
+  String $run          = '',
+) {
   require puppi
   require puppi::params
 
@@ -34,13 +34,12 @@
   }
 
   file { "${puppi::params::infodir}/${name}":
-    ensure  => present,
+    ensure  => file,
     mode    => '0750',
     owner   => $puppi::params::configfile_owner,
     group   => $puppi::params::configfile_group,
     require => Class['puppi'],
     content => template($templatefile),
     tag     => 'puppi_info',
   }
-
 }
diff --git a/manifests/info/instance.pp b/manifests/info/instance.pp
@@ -3,31 +3,30 @@
 # This is a puppi info plugin specific for the tomcat::instance define
 #
 define puppi::info::instance (
-  $servicename  = '',
-  $processname  = '',
-  $configdir    = '',
-  $bindir       = '',
-  $pidfile      = '',
-  $datadir      = '',
-  $logdir       = '',
-  $httpport     = '',
-  $controlport  = '',
-  $ajpport      = '',
-  $description  = '',
-  $run          = '',
-  $verbose      = 'no',
-  $templatefile = 'puppi/info/instance.erb' ) {
-
+  String $servicename  = '',
+  String $processname  = '',
+  String $configdir    = '',
+  String $bindir       = '',
+  String $pidfile      = '',
+  String $datadir      = '',
+  String $logdir       = '',
+  Variant[String,Integer] $httpport     = '',
+  Variant[String,Integer] $controlport  = '',
+  Variant[String,Integer] $ajpport      = '',
+  String $description  = '',
+  String $run          = '',
+  String $verbose      = 'no',
+  String $templatefile = 'puppi/info/instance.erb',
+) {
   require puppi
   require puppi::params
 
   file { "${puppi::params::infodir}/${name}":
-    ensure  => present,
+    ensure  => file,
     mode    => '0750',
     owner   => $puppi::params::configfile_owner,
     group   => $puppi::params::configfile_group,
     content => template($templatefile),
     tag     => 'puppi_info',
   }
-
 }
diff --git a/manifests/info/module.pp b/manifests/info/module.pp
@@ -26,34 +26,33 @@
 #  }
 #
 define puppi::info::module (
-  $packagename    = '',
-  $servicename    = '',
-  $processname    = '',
-  $configfile     = '',
-  $configdir      = '',
-  $initconfigfile = '',
-  $pidfile        = '',
-  $datadir        = '',
-  $logfile        = '',
-  $logdir         = '',
-  $protocol       = '',
-  $port           = '',
-  $description    = '',
-  $run            = '',
-  $verbose        = 'no',
-  $templatefile   = 'puppi/info/module.erb' ) {
-
+  String $packagename    = '',
+  String $servicename    = '',
+  String $processname    = '',
+  String $configfile     = '',
+  String $configdir      = '',
+  String $initconfigfile = '',
+  String $pidfile        = '',
+  String $datadir        = '',
+  String $logfile        = '',
+  String $logdir         = '',
+  String $protocol       = '',
+  Variant[String,Integer] $port = '',
+  String $description    = '',
+  String $run            = '',
+  String $verbose        = 'no',
+  String $templatefile   = 'puppi/info/module.erb',
+) {
   require puppi
   require puppi::params
 
   file { "${puppi::params::infodir}/${name}":
-    ensure  => present,
+    ensure  => file,
     mode    => '0750',
     owner   => $puppi::params::configfile_owner,
     group   => $puppi::params::configfile_group,
     require => Class['puppi'],
     content => template($templatefile),
     tag     => 'puppi_info',
   }
-
 }