puppet_litmus 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a75172285da5913803f07bae8651183d7196cd14
-  data.tar.gz: 45d70cbc2fcc22010f38a29b10f022d74ae5bae5
+  metadata.gz: 071a673e5f77fa53f54031196856229f59a8869b
+  data.tar.gz: d35953f4b2d720a7f185c558ff71ea21964db698
 SHA512:
-  metadata.gz: 6053495d1f61e0a8c671b81cd50048f6cb064431806950a8d93ab79510290e6168470fbfd3991c97833bbcb01a1c5ac89c80ee0ad150680c07e2e1f8d7cb802f
-  data.tar.gz: ccc9d916d4a6f56c138bfdbb6767e5f2c20bb059d5fcfb20d5f332f47e59635acde327b20585140ccf5529f0c7d91163a5b41d3b0f2bcb6712b12effe33bb12b
+  metadata.gz: da87c6046e0eddf2873ce385a95fb772cdbc92acf62525f588d1e86f6b10b43bde52634a9a228ceb99ad3f22a48ae16c44d0f387e0c31a069e59a8e7378dc9c8
+  data.tar.gz: ca340854e2b2f81d0205c30a9a07a13343c0f75ad67879a38c405f1d5962cc427ca783a71e301d90e1804c69e0f23105eb0b4110746f0768f41d22d68a4f3d46

data/lib/puppet_litmus/rake_tasks.rb

@@ -6,7 +6,6 @@ require 'bolt_spec/run'
 require 'open3'
 require 'pdk'
 require 'json'
-require 'parallel'
 
 def get_metadata_operating_systems(metadata)
   return unless metadata.is_a?(Hash)
@@ -110,28 +109,18 @@ namespace :litmus do
     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'))
 
-    if %w[abs vmpooler].include?(args[:provisioner])
-      params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
-      results = run_task("provision::#{args[:provisioner]}", 'localhost', params, config: config_data, inventory: nil)
-      results.each do |result|
-        if result['status'] != 'success'
-          puts "Failed #{result['node']}\n#{result}"
-        else
-          puts "#{result['result']['node_name']}, #{args[:platform]}"
-        end
-      end
-    elsif args[:provisioner] == 'docker'
-      params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
-      results = run_task('provision::docker', 'localhost', params, config: config_data, inventory: nil)
-      results.each do |result|
-        if result['status'] != 'success'
-          puts "Failed #{result['node']}\n#{result}"
-        else
-          puts "#{result['result']['node_name']}, #{args[:platform]}"
-        end
+    unless %w[abs vmpooler docker vagrant].include?(args[:provisioner])
+      raise "Unknown provisioner '#{args[:provisioner]}', try abs/docker/vmpooler/vagrant"
+    end
+
+    params = { 'action' => 'provision', 'platform' => args[:platform], 'inventory' => Dir.pwd }
+    results = run_task("provision::#{args[:provisioner]}", 'localhost', params, config: config_data, inventory: nil)
+    results.each do |result|
+      if result['status'] != 'success'
+        puts "Failed #{result['node']}\n#{result}"
+      else
+        puts "#{result['result']['node_name']}, #{args[:platform]}"
       end
-    else
-      raise "Unknown provisioner '#{args[:provisioner]}', try abs/docker/vmpooler"
     end
   end
 
@@ -218,7 +207,7 @@ namespace :litmus do
     targets.each do |node_name|
       # how do we know what provisioner to use
       node_facts = facts_from_node(inventory_hash, node_name)
-      next unless %w[abs docker vmpooler].include?(node_facts['provisioner'])
+      next unless %w[abs docker vmpooler vagrant].include?(node_facts['provisioner'])
 
       params = { 'action' => 'tear_down', 'node_name' => node_name, 'inventory' => Dir.pwd }
       result = run_task("provision::#{node_facts['provisioner']}", 'localhost', params, config: config_data, inventory: nil)
@@ -240,32 +229,66 @@ namespace :litmus do
     include PuppetLitmus::InventoryManipulation
     if File.file?('inventory.yaml')
       inventory_hash = inventory_hash_from_inventory_file
-      hosts = find_targets(inventory_hash, nil)
+      targets = find_targets(inventory_hash, nil)
 
       desc 'Run tests in parallel against all machines in the inventory file'
       task :parallel do
-        args = []
-        hosts.each do |host|
-          args << ["TARGET_HOST=#{host} bundle exec rspec ./spec/acceptance --format progress --format html --out html/#{host}.html", host]
+        spinners = TTY::Spinner::Multi.new("Running against #{targets.size} targets.[:spinner]", frames: ['.'], interval: 0.1)
+        payloads = []
+        targets.each do |target|
+          test = "TARGET_HOST=#{target} bundle exec rspec ./spec/acceptance --format progress"
+          title = "#{target}, #{facts_from_node(inventory_hash, target)['platform']}"
+          payloads << [title, test]
         end
-        results = Parallel.map(args, progress: "Running against #{hosts.size} machines") do |test, host|
-          stdout, stderr, status = Open3.capture3(test)
-          ["================\n#{host}\n", stdout, stderr, status]
+
+        results = []
+        success_list = []
+        failure_list = []
+        if (ENV['CI'] == 'true') || !ENV['DISTELLI_BUILDNUM'].nil?
+          # CI systems are strange beasts, we only output a '.' every wee while to keep the terminal alive.
+          puts "Running against #{targets.size} targets.\n"
+          spinner = TTY::Spinner.new(':spinner', frames: ['.'], interval: 0.1)
+          spinner.auto_spin
+          results = Parallel.map(payloads) do |title, test|
+            stdout, stderr, status = Open3.capture3(test)
+            ["================\n#{title}\n", stdout, stderr, status]
+          end
+          spinner.success
+        else
+          spinners = TTY::Spinner::Multi.new("[:spinner] Running against #{targets.size} targets.")
+          payloads.each do |title, test|
+            spinners.register("[:spinner] #{title}") do |sp|
+              stdout, stderr, status = Open3.capture3(test)
+              if status.to_i.zero?
+                sp.success
+                success_list.push(title)
+              else
+                sp.error
+                failure_list.push(title)
+              end
+              results.push(["================\n#{title}\n", stdout, stderr, status])
+            end
+          end
+          spinners.auto_spin
+          spinners.success
         end
-        # if any result is nonzero, there were test failures
-        failures = false
+
+        # output test results
         results.each do |result|
-          failures = true unless result.last.exitstatus.zero?
           puts result
         end
-        exit 1 if failures
+
+        # output test summary
+        puts "Successful on #{success_list.size} nodes: #{success_list}" if success_list.any?
+        puts "Failed on #{failure_list.size} nodes: #{failure_list}" if failure_list.any?
+        exit 1 if failure_list.any?
       end
 
-      hosts.each do |host|
-        desc "Run serverspec against #{host}"
-        RSpec::Core::RakeTask.new(host.to_sym) do |t|
+      targets.each do |target|
+        desc "Run serverspec against #{target}"
+        RSpec::Core::RakeTask.new(target.to_sym) do |t|
           t.pattern = 'spec/acceptance/**{,/*/**}/*_spec.rb'
-          ENV['TARGET_HOST'] = host
+          ENV['TARGET_HOST'] = target
         end
       end
     end

data/lib/puppet_litmus/serverspec.rb

@@ -1,14 +1,33 @@
 # frozen_string_literal: true
 
-# helper functions for running puppet commands, and helpers
+# 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
+  # Applies a manifest twice. First checking for errors. Secondly to make sure no changes occur.
+  #
+  # @param manifest [String] puppet manifest code to be applied.
+  # @return [Boolean] The result of the 2 apply manifests.
   def idempotent_apply(manifest)
     manifest_file_location = create_manifest_file(manifest)
     apply_manifest(nil, catch_failures: true, manifest_file_location: manifest_file_location)
     apply_manifest(nil, catch_changes: true, manifest_file_location: manifest_file_location)
   end
 
+  # rubocop:disable Layout/TrailingWhitespace
+
+  # Applies a manifest. returning the result of that apply. Mimics the apply_manifest from beaker
+  #
+  # @param manifest [String] puppet manifest code to be applied.
+  # @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.
+  # @param [Block] his 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
     target_node_name = ENV['TARGET_HOST']
     raise 'manifest and manifest_file_location in the opts hash are mutually exclusive arguments, pick one' if !manifest.nil? && !opts[:manifest_file_location].nil?
     raise 'please pass a manifest or the manifest_file_location in the opts hash' if (manifest.nil? || manifest == '') && opts[:manifest_file_location].nil?
@@ -19,9 +38,10 @@ module PuppetLitmus::Serverspec
                      else
                        inventory_hash_from_inventory_file
                      end
-    command_to_run = "puppet apply #{manifest_file_location}"
+    command_to_run = "#{opts[:prefix_command]} puppet apply #{manifest_file_location}"
     command_to_run += " --modulepath #{Dir.pwd}/spec/fixtures/modules" if target_node_name.nil? || target_node_name == 'localhost'
     command_to_run += ' --detailed-exitcodes' if !opts[:catch_changes].nil? && (opts[:catch_changes] == true)
+    command_to_run += ' --debug' if !opts[:debug].nil? && (opts[:debug] == true)
     # BOLT-608
     if Gem.win_platform?
       stdout, stderr, status = Open3.capture3(command_to_run)
@@ -35,13 +55,22 @@ module PuppetLitmus::Serverspec
       result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
     end
 
-    raise "apply mainfest failed\n`#{command_to_run}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
+    raise "apply manifest failed\n`#{command_to_run}`\n======\n#{result}" if result.first['result']['exit_code'] != 0 && opts[:expect_failures] != true
 
-    result.first
+    result = OpenStruct.new(exit_code: result.first['result']['exit_code'],
+                            stdout: result.first['result']['stdout'],
+                            stderr: result.first['result']['stderr'])
+    yield result if block_given?
+    result
   end
 
-  # creates a temp manifest file locally & remote depending on target
+  # Creates a manifest file locally, if running against localhost create in a temp location. Or create it on the target system.
+  #
+  # @param manifest [String] puppet manifest code.
+  # @return [String] The path to the location of the manifest.
   def create_manifest_file(manifest)
+    require 'tempfile'
+
     target_node_name = ENV['TARGET_HOST']
     manifest_file = Tempfile.new(['manifest_', '.pp'])
     manifest_file.write(manifest)
@@ -59,6 +88,12 @@ module PuppetLitmus::Serverspec
     manifest_file_location
   end
 
+  # Runs a command against the target system
+  #
+  # @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.
+  # @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']
@@ -66,10 +101,18 @@ module PuppetLitmus::Serverspec
 
     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'],
+                            stdout: result.first['result']['stdout'],
+                            stderr: result.first['result']['stderr'])
+    yield result if block_given?
     result
   end
 
-  # Runs a selected task against the target host. Parameters should be passed in with a hash format.
+  # Runs a task against the target system.
+  #
+  # @param task_name [String] The name of the task to run.
+  # @param params [Hash] key : value pairs to be passed to the task.
+  # @return [Object] A result object from the task.
   def run_bolt_task(task_name, params = {})
     config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
     inventory_hash = inventory_hash_from_inventory_file

data/lib/puppet_litmus/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -50,6 +50,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: "    Providing a simple command line tool for puppet content creators,
   to enable simple and complex test deployments.\n"
 email: