puppet_litmus 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8186fb041ca1c958fb32f75389eceb29cbe6c107c0510b725fdc2bba18b900
-  data.tar.gz: 7ffe43266b6c14f59f1c306f86c018f44b312d9ee02e9253e3b3cbd38932f26e
+  metadata.gz: fe018c648a86597b46e5cdb5840468cb790e3471b49c25d5fd4003c57f140ca6
+  data.tar.gz: 180250778c72cb783085036e6ee1908f7d99533f2b26dd92b7fa963711942a03
 SHA512:
-  metadata.gz: 12e95c5b22a998f54833adf7edd459ace61a85cceabc1463c5d572110aa2241c7642c96ab943ff6c9a6b8e5be4e42ff925fbaa19a6b4752f14ca5b9b0f050cda
-  data.tar.gz: 0b7570f08589b2603390f89920cf689a4e4f5491ed279e0dc7498aa3b182b9aa586c96a81be13cb16297d5ab7f6e92ec7eb82e0c31a1eebb4c88552471a2ce74
+  metadata.gz: 2a7f75b8b6a1bd870e6df72d784f1bfa433b0a663b3e3cc505a6feb6d404998591f6bb62e183a385de44412bc45a0ca0986f15e969a7adfde8f89522de36deac
+  data.tar.gz: 5d571a1f5fba0acad3425fab872bcd1abe404137be45b0aec2cb433f7b89e6f3c3d1eca9ce27173c160cce76d50ef84f420b20399110c3bf744910bfbefe2ccc

data/lib/puppet_litmus/serverspec.rb

@@ -137,15 +137,16 @@ module PuppetLitmus::Serverspec
   #
   # @param task_name [String] The name of the task to run.
   # @param params [Hash] key : value pairs to be passed to the task.
-  # @return [Object] A result object from the task.
-  def run_bolt_task(task_name, params = {})
+  # @param opts [Hash] Alters the behaviour of the command. Valid options are :expect_failures [Boolean] doesnt return an exit code of non-zero if the command failed.
+  # @return [Object] A result object from the task.The values available are stdout, stderr and result.
+  def run_bolt_task(task_name, params = {}, opts = {})
     config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
     inventory_hash = inventory_hash_from_inventory_file
     target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
 
     result = run_task(task_name, target_node_name, params, config: config_data, inventory: inventory_hash)
 
-    raise "task failed\n`#{task_name}`\n======\n#{result}" if result.first['status'] != 'success'
+    raise "task failed\n`#{task_name}`\n======\n#{result}" if result.first['status'] != 'success' && opts[:expect_failures] != true
 
     exit_code = if result.first['status'] == 'success'
                   0
@@ -154,7 +155,34 @@ module PuppetLitmus::Serverspec
                 end
     result = OpenStruct.new(exit_code: exit_code,
                             stdout: result.first['result']['status'],
-                            stderr: result.first['result']['status'])
+                            stderr: result.first['result']['stderr'],
+                            result: result.first['result'])
+    yield result if block_given?
+    result
+  end
+
+  # Runs a script against the target system.
+  #
+  # @param script [String] The path to the script on the source machine
+  # @param opts [Hash] Alters the behaviour of the command. Valid options are :expect_failures [Boolean] doesnt return an exit code of non-zero if the command failed.
+  # @param arguments [Array] Array of arguments to pass to script on runtime
+  # @yieldreturn [Block] this method will yield to a block of code passed by the caller; this can be used for additional validation, etc.
+  # @return [Object] A result object from the script run.
+  def bolt_run_script(script, opts = {}, arguments: [])
+    target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
+    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
+                       nil
+                     else
+                       inventory_hash_from_inventory_file
+                     end
+
+    result = run_script(script, target_node_name, arguments, options: opts, config: nil, inventory: inventory_hash)
+
+    raise "script run failed\n`#{script}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
+
+    result = OpenStruct.new(exit_code: result.first['result']['exit_code'],
+                            stdout: result.first['result']['stdout'],
+                            stderr: result.first['result']['stderr'])
     yield result if block_given?
     result
   end

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/serverspec_spec.rb

@@ -79,4 +79,72 @@ RSpec.describe PuppetLitmus::Serverspec do
       end
     end
   end
+
+  describe '.bolt_run_script' do
+    let(:script) { '/tmp/script.sh' }
+    let(:result) { ['result' => { 'exit_code' => 0, 'stdout' => nil, 'stderr' => nil }] }
+    let(:inventory_hash) { Hash.new(0) }
+
+    it 'responds to bolt_run_script' do
+      expect(dummy_class).to respond_to(:bolt_run_script).with(1..2).arguments
+    end
+
+    context 'when running against localhost and no inventory.yaml file' do
+      it 'does bolt_run_script against localhost without error' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('localhost')
+        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(dummy_class).to receive(:run_script).with(script, 'localhost', [], options: {}, config: nil, inventory: nil).and_return(result)
+        expect { dummy_class.bolt_run_script(script) }.not_to raise_error
+      end
+    end
+
+    context 'when running against remote host' do
+      it 'does bolt_run_script against remote host without error' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('some.host')
+        expect(dummy_class).to receive(:inventory_hash_from_inventory_file)
+        expect(dummy_class).to receive(:run_script).with(script, 'some.host', [], options: {}, config: nil, inventory: nil).and_return(result)
+        expect { dummy_class.bolt_run_script(script) }.not_to raise_error
+      end
+    end
+
+    context 'when running with arguments' do
+      it 'does bolt_run_script with arguments without error' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('localhost')
+        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(dummy_class).to receive(:run_script).with(script, 'localhost', ['doot'], options: {}, config: nil, inventory: nil).and_return(result)
+        expect { dummy_class.bolt_run_script(script, arguments: ['doot']) }.not_to raise_error
+      end
+    end
+  end
+
+  describe '.run_bolt_task' do
+    let(:task_name) { 'testtask' }
+    let(:params) { { 'action' => 'install', 'name' => 'foo' } }
+    let(:config_data) { { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') } }
+    let(:result_success) { ['status' => 'success', 'result' => { 'exit_code' => 0, 'stdout' => nil, 'stderr' => nil, 'result' => nil }] }
+    let(:result_failure) { ['status' => 'failure', 'result' => { 'exit_code' => 255, 'stdout' => 'failure', 'stderr' => 'failure', 'result' => nil }] }
+    let(:inventory_hash) { Hash.new(0) }
+
+    it 'responds to bolt_run_task' do
+      expect(dummy_class).to respond_to(:run_bolt_task).with(2..3).arguments
+    end
+
+    context 'when bolt returns success' do
+      it 'does bolt_task_run gives no runtime error for success' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('some.host')
+        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_success)
+        expect { dummy_class.run_bolt_task(task_name, params, opts: {}) }.not_to raise_error
+      end
+    end
+
+    context 'when bolt returns failure' do
+      it 'does bolt_task_run gives runtime error for failure' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('some.host')
+        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
+        expect { dummy_class.run_bolt_task(task_name, params, opts: {}) }.to raise_error(RuntimeError, %r{task failed})
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -110,7 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable