puppet_litmus 0.18.2 → 0.21.0

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?
@@ -66,7 +67,9 @@ module PuppetLitmus
                end
         set :host,        options[:host_name] || host
         set :ssh_options, options
-        set :request_pty, true
+        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.2'
+  VERSION ||= '0.21.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_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' =>
@@ -100,20 +136,20 @@ RSpec.describe PuppetLitmus::RakeHelper do
         [{ 'name' => 'ssh_nodes', 'targets' =>
           [{ 'uri' => 'some.host', 'facts' => { 'provisioner' => 'docker', 'container_name' => 'foo', 'platform' => 'some.host' } }] }] }
     end
-    let(:module_tar) { '/tmp/foo.tar.gz' }
+    let(:module_tar) { 'foo.tar.gz' }
     let(:targets) { ['some.host'] }
     let(:uninstall_module_command) { 'puppet module uninstall foo --force' }
-    let(:install_module_command) { "puppet module install --module_repository 'https://forgeapi.puppetlabs.com' #{module_tar}" }
+    let(:install_module_command) { "puppet module install --module_repository 'https://forgeapi.example.com' #{module_tar}" }
 
     it 'calls function' do
       allow_any_instance_of(BoltSpec::Run).to receive(:upload_file).with(module_tar, module_tar, targets, options: {}, config: nil, inventory: inventory_hash).and_return([])
       allow(File).to receive(:exist?).with(File.join(Dir.pwd, 'metadata.json')).and_return(true)
       allow(File).to receive(:read).with(File.join(Dir.pwd, 'metadata.json')).and_return(JSON.dump({ name: 'foo' }))
-      allow(Open3).to receive(:capture3).with("bundle exec bolt file upload \"#{module_tar}\" /tmp/#{File.basename(module_tar)} --targets all --inventoryfile inventory.yaml")
+      allow(Open3).to receive(:capture3).with("bundle exec bolt file upload \"#{module_tar}\" #{File.basename(module_tar)} --targets all --inventoryfile inventory.yaml")
                                         .and_return(['success', '', 0])
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(uninstall_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
       allow_any_instance_of(BoltSpec::Run).to receive(:run_command).with(install_module_command, targets, config: nil, inventory: inventory_hash).and_return([])
-      install_module(inventory_hash, nil, module_tar)
+      install_module(inventory_hash, nil, module_tar, 'https://forgeapi.example.com')
     end
   end
 

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -19,17 +19,17 @@ 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
 
   context 'with litmus:install_modules_from_directory' do
     let(:inventory_hash) { { 'groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'uri' => 'some.host' }] }] } }
-    let(:target_folder) { File.join(Dir.pwd, 'spec/fixtures/modules') }
-    let(:dummy_tar) { File.new('spec/data/doot.tar.gz') }
+    let(:target_dir) { File.join(Dir.pwd, 'spec/fixtures/modules') }
+    let(:dummy_tar) { 'spec/data/doot.tar.gz' }
 
     it 'happy path' do
       allow(File).to receive(:exist?).with(File.join(Dir.pwd, 'metadata.json')).and_return(true)
@@ -37,12 +37,13 @@ describe 'litmus rake tasks' do
 
       stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
       expect_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-      expect(File).to receive(:directory?).with(target_folder).and_return(true)
-      expect_any_instance_of(Object).to receive(:build_modules_in_folder).with(target_folder).and_return([dummy_tar])
-      expect(STDOUT).to receive(:puts).with('Building')
+      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_any_instance_of(Object).to receive(:upload_file).once.and_return([])
-      expect(STDOUT).to receive(:puts).with("\nInstalling")
+      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\''))
       Rake::Task['litmus:install_modules_from_directory'].invoke('./spec/fixtures/modules')
     end
   end
@@ -67,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)
-      expect(STDOUT).to receive(:puts).with('localhost:2222, centos:7')
+      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.18.2
+  version: 0.21.0
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -34,16 +34,22 @@ dependencies:
   name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -73,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
@@ -83,23 +89,23 @@ dependencies:
         version: '1.34'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: retryable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -113,7 +119,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: honeycomb-beeline
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -127,7 +133,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_honeycomb_formatter
+  name: honeycomb-beeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -141,55 +147,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ed25519
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: bcrypt_pbkdf
+  name: rspec_honeycomb_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 description: "    Providing a simple command line tool for puppet content creators,
   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
@@ -203,16 +185,16 @@ 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:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,22 +202,22 @@ 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.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
   simple and complex test deployments.
 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