puppet_litmus 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8793e294b24574549eb709f40fd2f4c60a7995e
-  data.tar.gz: 5f786dd179b80096027dbd60a5a0e3cfb805dc19
+  metadata.gz: 33763c6946158b131037d7d28f96b7db4ae5b924
+  data.tar.gz: f85aa0cd77c310d4e798f8676189839bb4276d2b
 SHA512:
-  metadata.gz: ddb4a53476e159cf891c661830f6d94af3600c1a6ce4127ca3cd7b9401aa51cd3efca458794b0e8ebd040b3269f783b52da3e285a1a99892ce0e9ae7f5e693b5
-  data.tar.gz: 9a730ae696a455ecd35ec5c544920b0a349a59aa9c42c63f897fe20d0c7e2dfe9757ae2cbee70bd3ce5a5a61b05569cc62f4f20418a94d7cf0cac8adb28f2325
+  metadata.gz: 345cfa379161bccf03db5945499114e6d322161891b66d85aac934e7cd8de8834cc73c465d65a19c482cf8320d22c1ae89b1afb8bcc9794dab2faf3a7460aeec
+  data.tar.gz: bc6916ad37c08f73ab2594c9537e14212257583e37437c396ea1f716219edfdda2a9be430c9d55bc8b7b1f777ec27beac7c76f1a97fb6d676f72bb36327a3ccf

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -2,6 +2,10 @@
 
 # helper functions for manipulating and reading a bolt inventory file
 module PuppetLitmus::InventoryManipulation
+  # Creates an inventory hash from the inventory.yaml.
+  #
+  # @param inventory_full_path [String] path to the inventory.yaml file
+  # @return [Hash] hash of the inventory.yaml file.
   def inventory_hash_from_inventory_file(inventory_full_path = nil)
     inventory_full_path = if inventory_full_path.nil?
                             'inventory.yaml'
@@ -14,6 +18,11 @@ module PuppetLitmus::InventoryManipulation
     inventory_hash
   end
 
+  # Finds targets to perform operations on from an inventory hash.
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param targets [Array]
+  # @return [Array] array of targets.
   def find_targets(inventory_hash, targets)
     if targets.nil?
       inventory = Bolt::Inventory.new(inventory_hash, nil)
@@ -24,6 +33,12 @@ module PuppetLitmus::InventoryManipulation
     targets
   end
 
+  # Determines if a node_name exists in a group in the inventory_hash.
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param node_name [String] node to locate in the group
+  # @param group_name [String] group of nodes to limit the search for the node_name in
+  # @return [Boolean] true if node_name exists in group_name.
   def target_in_group(inventory_hash, node_name, group_name)
     exists = false
     inventory_hash['groups'].each do |group|
@@ -36,6 +51,11 @@ module PuppetLitmus::InventoryManipulation
     exists
   end
 
+  # Finds a config hash in the inventory hash by searching for a node name.
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param node_name [String] node to locate in the group
+  # @return [Hash] config for node of name node_name
   def config_from_node(inventory_hash, node_name)
     inventory_hash['groups'].each do |group|
       group['nodes'].each do |node|
@@ -47,6 +67,11 @@ module PuppetLitmus::InventoryManipulation
     raise "No config was found for #{node_name}"
   end
 
+  # Finds a facts hash in the inventory hash by searching for a node name.
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param node_name [String] node to locate in the group
+  # @return [Hash] facts for node of name node_name
   def facts_from_node(inventory_hash, node_name)
     inventory_hash['groups'].each do |group|
       group['nodes'].each do |node|
@@ -55,9 +80,15 @@ module PuppetLitmus::InventoryManipulation
         end
       end
     end
-    raise "No config was found for #{node_name}"
+    raise "No facts were found for #{node_name}"
   end
 
+  # 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
+  # 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
@@ -67,6 +98,11 @@ module PuppetLitmus::InventoryManipulation
     inventory_hash
   end
 
+  # Removes named node from a group inside an inventory_hash.
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param node_name [String] node to locate in the group
+  # @return [Hash] inventory_hash with node of node_name removed.
   def remove_node(inventory_hash, node_name)
     inventory_hash['groups'].each do |group|
       group['nodes'].delete_if { |i| i['name'] == node_name }

data/lib/puppet_litmus/rake_tasks.rb

@@ -8,51 +8,64 @@ require 'pdk'
 require 'json'
 require 'parallel'
 
-def get_metadata_operating_systems(metadata)
-  return unless metadata.is_a?(Hash)
-  return unless metadata['operatingsystem_support'].is_a?(Array)
-
-  metadata['operatingsystem_support'].each do |os_info|
-    next unless os_info['operatingsystem'] && os_info['operatingsystemrelease']
-
-    os_name = case os_info['operatingsystem']
-              when 'Amazon', 'Archlinux', 'AIX', 'OSX'
-                next
-              when 'OracleLinux'
-                'oracle'
-              when 'Windows'
-                'win'
-              else
-                os_info['operatingsystem'].downcase
-              end
+# helper methods for the litmus rake tasks
+module LitmusRakeHelper
+  # Gets a string representing the operating system and version.
+  #
+  # @param metadata [Hash] metadata to parse for operating system info
+  # @return [String] the operating system string with version info for use in provisioning.
+  def get_metadata_operating_systems(metadata)
+    return unless metadata.is_a?(Hash)
+    return unless metadata['operatingsystem_support'].is_a?(Array)
+
+    metadata['operatingsystem_support'].each do |os_info|
+      next unless os_info['operatingsystem'] && os_info['operatingsystemrelease']
 
-    os_info['operatingsystemrelease'].each do |release|
-      version = case os_name
-                when 'ubuntu', 'osx'
-                  release.sub('.', '')
-                when 'sles'
-                  release.gsub(%r{ SP[14]}, '')
-                when 'win'
-                  release = release.delete('.') if release.include? '8.1'
-                  release.sub('Server', '').sub('10', '10-pro')
+      os_name = case os_info['operatingsystem']
+                when 'Amazon', 'Archlinux', 'AIX', 'OSX'
+                  next
+                when 'OracleLinux'
+                  'oracle'
+                when 'Windows'
+                  'win'
                 else
-                  release
+                  os_info['operatingsystem'].downcase
                 end
 
-      yield "#{os_name}-#{version.downcase}-x86_64".delete(' ')
+      os_info['operatingsystemrelease'].each do |release|
+        version = case os_name
+                  when 'ubuntu', 'osx'
+                    release.sub('.', '')
+                  when 'sles'
+                    release.gsub(%r{ SP[14]}, '')
+                  when 'win'
+                    release = release.delete('.') if release.include? '8.1'
+                    release.sub('Server', '').sub('10', '10-pro')
+                  else
+                    release
+                  end
+
+        yield "#{os_name}-#{version.downcase}-x86_64".delete(' ')
+      end
     end
   end
-end
 
-def run_local_command(command)
-  stdout, stderr, status = Open3.capture3(command)
-  error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
-  raise error_message unless status.to_i.zero?
+  # Executes a command on the test runner.
+  #
+  # @param command [String] command to execute.
+  # @return [Object] the standard out stream.
+  def run_local_command(command)
+    stdout, stderr, status = Open3.capture3(command)
+    error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
+    raise error_message unless status.to_i.zero?
 
-  stdout
+    stdout
+  end
 end
 
 namespace :litmus do
+  include LitmusRakeHelper
+  # Prints all supported OSes from metadata.json file.
   desc 'print all supported OSes from metadata'
   task :metadata do
     metadata = JSON.parse(File.read('metadata.json'))
@@ -61,7 +74,11 @@ namespace :litmus do
     end
   end
 
-  desc "provision all supported OSes on with abs eg 'bundle exec rake 'litmus:provision_from_metadata'"
+  # DEPRECATED - Provisions all supported OSes with provisioner eg 'bundle exec rake litmus:provision_from_metadata['vmpooler']'.
+  #
+  # @param :provisioner [String] provisioner to use in provisioning all OSes.
+  desc "DEPRECATED: provision_from_metadata task is deprecated.
+  Provision all supported OSes with provisioner eg 'bundle exec rake 'litmus:provision_from_metadata'"
   task :provision_from_metadata, [:provisioner] do |_task, args|
     metadata = JSON.parse(File.read('metadata.json'))
     get_metadata_operating_systems(metadata) do |os_and_version|
