puppet_litmus 0.26.2 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b54d56fe9cd63b49874f5dad0646bb656ad791f45b751315770d09e9f69f7c9d
-  data.tar.gz: 5098a3a890f18ce448f3060323ee663834eb348b9b2000dd399e3e3678cea91f
+  metadata.gz: 484ed9be18bf1f3555b2075641bb34bfa60203bd78548564b268a3831c1b9ec4
+  data.tar.gz: a3e9ce241dec2ce34b93a2cc8cab3febf0067282b218efed62d036f12cfe6b3e
 SHA512:
-  metadata.gz: acb0fc34a9fd73f2639daada9f05a6e9d7cd47727b4b652b0da90d0249d05364f9a67dd4cfb2e3f10840b26b23aec3a867b9630d13f263ce37765d774a12c187
-  data.tar.gz: 5ca486321dc9c226042316645cb091b35ebeb9e5ea5c6859c5a605986dae4a3552b7e88405153e3ce2238c0b1a01078c22f817763b38a2b22ee661ba5a6f41c6
+  metadata.gz: 2d6f9f8df5025e677cdcdf99196b09531d7069d4002aab0b033edf57e37201c7362002b520d4c798728494f421cd35415a72e5dab91b6952dbfab42cc03cca31
+  data.tar.gz: b66435bfb8fbd219caabca73b2c594354f5e8db4415ec736122f0350d1fedbc1f35a5f3806fa334e5c2559a59fe51493281a2095e89d2eff8dc985e1028bd410

data/README.md

@@ -12,17 +12,39 @@
 Litmus is a command line tool that allows you to run acceptance tests against Puppet modules.
 
 Litmus allows you to:
-* Provision targets to test against
-* Install a Puppet agent
-* Install a module
-* Run tests
-* Tear down the infrastructure
+
+- Provision targets to test against
+
+- Install a Puppet agent
+
+- Install a module
+
+- Run tests
+
+- Tear down the infrastructure
 
 Litmus also facilitates parallel test runs and running tests in isolation. Each step is standalone, allowing other operations between test runs, such as debugging or configuration updates on the test targets.
 
-Install Litmus as a gem by running ```gem install puppet_litmus```.
+Install Litmus as a gem by running `gem install puppet_litmus`.
+
+- Note if you choose to override the `litmus_inventory.yaml` location, please ensure that the directory strutcture you define exists.
+
+## matrix_from_metadata_v2
+
+matrix_from_metadata_v2 tool generates github actions matrix from metadata.json
+
+How to use it: in the project module root directory run `bundle exec matrix_from_metadata_v2`
+
+### --exclude-platforms parameter
+
+matrix_from_metadata_v2 accepts `--exclude-platforms <JSON array>` option in order to exclude some platforms from GA matrixes.
+
+In order to use this new functionality just simply run:
+
+`$: bundle exec matrix_from_metadata_v2 --exclude-platforms '["debian-11","centos-8"]'`
 
-* Note if you choose to override the `litmus_inventory.yaml` location, please ensure that the directory strutcture you define exists.
+> Note: The option value should be JSON string otherwise it will throw an error.
+> The values provided in the json array are case-insensitive `["debian-11","centos-8"]'` or `["Debian-11","CentOS-8"]'` are treated as being the same.
 
 ## Documentation
 
