puppet_litmus 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f42320bf296d7e6efb9370a3e39b775a868417f9dc337aa7c5dee5052b055c6f
-  data.tar.gz: 607ab4fe445eb6f8b29d758212e84065b3e15b0273af85debec7676ea70c9115
+  metadata.gz: ec6aae4d826162090c6d1d7b05df110263b1d77b77879e72623529912a0948fb
+  data.tar.gz: b1d98ca5cad46e027ab1a0c15fdb37ae3e49b8dc70ddf423f2f34ec05e784e7b
 SHA512:
-  metadata.gz: 6abadc5c20561dd3f0db0b0bfcd96b55ba0df2e2fdfa97576fb48caabe538287ccb86750264fe10c0831b23e20f89d34946d4df2dd3cdf2e1e0adccb7d3f6538
-  data.tar.gz: f500ac82345c2c05abddf4e50d8c3492e37ef711b5c20a14fcda8d16ad6d5cecb13b64b43d343bd9e11eba242d80ef9584fa73f60fb36329c1b078d3c72f86bd
+  metadata.gz: 33254eeeb62d7be13711ee6941a666141715a07f7f3ecf37fb9dc3983403345b6880f4ff060b37b16b83ef7e5ab173982d4323be82af6aa720e59b7fe037f29c
+  data.tar.gz: a06db9fc523e6c6a586ff852cb60769313eb0dfb4be435f24f24038fda950fa87536b8f51248f8d7f36ed431189242f4d57f8dfdf8793d4c0f28d56244b7027a

data/README.md

@@ -27,25 +27,36 @@ Litmus also facilitates parallel test runs and running tests in isolation. Each
 
 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.
+- Note if you choose to override the `litmus_inventory.yaml` location, please ensure that the directory structure you define exists.
 
 ## matrix_from_metadata_v2
 
-matrix_from_metadata_v2 tool generates github actions matrix from metadata.json
+matrix_from_metadata_v2 tool generates a github action matrix from the supported operating systems listed in the module's metadata.json.
 
-How to use it: in the project module root directory run `bundle exec matrix_from_metadata_v2`
+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.
+matrix_from_metadata_v2 accepts the `--exclude-platforms <JSON array>` argument in order to exclude some platforms from the matrix.
 
-In order to use this new functionality just simply run:
+For example:
 
 `$: bundle exec matrix_from_metadata_v2 --exclude-platforms '["debian-11","centos-8"]'`
 
 > 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.
 
+### --custom-matrix parameter
+
+matrix_from_metadata_v2 accepts the `--custom-matrix /path/to/matrix.json` argument in order to execute your test suite against a custom matrix. This is useful for use cases that do not fit the default matrix generated.
+
+In order to use this new functionality, run:
+
+`$: bundle exec matrix_from_metadata_v2 --custom-matrix matrix.json`
+
+> Note: The file should contain a valid Array of JSON Objects (i.e. `[{"label":"AlmaLinux-8","provider":"provision_service","image":"almalinux-cloud/almalinux-8"}, {..}]`), otherwise it will throw an error.
+
 ## Documentation
 
 For documentation, see our [Litmus Docs Site](https://puppetlabs.github.io/content-and-tooling-team/docs/litmus/).

data/exe/matrix_from_metadata_v2

@@ -94,29 +94,79 @@ else
   exclude_list = []
 end
 
+# Force the use of the provision_service provisioner, if the --provision-service argument is present
+if ARGV.include?('--provision-service')
+  provision_service_occurrences = ARGV.count { |arg| arg == '--provision-service' }
+  raise 'the --provision-service argument should be present just one time in the command' unless provision_service_occurrences <= 1
+
+  # NOTE: that the below are the only available images for the provision service
+  updated_platforms = {
+    'AlmaLinux-8' => 'almalinux-cloud/almalinux-8',
+    'CentOS-7' => 'centos-7',
+    'CentOS-8' => 'centos-stream-8',
+    'Rocky-8' => 'rocky-linux-cloud/rocky-linux-8',
+    'Debian-10' => 'debian-10',
+    'Debian-11' => 'debian-11',
+    'Ubuntu-20.04' => 'ubuntu-2004-lts',
+    'Ubuntu-22.04' => 'ubuntu-2204-lts'
+  }
+
+  updated_list = IMAGE_TABLE.dup.clone
+  updated_list.merge!(updated_platforms)
+
+  IMAGE_TABLE = updated_list.freeze
+  DOCKER_PLATFORMS = {}.freeze
+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(&:to_i).each do |ver|
-    image_key = "#{os}-#{ver}"
-
-    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) && !exclude_list.include?(image_key.downcase)
-      matrix[:platforms] << {
-        label: image_key,
-        provider: 'provision::docker',
-        image: DOCKER_PLATFORMS[image_key]
-      }
+
+# Allow the user to pass a file containing a custom matrix
+if ARGV.include?('--custom-matrix')
+  custom_matrix_occurrences = ARGV.count { |arg| arg == '--custom-matrix' }
+  raise '--custom-matrix argument should be present just one time in the command' unless custom_matrix_occurrences <= 1
+
+  file_path = ARGV[ARGV.find_index('--custom-matrix') + 1]
+  raise 'no file path specified' if file_path.nil?
+
+  begin
+    custom_matrix = JSON.parse(File.read(file_path))
+  rescue StandardError => e
+    case e
+    when JSON::ParserError
+      raise 'the matrix must be an array of valid JSON objects'
+    when Errno::ENOENT
+      raise "File not found: #{e.message}"
     else