@@ -83,6 +100,9 @@ namespace :litmus do
     end
   end
 
+  # Provisions a list of OSes from provision.yaml file e.g. 'bundle exec rake litmus:provision_list[default]'.
+  #
+  # @param :key [String] key that maps to a value for a provisioner and an image to be used for each OS provisioned.
   desc "provision list of machines from provision.yaml file. 'bundle exec rake 'litmus:provision_list[default]'"
   task :provision_list, [:key] do |_task, args|
     provision_hash = YAML.load_file('./provision.yaml')
@@ -103,9 +123,19 @@ namespace :litmus do
     raise "Failed to provision with '#{provisioner}'\n #{failed_image_message}" unless failed_image_message.empty?
   end
 
+  # Provision a container or VM with a given platform 'bundle exec rake 'litmus:provision[vmpooler, ubuntu-1604-x86_64]'.
+  #
+  # @param :provisioner [String] provisioner to use in provisioning given platform.
+  # @param :platform [String] OS platform for container or VM to use.
   desc "provision container/VM - abs/docker/vagrant/vmpooler eg 'bundle exec rake 'litmus:provision[vmpooler, ubuntu-1604-x86_64]'"
   task :provision, [:provisioner, :platform] do |_task, args|
     include BoltSpec::Run
+    spinner = if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
+                TTY::Spinner.new(':spinner', frames: ['.'], interval: 0.1)
+              else
+                TTY::Spinner.new("Provisioning #{args[:platform]} using #{args[:provisioner]} provisioner.[:spinner]")
+              end
+    spinner.auto_spin
     Rake::Task['spec_prep'].invoke
     config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
     raise "the provision module was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'provision'))
@@ -116,17 +146,29 @@ namespace :litmus do
 
     params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
     results = run_task("provision::#{args[:provisioner]}", 'localhost', params, config: config_data, inventory: nil)
-    raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}" if results.first['status'] != 'success'
+    if results.first['status'] != 'success'
+      spinner.error
+      raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}"
+    end
 
+    spinner.success
     puts "#{results.first['result']['node_name']}, #{args[:platform]}"
   end
 
+  # Install puppet agent on a collection of nodes
+  #
+  # @param :collection [String] parameters to pass to the puppet agent install command.
+  # @param :target_node_name [Array] nodes on which to install puppet agent.
   desc 'install puppet agent, [:collection, :target_node_name]'
   task :install_agent, [:collection, :target_node_name] do |_task, args|
-    puts 'install_agent'
-    include BoltSpec::Run
     inventory_hash = inventory_hash_from_inventory_file
     targets = find_targets(inventory_hash, args[:target_node_name])
+    if targets.empty?
+      puts 'No targets found'
+      exit 0
+    end
+    puts 'install_agent'
+    include BoltSpec::Run
     Rake::Task['spec_prep'].invoke
     config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
     params = if args[:collection].nil?
@@ -153,8 +195,69 @@ namespace :litmus do
     end
   end
 
