puppet_litmus 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae343528c6aa1a501ab3a74a35413af6fa597549117eabeb8187c34620ace77b
-  data.tar.gz: '084246ae80f218ff9fee07e7dc207ffafca0d1c88e4d7bf43f4698857465098c'
+  metadata.gz: ddb31ff29d7e1d38620998447c3b0374b5d83c000a728c82335b792d31713f69
+  data.tar.gz: 577f054f113f94e527749b187567b04f62335ce2eae6f4d36d299a554cacc6ca
 SHA512:
-  metadata.gz: b04fdf66b039df83064c3a2e658990269994a4916cba170b06b47bcf94c0ec45cc536fdc627aa7ca51b49ce6a394baa13a4c42e3ef568ed6175f6f5dc1181abe
-  data.tar.gz: c130ece42862fbc1434971b153b8ff3e5e0a8a8a9c397dbe423ccf5b347c621c656d9c0e8544d704b95de4257ab0dc13db0fe5870da5e81b814a6f18ace93b5c
+  metadata.gz: 500e38ceadb721af5cb4c45ae84d38edf417bd55411f67e5b910d9b74090739be94169d370cf7663a86f445c4853ca92fcf5e43170aaf5d01719cc4ba4a7c943
+  data.tar.gz: 38fd30196f4b5c6eb952bee7f230d5c14a76b9d75cc45eed4681abb72eec1e5075d61d5963a44bdc4a13be51d3dcb739e12ec14ae99877184efe8f11fedefbbe

data/README.md

@@ -68,6 +68,7 @@ in the project module root directory run `bundle exec matrix_from_metadata_v3`
 | --puppet-exclude    | MAJOR |                   | Filter puppet major version |
 | --platform-include  | REGEX |                   | Select platform |
 | --platform-exclude  | REGEX |                   | Filter platform |
+| --collection-platform-exclude | MAJOR:REGEX | | Filter a platform for one puppet major only, emitted as a GitHub Actions matrix exclude so the platform stays in other collections. Repeatable |
 | --arch-include      | REGEX |                   | Select architecture |
 | --arch-exclude      | REGEX |                   | Filter architecture |
 | --provision-prefer  | NAME  | docker            | Prefer provisioner |
@@ -88,6 +89,10 @@ in the project module root directory run `bundle exec matrix_from_metadata_v3`
   ```sh
   matrix_from_metadata_v3 --platform-exclude redhat-7 --platform-exclude ubuntu-18.04
   ```
+* Exclude a platform for one puppet major only (kept in other collections). E.g. ubuntu-20.04 has no Puppet 9 agent but is valid on Puppet 8:
+  ```sh
+  matrix_from_metadata_v3 --nightly --collection-platform-exclude 9:ubuntu-20.04
+  ```
 * Exclude architecture
   ```sh
   matrix_from_metadata_v3 --arch-exclude x86_64

data/exe/matrix_from_metadata_v3

@@ -86,6 +86,7 @@ options = OpenStruct.new(
   puppet_include: [],
   platform_exclude: [],
   platform_include: [],
+  collection_platform_exclude: [],
   arch_include: [],
   arch_exclude: [],
   provision_prefer: [],
@@ -155,6 +156,21 @@ begin
     opt.on('--platform-include REGEX', Regexp, 'Select platform') { |o| options.platform_include << o }
     opt.on('--platform-exclude REGEX', Regexp, 'Filter platform') { |o| options.platform_exclude << o }
 
+    opt.on('--collection-platform-exclude SPEC', String,
+           'Filter a platform for one puppet major only, as MAJOR:PLATFORM_REGEX (e.g. 9:ubuntu-20.04). ' \
+           'Emitted as a GitHub Actions matrix exclude so the platform stays in other collections. Repeatable.') do |o|
+      major, regex = o.split(':', 2)
+      raise OptionParser::InvalidArgument, "--collection-platform-exclude '#{o}' must be MAJOR:PLATFORM_REGEX" \
+        if regex.nil? || regex.empty? || major !~ /\A\d+\z/
+
+      begin
+        platform = Regexp.new(regex, Regexp::IGNORECASE)
+      rescue RegexpError => e
+        raise OptionParser::InvalidArgument, "--collection-platform-exclude '#{o}' has an invalid PLATFORM_REGEX: #{e.message}"
+      end
+      options.collection_platform_exclude << { major: major.to_i, platform: }
+    end
+
     opt.on('--arch-include REGEX', Regexp, 'Select architecture') { |o| options.arch_include << o }
     opt.on('--arch-exclude REGEX', Regexp, 'Filter architecture') { |o| options.arch_exclude << o }
 
@@ -370,6 +386,29 @@ options[:metadata]['operatingsystem_support'].each do |os_sup|
   end
 end
 
+# Exclude specific platform x collection combinations (e.g. an OS a given puppet
+# major ships no agent package for, such as ubuntu-20.04 on puppet 9). The platform
+# and collection remain valid on their own, so this is emitted as a GitHub Actions
+# matrix `exclude` that only drops the matching combinations.
+unless options[:collection_platform_exclude].empty?
+  exclude = []
+  matrix[:collection].each do |coll|
+    coll_name = coll.is_a?(Hash) ? coll[:collection] : coll
+    major = coll_name.to_s[/\d+/]&.to_i
+    next if major.nil?
+
+    matrix[:platforms].each do |platform|
+      next unless options[:collection_platform_exclude].any? do |spec|
+        spec[:major] == major && platform[:label].match?(spec[:platform])
+      end
+
+      Action.notice("collection-platform-exclude filtered #{platform[:label]} x #{coll_name}")
+      exclude << { platforms: platform, collection: coll }
+    end
+  end
+  matrix[:exclude] = exclude unless exclude.empty?
+end
+
 Action.group('matrix', matrix, pretty: true).group('spec_matrix', spec_matrix, pretty: true) if Action.type == 'github' && Action.notice
 
 Action.error('no supported puppet versions') if matrix[:collection].empty?

data/lib/puppet_litmus/version.rb

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

data/spec/exe/matrix_from_metadata_v3_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'json'
 
 RSpec.describe 'matrix_from_metadata_v3' do
   let(:github_output) { Tempfile.new('github_output') }
@@ -239,7 +240,7 @@ RSpec.describe 'matrix_from_metadata_v3' do
         '::group::matrix',
         '::group::spec_matrix'
       )
-      expect(github_output_content).to match(/"collection":\[(?:"\d{4}\.\d\.\d-puppet_enterprise",)+"puppetcore8","puppetcore9"/)
+      expect(github_output_content).to match(/"collection":\[(?:"\d{4}\.\d+\.\d+-puppet_enterprise",)+"puppetcore8","puppetcore9"/)
       expect(github_output_content).to include(
         'spec_matrix={"include":[{"puppet_version":"~> 8.0","ruby_version":3.2},{"puppet_version":"~> 9.0","ruby_version":4.0}]}'
       )
@@ -335,4 +336,52 @@ RSpec.describe 'matrix_from_metadata_v3' do
       )
     end
   end
+
+  context 'with --collection-platform-exclude' do
+    let(:result) do
+      run_matrix_from_metadata_v3(
+        ['--collection-platform-exclude', '9:ubuntu-18.04'],
+        env: { 'PUPPET_FORGE_TOKEN' => 'fake' }
+      )
+    end
+
+    it 'runs successfully' do
+      expect(result.status_code).to eq 0
+    end
+
+    it 'emits a matrix exclude for only the matching platform x collection' do
+      result
+      matrix = JSON.parse(github_output_content[/^matrix=(.+)$/, 1])
+      expect(matrix['exclude']).to contain_exactly(
+        'platforms' => {
+          'label' => 'Ubuntu-18.04', 'provider' => 'docker', 'arch' => 'x86_64',
+          'image' => 'litmusimage/ubuntu:18.04', 'runner' => 'ubuntu-22.04'
+        },
+        'collection' => 'puppetcore9'
+      )
+    end
+
+    it 'keeps the platform and the collection usable in other combinations' do
+      # Ubuntu-18.04 is still a platform and puppetcore9 is still a collection;
+      # only the single pair is excluded (so Ubuntu-18.04 still runs on puppetcore8).
+      result
+      expect(github_output_content).to include('{"label":"Ubuntu-18.04","provider":"docker",')
+      expect(github_output_content).to include('"collection":["puppetcore8","puppetcore9"]')
+    end
+
+    it 'logs the exclusion' do
+      expect(result.stdout).to include('::notice::collection-platform-exclude filtered Ubuntu-18.04 x puppetcore9')
+    end
+  end
+
+  context 'with an invalid --collection-platform-exclude spec' do
+    let(:result) do
+      run_matrix_from_metadata_v3(['--collection-platform-exclude', 'ubuntu-18.04'])
+    end
+
+    it 'fails with a helpful error' do
+      expect(result.status_code).not_to eq 0
+      expect(result.stdout).to include("--collection-platform-exclude 'ubuntu-18.04' must be MAJOR:PLATFORM_REGEX")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_litmus
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-25 00:00:00.000000000 Z
+date: 2026-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt