puppet_litmus 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325cdb47d0f7db0541938b78bf14879da2db05ba40d9a946ce99fd506d0f9c1d
-  data.tar.gz: d157bb8ff3192444f9eb974a12428e2b24dc4a3340a40a0bfaed2e5a33c3dd99
+  metadata.gz: 80914970290db5501971ee324794c82101f204d1c78a74cbd618547f8fb345c0
+  data.tar.gz: 596c114a8c75fb36f6ab8350850eca9005036fbdf12ed7d3465e2375c937579e
 SHA512:
-  metadata.gz: e8384b785f1b183bf5554f51113171af51d3c2ebe5ec5c5695222be7cac2cfd30716c0b28d47aa277c2b7bacbd9a2715af780d93479817cfb2ac0f2d1b964c1a
-  data.tar.gz: d387235b43cae7895acc007cd9bb314136488d29b9196fc5b51a2b7ab45357befb0c2e4a1c63f11a6b3cb24232ce6e5230b300fb7c5658bca1bdb5a6abe5ac64
+  metadata.gz: eef1f207558172836438bc1bb5686610af52560bd7eb99ae2ff9ae332fa3705f249587dd4eb4f12c4ffd83c0011d03764dd6fa974b21be4012144829d984a429
+  data.tar.gz: 57d962b1ea4e49fd483319514197f5b1d119ab9b69e981c2e3a17f151b71358477b6a7276bbee3101f3d0a5f1d00a0cb081de953dfbf750e1ba6d53016836f58

data/exe/matrix_from_metadata_v2

