puppet_litmus 0.18.1 → 0.20.0

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
 
@@ -36,30 +36,17 @@ namespace :litmus do
     results = []
     failed_image_message = ''
     provision_hash[args[:key]]['images'].each do |image|
-      if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-        progress = Thread.new do
-          loop do
-            printf '.'
-            sleep(10)
-          end
-        end
-      else
-        require 'tty-spinner'
-        spinner = TTY::Spinner.new("Provisioning #{image} using #{provisioner} provisioner.[:spinner]")
-        spinner.auto_spin
-      end
-      result = provision(provisioner, image, inventory_vars)
-
-      if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-        Thread.kill(progress)
-      else
-        spinner.success
+      begin
+        spinner = start_spinner("Provisioning #{image} using #{provisioner} provisioner.")
+        result = provision(provisioner, image, inventory_vars)
+      ensure
+        stop_spinner(spinner)
       end
 
       if result.first['status'] != 'success'
         failed_image_message += "=====\n#{result.first['target']}\n#{result.first['value']['_output']}\n#{result.inspect}"
       else
-        STDOUT.puts "#{result.first['value']['node_name']}, #{image}"
+        $stdout.puts "#{result.first['value']['node_name']}, #{image}"
       end
       results << result
     end
@@ -71,31 +58,38 @@ 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?
-      progress = Thread.new do
-        loop do
-          printf '.'
-          sleep(10)
+
+    begin
+      spinner = start_spinner("Provisioning #{args[:platform]} using #{args[:provisioner]} provisioner.")
+
+      results = provision(args[:provisioner], args[:platform], args[:inventory_vars])
+
+      unless results.first['status'] == 'success'
+        raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}"
+      end
+
+      puts "Successfully provisioned #{args[:platform]} using #{args[:provisioner]}\n"
+
+      target_names = if results.first['value']['node']
+                       [results.first['value']['node']['uri']]
+                     else
+                       results.first['value']['target_names'] || [] # provision_service multi-node provisioning
+                     end
+      target_names.each do |target|
+        Honeycomb.start_span(name: 'litmus.provision.check_connectivity') do |span|
+          span.add_field('target_name', target)
+          with_retries do
+            check_connectivity?(inventory_hash_from_inventory_file, target)
+          end
         end
       end
-    else
-      require 'tty-spinner'
-      spinner = TTY::Spinner.new("Provisioning #{args[:platform]} using #{args[:provisioner]} provisioner.[:spinner]")
-      spinner.auto_spin
-    end
-    results = provision(args[:provisioner], args[:platform], args[:inventory_vars])
-    if results.first['status'] != 'success'
-      raise "Failed provisioning #{args[:platform]} using #{args[:provisioner]}\n#{results.first}"
+    ensure
+      stop_spinner(spinner)
     end
 
-    if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
-      Thread.kill(progress)
-    else
-      spinner.success
-    end
     puts "#{results.first['value']['node_name']}, #{args[:platform]}"
   end
 
@@ -103,7 +97,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])
@@ -122,28 +116,43 @@ namespace :litmus do
         command_to_run = "bolt task run puppet_agent::install --targets #{result['target']} --inventoryfile inventory.yaml --modulepath #{DEFAULT_CONFIG_DATA['modulepath']}"
         raise "Failed on #{result['target']}\n#{result}\ntry running '#{command_to_run}'"
       else
+        # validate successful install
+        puts "Successfull install result: #{result.inspect}" if ENV['DEBUG'] == true
+        retries = 0
+        begin
+          responses = run_command('puppet --version', targets, options: {}, config: DEFAULT_CONFIG_DATA, inventory: inventory_hash.clone)
+          responses.each do |response|
+            raise "Error checking puppet version on #{response.to_json}" if response['status'] != 'success'
+          end
+        rescue StandardError => e
+          puts "ERROR:#{e}"
+          # fix the path
+          path_changes = configure_path(inventory_hash)
+          if ENV['DEBUG'] == true
+            path_changes.each do |change|
+              puts "Configuring puppet path result: #{change.inspect}"
+            end
+          end
+
+          retries += 1
+          sleep 3
+          retry if retries <= 300
+          raise 'Failed to detect installed puppet version after 5 minutes'
+        end
+
         # add puppet-agent feature to successful nodes
         inventory_hash = add_feature_to_node(inventory_hash, 'puppet-agent', result['target'])
       end
     end
     # update the inventory with the puppet-agent feature set per node
     write_to_inventory_file(inventory_hash, 'inventory.yaml')