+  # Install puppet enterprise - for internal puppet employees only - Requires an el7 provisioned machine - experimental feature [:target_node_name]'
+  #
+  # @param :target_node_name [Array] nodes on which to install puppet agent.
+  desc 'install puppet enterprise - for internal puppet employees only - Requires an el7 provisioned machine - experimental feature [:target_node_name]'
+  task :install_pe, [:target_node_name] do |_task, args|
+    inventory_hash = inventory_hash_from_inventory_file
+    target_nodes = find_targets(inventory_hash, args[:target_node_name])
+    if target_nodes.empty?
+      puts 'No targets found'
+      exit 0
+    end
+    puts 'install_pe'
+    include BoltSpec::Run
+    Rake::Task['spec_prep'].invoke
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+
+    puts 'Setting up parameters'
+
+    PE_RELEASE = 2019.0
+    pe_latest_cmd = "curl http://enterprise.delivery.puppetlabs.net/#{PE_RELEASE}/ci-ready/LATEST"
+    pe_latest = run_command(pe_latest_cmd, target_nodes, config: config_data, inventory: inventory_hash)
+    pe_latest_string = pe_latest[0]['result']['stdout'].delete("\n")
+    PE_FILE_NAME = "puppet-enterprise-#{pe_latest_string}-el-7-x86_64"
+    TAR_FILE = "#{PE_FILE_NAME}.tar"
+    DOWNLOAD_URL = "http://enterprise.delivery.puppetlabs.net/#{PE_RELEASE}/ci-ready/#{TAR_FILE}"
+
+    puts 'Initiating PE download'
+
+    # Download PE
+    download_pe_cmd = "wget -q #{DOWNLOAD_URL}"
+    run_command(download_pe_cmd, target_nodes, config: config_data, inventory: inventory_hash)
+
+    puts 'PE successfully downloaded, running installer (this may take 5 or so minutes, please be patient)'
+
+    # Install PE
+    untar_cmd = "tar xvf #{TAR_FILE}"
+    run_command(untar_cmd, target_nodes, config: config_data, inventory: inventory_hash)
+    puts run_command("cd #{PE_FILE_NAME} && 1 | ./puppet-enterprise-installer", target_nodes, config: nil, inventory: inventory_hash)[0]['result']['stdout']
+
+    puts 'Autosigning Certificates'
+
+    # Set Autosign
+    autosign_cmd = "echo 'autosign = true' >> /etc/puppetlabs/puppet/puppet.conf"
+    run_command(autosign_cmd, target_nodes, config: config_data, inventory: inventory_hash)
+
+    puts 'Finishing installation with a Puppet Agent run'
+
+    run_command('puppet agent -t', target_nodes, config: config_data, inventory: inventory_hash)
+
+    puts 'PE Installation is now complete'
+  end
+
+  # Install the puppet module under test on a collection of nodes
+  #
+  # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
   desc 'install_module - build and install module'
   task :install_module, [:target_node_name] do |_task, args|
+    inventory_hash = inventory_hash_from_inventory_file
+    target_nodes = find_targets(inventory_hash, args[:target_node_name])
+    if target_nodes.empty?
+      puts 'No targets found'
+      exit 0
+    end
     include BoltSpec::Run
     # old cli_way
     # pdk_build_command = 'bundle exec pdk build  --force'
@@ -167,8 +270,6 @@ namespace :litmus do
     module_tar = builder.build
     puts 'Built'
 
-    inventory_hash = inventory_hash_from_inventory_file
-    target_nodes = find_targets(inventory_hash, args[:target_node_name])
     # module_tar = Dir.glob('pkg/*.tar.gz').max_by { |f| File.mtime(f) }
     raise "Unable to find package in 'pkg/*.tar.gz'" if module_tar.nil?
 
@@ -192,15 +293,34 @@ namespace :litmus do
     puts 'Installed'
   end
 
+  # Provision a list of machines, install a puppet agent, and install the puppet module under test on a collection of nodes
+  #
+  # @param :key [String] key that maps to a value for a provisioner and an image to be used for each OS provisioned.
+  # @param :collection [String] parameters to pass to the puppet agent install command.
+  desc 'provision_install - provision a list of machines, install an agent, and the module.'
+  task :provision_install, [:key, :collection] do |_task, args|
+    Rake::Task['spec_prep'].invoke
+    Rake::Task['litmus:provision_list'].invoke(args[:key])
+    Rake::Task['litmus:install_agent'].invoke(args[:collection])
+    Rake::Task['litmus:install_module'].invoke
+  end
+
+  # Decommissions test machines.
+  #
+  # @param :target [Array] nodes to remove from test environemnt and decommission.
   desc 'tear-down - decommission machines'
   task :tear_down, [:target] do |_task, args|