-      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)
+      raise "An unknown exception occurred: #{e.message}"
+    end
+  end
+  custom_matrix.each do |platform|
+    matrix[:platforms] << platform
+  end
+else
+  # 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(&:to_i).each do |ver|
+      image_key = "#{os}-#{ver}"
+
+      if IMAGE_TABLE.key?(image_key) && !exclude_list.include?(image_key.downcase)
+        matrix[:platforms] << {
+          label: image_key,
+          provider: 'provision_service',
+          image: IMAGE_TABLE[image_key]
+        }
+      elsif DOCKER_PLATFORMS.key?(image_key) && !exclude_list.include?(image_key.downcase)
+        matrix[:platforms] << {
+          label: image_key,
+          provider: 'docker',
+          image: DOCKER_PLATFORMS[image_key]
+        }
+      else
+        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
 end
@@ -155,9 +205,8 @@ end
 
 # Set to defaults (all collections) if no matches are found
 matrix[:collection] = COLLECTION_TABLE.map { |collection| "puppet#{collection[:puppet_maj_version]}-nightly" } if matrix[:collection].empty?
-
 # Just to make sure there aren't any duplicates
-matrix[:platforms] = matrix[:platforms].uniq.sort_by { |a| a[:label] }
+matrix[:platforms] = matrix[:platforms].uniq.sort_by { |a| a[:label] } unless ARGV.include?('--custom-matrix')
 matrix[:collection] = matrix[:collection].uniq.sort
 
 set_output('matrix', JSON.generate(matrix))

data/lib/puppet_litmus/rake_helper.rb

@@ -98,7 +98,8 @@ module PuppetLitmus::RakeHelper
 
     results = {}
     targets.each do |node_name|
-      next if node_name == 'litmus_localhost'
+      #  next if local host or provisioner fact empty/not set (GH-421)
+      next if node_name == 'litmus_localhost' || facts_from_node(inventory_hash, node_name)['provisioner'].nil?
 
       result = tear_down(node_name, inventory_hash)
       # Some provisioners tear_down targets that were created as a batch job.
@@ -287,7 +288,7 @@ module PuppetLitmus::RakeHelper
     if SUPPORTED_PROVISIONERS.include?(provisioner)
       "provision::#{provisioner}"
     else
-      warn "WARNING: Unsuported provisioner '#{provisioner}', try #{SUPPORTED_PROVISIONERS.join('/')}"
+      warn "WARNING: Unsupported provisioner '#{provisioner}', try #{SUPPORTED_PROVISIONERS.join('/')}"
       provisioner.to_s
     end
   end
@@ -327,7 +328,7 @@ module PuppetLitmus::RakeHelper
   end
 
   def start_spinner(message)
-    if (ENV['CI'] || '').casecmp('true').zero?
+    if (ENV['CI'] || '').casecmp('true').zero? || Gem.win_platform?
       puts message
       spinner = Thread.new do
         # CI systems are strange beasts, we only output a '.' every wee while to keep the terminal alive.
@@ -345,7 +346,7 @@ module PuppetLitmus::RakeHelper
   end
 
   def stop_spinner(spinner)
-    if (ENV['CI'] || '').casecmp('true').zero?
+    if (ENV['CI'] || '').casecmp('true').zero? || Gem.win_platform?
       Thread.kill(spinner)
     else
       spinner.success

data/lib/puppet_litmus/version.rb

@@ -2,5 +2,5 @@
 
 # version of this gem
 module PuppetLitmus
-  VERSION = '1.0.3'
+  VERSION = '1.1.1'
 end

data/spec/exe/matrix_from_metadata_v2_spec.rb

@@ -22,9 +22,9 @@ RSpec.describe 'matrix_from_metadata_v2' do
         [
           '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"}',
+          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
+          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
+          '{"label":"Ubuntu-18.04","provider":"docker","image":"litmusimage/ubuntu:18.04"}',
           '],',
           '"collection":[',
           '"puppet7-nightly","puppet8-nightly"',
@@ -59,8 +59,8 @@ RSpec.describe 'matrix_from_metadata_v2' do
         [
           'matrix={',
           '"platforms":[',
-          '{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"},',
-          '{"label":"RedHat-8","provider":"provision::provision_service","image":"rhel-8"}',
+          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
+          '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"}',
           '],',
           '"collection":[',
           '"puppet7-nightly","puppet8-nightly"',
@@ -96,7 +96,7 @@ RSpec.describe 'matrix_from_metadata_v2' do
         [
           'matrix={',
           '"platforms":[',
-          '{"label":"CentOS-6","provider":"provision::docker","image":"litmusimage/centos:6"}',
+          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"}',
           '],',
           '"collection":[',
           '"puppet7-nightly","puppet8-nightly"',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt