puppet_litmus 0.19.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffba803cc6b53c4bdb7084bf11be4fac807f3b3cd237c5ddb297dcf6ca3a403d
-  data.tar.gz: 5cdb613f2be957e20a63fc1250b10113e468e162817657f0f987675f2ba7c055
+  metadata.gz: 11d83a8c9bc28bddfab1549c27e41514cbab10e4e942b1bceadf474bb7ab2866
+  data.tar.gz: e699d388947cb532e2f52a64f3f393da291140cc68efe0f8149b5dea3d8df29b
 SHA512:
-  metadata.gz: ea1fd95a69bfac81b56f94f3ee28b91be2587c501bf24729931c128315e41d5eaf937dce013ee0d63ec7a350469ac32ab0d7711e50411a0e5fe00340dabdd803
-  data.tar.gz: 899ac2b0edb422ccf35c9cdb5f46bec6b2a6a97557dca12ffc994e046ed8cf1e6eec2553865a3c4439b272d1dd29b0111fc24b2e1bb93575cb77fc0bfd7606b1
+  metadata.gz: a33d9d98831af21eeadc21971fc48c1d27f50270e20c5daf267340b1d811bfcb1f3860e8fcd5181a52e58f3f28d068bb100ae18f425a60be98f54ac61b4fb063
+  data.tar.gz: ac37e3be71bf832cc286cad40299eab785c6c52ceb14a3a1bdb7952b51f775bf78b7c7b66298320e3bac081835f3e51083230c7d1cc773e3ee2ede5c7f8ceb96

data/exe/matrix_from_metadata

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# this script creates a build matrix for github actions from the claimed supported platforms in metadata.json
+# this script creates a build matrix for github actions from the claimed supported platforms and puppet versions in metadata.json
 
 require 'json'
 
 IMAGE_TABLE = {
-  'RedHat-6' => 'rhel-6',
   'RedHat-7' => 'rhel-7',
   'RedHat-8' => 'rhel-8',
   'SLES-12' => 'sles-12',
@@ -33,16 +32,21 @@ DOCKER_PLATFORMS = [
   'Ubuntu-20.04',
 ].freeze
 
+# This table uses the latest version in each collection for accurate
+# comparison when evaluating puppet requirements from the metadata
+COLLECTION_TABLE = {
+  '5.5.22' => 'puppet5',
+  '6.19.1' => 'puppet6-nightly',
+  '7.0.0' => 'puppet7-nightly',
+}.freeze
+
 matrix = {
   platform: [],
-  collection: %w[
-    puppet5
-    puppet6
-    puppet7-nightly
-  ],
+  collection: [],
 }
 
 metadata = JSON.parse(File.read('metadata.json'))
+# Set platforms based on declared operating system support
 metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
   os = sup['operatingsystem']
   sup['operatingsystemrelease'].sort_by { |a| a.to_i }.each do |ver|
@@ -57,6 +61,38 @@ metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do
   end
 end
 
+# Set collections based on puppet version requirements
+if metadata.key?('requirements') && metadata['requirements'].length.positive?
+  metadata['requirements'].each do |req|
+    next unless req.key?('name') && req.key?('version_requirement') && req['name'] == 'puppet'
+
+    ver_regexp = %r{^([>=<]{1,2})\s*([\d.]+)\s+([>=<]{1,2})\s*([\d.]+)$}
+    match = ver_regexp.match(req['version_requirement'])
+    if match.nil?
+      puts "::warning::Didn't recognize version_requirement '#{req['version_requirement']}'"
+      break
+    end
+
+    cmp_one, ver_one, cmp_two, ver_two = match.captures
+    reqs = ["#{cmp_one} #{ver_one}", "#{cmp_two} #{ver_two}"]
+
+    COLLECTION_TABLE.each do |key, val|
+      if Gem::Requirement.create(reqs).satisfied_by?(Gem::Version.new(key))
+        matrix[:collection] << val
+      end
+    end
+  end
+end
+
+# Set to defaults (all collections) if no matches are found
+if matrix[:collection].empty?
+  matrix[:collection] = COLLECTION_TABLE.values
+end
+
+# Just to make sure there aren't any duplicates
+matrix[:platform] = matrix[:platform].uniq.sort
+matrix[:collection] = matrix[:collection].uniq.sort
+
 puts "::set-output name=matrix::#{JSON.generate(matrix)}"
 
 puts "Created matrix with #{matrix[:platform].length * matrix[:collection].length} cells."

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -17,10 +17,7 @@ module PuppetLitmus::InventoryManipulation
                           end
     raise "There is no inventory file at '#{inventory_full_path}'." unless File.exist?(inventory_full_path)
 
-    inventory_hash = YAML.load_file(inventory_full_path)
-    raise "Inventory file is incompatible (version 2 and up). Try the 'bolt project migrate' command." if inventory_hash['version'].nil? || (inventory_hash['version'] < 2)
-
-    inventory_hash
+    YAML.load_file(inventory_full_path)
   end
 
   # Provide a default hash for executing against localhost
@@ -28,7 +25,6 @@ module PuppetLitmus::InventoryManipulation
   # @return [Hash] inventory.yaml hash containing only an entry for localhost
   def localhost_inventory_hash
     {
-      'version' => 2,
       'groups' => [
         {
           'name' => 'local',
@@ -262,7 +258,12 @@ module PuppetLitmus::InventoryManipulation
   # @param inventory_hash [Hash] hash of the inventory.yaml file
   # @param node_name [String] node of nodes to limit the search for the node_name in
   def add_platform_field(inventory_hash, node_name)
-    facts = facts_from_node(inventory_hash, node_name)
+    facts = begin
+      facts_from_node(inventory_hash, node_name)
+    rescue StandardError => e
+      warn e
+      {}
+    end
     Honeycomb.current_span.add_field('litmus.platform', facts&.dig('platform'))
   end
 end

data/lib/puppet_litmus/puppet_helpers.rb

@@ -9,9 +9,9 @@ module PuppetLitmus::PuppetHelpers
   # @return [Boolean] The result of the 2 apply manifests.
   def idempotent_apply(manifest)
     Honeycomb.start_span(name: 'litmus.idempotent_apply') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       manifest_file_location = create_manifest_file(manifest)
-      apply_manifest(nil, expect_failures: false, manifest_file_location: manifest_file_location)
+      apply_manifest(nil, catch_failures: true, manifest_file_location: manifest_file_location)
       apply_manifest(nil, catch_changes: true, manifest_file_location: manifest_file_location)
     end
   end
@@ -30,7 +30,7 @@ module PuppetLitmus::PuppetHelpers
   #  :catch_failures [Boolean] (false) We're after only complete success so allow exit codes 0 and 2 only.
   #  :expect_failures [Boolean] (false) We're after failures specifically so allow exit codes 1, 4, and 6 only.
   #  :manifest_file_location [Path] The place on the target system.
-  #  :hiera_config [Path] The path to the hiera.yaml configuration on the runner.
+  #  :hiera_config [Path] The path to the hiera.yaml configuration on the target.
   #  :prefix_command [String] prefixes the puppet apply command; eg "export LANGUAGE='ja'".
   #  :trace [Boolean] run puppet apply with the trace flag (defaults to `true`).
   #  :debug [Boolean] run puppet apply with the debug flag.
@@ -39,7 +39,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the apply.
   def apply_manifest(manifest, opts = {})
     Honeycomb.start_span(name: 'litmus.apply_manifest') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.manifest', manifest)
       span.add_field('litmus.opts', opts)
 
@@ -83,11 +83,22 @@ module PuppetLitmus::PuppetHelpers
       command_to_run += ' --noop' if !opts[:noop].nil? && (opts[:noop] == true)
       command_to_run += ' --detailed-exitcodes' if use_detailed_exit_codes == true
 
-      span.add_field('litmus.command_to_run', command_to_run)
       span.add_field('litmus.target_node_name', target_node_name)
-      bolt_result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
-      span.add_field('litmus.bolt_result', bolt_result)
 
+      if os[:family] == 'windows'
+        # IAC-1365 - Workaround for BOLT-1535 and bolt issue #1650
+        command_to_run = "try { #{command_to_run}; exit $LASTEXITCODE } catch { write-error $_ ; exit 1 }"
+        span.add_field('litmus.command_to_run', command_to_run)
+        bolt_result = Tempfile.open(['temp', '.ps1']) do |script|
+          script.write(command_to_run)
+          script.close
+          run_script(script.path, target_node_name, [], options: {}, config: nil, inventory: inventory_hash)
+        end
+      else
+        span.add_field('litmus.command_to_run', command_to_run)
+        bolt_result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
+      end
+      span.add_field('litmus.bolt_result', bolt_result)
       result = OpenStruct.new(exit_code: bolt_result.first['value']['exit_code'],
                               stdout: bolt_result.first['value']['stdout'],
                               stderr: bolt_result.first['value']['stderr'])
@@ -117,7 +128,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [String] The path to the location of the manifest.
   def create_manifest_file(manifest)
     Honeycomb.start_span(name: 'litmus.create_manifest_file') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.manifest', manifest)
 
       require 'tmpdir'
@@ -154,7 +165,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Bool] Success. The file was succesfully writtne on the target.
   def write_file(content, destination)
     Honeycomb.start_span(name: 'litmus.write_file') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.destination', destination)
 
       require 'tmpdir'
@@ -191,7 +202,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the command.
   def run_shell(command_to_run, opts = {})
     Honeycomb.start_span(name: 'litmus.run_shell') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.command_to_run', command_to_run)
       span.add_field('litmus.opts', opts)
 
@@ -228,7 +239,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the command.
   def bolt_upload_file(source, destination, opts = {}, options = {})
     Honeycomb.start_span(name: 'litmus.bolt_upload_file') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.source', source)
       span.add_field('litmus.destination', destination)
       span.add_field('litmus.opts', opts)
@@ -280,7 +291,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the task.The values available are stdout, stderr and result.
   def run_bolt_task(task_name, params = {}, opts = {})
     Honeycomb.start_span(name: 'litmus.run_task') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.task_name', task_name)
       span.add_field('litmus.params', params)
       span.add_field('litmus.opts', opts)
@@ -348,7 +359,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the script run.
   def bolt_run_script(script, opts = {}, arguments: [])
     Honeycomb.start_span(name: 'litmus.bolt_run_script') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.script', script)
       span.add_field('litmus.opts', opts)
       span.add_field('litmus.arguments', arguments)

data/lib/puppet_litmus/rake_helper.rb

@@ -9,8 +9,8 @@ Honeycomb.configure do |config|
     config.client = Libhoney::NullClient.new
   end
 end
-process_span = Honeycomb.start_span(name: "litmus: #{([$PROGRAM_NAME] + ($ARGV || [])).join(' ')}", serialized_trace: ENV['HTTP_X_HONEYCOMB_TRACE'])
-ENV['HTTP_X_HONEYCOMB_TRACE'] = process_span.to_trace_header
+process_span = Honeycomb.start_span(name: "litmus: #{([$PROGRAM_NAME] + ($ARGV || [])).join(' ')}", serialized_trace: ENV['HONEYCOMB_TRACE'])
+ENV['HONEYCOMB_TRACE'] = process_span.to_trace_header
 Honeycomb.add_field_to_trace('litmus.pid', Process.pid)
 if defined? PuppetLitmus::VERSION
   Honeycomb.add_field_to_trace('litmus.version', PuppetLitmus::VERSION)
@@ -41,6 +41,13 @@ elsif ENV['GITHUB_ACTIONS'] == 'true'
   Honeycomb.add_field_to_trace('ci.sha', ENV['GITHUB_SHA'])
 end
 at_exit do
+  if $ERROR_INFO.is_a?(SystemExit)
+    process_span.add_field('process.exit_code', $ERROR_INFO.status)
+  elsif $ERROR_INFO
+    process_span.add_field('process.exit_code', $ERROR_INFO.class.name)
+  else
+    process_span.add_field('process.exit_code', 'unknown')
+  end
   process_span.send
 end
 
@@ -96,7 +103,7 @@ module PuppetLitmus::RakeHelper
   # @return [Object] the standard out stream.
   def run_local_command(command)
     Honeycomb.start_span(name: 'litmus.run_local_command') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.command', command)
 
       require 'open3'
@@ -119,13 +126,18 @@ module PuppetLitmus::RakeHelper
 
     Honeycomb.add_field_to_trace('litmus.provisioner', provisioner)
     Honeycomb.start_span(name: 'litmus.provision') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.platform', platform)
-      span.add_field('litmus.inventory', params['inventory'])
+
+      task_name = provisioner_task(provisioner)
+      span.add_field('litmus.task_name', task_name)
+      span.add_field('litmus.params', params)
       span.add_field('litmus.config', DEFAULT_CONFIG_DATA)
 
-      bolt_result = run_task(provisioner_task(provisioner), 'localhost', params, config: DEFAULT_CONFIG_DATA, inventory: nil)
+      bolt_result = run_task(task_name, 'localhost', params, config: DEFAULT_CONFIG_DATA, inventory: nil)
+      span.add_field('litmus.result', bolt_result)
       span.add_field('litmus.node_name', bolt_result&.first&.dig('value', 'node_name'))
+
       raise_bolt_errors(bolt_result, "provisioning of #{platform} failed.")
 
       bolt_result
@@ -148,7 +160,7 @@ module PuppetLitmus::RakeHelper
 
   def tear_down_nodes(targets, inventory_hash)
     Honeycomb.start_span(name: 'litmus.tear_down_nodes') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.targets', targets)
 
       include ::BoltSpec::Run
@@ -160,6 +172,18 @@ module PuppetLitmus::RakeHelper
         next if node_name == 'litmus_localhost'
 
         result = tear_down(node_name, inventory_hash)
+        # Some provisioners tear_down targets that were created as a batch job.
+        # These provisioners should return the list of additional targets
+        # removed so that we do not attempt to process them.
+        if result != [] && result[0]['value'].key?('removed')
+          removed_targets = result[0]['value']['removed']
+          result[0]['value'].delete('removed')
+          removed_targets.each do |removed_target|
+            targets.delete(removed_target)
+            results[removed_target] = result
+          end
+        end
+
         results[node_name] = result unless result == []
       end
       results
@@ -168,7 +192,7 @@ module PuppetLitmus::RakeHelper
 
   def tear_down(node_name, inventory_hash)
     Honeycomb.start_span(name: 'litmus.tear_down') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       # how do we know what provisioner to use
 
       span.add_field('litmus.node_name', node_name)
@@ -184,7 +208,7 @@ module PuppetLitmus::RakeHelper
 
   def install_agent(collection, targets, inventory_hash)
     Honeycomb.start_span(name: 'litmus.install_agent') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.collection', collection)
       span.add_field('litmus.targets', targets)
 
@@ -192,7 +216,6 @@ module PuppetLitmus::RakeHelper
       params = if collection.nil?
                  {}
                else
-                 Honeycomb.current_span.add_field('litmus.collection', collection)
                  { 'collection' => collection }
                end
       raise "puppet_agent was not found in #{DEFAULT_CONFIG_DATA['modulepath']}, please amend the .fixtures.yml file" \
@@ -277,7 +300,7 @@ module PuppetLitmus::RakeHelper
   # @return a bolt result
   def install_module(inventory_hash, target_node_name, module_tar, module_repository = nil, ignore_dependencies = false) # rubocop:disable Style/OptionalBooleanParameter
     Honeycomb.start_span(name: 'install_module') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.target_node_name', target_node_name)
       span.add_field('litmus.module_tar', module_tar)
 
@@ -333,24 +356,30 @@ module PuppetLitmus::RakeHelper
 
   def check_connectivity?(inventory_hash, target_node_name)
     Honeycomb.start_span(name: 'litmus.check_connectivity') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
+      ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       # if we're only checking connectivity for a single node
       if target_node_name
-        span.add_field('litmus.node_name', target_node_name)
+        span.add_field('litmus.target_node_name', target_node_name)
         add_platform_field(inventory_hash, target_node_name)
       end
 
       include ::BoltSpec::Run
       target_nodes = find_targets(inventory_hash, target_node_name)
+      puts "Checking connectivity for #{target_nodes.inspect}"
+      span.add_field('litmus.target_nodes', target_nodes)
+
       results = run_command('cd .', target_nodes, config: nil, inventory: inventory_hash)
       span.add_field('litmus.bolt_result', results)
       failed = []
-      results.each do |result|
-        failed.push(result['target']) if result['status'] == 'failure'
+      results.reject { |r| r['status'] == 'success' }.each do |result|
+        puts "Failure connecting to #{result['target']}:\n#{result.inspect}"
+        failed.push(result['target'])
       end
-      span.add_field('litmus.connectivity_failed', failed)
+      span.add_field('litmus.connectivity_success', results.select { |r| r['status'] == 'success' })
+      span.add_field('litmus.connectivity_failure', results.reject { |r| r['status'] == 'success' })
       raise "Connectivity has failed on: #{failed}" unless failed.length.zero?
 
+      puts 'Connectivity check PASSED.'
       true
     end
   end
@@ -397,4 +426,50 @@ module PuppetLitmus::RakeHelper
 
     nil
   end
+
+  def start_spinner(message)
+    if (ENV['CI'] || '').downcase == 'true'
+      puts message
+      spinner = Thread.new do
+        # CI systems are strange beasts, we only output a '.' every wee while to keep the terminal alive.
+        loop do
+          printf '.'
+          sleep(10)
+        end
+      end
+    else
+      require 'tty-spinner'
+      spinner = TTY::Spinner.new("[:spinner] #{message}")
+      spinner.auto_spin
+    end
+    spinner
+  end
+
+  def stop_spinner(spinner)
+    if (ENV['CI'] || '').downcase == 'true'
+      Thread.kill(spinner)
+    else
+      spinner.success
+    end
+  end
+
+  require 'retryable'
+
+  Retryable.configure do |config|
+    config.sleep = ->(n) { (1.5**n) + Random.rand(0.5) }
+    # config.log_method = ->(retries, exception) do
+    #   Logger.new($stdout).debug("[Attempt ##{retries}] Retrying because [#{exception.class} - #{exception.message}]: #{exception.backtrace.first(5).join(' | ')}")
+    # end
+  end
+
+  class LitmusTimeoutError < StandardError; end
+
+  def with_retries(options: { tries: Float::INFINITY }, max_wait_minutes: 8)
+    stop = Time.now + (max_wait_minutes * 60)
+    Retryable.retryable(options.merge(not: [LitmusTimeoutError])) do
+      raise LitmusTimeoutError if Time.now > stop
+
+      yield
+    end
+  end
 end

data/lib/puppet_litmus/rake_tasks.rb

@@ -33,35 +33,35 @@ namespace :litmus do
     inventory_vars = provision_hash[args[:key]]['vars']
     # Splat the params into environment variables to pass to the provision task but only in this runspace
     provision_hash[args[:key]]['params']&.each { |k, value| ENV[k.upcase] = value.to_s }
-    results = []
     failed_image_message = ''
-    provision_hash[args[:key]]['images'].each do |image|
-      if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-        progress = Thread.new do
-          loop do
-            printf '.'
-            sleep(10)
-          end
-        end
-      else
-        require 'tty-spinner'
-        spinner = TTY::Spinner.new("Provisioning #{image} using #{provisioner} provisioner.[:spinner]")
-        spinner.auto_spin
-      end
-      result = provision(provisioner, image, inventory_vars)
-
-      if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-        Thread.kill(progress)
-      else
-        spinner.success
+    if provision_hash[args[:key]]['images'].instance_of?(Hash)
+      begin
+        spinner = start_spinner("Provisioning multiple images using #{provisioner} provisioner.")
+        result = provision(provisioner, provision_hash[args[:key]]['images'], inventory_vars)
+      ensure
+        stop_spinner(spinner)
       end
 
       if result.first['status'] != 'success'
         failed_image_message += "=====\n#{result.first['target']}\n#{result.first['value']['_output']}\n#{result.inspect}"
       else
-        $stdout.puts "#{result.first['value']['node_name']}, #{image}"
+        $stdout.puts 'Success'
+      end
+    else
+      provision_hash[args[:key]]['images'].each do |image|
+        begin
+          spinner = start_spinner("Provisioning #{image} using #{provisioner} provisioner.")
+          result = provision(provisioner, image, inventory_vars)
+        ensure
+          stop_spinner(spinner)
+        end
+
+        if result.first['status'] != 'success'
+          failed_image_message += "=====\n#{result.first['target']}\n#{result.first['value']['_output']}\n#{result.inspect}"
+        else
+          $stdout.puts "#{result.first['value']['node_name']}, #{image}"
+        end
       end
-      results << result
     end
 
     raise "Failed to provision with '#{provisioner}'\n #{failed_image_message}" unless failed_image_message.empty?
@@ -74,28 +74,35 @@ namespace :litmus do
   desc 'provision a test system using the given provisioner and platform name. See the puppetlabs-provision module tasks for more documentation'
   task :provision, [:provisioner, :platform, :inventory_vars] do |_task, args|
     Rake::Task['spec_prep'].invoke
-    if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-      progress = Thread.new do
-        loop do
-          printf '.'
-          sleep(10)
+
+    begin
+      spinner = start_spinner("Provisioning #{args[:platform]} using #{args[:provisioner]} provisioner.")
+
+      results = provision(args[:provisioner], args[:platform], args[:inventory_vars])
+
+      unless results.first['status'] == 'success'
+        raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}"
+      end
+
+      puts "Successfully provisioned #{args[:platform]} using #{args[:provisioner]}\n"
+
+      target_names = if results.first['value']['node']
+                       [results.first['value']['node']['uri']]
+                     else
+                       results.first['value']['target_names'] || [] # provision_service multi-node provisioning
+                     end
+      target_names.each do |target|
+        Honeycomb.start_span(name: 'litmus.provision.check_connectivity') do |span|
+          span.add_field('target_name', target)
+          with_retries do
+            check_connectivity?(inventory_hash_from_inventory_file, target)
+          end
         end
       end
-    else
-      require 'tty-spinner'
-      spinner = TTY::Spinner.new("Provisioning #{args[:platform]} using #{args[:provisioner]} provisioner.[:spinner]")
-      spinner.auto_spin
-    end
-    results = provision(args[:provisioner], args[:platform], args[:inventory_vars])
-    if results.first['status'] != 'success'
-      raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}"
+    ensure
+      stop_spinner(spinner)
     end
 
-    if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-      Thread.kill(progress)
-    else
-      spinner.success
-    end
     puts "#{results.first['value']['node_name']}, #{args[:platform]}"
   end
 
@@ -118,36 +125,37 @@ namespace :litmus do
 
     results = install_agent(args[:collection], targets, inventory_hash)
     results.each do |result|
-      if result['status'] != 'success'
-        command_to_run = "bolt task run puppet_agent::install --targets #{result['target']} --inventoryfile inventory.yaml --modulepath #{DEFAULT_CONFIG_DATA['modulepath']}"
-        raise "Failed on #{result['target']}\n#{result}\ntry running '#{command_to_run}'"
-      else
-        # validate successful install
-        puts "Successfull install result: #{result.inspect}" if ENV['DEBUG'] == true
-        retries = 0
-        begin
-          responses = run_command('puppet --version', targets, options: {}, config: DEFAULT_CONFIG_DATA, inventory: inventory_hash.clone)
-          responses.each do |response|
-            raise "Error checking puppet version on #{response.to_json}" if response['status'] != 'success'
-          end
-        rescue StandardError => e
-          puts "ERROR:#{e}"
-          # fix the path
-          path_changes = configure_path(inventory_hash)
+      command_to_run = "bolt task run puppet_agent::install --targets #{result['target']} --inventoryfile inventory.yaml --modulepath #{DEFAULT_CONFIG_DATA['modulepath']}"
+      raise "Failed on #{result['target']}\n#{result}\ntry running '#{command_to_run}'" if result['status'] != 'success'
+
+      # validate successful install
+      puts "Successfull install result: #{result.inspect}" if ENV['DEBUG'] == 'true'
+      retries = 0
+      begin
+        responses = run_command('puppet --version', targets, options: {}, config: DEFAULT_CONFIG_DATA, inventory: inventory_hash.clone)
+        responses.each do |response|
+          raise "Error checking puppet version on #{response.to_json}" if response['status'] != 'success'
+        end
+      rescue StandardError => e
+        puts "ERROR:#{e}" if ENV['DEBUG'] == 'true'
+        # fix the path
+        path_changes = configure_path(inventory_hash)
+        if ENV['DEBUG'] == 'true'
           path_changes.each do |change|
             puts "Configuring puppet path result: #{change.inspect}"
           end
-
-          retries += 1
-          sleep 3
-          retry if retries <= 300
-          raise 'Failed to detect installed puppet version after 5 minutes'
         end
 
-        # add puppet-agent feature to successful nodes
-        inventory_hash = add_feature_to_node(inventory_hash, 'puppet-agent', result['target'])
+        retries += 1
+        sleep 3
+        retry if retries <= 300
+        raise 'Failed to detect installed puppet version after 5 minutes'
       end
+
+      # add puppet-agent feature to successful nodes
+      inventory_hash = add_feature_to_node(inventory_hash, 'puppet-agent', result['target'])
     end
+
     # update the inventory with the puppet-agent feature set per node
     write_to_inventory_file(inventory_hash, 'inventory.yaml')
   end
@@ -362,7 +370,7 @@ namespace :litmus do
         success_list = []
         failure_list = []
         # Provision targets depending on what environment we're in
-        if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
+        if ENV['CI'] == 'true'
           # CI systems are strange beasts, we only output a '.' every wee while to keep the terminal alive.
           puts "Running against #{targets.size} targets.\n"
           progress = Thread.new do
@@ -379,7 +387,7 @@ namespace :litmus do
             at_exit { exit! }
 
             env = options[:env].nil? ? {} : options[:env]
-            env['HTTP_X_HONEYCOMB_TRACE'] = Honeycomb.current_span.to_trace_header
+            env['HONEYCOMB_TRACE'] = Honeycomb.current_span.to_trace_header
             stdout, stderr, status = Open3.capture3(env, test)
             ["\n================\n#{title}\n", stdout, stderr, status]
           end
@@ -397,7 +405,7 @@ namespace :litmus do
           spinners = TTY::Spinner::Multi.new("[:spinner] Running against #{targets.size} targets.")
           payloads.each do |title, test, options|
             env = options[:env].nil? ? {} : options[:env]
-            env['HTTP_X_HONEYCOMB_TRACE'] = Honeycomb.current_span.to_trace_header
+            env['HONEYCOMB_TRACE'] = Honeycomb.current_span.to_trace_header
             spinners.register("[:spinner] #{title}") do |sp|
               stdout, stderr, status = Open3.capture3(env, test)
               if status.to_i.zero?

data/lib/puppet_litmus/version.rb

@@ -2,5 +2,5 @@
 
 # version of this gem
 module PuppetLitmus
-  VERSION ||= '0.19.0'
+  VERSION ||= '0.23.1'
 end

data/spec/lib/puppet_litmus/rake_helper_spec.rb

@@ -77,6 +77,42 @@ RSpec.describe PuppetLitmus::RakeHelper do
     end
   end
 
+  context 'with bulk tear_down' do
+    let(:inventory_hash) do
+      { 'groups' =>
+        [{ 'name' => 'ssh_nodes', 'targets' =>
+          [
+            { 'uri' => 'one.host', 'facts' => { 'provisioner' => 'abs', 'platform' => 'ubuntu-1604-x86_64', 'job_id' => 'iac-task-pid-21648' } },
+            { 'uri' => 'two.host', 'facts' => { 'provisioner' => 'abs', 'platform' => 'ubuntu-1804-x86_64', 'job_id' => 'iac-task-pid-21648' } },
+            { 'uri' => 'three.host', 'facts' => { 'provisioner' => 'abs', 'platform' => 'ubuntu-2004-x86_64', 'job_id' => 'iac-task-pid-21648' } },
+            { 'uri' => 'four.host', 'facts' => { 'provisioner' => 'abs', 'platform' => 'ubuntu-2004-x86_64', 'job_id' => 'iac-task-pid-21649' } },
+          ] }] }
+    end
+    let(:targets) { ['one.host'] }
+    let(:params) { { 'action' => 'tear_down', 'node_name' => 'one.host', 'inventory' => Dir.pwd } }
+
+    it 'calls function' do
+      allow(File).to receive(:directory?).with(File.join(described_class::DEFAULT_CONFIG_DATA['modulepath'], 'provision')).and_return(true)
+      allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with('provision::abs', 'localhost', params, config: described_class::DEFAULT_CONFIG_DATA, inventory: nil).and_return(
+        [{ 'target' => 'localhost',
+           'action' => 'task',
+           'object' => 'provision::abs',
+           'status' => 'success',
+           'value' =>
+           { 'status' => 'ok',
+             'removed' =>
+             ['one.host',
+              'two.host',
+              'three.host'] } }],
+      )
+      results = tear_down_nodes(targets, inventory_hash)
+      expect(results.keys).to eq(['one.host', 'two.host', 'three.host'])
+      results.each_value do |value|
+        expect(value[0]['value']).to eq({ 'status' => 'ok' })
+      end
+    end
+  end
+
   context 'with install_agent' do
     let(:inventory_hash) do
       { 'groups' =>

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -68,7 +68,13 @@ describe 'litmus rake tasks' do
 
       allow(File).to receive(:directory?).with(any_args).and_return(true)
       allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with(any_args).and_return(results)
+      allow_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).with(any_args).and_return({})
+      allow_any_instance_of(PuppetLitmus::RakeHelper).to receive(:check_connectivity?).with(any_args).and_return(true)
+
+      expect($stdout).to receive(:puts).with('Provisioning centos:7 using docker provisioner.')
+      expect($stdout).to receive(:puts).with("Successfully provisioned centos:7 using docker\n")
       expect($stdout).to receive(:puts).with('localhost:2222, centos:7')
+
       Rake::Task['litmus:provision'].invoke('docker', 'centos:7')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -90,6 +90,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -171,10 +185,10 @@ files:
 - spec/data/jim.yaml
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/puppet_helpers_spec.rb
+- spec/lib/puppet_litmus/puppet_litmus_version_spec.rb
 - spec/lib/puppet_litmus/rake_helper_spec.rb
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
 - spec/lib/puppet_litmus/util_spec.rb
-- spec/lib/puppet_litmus/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/puppetlabs/puppet_litmus
 licenses:
@@ -188,14 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
@@ -203,7 +217,7 @@ summary: Providing a simple command line tool for puppet content creators, to en
 test_files:
 - spec/spec_helper.rb
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
-- spec/lib/puppet_litmus/version_spec.rb
+- spec/lib/puppet_litmus/puppet_litmus_version_spec.rb
 - spec/lib/puppet_litmus/util_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/rake_helper_spec.rb