puppet_litmus 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 418acded5bb7ca19c9a011892b89b805aaedd642be7e94d004f038640d144c28
-  data.tar.gz: 20082a2cba1921b73cfb1a0324709253b6f74318916c8c302c8eb917cf7ad2f3
+SHA1:
+  metadata.gz: 9caf40c0204bbf7ee96cd7972dc94d1d08fe3789
+  data.tar.gz: f08c3e7468e1fc0c17a4ec66dd4df044cb7b21b4
 SHA512:
-  metadata.gz: d55ceaa23d4df5e1aed93363f2d3ecd725817064003630728887fb5f10262f079e89e60dc69b86e05f22e560d98f9b9ea1dcf5cad4fc419ad2d56766b538e499
-  data.tar.gz: d27be055768592ccdbc603b374787a2f4ce555f6c8649bcee071a5beaece65e699bd4cc2b7b22ece8706cb1ecc3ffa26752afd6d61477b9dd443866d20c50e68
+  metadata.gz: 630d0081008784dd6d8a0b822a2e69eea7e36c7eafec4263844c70bbed503936f804e2f3cac591d479ae7ccdc7fea7c0b00037a7e7da16063f80d86bdfb37506
+  data.tar.gz: 8362adbc00c895e436d1b587a3c4e9f8f66d5b9105fe1fab5d0c2c43a5c84a14db97fa6c9e08d5069a56a3c70ca5de9da57f6b3c9695aaa029b7507690b2a2d3

data/README.md

@@ -1,7 +1,14 @@
 # Litmus
 
+<div name="logo">
+  <img src="resources/litmus-dark-RGB.png"
+  style="display: block; margin-left: auto; margin-right: auto;"
+  width="50%"
+  alt="litmus logo">
+</div>
+
 ## Overview
-Litmus provides a simple command line tool for Puppet content creators, to enable both simple and complex test deployments against specifically configured target systems. It is available as a gem, and can be installed by running ```gem install puppet-litmus```.
+Litmus provides a simple command line tool for Puppet content creators, to enable both simple and complex test deployments against specifically configured target systems. It is available as a gem, and can be installed by running ```gem install puppet_litmus```.
 
 Litmus allows Puppet module developers to:
 * provision targets to test against,
@@ -20,25 +27,9 @@ All our documentation is currently available in the [Wiki](https://github.com/pu
 * [Architecture](https://github.com/puppetlabs/puppet_litmus/wiki/Architecture-of-puppet-litmus) with an explanation of what's going on under the hood
 * [Step-by-step guide](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)) of how to use Litmus with the popular and simple [MoTD Puppet module](https://forge.puppet.com/puppetlabs/motd).
 * [How to guide](https://github.com/puppetlabs/puppet_litmus/wiki/Converting-a-module-to-use-Litmus) walking through how to use Litmus in a module
-
+* [Helper functions](https://github.com/puppetlabs/puppet_litmus/wiki/Helper-Functions-for-Litmus) a guide to the various helper functions within Litmus.
 ## Known issues
 
-### PDK and Bolt dependencies infers support on Ruby and Puppet versions
-
-We are actively working towards the point that where we declare our gem dependencies for PDK and Bolt gems in the puppet_litmus gemspec file [here](https://github.com/puppetlabs/puppet_litmus/blame/master/puppet_litmus.gemspec#L23)
-
-Bolt has a hard dependency on Puppet 6, and CRI 2.15.1 which is ruby version specific
-
-PDK depends on CRI 2.10.0 which is ruby version specific
-
-We have work in progress to create a pathway through this. A fix is up for PDK, which allows CRI 2.15 and 2.10 to be used (here)[https://github.com/puppetlabs/pdk/pull/638]. This also allows the use of multiple ruby versions.
-
-A PR (here)[https://github.com/puppetlabs/puppetlabs-motd/pull/200] shows what needs to happen within a module, to use litmus for puppet 5 unit tests, and puppet 6 unit tests. Also for running acceptance tests against puppet 5 and puppet 6 with litmus.
-
-(Gem changes for a module)[https://github.com/puppetlabs/puppetlabs-motd/blob/29d8c9b0ceceb4b0114a66077ce0f473a49481a5/Gemfile#L34-L39] it only installs litmus if your are running puppet 6 and system tests. Also to use a version of the pdk that has the CRI fixes. You can still test against puppet 5 targets in acceptance tests. IF you want to run unit tests against the puppet 5 gem you will have to run something like (this)[https://github.com/puppetlabs/puppetlabs-motd/blob/29d8c9b0ceceb4b0114a66077ce0f473a49481a5/.travis.yml#L107]
-
-Thank you for your patience. 
-
 ## Other Resources
 
 * [Is it Worth the Time?](https://xkcd.com/1205/)

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# helper functions for manipulating and reading a bolt inventory file
+module PuppetLitmus::InventoryManipulation
+  def inventory_hash_from_inventory_file(inventory_full_path = nil)
+    inventory_full_path = if inventory_full_path.nil?
+                            'inventory.yaml'
+                          else
+                            inventory_full_path
+                          end
+    raise "There is no inventory file at '#{inventory_full_path}'" unless File.exist?(inventory_full_path)
+
+    inventory_hash = YAML.load_file(inventory_full_path)
+    inventory_hash
+  end
+
+  def find_targets(inventory_hash, targets)
+    if targets.nil?
+      inventory = Bolt::Inventory.new(inventory_hash, nil)
+      targets = inventory.node_names.to_a
+    else
+      targets = [targets]
+    end
+    targets
+  end
+
+  def target_in_group(inventory_hash, node_name, group_name)
+    exists = false
+    inventory_hash['groups'].each do |group|
+      next unless group['name'] == group_name
+
+      group['nodes'].each do |node|
+        exists = true if node['name'] == node_name
+      end
+    end
+    exists
+  end
+
+  def config_from_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].each do |node|
+        if node['name'] == node_name
+          return node['config']
+        end
+      end
+    end
+    raise "No config was found for #{node_name}"
+  end
+
+  def facts_from_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].each do |node|
+        if node['name'] == node_name
+          return node['facts']
+        end
+      end
+    end
+    raise "No config was found for #{node_name}"
+  end
+
+  def add_node_to_group(inventory_hash, node_name, group_name)
+    inventory_hash['groups'].each do |group|
+      if group['name'] == group_name
+        group['nodes'].push node_name
+      end
+    end
+    inventory_hash
+  end
+
+  def remove_node(inventory_hash, node_name)
+    inventory_hash['groups'].each do |group|
+      group['nodes'].delete_if { |i| i['name'] == node_name }
+    end
+    inventory_hash
+  end
+end

data/lib/puppet_litmus/rake_tasks.rb

@@ -66,7 +66,7 @@ namespace :litmus do
     metadata = JSON.parse(File.read('metadata.json'))
     get_metadata_operating_systems(metadata) do |os_and_version|
       puts os_and_version
-      include PuppetLitmus
+      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'))
@@ -87,15 +87,25 @@ namespace :litmus do
   task :provision_list, [:key] do |_task, args|
     provision_hash = YAML.load_file('./provision.yaml')
     provisioner = provision_hash[args[:key]]['provisioner']
+    failed_image_message = ''
     provision_hash[args[:key]]['images'].each do |image|
+      # this is the only way to capture the stdout from the rake task, it will affect pry
+      capture_rake_output = StringIO.new
+      $stdout = capture_rake_output
       Rake::Task['litmus:provision'].invoke(provisioner, image)
+      if $stdout.string =~ %r{.status.=>.failure}
+        failed_image_message += "=====\n#{image}\n#{$stdout.string}\n"
+      else
+        STDOUT.puts $stdout.string
+      end
       Rake::Task['litmus:provision'].reenable
     end
+    raise "Failed to provision with '#{provisioner}'\n #{failed_image_message}" unless failed_image_message.empty?
   end
 
   desc "provision container/VM - abs/docker/vmpooler eg 'bundle exec rake 'litmus:provision[vmpooler, ubuntu-1604-x86_64]'"
   task :provision, [:provisioner, :platform] do |_task, args|
-    include PuppetLitmus
+    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'))
@@ -197,6 +207,7 @@ namespace :litmus do
 
   desc 'tear-down - decommission machines'
   task :tear_down, [:target] do |_task, args|
+    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'))
@@ -226,7 +237,7 @@ namespace :litmus do
   end
 
   namespace :acceptance do
-    include PuppetLitmus
+    include PuppetLitmus::InventoryManipulation
     if File.file?('inventory.yaml')
       inventory_hash = inventory_hash_from_inventory_file
       hosts = find_targets(inventory_hash, nil)

data/lib/puppet_litmus/serverspec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# helper functions for running puppet commands, and helpers
+module PuppetLitmus::Serverspec
+  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
+
+  def apply_manifest(manifest, opts = {})
+    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?
+
+    manifest_file_location = opts[:manifest_file_location] || create_manifest_file(manifest)
+    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
+                       nil
+                     else
+                       inventory_hash_from_inventory_file
+                     end
+    command_to_run = "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)
+    # BOLT-608
+    if Gem.win_platform?
+      stdout, stderr, status = Open3.capture3(command_to_run)
+      status_text = if status.to_i.zero?
+                      'success'
+                    else
+                      'failure'
+                    end
+      result = [{ 'node' => 'localhost', 'status' => status_text, 'result' => { 'exit_code' => status.to_i, 'stderr' => stderr, 'stdout' => stdout } }]
+    else
+      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
+
+    result.first
+  end
+
+  # creates a temp manifest file locally & remote depending on target
+  def create_manifest_file(manifest)
+    target_node_name = ENV['TARGET_HOST']
+    manifest_file = Tempfile.new(['manifest_', '.pp'])
+    manifest_file.write(manifest)
+    manifest_file.close
+    if target_node_name.nil? || target_node_name == 'localhost'
+      # no need to transfer
+      manifest_file_location = manifest_file.path
+    else
+      # transfer to TARGET_HOST
+      inventory_hash = inventory_hash_from_inventory_file
+      manifest_file_location = "/tmp/#{File.basename(manifest_file)}"
+      result = upload_file(manifest_file.path, manifest_file_location, target_node_name, options: {}, config: nil, inventory: inventory_hash)
+      raise result.first['result'].to_s unless result.first['status'] == 'success'
+    end
+    manifest_file_location
+  end
+
+  def run_shell(command_to_run, opts = {})
+    inventory_hash = inventory_hash_from_inventory_file
+    target_node_name = ENV['TARGET_HOST']
+    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
+  end
+
+  # Runs a selected task against the target host. Parameters should be passed in with a hash format.
+  def run_bolt_task(task_name, params = {})
+    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
+    inventory_hash = inventory_hash_from_inventory_file
+    target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
+
+    result = run_task(task_name, target_node_name, params, config: config_data, inventory: inventory_hash)
+
+    raise "task failed\n`#{task_name}`\n======\n#{result}" if result.first['status'] != 'success'
+
+    result
+  end
+end

data/lib/puppet_litmus/version.rb

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

data/lib/puppet_litmus.rb

@@ -1,161 +1,12 @@
 # frozen_string_literal: true
 
 require 'bolt_spec/run'
+require 'puppet_litmus/inventory_manipulation'
+require 'puppet_litmus/serverspec'
 
 # Helper methods for testing puppet content
 module PuppetLitmus
   include BoltSpec::Run
-  def apply_manifest(manifest, opts = {})
-    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?
-
-    manifest_file_location = opts[:manifest_file_location] || create_manifest_file(manifest)
-    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
-                       nil
-                     else
-                       inventory_hash_from_inventory_file
-                     end
-    command_to_run = "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)
-    # BOLT-608
-    if Gem.win_platform?
-      stdout, stderr, status = Open3.capture3(command_to_run)
-      status_text = if status.to_i.zero?
-                      'success'
-                    else
-                      'failure'
-                    end
-      result = [{ 'node' => 'localhost', 'status' => status_text, 'result' => { 'exit_code' => status.to_i, 'stderr' => stderr, 'stdout' => stdout } }]
-    else
-      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
-
-    result
-  end
-
-  # creates a temp manifest file locally & remote depending on target
-  def create_manifest_file(manifest)
-    target_node_name = ENV['TARGET_HOST']
-    manifest_file = Tempfile.new(['manifest_', '.pp'])
-    manifest_file.write(manifest)
-    manifest_file.close
-    if target_node_name.nil? || target_node_name == 'localhost'
-      # no need to transfer
-      manifest_file_location = manifest_file.path
-    else
-      # transfer to TARGET_HOST
-      command = "bundle exec bolt file upload #{manifest_file.path} /tmp/#{File.basename(manifest_file)} --nodes #{target_node_name} --inventoryfile inventory.yaml"
-      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?
-
-      manifest_file_location = "/tmp/#{File.basename(manifest_file)}"
-    end
-    manifest_file_location
-  end
-
-  def apply_manifest_and_idempotent(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
-
-  def run_shell(command_to_run, opts = {})
-    inventory_hash = inventory_hash_from_inventory_file
-    target_node_name = ENV['TARGET_HOST']
-    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
-  end
-
-  def inventory_hash_from_inventory_file(inventory_full_path = nil)
-    inventory_full_path = if inventory_full_path.nil?
-                            'inventory.yaml'
-                          else
-                            inventory_full_path
-                          end
-    raise "There is no inventory file at '#{inventory_full_path}'" unless File.exist?(inventory_full_path)
-
-    inventory_hash = YAML.load_file(inventory_full_path)
-    inventory_hash
-  end
-
-  def find_targets(inventory_hash, targets)
-    if targets.nil?
-      inventory = Bolt::Inventory.new(inventory_hash, nil)
-      targets = inventory.node_names.to_a
-    else
-      targets = [targets]
-    end
-    targets
-  end
-
-  def target_in_group(inventory_hash, node_name, group_name)
-    exists = false
-    inventory_hash['groups'].each do |group|
-      next unless group['name'] == group_name
-
-      group['nodes'].each do |node|
-        exists = true if node['name'] == node_name
-      end
-    end
-    exists
-  end
-
-  def config_from_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['nodes'].each do |node|
-        if node['name'] == node_name
-          return node['config']
-        end
-      end
-    end
-    raise "No config was found for #{node_name}"
-  end
-
-  def facts_from_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['nodes'].each do |node|
-        if node['name'] == node_name
-          return node['facts']
-        end
-      end
-    end
-    raise "No config was found for #{node_name}"
-  end
-
-  def add_node_to_group(inventory_hash, node_name, group_name)
-    inventory_hash['groups'].each do |group|
-      if group['name'] == group_name
-        group['nodes'].push node_name
-      end
-    end
-    inventory_hash
-  end
-
-  def remove_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['nodes'].delete_if { |i| i['name'] == node_name }
-    end
-    inventory_hash
-  end
-
-  # Runs a selected task against the target host. Parameters should be passed in with a hash format.
-  def task_run(task_name, params)
-    config_data = { 'modulepath' => File.join(Dir.pwd, 'spec', 'fixtures', 'modules') }
-    inventory_hash = inventory_hash_from_inventory_file
-    target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
-
-    result = run_task(task_name, target_node_name, params, config: config_data, inventory: inventory_hash)
-
-    raise "task failed\n`#{task_name}`\n======\n#{result}" if result.first['status'] != 'success'
-
-    result
-  end
+  include PuppetLitmus::InventoryManipulation
+  include PuppetLitmus::Serverspec
 end

data/spec/lib/puppet_litmus_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe PuppetLitmus do
+  it 'has a version number' do
+    expect(described_class::VERSION).not_to be nil
+    expect(described_class::VERSION).to be_a_kind_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'puppet_litmus'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -61,8 +61,12 @@ files:
 - LICENSE
 - README.md
 - lib/puppet_litmus.rb
+- lib/puppet_litmus/inventory_manipulation.rb
 - lib/puppet_litmus/rake_tasks.rb
+- lib/puppet_litmus/serverspec.rb
 - lib/puppet_litmus/version.rb
+- spec/lib/puppet_litmus_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/puppetlabs/puppet_litmus
 licenses:
 - Apache-2.0
@@ -83,9 +87,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
   simple and complex test deployments.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/lib/puppet_litmus_spec.rb