@@ -13,6 +13,7 @@ IMAGE_TABLE = {
   'Windows-2012 R2' => 'windows-2012-r2-core',
   'Windows-2016' => 'windows-2016',
   'Windows-2019' => 'windows-2019-core',
+  'Windows-2022' => 'windows-2022',
 }.freeze
 
 DOCKER_PLATFORMS = {

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -53,6 +53,85 @@ module PuppetLitmus::InventoryManipulation
     end
   end
 
+  # Recursively find and iterate over the groups in an inventory. If no block is passed
+  # to the function then only the name of the group is returned. If a block is passed
+  # then the block is executed against each group and the value of the block is returned.
+  #
+  # @param inventory_hash [Hash] Inventory hash from inventory.yaml
+  # @param block [Block] Block to execute against each node
+  def groups_in_inventory(inventory_hash, &block)
+    inventory_hash['groups'].flat_map do |group|
+      output_collector = []
+      output_collector << if block_given?
+                            yield group
+                          else
+                            group['name'].downcase
+                          end
+      output_collector << groups_in_inventory({ 'groups' => group['groups'] }, &block) if group.key? 'groups'
+      output_collector.flatten.compact
+    end
+  end
+
+  # Iterate over all targets in an inventory. If no block is given to the function
+  # it will return the name of every target in the inventory. If a block is passed
+  # it will execute the block on each target and return the value of the block.
+  #
+  # @param inventory_hash [Hash] Inventory hash from inventory.yaml
+  # @param block [Block] Block to execute against each node
+  def targets_in_inventory(inventory_hash)
+    groups_in_inventory(inventory_hash) do |group|
+      if group.key? 'targets'
+        group['targets'].map do |target|
+          if block_given?
+            (yield target)
+          else
+            target['uri'].downcase
+          end
+        end
+      end
+    end
+  end
+
+  # Find all targets in an inventory that have a role. The roles for a target are
+  # specified in the vars hash for a target. This function is tolerant to the roles
+  # hash being called either 'role' or 'roles' and it is tolerant to the roles being
+  # either a single key value or an array of roles.
+  #
+  # @param role [String] The name of a role to search for
+  # @param inventory [Hash] Inventory hash from inventory.yaml
+  def nodes_with_role(role, inventory)
+    output_collector = []
+    targets_in_inventory(inventory) do |target|
+      vars = target['vars']
+      roles = [(vars['role'] || vars['roles'])].flatten
+      roles = roles.map { |r| r.downcase }
+      output_collector << target['uri'] if roles.include? role.downcase
+    end
+    output_collector unless output_collector.empty?
+  end
+
+  # Searches through the inventory hash to either validate that a group being targeted exists,
+  # validate that a specific target being targeted exists, or resolves role names to a
+  # list of nodes to target. Targets and roles can be specified as strings or as symbols, and
+  # the functions are tolerant to incorrect capitalization.
+  #
+  # @param target [String] || [Array[String]] A list of targets
+  # @param inventory [Hash] inventory hash from inventory.yaml
+  def search_for_target(target, inventory)
+    result_collector = []
+    groups = groups_in_inventory(inventory)
+    Array(target).map do |name|
+      result_collector << name if groups.include? name.to_s.downcase
+      result_collector << name if targets_in_inventory(inventory).include? name.to_s.downcase
+      result_collector << nodes_with_role(name.to_s, inventory)
+    end
+
+    result_collector = result_collector.flatten.compact
+    raise 'targets not found in inventory' if result_collector.empty?
+
+    result_collector
+  end
+
   # Determines if a node_name exists in a group in the inventory_hash.
   #
   # @param inventory_hash [Hash] hash of the inventory.yaml file
@@ -86,14 +165,13 @@ module PuppetLitmus::InventoryManipulation
   # @param node_name [String] node to locate in the group
   # @return [Hash] config for node of name node_name
   def config_from_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['targets'].each do |node|
-        if node['uri'] == node_name
-          return node['config']
-        end
-      end
+    config = targets_in_inventory(inventory_hash) do |target|
+      next unless target['uri'].downcase == node_name.downcase
+
+      return target['config'] unless target['config'].nil?
     end
-    raise "No config was found for #{node_name}"
+
+    config.empty? ? nil : config[0]
   end
 
   # Finds a facts hash in the inventory hash by searching for a node name.
@@ -102,14 +180,13 @@ module PuppetLitmus::InventoryManipulation
   # @param node_name [String] node to locate in the group
   # @return [Hash] facts for node of name node_name
   def facts_from_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['targets'].each do |node|
-        if node['uri'] == node_name
-          return node['facts']
-        end
-      end
+    facts = targets_in_inventory(inventory_hash) do |target|
+      next unless target['uri'].downcase == node_name.downcase
+
+      target['facts'] unless target['facts'].nil?
     end
-    raise "No facts were found for #{node_name}"
+
+    facts.empty? ? nil : facts[0]
   end
 
   # Finds a var hash in the inventory hash by searching for a node name.
@@ -118,14 +195,12 @@ module PuppetLitmus::InventoryManipulation
   # @param node_name [String] node to locate in the group
   # @return [Hash] vars for node of name node_name
   def vars_from_node(inventory_hash, node_name)
-    inventory_hash['groups'].each do |group|
-      group['targets'].each do |node|
-        if node['uri'] == node_name
-          return node['vars']
-        end
-      end
+    vars = targets_in_inventory(inventory_hash) do |target|
+      next unless target['uri'].downcase == node_name.downcase
+
+      target['vars'] unless target['vars'].nil?
     end
-    {}
+    vars.empty? ? {} : vars[0]
   end
 
   # Adds a node to a group specified, if group_name exists in inventory hash.
@@ -266,4 +341,27 @@ module PuppetLitmus::InventoryManipulation
     end
     Honeycomb.current_span.add_field('litmus.platform', facts&.dig('platform'))
   end
+
+  # Add platform custom information field to the current span for each node being targeted.
+  # If more than one node is being targeted, each node will be given a separate custom field.
+  #
+  # @param span [Honeycomb::Span] The current span
+  # @param target_node_names [Array[String]] Nodes being targeted
+  # @param inventory_hash [Hash] Hash of the inventory.yaml file
+  def add_node_fields_to_span(span, target_node_names, inventory_hash)
+    node_counter = 1
+    Array(target_node_names).each do |target_name|
+      name_field     = 'litmus.node_name'
+      platform_field = 'litmus.platform'
+
+      name_field = "#{name_field}_#{node_counter}"
+      platform_field = "#{platform_field}_#{node_counter}"
+      span.add_field(name_field, target_name)
+      if target_in_inventory?(inventory_hash, target_name)
+        facts = facts_from_node(inventory_hash, target_name)
+        span.add_field(platform_field, facts&.dig('platform')) unless facts.nil?
+      end
+      node_counter += 1
+    end
+  end
 end

data/lib/puppet_litmus/puppet_helpers.rb

@@ -81,10 +81,15 @@ module PuppetLitmus::PuppetHelpers
 
       manifest_file_location = opts[:manifest_file_location] || create_manifest_file(manifest)
       inventory_hash = File.exist?('spec/fixtures/litmus_inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
 
-      span.add_field('litmus.node_name', target_node_name)
-      add_platform_field(inventory_hash, target_node_name)
+      target_option = opts['targets'] || opts[:targets]
+      if target_option.nil?
+        raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      else
+        target_node_name = search_for_target(target_option, inventory_hash)
+      end
+
+      add_node_fields_to_span(span, target_node_name, inventory_hash)
 
       # Forcibly set the locale of the command
       locale = if os[:family] != 'windows'
@@ -143,7 +148,7 @@ module PuppetLitmus::PuppetHelpers
   #
   # @param manifest [String] puppet manifest code.
   # @return [String] The path to the location of the manifest.
-  def create_manifest_file(manifest)
+  def create_manifest_file(manifest, opts = {})
     Honeycomb.start_span(name: 'litmus.create_manifest_file') do |span|
       ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.manifest', manifest)
@@ -160,8 +165,9 @@ module PuppetLitmus::PuppetHelpers
       else
         # transfer to TARGET_HOST
         inventory_hash = inventory_hash_from_inventory_file
-        span.add_field('litmus.node_name', target_node_name)
-        add_platform_field(inventory_hash, target_node_name)
+        target_option = opts['targets'] || opts[:targets]
+        target_node_name = search_for_target(target_option, inventory_hash) unless target_option.nil?
+        add_node_fields_to_span(span, target_node_name, inventory_hash)
 
         manifest_file_location = File.basename(manifest_file)
         bolt_result = upload_file(manifest_file.path, manifest_file_location, target_node_name, options: {}, config: nil, inventory: inventory_hash)
@@ -180,13 +186,16 @@ module PuppetLitmus::PuppetHelpers
   # @param content [String] String data to write to the file.
   # @param destination [String] The path on the target node to write the file.
   # @return [Bool] Success. The file was succesfully writtne on the target.
-  def write_file(content, destination)
+  def write_file(content, destination, opts = {})
     Honeycomb.start_span(name: 'litmus.write_file') do |span|
       ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       span.add_field('litmus.destination', destination)
 
       require 'tmpdir'
+      inventory_hash = inventory_hash_from_inventory_file
       target_node_name = ENV['TARGET_HOST']
+      target_option = opts['targets'] || opts[:targets]
+      target_node_name = search_for_target(target_option, inventory_hash) unless target_option.nil?
 
       Tempfile.create('litmus') do |tmp_file|
         tmp_file.write(content)
@@ -197,9 +206,7 @@ module PuppetLitmus::PuppetHelpers
           FileUtils.cp(tmp_file.path, destination)
         else
           # transfer to TARGET_HOST
-          inventory_hash = inventory_hash_from_inventory_file
-          span.add_field('litmus.node_name', target_node_name)
-          add_platform_field(inventory_hash, target_node_name)
+          add_node_fields_to_span(span, target_node_name, inventory_hash)
 
           bolt_result = upload_file(tmp_file.path, destination, target_node_name, options: {}, config: nil, inventory: inventory_hash)
           span.add_field('litmus.bolt_result.file_upload', bolt_result)
@@ -223,12 +230,17 @@ module PuppetLitmus::PuppetHelpers
       span.add_field('litmus.command_to_run', command_to_run)
       span.add_field('litmus.opts', opts)
 
-      target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
       inventory_hash = File.exist?('spec/fixtures/litmus_inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
 
-      span.add_field('litmus.node_name', target_node_name)
-      add_platform_field(inventory_hash, target_node_name)
+      target_option = opts['targets'] || opts[:targets]
+      if target_option.nil?
+        target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
+        raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      else
+        target_node_name = search_for_target(target_option, inventory_hash)
+      end
+
+      add_node_fields_to_span(span, target_node_name, inventory_hash)
 
       bolt_result = run_command(command_to_run, target_node_name, config: nil, inventory: inventory_hash)
       span.add_field('litmus.bolt_result', bolt_result)
@@ -262,12 +274,16 @@ module PuppetLitmus::PuppetHelpers
       span.add_field('litmus.opts', opts)
       span.add_field('litmus.options', options)
 
-      target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
       inventory_hash = File.exist?('spec/fixtures/litmus_inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      target_option = opts['targets'] || opts[:targets]
+      if target_option.nil?
+        target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
+        raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      else
+        target_node_name = search_for_target(target_option, inventory_hash)
+      end
 
-      span.add_field('litmus.node_name', target_node_name)
-      add_platform_field(inventory_hash, target_node_name)
+      add_node_fields_to_span(span, target_node_name, inventory_hash)
 
       bolt_result = upload_file(source, destination, target_node_name, options: options, config: nil, inventory: inventory_hash)
       span.add_field('litmus.bolt_result', bolt_result)
@@ -322,10 +338,15 @@ module PuppetLitmus::PuppetHelpers
                        else
                          localhost_inventory_hash
                        end
-      raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
 
-      span.add_field('litmus.node_name', target_node_name)
-      add_platform_field(inventory_hash, target_node_name)
+      target_option = opts['targets'] || opts[:targets]
+      if target_option.nil?
+        raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      else
+        target_node_name = search_for_target(target_option, inventory_hash)
+      end
+
+      add_node_fields_to_span(span, target_node_name, inventory_hash)
 
       bolt_result = run_task(task_name, target_node_name, params, config: config_data, inventory: inventory_hash)
       result_obj = {
@@ -383,10 +404,14 @@ module PuppetLitmus::PuppetHelpers
 
       target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
       inventory_hash = File.exist?('spec/fixtures/litmus_inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      target_option = opts['targets'] || opts[:targets]
+      if target_option.nil?
+        raise "Target '#{target_node_name}' not found in spec/fixtures/litmus_inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      else
+        target_node_name = search_for_target(target_option, inventory_hash)
+      end
 
-      span.add_field('litmus.node_name', target_node_name)
-      add_platform_field(inventory_hash, target_node_name)
+      add_node_fields_to_span(span, target_node_name, inventory_hash)
 
       bolt_result = run_script(script, target_node_name, arguments, options: opts, config: nil, inventory: inventory_hash)
 

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/inventory_manipulation_spec.rb

@@ -1,96 +1,12 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'support/inventory'
 
 RSpec.describe PuppetLitmus::InventoryManipulation do
-  context 'with config_from_node' do
-    let(:no_config_hash) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => 'test.delivery.puppetlabs.net',
-        'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' } }] },
-   { 'name' => 'winrm_nodes', 'targets' => [] }] }
-    end
-
-    let(:no_docker_hash) do
-      { 'groups' =>
-        [{ 'name' => 'ssh_nodes', 'targets' => [] },
-         { 'name' => 'winrm_nodes', 'targets' => [] }] }
-    end
-
-    let(:config_hash) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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' },
-        'vars' => { 'role' => 'agent' } }] },
-   { 'name' => 'winrm_nodes', 'targets' => [] }] }
-    end
-
-    let(:inventory_full_path) { 'spec/data/inventory.yaml' }
-
-    let(:no_feature_hash) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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', 'targets' => [] }] }
-    end
-
-    let(:feature_hash_group) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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', 'targets' => [] }] }
-    end
-
-    let(:empty_feature_hash_group) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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', 'targets' => [] }] }
-    end
-
-    let(:feature_hash_node) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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', 'targets' => [] }] }
-    end
-
-    let(:empty_feature_hash_node) do
-      { 'groups' =>
-  [{ 'name' => 'ssh_nodes',
-     'targets' =>
-     [{ 'uri' => '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', 'targets' => [] }] }
-    end
-
-    let(:foo_node) do
-      { 'uri' => 'foo',
-        'facts' => { 'provisioner' => 'bar', 'platform' => 'ubuntu' } }
-    end
+  let(:inventory_full_path) { 'spec/data/inventory.yaml' }
 
+  context 'with config_from_node' do
     it 'no matching node, raises' do
       expect { config_from_node(config_hash, 'not.here') }.to raise_error('No config was found for not.here')
     end
@@ -159,4 +75,70 @@ RSpec.describe PuppetLitmus::InventoryManipulation do
         [{ 'name' => 'ssh_nodes', 'targets' => [foo_node] }, { 'name' => 'winrm_nodes', 'targets' => [] }])
     end
   end
+
+  context 'with target searching' do
+    it 'gets correct groups names from an inventory' do
+      expect(groups_in_inventory(complex_inventory)).to eql(%w[ssh_nodes frontend winrm_nodes])
+    end
+
+    it 'applies a code block to groups' do
+      counts = groups_in_inventory(complex_inventory) do |group|
+        if group.key? 'targets'
+          group['targets'].count
+        end
+      end
+      expect(counts.sum).to be 4
+    end
+
+    it 'gets names of targets' do
+      target_list = ['test.delivery.puppetlabs.net', 'test2.delivery.puppetlabs.net', 'test3.delivery.puppetlabs.net', 'test4.delivery.puppetlabs.net']
+      expect(targets_in_inventory(complex_inventory)).to eql target_list
+    end
+
+    it 'applies a code block to targets' do
+      target_list = targets_in_inventory(complex_inventory) do |target|
+        next unless target['config']['transport'] == 'winrm'
+
+        target['uri']
+      end
+
+      expect(target_list).to eql ['test4.delivery.puppetlabs.net']
+    end
+
+    it 'returns agent nodes' do
+      node_list = nodes_with_role('agent', complex_inventory)
+      expected_node_list = ['test.delivery.puppetlabs.net', 'test3.delivery.puppetlabs.net', 'test4.delivery.puppetlabs.net']
+      expect(node_list).to eql expected_node_list
+    end
+
+    it 'returns agent nodes with different capitolization' do
+      node_list = nodes_with_role('Agent', complex_inventory)
+      expected_node_list = ['test.delivery.puppetlabs.net', 'test3.delivery.puppetlabs.net', 'test4.delivery.puppetlabs.net']
+      expect(node_list).to eql expected_node_list
+    end
+
+    it 'searches for a group' do
+      expect(search_for_target('winrm_nodes', complex_inventory)).to eql ['winrm_nodes']
+    end
+
+    it 'seaches for an array of groups' do
+      expect(search_for_target(%w[winrm_nodes ssh_nodes], complex_inventory)).to eql %w[winrm_nodes ssh_nodes]
+    end
+
+    it 'searches for a specific target' do
+      expect(search_for_target('test.delivery.puppetlabs.net', complex_inventory)).to eql ['test.delivery.puppetlabs.net']
+    end
+
+    it 'searches for an array of roles' do
+      expect(search_for_target(%w[iis nginx], complex_inventory)).to eql ['test4.delivery.puppetlabs.net', 'test3.delivery.puppetlabs.net']
+    end
+
+    it 'searches for roles as symbols' do
+      expect(search_for_target([:iis, :nginx], complex_inventory)).to eql ['test4.delivery.puppetlabs.net', 'test3.delivery.puppetlabs.net']
+    end
+
+    it 'raises an error if target not found' do
+      expect { search_for_target(:blah, complex_inventory) }.to raise_error 'targets not found in inventory'
+    end
+  end
 end

data/spec/support/inventory.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+def no_config_hash
+  { 'groups' =>
+    [
+      { 'name' => 'ssh_nodes',
+        'targets' =>
+      [{ 'uri' => 'test.delivery.puppetlabs.net',
+         'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' } }] },
+      { 'name' => 'winrm_nodes', 'targets' => [] },
+    ] }
+end
+
+def no_docker_hash
+  { 'groups' =>
+    [{ 'name' => 'ssh_nodes', 'targets' => [] },
+     { 'name' => 'winrm_nodes', 'targets' => [] }] }
+end
+
+def config_hash
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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' },
+    'vars' => { 'role' => 'agent' } }] },
+ { 'name' => 'winrm_nodes', 'targets' => [] }] }
+end
+
+def no_feature_hash
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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', 'targets' => [] }] }
+end
+
+def feature_hash_group
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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', 'targets' => [] }] }
+end
+
+def empty_feature_hash_group
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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', 'targets' => [] }] }
+end
+
+def feature_hash_node
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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', 'targets' => [] }] }
+end
+
+def empty_feature_hash_node
+  { 'groups' =>
+[{ 'name' => 'ssh_nodes',
+   'targets' =>
+ [{ 'uri' => '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', 'targets' => [] }] }
+end
+
+def foo_node
+  { 'uri' => 'foo',
+    'facts' => { 'provisioner' => 'bar', 'platform' => 'ubuntu' } }
+end
+
+def complex_inventory
+  { 'groups' =>
+    [
+      {
+        'name' => 'ssh_nodes',
+        'groups' => [
+          { 'name' => 'frontend',
+            'targets' => [
+              {
+                'uri' => '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' },
+                'vars' => { 'role' => 'agent' },
+              },
+              {
+                'uri' => 'test2.delivery.puppetlabs.net',
+                'config' => { 'transport' => 'ssh', 'ssh' => { 'user' => 'root', 'password' => 'Qu@lity!', 'host-key-check' => false } },
+                'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' },
+                'vars' => { 'role' => 'server' },
+              },
+              {
+                'uri' => 'test3.delivery.puppetlabs.net',
+                'config' => { 'transport' => 'ssh', 'ssh' => { 'user' => 'root', 'password' => 'Qu@lity!', 'host-key-check' => false } },
+                'vars' => { 'roles' => %w[agent nginx webserver] },
+              },
+            ] },
+        ],
+      },
+      {
+        'name' => 'winrm_nodes',
+        'targets' => [
+          {
+            'uri' => 'test4.delivery.puppetlabs.net',
+            'config' => { 'transport' => 'winrm', 'winrm' => { 'user' => 'admin', 'password' => 'Qu@lity!' } },
+            'facts' => { 'provisioner' => 'vmpooler', 'platform' => 'centos-5-x86_64' },
+            'vars' => { 'roles' => %w[agent iis webserver] },
+          },
+        ],
+      },
+    ] }
+end

data/spec/support/inventorytesting.yaml

@@ -0,0 +1,41 @@
+groups:
+  - name: ssh_nodes
+    groups:
+      - name: webservers
+        targets:
+          - 192.168.100.179
+          - 192.168.100.180
+          - 192.168.100.181
+      - name: memcached
+        targets:
+          - 192.168.101.50
+          - 192.168.101.60
+        config:
+          ssh:
+            user: root
+    config:
+      transport: ssh
+      ssh:
+        user: centos
+        private-key: ~/.ssh/id_rsa
+        host-key-check: false
+  - name: win_nodes
+    groups:
+      - name: domaincontrollers
+        targets:
+          - 192.168.110.10
+          - 192.168.110.20
+      - name: testservers
+        targets:
+          - 172.16.219.20
+          - 172.16.219.30
+        config:
+          winrm:
+            realm: MYDOMAIN
+            ssl: false
+    config:
+      transport: winrm
+      winrm:
+        user: DOMAIN\opsaccount
+        password: S3cretP@ssword
+        ssl: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -194,6 +194,8 @@ files:
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
 - spec/lib/puppet_litmus/util_spec.rb
 - spec/spec_helper.rb
+- spec/support/inventory.rb
+- spec/support/inventorytesting.yaml
 homepage: https://github.com/puppetlabs/puppet_litmus
 licenses:
 - Apache-2.0
@@ -220,6 +222,8 @@ summary: Providing a simple command line tool for puppet content creators, to en
   simple and complex test deployments.
 test_files:
 - spec/spec_helper.rb
+- spec/support/inventory.rb
+- spec/support/inventorytesting.yaml
 - spec/lib/puppet_litmus/rake_tasks_spec.rb
 - spec/lib/puppet_litmus/puppet_litmus_version_spec.rb
 - spec/lib/puppet_litmus/util_spec.rb