puppet_litmus 0.18.2 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9148f5cf259702d6b12f875555b4cbef8fdbc4ff78081e495ca1b9b8948d082
-  data.tar.gz: 3b002919bfff6ce6cb794ed9bd3d8b6b5712ba76d1cceceba1c8d205488f9057
+  metadata.gz: 7ace2d5a5ae33d1e795535b4704d84a54b9d97e48bd5a77b39866887c077e300
+  data.tar.gz: 611dbd8bd462331462506280920ac3355a732c18ca2a6edc2ce15e4da5071214
 SHA512:
-  metadata.gz: 458f9935cf9148d839f0a2ac3cb3851a85ef18df7a7e99a0b216adafb9d33999a1d672da95f5450c1b371794cd6ecf7d92131778d79cdb47ea0cd0788e1901c4
-  data.tar.gz: 4c1c40a1b40865ff788af2f52c6766a5f5d159674ce3f62173da91713dd96f5e1e78f1fb41234e5a7d82aa89c1cb1b2f35a29c841bf2e3307719506c4a130793
+  metadata.gz: 3f2024d6a7afed0976cdc5ab48ab1fe1e42ff17f75a39637feed9cf102d0a8defc8fd2c8bf54dac45512f9849fd9ec1a1862691455c6246e79afc55008376d23
+  data.tar.gz: 8a91349dc69667bdb7e701fa64a60fe71b0f8e311c017d5bda53b4fd0d1fa17c0276db50982076abdbf2d56408ea88cd6d9de8fac151ba609f41c75282c7125b

data/README.md

@@ -24,7 +24,7 @@ Install Litmus as a gem by running ```gem install puppet_litmus```.
 
 ## Documentation
 
-For documentation, see our [Litmus Wiki](https://github.com/puppetlabs/puppet_litmus/wiki).
+For documentation, see our [Litmus Docs Site](https://puppetlabs.github.io/litmus/).
 
 ## Other Resources
 

data/lib/puppet_litmus/puppet_helpers.rb

@@ -9,7 +9,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Boolean] The result of the 2 apply manifests.
   def idempotent_apply(manifest)
     Honeycomb.start_span(name: 'litmus.idempotent_apply') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       manifest_file_location = create_manifest_file(manifest)
       apply_manifest(nil, expect_failures: false, manifest_file_location: manifest_file_location)
       apply_manifest(nil, catch_changes: true, manifest_file_location: manifest_file_location)
@@ -39,7 +39,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the apply.
   def apply_manifest(manifest, opts = {})
     Honeycomb.start_span(name: 'litmus.apply_manifest') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.manifest', manifest)
       span.add_field('litmus.opts', opts)
 
@@ -117,7 +117,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [String] The path to the location of the manifest.
   def create_manifest_file(manifest)
     Honeycomb.start_span(name: 'litmus.create_manifest_file') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.manifest', manifest)
 
       require 'tmpdir'
@@ -155,7 +155,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the command.
   def run_shell(command_to_run, opts = {})
     Honeycomb.start_span(name: 'litmus.run_shell') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.command_to_run', command_to_run)
       span.add_field('litmus.opts', opts)
 
@@ -192,7 +192,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the command.
   def bolt_upload_file(source, destination, opts = {}, options = {})
     Honeycomb.start_span(name: 'litmus.bolt_upload_file') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.source', source)
       span.add_field('litmus.destination', destination)
       span.add_field('litmus.opts', opts)
@@ -244,7 +244,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the task.The values available are stdout, stderr and result.
   def run_bolt_task(task_name, params = {}, opts = {})
     Honeycomb.start_span(name: 'litmus.run_task') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.task_name', task_name)
       span.add_field('litmus.params', params)
       span.add_field('litmus.opts', opts)
@@ -312,7 +312,7 @@ module PuppetLitmus::PuppetHelpers
   # @return [Object] A result object from the script run.
   def bolt_run_script(script, opts = {}, arguments: [])
     Honeycomb.start_span(name: 'litmus.bolt_run_script') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.script', script)
       span.add_field('litmus.opts', opts)
       span.add_field('litmus.arguments', arguments)

data/lib/puppet_litmus/rake_helper.rb

@@ -2,15 +2,17 @@
 
 require 'bolt_spec/run'
 require 'honeycomb-beeline'
+require 'puppet_litmus/version'
 Honeycomb.configure do |config|
   # override client if no configuration is provided, so that the pesky libhoney warning about lack of configuration is not shown
   unless ENV['HONEYCOMB_WRITEKEY'] && ENV['HONEYCOMB_DATASET']
     config.client = Libhoney::NullClient.new
   end
 end
-process_span = Honeycomb.start_span(name: 'Litmus Testing', serialized_trace: ENV['HTTP_X_HONEYCOMB_TRACE'])
-ENV['HTTP_X_HONEYCOMB_TRACE'] = process_span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+process_span = Honeycomb.start_span(name: "litmus: #{([$PROGRAM_NAME] + ($ARGV || [])).join(' ')}", serialized_trace: ENV['HTTP_X_HONEYCOMB_TRACE'])
+ENV['HTTP_X_HONEYCOMB_TRACE'] = process_span.to_trace_header
 Honeycomb.add_field_to_trace('litmus.pid', Process.pid)
+Honeycomb.add_field_to_trace('litmus.version', PuppetLitmus::VERSION)
 if ENV['CI'] == 'true' && ENV['TRAVIS'] == 'true'
   Honeycomb.add_field_to_trace('module_name', ENV['TRAVIS_REPO_SLUG'])
   Honeycomb.add_field_to_trace('ci.provider', 'travis')
@@ -90,7 +92,7 @@ module PuppetLitmus::RakeHelper
   # @return [Object] the standard out stream.
   def run_local_command(command)
     Honeycomb.start_span(name: 'litmus.run_local_command') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.command', command)
 
       require 'open3'
@@ -113,7 +115,7 @@ module PuppetLitmus::RakeHelper
 
     Honeycomb.add_field_to_trace('litmus.provisioner', provisioner)
     Honeycomb.start_span(name: 'litmus.provision') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.platform', platform)
       span.add_field('litmus.inventory', params['inventory'])
       span.add_field('litmus.config', DEFAULT_CONFIG_DATA)
@@ -142,7 +144,7 @@ module PuppetLitmus::RakeHelper
 
   def tear_down_nodes(targets, inventory_hash)
     Honeycomb.start_span(name: 'litmus.tear_down_nodes') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.targets', targets)
 
       include ::BoltSpec::Run
@@ -162,7 +164,7 @@ module PuppetLitmus::RakeHelper
 
   def tear_down(node_name, inventory_hash)
     Honeycomb.start_span(name: 'litmus.tear_down') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       # how do we know what provisioner to use
 
       span.add_field('litmus.node_name', node_name)
@@ -178,7 +180,7 @@ module PuppetLitmus::RakeHelper
 
   def install_agent(collection, targets, inventory_hash)
     Honeycomb.start_span(name: 'litmus.install_agent') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.collection', collection)
       span.add_field('litmus.targets', targets)
 
@@ -209,32 +211,71 @@ module PuppetLitmus::RakeHelper
     results
   end
 
+  # Build the module in `module_dir` and put the resulting compressed tarball into `target_dir`.
+  #
   # @param opts Hash of options to build the module
   # @param module_dir [String] The path of the module to build. If missing defaults to Dir.pwd
-  # @param target_dir [String] The path the module will be built into. The default is <source_dir>/pkg
+  # @param target_dir [String] The path the module will be built into. The default is <module_dir>/pkg
   # @return [String] The path to the built module
   def build_module(module_dir = nil, target_dir = nil)
     require 'puppet/modulebuilder'
 
-    source_dir = module_dir || Dir.pwd
-    dest_dir = target_dir || File.join(source_dir, 'pkg')
+    module_dir ||= Dir.pwd
+    target_dir ||= File.join(source_dir, 'pkg')
+
+    puts "Building '#{module_dir}' into '#{target_dir}''"
+    builder = Puppet::Modulebuilder::Builder.new(module_dir, target_dir, nil)
 
-    builder = Puppet::Modulebuilder::Builder.new(source_dir, dest_dir, nil)
     # Force the metadata to be read. Raises if metadata could not be found
     _metadata = builder.metadata
 
     builder.build
   end
 
-  def install_module(inventory_hash, target_node_name, module_tar, module_repository = 'https://forgeapi.puppetlabs.com')
+  # Builds all the modules in a specified directory
+  #
+  # @param source_dir [String] the directory to get the modules from
+  # @param target_dir [String] temporary location to store tarballs before uploading. This directory will be cleaned before use. The default is <source_dir>/pkg
+  # @return [Array] an array of module tars' filenames
+  def build_modules_in_dir(source_dir, target_dir = nil)
+    target_dir ||= File.join(Dir.pwd, 'pkg')
+    # remove old build dir if exists, before we build afresh
+    FileUtils.rm_rf(target_dir) if File.directory?(target_dir)
+
+    module_tars = Dir.entries(source_dir).map do |entry|
+      next if ['.', '..'].include? entry
+
+      module_dir = File.join(source_dir, entry)
+      next unless File.directory? module_dir
+
+      build_module(module_dir, target_dir)
+    end
+    module_tars.compact
+  end
+
+  # @deprecated Use `build_modules_in_dir` instead
+  def build_modules_in_folder(source_folder)
+    build_modules_in_dir(source_folder)
+  end
+
+  # Install a specific module tarball to the specified target.
+  # This method installs dependencies using a forge repository.
+  #
+  # @param inventory_hash [Hash] the pre-loaded inventory
+  # @param target_node_name [String] the name of the target where the module should be installed
+  # @param module_tar [String] the filename of the module tarball to upload
+  # @param module_repository [String] the URL for the forge to use for downloading modules. Defaults to the public Forge API.
+  # @return a bolt result
+  def install_module(inventory_hash, target_node_name, module_tar, module_repository = nil)
     Honeycomb.start_span(name: 'install_module') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.target_node_name', target_node_name)
       span.add_field('litmus.module_tar', module_tar)
 
-      # make sure the target module is not installed
+      # make sure the module to install is not installed
       # otherwise `puppet module install` might silently skip it
-      uninstall_module(inventory_hash.clone, target_node_name, force: true)
+      module_name = File.basename(module_tar, '.tar.gz').split('-', 3)[0..1].join('-')
+      uninstall_module(inventory_hash.clone, target_node_name, module_name, force: true)
 
       include ::BoltSpec::Run
 
@@ -243,7 +284,8 @@ module PuppetLitmus::RakeHelper
       bolt_result = upload_file(module_tar, File.basename(module_tar), target_nodes, options: {}, config: nil, inventory: inventory_hash.clone)
       raise_bolt_errors(bolt_result, 'Failed to upload module.')
 
-      install_module_command = "puppet module install --module_repository '#{module_repository}' #{File.basename(module_tar)}"
+      module_repository_opts = "--module_repository '#{module_repository}'" unless module_repository.nil?
+      install_module_command = "puppet module install #{module_repository_opts} #{File.basename(module_tar)}"
       span.add_field('litmus.install_module_command', install_module_command)
 
       bolt_result = run_command(install_module_command, target_nodes, config: nil, inventory: inventory_hash.clone)
@@ -252,31 +294,6 @@ module PuppetLitmus::RakeHelper
     end
   end
 
-  # Builds all the modules in a specified module
-  #
-  # @param source_folder [String] the folder to get the modules from
-  # @return [Array] an array of module tar's
-  def build_modules_in_folder(source_folder)
-    folder_list = Dir.entries(source_folder).reject { |f| File.directory? f }
-    module_tars = []
-
-    target_dir = File.join(Dir.pwd, 'pkg')
-    # remove old build folder if exists, before we build afresh
-    FileUtils.rm_rf(target_dir) if File.directory?(target_dir)
-
-    folder_list.each do |folder|
-      folder_handle = Dir.open(File.join(source_folder, folder))
-      next if File.symlink?(folder_handle)
-
-      module_dir = folder_handle.path
-
-      # build_module
-      module_tar = build_module(module_dir, target_dir)
-      module_tars.push(File.new(module_tar))
-    end
-    module_tars
-  end
-
   def metadata_module_name
     require 'json'
     raise 'Could not find metadata.json' unless File.exist?(File.join(Dir.pwd, 'metadata.json'))
@@ -287,6 +304,11 @@ module PuppetLitmus::RakeHelper
     metadata['name']
   end
 
+  # Uninstall a module from a specified target
+  # @param inventory_hash [Hash] the pre-loaded inventory
+  # @param target_node_name [String] the name of the target where the module should be uninstalled
+  # @param module_to_remove [String] the name of the module to remove. Defaults to the module under test.
+  # @param opts [Hash] additional options to pass on to `puppet module uninstall`
   def uninstall_module(inventory_hash, target_node_name, module_to_remove = nil, **opts)
     include ::BoltSpec::Run
     module_name = module_to_remove || metadata_module_name
@@ -301,7 +323,7 @@ module PuppetLitmus::RakeHelper
 
   def check_connectivity?(inventory_hash, target_node_name)
     Honeycomb.start_span(name: 'litmus.check_connectivity') do |span|
-      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header unless ENV['HTTP_X_HONEYCOMB_TRACE']
+      ENV['HTTP_X_HONEYCOMB_TRACE'] = span.to_trace_header
       # if we're only checking connectivity for a single node
       if target_node_name
         span.add_field('litmus.node_name', target_node_name)
@@ -346,7 +368,7 @@ module PuppetLitmus::RakeHelper
 
       target = target_result['target']
       # get some info from error
-      errors[target] = target_result['value']['_error']
+      errors[target] = target_result['value']
     end
     errors
   end
@@ -359,7 +381,8 @@ module PuppetLitmus::RakeHelper
     errors = check_bolt_errors(result_set)
 
     unless errors.empty?
-      raise "#{error_msg}\nErrors: #{errors}"
+      formatted_results = errors.map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
+      raise "#{error_msg}\nResults:\n#{formatted_results}}"
     end
 
     nil

data/lib/puppet_litmus/rake_tasks.rb

@@ -17,15 +17,15 @@ namespace :litmus do
   end
 
   # Provisions a list of OSes from provision.yaml file e.g. 'bundle exec rake litmus:provision_list[default]'.
-  # @See https://github.com/puppetlabs/puppet_litmus/wiki/Overview-of-Litmus#provisioning-via-yaml
+  # @See https://puppetlabs.github.io/litmus/Litmus-core-commands.html#provisioning-via-yaml
   #
   # @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]'"
+  desc 'provision list of machines from provision.yaml file'
   task :provision_list, [:key] do |_task, args|
     raise 'Cannot find provision.yaml file' unless File.file?('./provision.yaml')
 
     provision_hash = YAML.load_file('./provision.yaml')
-    raise "No key #{args[:key]} in ./provision.yaml, see https://github.com/puppetlabs/puppet_litmus/wiki/Overview-of-Litmus#provisioning-via-yaml for examples" if provision_hash[args[:key]].nil?
+    raise "No key #{args[:key]} in ./provision.yaml, see https://puppetlabs.github.io/litmus/Litmus-core-commands.html#provisioning-via-yaml for examples" if provision_hash[args[:key]].nil?
 
     Rake::Task['spec_prep'].invoke
 
@@ -71,7 +71,7 @@ namespace :litmus do
   #
   # @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]'"
+  desc 'provision a test system using the given provisioner and platform name. See the puppetlabs-provision module tasks for more documentation'
   task :provision, [:provisioner, :platform, :inventory_vars] do |_task, args|
     Rake::Task['spec_prep'].invoke
     if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
@@ -103,7 +103,7 @@ namespace :litmus do
   #
   # @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]'
+  desc 'install a puppet agent to all or a specified set of targets'
   task :install_agent, [:collection, :target_node_name] do |_task, args|
     inventory_hash = inventory_hash_from_inventory_file
     targets = find_targets(inventory_hash, args[:target_node_name])
@@ -143,7 +143,7 @@ namespace :litmus do
   #
   # @param :target_node_name [Array] nodes on which to add the feature.
   # @param :added_feature [String] the feature which you wish to add.
-  desc 'add_feature, [:added_feature, :target_node_name]'
+  desc 'add a feature tag to a node'
   task :add_feature, [:added_feature, :target_node_name] do |_task, args|
     inventory_hash = inventory_hash_from_inventory_file
     targets = find_targets(inventory_hash, args[:target_node_name])
@@ -166,83 +166,118 @@ namespace :litmus do
     puts 'Feature added'
   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 'build the module under test and install it onto targets'
+  task :install_module, [:target_node_name, :module_repository] do |_task, args|
+    args.with_defaults(target_node_name: nil, module_repository: nil)
+    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
+
+    module_tar = build_module
+    puts "Built '#{module_tar}'"
+
+    # 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?
+
+    install_module(inventory_hash, args[:target_node_name], module_tar, args[:module_repository])
+
+    puts "Installed '#{module_tar}' on #{args[:target_node_name]}"
+  end
+
   # Install the puppet modules from a source directory to nodes. It does not install dependencies.
   #
   # @param :source [String] source directory to look in (ignores symlinks) defaults do './spec/fixtures/modules'.
   # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
-  desc 'install_module - build and install module'
+  desc 'build and install all modules from a directory'
   task :install_modules_from_directory, [:source, :target_node_name, :module_repository] do |_task, args|
-    args.with_defaults(source: nil, target_node_name: nil, module_repository: 'https://forgeapi.puppetlabs.com')
+    args.with_defaults(source: nil, target_node_name: nil, module_repository: nil)
     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
-    source_folder = if args[:source].nil?
-                      './spec/fixtures/modules'
-                    else
-                      File.expand_path(args[:source])
-                    end
-    raise "Source folder doesnt exist #{source_folder}" unless File.directory?(source_folder)
-
-    puts 'Building'
-    module_tars = build_modules_in_folder(source_folder)
+    source_dir = if args[:source].nil?
+                   './spec/fixtures/modules'
+                 else
+                   File.expand_path(args[:source])
+                 end
+    raise "Source directory doesn't exist #{source_dir}" unless File.directory?(source_dir)
+
+    puts "Building all modules in #{source_dir.inspect}"
+    module_tars = build_modules_in_dir(source_dir)
     require 'bolt_spec/run'
     include BoltSpec::Run
-    puts "\nInstalling"
     module_tars.each do |module_tar|
+      puts "Installing '#{module_tar}'"
       target_nodes.each do |target_node_name|
         install_module(inventory_hash, target_node_name, module_tar, args[:module_repository])
+        puts "Installed '#{module_tar}' on #{target_node_name}"
       end
     end
   end
 
-  # Check that the nodes in the inventory are still contactable
+  # Uninstall the puppet module under test on a collection of nodes
   #
-  # @param :target_node_name [Array] nodes on which to check connnectivity
-  desc 'check_connectivity - build and install module'
-  task :check_connectivity, [:target_node_name] do |_task, args|
+  # @param :target_node_name [Array] nodes on which to install a puppet module for testing.
+  # @param :module_name [String] module name to be uninstalled
+  desc 'uninstall a specific module'
+  task :uninstall_module, [:target_node_name, :module_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
-    check_connectivity?(inventory_hash, args[:target_node_name])
+
+    result = uninstall_module(inventory_hash, args[:target_node_name], args[:module_name])
+
+    raise "Failed trying to run 'puppet module uninstall #{module_name}' against inventory." unless result.is_a?(Array)
+
+    result.each do |node|
+      puts "#{node['target']} failed #{node['value']}" if node['status'] != 'success'
+    end
+
+    puts 'Uninstalled'
   end
 
-  # Install the puppet module under test on a collection of nodes
+  # Reinstall 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, :module_repository] do |_task, args|
-    args.with_defaults(target_node_name: nil, module_repository: 'https://forgeapi.puppetlabs.com')
+  desc 'reinstall the module under test'
+  task :reinstall_module, [:target_node_name, :module_repository] do |_task, args|
+    args.with_defaults(target_node_name: nil, module_repository: nil)
+    Rake::Task['litmus:uninstall_module'].invoke(args[:target_node_name])
+    Rake::Task['litmus:install_module'].invoke(args[:target_node_name], args[:module_repository])
+  end
+
+  # Check that the nodes in the inventory are still contactable
+  #
+  # @param :target_node_name [Array] nodes on which to check connnectivity
+  desc 'check the connectivity to all provisioned targets'
+  task :check_connectivity, [: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
-
-    module_tar = build_module
-    puts 'Built'
-
-    # 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?
-
-    install_module(inventory_hash, args[:target_node_name], module_tar, args[:module_repository])
-
-    puts 'Installed'
+    check_connectivity?(inventory_hash, args[:target_node_name])
   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.'
+  desc 'provision a list of machines, install an agent, and the module.'
   task :provision_install, [:key, :collection, :module_repository] do |_task, args|
-    args.with_defaults(module_repository: 'https://forgeapi.puppetlabs.com')
+    args.with_defaults(module_repository: nil)
     Rake::Task['spec_prep'].invoke
     Rake::Task['litmus:provision_list'].invoke(args[:key])
     Rake::Task['litmus:install_agent'].invoke(args[:collection])
@@ -252,7 +287,7 @@ namespace :litmus do
   # Decommissions test machines.
   #
   # @param :target [Array] nodes to remove from test environemnt and decommission.
-  desc 'tear-down - decommission machines'
+  desc 'destroy provisioned targets'
   task :tear_down, [:target] do |_task, args|
     inventory_hash = inventory_hash_from_inventory_file
     targets = find_targets(inventory_hash, args[:target])
@@ -278,40 +313,6 @@ namespace :litmus do
     end
   end
 
-  # Uninstall 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.
-  # @param :module_name [String] module name to be uninstalled
-  desc 'uninstall_module - uninstall module'
-  task :uninstall_module, [:target_node_name, :module_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
-
-    result = uninstall_module(inventory_hash, args[:target_node_name], args[:module_name])
-
-    raise "Failed trying to run 'puppet module uninstall #{module_name}' against inventory." unless result.is_a?(Array)
-
-    result.each do |node|
-      puts "#{node['target']} failed #{node['value']}" if node['status'] != 'success'
-    end
-
-    puts 'Uninstalled'
-  end
-
-  # Reinstall 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 'reinstall_module - reinstall module'
-  task :reinstall_module, [:target_node_name, :module_repository] do |_task, args|
-    args.with_defaults(target_node_name: nil, module_repository: 'https://forgeapi.puppetlabs.com')
-    Rake::Task['litmus:uninstall_module'].invoke(args[:target_node_name])
-    Rake::Task['litmus:install_module'].invoke(args[:target_node_name], args[:module_repository])
-  end
-
   namespace :acceptance do
     require 'rspec/core/rake_task'
     if File.file?('inventory.yaml')

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/rake_helper_spec.rb

@@ -100,20 +100,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

@@ -28,8 +28,8 @@ describe 'litmus rake tasks' do
 
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.18.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-06-10 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.1'
+        version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -233,13 +239,13 @@ 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/data/doot.tar.gz
+- spec/data/inventory.yaml
+- spec/data/jim.yaml
 - spec/lib/puppet_litmus/util_spec.rb
+- spec/lib/puppet_litmus/version_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
-- spec/lib/puppet_litmus/rake_helper_spec.rb
 - spec/lib/puppet_litmus/puppet_helpers_spec.rb
-- spec/data/doot.tar.gz
-- spec/data/jim.yaml
-- spec/data/inventory.yaml
+- spec/lib/puppet_litmus/rake_helper_spec.rb
+- spec/lib/puppet_litmus/rake_tasks_spec.rb
+- spec/spec_helper.rb