puppet_metadata 5.3.0 → 6.0.0

data/data/eol_dates.json

@@ -0,0 +1,292 @@
+{
+  "AlmaLinux": {
+    "10": "2035-05-31",
+    "9": "2032-05-31",
+    "8": "2029-03-01"
+  },
+  "Amazon": {
+    "2023": "2029-06-30",
+    "2.0": "2026-06-30",
+    "2010.11": "2023-12-31",
+    "2011.09": "2023-12-31",
+    "2012.03": "2023-12-31",
+    "2012.09": "2023-12-31",
+    "2013.03": "2023-12-31",
+    "2013.09": "2023-12-31",
+    "2014.03": "2023-12-31",
+    "2014.09": "2023-12-31",
+    "2015.03": "2023-12-31",
+    "2015.09": "2023-12-31",
+    "2016.03": "2023-12-31",
+    "2016.09": "2023-12-31",
+    "2017.03": "2023-12-31",
+    "2017.09": "2023-12-31",
+    "2018.03": "2023-12-31"
+  },
+  "CentOS": {
+    "10": "2030-01-01",
+    "9": "2027-05-31",
+    "7": "2024-06-30",
+    "8": "2021-12-31",
+    "6": "2020-11-30",
+    "5": "2017-03-31",
+    "4": "2012-02-29",
+    "3": "2010-10-30"
+  },
+  "Debian": {
+    "13": "2030-06-30",
+    "12": "2028-06-30",
+    "11": "2026-08-31",
+    "10": "2024-06-30",
+    "9": "2022-07-01",
+    "8": "2020-06-30",
+    "7": "2018-05-31",
+    "6": "2016-02-29",
+    "5": "2012-02-06",
+    "4": "2010-02-15",
+    "3.1": "2008-03-31",
+    "3.0": "2006-06-30",
+    "2.2": "2003-06-30",
+    "2.1": "2000-09-30",
+    "2.0": "1999-02-15",
+    "1.3": "1998-12-08",
+    "1.2": "1997-10-23",
+    "1.1": "1996-12-12"
+  },
+  "OracleLinux": {
+    "10": null,
+    "9": "2032-06-30",
+    "8": "2029-07-31",
+    "7": "2024-12-31",
+    "6": "2021-03-31"
+  },
+  "Fedora": {
+    "43": "2026-12-09",
+    "42": "2026-05-13",
+    "41": "2025-11-26",
+    "40": "2025-05-13",
+    "39": "2024-11-26",
+    "38": "2024-05-21",
+    "37": "2023-12-05",
+    "36": "2023-05-16",
+    "35": "2022-12-13",
+    "34": "2022-06-07",
+    "33": "2021-11-30",
+    "32": "2021-05-25",
+    "31": "2020-11-24",
+    "30": "2020-05-26",
+    "29": "2019-11-26",
+    "28": "2019-05-28",
+    "27": "2018-11-30",
+    "26": "2018-05-29",
+    "25": "2017-12-12",
+    "24": "2017-08-08",
+    "23": "2016-12-20",
+    "22": "2016-07-19",
+    "21": "2015-12-01",
+    "20": "2015-06-23",
+    "19": "2015-01-06",
+    "18": "2014-01-14",
+    "17": "2013-07-30",
+    "16": "2013-02-12",
+    "15": "2012-06-26",
+    "14": "2011-12-09",
+    "13": "2011-06-24",
+    "12": "2010-12-02",
+    "11": "2010-06-25",
+    "10": "2009-12-17",
+    "9": "2009-07-10",
+    "8": "2009-01-07",
+    "7": "2008-06-13",
+    "6": "2007-12-07",
+    "5": "2007-07-02",
+    "4": "2006-08-07",
+    "3": "2006-01-16",
+    "2": "2005-04-11",
+    "1": "2004-09-20"
+  },
+  "FreeBSD": {
+    "14": "2028-11-30",
+    "14.3": "2026-06-30",
+    "13": "2026-04-30",
+    "13.5": "2026-04-30",
+    "14.2": "2025-09-30",
+    "13.4": "2025-06-30",
+    "14.1": "2025-03-31",
+    "13.3": "2024-12-31",
+    "14.0": "2024-09-30",
+    "13.2": "2024-06-30",
+    "12": "2023-12-31",
+    "12.4": "2023-12-31",
+    "13.1": "2023-07-31",
+    "12.3": "2023-03-31",
+    "13.0": "2022-08-31",
+    "12.2": "2022-03-31",
+    "11": "2021-09-30",
+    "11.4": "2021-09-30",
+    "12.1": "2021-01-31",
+    "11.3": "2020-09-30",
+    "12.0": "2020-02-29",
+    "11.2": "2019-10-31",
+    "10": "2018-10-31",
+    "10.4": "2018-10-31",
+    "11.1": "2018-09-30",
+    "10.3": "2018-04-30",
+    "11.0": "2017-11-30",
+    "9": "2016-12-31",
+    "9.3": "2016-12-31",
+    "10.1": "2016-12-31",
+    "10.2": "2016-12-31",
+    "8": "2015-08-01",
+    "8.4": "2015-08-01",
+    "10.0": "2015-02-28",
+    "9.1": "2014-12-31",
+    "9.2": "2014-12-31",
+    "8.3": "2014-04-30",
+    "9.0": "2013-03-31",
+    "7": "2013-02-28",
+    "7.4": "2013-02-28",
+    "8.1": "2012-07-31",
+    "8.2": "2012-07-31",
+    "7.3": "2012-03-31",
+    "7.1": "2011-02-28",
+    "6": "2010-11-30",
+    "6.4": "2010-11-30",
+    "8.0": "2010-11-30",
+    "7.2": "2010-06-30",
+    "6.3": "2010-01-31",
+    "7.0": "2009-04-30",
+    "5": "2008-05-31",
+    "6.1": "2008-05-31",
+    "5.5": "2008-05-31",
+    "6.2": "2008-05-31",
+    "4": "2007-01-31",
+    "4.10": "2007-01-31",
+    "4.11": "2007-01-31",
+    "6.0": "2007-01-31",
+    "5.3": "2006-10-31",
+    "5.4": "2006-10-31",
+    "5.2": "2005-02-28",
+    "4.9": "2004-08-31",
+    "5.1": "2004-04-30",
+    "4.8": "2004-02-28",
+    "5.0": "2003-09-30",
+    "4.7": "2003-07-31",
+    "4.6": "2003-01-31",
+    "4.5": "2002-09-30",
+    "4.4": "2002-04-30",
+    "4.3": "2001-12-31",
+    "4.2": "2001-07-31",
+    "3.5": "2001-06-30",
+    "4.1": "2001-02-28",
+    "4.0": "2000-10-31",
+    "3.4": "2000-09-30",
+    "3.3": "2000-02-29",
+    "3.2": "1999-12-31",
+    "3.1": "1999-08-31",
+    "3.0": "1999-05-31",
+    "2.2": "1998-03-31",
+    "2.1": "1997-06-30",
+    "2.0": "1996-02-28",
+    "1.1": "1995-05-31",
+    "1.0": "1994-08-31"
+  },
+  "RedHat": {
+    "10": "2035-05-31",
+    "9": "2032-05-31",
+    "8": "2029-05-31",
+    "7": "2024-06-30",
+    "6": "2020-11-30",
+    "5": "2017-03-31",
+    "4": "2012-02-29",
+    "3": "2010-10-31"
+  },
+  "Rocky": {
+    "10": "2035-05-31",
+    "9": "2032-05-31",
+    "8": "2029-05-31"
+  },
+  "Scientific": {
+    "7": "2024-06-30",
+    "8": "2024-06-30",
+    "6": "2020-11-30",
+    "5": "2017-03-31",
+    "4": "2012-02-29",
+    "3": "2010-10-30"
+  },
+  "SLES": {
+    "15": "2031-07-31",
+    "15.7": "2031-07-31",
+    "15.6": "2025-12-31",
+    "15.5": "2024-12-31",
+    "12": "2024-10-31",
+    "12.5": "2024-10-31",
+    "15.4": "2023-12-31",
+    "15.3": "2022-12-31",
+    "15.2": "2021-12-31",
+    "15.1": "2021-01-31",
+    "12.4": "2020-06-30",
+    "15.0": "2019-12-31",
+    "12.3": "2019-06-30",
+    "11": "2019-03-31",
+    "11.4": "2019-03-31",
+    "12.2": "2018-03-31",
+    "12.1": "2017-05-31",
+    "12.0": "2016-06-30",
+    "11.3": "2016-01-31",
+    "11.2": "2014-01-31",
+    "10": "2013-07-31",
+    "10.4": "2013-07-31",
+    "11.1": "2012-08-31",
+    "10.3": "2011-10-11",
+    "11.0": "2010-12-31",
+    "10.2": "2010-04-11",
+    "10.1": "2008-11-30",
+    "10.0": "2007-12-31"
+  },
+  "Ubuntu": {
+    "24.04": "2029-04-25",
+    "22.04": "2027-04-01",
+    "25.10": "2026-07-01",
+    "25.04": "2026-01-17",
+    "24.10": "2025-07-10",
+    "20.04": "2025-05-31",
+    "23.10": "2024-07-12",
+    "23.04": "2024-01-20",
+    "22.10": "2023-07-20",
+    "18.04": "2023-05-31",
+    "21.10": "2022-07-14",
+    "21.04": "2022-01-20",
+    "20.10": "2021-07-22",
+    "16.04": "2021-04-02",
+    "19.10": "2020-07-06",
+    "19.04": "2020-01-23",
+    "18.10": "2019-07-18",
+    "14.04": "2019-04-02",
+    "17.10": "2018-07-19",
+    "17.04": "2018-01-13",
+    "16.10": "2017-07-20",
+    "12.04": "2017-04-28",
+    "15.10": "2016-07-28",
+    "15.04": "2016-02-04",
+    "14.10": "2015-07-23",
+    "13.10": "2014-07-17",
+    "12.10": "2014-05-16",
+    "13.04": "2014-01-27",
+    "8.04": "2013-05-09",
+    "10.04": "2013-05-09",
+    "11.10": "2013-05-09",
+    "11.04": "2012-10-28",
+    "10.10": "2012-04-10",
+    "6.06": "2011-06-01",
+    "9.10": "2011-04-30",
+    "9.04": "2010-10-23",
+    "8.10": "2010-04-30",
+    "7.10": "2009-04-18",
+    "7.04": "2008-10-19",
+    "6.10": "2008-04-26",
+    "5.10": "2007-04-13",
+    "5.04": "2006-10-31",
+    "4.10": "2006-04-30"
+  }
+}

