puppet_litmus 0.25.0 → 0.26.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30427123e4564bc48f1ab51d5ba1a309d51a92cfaa960ca879cf0bc9646b811
-  data.tar.gz: 0c84f4661ece76aa2c69e375c7c82b0a2c8eef4d9b644edd6e50c516e3eb2b5b
+  metadata.gz: f98913f0f6a0c9ad4060437f3d79da268611da67a03a147f79ae84ebc39f0626
+  data.tar.gz: 8f6f10a27f7151c7d1b6f1428f8b0b9c2976a5c63ecbc6586ee58e047f695c68
 SHA512:
-  metadata.gz: b188680048a9f7c9aa78f579555cf2ce892b74a9dbf03d7463a6f12f097b17db4dcde1fb0173c1037e1817a9cc423cf948c2888c18cf141499dd57adcc9607bf
-  data.tar.gz: bd2df6cd288d01181384eb9ecd943b3f508d8c5262062acb4cbe88c1b694c578e435769fc067cbaea0032c3e224f9b8193485cab34f3aaa75e91d8dfed9d31ea
+  metadata.gz: aef4defe588e0e2abc252ce3110fa6dea31d25dd9977809a28029eb0856e9348a134a69058089078b254b27865372ce740d5903ccbf0151fe6b8769d8e503d24
+  data.tar.gz: 75da654699d7820473e840ab65e998387c89ab76cf935ede3835f4fdda280669dd01af29f8de098308655ace037b1807a4ec53771e969102c97ba1965b32b11e

data/README.md

