puppet_litmus 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28a5409c12ffc5d0ab3b083cabebff39be58c3ed41095cc9711a16f07f49852b
-  data.tar.gz: 9517425db215a6cbafdb1945260f09070dca8a550b2c511be0317c1c5097bac3
+  metadata.gz: 9fcb472feb01cf0ebd62532e0cb58b87fee60285a7c981c416befd43374393c7
+  data.tar.gz: 285b1a3907733f5fc8aa7d29599e257df69ffab3318387ad23952a4947e6b2c7
 SHA512:
-  metadata.gz: 560edd1797551152c839db07af920345603d1a67d400301898b3e4b4841145892c50a0ffc18943c653712370cc1686612cb89503c6a8fc459524b803fcdc0bbf
-  data.tar.gz: 23c9cbf00d3f2af2343c1975b09eb5d43235d87b6cb32347a76db039d4f903aaa732b8ab7677eeeabea10ef08588e910032c2d9d9cf315a96b4aeef1cb8bd57c
+  metadata.gz: fbf13c7c25f17337e7a06c208533c003f5d779e09c31f7363ce228774752e1244a48898174d11728e91744890bd7374a5427b6c66f3c2e9ed97b72cf84ae8e95
+  data.tar.gz: 421817337c42b08ab8bee201e6faf601a6cf65385470db90491c35528815b5578291235b78aa462d860fe9275b3079b3831cad39ae8f7eb5b4115bad771e402e

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -130,14 +130,21 @@ module PuppetLitmus::InventoryManipulation
   # Adds a node to a group specified, if group_name exists in inventory hash.
   #
   # @param inventory_hash [Hash] hash of the inventory.yaml file
-  # @param node_name [String] node to locate in the group
+  # @param node [Hash] node to add to the group
   # group_name [String] group of nodes to limit the search for the node_name in
   # @return [Hash] inventory_hash with node added to group if group_name exists in inventory hash.
-  def add_node_to_group(inventory_hash, node_name, group_name)
-    inventory_hash['groups'].each do |group|
-      if group['name'] == group_name
-        group['nodes'].push node_name
+  def add_node_to_group(inventory_hash, node, group_name)
+    # check if group exists
+    if inventory_hash['groups'].any? { |g| g['name'] == group_name }
+      inventory_hash['groups'].each do |group|
+        if group['name'] == group_name
+          group['nodes'].push node
+        end
       end
+    else
+      # add new group
+      group = { 'name' => group_name, 'nodes' => [node] }
+      inventory_hash['groups'].push group
     end
     inventory_hash
   end

data/lib/puppet_litmus/{serverspec.rb → puppet_helpers.rb}

@@ -2,7 +2,7 @@
 
 # helper functions for running puppet commands. They execute a target system specified by ENV['TARGET_HOST']
 # heavily uses functions from here https://github.com/puppetlabs/bolt/blob/master/developer-docs/bolt_spec-run.md
-module PuppetLitmus::Serverspec
+module PuppetLitmus::PuppetHelpers
   # Applies a manifest twice. First checking for errors. Secondly to make sure no changes occur.
   #
   # @param manifest [String] puppet manifest code to be applied.

data/lib/puppet_litmus/rake_tasks.rb

@@ -7,6 +7,7 @@ require 'open3'
 require 'pdk'
 require 'json'
 require 'parallel'
+require 'tty-spinner'
 
 # helper methods for the litmus rake tasks
 module LitmusRakeHelper
@@ -277,6 +278,7 @@ namespace :litmus do
     # stdout, stderr, _status = Open3.capture3(pdk_build_command)
     # raise "Failed to run 'pdk_build_command',#{stdout} and #{stderr}" if (stderr =~ %r{completed successfully}).nil?
     require 'pdk/module/build'
+
     opts = {}
     opts[:force] = true
     builder = PDK::Module::Build.new(opts)

data/lib/puppet_litmus/version.rb

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

data/lib/puppet_litmus.rb

@@ -5,11 +5,11 @@ module PuppetLitmus; end
 
 require 'bolt_spec/run'
 require 'puppet_litmus/inventory_manipulation'
-require 'puppet_litmus/serverspec'
+require 'puppet_litmus/puppet_helpers'
 
 # Helper methods for testing puppet content
 module PuppetLitmus
   include BoltSpec::Run
   include PuppetLitmus::InventoryManipulation
-  include PuppetLitmus::Serverspec
+  include PuppetLitmus::PuppetHelpers
 end

data/spec/lib/puppet_litmus/inventory_manipulation_spec.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+load File.expand_path('../../../lib/puppet_litmus/inventory_manipulation.rb', __dir__)
+include PuppetLitmus::InventoryManipulation # rubocop:disable Style/MixinUsage
 
 RSpec.describe PuppetLitmus::InventoryManipulation do
-  let(:dummy_class) do
-    dummy = Class.new
-    dummy.extend(described_class)
-    dummy
-  end
-
   context 'with config_from_node' do
     let(:no_config_hash) do
       { 'groups' =>
@@ -19,6 +15,12 @@ RSpec.describe PuppetLitmus::InventoryManipulation do
    { 'name' => 'winrm_nodes', 'nodes' => [] }] }
     end
 
+    let(:no_docker_hash) do
+      { 'groups' =>
+        [{ 'name' => 'ssh_nodes', 'nodes' => [] },
+         { 'name' => 'winrm_nodes', 'nodes' => [] }] }
+    end
+
     let(:config_hash) do
       { 'groups' =>
   [{ 'name' => 'ssh_nodes',
@@ -86,62 +88,77 @@ RSpec.describe PuppetLitmus::InventoryManipulation do
    { 'name' => 'winrm_nodes', 'nodes' => [] }] }
     end
 
+    let(:foo_node) do
+      { 'name' => 'foo',
+        'facts' => { 'provisioner' => 'bar', 'platform' => 'ubuntu' } }
+    end
+
     it 'no matching node, raises' do
-      expect { dummy_class.config_from_node(config_hash, 'not.here') }.to raise_error('No config was found for not.here')
+      expect { described_class.config_from_node(config_hash, 'not.here') }.to raise_error('No config was found for not.here')
     end
 
     it 'no config section, returns nil' do
-      expect(dummy_class.config_from_node(no_config_hash, 'test.delivery.puppetlabs.net')).to eq(nil)
+      expect(described_class.config_from_node(no_config_hash, 'test.delivery.puppetlabs.net')).to eq(nil)
     end
 
     it 'config exists, and returns' do
-      expect(dummy_class.config_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('transport' => 'ssh', 'ssh' =>
+      expect(described_class.config_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('transport' => 'ssh', 'ssh' =>
 { 'user' => 'root', 'password' => 'Qu@lity!', 'host-key-check' => false })
     end
 
     it 'facts exists, and returns' do
-      expect(dummy_class.facts_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64')
+      expect(described_class.facts_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64')
     end
 
     it 'vars exists, and returns' do
-      expect(dummy_class.vars_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('role' => 'agent')
+      expect(described_class.vars_from_node(config_hash, 'test.delivery.puppetlabs.net')).to eq('role' => 'agent')
     end
 
     it 'no feature exists for the group, and returns hash with feature added' do
-      expect(dummy_class.add_feature_to_group(no_feature_hash, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.add_feature_to_group(no_feature_hash, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'feature exists for the group, and returns hash with feature removed' do
-      expect(dummy_class.remove_feature_from_group(feature_hash_group, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => [], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.remove_feature_from_group(feature_hash_group, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => [], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'write from inventory_hash to inventory_yaml file feature_hash_group' do
-      expect { dummy_class.write_to_inventory_file(feature_hash_group, inventory_full_path) }.not_to raise_error
+      expect { described_class.write_to_inventory_file(feature_hash_group, inventory_full_path) }.not_to raise_error
     end
 
     it 'empty feature exists for the group, and returns hash with feature added' do
-      expect(dummy_class.add_feature_to_group(empty_feature_hash_group, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.add_feature_to_group(empty_feature_hash_group, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'no feature exists for the node, and returns hash with feature added' do
-      expect(dummy_class.add_feature_to_node(no_feature_hash, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => ['puppet-agent'] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.add_feature_to_node(no_feature_hash, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => ['puppet-agent'] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'feature exists for the node, and returns hash with feature removed' do
-      expect(dummy_class.remove_feature_from_node(feature_hash_node, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => [] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.remove_feature_from_node(feature_hash_node, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => [] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'write from inventory_hash to inventory_yaml file feature_hash_node' do
-      expect { dummy_class.write_to_inventory_file(feature_hash_node, inventory_full_path) }.not_to raise_error
+      expect { described_class.write_to_inventory_file(feature_hash_node, inventory_full_path) }.not_to raise_error
     end
 
     it 'empty feature exists for the node, and returns hash with feature added' do
-      expect(dummy_class.add_feature_to_node(empty_feature_hash_node, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => ['puppet-agent'] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+      expect(described_class.add_feature_to_node(empty_feature_hash_node, 'puppet-agent', 'test.delivery.puppetlabs.net')).to eq('groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net', 'features' => ['puppet-agent'] }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
     end
 
     it 'write from inventory_hash to inventory_yaml file no feature_hash' do
       expect(File).to exist(inventory_full_path)
-      expect { dummy_class.write_to_inventory_file(no_feature_hash, inventory_full_path) }.not_to raise_error
+      expect { described_class.write_to_inventory_file(no_feature_hash, inventory_full_path) }.not_to raise_error
+    end
+
+    it 'group does not exist in inventory, and returns hash with group added' do
+      expect(described_class.add_node_to_group(no_docker_hash, foo_node, 'docker_nodes')).to eq('groups' =>
+        [{ 'name' => 'ssh_nodes', 'nodes' => [] }, { 'name' => 'winrm_nodes', 'nodes' => [] }, { 'name' => 'docker_nodes', 'nodes' => [foo_node] }])
+    end
+
+    it 'group exists in inventory, and returns hash with node added' do
+      expect(described_class.add_node_to_group(no_docker_hash, foo_node, 'ssh_nodes')).to eq('groups' =>
+        [{ 'name' => 'ssh_nodes', 'nodes' => [foo_node] }, { 'name' => 'winrm_nodes', 'nodes' => [] }])
     end
   end
 end

data/spec/lib/puppet_litmus/{serverspec_spec.rb → puppet_helpers_spec.rb}

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+load File.expand_path('../../../lib/puppet_litmus/puppet_helpers.rb', __dir__)
 
-RSpec.describe PuppetLitmus::Serverspec do
-  let(:dummy_class) do
-    dummy = Class.new
-    dummy.extend(described_class)
-    dummy
-  end
+include PuppetLitmus::PuppetHelpers # rubocop:disable Style/MixinUsage
 
+RSpec.describe PuppetLitmus::PuppetHelpers do
   context 'with idempotent_apply' do
     let(:manifest) do
       "include '::doot'"
     end
 
     it 'calls all functions' do
-      expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-      expect(dummy_class).to receive(:apply_manifest).with(nil, expect_failures: false, manifest_file_location: '/bla.pp')
-      expect(dummy_class).to receive(:apply_manifest).with(nil, catch_changes: true, manifest_file_location: '/bla.pp')
-      dummy_class.idempotent_apply(manifest)
+      expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+      expect(described_class).to receive(:apply_manifest).with(nil, expect_failures: false, manifest_file_location: '/bla.pp')
+      expect(described_class).to receive(:apply_manifest).with(nil, catch_changes: true, manifest_file_location: '/bla.pp')
+      described_class.idempotent_apply(manifest)
     end
   end
 
@@ -31,11 +28,11 @@ RSpec.describe PuppetLitmus::Serverspec do
 
       it 'passes the --hiera_config flag if the :hiera_config opt is specified' do
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-        expect(dummy_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        dummy_class.apply_manifest(manifest, hiera_config: '/hiera.yaml')
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+        expect(described_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        described_class.apply_manifest(manifest, hiera_config: '/hiera.yaml')
       end
     end
 
@@ -47,42 +44,42 @@ RSpec.describe PuppetLitmus::Serverspec do
 
       it 'uses detailed-exitcodes with expect_failures' do
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-        expect(dummy_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        expect { dummy_class.apply_manifest(manifest, expect_failures: true) }.to raise_error(RuntimeError)
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+        expect(described_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        expect { described_class.apply_manifest(manifest, expect_failures: true) }.to raise_error(RuntimeError)
       end
 
       it 'uses detailed-exitcodes with catch_failures' do
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-        expect(dummy_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        dummy_class.apply_manifest(manifest, catch_failures: true)
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+        expect(described_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        described_class.apply_manifest(manifest, catch_failures: true)
       end
 
       it 'uses detailed-exitcodes with expect_changes' do
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-        expect(dummy_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        expect { dummy_class.apply_manifest(manifest, expect_changes: true) }.to raise_error(RuntimeError)
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+        expect(described_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        expect { described_class.apply_manifest(manifest, expect_changes: true) }.to raise_error(RuntimeError)
       end
 
       it 'uses detailed-exitcodes with catch_changes' do
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-        expect(dummy_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        dummy_class.apply_manifest(manifest, catch_changes: true)
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+        expect(described_class).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        described_class.apply_manifest(manifest, catch_changes: true)
       end
 
       it 'uses raises exception for multiple options' do
-        expect { dummy_class.apply_manifest(manifest, catch_changes: true, expect_failures: true) }
+        expect { described_class.apply_manifest(manifest, catch_changes: true, expect_failures: true) }
           .to raise_error(RuntimeError, 'please specify only one of `catch_changes`, `expect_changes`, `catch_failures` or `expect_failures`')
       end
     end
@@ -95,17 +92,17 @@ RSpec.describe PuppetLitmus::Serverspec do
     let(:localhost_inventory_hash) { { 'groups' => [{ 'name' => 'local', 'nodes' => [{ 'name' => 'litmus_localhost', 'config' => { 'transport' => 'local' } }] }] } }
 
     it 'responds to run_shell' do
-      expect(dummy_class).to respond_to(:run_shell).with(1..2).arguments
+      expect(described_class).to respond_to(:run_shell).with(1..2).arguments
     end
 
     context 'when running against localhost and no inventory.yaml file' do
       it 'does run_shell against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_command).with(command_to_run, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
-        expect { dummy_class.run_shell(command_to_run) }.not_to raise_error
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_command).with(command_to_run, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
+        expect { described_class.run_shell(command_to_run) }.not_to raise_error
       end
     end
 
@@ -113,10 +110,10 @@ RSpec.describe PuppetLitmus::Serverspec do
       it 'does run_shell against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_command).with(command_to_run, 'some.host', config: nil, inventory: inventory_hash).and_return(result)
-        expect { dummy_class.run_shell(command_to_run) }.not_to raise_error
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_command).with(command_to_run, 'some.host', config: nil, inventory: inventory_hash).and_return(result)
+        expect { described_class.run_shell(command_to_run) }.not_to raise_error
       end
     end
   end
@@ -133,27 +130,27 @@ RSpec.describe PuppetLitmus::Serverspec do
     let(:localhost_inventory_hash) { { 'groups' => [{ 'name' => 'local', 'nodes' => [{ 'name' => 'litmus_localhost', 'config' => { 'transport' => 'local' } }] }] } }
 
     it 'responds to run_shell' do
-      expect(dummy_class).to respond_to(:bolt_upload_file).with(2..3).arguments
+      expect(described_class).to respond_to(:bolt_upload_file).with(2..3).arguments
     end
 
     context 'when upload returns success' do
       it 'does upload_file against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_success)
-        expect { dummy_class.bolt_upload_file(local, remote) }.not_to raise_error
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_success)
+        expect { described_class.bolt_upload_file(local, remote) }.not_to raise_error
       end
 
       it 'does upload_file against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:upload_file).with(local, remote, 'litmus_localhost', options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result_success)
-        expect { dummy_class.bolt_upload_file(local, remote) }.not_to raise_error
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:upload_file).with(local, remote, 'litmus_localhost', options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result_success)
+        expect { described_class.bolt_upload_file(local, remote) }.not_to raise_error
       end
     end
 
@@ -161,19 +158,19 @@ RSpec.describe PuppetLitmus::Serverspec do
       it 'does upload_file gives runtime error for failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
-        expect { dummy_class.bolt_upload_file(local, remote) }.to raise_error(RuntimeError, %r{upload file failed})
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
+        expect { described_class.bolt_upload_file(local, remote) }.to raise_error(RuntimeError, %r{upload file failed})
       end
 
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
-        method_result = dummy_class.bolt_upload_file(local, remote, expect_failures: true)
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
+        method_result = described_class.bolt_upload_file(local, remote, expect_failures: true)
         expect(method_result.exit_code).to be(255)
         expect(method_result.stderr).to be('No such file or directory @ rb_sysopen - /nonexistant/file/path')
       end
@@ -187,18 +184,18 @@ RSpec.describe PuppetLitmus::Serverspec do
     let(:localhost_inventory_hash) { { 'groups' => [{ 'name' => 'local', 'nodes' => [{ 'name' => 'litmus_localhost', 'config' => { 'transport' => 'local' } }] }] } }
 
     it 'responds to bolt_run_script' do
-      expect(dummy_class).to respond_to(:bolt_run_script).with(1..2).arguments
+      expect(described_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
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_script).with(script, 'litmus_localhost', [], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
-        expect { dummy_class.bolt_run_script(script) }.not_to raise_error
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_script).with(script, 'litmus_localhost', [], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
+        expect { described_class.bolt_run_script(script) }.not_to raise_error
       end
     end
 
@@ -206,10 +203,10 @@ RSpec.describe PuppetLitmus::Serverspec do
       it 'does bolt_run_script against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        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
+        expect(described_class).to receive(:inventory_hash_from_inventory_file)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_script).with(script, 'some.host', [], options: {}, config: nil, inventory: nil).and_return(result)
+        expect { described_class.bolt_run_script(script) }.not_to raise_error
       end
     end
 
@@ -217,11 +214,11 @@ RSpec.describe PuppetLitmus::Serverspec do
       it 'does bolt_run_script with arguments without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
-        expect(dummy_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
-        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_script).with(script, 'litmus_localhost', ['doot'], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
-        expect { dummy_class.bolt_run_script(script, arguments: ['doot']) }.not_to raise_error
+        expect(described_class).to receive(:localhost_inventory_hash).and_return(localhost_inventory_hash)
+        expect(described_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_script).with(script, 'litmus_localhost', ['doot'], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
+        expect { described_class.bolt_run_script(script, arguments: ['doot']) }.not_to raise_error
       end
     end
   end
@@ -239,36 +236,36 @@ RSpec.describe PuppetLitmus::Serverspec do
     let(:inventory_hash) { { 'groups' => [{ 'name' => 'local', 'nodes' => [{ 'name' => 'some.host', 'config' => { 'transport' => 'local' } }] }] } }
 
     it 'responds to bolt_run_task' do
-      expect(dummy_class).to respond_to(:run_bolt_task).with(2..3).arguments
+      expect(described_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
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
-        expect { dummy_class.run_bolt_task(task_name, params, opts: {}) }.not_to raise_error
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
+        expect { described_class.run_bolt_task(task_name, params, opts: {}) }.not_to raise_error
       end
 
       it 'returns stdout for unstructured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
-        method_result = dummy_class.run_bolt_task(task_name, params, opts: {})
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
+        method_result = described_class.run_bolt_task(task_name, params, opts: {})
         expect(method_result.stdout).to eq('SUCCESS!')
       end
 
       it 'returns structured output for structured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_structured_task_success)
-        method_result = dummy_class.run_bolt_task(task_name, params, opts: {})
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_structured_task_success)
+        method_result = described_class.run_bolt_task(task_name, params, opts: {})
         expect(method_result.stdout).to eq('{"key1"=>"foo", "key2"=>"bar"}')
         expect(method_result.result['key1']).to eq('foo')
         expect(method_result.result['key2']).to eq('bar')
@@ -279,19 +276,19 @@ RSpec.describe PuppetLitmus::Serverspec do
       it 'does bolt_task_run gives runtime error for failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        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})
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
+        expect { described_class.run_bolt_task(task_name, params, opts: {}) }.to raise_error(RuntimeError, %r{task failed})
       end
 
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
         expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
-        expect(dummy_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
-        expect(dummy_class).to receive(:target_in_inventory?).and_return(true)
-        expect(dummy_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
-        method_result = dummy_class.run_bolt_task(task_name, params, expect_failures: true)
+        expect(described_class).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+        expect(described_class).to receive(:target_in_inventory?).and_return(true)
+        expect(described_class).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
+        method_result = described_class.run_bolt_task(task_name, params, expect_failures: true)
         expect(method_result.exit_code).to be(123)
         expect(method_result.stderr).to be('FAILURE!')
       end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 require 'rake'
-# rubocop:disable RSpec/AnyInstance
 describe 'litmus rake tasks' do
   before(:all) do # rubocop:disable RSpec/BeforeAfterAll
     load File.expand_path('../../../lib/puppet_litmus/rake_tasks.rb', __dir__)
@@ -83,4 +82,3 @@ describe 'litmus rake tasks' do
     end
   end
 end
-# rubocop:enable RSpec/AnyInstance

data/spec/lib/puppet_litmus/version_spec.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+load File.expand_path('../../../lib/puppet_litmus/version.rb', __dir__)
+
+include PuppetLitmus # rubocop:disable Style/MixinUsage
 
 RSpec.describe PuppetLitmus do
   it 'has a version number' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -39,7 +39,7 @@ dependencies:
         version: 1.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 1.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +102,14 @@ files:
 - README.md
 - lib/puppet_litmus.rb
 - lib/puppet_litmus/inventory_manipulation.rb
+- lib/puppet_litmus/puppet_helpers.rb
 - lib/puppet_litmus/rake_tasks.rb
-- lib/puppet_litmus/serverspec.rb
 - lib/puppet_litmus/version.rb
 - spec/data/doot.tar.gz
 - spec/data/inventory.yaml
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
+- spec/lib/puppet_litmus/puppet_helpers_spec.rb
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
-- spec/lib/puppet_litmus/serverspec_spec.rb
 - spec/lib/puppet_litmus/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/puppetlabs/puppet_litmus
@@ -142,6 +142,6 @@ test_files:
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
 - spec/lib/puppet_litmus/version_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
-- spec/lib/puppet_litmus/serverspec_spec.rb
+- spec/lib/puppet_litmus/puppet_helpers_spec.rb
 - spec/data/doot.tar.gz
 - spec/data/inventory.yaml