puppet_litmus 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e321964b54828b1e0c5602fd6038e8efe1fcd0190bd9c1ada036954b66e8db
-  data.tar.gz: f5179463919201def0ff7a033f061dea91755a91c035b5fffc6222cdb8ce1359
+  metadata.gz: 484ed9be18bf1f3555b2075641bb34bfa60203bd78548564b268a3831c1b9ec4
+  data.tar.gz: a3e9ce241dec2ce34b93a2cc8cab3febf0067282b218efed62d036f12cfe6b3e
 SHA512:
-  metadata.gz: ff4f3114a21e708537908e577ce0d3361c6075d980eb1bd3bb13f680d526e0eaa2e6ecf64291864e8042e43b18e4a9df88b0098c53c3879a5d79390ffff1ddf6
-  data.tar.gz: 0a3177a69170a3687e33820f8fbe21c89b6a00fc999ad800ecf2921b2f0452e06644833df5a5a98e3f3aa51cbdcca87d3e0a8f85476d4bcf9d7dde09ce5441a2
+  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

@@ -55,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/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/version.rb

@@ -2,5 +2,5 @@
 
 # version of this gem
 module PuppetLitmus
-  VERSION ||= '0.28.0'
+  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

@@ -18,6 +18,13 @@ RSpec.describe PuppetLitmus::PuppetHelpers do
       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

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.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -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
@@ -211,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Providing a simple command line tool for puppet content creators, to enable
@@ -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