data/lib/puppet_metadata/aio.rb

@@ -2,7 +2,6 @@ module PuppetMetadata
   class AIO
     COMPATIBLE = {
       'AlmaLinux' => 'RedHat',
-      'Amazon' => 'RedHat',
       'CentOS' => 'RedHat',
       'OracleLinux' => 'RedHat',
       'Rocky' => 'RedHat',
@@ -38,6 +37,10 @@ module PuppetMetadata
     }.freeze
 
     OPENVOX_BUILDS = PUPPET_BUILDS.merge({
+                                           # RPM-based
+                                           'Amazon' => {
+                                             '2023' => [8],
+                                           },
                                            'RedHat' => {
                                              '7' => 7..8,
                                              '8' => 7..8,

data/lib/puppet_metadata/base_command.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module PuppetMetadata
+  # The base command. All actual commands should inherit from this.
+  class BaseCommand
+    def initialize(arguments, options)
+      @arguments = arguments
+      @options = options
+    end
+
+    def filename
+      @filename ||= @options.fetch(:filename, 'metadata.json')
+    end
+
+    def metadata
+      @metadata ||= PuppetMetadata.read(filename)
+    rescue StandardError => e
+      warn "Failed to read #{filename}: #{e}"
+      exit 2
+    end
+
+    def self.commands
+      PuppetMetadata::Command.load_commands
+
+      subclasses.to_h { |subclass| [subclass.command, subclass] }
+    end
+
+    def self.command
+      name.gsub(/Command$/, '')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('_', '-')
+          .downcase
+    end
+
+    # Return a parser. The program name should be overridden with a description
+    # @param [Hash] _options
+    #   The data to store the options into
+    # @return [OptionParser]
+    #   The parser for the command
+    def self.parser(_options)
+      raise NotImplementedError
+    end
+
+    # Actual implementation of the command
+    def run
+      raise NotImplementedError
+    end
+  end
+end

data/lib/puppet_metadata/beaker.rb

@@ -4,25 +4,6 @@ module PuppetMetadata
   # @see https://rubygems.org/gems/beaker
   # @see https://rubygems.org/gems/beaker-hostgenerator
   class Beaker
-    # These images have an older systemd, which they work with
-    # PIDFile parameter
-    PIDFILE_COMPATIBLE_IMAGES = {
-      'CentOS' => {
-        '7' => 'centos:7.6.1810',
-      },
-      'Ubuntu' => {
-        '16.04' => 'ubuntu:xenial-20191212',
-      },
-    }.freeze
-
-    # There is no CentOS 8 image that works with PIDFile in systemd
-    # unit files
-    PIDFILE_INCOMPATIBLE = {
-      'CentOS' => ['8'],
-      'AlmaLinux' => ['8'],
-      'OracleLinux' => ['7', '8'],
-      'Rocky' => ['8'],
-    }.freeze
     class << self
       # modifies the operating system name to suit beaker-hostgenerator
       # @param [String] os
@@ -31,6 +12,8 @@ module PuppetMetadata
         case os
         when 'OracleLinux'
           'oracle'
+        when 'Amazonlinux', 'AmazonLinux' # Vox Pupuli default is Amazon in metadata.json
+          'amazon'
         else
           os.downcase
         end
@@ -42,13 +25,6 @@ module PuppetMetadata
       #   The Operating System string as metadata.json knows it, which in turn is
       #   based on Facter's operatingsystem fact.
       # @param [String] release The OS release
-      # @param [Boolean, Array[String]] pidfile_workaround
-      #   Whether or not to apply the systemd PIDFile workaround. This is only
-      #   needed when the daemon uses PIDFile in its service file and using
-      #   Docker as a Beaker hypervisor. This is to work around Docker's
-      #   limitations.
-      #   When a boolean, it's applied on applicable operating systems. On arrays
-      #   it's applied only when os is included in the provided array.
       # @param [Optional[String]] domain
       #   Enforce a domain to be appended to the hostname, making it an FQDN
       # @param [Optional[String]] puppet_version
@@ -61,7 +37,7 @@ module PuppetMetadata
       #
       # @return [nil] If no setfile is available
       # @return [Array<(String, String)>] The beaker setfile description with a readable name
-      def os_release_to_setfile(os, release, pidfile_workaround: false, domain: nil, puppet_version: nil, hosts: nil)
+      def os_release_to_setfile(os, release, domain: nil, puppet_version: nil, hosts: nil)
         return unless os_supported?(os)
 
         aos = adjusted_os(os)
@@ -96,21 +72,10 @@ module PuppetMetadata
         end
 
         options = {}
-        # Docker messes up cgroups and some systemd versions can't deal with
-        # that when PIDFile is used.
-        image_to_use = nil
-        if pidfile_workaround?(pidfile_workaround, os)
-          return if PIDFILE_INCOMPATIBLE[os]&.include?(release)
-
-          if (image = PIDFILE_COMPATIBLE_IMAGES.dig(os, release))
-            image_to_use = image
-          end
-        end
 
         setfile_parts = []
         hosts_settings.each do |host_settings|
           options[:hostname] = host_settings['hostname'] unless host_settings['hostname'].empty?
-          options[:image] = image_to_use if image_to_use
           setfile_parts << build_setfile(host_settings['name'], options)
         end
 
@@ -120,17 +85,13 @@ module PuppetMetadata
       # Return whether a Beaker setfile can be generated for the given OS
       # @param [String] os The operating system
       def os_supported?(os)
-        %w[Archlinux CentOS Fedora Debian Ubuntu Rocky AlmaLinux OracleLinux].include?(os)
+        %w[Amazonlinux Amazon Archlinux CentOS Fedora Debian Ubuntu Rocky AlmaLinux OracleLinux].include?(os)
       end
 
       private
 
-      def pidfile_workaround?(pidfile_workaround, os)
-        pidfile_workaround && (!pidfile_workaround.is_a?(Array) || pidfile_workaround.include?(os))
-      end
-
       def build_setfile(name, options)
-        "#{name}#{options.any? ? "{#{options.map { |key, value| "#{key}=#{value}" }.join(',')}}" : ''}"
+        "#{name}#{"{#{options.map { |key, value| "#{key}=#{value}" }.join(',')}}" if options.any?}"
       end
     end
   end

data/lib/puppet_metadata/command/os_versions.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Manage operating system versions in metadata.json
+class OsVersionsCommand < PuppetMetadata::BaseCommand
+  def self.parser(options)
+    OptionParser.new do |opts|
+      opts.set_program_name 'Manage operating system versions in metadata.json'
+      opts.on('--at DATE', Date, 'The date to use for EOL checks') do |value|
+        options[:at] = value
+      end
+      opts.on('--os OPERATINGSYSTEM', 'Only process the specific operating system') do |value|
+        options[:os] = value
+      end
+      opts.on('--add-missing', 'Add missing supported OS versions to metadata.json') do
+        options[:add_missing] = true
+      end
+      opts.on('--remove-eol', 'Remove EOL OS versions from metadata.json') do
+        options[:remove_eol] = true
+      end
+      opts.on('--noop', 'Show what would be changed without modifying metadata.json') do
+        options[:noop] = true
+      end
+    end
+  end
+
+  def run
+    changes_made = false
+
+    if @options[:add_missing] && @options[:remove_eol]
+      # Run both operations in sequence
+      changes_made |= add_missing
+      changes_made |= remove_eol
+    elsif @options[:add_missing]
+      changes_made = add_missing
+    elsif @options[:remove_eol]
+      changes_made = remove_eol
+    else
+      list_versions
+      return
+    end
+
+    PuppetMetadata.write(filename, metadata) if changes_made && !@options[:noop]
+  end
+
+  private
+
+  # rubocop:disable Naming/PredicateMethod
+  def add_missing
+    added = metadata.add_supported_operatingsystems(@options[:at], @options[:os])
+
+    return false unless added.any?
+
+    prefix = @options[:noop] ? '[NOOP] Would add support:' : 'Added support:'
+    puts prefix
+    added.each do |os, releases|
+      puts "#{os} => #{releases.join(', ')}"
+    end
+
+    true
+  end
+
+  def remove_eol
+    removed = metadata.remove_eol_operatingsystems(@options[:at], @options[:os])
+
+    return false unless removed.any?
+
+    prefix = @options[:noop] ? '[NOOP] Would remove EOL operating systems:' : 'Removed EOL operating systems:'
+    puts prefix
+    removed.each do |os, releases|
+      puts "#{os} => #{releases.join(', ')}"
+    end
+
+    # Check for OSes that now have empty version lists
+    metadata.operatingsystems.each do |os, versions|
+      warn "Warning: #{os} has no supported versions after removing EOL releases. Consider removing it from metadata.json or adding newer versions." if versions.is_a?(Array) && versions.empty?
+    end
+
+    true
+  end
+  # rubocop:enable Naming/PredicateMethod
+
+  def list_versions
+    # Collect all OS data
+    supported_oses = {}
+    eol_oses = {}
+
+    oses = @options[:os] ? [@options[:os]] : metadata.operatingsystems.keys.sort
+
+    oses.each do |os|
+      current = metadata.operatingsystems[os]
+
+      if current.nil? || current.empty?
+        supported_oses[os] = '(supports all versions)'
+      else
+        eol = current.select { |rel| PuppetMetadata::OperatingSystem.eol?(os, rel, @options[:at]) }
+        non_eol = current - eol
+
+        supported_oses[os] = non_eol.join(', ') if non_eol.any?
+        eol_oses[os] = eol.join(', ') if eol.any?
+      end
+    end
+
+    # Display supported OSes
+    if supported_oses.any?
+      puts "#{metadata.name} supports these non-EOL operating system versions:"
+      supported_oses.each do |os, versions|
+        puts "  #{os}: #{versions}"
+      end
+      puts ''
+    end
+
+    # Display EOL OSes
+    return unless eol_oses.any?
+
+    puts "#{metadata.name} supports these EOL operating system versions:"
+    eol_oses.each do |os, versions|
+      puts "  #{os}: #{versions}"
+    end
+    puts ''
+  end
+end

data/lib/puppet_metadata/command/setfiles.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Show the various setfiles supported by the metadata
+class SetfilesCommand < PuppetMetadata::BaseCommand
+  def self.parser(_options)
+    OptionParser.new do |opts|
+      opts.set_program_name 'Show the various setfiles supported by the metadata'
+    end
+  end
+
+  def run
+    options = {
+      domain: 'example.com',
+      minimum_major_puppet_version: nil,
+      beaker_fact: nil,
+      beaker_hosts: nil,
+    }
+
+    metadata.github_actions(options).outputs[:puppet_beaker_test_matrix].each do |os|
+      puts "BEAKER_SETFILE=\"#{os[:env]['BEAKER_SETFILE']}\""
+    end
+  end
+end

data/lib/puppet_metadata/command.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PuppetMetadata
+  # A collection of commands implemented in the CLI.
+  #
+  # @see PuppetMetadata::BaseCommand
+  module Command
+    def self.load_commands
+      return if @loaded
+
+      Dir.glob(File.join(__dir__, 'command', '*.rb')) do |path|
+        require_relative File.join('command', File.basename(path, '.rb'))
+      end
+
+      @loaded = true
+    end
+  end
+end

data/lib/puppet_metadata/github_actions.rb

@@ -138,7 +138,6 @@ module PuppetMetadata
       PuppetMetadata::Beaker.os_release_to_setfile(
         os,
         release,
-        pidfile_workaround: options[:beaker_pidfile_workaround],
         domain: options[:domain],
         puppet_version: puppet_collection,
         hosts: options[:beaker_hosts],