Add mail packages for arch/redhat

jstraw · jstraw · commit 66b1781bd8de · 2025-05-02T13:39:00.000-05:00
While redhat installs the mail packages by default,
arch doesn't and therefore you need to be able to define that
package for installation.

Remove the installation of the package in the test itself

Debian uses the upstream with mail compiled in

Add mail_package_name to REFERENCE

Make the RedHat module load when mail is configured

Add documentation for mail_package

Disable non nginx 1.14 for redhat 8 in testing

Rubocop autocorrects

Make sure the right nginx version is installed for test
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -77,6 +77,7 @@ The following parameters are available in the `nginx` class:
 
 * [`include_modules_enabled`](#-nginx--include_modules_enabled)
 * [`passenger_package_name`](#-nginx--passenger_package_name)
+* [`mail_package_name`](#-nginx--mail_package_name)
 * [`nginx_version`](#-nginx--nginx_version)
 * [`debug_connections`](#-nginx--debug_connections)
 * [`service_config_check`](#-nginx--service_config_check)
@@ -266,10 +267,19 @@ Default value: `$nginx::params::include_modules_enabled`
 Data type: `String[1]`
 
 The name of the package to install in order for the passenger module of
-nginx being usable.
+nginx to be usable.
 
 Default value: `$nginx::params::passenger_package_name`
 
+##### <a name="-nginx--mail_package_name"></a>`mail_package_name`
+
+Data type: `Optional[String[1]]`
+
+The name of the package to install in order for the mail module of
+nginx to be usable.
+
+Default value: `$nginx::params::mail_package_name`
+
 ##### <a name="-nginx--nginx_version"></a>`nginx_version`
 
 Data type: `String[1]`
@@ -395,7 +405,7 @@ Data type: `Array[String]`
 
 
 
-Default value: `[]`
+Default value: `$nginx::params::dynamic_modules`
 
 ##### <a name="-nginx--global_owner"></a>`global_owner`
 
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -14,7 +14,11 @@
 #
 # @param passenger_package_name
 #   The name of the package to install in order for the passenger module of
-#   nginx being usable.
+#   nginx to be usable.
+#
+# @param mail_package_name
+#   The name of the package to install in order for the mail module of
+#   nginx to be usable.
 #
 # @param nginx_version
 #   The version of nginx installed (or being installed).
@@ -220,7 +224,7 @@
   Optional[Enum['on', 'off']] $daemon                        = undef,
   String[1] $daemon_user                                     = $nginx::params::daemon_user,
   Optional[String[1]] $daemon_group                          = undef,
-  Array[String] $dynamic_modules                             = [],
+  Array[String] $dynamic_modules                             = $nginx::params::dynamic_modules,
   String[1] $global_owner                                    = 'root',
   String[1] $global_group                                    = $nginx::params::global_group,
   Stdlib::Filemode $global_mode                              = '0644',
@@ -375,6 +379,8 @@
   Optional[String] $repo_release                             = undef,
   String $passenger_package_ensure                           = installed,
   String[1] $passenger_package_name                          = $nginx::params::passenger_package_name,
+  # This is optional, to allow it to be set to undef for systems that install it with nginx always
+  Optional[String[1]] $mail_package_name                     = $nginx::params::mail_package_name,
   Optional[Stdlib::HTTPUrl] $repo_source                     = undef,
   ### END Package Configuration ###
 
diff --git a/manifests/params.pp b/manifests/params.pp
@@ -14,8 +14,10 @@
     'log_mode'                => '0750',
     'package_name'            => 'nginx',
     'passenger_package_name'  => 'passenger',
+    'mail_package_name'       => undef,
     'manage_repo'             => false,
     'include_modules_enabled' => false,
+    'dynamic_modules'         => [],
     'mime_types'              => {
       'text/html'                                                                 => 'html htm shtml',
       'text/css'                                                                  => 'css',
@@ -104,11 +106,12 @@
   case $facts['os']['family'] {
     'ArchLinux': {
       $_module_os_overrides = {
-        'pid'          => false,
-        'daemon_user'  => 'http',
-        'log_user'     => 'http',
-        'log_group'    => 'log',
-        'package_name' => 'nginx-mainline',
+        'pid'               => false,
+        'daemon_user'       => 'http',
+        'log_user'          => 'http',
+        'log_group'         => 'log',
+        'package_name'      => 'nginx-mainline',
+        'mail_package_name' => 'nginx-mod-mail',
       }
     }
     'Debian': {
@@ -144,7 +147,9 @@
         }
       } else {
         $_module_os_overrides = {
-          'log_group' => 'nginx',
+          'log_group'         => 'nginx',
+          'mail_package_name' => 'nginx-mod-mail',
+          'dynamic_modules'   => ['/usr/lib64/nginx/modules/ngx_mail_module.so'],
         }
       }
     }
@@ -204,6 +209,7 @@
   $log_mode                = $_module_parameters['log_mode']
   $pid                     = $_module_parameters['pid']
   $include_modules_enabled = $_module_parameters['include_modules_enabled']
+  $dynamic_modules         = $_module_parameters['dynamic_modules']
 
   $daemon_user             = $_module_parameters['daemon_user']
   $global_group            = $_module_parameters['root_group']
@@ -212,6 +218,7 @@
   $root_group              = $_module_parameters['root_group']
   $package_name            = $_module_parameters['package_name']
   $passenger_package_name  = $_module_parameters['passenger_package_name']
+  $mail_package_name       = $_module_parameters['mail_package_name']
   $sites_available_group   = $_module_parameters['root_group']
   ### END Referenced Variables
 }
diff --git a/manifests/resource/mailhost.pp b/manifests/resource/mailhost.pp
@@ -188,6 +188,11 @@
   if ! defined(Class['nginx']) {
     fail('You must include the nginx base class before using any defined resources')
   }
+  if $nginx::mail_package_name {
+    package { $nginx::mail_package_name:
+      ensure => 'installed',
+    }
+  }
 
   # Add IPv6 Logic Check - Nginx service will not start if ipv6 is enabled
   # and support does not exist for it in the kernel.
diff --git a/spec/acceptance/nginx_mail_spec.rb b/spec/acceptance/nginx_mail_spec.rb
@@ -5,15 +5,9 @@
 describe 'nginx::resource::mailhost define:' do
   has_recent_mail_module = true
 
-  if fact('os.family') == 'RedHat' && fact('os.release.major') == '8'
-    # EPEL had recent nginx-mod-mail package for CentOS 7 but not CentOS 8
-    # Stream.  The base packages use an older version of nginx that does not
-    # work with the acceptance test configuration.
-    has_recent_mail_module = false
-  end
+  has_recent_mail_module = false if fact('os.family') == 'RedHat' && fact('os.release.major') == '8'
 
   it 'remove leftovers from previous tests', if: fact('os.family') == 'RedHat' do
-    shell('yum -y remove nginx nginx-filesystem passenger')
     # nginx-mod-mail is not available for all versions of nginx, the one
     # installed might be incompatible with the version of nginx-mod-mail we are
     # about to install so clean everything.
@@ -26,23 +20,15 @@
     }
     "
     apply_manifest(pp, catch_failures: true)
+    shell('yum -y remove nginx nginx-filesystem passenger nginx-mod-mail')
+    shell('yum clean all')
   end
 
   context 'actualy test the mail module', if: has_recent_mail_module do
     it 'runs successfully' do
       pp = "
-      if fact('os.family') == 'RedHat' {
-        package { 'nginx-mod-mail':
-          ensure => installed,
-        }
-      }
-
       class { 'nginx':
         mail            => true,
-        dynamic_modules => fact('os.family') ? {
-          'RedHat' => ['/usr/lib64/nginx/modules/ngx_mail_module.so'],
-          default  => [],
-        }
       }
       nginx::resource::mailhost { 'domain1.example':
         ensure      => present,
@@ -81,21 +67,13 @@ class { 'nginx':
     end
 
     context 'when configured for nginx 1.14', if: !%w[Debian Archlinux].include?(fact('os.family')) do
+      shell('yum -y install nginx-1.14.1') if fact('os.family') == 'RedHat' && fact('os.release.major') == '8'
       it 'runs successfully' do
         pp = "
-      if fact('os.family') == 'RedHat' {
-        package { 'nginx-mod-mail':
-          ensure => installed,
-        }
-      }
-
       class { 'nginx':
         mail            => true,
+        manage_repo     => false,
         nginx_version   => '1.14.0',
-        dynamic_modules => fact('os.family') ? {
-          'RedHat' => ['/usr/lib64/nginx/modules/ngx_mail_module.so'],
-          default  => [],
-        }
       }
       nginx::resource::mailhost { 'domain1.example':
         ensure      => present,
