puppet_metadata 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ed509fe1ad25088c9596721f674e5d2c730db03958d3f538fbd3c05d87d330
-  data.tar.gz: a66c279bfd4f85ad8dfabf8d85ba73bd406363a190af4bbac6b9c3d3a561cb7b
+  metadata.gz: 1763188bcd3297af8beb78aca2fc95986371390ea4e0d95178558c4744257a24
+  data.tar.gz: 9f00b77fef19f20ff4a0efc020c39e651aa4a35c71778ec6aba8d0538a10110c
 SHA512:
-  metadata.gz: 2ee5a4ec7f9ae96f7da02dcbc2dadc83a16a20d44c31ec4991abe638adcd34524d920f28039e5c5b78fb09ac7b0a63529b531cc5e7e8da339af170abc174b638
-  data.tar.gz: 02c8a63f6ae12572cd88582c6ad74804888bbfbc2de273ea277a249d39d429ad4f69676446ee460e39d6f89658d6b0f1d99429cdb71dd40425aa7023eab1ca84
+  metadata.gz: 205f35c88e3d3106f3403505c90e5e6f14271c2be756662bc347fc79aee1fc03ef8e1b5b32d5b3374b95df0a628ecba8cc009f8bdb8ab5260252d45173aed4ba
+  data.tar.gz: e168ab33e1b0420031a08b833f46b85e22e60279b1c7228ad7188824021a9e0c12546995a406bfaa0016dcb3db3a07ab12635f9a615187f40746b648223da631

data/README.md

