(PE-42079) Add timeout for puppet run on db targets

Author: davidmalloncares

.github/workflows/test-upgrade-matrix.yaml

@@ -44,6 +44,8 @@ jobs:
         exclude:
           - version: 2021.7.9
             version_to_upgrade: 2021.7.9
+          - version: 2021.7.9
+            version_to_upgrade: 2025.6.0
           - version: 2023.8.6
             version_to_upgrade: 2021.7.9
           - version: 2023.8.6

Gemfile

@@ -38,7 +38,7 @@ group :development do
   gem "rubocop-factory_bot", '~> 2.27.1',        require: false
   gem "rubocop-capybara", '~> 2.22.1',           require: false
   gem "rb-readline", '= 0.5.5',                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  #gem "bolt", '>= 4.0.0',                        require: false
+  gem "bolt", '>= 4.0.0',                        require: false
   gem "github_changelog_generator", '1.16.4',    require: false
   gem "octokit", '4.21.0',                       require: false
   gem "orchestrator_client", '< 0.7.1',          require: false
@@ -55,24 +55,14 @@ end
 puppet_version = ENV['PUPPET_GEM_VERSION']
 facter_version = ENV['FACTER_GEM_VERSION']
 hiera_version = ENV['HIERA_GEM_VERSION']
-bolt_version = ENV.fetch('BOLT_GEM_VERSION', nil)
 
 gems = {}
 
-# If PUPPET_FORGE_TOKEN is set then use authenticated source for both puppet and facter, since facter is a transitive dependency of puppet
-# Otherwise, do as before and use location_for to fetch gems from the default source
-if !ENV['PUPPET_FORGE_TOKEN'].to_s.empty?
-  gems['bolt'] = [bolt_version || '~> 5.0', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }]
-  gems['puppet'] = [puppet_version || '~> 8.11', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }]
-  gems['facter'] = [facter_version || '~> 4.0', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }]
-else
-  gems['bolt'] = location_for(bolt_version)
-  gems['puppet'] = location_for(puppet_version)
-  gems['facter'] = location_for(facter_version) if facter_version  
-end
+gems['puppet'] = location_for(puppet_version)
 
-# If hiera version have been specified via the environment
+# If facter or hiera versions have been specified via the environment
 # variables
+gems['facter'] = location_for(facter_version) if facter_version
 gems['hiera'] = location_for(hiera_version) if hiera_version
 
 gems.each do |gem_name, gem_params|

REFERENCE.md

@@ -16,6 +16,7 @@
 
 ### Functions
 
+* [`peadm::assert_puppet_not_installed`](#peadm--assert_puppet_not_installed): Assert that Puppet is not already installed on the provided nodes
 * [`peadm::assert_supported_architecture`](#peadm--assert_supported_architecture): Assert that the architecture given is a supported one
 * [`peadm::assert_supported_bolt_version`](#peadm--assert_supported_bolt_version): Assert that the Bolt executable running PEAdm is a supported version
 * [`peadm::assert_supported_pe_version`](#peadm--assert_supported_pe_version): Assert that the PE version given is supported by PEAdm
@@ -146,6 +147,24 @@ Supported use cases:
 
 ## Functions
 
+### <a name="peadm--assert_puppet_not_installed"></a>`peadm::assert_puppet_not_installed`
+
+Type: Puppet Language
+
+Assert that Puppet is not already installed on the provided nodes
+
+#### `peadm::assert_puppet_not_installed(TargetSpec $nodes)`
+
+The peadm::assert_puppet_not_installed function.
+
+Returns: `Boolean` Returns true if no Puppet installations are found, fails otherwise
+
+##### `nodes`
+
+Data type: `TargetSpec`
+
+A list of nodes to check for existing Puppet installations
+
 ### <a name="peadm--assert_supported_architecture"></a>`peadm::assert_supported_architecture`
 
 Type: Puppet Language

functions/assert_puppet_not_installed.pp

@@ -0,0 +1,48 @@
+# @summary Assert that Puppet is not already installed on the provided nodes
+# @param nodes
+#   A list of nodes to check for existing Puppet installations
+# @return [Boolean] Returns true if no Puppet installations are found, fails otherwise
+function peadm::assert_puppet_not_installed(
+  TargetSpec $nodes,
+) >> Boolean {
+  # Normalize nodes to an array of targets
+  $nodes_array = get_targets($nodes)
+
+  if empty($nodes_array) {
+    return true
+  }
+
+  out::message("Checking ${nodes_array.length} nodes for existing Puppet installations...")
+
+  # Run puppet --version command on all nodes to check for existing installations
+  $results = run_command('puppet --version', $nodes_array, '_catch_errors' => true)
+
+  # Find nodes that have Puppet already installed (command succeeded)
+  $nodes_with_puppet = $results.filter |$result| {
+    $result.ok()
+  }
+
+  if !empty($nodes_with_puppet) {
+    $node_list = $nodes_with_puppet.map |$result| {
+      "  - ${result.target.name}: ${result.value['stdout'].strip()}"
+    }.join("\n")
+
+    out::message(inline_epp(@(HEREDOC)))
+      ERROR: Puppet is already installed on the following nodes:
+      
+      <%= $node_list %>
+      
+      PEADM requires clean nodes without existing Puppet installations.
+      
+      To resolve this issue:
+      1. Use fresh/clean target systems that don't have Puppet installed, OR
+      2. Remove existing Puppet installations
+      
+      | HEREDOC
+
+    fail("Puppet is already installed on ${nodes_with_puppet.length} node(s). Clean installations required.")
+  }
+
+  out::message('✓ No existing Puppet installations found on target nodes')
+  return true
+}

plans/subplans/install.pp

@@ -100,6 +100,7 @@
       $compiler_targets,
       $legacy_compiler_targets,
   ])
+  peadm::assert_puppet_not_installed($all_targets)
 
   $primary_targets = peadm::flatten_compact([
       $primary_target,
@@ -429,7 +430,7 @@
     run_task('peadm::puppet_runonce', $target)
   }
 
-  wait([$bg_db_run])
+  wait([$bg_db_run], 1200, _catch_errors => true)
 
   # The puppetserver might be in the middle of a restart after the Puppet run,
   # so we check the status by calling the api and ensuring the puppetserver is