@@ -30,4 +52,4 @@ For documentation, see our [Litmus Docs Site](https://puppetlabs.github.io/litmu
 
 ## Other Resources
 
-* [Is it Worth the Time?](https://xkcd.com/1205/)
+- [Is it Worth the Time?](https://xkcd.com/1205/)

data/exe/matrix_from_metadata_v2

@@ -19,9 +19,10 @@ DOCKER_PLATFORMS = {
   'CentOS-6' => 'litmusimage/centos:6',
   'CentOS-7' => 'litmusimage/centos:7',
   'CentOS-8' => 'litmusimage/centos:8',
-  'Debian-10' => 'litmusimage/debian:10',
   # 'Debian-8' => 'litmusimage/debian:8', Removing from testing: https://puppet.com/docs/pe/2021.0/supported_operating_systems.html
   'Debian-9' => 'litmusimage/debian:9',
+  'Debian-10' => 'litmusimage/debian:10',
+  'Debian-11' => 'litmusimage/debian:11',
   'OracleLinux-6' => 'litmusimage/oraclelinux:6',
   'OracleLinux-7' => 'litmusimage/oraclelinux:7',
   'Scientific-6' => 'litmusimage/scientificlinux:6',
@@ -54,26 +55,45 @@ spec_matrix = {
   include: [],
 }
 
-metadata = JSON.parse(File.read('metadata.json'))
+if ARGV.include?('--exclude-platforms')
+  exclude_platforms_occurencies = ARGV.select { |arg| arg == '--exclude-platforms' }.length
+  raise '--exclude-platforms argument should be present just one time in the command' unless exclude_platforms_occurencies <= 1
+
+  exclude_platforms_list = ARGV[ARGV.find_index('--exclude-platforms') + 1]
+  raise 'you need to provide a list of platforms in JSON format' if exclude_platforms_list.nil?
+
+  begin
+    exclude_list = JSON.parse(exclude_platforms_list).map { |platform| platform.downcase }
+  rescue JSON::ParserError
+    raise 'the exclude platforms list must valid JSON'
+  end
+else
+  exclude_list = []
+end
+
+metadata_path = ENV['TEST_MATRIX_FROM_METADATA'] || 'metadata.json'
+metadata = JSON.parse(File.read(metadata_path))
 # Set platforms based on declared operating system support
 metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
   os = sup['operatingsystem']
   sup['operatingsystemrelease'].sort_by { |a| a.to_i }.each do |ver|
     image_key = "#{os}-#{ver}"
-    if IMAGE_TABLE.key? image_key
+
+    if IMAGE_TABLE.key?(image_key) && !exclude_list.include?(image_key.downcase)
       matrix[:platforms] << {
         label: image_key,
         provider: 'provision::provision_service',
         image: IMAGE_TABLE[image_key],
       }
-    elsif DOCKER_PLATFORMS.key? image_key
+    elsif DOCKER_PLATFORMS.key?(image_key) && !exclude_list.include?(image_key.downcase)
       matrix[:platforms] << {
         label: image_key,
         provider: 'provision::docker',
         image: DOCKER_PLATFORMS[image_key],
       }
     else
-      puts "::warning::Cannot find image for #{image_key}"
+      puts "::warning::#{image_key} was excluded from testing" if exclude_list.include?(image_key.downcase)
+      puts "::warning::Cannot find image for #{image_key}" unless exclude_list.include?(image_key.downcase)
     end
   end
 end

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -6,8 +6,8 @@ module PuppetLitmus; end # rubocop:disable Style/Documentation
 module PuppetLitmus::InventoryManipulation
   # Creates an inventory hash from the inventory.yaml.
   #
-  # @param inventory_full_path [String] path to the inventory.yaml file
-  # @return [Hash] hash of the inventory.yaml file.
+  # @param inventory_full_path [String] path to the litmus_inventory.yaml file
+  # @return [Hash] hash of the litmus_inventory.yaml file.
   def inventory_hash_from_inventory_file(inventory_full_path = nil)
     require 'yaml'
     inventory_full_path = if inventory_full_path.nil?

data/lib/puppet_litmus/puppet_helpers.rb

@@ -6,13 +6,24 @@ module PuppetLitmus::PuppetHelpers
   # Applies a manifest twice. First checking for errors. Secondly to make sure no changes occur.
   #
   # @param manifest [String] puppet manifest code to be applied.
+  # @param opts [Hash] Alters the behaviour of the command. Valid options are:
+  #  :catch_changes [Boolean] (false) We're after idempotency so allow exit code 0 only.
+  #  :expect_changes [Boolean] (false) We're after changes specifically so allow exit code 2 only.
+  #  :catch_failures [Boolean] (false) We're after only complete success so allow exit codes 0 and 2 only.
+  #  :expect_failures [Boolean] (false) We're after failures specifically so allow exit codes 1, 4, and 6 only.
+  #  :manifest_file_location [Path] The place on the target system.
+  #  :hiera_config [Path] The path to the hiera.yaml configuration on the target.
+  #  :prefix_command [String] prefixes the puppet apply command; eg "export LANGUAGE='ja'".
+  #  :trace [Boolean] run puppet apply with the trace flag (defaults to `true`).
+  #  :debug [Boolean] run puppet apply with the debug flag.
+  #  :noop [Boolean] run puppet apply with the noop flag.
   # @return [Boolean] The result of the 2 apply manifests.
-  def idempotent_apply(manifest)
+  def idempotent_apply(manifest, opts = {})
     Honeycomb.start_span(name: 'litmus.idempotent_apply') do |span|
       ENV['HONEYCOMB_TRACE'] = span.to_trace_header
       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)
+      apply_manifest(nil, **opts, catch_failures: true, manifest_file_location: manifest_file_location)
+      apply_manifest(nil, **opts, catch_changes: true, manifest_file_location: manifest_file_location)
     end
   end
 

data/lib/puppet_litmus/rake_helper.rb

@@ -464,7 +464,7 @@ module PuppetLitmus::RakeHelper
 
   class LitmusTimeoutError < StandardError; end
 
-  def with_retries(options: { tries: Float::INFINITY }, max_wait_minutes: 8)
+  def with_retries(options: { tries: Float::INFINITY }, max_wait_minutes: 15)
     stop = Time.now + (max_wait_minutes * 60)
     Retryable.retryable(options.merge(not: [LitmusTimeoutError])) do
       raise LitmusTimeoutError if Time.now > stop

data/lib/puppet_litmus/rake_tasks.rb

@@ -125,7 +125,7 @@ namespace :litmus do
 
     results = install_agent(args[:collection], targets, inventory_hash)
     results.each do |result|
-      command_to_run = "bolt task run puppet_agent::install --targets #{result['target']} --inventoryfile inventory.yaml --modulepath #{DEFAULT_CONFIG_DATA['modulepath']}"
+      command_to_run = "bolt task run puppet_agent::install --targets #{result['target']} --inventoryfile spec/fixtures/litmus_inventory.yaml --modulepath #{DEFAULT_CONFIG_DATA['modulepath']}"
       raise "Failed on #{result['target']}\n#{result}\ntry running '#{command_to_run}'" if result['status'] != 'success'
 
       # validate successful install
@@ -157,7 +157,7 @@ namespace :litmus do
     end
 
     # update the inventory with the puppet-agent feature set per node
-    write_to_inventory_file(inventory_hash, 'inventory.yaml')
+    write_to_inventory_file(inventory_hash, 'spec/fixtures/litmus_inventory.yaml')
   end
 
   # Add a given feature to a selection of nodes
@@ -182,7 +182,7 @@ namespace :litmus do
       inventory_hash = add_feature_to_node(inventory_hash, args[:added_feature], target)
     end
 
-    write_to_inventory_file(inventory_hash, 'inventory.yaml')
+    write_to_inventory_file(inventory_hash, 'spec/fixtures/litmus_inventory.yaml')
 
     puts 'Feature added'
   end
@@ -336,7 +336,7 @@ namespace :litmus do
 
   namespace :acceptance do
     require 'rspec/core/rake_task'
-    if File.file?('inventory.yaml')
+    if File.file?('spec/fixtures/litmus_inventory.yaml')
       inventory_hash = inventory_hash_from_inventory_file
       targets = find_targets(inventory_hash, nil)
 

data/lib/puppet_litmus/version.rb

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

data/spec/exe/fake_metadata.json

@@ -0,0 +1,46 @@
+{
+  "name": "puppetlabs-fake_module",
+  "version": "3.1.0",
+  "author": "puppetlabs",
+  "summary": "fake_module is a test",
+  "license": "Apache-2.0",
+  "source": "it has no source",
+  "project_page": "it has no project page",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES",
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": ">= 4.0.0 < 9.0.0"
+    }
+  ],
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "6"
+      ]
+    },
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "8"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "14.04",
+        "18.04"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": ">= 6.0.0 < 8.0.0"
+    }
+  ],
+  "template-url": "https://github.com/puppetlabs/pdk-templates.git#main",
+  "template-ref": "heads/main-0-g2381db6",
+  "pdk-version": "2.1.1"
+}

data/spec/exe/matrix_from_metadata_v2_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'matrix_from_metadata_v2' do
+  context 'without arguments' do
+    let(:result) { run_matrix_from_metadata_v2 }
+
+    it 'run successfully' do
+      expect(result.status_code).to eq 0
+    end
+
+    it 'generates the matrix' do
+      expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
+      expect(result.stdout).to include(
+        [
+          '::set-output name=matrix::{',
+          '"platforms":[',
+          '{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"},',
+          '{"label":"RedHat-8","provider":"provision::provision_service","image":"rhel-8"},',
+          '{"label":"Ubuntu-18.04","provider":"provision::docker","image":"litmusimage/ubuntu:18.04"}',
+          '],',
+          '"collection":[',
+          '"puppet6-nightly","puppet7-nightly"',
+          ']',
+          '}',
+        ].join,
+      )
+      expect(result.stdout).to include(
+        '::set-output name=spec_matrix::{"include":[{"puppet_version":"~> 6.0","ruby_version":2.5},{"puppet_version":"~> 7.0","ruby_version":2.7}]}',
+      )
+      expect(result.stdout).to include("Created matrix with 8 cells:\n  - Acceptance Test Cells: 6\n  - Spec Test Cells: 2")
+    end
+  end
+
+  context 'with --exclude-platforms ["ubuntu-18.04"]' do
+    let(:result) { run_matrix_from_metadata_v2({ '--exclude-platforms' => ['ubuntu-18.04'] }) }
+
+    it 'run successfully' do
+      expect(result.status_code).to eq 0
+    end
+
+    it 'generates the matrix without excluded platforms' do
+      expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
+      expect(result.stdout).to include('::warning::Ubuntu-18.04 was excluded from testing')
+      expect(result.stdout).to include(
+        [
+          '::set-output name=matrix::{',
+          '"platforms":[',
+          '{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"},',
+          '{"label":"RedHat-8","provider":"provision::provision_service","image":"rhel-8"}',
+          '],',
+          '"collection":[',
+          '"puppet6-nightly","puppet7-nightly"',
+          ']',
+          '}',
+        ].join,
+      )
+      expect(result.stdout).to include(
+        '::set-output name=spec_matrix::{"include":[{"puppet_version":"~> 6.0","ruby_version":2.5},{"puppet_version":"~> 7.0","ruby_version":2.7}]}',
+      )
+      expect(result.stdout).to include("Created matrix with 6 cells:\n  - Acceptance Test Cells: 4\n  - Spec Test Cells: 2")
+    end
+  end
+
+  context 'with --exclude-platforms \'["ubuntu-18.04","redhat-8"]\'' do
+    let(:result) { run_matrix_from_metadata_v2({ '--exclude-platforms' => ['ubuntu-18.04', 'redhat-8'] }) }
+
+    it 'run successfully' do
+      expect(result.status_code).to eq 0
+    end
+
+    it 'generates the matrix without excluded platforms' do
+      expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
+      expect(result.stdout).to include('::warning::Ubuntu-18.04 was excluded from testing')
+      expect(result.stdout).to include('::warning::RedHat-8 was excluded from testing')
+      expect(result.stdout).to include(
+        [
+          '::set-output name=matrix::{',
+          '"platforms":[',
+          '{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"}',
+          '],',
+          '"collection":[',
+          '"puppet6-nightly","puppet7-nightly"',
+          ']',
+          '}',
+        ].join,
+      )
+      expect(result.stdout).to include(
+        '::set-output name=spec_matrix::{"include":[{"puppet_version":"~> 6.0","ruby_version":2.5},{"puppet_version":"~> 7.0","ruby_version":2.7}]}',
+      )
+      expect(result.stdout).to include("Created matrix with 4 cells:\n  - Acceptance Test Cells: 2\n  - Spec Test Cells: 2")
+    end
+  end
+end

