puppet_litmus 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33763c6946158b131037d7d28f96b7db4ae5b924
-  data.tar.gz: f85aa0cd77c310d4e798f8676189839bb4276d2b
+SHA256:
+  metadata.gz: 9a8186fb041ca1c958fb32f75389eceb29cbe6c107c0510b725fdc2bba18b900
+  data.tar.gz: 7ffe43266b6c14f59f1c306f86c018f44b312d9ee02e9253e3b3cbd38932f26e
 SHA512:
-  metadata.gz: 345cfa379161bccf03db5945499114e6d322161891b66d85aac934e7cd8de8834cc73c465d65a19c482cf8320d22c1ae89b1afb8bcc9794dab2faf3a7460aeec
-  data.tar.gz: bc6916ad37c08f73ab2594c9537e14212257583e37437c396ea1f716219edfdda2a9be430c9d55bc8b7b1f777ec27beac7c76f1a97fb6d676f72bb36327a3ccf
+  metadata.gz: 12e95c5b22a998f54833adf7edd459ace61a85cceabc1463c5d572110aa2241c7642c96ab943ff6c9a6b8e5be4e42ff925fbaa19a6b4752f14ca5b9b0f050cda
+  data.tar.gz: 0b7570f08589b2603390f89920cf689a4e4f5491ed279e0dc7498aa3b182b9aa586c96a81be13cb16297d5ab7f6e92ec7eb82e0c31a1eebb4c88552471a2ce74

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -109,4 +109,51 @@ module PuppetLitmus::InventoryManipulation
     end
     inventory_hash
   end
+
+  # Adds a feature to the group specified/
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param feature_name [String] feature to locate in the group
+  # group_name [String] group of nodes to limit the search for the group_name in
+  # @return inventory.yaml file with feature added to group.
+  # @return [Hash] inventory_hash with feature added to group if group_name exists in inventory hash.
+  def add_feature_to_group(inventory_hash, feature_name, group_name)
+    i = 0
+    inventory_hash['groups'].each do |group|
+      if group['name'] == group_name
+        if group['features'].nil? == true
+          group = group.merge('features' => [])
+        end
+        group['features'].push feature_name
+        inventory_hash['groups'][i] = group
+      end
+      i += 1
+    end
+    inventory_hash
+  end
+
+  # Removes a feature from the group specified/
+  #
+  # @param inventory_hash [Hash] hash of the inventory.yaml file
+  # @param feature_name [String] feature to locate in the group
+  # group_name [String] group of nodes to limit the search for the group_name in
+  # @return inventory.yaml file with feature removed from the group.
+  # @return [Hash] inventory_hash with feature added to group if group_name exists in inventory hash.
+  def remove_feature_from_group(inventory_hash, feature_name, group_name)
+    inventory_hash['groups'].each do |group|
+      if group['name'] == group_name && group['features'].nil? != true
+        group['features'].delete(feature_name)
+      end
+    end
+    inventory_hash
+  end
+
+  # Write inventory_hash to inventory_yaml file/
+  #
+  #  @param inventory_full_path [String] path to the inventory.yaml file
+  #  @param inventory_hash [Hash] hash of the inventory.yaml file
+  #  @return inventory.yaml file with feature added to group.
+  def write_to_inventory_file(inventory_hash, inventory_full_path)
+    File.open(inventory_full_path, 'w+') { |f| f.write(inventory_hash.to_yaml) }
+  end
 end

data/lib/puppet_litmus/rake_tasks.rb

@@ -107,6 +107,8 @@ namespace :litmus do
   task :provision_list, [:key] do |_task, args|
     provision_hash = YAML.load_file('./provision.yaml')
     provisioner = provision_hash[args[:key]]['provisioner']
+    # Splat the params into environment variables to pass to the provision task but only in this runspace
+    provision_hash[args[:key]]['params']&.each { |key, value| ENV["LITMUS_#{key.upcase}"] = value }
     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
@@ -358,22 +360,30 @@ namespace :litmus do
         end
         spinners = TTY::Spinner::Multi.new("Running against #{targets.size} targets.[:spinner]", frames: ['.'], interval: 0.1)
         payloads = []
+        # Generate list of targets to provision
         targets.each do |target|
-          test = "TARGET_HOST=#{target} bundle exec rspec ./spec/acceptance --format progress"
+          test = 'bundle exec bundle exec rspec ./spec/acceptance --format progress'
           title = "#{target}, #{facts_from_node(inventory_hash, target)['platform']}"
-          payloads << [title, test]
+          options = {
+            env: {
+              'TARGET_HOST' => target,
+            },
+          }
+          payloads << [title, test, options]
         end
 
         results = []
         success_list = []
         failure_list = []
+        # Provision targets depending on what environment we're in
         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)
+          results = Parallel.map(payloads) do |title, test, options|
+            env = options[:env].nil? ? {} : options[:env]
+            stdout, stderr, status = Open3.capture3(env, test)
             ["================\n#{title}\n", stdout, stderr, status]
           end
           # because we cannot modify variables inside of Parallel
@@ -387,9 +397,10 @@ namespace :litmus do
           spinner.success
         else
           spinners = TTY::Spinner::Multi.new("[:spinner] Running against #{targets.size} targets.")
-          payloads.each do |title, test|
+          payloads.each do |title, test, options|
+            env = options[:env].nil? ? {} : options[:env]
             spinners.register("[:spinner] #{title}") do |sp|
-              stdout, stderr, status = Open3.capture3(test)
+              stdout, stderr, status = Open3.capture3(env, test)
               if status.to_i.zero?
                 sp.success
                 success_list.push(title)

data/lib/puppet_litmus/serverspec.rb

@@ -102,6 +102,37 @@ module PuppetLitmus::Serverspec
     result
   end
 
+  # Copies file to the target, using its respective transport
+  #
+  # @param source [String] place locally, to copy from.
+  # @param destination [String] place on the target, to copy to.
+  # @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.
+  # @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 bolt_upload_file(source, destination, options = {})
+    target_node_name = ENV['TARGET_HOST'] if target_node_name.nil?
+    inventory_hash = if target_node_name.nil? || target_node_name == 'localhost'
+                       nil
+                     else
+                       inventory_hash_from_inventory_file
+                     end
+
+    result = upload_file(source, destination, target_node_name, options: options, config: nil, inventory: inventory_hash)
+
+    raise "upload file failed\n======\n#{result}" if result.first['status'] != 'success'
+
+    exit_code = if result.first['status'] == 'success'
+                  0
+                else
+                  255
+                end
+    result = OpenStruct.new(exit_code: exit_code,
+                            stdout: result.first['result']['status'],
+                            stderr: result.first['result']['status'])
+    yield result if block_given?
+    result
+  end
+
   # Runs a task against the target system.
   #
   # @param task_name [String] The name of the task to run.

data/lib/puppet_litmus/version.rb

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

data/spec/data/inventory.yaml

@@ -0,0 +1,16 @@
+---
+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: []

data/spec/lib/puppet_litmus/inventory_manipulation_spec.rb

@@ -31,6 +31,40 @@ RSpec.describe PuppetLitmus::InventoryManipulation do
    { 'name' => 'winrm_nodes', 'nodes' => [] }] }
     end
 
+    let(:inventory_full_path) { 'spec/data/inventory.yaml' }
+
+    let(:no_feature_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
+
+    let(:feature_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' } }],
+     'features' => ['puppet-agent'] },
+   { 'name' => 'winrm_nodes', 'nodes' => [] }] }
+    end
+
+    let(:empty_feature_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' } }],
+     'features' => [] },
+   { '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
@@ -43,5 +77,26 @@ RSpec.describe PuppetLitmus::InventoryManipulation 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
+
+    it 'no feature exists, and returns hash with feature added' do
+      expect(dummy_class.add_feature_to_group(no_feature_hash, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+    end
+
+    it 'feature exists, and returns hash with feature removed' do
+      expect(dummy_class.remove_feature_from_group(feature_hash, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => [], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+    end
+
+    it 'write from inventory_hash to inventory_yaml file feature_hash' do
+      expect { dummy_class.write_to_inventory_file(feature_hash, inventory_full_path) }.not_to raise_error
+    end
+
+    it 'empty feature exists, and returns hash with feature added' do
+      expect(dummy_class.add_feature_to_group(empty_feature_hash, 'puppet-agent', 'ssh_nodes')).to eq('groups' => [{ 'features' => ['puppet-agent'], 'name' => 'ssh_nodes', 'nodes' => [{ 'config' => { 'ssh' => { 'host-key-check' => false, 'password' => 'Qu@lity!', 'user' => 'root' }, 'transport' => 'ssh' }, 'facts' => { 'platform' => 'centos-5-x86_64', 'provisioner' => 'vmpooler' }, 'name' => 'test.delivery.puppetlabs.net' }] }, { 'name' => 'winrm_nodes', 'nodes' => [] }]) # rubocop:disable Metrics/LineLength: Line is too long
+    end
+
+    it 'write from inventory_hash to inventory_yaml file no feature_hash' do
+      expect(File).to exist(inventory_full_path)
+      expect { dummy_class.write_to_inventory_file(no_feature_hash, inventory_full_path) }.not_to raise_error
+    end
   end
 end

data/spec/lib/puppet_litmus/serverspec_spec.rb

@@ -50,4 +50,33 @@ RSpec.describe PuppetLitmus::Serverspec do
       end
     end
   end
+
+  describe '.bolt_upload_file' do
+    let(:local) { '/tmp' }
+    let(:remote) { '/remote_tmp' }
+    let(:result) { ['status' => 'success', '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(:bolt_upload_file).with(2..3).arguments
+    end
+
+    context 'when running against remote host' do
+      it 'does upload_file 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(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result)
+        expect { dummy_class.bolt_upload_file(local, remote) }.not_to raise_error
+      end
+    end
+
+    context 'when running against remote host' do
+      it 'does upload_file against localhost without error' do
+        allow(ENV).to receive(:[]).with('TARGET_HOST').and_return('localhost')
+        expect(dummy_class).not_to receive(:inventory_hash_from_inventory_file)
+        expect(dummy_class).to receive(:upload_file).with(local, remote, 'localhost', options: {}, config: nil, inventory: nil).and_return(result)
+        expect { dummy_class.bolt_upload_file(local, remote) }.not_to raise_error
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -85,6 +85,7 @@ files:
 - lib/puppet_litmus/rake_tasks.rb
 - lib/puppet_litmus/serverspec.rb
 - lib/puppet_litmus/version.rb
+- spec/data/inventory.yaml
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
 - spec/lib/puppet_litmus/serverspec_spec.rb
@@ -109,15 +110,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.4
 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:
-- spec/spec_helper.rb
-- spec/lib/puppet_litmus/rake_tasks_spec.rb
-- spec/lib/puppet_litmus/version_spec.rb
+- spec/data/inventory.yaml
 - 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