@@ -16,33 +16,10 @@ To get outputs [usable in Github Actions](https://docs.github.com/en/free-pro-te
 
 ```console
 $ metadata2gha-beaker
-beaker_setfiles=[{"name":"CentOS 7","value":"centos7-64"},{"name":"CentOS 8","value":"centos8-64"},{"name":"Debian 10","value":"debian10-64"},{"name":"Ubuntu 18.04","value":"ubuntu1804-64"}]
 puppet_major_versions=[{"name":"Puppet 6","value":6,"collection":"puppet6"},{"name":"Puppet 5","value":5,"collection":"puppet5"}]
 puppet_unit_test_matrix=[{"puppet":6,"ruby":"2.5"},{"puppet":5,"ruby":"2.4"}]
 ```
 
-Beaker setfiles formatted for readability:
-```json
-[
-  {
-    "name": "CentOS 7",
-    "value": "centos7-64"
-  },
-  {
-    "name": "CentOS 8",
-    "value": "centos8-64"
-  },
-  {
-    "name": "Debian 10",
-    "value": "debian10-64"
-  },
-  {
-    "name": "Ubuntu 18.04",
-    "value": "ubuntu1804-64"
-  }
-]
-```
-
 Puppet major versions formatted for readability:
 ```json
 [

data/bin/metadata2gha

@@ -5,7 +5,13 @@ require 'puppet_metadata'
 
 PidfileWorkaround = Object.new
 
-options = {}
+options = {
+  beaker_use_fqdn: false,
+  beaker_pidfile_workaround: false,
+  domain: nil,
+  minimum_major_puppet_version: nil
+}
+
 OptionParser.new do |opts|
   opts.accept(PidfileWorkaround) do |value|
     case value
@@ -20,9 +26,11 @@ OptionParser.new do |opts|
 
   opts.banner = "Usage: #{$0} [options] metadata"
 
-  opts.on("--[no-]use-fqdn", "Generate beaker setfiles with a FQDN")
-  opts.on("--pidfile-workaround VALUE", "Generate the systemd PIDFile workaround to work around a docker bug", PidfileWorkaround)
-end.parse!(into: options)
+  opts.on("--[no-]use-fqdn", "Generate beaker setfiles with a FQDN") { |opt| options[:beaker_use_fqdn] = opt }
+  opts.on("--pidfile-workaround VALUE", "Generate the systemd PIDFile workaround to work around a docker bug", PidfileWorkaround) { |opt| options[:beaker_pidfile_workaround] = opt }
+  opts.on("-d", "--domain VALUE", "the domain for the box, only used when --use-fqdn is set to true") { |opt| options[:domain] = opt }
+  opts.on("--minimum-major-puppet-version VERSION", "Don't create actions for Puppet versions less than this major version") { |opt| options[:minimum_major_puppet_version] = opt }
+end.parse!
 
 filename = ARGV[0]
 if filename.nil? || filename.empty?
@@ -37,7 +45,7 @@ rescue StandardError => e
 end
 
 github_output = !ENV['GITHUB_OUTPUT'].nil? ? File.open(ENV['GITHUB_OUTPUT'], 'a') : $stdout
-metadata.github_actions.outputs(beaker_use_fqdn: options[:'use-fqdn'], beaker_pidfile_workaround: options[:'pidfile-workaround']).each do |name, value|
+metadata.github_actions(options).outputs.each do |name, value|
   github_output.write("#{name}=#{value.to_json}\n")
 end
 github_output.close

data/lib/puppet_metadata/beaker.rb

@@ -28,7 +28,7 @@ module PuppetMetadata
       #   based on Facter's operatingsystem fact.
       # @param [String] release The OS release
       # @param [Boolean] use_fqdn
-      #   Whether or not to use a FQDN, ensuring a domain
+      #   Whether or not to use a FQDN, ensuring a domain (deprecated, use domain)
       # @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
@@ -36,16 +36,22 @@ module PuppetMetadata
       #   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
+      #   The desired puppet version. Will be appended to the hostname
       #
       # @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, use_fqdn: false, pidfile_workaround: false)
+      def os_release_to_setfile(os, release, use_fqdn: false, pidfile_workaround: false, domain: nil, puppet_version: nil)
         return unless os_supported?(os)
 
         name = "#{os.downcase}#{release.tr('.', '')}-64"
+        hostname = puppet_version != nil ? "#{name}-#{puppet_version}" : name
+        domain ||= 'example.com' if use_fqdn
 
         options = {}
-        options[:hostname] = "#{name}.example.com" if use_fqdn
+        options[:hostname] = "#{hostname}.#{domain}" if domain
 
         # Docker messes up cgroups and some systemd versions can't deal with
         # that when PIDFile is used.
@@ -65,7 +71,7 @@ module PuppetMetadata
       # Return whether a Beaker setfile can be generated for the given OS
       # @param [String] os The operating system
       def os_supported?(os)
-        ['Archlinux', 'CentOS', 'Fedora', 'Debian', 'Ubuntu'].include?(os)
+        ['Archlinux', 'CentOS', 'Fedora', 'Debian', 'Ubuntu', 'Rocky', 'AlmaLinux'].include?(os)
       end
 
       private

data/lib/puppet_metadata/github_actions.rb

@@ -1,49 +1,43 @@
 module PuppetMetadata
   class GithubActions
     attr_reader :metadata
+    attr_reader :options
 
     # @param [PuppetMetadata::Metadata] metadata
-    def initialize(metadata)
+    # @param [Hash] options
+    def initialize(metadata, options)
       @metadata = metadata
+      @options  = options
     end
 
     # @return [Hash[Symbol, Any]] The outputs for Github Actions
-    def outputs(beaker_use_fqdn: false, beaker_pidfile_workaround: false)
+    def outputs
       {
-        beaker_setfiles: beaker_setfiles(beaker_use_fqdn, beaker_pidfile_workaround),
         puppet_major_versions: puppet_major_versions,
         puppet_unit_test_matrix: puppet_unit_test_matrix,
-        github_action_test_matrix: github_action_test_matrix(use_fqdn: beaker_use_fqdn, pidfile_workaround: beaker_pidfile_workaround),
+        github_action_test_matrix: github_action_test_matrix,
       }
     end
 
     private
 
-    def beaker_setfiles(use_fqdn, pidfile_workaround)
-      setfiles = []
-      metadata.beaker_setfiles(use_fqdn: use_fqdn, pidfile_workaround: pidfile_workaround) do |setfile, name|
-        setfiles << {
-          name: name,
-          value: setfile,
-        }
-      end
-      setfiles
-    end
-
     def puppet_major_versions
       metadata.puppet_major_versions.sort.reverse.map do |version|
+        next if puppet_version_below_minimum?(version)
+
         {
           name: "Puppet #{version}",
           value: version,
           collection: "puppet#{version}",
         }
-      end
+      end.compact
     end
 
     def puppet_unit_test_matrix
       metadata.puppet_major_versions.sort.reverse.map do |puppet|
         ruby = PuppetMetadata::AIO::PUPPET_RUBY_VERSIONS[puppet]
         next unless ruby
+        next if puppet_version_below_minimum?(puppet)
 
         {
           puppet: puppet,
@@ -71,12 +65,15 @@ module PuppetMetadata
       end
     end
 
-    def github_action_test_matrix(use_fqdn: false, pidfile_workaround: false)
+    def github_action_test_matrix
       matrix_include = []
 
       beaker_os_releases do |os, release, puppet_version|
-        setfile = PuppetMetadata::Beaker.os_release_to_setfile(os, release, use_fqdn: use_fqdn, pidfile_workaround: pidfile_workaround)
+        setfile = PuppetMetadata::Beaker.os_release_to_setfile(
+          os, release, use_fqdn: options[:beaker_use_fqdn], pidfile_workaround: options[:beaker_pidfile_workaround], domain: options[:domain], puppet_version: puppet_version[:collection]
+        )
         next unless setfile
+        next if puppet_version_below_minimum?(puppet_version[:value])
 
         matrix_include << {
           setfile: {
@@ -89,5 +86,11 @@ module PuppetMetadata
 
       matrix_include
     end
+
+    def puppet_version_below_minimum?(version)
+      return false unless options[:minimum_major_puppet_version]
+
+      Gem::Version.new(version) < Gem::Version.new(options[:minimum_major_puppet_version])
+    end
   end
 end

data/lib/puppet_metadata/metadata.rb

@@ -182,26 +182,10 @@ module PuppetMetadata
       matches?(dependencies[name], version)
     end
 
+    # @param [Hash] options A hash containing the command line options
     # @return [PuppetMetadata::GithubActions] A GithubActions instance
-    def github_actions
-      PuppetMetadata::GithubActions.new(self)
-    end
-
-    # @param [Boolean] use_fqdn
-    #   Whether to set the hostname to a fully qualified domain name
-    # @param [Boolean] pidfile_workaround
-    #   Whether to apply the Docker pidfile workaround
-    # @yieldparam [String] setfile
-    #   The supported setfile configurations
-    # @see PuppetMetadata::Beaker#os_release_to_setfile
-    def beaker_setfiles(use_fqdn: false, pidfile_workaround: false)
-      operatingsystems.each do |os, releases|
-        next unless PuppetMetadata::Beaker.os_supported?(os)
-        releases&.each do |release|
-          setfile = PuppetMetadata::Beaker.os_release_to_setfile(os, release, use_fqdn: use_fqdn, pidfile_workaround: pidfile_workaround)
-          yield setfile if setfile
-        end
-      end
+    def github_actions(options)
+      PuppetMetadata::GithubActions.new(self, options)
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
@@ -132,7 +132,7 @@ files:
 - lib/puppet_metadata/github_actions.rb
 - lib/puppet_metadata/metadata.rb
 - lib/puppet_metadata/operatingsystem.rb
-homepage: http://github.com/voxpupuli/puppet_metadata
+homepage: https://github.com/voxpupuli/puppet_metadata
 licenses:
 - Apache-2.0
 metadata: {}