Merge pull request #536 from puppetlabs/CONT-353-Syntax_update

(CONT-353) Syntax update
puppetlabs · Jan 24, 2023 · 95ca912 · 95ca912
2 parents 9fbf4e6 + b882759
commit 95ca912
Show file tree

Hide file tree

Showing 40 changed files with 311 additions and 275 deletions.
diff --git a/.puppet-lint.rc b/.puppet-lint.rc
@@ -1,8 +1 @@
 --relative
---no-top_scope_facts-check
---no-parameter_types-check
---no-relative_classname_inclusion-check
---no-parameter_documentation-check
---no-legacy_facts-check
---no-anchor_resource-check
---no-topscope_variable-check
diff --git a/.sync.yml b/.sync.yml
@@ -34,12 +34,3 @@ spec/spec_helper.rb:
   unmanaged: false
 .travis.yml:
   delete: true
-Rakefile:
-  extra_disabled_lint_checks:
-    - top_scope_facts
-    - parameter_types
-    - relative_classname_inclusion
-    - parameter_documentation
-    - legacy_facts
-    - anchor_resource
-    - topscope_variable
diff --git a/Rakefile b/Rakefile
@@ -42,14 +42,6 @@ def changelog_future_release
 end
 
 PuppetLint.configuration.send('disable_relative')
-PuppetLint.configuration.send('disable_top_scope_facts')
-PuppetLint.configuration.send('disable_parameter_types')
-PuppetLint.configuration.send('disable_relative_classname_inclusion')
-PuppetLint.configuration.send('disable_parameter_documentation')
-PuppetLint.configuration.send('disable_legacy_facts')
-PuppetLint.configuration.send('disable_anchor_resource')
-PuppetLint.configuration.send('disable_topscope_variable')
-
 
 if Bundler.rubygems.find_name('github_changelog_generator').any?
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|

diff --git a/examples/init.pp b/examples/init.pp
@@ -1,8 +1,8 @@
 # Declare haproxy base class with configuration options
-class { '::haproxy':
+class { 'haproxy':
   enable           => true,
   global_options   => {
-    'log'     => "${::ipaddress} local0",
+    'log'     => "${$facts['networking']['ip']} local0",
     'chroot'  => '/var/lib/haproxy',
     'pidfile' => '/var/run/haproxy.pid',
     'maxconn' => '4000',
@@ -33,8 +33,8 @@
 @@haproxy::balancermember { $fqdn:
   order                  => '21',
   listening_service      => 'puppet00',
-  server_name            => $::hostname,
-  balancer_ip            => $::ipaddress,
+  server_name            => $facts['networking']['hostname'],
+  balancer_ip            => $facts['networking']['ip'],
   balancer_port          => '8140',
   balancermember_options => 'check',
 }
@@ -45,7 +45,7 @@
 #  Haproxy::Balancermember <<| listening_service == $name |>>
 haproxy::listen { 'puppet00':
   order     => '20',
-  ipaddress => $::ipaddress,
+  ipaddress => $facts['networking']['ip'],
   ports     => '18140',
   options   => {
     'option'  => [

diff --git a/manifests/backend.pp b/manifests/backend.pp
@@ -70,17 +70,17 @@
 # Jeremy Kitchen <jeremy@nationbuilder.com>
 #
 define haproxy::backend (
-  $mode                    = undef,
-  $collect_exported        = true,
-  $options                 = {
+  Optional[Enum['tcp', 'http', 'health']] $mode                     = undef,
+  Boolean                                 $collect_exported         = true,
+  Variant[Hash, Array[Hash]]              $options                  = {
     'balance' => 'roundrobin',
   },
-  $instance                = 'haproxy',
-  $section_name            = $name,
-  $sort_options_alphabetic = undef,
-  $description             = undef,
-  $defaults                = undef,
-  Optional[Stdlib::Absolutepath] $config_file             = undef,
+  String                                  $instance                 = 'haproxy',
+  String[1]                               $section_name             = $name,
+  Boolean                                 $sort_options_alphabetic  = true,
+  Optional[String]                        $description              = undef,
+  Optional[String]                        $defaults                 = undef,
+  Optional[Stdlib::Absolutepath]          $config_file              = undef,
 ) {
   if defined(Haproxy::Listen[$section_name]) {
     fail("An haproxy::listen resource was discovered with the same name (${section_name}) which is not supported")

diff --git a/manifests/balancermember.pp b/manifests/balancermember.pp
@@ -135,24 +135,24 @@
 #  (this resource can be declared anywhere)
 #
 define haproxy::balancermember (
-  $listening_service,
-  Enum['server', 'default-server', 'server-template'] $type         = 'server',
-  $ports        = undef,
-  $port         = undef,
-  $server_names = $::hostname,
-  $ipaddresses  = $::ipaddress,
-  $prefix       = 'server',
-  $amount       = '1',
-  $fqdn         = '',
-  $options      = '',
-  $define_cookies = false,
-  $instance     = 'haproxy',
-  $defaults     = undef,
-  Optional[Stdlib::Absolutepath] $config_file  = undef,
-  $verifyhost   = false,
-  $weight       = undef,
+  String                                              $listening_service,
+  Enum['server', 'default-server', 'server-template'] $type               = 'server',
+  Optional[Variant[Array, String]]                    $ports              = undef,
+  Optional[Variant[String]]                           $port               = undef,
+  Variant[String[1], Array]                           $server_names       = $hostname,
+  Variant[String, Array]                              $ipaddresses        = $ipaddress,
+  String                                              $prefix             = 'server',
+  String                                              $amount             = '1',
+  Optional[String]                                    $fqdn               = undef,
+  Optional[Variant[String, Array]]                    $options            = undef,
+  Boolean                                             $define_cookies     = false,
+  String                                              $instance           = 'haproxy',
+  Optional[String]                                    $defaults           = undef,
+  Optional[Stdlib::Absolutepath]                      $config_file        = undef,
+  Boolean                                             $verifyhost         = false,
+  Optional[Variant[String, Integer]]                  $weight             = undef,
 ) {
-  include ::haproxy::params
+  include haproxy::params
 
   if $instance == 'haproxy' {
     $instance_name = 'haproxy'

diff --git a/manifests/config.pp b/manifests/config.pp
@@ -3,16 +3,16 @@
 # @api private
 define haproxy::config (
   # lint:ignore:140chars
-  $instance_name,
-  $config_file,
-  $global_options,
-  $defaults_options,
-  $package_ensure,
-  $chroot_dir_manage,
-  $config_dir = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
-  $custom_fragment = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
-  $merge_options = $haproxy::merge_options,
-  $config_validate_cmd = $haproxy::config_validate_cmd,
+  String                                $instance_name,
+  Stdlib::Absolutepath                  $config_file,
+  Hash                                  $global_options,
+  Hash                                  $defaults_options,
+  String[1]                             $package_ensure,
+  Boolean                               $chroot_dir_manage,
+  Stdlib::Absolutepath                  $config_dir = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
+  Optional[String]                      $custom_fragment = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed. << Update 15/12/22 This still needs a default.
+  Boolean                               $merge_options = $haproxy::merge_options,
+  Variant[Stdlib::Absolutepath, String] $config_validate_cmd = $haproxy::config_validate_cmd,
   # lint:endignore
 ) {
   if $caller_module_name != $module_name {
@@ -59,12 +59,8 @@
       mode  => '0640',
     }
 
-    # validate_cmd introduced in Puppet 3.5
-    if ((!defined('$::puppetversion') or (versioncmp($::puppetversion, '3.5') >= 0)) and
-    (!defined('$::serverversion') or versioncmp($::serverversion, '3.5') >= 0)) {
-      Concat[$_config_file] {
-        validate_cmd => $config_validate_cmd,
-      }
+    Concat[$_config_file] {
+      validate_cmd => $config_validate_cmd,
     }
 
     # Simple Header

diff --git a/manifests/defaults.pp b/manifests/defaults.pp
@@ -20,20 +20,20 @@
 #   Optional. Defaults to 'haproxy'.
 #
 define haproxy::defaults (
-  $options                 = {},
-  $sort_options_alphabetic = undef,
-  $instance                = 'haproxy',
+  Hash    $options                  = {},
+  Boolean $sort_options_alphabetic  = true,
+  String  $instance                 = 'haproxy',
 ) {
   if $instance == 'haproxy' {
-    include ::haproxy
+    include haproxy
     $instance_name = 'haproxy'
     $config_file = $haproxy::config_file
   } else {
-    include ::haproxy::params
+    include haproxy::params
     $instance_name = "haproxy-${instance}"
     $config_file = inline_template($haproxy::params::config_file_tmpl)
   }
-  include ::haproxy::globals
+  include haproxy::globals
   $_sort_options_alphabetic = pick($sort_options_alphabetic, $haproxy::globals::sort_options_alphabetic)
 
   concat::fragment { "${instance_name}-${name}_defaults_block":

diff --git a/manifests/frontend.pp b/manifests/frontend.pp
@@ -91,25 +91,25 @@
 # Gary Larizza <gary@puppetlabs.com>
 #
 define haproxy::frontend (
-  $ports                                       = undef,
-  $ipaddress                                   = undef,
-  Optional[Hash] $bind                         = undef,
-  $mode                                        = undef,
-  $collect_exported                            = true,
-  $options                                     = {
-    'option'                                  => [
+  Optional[Variant[Array, String]]        $ports                    = undef,
+  Optional[Variant[String, Array]]        $ipaddress                = undef,
+  Optional[Hash]                          $bind                     = undef,
+  Optional[Enum['tcp', 'http', 'health']] $mode                     = undef,
+  Boolean                                 $collect_exported         = true,
+  Variant[Hash, Array[Hash]]              $options                  = {
+    'option'                                    => [
       'tcplog',
     ],
   },
-  $instance                                    = 'haproxy',
-  $section_name                                = $name,
-  $sort_options_alphabetic                     = undef,
-  $description                                 = undef,
-  $defaults                                    = undef,
-  $defaults_use_backend                        = true,
-  Optional[Stdlib::Absolutepath] $config_file  = undef,
+  String                                  $instance                 = 'haproxy',
+  String[1]                               $section_name             = $name,
+  Boolean                                 $sort_options_alphabetic  = true,
+  Optional[String]                        $description              = undef,
+  Optional[String]                        $defaults                 = undef,
+  Boolean                                 $defaults_use_backend     = true,
+  Optional[Stdlib::Absolutepath]          $config_file              = undef,
   # Deprecated
-  $bind_options                                = '',
+  Optional[Array]                         $bind_options             = undef,
 ) {
   if $ports and $bind {
     fail('The use of $ports and $bind is mutually exclusive, please choose either one')
@@ -121,7 +121,7 @@
     warning('The $bind_options parameter is deprecated; please use $bind instead')
   }
 
-  include ::haproxy::params
+  include haproxy::params
 
   if $instance == 'haproxy' {
     $instance_name = 'haproxy'

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -120,27 +120,27 @@
 #  }
 #
 class haproxy (
-  String[1] $package_ensure                                    = 'present',
-  String $package_name                                         = $haproxy::params::package_name,
-  Variant[Enum['running', 'stopped'], Boolean] $service_ensure = 'running',
-  Boolean $service_manage                                      = true,
-  Boolean $chroot_dir_manage                                   = true,
-  String $service_name                                         = $haproxy::params::service_name,
-  String $service_options                                      = $haproxy::params::service_options,
-  $sysconfig_options                                           = $haproxy::params::sysconfig_options,
-  Hash $global_options                                         = $haproxy::params::global_options,
-  Hash $defaults_options                                       = $haproxy::params::defaults_options,
-  Boolean $merge_options                                       = $haproxy::params::merge_options,
-  $restart_command                                             = undef,
-  $custom_fragment                                             = undef,
-  Stdlib::Absolutepath $config_dir                             = $haproxy::params::config_dir,
-  Optional[Stdlib::Absolutepath] $config_file                  = $haproxy::params::config_file,
-  $manage_config_dir                                           = $haproxy::params::manage_config_dir,
-  $config_validate_cmd                                         = $haproxy::params::config_validate_cmd,
+  String[1]                                     $package_ensure       = 'present',
+  String                                        $package_name         = $haproxy::params::package_name,
+  Variant[Enum['running', 'stopped'], Boolean]  $service_ensure       = 'running',
+  Boolean                                       $service_manage       = true,
+  Boolean                                       $chroot_dir_manage    = true,
+  String                                        $service_name         = $haproxy::params::service_name,
+  String                                        $service_options      = $haproxy::params::service_options,
+  String                                        $sysconfig_options    = $haproxy::params::sysconfig_options,
+  Hash                                          $global_options       = $haproxy::params::global_options,
+  Hash                                          $defaults_options     = $haproxy::params::defaults_options,
+  Boolean                                       $merge_options        = $haproxy::params::merge_options,
+  Optional[String]                              $restart_command      = undef,
+  Optional[String]                              $custom_fragment      = undef,
+  Stdlib::Absolutepath                          $config_dir           = $haproxy::params::config_dir,
+  Optional[Stdlib::Absolutepath]                $config_file          = $haproxy::params::config_file,
+  Boolean                                       $manage_config_dir    = $haproxy::params::manage_config_dir,
+  Variant[Stdlib::Absolutepath, String]         $config_validate_cmd  = $haproxy::params::config_validate_cmd,
 
   # Deprecated
-  $manage_service                                              = undef,
-  $enable                                                      = undef,
+  Optional[Boolean]                             $manage_service       = undef,
+  Optional[Boolean]                             $enable               = undef,
 ) inherits haproxy::params {
   # NOTE: These deprecating parameters are implemented in this class,
   # not in haproxy::instance.  haproxy::instance is new and therefore

diff --git a/manifests/install.pp b/manifests/install.pp
@@ -3,8 +3,8 @@
 # @api private
 define haproxy::install (
   # lint:ignore:140chars
-  $package_ensure,
-  $package_name = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
+  String[1]         $package_ensure,
+  Optional[String]  $package_name     = undef,  # A default is required for Puppet 2.7 compatibility. When 2.7 is no longer supported, this parameter default should be removed.
   # lint:endignore
 ) {
   if $caller_module_name != $module_name {

diff --git a/manifests/instance.pp b/manifests/instance.pp
@@ -159,26 +159,26 @@
 #   call haproxy::instance_service.
 #
 define haproxy::instance (
-  Optional[String] $package_name                               = undef,
-  String[1] $package_ensure                                    = 'present',
-  Variant[Enum['running', 'stopped'], Boolean] $service_ensure = 'running',
-  Boolean $service_manage                                      = true,
-  Boolean $chroot_dir_manage                                   = true,
-  Optional[String] $service_name                               = undef,
-  Optional[Hash] $global_options                               = undef,
-  Optional[Hash] $defaults_options                             = undef,
-  $restart_command                                             = undef,
-  $custom_fragment                                             = undef,
-  $config_dir                                                  = undef,
-  Optional[Stdlib::Absolutepath] $config_file                  = undef,
-  $config_validate_cmd                                         = $haproxy::params::config_validate_cmd,
-  $merge_options                                               = $haproxy::params::merge_options,
-  $service_options                                             = $haproxy::params::service_options,
-  $sysconfig_options                                           = $haproxy::params::sysconfig_options,
+  Optional[String]                              $package_name         = undef,
+  String[1]                                     $package_ensure       = 'present',
+  Variant[Enum['running', 'stopped'], Boolean]  $service_ensure       = 'running',
+  Boolean                                       $service_manage       = true,
+  Boolean                                       $chroot_dir_manage    = true,
+  Optional[String]                              $service_name         = undef,
+  Optional[Hash]                                $global_options       = undef,
+  Optional[Hash]                                $defaults_options     = undef,
+  Optional[String]                              $restart_command      = undef,
+  Optional[String]                              $custom_fragment      = undef,
+  Optional[Stdlib::Absolutepath]                $config_dir           = undef,
+  Optional[Stdlib::Absolutepath]                $config_file          = undef,
+  Variant[Stdlib::Absolutepath, String]         $config_validate_cmd  = $haproxy::params::config_validate_cmd,
+  Boolean                                       $merge_options        = $haproxy::params::merge_options,
+  String                                        $service_options      = $haproxy::params::service_options,
+  String                                        $sysconfig_options    = $haproxy::params::sysconfig_options,
 ) {
   # Since this is a 'define', we can not use 'inherts haproxy::params'.
   # Therefore, we "include haproxy::params" for any parameters we need.
-  include ::haproxy::params
+  contain haproxy::params
 
   $_global_options = pick($global_options, $haproxy::params::global_options)
   $_defaults_options = pick($defaults_options, $haproxy::params::defaults_options)
@@ -236,16 +236,12 @@
   }
 
   if $package_ensure == 'absent' or $package_ensure == 'purged' {
-    anchor { "${title}::haproxy::begin": }
-    ~> Haproxy::Service[$title]
+    Haproxy::Service[$title]
     -> Haproxy::Config[$title]
     -> Haproxy::Install[$title]
-    -> anchor { "${title}::haproxy::end": }
   } else {
-    anchor { "${title}::haproxy::begin": }
-    -> Haproxy::Install[$title]
+    Haproxy::Install[$title]
     -> Haproxy::Config[$title]
     ~> Haproxy::Service[$title]
-    -> anchor { "${title}::haproxy::end": }
   }
 }