-
-    # fix the path on ssh_nodes
-    results = configure_path(inventory_hash)
-
-    results.each do |result|
-      if result['status'] != 'success'
-        puts "Failed on #{result['target']}\n#{result}"
-      end
-    end
   end
 
   # Add a given feature to a selection of nodes
   #
   # @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 +175,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'
-  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')
+  desc 'build and install all modules from a directory'
+  task :install_modules_from_directory, [:source, :target_node_name, :module_repository, :ignore_dependencies] do |_task, args|
+    args.with_defaults(source: nil, target_node_name: nil, module_repository: nil, ignore_dependencies: false)
     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])
+        install_module(inventory_hash, target_node_name, module_tar, args[:module_repository], args[:ignore_dependencies])
+        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 +296,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 +322,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')
@@ -320,15 +330,21 @@ namespace :litmus do
 
       # 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
+      task :parallel, [:tag] do |_task, args|
+        args.with_defaults(tag: nil)
         if targets.empty?
           puts 'No targets found'
           exit 0
         end
+        tag_value = if args[:tag].nil?
+                      nil
+                    else
+                      "--tag #{args[:tag]}"
+                    end
         payloads = []
         # Generate list of targets to provision
         targets.each do |target|
-          test = 'bundle exec rspec ./spec/acceptance --format progress --require rspec_honeycomb_formatter --format RSpecHoneycombFormatter'
+          test = "bundle exec rspec ./spec/acceptance #{tag_value} --format progress --require rspec_honeycomb_formatter --format RSpecHoneycombFormatter"
           title = "#{target}, #{facts_from_node(inventory_hash, target)['platform']}"
           options = {
             env: {
@@ -342,7 +358,7 @@ namespace :litmus do
         success_list = []
         failure_list = []
         # Provision targets depending on what environment we're in
-        if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
+        if ENV['CI'] == 'true'
           # CI systems are strange beasts, we only output a '.' every wee while to keep the terminal alive.
           puts "Running against #{targets.size} targets.\n"
           progress = Thread.new do
@@ -366,9 +382,9 @@ namespace :litmus do
           # because we cannot modify variables inside of Parallel
           results.each do |result|
             if result.last.to_i.zero?
-              success_list.push(result.first.scan(%r{.*})[2])
+              success_list.push(result.first.scan(%r{.*})[3])
             else
-              failure_list.push(result.first.scan(%r{.*})[2])
+              failure_list.push(result.first.scan(%r{.*})[3])
             end
           end
           Thread.kill(progress)
@@ -410,8 +426,9 @@ namespace :litmus do
         desc "Run serverspec against #{target}"
         next if target == 'litmus_localhost'
 
-        RSpec::Core::RakeTask.new(target.to_sym) do |t|
+        RSpec::Core::RakeTask.new(target.to_sym, :tag) do |t, args|
           t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+          t.rspec_opts = "--tag #{args[:tag]}" unless args[:tag].nil?
           ENV['TARGET_HOST'] = target
         end
       end
@@ -420,8 +437,9 @@ namespace :litmus do
     # add localhost separately
     desc 'Run serverspec against localhost, USE WITH CAUTION, this action can be potentially dangerous.'
     host = 'localhost'
-    RSpec::Core::RakeTask.new(host.to_sym) do |t|
+    RSpec::Core::RakeTask.new(host.to_sym, :tag) do |t, args|
       t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
+      t.rspec_opts = "--tag #{args[:tag]}" unless args[:tag].nil?
       Rake::Task['spec_prep'].invoke
       ENV['TARGET_HOST'] = host
     end

data/lib/puppet_litmus/spec_helper_acceptance.rb

@@ -35,6 +35,7 @@ module PuppetLitmus
         options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil?
         options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil?
         options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil?
+        run_as = node_config.dig('ssh', 'run-as') unless node_config.dig('ssh', 'run-as').nil?
         # Support both net-ssh 4 and 5.
         # rubocop:disable Metrics/BlockNesting
         options[:verify_host_key] = if node_config.dig('ssh', 'host-key-check').nil?
@@ -66,7 +67,9 @@ module PuppetLitmus
                end
         set :host,        options[:host_name] || host
         set :ssh_options, options
-        set :request_pty, true
+        set :request_pty, false
+        set :sudo_password, options[:password] if run_as
+        puts "Running tests as #{run_as}" if run_as
       elsif target_in_group(inventory_hash, ENV['TARGET_HOST'], 'winrm_nodes')
         require 'winrm'