(MODULES-10670) Add alternate_pe_version parameter

This parameter will allow PE users to override the PE version
detection used in the packages source to a different version
than the running PE version.  This could be used to hold back
packages during a PE upgrade cycle until the user is ready
to upgrade the agents.

Author: seanmil

manifests/init.pp

@@ -98,6 +98,12 @@
 #   Puppet_agent::Config hash, which has keys for puppet.conf section, setting, and value.
 #   This parameter is constrained to managing only a predetermined set of configuration
 #   settings, e.g. runinterval.
+# [alternate_pe_version]
+#   When using a PE-based package source (e.g. "alternate_pe_source", "aix_source")
+#   this setting allows you to override the PE version number used when constructing the
+#   package source URL. Normally, this will be the running version of PE but this setting
+#   can be used to "hold back" the agents during an upgrade of PE if there is a need
+#   to upgrade the platform and agents on separate schedules.
 class puppet_agent (
   $arch                    = $::architecture,
   $collection              = $::puppet_agent::params::collection,
@@ -126,6 +132,7 @@
   $wait_for_pxp_agent_exit = undef,
   $wait_for_puppet_run     = undef,
   Array[Puppet_agent::Config] $config = [],
+  Optional[String[1]] $alternate_pe_version = undef,
 ) inherits ::puppet_agent::params {
 
   # The configure class uses $puppet_agent::config to manage settings in

manifests/osfamily/aix.pp

@@ -9,7 +9,7 @@
     fail('AIX upgrades are only supported on Puppet Enterprise')
   }
 
-  $pe_server_version = pe_build_version()
+  $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
 
   # in puppet versions later than 4 we began using single agent packages for
   # multiple version of AIX. The support sequence is as follows:

manifests/osfamily/darwin.pp

@@ -11,7 +11,7 @@
   if $::puppet_agent::absolute_source {
     $source = $::puppet_agent::absolute_source
   } elsif ($::puppet_agent::is_pe and (!$::puppet_agent::use_alternate_sources)) {
-    $pe_server_version = pe_build_version()
+    $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
     if $::puppet_agent::alternate_pe_source {
       $source = "${::puppet_agent::alternate_pe_source}/packages/${pe_server_version}/${::platform_tag}/${puppet_agent::package_name}-${::puppet_agent::prepare::package_version}-1.osx${$productversion_major}.dmg"
     } elsif $::puppet_agent::source {

manifests/osfamily/debian.pp

@@ -15,7 +15,7 @@
     if getvar('::puppet_agent::manage_repo') == true {
       include ::apt
       if ($::puppet_agent::is_pe and (!$::puppet_agent::use_alternate_sources)) {
-        $pe_server_version = pe_build_version()
+        $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
         if $::puppet_agent::source {
           $source = "${::puppet_agent::source}/packages/${pe_server_version}/${::platform_tag}"
         } elsif $::puppet_agent::alternate_pe_source {

manifests/osfamily/redhat.pp

@@ -28,7 +28,7 @@
       }
     }
     if ($::puppet_agent::is_pe and (!$::puppet_agent::use_alternate_sources)) {
-      $pe_server_version = pe_build_version()
+      $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
       # Treat Amazon Linux just like Enterprise Linux
       $pe_repo_dir = ($::operatingsystem == 'Amazon') ? {
         true    => "el-${amz_el_version}-${::architecture}",

manifests/osfamily/solaris.pp

@@ -9,7 +9,7 @@
     fail('Solaris upgrades are only supported on Puppet Enterprise')
   }
 
-  $pe_server_version = pe_build_version()
+  $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
   if $::puppet_agent::absolute_source {
     $source_dir = $::puppet_agent::absolute_source
   } elsif $::puppet_agent::alternate_pe_source {

manifests/osfamily/suse.pp

@@ -16,7 +16,7 @@
     contain puppet_agent::prepare::package
   } else {
     if ($::puppet_agent::is_pe and (!$::puppet_agent::use_alternate_sources)) {
-      $pe_server_version = pe_build_version()
+      $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
 
       # SLES 11 in PE can no longer install agents from pe_repo
       if $::operatingsystemmajrelease == '11' {

manifests/osfamily/windows.pp

@@ -6,7 +6,7 @@
   } elsif $::puppet_agent::source {
     $source = $::puppet_agent::source
   } elsif  ($::puppet_agent::is_pe and (!$::puppet_agent::use_alternate_sources)) {
-    $pe_server_version = pe_build_version()
+    $pe_server_version = $::puppet_agent::alternate_pe_version.lest || { pe_build_version() }
     $tag = $::puppet_agent::arch ? {
       'x64' => $::fips_enabled ? {
         true => 'windowsfips-x86_64',

spec/classes/puppet_agent_osfamily_aix_spec.rb

@@ -81,6 +81,31 @@
     }
   end
 
+  context 'with a user defined PE version' do
+    let(:facts) do
+      common_facts.merge({
+                           architecture: 'PowerPC_POWER8',
+                           platform_tag: 'aix-6.1-power',
+                         })
+    end
+    let(:params) do
+      {
+        package_version: '5.10.100.1',
+        collection: 'puppet5',
+        alternate_pe_version: '2222.2.2',
+      }
+    end
+
+    before(:each) do
+      Puppet::Parser::Functions.newfunction(:pe_build_version, type: :rvalue) { |_args| '2000.0.0' }
+      Puppet::Parser::Functions.newfunction(:pe_compiling_server_aio_build, type: :rvalue) { |_args| '1.10.100' }
+    end
+
+    it {
+      is_expected.to contain_file('/opt/puppetlabs/packages/puppet-agent-5.10.100.1-1.aix7.1.ppc.rpm').with_source('puppet:///pe_packages/2222.2.2/aix-7.1-power/puppet-agent-5.10.100.1-1.aix7.1.ppc.rpm')
+    }
+  end
+
   context 'with a PC1 collection' do
     let(:params) do
       {

spec/classes/puppet_agent_osfamily_darwin_spec.rb

@@ -93,6 +93,26 @@
     it { is_expected.to contain_file('/opt/puppetlabs/packages/puppet-agent-5.10.100.1-1.osx10.13.dmg').with_source('https://fake-pe-master.com/packages/2000.0.0/osx-10.13-x86_64/puppet-agent-5.10.100.1-1.osx10.13.dmg') }
   end
 
+  describe 'when using a user defined PE version' do
+    let(:params) do
+      {
+        package_version: '5.10.100.1',
+        collection: 'puppet5',
+        alternate_pe_version: '2222.2.2',
+      }
+    end
+    let(:facts) do
+      facts.merge({
+                    is_pe: true,
+                    aio_agent_version: '1.10.99',
+                    platform_tag: 'osx-10.13-x86_64',
+                    macosx_productversion_major: '10.13'
+                  })
+    end
+
+    it { is_expected.to contain_file('/opt/puppetlabs/packages/puppet-agent-5.10.100.1-1.osx10.13.dmg').with_source('puppet:///pe_packages/2222.2.2/osx-10.13-x86_64/puppet-agent-5.10.100.1-1.osx10.13.dmg') }
+  end
+
   describe 'when using package_version auto' do
     let(:params) do
       {