+    inventory_hash = inventory_hash_from_inventory_file
+    targets = find_targets(inventory_hash, args[:target])
+    if targets.empty?
+      puts 'No targets found'
+      exit 0
+    end
     include BoltSpec::Run
     Rake::Task['spec_prep'].invoke
     config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
     raise "the provision module was not found in #{config_data['modulepath']}, please amend the .fixtures.yml file" unless File.directory?(File.join(config_data['modulepath'], 'provision'))
 
-    inventory_hash = inventory_hash_from_inventory_file
-    targets = find_targets(inventory_hash, args[:target])
     bad_results = []
     targets.each do |node_name|
       # how do we know what provisioner to use
@@ -229,8 +349,13 @@ namespace :litmus do
       inventory_hash = inventory_hash_from_inventory_file
       targets = find_targets(inventory_hash, nil)
 
+      # 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
+        if targets.empty?
+          puts 'No targets found'
+          exit 0
+        end
         spinners = TTY::Spinner::Multi.new("Running against #{targets.size} targets.[:spinner]", frames: ['.'], interval: 0.1)
         payloads = []
         targets.each do |target|

data/lib/puppet_litmus/serverspec.rb

@@ -21,11 +21,11 @@ module PuppetLitmus::Serverspec
   # @param opts [Hash] Alters the behaviour of the command. Valid options are:  
   #  :catch_changes [Boolean] exit status of 1 if there were changes.  
   #  :expect_failures [Boolean] doesnt return an exit code of non-zero if the apply failed.  
-  #  :manifest_file_location [Path] The place on the target system.
-  #  :prefix_command [String] prefixes the puppet apply command; eg "export LANGUAGE='ja'".
-  #  :debug [Boolean] run puppet apply with the debug flag.
-  #  :noop [Boolean] run puppet apply with the noop flag.
-  # @param [Block] his method will yield to a block of code passed by the caller; this can be used for additional validation, etc.
+  #  :manifest_file_location [Path] The place on the target system.  
+  #  :prefix_command [String] prefixes the puppet apply command; eg "export LANGUAGE='ja'".  
+  #  :debug [Boolean] run puppet apply with the debug flag.  
+  #  :noop [Boolean] run puppet apply with the noop flag.  
+  # @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 apply.
   def apply_manifest(manifest, opts = {})
     # rubocop:enable Layout/TrailingWhitespace
@@ -83,13 +83,16 @@ module PuppetLitmus::Serverspec
   #
   # @param command_to_run [String] The command to execute.
   # @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 [Block] his method will yield to a block of code passed by the caller; this can be used for additional validation, etc.
+  # @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 command.
   def run_shell(command_to_run, opts = {})
-    inventory_hash = inventory_hash_from_inventory_file
     target_node_name = ENV['TARGET_HOST']
+    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
+                       nil
+                     else
+                       inventory_hash_from_inventory_file
+                     end
     result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
