puppet_litmus 0.23.1 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d83a8c9bc28bddfab1549c27e41514cbab10e4e942b1bceadf474bb7ab2866
-  data.tar.gz: e699d388947cb532e2f52a64f3f393da291140cc68efe0f8149b5dea3d8df29b
+  metadata.gz: 33e2e2e71e771ea419d87cee723a5e5b7741f11a233ffe379953a3502776bc2d
+  data.tar.gz: 0ccdf33ad639e1391355c9c6f2769490167a4ea9e7c307cf635f193d51ea24a5
 SHA512:
-  metadata.gz: a33d9d98831af21eeadc21971fc48c1d27f50270e20c5daf267340b1d811bfcb1f3860e8fcd5181a52e58f3f28d068bb100ae18f425a60be98f54ac61b4fb063
-  data.tar.gz: ac37e3be71bf832cc286cad40299eab785c6c52ceb14a3a1bdb7952b51f775bf78b7c7b66298320e3bac081835f3e51083230c7d1cc773e3ee2ede5c7f8ceb96
+  metadata.gz: 6649698775dddc73e2f211bfbe5c69441fb10cee2a040bc2a475243e544467ceb3fdbe6b67ba07d79de11acdc8780132f7add4c06b9fbe97ddf03ff5e27e7543
+  data.tar.gz: a2697302f595adb29d8c966b96170d006111a14c618f78c40d7e62b8f96e0b2fd10512d7770752a110866847f2e7d0befab904ccea1837064b94e00f7b463073

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

@@ -35,9 +35,8 @@ DOCKER_PLATFORMS = [
 # This table uses the latest version in each collection for accurate
 # comparison when evaluating puppet requirements from the metadata
 COLLECTION_TABLE = {
-  '5.5.22' => 'puppet5',
-  '6.19.1' => 'puppet6-nightly',
-  '7.0.0' => 'puppet7-nightly',
+  '6.21.0' => 'puppet6-nightly',
+  '7.4.0' => 'puppet7-nightly',
 }.freeze
 
 matrix = {

data/exe/matrix_from_metadata_v2

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# this script creates a build matrix for github actions from the claimed supported platforms and puppet versions in metadata.json
+
+require 'json'
+
+IMAGE_TABLE = {
+  'RedHat-7' => 'rhel-7',
+  'RedHat-8' => 'rhel-8',
+  'SLES-12' => 'sles-12',
+  'SLES-15' => 'sles-15',
+  'Windows-2012 R2' => 'windows-2012-r2-core',
+  'Windows-2016' => 'windows-2016',
+  'Windows-2019' => 'windows-2019-core',
+}.freeze
+
+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',
+  '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', 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',
+}.freeze
+
+# This table uses the latest version in each collection for accurate
+# comparison when evaluating puppet requirements from the metadata
+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|
+  os = sup['operatingsystem']
+  sup['operatingsystemrelease'].sort_by { |a| a.to_i }.each do |ver|
+    image_key = "#{os}-#{ver}"
+    if IMAGE_TABLE.key? image_key
+      matrix[:platforms] << {
+        label: image_key,
+        provider: 'provision::provision_service',
+        image: IMAGE_TABLE[image_key],
+      }
+    elsif DOCKER_PLATFORMS.key? image_key
+      matrix[:platforms] << {
+        label: image_key,
+        provider: 'provision::docker',
+        image: DOCKER_PLATFORMS[image_key],
+      }
+    else
+      puts "::warning::Cannot find image for #{image_key}"
+    end
+  end
+end
+
+# Set collections based on puppet version requirements
+if metadata.key?('requirements') && metadata['requirements'].length.positive?
+  metadata['requirements'].each do |req|
+    next unless req.key?('name') && req.key?('version_requirement') && req['name'] == 'puppet'
+
+    ver_regexp = %r{^([>=<]{1,2})\s*([\d.]+)\s+([>=<]{1,2})\s*([\d.]+)$}
+    match = ver_regexp.match(req['version_requirement'])
+    if match.nil?
+      puts "::warning::Didn't recognize version_requirement '#{req['version_requirement']}'"
+      break
+    end
+
+    cmp_one, ver_one, cmp_two, ver_two = match.captures
+    reqs = ["#{cmp_one} #{ver_one}", "#{cmp_two} #{ver_two}"]
+
+    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.map { |collection| "puppet#{collection[:puppet_maj_version]}-nightly" }
+end
+
+# Just to make sure there aren't any duplicates
+matrix[:platforms] = matrix[:platforms].uniq.sort { |a, b| a[:label] <=> b[:label] }
+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 #{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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # helper functions for running puppet commands. They execute a target system specified by ENV['TARGET_HOST']
-# heavily uses functions from here https://github.com/puppetlabs/bolt/blob/master/developer-docs/bolt_spec-run.md
+# heavily uses functions from here https://github.com/puppetlabs/bolt/blob/main/developer-docs/bolt_spec-run.md
 module PuppetLitmus::PuppetHelpers
   # Applies a manifest twice. First checking for errors. Secondly to make sure no changes occur.
   #
@@ -75,7 +75,13 @@ module PuppetLitmus::PuppetHelpers
       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?

data/lib/puppet_litmus/version.rb

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

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -16,7 +16,7 @@ describe 'litmus rake tasks' do
                    'operatingsystem_support' =>
   [{ 'operatingsystem' => 'RedHat', 'operatingsystemrelease' => ['5'] },
    { 'operatingsystem' => 'Ubuntu', 'operatingsystemrelease' => ['14.04', '18.04'] }],
-                   'template-ref' => 'heads/master-0-g7827fc2' }
+                   'template-ref' => 'heads/main-0-g7827fc2' }
       expect(File).to receive(:read).with(any_args).once
       expect(JSON).to receive(:parse).with(any_args).and_return(metadata)
       expect($stdout).to receive(:puts).with('redhat-5-x86_64')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.26.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -166,12 +166,14 @@ email:
 - info@puppet.com
 executables:
 - matrix_from_metadata
+- matrix_from_metadata_v2
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
 - exe/matrix_from_metadata
+- exe/matrix_from_metadata_v2
 - lib/puppet_litmus.rb
 - lib/puppet_litmus/inventory_manipulation.rb
 - lib/puppet_litmus/puppet_helpers.rb
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable