(CONT-1144) - Conversion of ERB to EPP templates

.github/workflows/labeller.yml

@@ -1,22 +1,27 @@
-name: community-labeller
+name: Labeller
 
 on:
   issues:
     types:
       - opened
+      - labeled
+      - unlabeled
   pull_request_target:
     types:
       - opened
+      - labeled
+      - unlabeled
 
 jobs:
   label:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: puppetlabs/community-labeller@v0
+      - uses: puppetlabs/community-labeller@v1.0.1
         name: Label issues or pull requests
         with:
           label_name: community
           label_color: '5319e7'
           org_membership: puppetlabs
+          fail_if_member: 'true'
           token: ${{ secrets.IAC_COMMUNITY_LABELER }}

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-29 09:56:35 UTC using RuboCop version 1.48.1.
+# on 2023-07-20 04:54:59 UTC using RuboCop version 1.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -41,8 +41,8 @@ RSpec/NamedSubject:
     - 'spec/classes/haproxy_spec.rb'
     - 'spec/defines/instance_service_spec.rb'
     - 'spec/defines/instance_spec.rb'
-  
-# Offense count: 183
+
+# Offense count: 181
 # Configuration parameters: AllowedPatterns.
 # AllowedPatterns: ^expect_, ^assert_
 RSpec/NoExpectationExample:

REFERENCE.md

@@ -1247,7 +1247,7 @@ Data type: `String`
 
 The template that will be used to create an unit file.
 
-Default value: `'haproxy/instance_service_unit.erb'`
+Default value: `'haproxy/instance_service_unit.epp'`
 
 ### <a name="haproxy--listen"></a>`haproxy::listen`
 

lib/puppet/functions/haproxy/generate_error_message.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Function created to generate error message. Any string as error message can be passed and the function can
+# be called in epp templates.
+
+Puppet::Functions.create_function(:'haproxy::generate_error_message') do
+  dispatch :generate_error_message do
+    param 'String', :error_message
+  end
+
+  def generate_error_message(error_message)
+    raise(error_message)
+  end
+end

lib/puppet/functions/haproxy/sort_bind.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Puppet::Functions.create_function(:'haproxy::sort_bind') do
+  dispatch :sort_bind do
+    param 'Hash', :bind
+    return_type 'Array'
+  end
+
+  def sort_bind(bind)
+    bind.sort_by do |address_port|
+      md = %r{^((\d+)\.(\d+)\.(\d+)\.(\d+))?(.*)}.match(address_port[0])
+      [(md[1] ? md[2..5].inject(0) { |addr, octet| (addr << 8) + octet.to_i } : -1), md[6]]
+    end
+  end
+end

lib/puppet/functions/haproxy/validate_ip_addr.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+Puppet::Functions.create_function(:'haproxy::validate_ip_addr') do
+  dispatch :validate_ip_addr do
+    param 'String', :virtual_ip
+    return_type 'Boolean'
+  end
+
+  def validate_ip_addr(virtual_ip)
+    IPAddr.new(virtual_ip)
+    true
+  rescue StandardError
+    false
+  end
+end

manifests/backend.pp

@@ -125,11 +125,19 @@
     $order = "25-${defaults}-${section_name}-01"
   }
 
+  $parameters = {
+    'section_name'             => $section_name,
+    'mode'                     => $mode,
+    'description'              => $description,
+    '_sort_options_alphabetic' => $_sort_options_alphabetic,
+    'options'                  => $options,
+  }
+
   # Template uses: $section_name, $ipaddress, $ports, $options
   concat::fragment { "${instance_name}-${section_name}_backend_block":
     order   => $order,
     target  => $_config_file,
-    content => template('haproxy/haproxy_backend_block.erb'),
+    content => epp('haproxy/haproxy_backend_block.epp', $parameters),
   }
 
   if $collect_exported {

manifests/balancermember.pp

@@ -167,10 +167,25 @@
   } else {
     $order = "25-${defaults}-${listening_service}-02-${name}"
   }
+
+  $parameters = {
+    'type'           => $type,
+    'ipaddresses'    => $ipaddresses,
+    'server_names'   => $server_names,
+    'ports'          => $ports,
+    'define_cookies' => $define_cookies,
+    'options'        => $options,
+    'verifyhost'     => $verifyhost,
+    'weight'         => $weight,
+    'prefix'         => $prefix,
+    'amount'         => $amount,
+    'fqdn'           => $fqdn,
+    'port'           => $port,
+  }
   # Template uses $ipaddresses, $server_name, $ports, $option
   concat::fragment { "${instance_name}-${listening_service}_balancermember_${name}":
     order   => $order,
     target  => $_config_file,
-    content => template('haproxy/haproxy_balancermember.erb'),
+    content => epp('haproxy/haproxy_balancermember.epp', $parameters),
   }
 }

manifests/config.pp

@@ -70,11 +70,17 @@
       content => "# This file is managed by Puppet\n",
     }
 
+    $parameters = {
+      '_global_options'   => $_global_options,
+      '_defaults_options' => $_defaults_options,
+      'custom_fragment'   => $custom_fragment,
+    }
+
     # Template uses $_global_options, $_defaults_options, $custom_fragment
     concat::fragment { "${instance_name}-haproxy-base":
       target  => $_config_file,
       order   => '10',
-      content => template("${module_name}/haproxy-base.cfg.erb"),
+      content => epp("${module_name}/haproxy-base.cfg.epp", $parameters),
     }
   }
 

manifests/defaults.pp

@@ -36,9 +36,15 @@
   include haproxy::globals
   $_sort_options_alphabetic = pick($sort_options_alphabetic, $haproxy::globals::sort_options_alphabetic)
 
+  $parameters = {
+    '_sort_options_alphabetic' => $_sort_options_alphabetic,
+    'options'                  => $options,
+    'name'                     => $name,
+  }
+
   concat::fragment { "${instance_name}-${name}_defaults_block":
     order   => "25-${name}",
     target  => $config_file,
-    content => template('haproxy/haproxy_defaults_block.erb'),
+    content => epp('haproxy/haproxy_defaults_block.epp', $parameters),
   }
 }

manifests/frontend.pp

@@ -143,10 +143,23 @@
       $order = "25-${defaults}-${section_name}-00"
     }
   }
+
+  $parameters = {
+    'section_name'             => $section_name,
+    'bind'                     => $bind,
+    'ipaddress'                => $ipaddress,
+    'ports'                    => $ports,
+    'bind_options'             => $bind_options,
+    'mode'                     => $mode,
+    'description'              => $description,
+    'options'                  => $options,
+    '_sort_options_alphabetic' => $_sort_options_alphabetic,
+  }
+
   # Template uses: $section_name, $ipaddress, $ports, $options
   concat::fragment { "${instance_name}-${section_name}_frontend_block":
     order   => $order,
     target  => $_config_file,
-    content => template('haproxy/haproxy_frontend_block.erb'),
+    content => epp('haproxy/haproxy_frontend_block.epp', $parameters),
   }
 }

manifests/instance_service.pp

@@ -42,7 +42,7 @@
 #
 define haproxy::instance_service (
   Optional[String]      $haproxy_init_source    = undef,
-  String                $haproxy_unit_template  = 'haproxy/instance_service_unit.erb',
+  String                $haproxy_unit_template  = 'haproxy/instance_service_unit.epp',
   String                $haproxy_package        = 'haproxy',
   Stdlib::Absolutepath  $bindir                 = '/opt/haproxy/bin',
 ) {
@@ -103,12 +103,16 @@
         $unitfile = "/lib/systemd/system/haproxy-${title}.service"
       }
 
+      $parameters = {
+        'title'   => $title,
+        'wrapper' => $wrapper,
+      }
       file { $unitfile:
         ensure  => file,
         mode    => '0644',
         owner   => 'root',
         group   => 'root',
-        content => template($haproxy_unit_template),
+        content => epp($haproxy_unit_template, $parameters),
         notify  => Exec['systemctl daemon-reload'],
       }
       if (!defined(Exec['systemctl daemon-reload'])) {

manifests/listen.pp

@@ -150,11 +150,23 @@
     $order = "25-${defaults}-${section_name}-00"
   }
 
+  $parameters = {
+    'section_name'             => $section_name,
+    'bind'                     => $bind,
+    'ipaddress'                => $ipaddress,
+    'ports'                    => $ports,
+    'bind_options'             => $bind_options,
+    'mode'                     => $mode,
+    'description'              => $description,
+    'options'                  => $options,
+    '_sort_options_alphabetic' => $_sort_options_alphabetic,
+  }
+
   # Template uses: $section_name, $ipaddress, $ports, $options
   concat::fragment { "${instance_name}-${section_name}_listen_block":
     order   => $order,
     target  => $_config_file,
-    content => template('haproxy/haproxy_listen_block.erb'),
+    content => epp('haproxy/haproxy_listen_block.epp', $parameters),
   }
 
   if $collect_exported {

manifests/mailer.pp

@@ -48,10 +48,16 @@
     $config_file = inline_template($haproxy::params::config_file_tmpl)
   }
 
+  $parameters = {
+    'ipaddresses'  => $ipaddresses,
+    'server_names' => $server_names,
+    'port'         => $port,
+  }
+
   # Templates uses $ipaddresses, $server_name, $ports, $option
   concat::fragment { "${instance_name}-mailers-${mailers_name}-${name}":
     order   => "40-mailers-01-${mailers_name}-${name}",
     target  => $config_file,
-    content => template('haproxy/haproxy_mailer.erb'),
+    content => epp('haproxy/haproxy_mailer.epp', $parameters),
   }
 }

manifests/mailers.pp

@@ -24,11 +24,15 @@
     $config_file = inline_template($haproxy::params::config_file_tmpl)
   }
 
+  $parameters = {
+    'name' => $name,
+  }
+
   # Template uses: $name
   concat::fragment { "${instance_name}-${name}_mailers_block":
     order   => "40-mailers-00-${name}",
     target  => $config_file,
-    content => template('haproxy/haproxy_mailers_block.erb'),
+    content => epp('haproxy/haproxy_mailers_block.epp', $parameters),
   }
 
   if $collect_exported {

manifests/mapfile.pp

@@ -57,9 +57,14 @@
     notify => Haproxy::Service[$_instances],
   }
 
+  $parameters = {
+    'mappings'     => $mappings,
+    'mapfile_name' => $mapfile_name,
+  }
+
   concat::fragment { "haproxy_mapfile_${mapfile_name}-top":
     target  => $_mapfile_name,
-    content => template('haproxy/haproxy_mapfile.erb'),
+    content => epp('haproxy/haproxy_mapfile.epp', $parameters),
     order   => '00',
   }
 }

manifests/mapfile/entry.pp

@@ -29,9 +29,14 @@
 ) {
   $_mapfile_name = "${haproxy::config_dir}/${mapfile}.map"
 
+  $parameters = {
+    'mappings'     => $mappings,
+    'mapfile_name' => $title,
+  }
+
   concat::fragment { "haproxy_mapfile_${mapfile}-${title}":
     target  => $_mapfile_name,
-    content => template('haproxy/haproxy_mapfile.erb'),
+    content => epp('haproxy/haproxy_mapfile.epp', $parameters),
     order   => $order,
   }
 }

manifests/peer.pp

@@ -56,10 +56,16 @@
     $_config_file = pick($config_file, inline_template($haproxy::params::config_file_tmpl))
   }
 
+  $parameters = {
+    'ipaddresses'  => $ipaddresses,
+    'server_names' => $server_names,
+    'port'         => $port,
+  }
+
   # Templates uses $ipaddresses, $server_name, $ports, $option
   concat::fragment { "${instance_name}-peers-${peers_name}-${name}":
     order   => "30-peers-01-${peers_name}-${name}",
     target  => $_config_file,
-    content => template('haproxy/haproxy_peer.erb'),
+    content => epp('haproxy/haproxy_peer.epp', $parameters),
   }
 }

manifests/peers.pp

@@ -41,7 +41,7 @@
   concat::fragment { "${instance_name}-${name}_peers_block":
     order   => "30-peers-00-${name}",
     target  => $_config_file,
-    content => template('haproxy/haproxy_peers_block.erb'),
+    content => epp('haproxy/haproxy_peers_block.epp', { 'name' => $name }),
   }
 
   if $collect_exported {

manifests/resolver.pp

@@ -131,11 +131,20 @@
     $order = "25-${defaults}-${section_name}-02"
   }
 
+  $parameters = {
+    'section_name'          => $section_name,
+    'nameservers'           => $nameservers,
+    'parse_resolv_conf'     => $parse_resolv_conf,
+    'resolve_retries'       => $resolve_retries,
+    'timeout'               => $timeout,
+    'hold'                  => $hold,
+    'accepted_payload_size' => $accepted_payload_size,
+  }
   # Template uses: $section_name
   concat::fragment { "${instance_name}-${section_name}_resolver_block":
     order   => $order,
     target  => $_config_file,
-    content => template('haproxy/haproxy_resolver_block.erb'),
+    content => epp('haproxy/haproxy_resolver_block.epp', $parameters),
   }
 
   if $collect_exported {