-
     raise "shell failed\n`#{command_to_run}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
 
     result = OpenStruct.new(exit_code: result.first['result']['exit_code'],

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/inventory_manipulation_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe PuppetLitmus::InventoryManipulation do
+  class DummyClass
+  end
+  let(:dummy_class) do
+    dummy_class = DummyClass.new
+    dummy_class.extend(described_class)
+    dummy_class
+  end
+
+  context 'with config_from_node' do
+    let(:no_config_hash) do
+      { 'groups' =>
+  [{ 'name' => 'ssh_nodes',
+     'nodes' =>
+     [{ 'name' => 'test.delivery.puppetlabs.net',
+        'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' } }] },
+   { 'name' => 'winrm_nodes', 'nodes' => [] }] }
+    end
+
+    let(:config_hash) do
+      { 'groups' =>
+  [{ 'name' => 'ssh_nodes',
+     'nodes' =>
+     [{ 'name' => 'test.delivery.puppetlabs.net',
+        'config' => { 'transport' => 'ssh', 'ssh' => { 'user' => 'root', 'password' => 'Qu@lity!', 'host-key-check' => false } },
+        'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' } }] },
+   { 'name' => 'winrm_nodes', 'nodes' => [] }] }
+    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')
+    end
+
+    it 'no config section, returns nil' do
+      expect(dummy_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' =>
+{ 'user' => 'root', 'password' => 'Qu@lity!', 'host-key-check' => false })
+    end
+  end
+end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'rake'
+
+describe 'litmus rake tasks' do
+  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
+    load File.expand_path('../../../lib/puppet_litmus/rake_tasks.rb', __dir__)
+    # the spec_prep task is stubbed, rather than load from another gem.
+    Rake::Task.define_task(:spec_prep)
+  end
+
+  context 'with litmus:metadata task' do
+    it 'happy path' do
+      metadata = { 'name' => 'puppetlabs-postgresql',
+                   'version' => '6.0.0',
+                   'operatingsystem_support' =>
+  [{ 'operatingsystem' => 'RedHat', 'operatingsystemrelease' => ['5'] },
+   { 'operatingsystem' => 'Ubuntu', 'operatingsystemrelease' => ['14.04', '18.04'] }],
+                   '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')
+      Rake::Task['litmus:metadata'].invoke
+    end
+  end
+
+  context 'with litmus:provision_install task' do
+    it 'happy path' do
+      expect(Rake::Task['spec_prep']).to receive(:invoke).and_return('').once
+      expect(Rake::Task['litmus:provision_list']).to receive(:invoke).with('default').once
+      expect(Rake::Task['litmus:install_agent']).to receive(:invoke).with('puppet6').once
+      expect(Rake::Task['litmus:install_module']).to receive(:invoke).once
+      Rake::Task['litmus:provision_install'].invoke('default', 'puppet6')
+    end
+  end
+
+  context 'with litmus:provision task' do
+    it 'provisions' do
+      results = [{ 'node' => 'localhost',
+                   'target' => 'localhost',
+                   'action' => 'task',
+                   'object' => 'provision::docker',
+                   'status' => 'success',
+                   'result' => { 'status' => 'ok', 'node_name' => 'localhost:2222' } }]
+
+      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) # rubocop:disable RSpec/AnyInstance
+      expect(STDOUT).to receive(:puts).with('localhost:2222, centos:7')
+      Rake::Task['litmus:provision'].invoke('docker', 'centos:7')
+    end
+  end
+end

data/spec/lib/puppet_litmus/serverspec_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe PuppetLitmus::Serverspec do
+  class DummyClass
+  end
+  let(:dummy_class) do
+    dummy_class = DummyClass.new
+    dummy_class.extend(described_class)
+    dummy_class
+  end
+
+  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, catch_failures: true, 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)
+    end
+  end
+
+  describe '.run_shell' do
+    let(:command_to_run) { "puts 'doot'" }
+    let(:result) { ['result' => { 'exit_code' => 0, 'stdout' => nil, 'stderr' => nil }] }
+    let(:inventory_hash) { Hash.new(0) }
+
+    it 'responds to run_shell' do
+      expect(dummy_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
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('localhost')
+        expect(dummy_class).to receive(:run_command).with(command_to_run, 'localhost', config: nil, inventory: nil).and_return(result)
+        expect { dummy_class.run_shell(command_to_run) }.not_to raise_error
+      end
+    end
+
+    context 'when running against remote host' do
+      it 'does run_shell 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).and_return(inventory_hash)
+        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
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,3 +2,28 @@
 
 require 'rspec'
 require 'puppet_litmus'
+
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+  ]
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+
+    # do not track gitignored files
+    # this adds about 4 seconds to the coverage check
+    # this could definitely be optimized
+    add_filter do |f|
+      # system returns true if exit status is 0, which with git-check-ignore means file is ignored
+      system("git check-ignore --quiet #{f.filename}")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -85,7 +85,10 @@ files:
 - lib/puppet_litmus/rake_tasks.rb
 - lib/puppet_litmus/serverspec.rb
 - lib/puppet_litmus/version.rb
-- spec/lib/puppet_litmus_spec.rb
+- spec/lib/puppet_litmus/inventory_manipulation_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
 licenses:
@@ -114,4 +117,7 @@ summary: Providing a simple command line tool for puppet content creators, to en
   simple and complex test deployments.
 test_files:
 - spec/spec_helper.rb
-- spec/lib/puppet_litmus_spec.rb
+- 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