@@ -22,6 +22,8 @@ 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.
+
 ## Documentation
 
 For documentation, see our [Litmus Docs Site](https://puppetlabs.github.io/litmus/).

data/exe/matrix_from_metadata_v2

@@ -20,13 +20,13 @@ DOCKER_PLATFORMS = {
   'CentOS-7' => 'litmusimage/centos:7',
   'CentOS-8' => 'litmusimage/centos:8',
   'Debian-10' => 'litmusimage/debian:10',
-  'Debian-8' => 'litmusimage/debian:8',
+  # 'Debian-8' => 'litmusimage/debian:8', Removing from testing: https://puppet.com/docs/pe/2021.0/supported_operating_systems.html
   'Debian-9' => 'litmusimage/debian:9',
   'OracleLinux-6' => 'litmusimage/oraclelinux:6',
   'OracleLinux-7' => 'litmusimage/oraclelinux:7',
   'Scientific-6' => 'litmusimage/scientificlinux:6',
   'Scientific-7' => 'litmusimage/scientificlinux:7',
-  'Ubuntu-14.04' => 'litmusimage/ubuntu:14.04',
+  # 'Ubuntu-14.04' => 'litmusimage/ubuntu:14.04', Removing from testing: https://puppet.com/docs/pe/2021.0/supported_operating_systems.html
   'Ubuntu-16.04' => 'litmusimage/ubuntu:16.04',
   'Ubuntu-18.04' => 'litmusimage/ubuntu:18.04',
   'Ubuntu-20.04' => 'litmusimage/ubuntu:20.04',
@@ -34,16 +34,26 @@ DOCKER_PLATFORMS = {
 
 # This table uses the latest version in each collection for accurate
 # comparison when evaluating puppet requirements from the metadata
-COLLECTION_TABLE = {
-  '6.24.0' => 'puppet6-nightly',
-  '7.4.0' => 'puppet7-nightly',
-}.freeze
+COLLECTION_TABLE = [
+  {
+    puppet_maj_version: 6,
+    ruby_version: 2.5,
+  },
+  {
+    puppet_maj_version: 7,
+    ruby_version: 2.7,
+  },
+].freeze
 
 matrix = {
   platforms: [],
   collection: [],
 }
 
+spec_matrix = {
+  include: [],
+}
+
 metadata = JSON.parse(File.read('metadata.json'))
 # Set platforms based on declared operating system support
 metadata['operatingsystem_support'].sort_by { |a| a['operatingsystem'] }.each do |sup|
@@ -83,17 +93,20 @@ if metadata.key?('requirements') && metadata['requirements'].length.positive?
     cmp_one, ver_one, cmp_two, ver_two = match.captures
     reqs = ["#{cmp_one} #{ver_one}", "#{cmp_two} #{ver_two}"]
 
-    COLLECTION_TABLE.each do |key, val|
-      if Gem::Requirement.create(reqs).satisfied_by?(Gem::Version.new(key))
-        matrix[:collection] << val
-      end
+    COLLECTION_TABLE.each do |collection|
+      # Test against the "largest" puppet version in a collection, e.g. `7.9999` to allow puppet requirements with a non-zero lower bound on minor/patch versions.
+      # This assumes that such a boundary will always allow the latest actually existing puppet version of a release stream, trading off simplicity vs accuracy here.
+      next unless Gem::Requirement.create(reqs).satisfied_by?(Gem::Version.new("#{collection[:puppet_maj_version]}.9999"))
+
+      matrix[:collection] << "puppet#{collection[:puppet_maj_version]}-nightly"
+      spec_matrix[:include] << { puppet_version: "~> #{collection[:puppet_maj_version]}.0", ruby_version: collection[:ruby_version] }
     end
   end
 end
 
 # Set to defaults (all collections) if no matches are found
 if matrix[:collection].empty?
-  matrix[:collection] = COLLECTION_TABLE.values
+  matrix[:collection] = COLLECTION_TABLE.map { |collection| "puppet#{collection[:puppet_maj_version]}-nightly" }
 end
 
 # Just to make sure there aren't any duplicates
@@ -101,5 +114,11 @@ matrix[:platforms] = matrix[:platforms].uniq.sort { |a, b| a[:label] <=> b[:labe
 matrix[:collection] = matrix[:collection].uniq.sort
 
 puts "::set-output name=matrix::#{JSON.generate(matrix)}"
+puts "::set-output name=spec_matrix::#{JSON.generate(spec_matrix)}"
+
+acceptance_test_cell_count = matrix[:platforms].length * matrix[:collection].length
+spec_test_cell_count = spec_matrix[:include].length
 
-puts "Created matrix with #{matrix[:platforms].length * matrix[:collection].length} cells."
+puts "Created matrix with #{acceptance_test_cell_count + spec_test_cell_count} cells:"
+puts "  - Acceptance Test Cells: #{acceptance_test_cell_count}"
+puts "  - Spec Test Cells: #{spec_test_cell_count}"

data/lib/puppet_litmus/inventory_manipulation.rb

@@ -11,7 +11,7 @@ module PuppetLitmus::InventoryManipulation
   def inventory_hash_from_inventory_file(inventory_full_path = nil)
     require 'yaml'
     inventory_full_path = if inventory_full_path.nil?
-                            'inventory.yaml'
+                            "#{Dir.pwd}/spec/fixtures/litmus_inventory.yaml"
                           else
                             inventory_full_path
                           end

data/lib/puppet_litmus/puppet_helpers.rb

@@ -69,13 +69,19 @@ module PuppetLitmus::PuppetHelpers
       end
 
       manifest_file_location = opts[:manifest_file_location] || create_manifest_file(manifest)
-      inventory_hash = File.exist?('inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      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)
 
-      command_to_run = "#{opts[:prefix_command]} puppet apply #{manifest_file_location}"
+      # Forcibly set the locale of the command
+      locale = if os[:family] != 'windows'
+                 'LC_ALL=en_US.UTF-8 '
+               else
+                 ''
+               end
+      command_to_run = "#{locale}#{opts[:prefix_command]} puppet apply #{manifest_file_location}"
       command_to_run += ' --trace' if !opts[:trace].nil? && (opts[:trace] == true)
       command_to_run += " --modulepath #{Dir.pwd}/spec/fixtures/modules" if target_node_name == 'litmus_localhost'
       command_to_run += " --hiera_config='#{opts[:hiera_config]}'" unless opts[:hiera_config].nil?
@@ -207,8 +213,8 @@ module PuppetLitmus::PuppetHelpers
       span.add_field('litmus.opts', opts)
 
       target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
-      inventory_hash = File.exist?('inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      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)
@@ -246,8 +252,8 @@ module PuppetLitmus::PuppetHelpers
       span.add_field('litmus.options', options)
 
       target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
-      inventory_hash = File.exist?('inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      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)
@@ -300,12 +306,12 @@ module PuppetLitmus::PuppetHelpers
       target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
       inventory_hash = if !opts[:inventory_file].nil? && File.exist?(opts[:inventory_file])
                          inventory_hash_from_inventory_file(opts[:inventory_file])
-                       elsif File.exist?('inventory.yaml')
-                         inventory_hash_from_inventory_file('inventory.yaml')
+                       elsif File.exist?('spec/fixtures/litmus_inventory.yaml')
+                         inventory_hash_from_inventory_file('spec/fixtures/litmus_inventory.yaml')
                        else
                          localhost_inventory_hash
                        end
-      raise "Target '#{target_node_name}' not found in inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      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)
@@ -365,8 +371,8 @@ module PuppetLitmus::PuppetHelpers
       span.add_field('litmus.arguments', arguments)
 
       target_node_name = targeting_localhost? ? 'litmus_localhost' : ENV['TARGET_HOST']
-      inventory_hash = File.exist?('inventory.yaml') ? inventory_hash_from_inventory_file : localhost_inventory_hash
-      raise "Target '#{target_node_name}' not found in inventory.yaml" unless target_in_inventory?(inventory_hash, target_node_name)
+      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)

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.25.0'
+  VERSION ||= '0.26.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable