puppet_litmus 0.18.4 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60fc5eef658171b749a429d8d302e94c05e8812858206124e90c915a035a8e4e
-  data.tar.gz: 2016992ffee484e5c2ab2b92e0011d98678b21bc1c0e62dd1d75c857ad50db65
+  metadata.gz: ffba803cc6b53c4bdb7084bf11be4fac807f3b3cd237c5ddb297dcf6ca3a403d
+  data.tar.gz: 5cdb613f2be957e20a63fc1250b10113e468e162817657f0f987675f2ba7c055
 SHA512:
-  metadata.gz: f4bb7954ab40c5345dacb291f0fd82a745c7ac5da4e939e07323e23f6c06b7c4758303cc5f9faccf75f67134337ad409edb429ebb438ffe879682460722cacb3
-  data.tar.gz: 3367726403b6691edbb3439377617f894fdffec96f964965bb1e62aa175ade0494920ec166b49da367449c331a9ca6f8e7f87ed2ede707bb7cd7410077e63c38
+  metadata.gz: ea1fd95a69bfac81b56f94f3ee28b91be2587c501bf24729931c128315e41d5eaf937dce013ee0d63ec7a350469ac32ab0d7711e50411a0e5fe00340dabdd803
+  data.tar.gz: 899ac2b0edb422ccf35c9cdb5f46bec6b2a6a97557dca12ffc994e046ed8cf1e6eec2553865a3c4439b272d1dd29b0111fc24b2e1bb93575cb77fc0bfd7606b1

data/exe/matrix_from_metadata

@@ -0,0 +1,62 @@
+#!/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
+
+require 'json'
+
+IMAGE_TABLE = {
+  'RedHat-6' => 'rhel-6',
+  'RedHat-7' => 'rhel-7',
+  'RedHat-8' => 'rhel-8',
+  'SLES-12' => 'sles-12',
+  'SLES-15' => 'sles-15',
+  'Windows-2012 R2' => 'windows-2012-r2-core',
+  'Windows-2016' => 'windows-2016',
+  'Windows-2019' => 'windows-2019-core',
+}.freeze
+
+DOCKER_PLATFORMS = [
+  'CentOS-6',
+  'CentOS-7',
+  'CentOS-8',
+  'Debian-10',
+  'Debian-8',
+  'Debian-9',
+  'OracleLinux-6',
+  'OracleLinux-7',
+  'Scientific-6',
+  'Scientific-7',
+  'Ubuntu-14.04',
+  'Ubuntu-16.04',
+  'Ubuntu-18.04',
+  'Ubuntu-20.04',
+].freeze
+
+matrix = {
+  platform: [],
+  collection: %w[
+    puppet5
+    puppet6
+    puppet7-nightly
+  ],
+}
+
+metadata = JSON.parse(File.read('metadata.json'))
+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|
+    image_key = "#{os}-#{ver}"
+    if IMAGE_TABLE.key? image_key
+      matrix[:platform] << IMAGE_TABLE[image_key]
+    elsif DOCKER_PLATFORMS.include? image_key
+      puts "Expecting #{image_key} test using docker on travis"
+    else
+      puts "::warning::Cannot find image for #{image_key}"
+    end
+  end
+end
+
+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

@@ -18,7 +18,7 @@ module PuppetLitmus::InventoryManipulation
     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.dig('version').nil? || (inventory_hash['version'] < 2)
+    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
   end
@@ -50,12 +50,11 @@ module PuppetLitmus::InventoryManipulation
   # @param targets [Array]
   # @return [Array] array of targets.
   def find_targets(inventory_hash, targets)
-    targets = if targets.nil?
-                inventory_hash.to_s.scan(%r{uri"=>"(\S*)"}).flatten
-              else
-                [targets]
-              end
-    targets
+    if targets.nil?
+      inventory_hash.to_s.scan(%r{uri"=>"(\S*)"}).flatten
+    else
+      [targets]
+    end
   end
 
   # Determines if a node_name exists in a group in the inventory_hash.

data/lib/puppet_litmus/puppet_helpers.rb

@@ -147,6 +147,42 @@ module PuppetLitmus::PuppetHelpers
     end
   end
 
+  # Writes a string variable to a file on a target node at a specified path.
+  #
+  # @param content [String] String data to write to the file.
+  # @param destination [String] The path on the target node to write the file.
+  # @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
+      span.add_field('litmus.destination', destination)
+
+      require 'tmpdir'
+      target_node_name = ENV['TARGET_HOST']
+
+      Tempfile.create('litmus') do |tmp_file|
+        tmp_file.write(content)
+        tmp_file.flush
+        if target_node_name.nil? || target_node_name == 'localhost'
+          require 'fileutils'
+          # no need to transfer
+          FileUtils.cp(tmp_file.path, destination)
+        else
+          # transfer to TARGET_HOST
+          inventory_hash = inventory_hash_from_inventory_file
+          span.add_field('litmus.node_name', target_node_name)
+          add_platform_field(inventory_hash, target_node_name)
+
+          bolt_result = upload_file(tmp_file.path, destination, target_node_name, options: {}, config: nil, inventory: inventory_hash)
+          span.add_field('litmus.bolt_result.file_upload', bolt_result)
+          raise bolt_result.first['value'].to_s unless bolt_result.first['status'] == 'success'
+        end
+      end
+
+      true
+    end
+  end
+
   # Runs a command against the target system
   #
   # @param command_to_run [String] The command to execute.
@@ -382,7 +418,7 @@ module PuppetLitmus::PuppetHelpers
 
   # Return the stdout of the puppet run
   def puppet_output(bolt_result)
-    bolt_result.dig(0, 'value', 'stderr').to_s << \
+    bolt_result.dig(0, 'value', 'stderr').to_s + \
       bolt_result.dig(0, 'value', 'stdout').to_s
   end
 

data/lib/puppet_litmus/rake_helper.rb

@@ -48,7 +48,7 @@ end
 module PuppetLitmus::RakeHelper
   # DEFAULT_CONFIG_DATA should be frozen for our safety, but it needs to work around https://github.com/puppetlabs/bolt/pull/1696
   DEFAULT_CONFIG_DATA ||= { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') } # .freeze # rubocop:disable Style/MutableConstant
-  SUPPORTED_PROVISIONERS ||= %w[abs docker docker_exp vagrant vmpooler].freeze
+  SUPPORTED_PROVISIONERS ||= %w[abs docker docker_exp provision_service vagrant vmpooler].freeze
 
   # Gets a string representing the operating system and version.
   #
@@ -208,9 +208,13 @@ module PuppetLitmus::RakeHelper
   def configure_path(inventory_hash)
     results = []
     # fix the path on ssh_nodes
-    unless inventory_hash['groups'].select { |group| group['name'] == 'ssh_nodes' }.size.zero?
-      results = run_command('echo PATH="$PATH:/opt/puppetlabs/puppet/bin" > /etc/environment',
-                            'ssh_nodes', config: nil, inventory: inventory_hash)
+    unless inventory_hash['groups'].select { |group| group['name'] == 'ssh_nodes' && !group['targets'].empty? }.size.zero?
+      results << run_command('echo PATH="$PATH:/opt/puppetlabs/puppet/bin" > /etc/environment',
+                             'ssh_nodes', config: nil, inventory: inventory_hash)
+    end
+    unless inventory_hash['groups'].select { |group| group['name'] == 'winrm_nodes' && !group['targets'].empty? }.size.zero?
+      results << run_command('[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\Puppet Labs\Puppet\bin;C:\Program Files (x86)\Puppet Labs\Puppet\bin", "Machine")',
+                             'winrm_nodes', config: nil, inventory: inventory_hash)
     end
     results
   end
@@ -227,7 +231,7 @@ module PuppetLitmus::RakeHelper
     module_dir ||= Dir.pwd
     target_dir ||= File.join(source_dir, 'pkg')
 
-    puts "Building '#{module_dir}' into '#{target_dir}''"
+    puts "Building '#{module_dir}' into '#{target_dir}'"
     builder = Puppet::Modulebuilder::Builder.new(module_dir, target_dir, nil)
 
     # Force the metadata to be read. Raises if metadata could not be found
@@ -269,8 +273,9 @@ module PuppetLitmus::RakeHelper
   # @param target_node_name [String] the name of the target where the module should be installed
   # @param module_tar [String] the filename of the module tarball to upload
   # @param module_repository [String] the URL for the forge to use for downloading modules. Defaults to the public Forge API.
+  # @param ignore_dependencies [Boolean] flag used to ignore module dependencies defaults to false.
   # @return a bolt result
-  def install_module(inventory_hash, target_node_name, module_tar, module_repository = nil)
+  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
       span.add_field('litmus.target_node_name', target_node_name)
@@ -290,6 +295,7 @@ module PuppetLitmus::RakeHelper
 
       module_repository_opts = "--module_repository '#{module_repository}'" unless module_repository.nil?
       install_module_command = "puppet module install #{module_repository_opts} #{File.basename(module_tar)}"
+      install_module_command += ' --ignore-dependencies --force' if ignore_dependencies.to_s.downcase == 'true'
       span.add_field('litmus.install_module_command', install_module_command)
 
       bolt_result = run_command(install_module_command, target_nodes, config: nil, inventory: inventory_hash.clone)

data/lib/puppet_litmus/rake_tasks.rb

@@ -59,7 +59,7 @@ namespace :litmus do
       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 "#{result.first['value']['node_name']}, #{image}"
       end
       results << result
     end
@@ -122,21 +122,34 @@ namespace :litmus do
         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)
+          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'])
       end
     end
     # update the inventory with the puppet-agent feature set per node
     write_to_inventory_file(inventory_hash, 'inventory.yaml')
-
-    # fix the path on ssh_nodes
-    results = configure_path(inventory_hash)
-
-    results.each do |result|
-      if result['status'] != 'success'
-        puts "Failed on #{result['target']}\n#{result}"
-      end
-    end
   end
 
   # Add a given feature to a selection of nodes
@@ -195,8 +208,8 @@ namespace :litmus do
   # @param :source [String] source directory to look in (ignores symlinks) defaults do './spec/fixtures/modules'.
   # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
   desc 'build and install all modules from a directory'
-  task :install_modules_from_directory, [:source, :target_node_name, :module_repository] do |_task, args|
-    args.with_defaults(source: nil, target_node_name: nil, module_repository: nil)
+  task :install_modules_from_directory, [:source, :target_node_name, :module_repository, :ignore_dependencies] do |_task, args|
+    args.with_defaults(source: nil, target_node_name: nil, module_repository: nil, ignore_dependencies: false)
     inventory_hash = inventory_hash_from_inventory_file
     target_nodes = find_targets(inventory_hash, args[:target_node_name])
     if target_nodes.empty?
@@ -217,7 +230,7 @@ namespace :litmus do
     module_tars.each do |module_tar|
       puts "Installing '#{module_tar}'"
       target_nodes.each do |target_node_name|
-        install_module(inventory_hash, target_node_name, module_tar, args[:module_repository])
+        install_module(inventory_hash, target_node_name, module_tar, args[:module_repository], args[:ignore_dependencies])
         puts "Installed '#{module_tar}' on #{target_node_name}"
       end
     end
@@ -321,15 +334,21 @@ namespace :litmus do
 
       # Run acceptance tests against all machines in the inventory file in parallel.
       desc 'Run tests in parallel against all machines in the inventory file'
-      task :parallel do
+      task :parallel, [:tag] do |_task, args|
+        args.with_defaults(tag: nil)
         if targets.empty?
           puts 'No targets found'
           exit 0
         end
+        tag_value = if args[:tag].nil?
+                      nil
+                    else
+                      "--tag #{args[:tag]}"
+                    end
         payloads = []
         # Generate list of targets to provision
         targets.each do |target|
-          test = 'bundle exec rspec ./spec/acceptance --format progress --require rspec_honeycomb_formatter --format RSpecHoneycombFormatter'
+          test = "bundle exec rspec ./spec/acceptance #{tag_value} --format progress --require rspec_honeycomb_formatter --format RSpecHoneycombFormatter"
           title = "#{target}, #{facts_from_node(inventory_hash, target)['platform']}"
           options = {
             env: {
@@ -367,9 +386,9 @@ namespace :litmus do
           # because we cannot modify variables inside of Parallel
           results.each do |result|
             if result.last.to_i.zero?
-              success_list.push(result.first.scan(%r{.*})[2])
+              success_list.push(result.first.scan(%r{.*})[3])
             else
-              failure_list.push(result.first.scan(%r{.*})[2])
+              failure_list.push(result.first.scan(%r{.*})[3])
             end
           end
           Thread.kill(progress)
@@ -411,8 +430,9 @@ namespace :litmus do
         desc "Run serverspec against #{target}"
         next if target == 'litmus_localhost'
 
-        RSpec::Core::RakeTask.new(target.to_sym) do |t|
+        RSpec::Core::RakeTask.new(target.to_sym, :tag) do |t, args|
           t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+          t.rspec_opts = "--tag #{args[:tag]}" unless args[:tag].nil?
           ENV['TARGET_HOST'] = target
         end
       end
@@ -421,8 +441,9 @@ namespace :litmus do
     # add localhost separately
     desc 'Run serverspec against localhost, USE WITH CAUTION, this action can be potentially dangerous.'
     host = 'localhost'
-    RSpec::Core::RakeTask.new(host.to_sym) do |t|
+    RSpec::Core::RakeTask.new(host.to_sym, :tag) do |t, args|
       t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+      t.rspec_opts = "--tag #{args[:tag]}" unless args[:tag].nil?
       Rake::Task['spec_prep'].invoke
       ENV['TARGET_HOST'] = host
     end

data/lib/puppet_litmus/spec_helper_acceptance.rb

@@ -35,6 +35,7 @@ module PuppetLitmus
         options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil?
         options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil?
         options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil?
+        run_as = node_config.dig('ssh', 'run-as') unless node_config.dig('ssh', 'run-as').nil?
         # Support both net-ssh 4 and 5.
         # rubocop:disable Metrics/BlockNesting
         options[:verify_host_key] = if node_config.dig('ssh', 'host-key-check').nil?
@@ -67,6 +68,8 @@ module PuppetLitmus
         set :host,        options[:host_name] || host
         set :ssh_options, options
         set :request_pty, false
+        set :sudo_password, options[:password] if run_as
+        puts "Running tests as #{run_as}" if run_as
       elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'winrm_nodes')
         require 'winrm'
 

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/puppet_helpers_spec.rb

@@ -113,10 +113,10 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     let(:local) { '/tmp' }
     let(:remote) { '/remote_tmp' }
     # Ignore rubocop because these hashes are representative of output from an external method and editing them leads to test failures.
-    # rubocop:disable Layout/SpaceInsideHashLiteralBraces, Layout/SpaceInsideBlockBraces, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
-    let(:result_success) {[{'target'=>'some.host','action'=>'upload','object'=>'C:\foo\bar.ps1','status'=>'success','value'=>{'_output'=>'Uploaded \'C:\foo\bar.ps1\' to \'some.host:C:\bar\''}}]}
-    let(:result_failure) {[{'target'=>'some.host','action'=>nil,'object'=>nil,'status'=>'failure','value'=>{'_error'=>{'kind'=>'puppetlabs.tasks/task_file_error','msg'=>'No such file or directory @ rb_sysopen - /nonexistant/file/path','details'=>{},'issue_code'=>'WRITE_ERROR'}}}]}
-    # rubocop:enable Layout/SpaceInsideHashLiteralBraces, Layout/SpaceInsideBlockBraces, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
+    # rubocop:disable Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
+    let(:result_success) { [{ 'target'=>'some.host','action'=>'upload','object'=>'C:\foo\bar.ps1','status'=>'success','value'=>{ '_output'=>'Uploaded \'C:\foo\bar.ps1\' to \'some.host:C:\bar\'' } }] }
+    let(:result_failure) { [{ 'target'=>'some.host','action'=>nil,'object'=>nil,'status'=>'failure','value'=>{ '_error'=>{ 'kind'=>'puppetlabs.tasks/task_file_error','msg'=>'No such file or directory @ rb_sysopen - /nonexistant/file/path','details'=>{},'issue_code'=>'WRITE_ERROR' } } }] }
+    # rubocop:enable, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
 
     it 'responds to run_shell' do
       expect(self).to respond_to(:bolt_upload_file).with(2..3).arguments
@@ -212,11 +212,11 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     let(:params) { { 'action' => 'install', 'name' => 'foo' } }
     let(:config_data) { { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') } }
     # Ignore rubocop because these hashes are representative of output from an external method and editing them leads to test failures.
-    # rubocop:disable Layout/SpaceInsideHashLiteralBraces, Layout/SpaceBeforeBlockBraces, Layout/SpaceInsideBlockBraces, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
-    let(:result_unstructured_task_success){ [{'target'=>'some.host','action'=>'task','object'=>'testtask::unstructured','status'=>'success','value'=>{'_output'=>'SUCCESS!'}}]}
-    let(:result_structured_task_success){ [{'target'=>'some.host','action'=>'task','object'=>'testtask::structured','status'=>'success','value'=>{'key1'=>'foo','key2'=>'bar'}}]}
-    let(:result_failure) {[{'target'=>'some.host','action'=>'task','object'=>'testtask::unstructured','status'=>'failure','value'=>{'_error'=>{'msg'=>'FAILURE!','kind'=>'puppetlabs.tasks/task-error','details'=>{'exitcode'=>123}}}}]}
-    # rubocop:enable Layout/SpaceInsideHashLiteralBraces, Layout/SpaceBeforeBlockBraces, Layout/SpaceInsideBlockBraces, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
+    # rubocop:disable Layout/SpaceBeforeBlockBraces
+    let(:result_unstructured_task_success){ [{ 'target'=>'some.host','action'=>'task','object'=>'testtask::unstructured','status'=>'success','value'=>{ '_output'=>'SUCCESS!' } }] }
+    let(:result_structured_task_success){ [{ 'target'=>'some.host','action'=>'task','object'=>'testtask::structured','status'=>'success','value'=>{ 'key1'=>'foo','key2'=>'bar' } }] }
+    let(:result_failure) { [{ 'target'=>'some.host','action'=>'task','object'=>'testtask::unstructured','status'=>'failure','value'=>{ '_error'=>{ 'msg'=>'FAILURE!','kind'=>'puppetlabs.tasks/task-error','details'=>{ 'exitcode'=>123 } } } }] }
+    # rubocop:enable Layout/SpaceBeforeBlockBraces, Layout/SpaceAroundOperators, Layout/LineLength, Layout/SpaceAfterComma
 
     it 'responds to bolt_run_task' do
       expect(self).to respond_to(:run_bolt_task).with(2..3).arguments
@@ -286,4 +286,42 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
       end
     end
   end
+
+  describe '.write_file' do
+    let(:content) { 'foo' }
+    let(:destination) { '/tmp/foo' }
+    let(:owner) { 'foo:foo' }
+    let(:local_path) { '/tmp/local_foo' }
+
+    before(:each) do
+      allow_any_instance_of(File).to receive(:path).and_return(local_path)
+    end
+
+    it 'responds to write_file' do
+      expect(self).to respond_to(:write_file).with(2).arguments
+    end
+
+    context 'without setting owner' do
+      it 'call upload file with the correct params' do
+        stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
+        expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        result = instance_double('result')
+        allow(result).to receive(:first).and_return({ 'status' => 'success' })
+        expect(self).to receive(:upload_file).with(local_path, destination, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result)
+        result = write_file(content, destination)
+        expect(result).to be true
+      end
+    end
+
+    context 'when upload encounters an error' do
+      it 'call upload file with the correct params' do
+        stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
+        expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        result = instance_double('result')
+        allow(result).to receive(:first).and_return({ 'status' => 'failure', 'value' => 'foo error' })
+        expect(self).to receive(:upload_file).with(local_path, destination, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result)
+        expect { write_file(content, destination) }.to raise_error 'foo error'
+      end
+    end
+  end
 end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -19,9 +19,9 @@ describe 'litmus rake tasks' do
                    'template-ref' => 'heads/master-0-g7827fc2' }
       expect(File).to receive(:read).with(any_args).once
       expect(JSON).to receive(:parse).with(any_args).and_return(metadata)
-      expect(STDOUT).to receive(:puts).with('redhat-5-x86_64')
-      expect(STDOUT).to receive(:puts).with('ubuntu-1404-x86_64')
-      expect(STDOUT).to receive(:puts).with('ubuntu-1804-x86_64')
+      expect($stdout).to receive(:puts).with('redhat-5-x86_64')
+      expect($stdout).to receive(:puts).with('ubuntu-1404-x86_64')
+      expect($stdout).to receive(:puts).with('ubuntu-1804-x86_64')
       Rake::Task['litmus:metadata'].invoke
     end
   end
@@ -39,11 +39,11 @@ describe 'litmus rake tasks' do
       expect_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
       expect(File).to receive(:directory?).with(target_dir).and_return(true)
       expect_any_instance_of(Object).to receive(:build_modules_in_dir).with(target_dir).and_return([dummy_tar])
-      expect(STDOUT).to receive(:puts).with(start_with('Building all modules in'))
+      expect($stdout).to receive(:puts).with(start_with('Building all modules in'))
       expect_any_instance_of(Object).to receive(:upload_file).once.and_return([])
-      expect(STDOUT).to receive(:puts).with(start_with('Installing \'spec/data/doot.tar.gz\''))
+      expect($stdout).to receive(:puts).with(start_with('Installing \'spec/data/doot.tar.gz\''))
       expect_any_instance_of(Object).to receive(:run_command).twice.and_return([])
-      expect(STDOUT).to receive(:puts).with(start_with('Installed \'spec/data/doot.tar.gz\''))
+      expect($stdout).to receive(:puts).with(start_with('Installed \'spec/data/doot.tar.gz\''))
       Rake::Task['litmus:install_modules_from_directory'].invoke('./spec/fixtures/modules')
     end
   end
@@ -68,7 +68,7 @@ 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)
-      expect(STDOUT).to receive(:puts).with('localhost:2222, centos:7')
+      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.18.4
+  version: 0.19.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -79,7 +79,7 @@ dependencies:
         version: '1.34'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '1.34'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -150,12 +150,14 @@ description: "    Providing a simple command line tool for puppet content creato
   to enable simple and complex test deployments.\n"
 email:
 - info@puppet.com
-executables: []
+executables:
+- matrix_from_metadata
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- exe/matrix_from_metadata
 - lib/puppet_litmus.rb
 - lib/puppet_litmus/inventory_manipulation.rb
 - lib/puppet_litmus/puppet_helpers.rb
@@ -193,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable