feat: added support for common::packages::manage to set the pin for a package and updated the doc for package::install func and other misc bug fixes

Author: ashish1099

modules/enableit/common/manifests/package.pp

@@ -4,19 +4,58 @@
   Hash[
     String,
     Struct[{
-      ensure => Optional[Variant[Enum['latest', 'present', 'purge', 'absent', 'installed'], String]],
+      ensure => Optional[Stdlib::Ensure::Package],
       noop   => Optional[Boolean],
+      pin    => Optional[String],
     }]
-  ] $manage = {},
+  ]                       $manage                   = {},
   Array[String]           $default_packages         = [],
   Array[String]           $removed_packages         = [],
   Array[String]           $required_packages        = [],
 ) {
-  $manage.each | $package_name, $status | {
-    package { $package_name :
+
+  # Manage package
+  $manage.each | $package_name, $options | {
+
+    confine($options['pin'], $options['ensure'] in ['present', 'absent'] or $options['ensure'] =~ Boolean, 'Package pinning requires an explicit package version') #lint:ignore:140chars
+
+    stdlib::ensure_packages($package_name, {
       # make sure the default is installed, even if it should change
-      ensure => pick($status['ensure'], installed),
-      noop   => $status['noop'],
+      ensure => pick($options['ensure'], installed),
+      noop   => $options['noop'],
+    })
+
+    if $options['pin'] {
+      case $facts['package_provider'] {
+        'apt': {
+          apt::pin { "pin ${package_name}":
+            version  => $options['pin'],
+            priority => 999,
+            packages => $package_name,
+          }
+        }
+        /^(yum|dnf)$/: {
+          $release = split($options['pin'], '-')
+
+          yum::versionlock { $package_name:
+            ensure  => present,
+            version => $release[0],
+            # NOTE: some package has like el8_10 (8.10) and some just have el8, so * will help to catch those
+            release => "${release[1]}.el${facts['os']['release']['major']}*",
+            arch    => $facts['os']['architecture'],
+          }
+        }
+        'zypper': {
+          $full_package_name = "${package_name}-${options['pin']}-*.sles${facts['os']['release']['major']}*.${facts['os']['architecture']}"
+
+          zypprepo::versionlock { $full_package_name:
+            ensure  => present,
+          }
+        }
+        default: {
+          info('Unsupported package provider, please raise issue on github')
+        }
+      }
     }
   }
 

modules/enableit/package/functions/install.pp

@@ -3,25 +3,26 @@
 # Tries to look up package names in hiera. If not found, uses package name as-is.
 #
 # @example
-#   package::install('emacs')
-#   package::install('rsync', 'absent')
-#   package::install('python-pymongo', {notify => Service['diamond']})
-#   package::install('hp-health', 'present' , '9.4.0.1.7-5.')
-#   package::install('diamond', {notify => Service['diamond']} , '4.0.471')
+# Install emacs (will be in installed state)
+# package::install('emacs')
 #
-# @param package_names One or more package names
-# @param status Package status
+# Remove the rsync package
+# package::install('rsync', 'absent')
+#
+# Install hp-health with a specific version, and notify some service
+# package::install('hp-health', {notify => Service['some-servicd']}))
+#
+# Install diamond package with a specific version, but does not set a pin
+# package::install('diamond', '4.0.471')
+#
+# @param packages One or more package names
 # @param parameters Additional parameters. These are merged with `status`.
 
 function package::install (
   Variant[String, Array[String]] $packages,
-  Variant[Boolean, Enum['present', 'absent'], Hash[String, Any], String] $parameters = {},
-  Boolean $pin = false,
+  Variant[Stdlib::Ensure::Package, Hash[String, Any]] $parameters = {},
 ) {
 
-  confine($pin, $::facts['os']['family'] != 'Debian', 'Package pinning only supported on Debian-based systems')
-  confine($pin, $parameters in ['present', 'absent'] or $parameters =~ Boolean, 'Package pinning requires an explicit package version')
-
   # Packages
   $_packages = case $packages {
     String: {
@@ -42,15 +43,6 @@ function package::install (
     }
   }
 
-  if $pin {
-    $_name = join($_packages, ', ')
-    apt::pin { $_name:
-      packages => $_packages,
-      version  => $parameters,
-      priority => 999,
-    }
-  }
-
   # Install/Remove Package
   $install_packages = package::lookup($_packages)
 

modules/enableit/profile/manifests/system/sudoers.pp

@@ -67,7 +67,7 @@
     require  => File[$sudoers_d_dir],
   }
 
-  package::install('pam-ssh-agent-auth', $common::system::authentication::sudo::ssh_agent_auth)
+  package::install('pam-ssh-agent-auth', ensure_present($common::system::authentication::sudo::ssh_agent_auth))
 
   $sudoers.each |$name, $v| {
     profile::system::sudoers::conf { $name: