puppet_litmus 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ccf17917e989f2e0396f8b0611dd22cdf714b1e72db8be39e44b796e29e6044
-  data.tar.gz: fffb9cd11af3950794c48b23767e4990a278d4c9f2584497d432157b7c1cc031
+  metadata.gz: 8b28ee9fd69e25bb7644899b004f8c188940bf2f8df398cbff9f849813e3b0b7
+  data.tar.gz: d6da95723ccd59175d110b07d6a2244733f1e85e26ed4d075fb8ada7c7e4888f
 SHA512:
-  metadata.gz: 11a2e60e31f2e4d830a1bb12ca1a872e184244852514913636edbc599489e8f5d3c94feb8c98d2166358ebba18a04e76daa4cefefda52c21cecc9306d6f18c1c
-  data.tar.gz: 455dfdd8692055f23f79c916c0968cfd2a16d7ce7d13ea1c74b5ce8b8b83fa25ae346c4928b1fdb355cca1cdb18790beab89b57302d9f6b7f64c42bf4165c6fa
+  metadata.gz: d34ca11e5202fb7fd3f365c7c2fcf975404f71e8581e9d46b550241132d3f90d40801d2db576041cd64ac64d2a95cbb4406b9ca9db910a5197159e594f0ae7fb
+  data.tar.gz: 5734185bbf729d032023d99bd25630fbe1d16e1c77e5c9875a6ca5d53ca9dd518a7f07616c8a48efe908191a1775ee1b730ef6f9eb7594826dd3ae622de5be7c

data/exe/matrix_from_metadata

@@ -37,7 +37,6 @@ IMAGE_TABLE = {
 }.freeze
 
 DOCKER_PLATFORMS = [
-  'CentOS-6',
   'CentOS-7',
   'CentOS-8',
   'Debian-10',

data/exe/matrix_from_metadata_v2

@@ -41,22 +41,22 @@ ARM_IMAGE_TABLE = {
 }.freeze
 
 DOCKER_PLATFORMS = {
-  'CentOS-6' => 'litmusimage/centos:6',
+  'AmazonLinux-2' => 'litmusimage/amazonlinux:2',
+  'AmazonLinux-2023' => 'litmusimage/amazonlinux:2023',
   'CentOS-7' => 'litmusimage/centos:7',
   'CentOS-8' => 'litmusimage/centos:stream8', # Support officaly moved to Stream8, metadata is being left as is
+  'CentOS-9' => 'litmusimage/centos:stream9',
   'Rocky-8' => 'litmusimage/rockylinux:8',
+  'Rocky-9' => 'litmusimage/rockylinux:9',
   'AlmaLinux-8' => 'litmusimage/almalinux: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',
+  'AlmaLinux-9' => 'litmusimage/almalinux:9',
   'Debian-10' => 'litmusimage/debian:10',
   'Debian-11' => 'litmusimage/debian:11',
   'Debian-12' => 'litmusimage/debian:12',
-  'OracleLinux-6' => 'litmusimage/oraclelinux:6',
   'OracleLinux-7' => 'litmusimage/oraclelinux:7',
-  'Scientific-6' => 'litmusimage/scientificlinux:6',
+  'OracleLinux-8' => 'litmusimage/oraclelinux:8',
+  'OracleLinux-9' => 'litmusimage/oraclelinux:9',
   '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', Support Dropped
   'Ubuntu-18.04' => 'litmusimage/ubuntu:18.04',
   'Ubuntu-20.04' => 'litmusimage/ubuntu:20.04',
   'Ubuntu-22.04' => 'litmusimage/ubuntu:22.04'

data/lib/puppet_litmus/rake_tasks.rb

@@ -210,9 +210,9 @@ namespace :litmus do
     # module_tar = Dir.glob('pkg/*.tar.gz').max_by { |f| File.mtime(f) }
     raise "Unable to find package in 'pkg/*.tar.gz'" if module_tar.nil?
 
-    install_module(inventory_hash, args[:target_node_name], module_tar, args[:module_repository])
+    install_module(inventory_hash, target_nodes, module_tar, args[:module_repository])
 
-    puts "Installed '#{module_tar}' on #{args[:target_node_name]}"
+    puts "Installed '#{module_tar}' on #{target_nodes.join(', ')}"
   end
 
   # Install the puppet modules from a source directory to nodes. It does not install dependencies.
@@ -241,10 +241,8 @@ namespace :litmus do
     include BoltSpec::Run
     module_tars.each do |module_tar|
       puts "Installing '#{module_tar}'"
-      target_nodes.each do |target_node_name|
-        install_module(inventory_hash, target_node_name, module_tar, args[:module_repository], args[:ignore_dependencies])
-        puts "Installed '#{module_tar}' on #{target_node_name}"
-      end
+      install_module(inventory_hash, target_nodes, module_tar, args[:module_repository], args[:ignore_dependencies])
+      puts "Installed '#{module_tar}' on #{target_nodes.join(', ')}"
     end
   end
 

data/lib/puppet_litmus/spec_helper_acceptance.rb

@@ -26,7 +26,7 @@ module PuppetLitmus
 
       if target_in_group(inventory_hash, ENV.fetch('TARGET_HOST', nil), 'docker_nodes')
         host = ENV.fetch('TARGET_HOST', nil)
-        set :backend, :docker
+        set :backend, :dockercli
         set :docker_container, host
       elsif target_in_group(inventory_hash, ENV.fetch('TARGET_HOST', nil), 'ssh_nodes')
         set :backend, :ssh

data/lib/puppet_litmus/version.rb

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

data/spec/exe/fake_metadata.json

@@ -14,6 +14,13 @@
     }
   ],
   "operatingsystem_support": [
+    {
+      "operatingsystem": "AmazonLinux",
+      "operatingsystemrelease": [
+        "2",
+        "2023"
+      ]
+    },
     {
       "operatingsystem": "CentOS",
       "operatingsystemrelease": [

data/spec/exe/matrix_from_metadata_v2_spec.rb

@@ -17,12 +17,14 @@ RSpec.describe 'matrix_from_metadata_v2' do
     end
 
     it 'generates the matrix' do # rubocop:disable RSpec/ExampleLength
+      expect(result.stdout).to include('::warning::Cannot find image for CentOS-6')
       expect(result.stdout).to include('::warning::Cannot find image for Ubuntu-14.04')
       expect(github_output_content).to include(
         [
           'matrix={',
           '"platforms":[',
-          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
+          '{"label":"AmazonLinux-2","provider":"docker","image":"litmusimage/amazonlinux:2"},',
+          '{"label":"AmazonLinux-2023","provider":"docker","image":"litmusimage/amazonlinux:2023"},',
           '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
           '{"label":"RedHat-9","provider":"provision_service","image":"rhel-9"},',
           '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"},',
@@ -39,7 +41,7 @@ RSpec.describe 'matrix_from_metadata_v2' do
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 7.24","ruby_version":2.7},{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
       )
-      expect(result.stdout).to include("Created matrix with 16 cells:\n  - Acceptance Test Cells: 14\n  - Spec Test Cells: 2")
+      expect(result.stdout).to include("Created matrix with 18 cells:\n  - Acceptance Test Cells: 16\n  - Spec Test Cells: 2")
     end
   end
 
@@ -57,13 +59,15 @@ RSpec.describe 'matrix_from_metadata_v2' do
     end
 
     it 'generates the matrix without excluded platforms' do # rubocop:disable RSpec/ExampleLength
+      expect(result.stdout).to include('::warning::Cannot find image for CentOS-6')
       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(github_output_content).to include(
         [
           'matrix={',
           '"platforms":[',
-          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
+          '{"label":"AmazonLinux-2","provider":"docker","image":"litmusimage/amazonlinux:2"},',
+          '{"label":"AmazonLinux-2023","provider":"docker","image":"litmusimage/amazonlinux:2023"},',
           '{"label":"RedHat-8","provider":"provision_service","image":"rhel-8"},',
           '{"label":"RedHat-9","provider":"provision_service","image":"rhel-9"},',
           '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"},',
@@ -79,14 +83,14 @@ RSpec.describe 'matrix_from_metadata_v2' do
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 7.24","ruby_version":2.7},{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
       )
-      expect(result.stdout).to include("Created matrix with 14 cells:\n  - Acceptance Test Cells: 12\n  - Spec Test Cells: 2")
+      expect(result.stdout).to include("Created matrix with 16 cells:\n  - Acceptance Test Cells: 14\n  - Spec Test Cells: 2")
     end
   end
 
   context 'with --exclude-platforms \'["ubuntu-18.04","redhat-8"]\'' do
     let(:github_output) { Tempfile.new('github_output') }
     let(:github_output_content) { github_output.read }
-    let(:result) { run_matrix_from_metadata_v2({ '--exclude-platforms' => ['ubuntu-18.04', 'ubuntu-22.04', 'redhat-8', 'redhat-9'] }) }
+    let(:result) { run_matrix_from_metadata_v2({ '--exclude-platforms' => ['amazonlinux-2', 'amazonlinux-2023', 'ubuntu-18.04', 'ubuntu-22.04', 'redhat-8', 'redhat-9'] }) }
 
     before do
       ENV['GITHUB_OUTPUT'] = github_output.path
@@ -98,6 +102,7 @@ RSpec.describe 'matrix_from_metadata_v2' do
 
     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::Cannot find image for CentOS-6')
       expect(result.stdout).to include('::warning::Ubuntu-18.04 was excluded from testing')
       expect(result.stdout).to include('::warning::Ubuntu-22.04 was excluded from testing')
       expect(result.stdout).to include('::warning::RedHat-8 was excluded from testing')
@@ -105,7 +110,6 @@ RSpec.describe 'matrix_from_metadata_v2' do
         [
           'matrix={',
           '"platforms":[',
-          '{"label":"CentOS-6","provider":"docker","image":"litmusimage/centos:6"},',
           '{"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64"},',
           '{"label":"Ubuntu-22.04-arm","provider":"provision_service","image":"ubuntu-2204-lts-arm64"}',
           '],',
@@ -118,7 +122,7 @@ RSpec.describe 'matrix_from_metadata_v2' do
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 7.24","ruby_version":2.7},{"puppet_version":"~> 8.0","ruby_version":3.2}]}'
       )
-      expect(result.stdout).to include("Created matrix with 8 cells:\n  - Acceptance Test Cells: 6\n  - Spec Test Cells: 2")
+      expect(result.stdout).to include("Created matrix with 6 cells:\n  - Acceptance Test Cells: 4\n  - Spec Test Cells: 2")
     end
   end
 end

data/spec/lib/puppet_litmus/rake_tasks_spec.rb

@@ -22,10 +22,60 @@ describe 'litmus rake tasks' do
       expect($stdout).to receive(:puts).with('redhat-5-x86_64')
       expect($stdout).to receive(:puts).with('ubuntu-1404-x86_64')
       expect($stdout).to receive(:puts).with('ubuntu-1804-x86_64')
+      allow_any_instance_of(Object).to receive(:exit)
       Rake::Task['litmus:metadata'].invoke
     end
   end
 
+  context 'with litmus:install_module' do
+    let(:args) { { target_node_name: nil, module_repository: nil } }
+    let(:inventory_hash) { { 'groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'uri' => 'some.host' }, { 'uri' => 'some.otherhost' }] }] } }
+    let(:target_nodes) { ['some.host', 'some.otherhost'] }
+    let(:dummy_tar) { 'spec/data/doot.tar.gz' }
+
+    before do
+      Rake::Task['litmus:install_module'].reenable
+      allow_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
+      allow_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:find_targets).with(inventory_hash, args[:target_node_name]).and_return(target_nodes)
+    end
+
+    it 'installs module' do
+      expect_any_instance_of(Object).to receive(:build_module).and_return(dummy_tar)
+      expect($stdout).to receive(:puts).with("Built '#{dummy_tar}'")
+
+      expect_any_instance_of(Object).to receive(:install_module).with(inventory_hash, target_nodes, dummy_tar, args[:module_repository])
+      expect($stdout).to receive(:puts).with("Installed '#{dummy_tar}' on #{target_nodes.join(', ')}")
+      allow_any_instance_of(Object).to receive(:exit)
+      Rake::Task['litmus:install_module'].invoke(*args.values)
+    end
+
+    context 'with unknown target' do
+      let(:args) { { target_node_name: 'un.known', module_repository: nil } }
+      let(:target_nodes) { [] }
+
+      it 'exits with No targets found' do
+        expect do
+          expect($stdout).to receive(:puts).with('No targets found')
+          Rake::Task['litmus:install_module'].invoke(*args.values)
+        end.to raise_error(SystemExit) { |error|
+          expect(error.status).to eq(0)
+        }
+      end
+    end
+
+    context 'when build_module returns nil' do
+      let(:dummy_tar) { nil }
+
+      it 'raises error if build fails' do
+        expect_any_instance_of(Object).to receive(:build_module).and_return(dummy_tar)
+        expect($stdout).to receive(:puts).with("Built '#{dummy_tar}'")
+
+        expect { Rake::Task['litmus:install_module'].invoke(*args.values) }
+          .to raise_error(RuntimeError, "Unable to find package in 'pkg/*.tar.gz'")
+      end
+    end
+  end
+
   context 'with litmus:install_modules_from_directory' do
     let(:inventory_hash) { { 'groups' => [{ 'name' => 'ssh_nodes', 'nodes' => [{ 'uri' => 'some.host' }] }] } }
     let(:target_dir) { File.join(Dir.pwd, 'spec/fixtures/modules') }
@@ -44,6 +94,7 @@ describe 'litmus rake tasks' do
       expect($stdout).to receive(:puts).with(start_with('Installing \'spec/data/doot.tar.gz\''))
       expect_any_instance_of(Object).to receive(:run_command).twice.and_return([])
       expect($stdout).to receive(:puts).with(start_with('Installed \'spec/data/doot.tar.gz\''))
+      allow_any_instance_of(Object).to receive(:exit)
       Rake::Task['litmus:install_modules_from_directory'].invoke('./spec/fixtures/modules')
     end
   end
@@ -54,6 +105,7 @@ describe 'litmus rake tasks' do
       expect(Rake::Task['litmus:provision_list']).to receive(:invoke).with('default')
       expect(Rake::Task['litmus:install_agent']).to receive(:invoke).with('puppet6')
       expect(Rake::Task['litmus:install_module']).to receive(:invoke)
+      allow_any_instance_of(Object).to receive(:exit)
       Rake::Task['litmus:provision_install'].invoke('default', 'puppet6')
     end
   end
@@ -77,7 +129,7 @@ describe 'litmus rake tasks' do
       allow_any_instance_of(BoltSpec::Run).to receive(:run_task).with(any_args).and_return(results)
       allow_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).with(any_args).and_return({})
       allow_any_instance_of(PuppetLitmus::RakeHelper).to receive(:check_connectivity?).with(any_args).and_return(true)
-
+      allow_any_instance_of(Object).to receive(:exit)
       expect { Rake::Task['litmus:provision'].invoke('docker', 'centos:7') }.to output(/#{expected_output}/).to_stdout
     end
   end
@@ -89,6 +141,7 @@ describe 'litmus rake tasks' do
     it 'no key in provision file' do
       allow(File).to receive(:file?).with(any_args).and_return(true)
       expect(YAML).to receive(:load_file).with(provision_file).and_return(provision_hash)
+      allow_any_instance_of(Object).to receive(:exit)
       expect { Rake::Task['litmus:provision_list'].invoke('deet') }.to raise_error(/deet/)
     end
   end
@@ -100,6 +153,7 @@ describe 'litmus rake tasks' do
       stub_const('ENV', ENV.to_hash.merge('TARGET_HOST' => 'some.host'))
       expect_any_instance_of(PuppetLitmus::InventoryManipulation).to receive(:inventory_hash_from_inventory_file).and_return(inventory_hash)
       expect_any_instance_of(PuppetLitmus::RakeHelper).to receive(:check_connectivity?).with(inventory_hash, nil).and_return(true)
+      allow_any_instance_of(Object).to receive(:exit)
       Rake::Task['litmus:check_connectivity'].invoke
     end
   end
@@ -108,6 +162,7 @@ describe 'litmus rake tasks' do
     it 'calls spec_prep' do
       expect(Rake::Task['spec_prep']).to receive(:invoke).and_return('')
       expect_any_instance_of(RSpec::Core::RakeTask).to receive(:run_task)
+      allow_any_instance_of(Object).to receive(:exit)
       Rake::Task['litmus:acceptance:localhost'].invoke
     end
   end

data/spec/lib/puppet_litmus/util_spec.rb

@@ -5,11 +5,12 @@ load File.expand_path('../../../lib/puppet_litmus/util.rb', __dir__)
 
 RSpec.describe PuppetLitmus::Util do
   context 'when using interpolate_powershell' do
+    let(:command) { 'foo' }
+    let(:encoded) { Base64.strict_encode64(command.encode('UTF-16LE')) }
+
     it 'interpolates the command' do
-      expect(described_class.interpolate_powershell('foo')).to match(/powershell\.exe/)
-      expect(described_class.interpolate_powershell('foo')).to match(/NoProfile/)
-      expect(described_class.interpolate_powershell('foo')).to match(/EncodedCommand/)
-      expect(described_class.interpolate_powershell('foo')).not_to match(/foo/)
+      expect(described_class.interpolate_powershell(command)).to eql("powershell.exe -NoProfile -EncodedCommand #{encoded}")
+      expect(described_class.interpolate_powershell(command)).not_to match(/#{command}/)
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,32 +5,25 @@ require 'open3'
 require 'ostruct'
 
 if ENV['COVERAGE'] == 'yes'
-  require 'simplecov'
-
-  if ENV['CI'] == 'true'
-    require 'codecov'
-    SimpleCov.formatter = SimpleCov::Formatter::Codecov
-  else
+  begin
+    require 'simplecov'
+    require 'simplecov-console'
     SimpleCov.formatters = [
-      SimpleCov::Formatter::HTMLFormatter
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console
     ]
-  end
-  SimpleCov.start do
-    track_files 'lib/**/*.rb'
-
-    add_filter '/spec'
 
-    # do not track vendored files
-    add_filter '/vendor'
-    add_filter '/.vendor'
+    SimpleCov.start do
+      track_files 'lib/**/*.rb'
 
-    # do not track gitignored files
-    # this adds about 4 seconds to the coverage check
-    # this could definitely be optimized
-    add_filter do |f|
-      # system returns true if exit status is 0, which with git-check-ignore means file is ignored
-      system("git check-ignore --quiet #{f.filename}")
+      add_filter '/spec'
+      add_filter 'lib/puppet_litmus/version.rb'
+      # do not track vendored files
+      add_filter '/vendor'
+      add_filter '/.vendor'
     end
+  rescue LoadError
+    raise 'Add the simplecov & simplecov-console gems to Gemfile to enable this task'
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt