puppet_metadata 5.3.0 → 6.0.0

data/lib/puppet_metadata/metadata.rb

@@ -109,6 +109,79 @@ module PuppetMetadata
       unsupported.compact.to_h
     end
 
+    # @param [Date] at The date to check the EOL time. Today is used when nil.
+    # @param [String] desired_os the name of the operating system from metadata.json we want to update
+    # @return [Hash[String, Array[String]]]
+    #   All added releases for each operating system
+    def add_supported_operatingsystems(at = nil, desired_os = nil)
+      added = {}
+
+      metadata['operatingsystem_support'] = operatingsystems.map do |os, releases|
+        result = {
+          'operatingsystem' => os,
+        }
+
+        # desired_os is a filter
+        # if set, we only care about this OS, otherwise we want all OSes from metadata.json
+        if desired_os && desired_os != os
+          # Preserve the original entry unchanged
+          result['operatingsystemrelease'] = releases unless releases.nil?
+          next result
+        end
+
+        unless releases.nil?
+          supported = OperatingSystem.supported_releases(os, at)
+          releases_added = supported - releases
+          added[os] = releases_added if releases_added.any?
+          result['operatingsystemrelease'] = releases | supported
+        end
+        result
+      end
+
+      # Clear the memoized operatingsystems so it gets recalculated
+      @operatingsystems = nil
+
+      added
+    end
+
+    # @param [Date, nil] at The date to check the EOL time. Today is used when nil.
+    # @param [String, nil] desired_os the name of the operating system from metadata.json we want to update. All OSes are processed when nil.
+    # @return [Hash[String, Array[String]]]
+    #   All removed EOL releases for each operating system
+    def remove_eol_operatingsystems(at = nil, desired_os = nil)
+      removed = {}
+
+      metadata['operatingsystem_support'] = operatingsystems.map do |os, releases|
+        result = {
+          'operatingsystem' => os,
+        }
+
+        # desired_os is a filter
+        # if set, we only care about this OS, otherwise we want all OSes from metadata.json
+        if desired_os && desired_os != os
+          # Preserve the original entry unchanged
+          result['operatingsystemrelease'] = releases unless releases.nil?
+          next result
+        end
+
+        unless releases.nil?
+          eol = releases.select { |rel| OperatingSystem.eol?(os, rel, at) }
+          if eol.any?
+            removed[os] = eol
+            result['operatingsystemrelease'] = releases - eol
+          else
+            result['operatingsystemrelease'] = releases
+          end
+        end
+        result
+      end
+
+      # Clear the memoized operatingsystems so it gets recalculated
+      @operatingsystems = nil
+
+      removed
+    end
+
     # A hash representation of the requirements
     #
     # Every element in the original array is converted. The name is used as a

data/lib/puppet_metadata/operatingsystem.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'date'
+require 'json'
 
 module PuppetMetadata
   # An abstraction layer over operating systems. Mostly to determine End Of
@@ -10,207 +11,38 @@ module PuppetMetadata
   class OperatingSystem
     # please add new OSes sorted alphabetically
 