data/spec/lib/puppet_litmus/puppet_helpers_spec.rb

@@ -14,20 +14,32 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
     it 'calls all functions' do
       expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
-      expect(self).to receive(:apply_manifest).with(nil, expect_failures: false, manifest_file_location: '/bla.pp')
+      expect(self).to receive(:apply_manifest).with(nil, catch_failures: true, manifest_file_location: '/bla.pp')
       expect(self).to receive(:apply_manifest).with(nil, catch_changes: true, manifest_file_location: '/bla.pp')
       idempotent_apply(manifest)
     end
+
+    it 'passes options to apply_manifest' do
+      expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
+      expect(self).to receive(:apply_manifest).with(nil, catch_failures: true, manifest_file_location: '/bla.pp', option: 'value')
+      expect(self).to receive(:apply_manifest).with(nil, catch_changes: true, manifest_file_location: '/bla.pp', option: 'value')
+      idempotent_apply(manifest, option: 'value')
+    end
   end
 
   describe '.apply_manifest' do
     context 'when specifying a hiera config' do
       let(:manifest) { "include '::doot'" }
       let(:result) { ['value' => { 'exit_code' => 0, 'stdout' => nil, 'stderr' => nil }] }
-      let(:command) { " puppet apply /bla.pp --trace --modulepath #{Dir.pwd}/spec/fixtures/modules --hiera_config='/hiera.yaml'" }
+      let :os do
+        {
+          family: 'redhat',
+        }
+      end
+      let(:command) { "LC_ALL=en_US.UTF-8  puppet apply /bla.pp --trace --modulepath #{Dir.pwd}/spec/fixtures/modules --hiera_config='/hiera.yaml'" }
 
       it 'passes the --hiera_config flag if the :hiera_config opt is specified' do
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
         expect(self).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -38,10 +50,15 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when using detailed-exitcodes' do
       let(:manifest) { "include '::doot'" }
       let(:result) { ['value' => { 'exit_code' => 0, 'stdout' => nil, 'stderr' => nil }] }
-      let(:command) { " puppet apply /bla.pp --trace --modulepath #{Dir.pwd}/spec/fixtures/modules --detailed-exitcodes" }
+      let(:command) { "LC_ALL=en_US.UTF-8  puppet apply /bla.pp --trace --modulepath #{Dir.pwd}/spec/fixtures/modules --detailed-exitcodes" }
+      let :os do
+        {
+          family: 'redhat',
+        }
+      end
 
       it 'uses detailed-exitcodes with expect_failures' do
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
         expect(self).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -49,7 +66,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
       end
 
       it 'uses detailed-exitcodes with catch_failures' do
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
         expect(self).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -57,7 +74,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
       end
 
       it 'uses detailed-exitcodes with expect_changes' do
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
         expect(self).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -65,7 +82,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
       end
 
       it 'uses detailed-exitcodes with catch_changes' do
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:create_manifest_file).with(manifest).and_return('/bla.pp')
         expect(self).to receive(:run_command).with(command, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -90,7 +107,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when running against localhost and no inventory.yaml file' do
       it 'does run_shell against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_command).with(command_to_run, 'litmus_localhost', config: nil, inventory: localhost_inventory_hash).and_return(result)
         expect { run_shell(command_to_run) }.not_to raise_error
@@ -100,7 +117,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when running against remote host' do
       it 'does run_shell against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_command).with(command_to_run, 'some.host', config: nil, inventory: inventory_hash).and_return(result)
@@ -125,7 +142,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when upload returns success' do
       it 'does upload_file against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_success)
@@ -134,7 +151,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
       it 'does upload_file against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).not_to receive(:inventory_hash_from_inventory_file)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:upload_file).with(local, remote, 'litmus_localhost', options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result_success)
@@ -145,7 +162,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when upload returns failure' do
       it 'does upload_file gives runtime error for failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
@@ -154,7 +171,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:upload_file).with(local, remote, 'some.host', options: {}, config: nil, inventory: inventory_hash).and_return(result_failure)
@@ -176,7 +193,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when running against localhost and no inventory.yaml file' do
       it 'does bolt_run_script against localhost without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).not_to receive(:inventory_hash_from_inventory_file)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_script).with(script, 'litmus_localhost', [], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -187,7 +204,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when running against remote host' do
       it 'does bolt_run_script against remote host without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_script).with(script, 'some.host', [], options: {}, config: nil, inventory: inventory_hash).and_return(result)
@@ -198,7 +215,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when running with arguments' do
       it 'does bolt_run_script with arguments without error' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'localhost'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(false)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(false)
         expect(self).not_to receive(:inventory_hash_from_inventory_file)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_script).with(script, 'litmus_localhost', ['doot'], options: {}, config: nil, inventory: localhost_inventory_hash).and_return(result)
@@ -225,7 +242,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when bolt returns success' do
       it 'does bolt_task_run gives no runtime error for success' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
@@ -243,7 +260,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
       it 'returns stdout for unstructured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_unstructured_task_success)
@@ -253,7 +270,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
       it 'returns structured output for structured-data tasks' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_structured_task_success)
@@ -267,7 +284,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
     context 'when bolt returns failure' do
       it 'does bolt_task_run gives runtime error for failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)
@@ -276,7 +293,7 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
 
       it 'returns the exit code and error message when expecting failure' do
         stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
-        expect(File).to receive(:exist?).with('inventory.yaml').and_return(true)
+        expect(File).to receive(:exist?).with('spec/fixtures/litmus_inventory.yaml').and_return(true)
         expect(self).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
         expect(self).to receive(:target_in_inventory?).and_return(true)
         expect(self).to receive(:run_task).with(task_name, 'some.host', params, config: config_data, inventory: inventory_hash).and_return(result_failure)

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rspec'
+require 'open3'
+require 'ostruct'
 
 if ENV['COVERAGE'] == 'yes'
   require 'simplecov'
@@ -32,6 +34,17 @@ if ENV['COVERAGE'] == 'yes'
   end
 end
 
+def run_matrix_from_metadata_v2(options = {})
+  command = 'bundle exec ./exe/matrix_from_metadata_v2'
+  command += " --exclude-platforms '#{options['--exclude-platforms']}'" unless options['--exclude-platforms'].nil?
+  result = Open3.capture3({ 'TEST_MATRIX_FROM_METADATA' => 'spec/exe/fake_metadata.json' }, command)
+  OpenStruct.new(
+    stdout: result[0],
+    stderr: result[1],
+    status_code: result[2],
+  )
+end
+
 # This is basically how `configure!` sets up RSpec in tests.
 require 'puppet_litmus'
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.29.0
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -19,7 +19,7 @@ dependencies:
         version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,8 @@ files:
 - spec/data/doot.tar.gz
 - spec/data/inventory.yaml
 - spec/data/jim.yaml
+- spec/exe/fake_metadata.json
+- spec/exe/matrix_from_metadata_v2_spec.rb
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/puppet_helpers_spec.rb
 - spec/lib/puppet_litmus/puppet_litmus_version_spec.rb
@@ -196,7 +198,7 @@ homepage: https://github.com/puppetlabs/puppet_litmus
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -211,8 +213,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
   simple and complex test deployments.
@@ -224,6 +226,8 @@ test_files:
 - spec/lib/puppet_litmus/inventory_manipulation_spec.rb
 - spec/lib/puppet_litmus/rake_helper_spec.rb
 - spec/lib/puppet_litmus/puppet_helpers_spec.rb
+- spec/exe/fake_metadata.json
+- spec/exe/matrix_from_metadata_v2_spec.rb
 - spec/data/doot.tar.gz
 - spec/data/jim.yaml
 - spec/data/inventory.yaml