-    # The EOL dates for the various operating systems
-    # @see .eol_date
-    EOL_DATES = {
-      # https://wiki.almalinux.org/release-notes/
-      'AlmaLinux' => {
-        '9' => '2032-05-31',
-        '8' => '2029-05-31',
-      },
-      'Amazon' => {
-        # Amazon Linux AMI
-        # https://aws.amazon.com/amazon-linux-ami/
-        '2018.03' => '2023-12-31',
-        '2017.09' => '2023-12-31',
-        '2017.03' => '2023-12-31',
-        '2016.09' => '2023-12-31',
-        '2016.03' => '2023-12-31',
-        '2015.09' => '2023-12-31',
-        '2015.03' => '2023-12-31',
-        '2014.09' => '2023-12-31',
-        '2014.03' => '2023-12-31',
-        '2013.09' => '2023-12-31',
-        '2013.03' => '2023-12-31',
-        '2012.09' => '2023-12-31',
-        '2012.03' => '2023-12-31',
-        '2011.09' => '2023-12-31',
-        '2010.11' => '2023-12-31',
-        # Amazon Linux 2
-        # https://aws.amazon.com/amazon-linux-2/faqs/
-        '2.0' => '2026-06-30',
-        # Amazon Linux 2023
-        # https://docs.aws.amazon.com/linux/al2023/ug/release-cadence.html
-        '2023' => '2027-06-30',
-      },
-      # https://endoflife.software/operating-systems/linux/centos
-      # https://endoflife.date/centos-stream
-      'CentOS' => {
-        '10' => '2030-01-01',
-        '9' => '2027-05-31',
-        '8' => '2024-05-31',
-        '7' => '2024-06-30',
-        '6' => '2020-11-30',
-        '5' => '2017-03-31',
-        '4' => '2012-02-29',
-        '3' => '2010-10-30',
-      },
-      # https://wiki.debian.org/DebianReleases
-      'Debian' => {
-        # EOL is extended life cycle, not standard support
-        # https://github.com/voxpupuli/voxpupuli.github.io/pull/386
-        '13' => '2030-08-09',
-        '12' => '2028-06-30',
-        '11' => '2026-08-31',
-        '10' => '2022-09-10',
-        '9' => '2020-07-06',
-        '8' => '2018-06-17',
-        '7' => '2016-04-26',
-        '6' => '2015-05-31',
-        '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',
-      },
-      # https://endoflife.date/oraclelinux
-      'OracleLinux' => {
-        '10' => '2032-06-30', # I didn't find an EoL date yet, so I used the one from OL9
-        '9' => '2032-06-30',
-        '8' => '2029-07-01',
-        '7' => '2024-12-31',
-      },
-      # https://docs.fedoraproject.org/en-US/releases/eol/
-      'Fedora' => {
-        '41' => nil,
-        '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-08',
-        '13' => '2011-06-24',
-        '12' => '2010-12-02',
-        '11' => '2010-06-25',
-        '10' => '2009-12-18',
-        '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',
-      },
-      # https://endoflife.software/operating-systems/unix-like-bsd/freebsd
-      'FreeBSD' => {
-        '13' => '2026-01-31',
-        '12' => '2024-06-30',
-        '11' => '2021-09-30',
-        '10' => '2018-10-31',
-        '9' => '2016-12-31',
-        '8' => '2015-08-01',
-        '7' => '2013-02-28',
-        '6' => '2010-11-30',
-        '5' => '2008-05-31',
-        '4' => '2007-01-31',
-      },
-      # https://endoflife.software/operating-systems/linux/red-hat-enterprise-linux-rhel
-      'RedHat' => {
-        # TODO: EOL is standard support, not the extended life cycle
-        '8' => '2029-05-31',
-        '7' => '2024-06-30',
-        '6' => '2020-11-30',
-        '5' => '2017-03-31',
-        '4' => '2012-02-29',
-        '3' => '2010-10-31',
-      },
-      # https://wiki.rockylinux.org/rocky/version/
-      'Rocky' => {
-        '9' => '2032-05-31',
-        '8' => '2029-05-31',
-      },
-      # https://scientificlinux.org/category/uncategorized/scientific-linux-end-of-life/
-      'Scientific' => {
-        '8' => '2024-06-30', # This is not really a Scientific release, but I have seen it in module metadata ..
-        '7' => '2024-06-30',
-        '6' => '2020-11-30',
-        '5' => '2017-03-31',
-        '4' => '2012-02-29',
-        '3' => '2010-10-30',
-      },
-      # https://www.suse.com/lifecycle/#product-suse-linux-enterprise-server
-      # General support end dates, not LTSS
-      'SLES' => {
-        '15' => '2031-07-31',
-        '12' => '2024-10-31',
-        '11' => '2019-03-31',
-        '10' => '2013-07-31',
-      },
-      # https://endoflife.software/operating-systems/linux/ubuntu
-      'Ubuntu' => {
-        '24.04' => '2029-04-30',
-        '22.04' => '2027-04-15',
-        '21.10' => '2022-07-15',
-        '20.10' => '2021-07-15',
-        '20.04' => '2025-04-15',
-        '19.10' => '2020-07-15',
-        '19.04' => '2020-01-15',
-        '18.10' => '2019-07-15',
-        '18.04' => '2023-05-31',
-        '17.10' => '2018-07-15',
-        '17.04' => '2018-01-15',
-        '16.10' => '2017-07-20',
-        '16.04' => '2021-04-15',
-        '15.10' => '2016-07-28',
-        '15.04' => '2016-02-04',
-        '14.10' => '2015-07-23',
-        '14.04' => '2019-04-15',
-        '13.10' => '2014-07-17',
-        '13.04' => '2014-01-27',
-        '12.04' => '2017-04-28',
-        '11.10' => '2013-05-09',
-        '11.04' => '2012-10-28',
-        '10.10' => '2012-04-10',
-        '10.04' => '2015-04-30',
-        '9.10' => '2011-04-30',
-        '9.04' => '2010-10-23',
-        '8.10' => '2010-04-30',
-        '8.04' => '2013-05-09',
-        '7.10' => '2009-04-18',
-        '7.04' => '2008-10-19',
-        '6.10' => '2008-04-26',
-        '6.06' => '2011-06-01',
-        '5.10' => '2007-04-13',
-        '5.04' => '2006-10-31',
-        '4.10' => '2006-04-30',
-      },
-    }.freeze
+    # The EOL dates are maintained in data/eol_dates.json and can be updated
+    # automatically using the bin/update_eol_dates script.
+    #
+    # Lazy load the JSON data to minimize disk I/O and JSON parsing.
+    EOL_DATES_FILE = File.expand_path('../../data/eol_dates.json', __dir__).freeze
+
+    def self.const_missing(name)
+      return super unless name == :EOL_DATES
+
+      dates = JSON.parse(File.read(EOL_DATES_FILE)).freeze
+      const_set(:EOL_DATES, dates)
+    end
+
+    def self.reset_eol_dates_cache!
+      remove_const(:EOL_DATES) if const_defined?(:EOL_DATES, false)
+      nil
+    end
 
     class << self
+      def ubuntu_lts_version?(release)
+        # Ubuntu LTS releases are even-year April releases (e.g. 22.04, 24.04).
+        match = release.match(/^([0-9]+)\.04$/)
+        return false unless match
+
+        year = match[1].to_i
+        year.even?
+      end
+
+      def sles_major_version?(release)
+        release.match?(/^\d+$/)
+      end
+
       # Return the EOL date for the given operating system release
       # @param [String] operatingsystem
       #   The operating system
@@ -220,7 +52,7 @@ module PuppetMetadata
       #   The EOL date for the given operating system release. Nil is returned
       #   when the either when the OS, the release or the EOL date is unknown
       def eol_date(operatingsystem, release)
-        releases = EOL_DATES[operatingsystem]
+        releases = OperatingSystem::EOL_DATES[operatingsystem]
         return unless releases
 
         date = releases[release]
@@ -250,17 +82,31 @@ module PuppetMetadata
       #   The latest major release for the given operating system, if any is
       #   known
       def latest_release(operatingsystem)
-        releases = EOL_DATES[operatingsystem]
-        releases&.keys&.max_by { |release| Gem::Version.new(release) }
+        releases = OperatingSystem::EOL_DATES[operatingsystem]
+        return unless releases
+
+        keys = releases.keys
+        keys = keys.select { |release| ubuntu_lts_version?(release) } if operatingsystem == 'Ubuntu'
+        keys = keys.select { |release| sles_major_version?(release) } if operatingsystem == 'SLES'
+        keys.max_by { |release| Gem::Version.new(release) }
       end
 
       # Return an array of all Operating System versions that aren't EoL
       # @param [String] operatingsystem The operating system
-      # @return [Array] All Operating System versions that aren't EoL today
-      def supported_releases(operatingsystem)
-        releases = EOL_DATES[operatingsystem]
-        today = Date.today
-        releases.select { |_release, eol_date| !eol_date || Date.parse(eol_date) > today }.keys
+      # @param [Date] at The date to check the EOL time. Today is used when nil.
+      # @return [Array] All Operating System versions that aren't EoL
+      def supported_releases(operatingsystem, at = nil)
+        releases = OperatingSystem::EOL_DATES[operatingsystem]
+
+        # return an empty array if one OS has zero dates
+        # Happens for esoteric distros like windows, where we currently don't have any data in EOL_DATES
+        return [] unless releases
+
+        releases = releases.select { |release, _eol_date| ubuntu_lts_version?(release) } if operatingsystem == 'Ubuntu'
+        releases = releases.select { |release, _eol_date| sles_major_version?(release) } if operatingsystem == 'SLES'
+
+        at ||= Date.today
+        releases.select { |_release, eol_date| !eol_date || Date.parse(eol_date) > at }.keys
                 .sort_by { |release| Gem::Version.new(release) }
       end
 

data/lib/puppet_metadata.rb

@@ -3,7 +3,9 @@
 # A module that provides abstractions around Puppet's metadata format.
 module PuppetMetadata
   autoload :AIO, 'puppet_metadata/aio'
+  autoload :BaseCommand, 'puppet_metadata/base_command'
   autoload :Beaker, 'puppet_metadata/beaker'
+  autoload :Command, 'puppet_metadata/command'
   autoload :GithubActions, 'puppet_metadata/github_actions'
   autoload :Metadata, 'puppet_metadata/metadata'
   autoload :OperatingSystem, 'puppet_metadata/operatingsystem'
@@ -21,4 +23,11 @@ module PuppetMetadata
   def self.read(path)
     parse(File.read(path))
   end
+
+  # Write metadata back to disk
+  # @param path The path metadata.json
+  # @param [PuppetMetadata::Metadata] A Metadata object
+  def self.write(path, metadata)
+    File.write(path, "#{JSON.pretty_generate(metadata.metadata)}\n")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -62,16 +62,22 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 5.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -139,17 +145,26 @@ email:
 - voxpupuli@groups.io
 executables:
 - metadata2gha
+- puppet-metadata
 - setfiles
+- update_eol_dates
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
 - README.md
 - bin/metadata2gha
+- bin/puppet-metadata
 - bin/setfiles
+- bin/update_eol_dates
+- data/eol_dates.json
 - lib/puppet_metadata.rb
 - lib/puppet_metadata/aio.rb
+- lib/puppet_metadata/base_command.rb
 - lib/puppet_metadata/beaker.rb
+- lib/puppet_metadata/command.rb
+- lib/puppet_metadata/command/os_versions.rb
+- lib/puppet_metadata/command/setfiles.rb
 - lib/puppet_metadata/github_actions.rb
 - lib/puppet_metadata/metadata.rb
 - lib/puppet_metadata/operatingsystem.rb
@@ -166,17 +181,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4'
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Data structures for the Puppet Metadata
 test_files: []