puppet_metadata 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6592e846ac0678664a4f88091a19002df675cbbf06d51159a0a54e9e68573ae7
-  data.tar.gz: c5975198c75b77e682c8ce263f0b2279f77bbb2df1fb941f5809b909416cf003
+  metadata.gz: 28aa43873472b811f5e9cc1fb83463e9cdaf413dc0ffc7b3e30674f7f82e19ba
+  data.tar.gz: b8965851efccac5ffd2045f8cbbc944a7fc5db0df386806ec371af8fc86221ef
 SHA512:
-  metadata.gz: 46c96e7c74f6f2967b0d7a9c3f0568564e5edcca10f0b57a4652edea19b33d6adad589971cb6141cbab0864eadd58a450554b540fd318bd22717d80e634f6060
-  data.tar.gz: c7a6da54b846424e3122206c6d6908dd8e4716450c7b79e1529a96df24e376a95c77a04cb73bc40519b5e901da43e08857a061cac0687e83b20da1284ff40565
+  metadata.gz: 06df9e652fd704478bc5c95fa86406ea587daf0b21af5bfe5a12a988801c6ee81965713d4e90a484b0e10e2c739147a6b06730ac0ce001be68943598cb5860ce
+  data.tar.gz: 87fb2e005ccfb3ab28808d56113541e3a96d6e4ae05064e60818a6abe18249ff7fb94af34fb517ca296ab15136d503ed9ae57fd19ca68adcf7a3a0d54a2779e6

data/README.md

@@ -16,23 +16,23 @@ To get outputs [usable in Github Actions](https://docs.github.com/en/free-pro-te
 
 ```console
 $ metadata2gha
-puppet_major_versions=[{"name":"Puppet 7","value":7,"collection":"puppet7"},{"name":"Puppet 6","value":6,"collection":"puppet6"}]
-puppet_unit_test_matrix=[{"puppet":7,"ruby":"2.7"},{"puppet":6,"ruby":"2.5"}]
-github_action_test_matrix=[{"setfile":{"name":"Debian 11","value":"debian11-64"},"puppet":{"name":"Puppet 7","value":7,"collection":"puppet7"}},{"setfile":{"name":"Debian 11","value":"debian11-64"},"puppet":{"name":"Puppet 6","value":6,"collection":"puppet6"}}]
+puppet_major_versions=[{"name":"Puppet 8","value":8,"collection":"puppet8"},{"name":"Puppet 7","value":7,"collection":"puppet7"}]
+puppet_unit_test_matrix=[{"puppet":8,"ruby":"3.2"},{"puppet":7,"ruby":"2.7"}]
+puppet_beaker_test_matrix=[{"name":"Puppet 8 - Debian 12","env":{"BEAKER_PUPPET_COLLECTION":"puppet8","BEAKER_SETFILE":"debian12-64{hostname=debian12-64-puppet8}"}},{"name":"Puppet 7 - Debian 12","env":{"BEAKER_PUPPET_COLLECTION":"puppet7","BEAKER_SETFILE":"debian12-64{hostname=debian12-64-puppet7}"}}]
 ```
 
 Puppet major versions formatted for readability:
 ```json
 [
+  {
+    "name": "Puppet 8",
+    "value": 8,
+    "collection": "puppet8"
+  },
   {
     "name": "Puppet 7",
     "value": 7,
     "collection": "puppet7"
-  },
-  {
-    "name": "Puppet 6",
-    "value": 6,
-    "collection": "puppet6"
   }
 ]
 ```
@@ -40,70 +40,177 @@ Puppet major versions formatted for readability:
 Puppet unit test matrix formatted for readability:
 ```json
 [
+  {
+    "puppet": 8,
+    "ruby": "3.2"
+  },
   {
     "puppet": 7,
     "ruby": "2.7"
+  }
+]
+```
+
+Beaker test matrix formatted for readability
+```json
+[
+  {
+    "name": "Puppet 8 - Debian 12",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet8",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet8}"
+    }
   },
   {
-    "puppet": 6,
-    "ruby": "2.5"
+    "name": "Puppet 7 - Debian 12",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7}"
+    }
   }
 ]
 ```
 
-GitHub Action test matrix formatted for readability
+It is possible to specify the path to metadata.json and customize the setfiles. For example, to ensure the setfiles use FQDNs and apply the [systemd PIDFile workaround under docker](https://github.com/docker/for-linux/issues/835). This either means either using an older image (CentOS 7, Ubuntu 16.04) or skipping (CentOS 8).
+
+```console
+$ metadata2gha --use-fqdn --pidfile-workaround true /path/to/metadata.json
+```
+
+This results in the following JSON data
 ```json
 [
   {
-    "setfile": {
-      "name": "Debian 11",
-      "value": "debian11-64"
-    },
-    "puppet": {
-      "name": "Puppet 7",
-      "value": 7,
-      "collection": "puppet7"
+    "name": "Puppet 7 - CentOS 7",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "centos7-64{hostname=centos7-64-puppet7.example.com,image=centos:7.6.1810}"
+    }
+  },
+  {
+    "name": "Puppet 7 - Debian 12",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7.example.com}"
     }
   },
   {
-    "setfile": {
-      "name": "Debian 11",
-      "value": "debian11-64"
-    },
-    "puppet": {
-      "name": "Puppet 6",
-      "value": 6,
-      "collection": "puppet6"
+    "name": "Puppet 7 - Ubuntu 22.04",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "ubuntu2204-64{hostname=ubuntu2204-64-puppet7.example.com}"
     }
   }
 ]
 ```
 
-It is also possible to specify the path to metadata.json and customize the setfiles. For example, to ensure the setfiles use FQDNs and apply the [systemd PIDFile workaround under docker](https://github.com/docker/for-linux/issues/835). This either means either using an older image (CentOS 7, Ubuntu 16.04) or skipping (CentOS 8).
+If you need custom hostname or multiple hosts in your integration tests this could be achived by using the --beaker-hosts option
+
+Option argument is 'HOSTNAME:ROLES;HOSTNAME:..;..' where
+- hosts are separated by ';'
+- host number and roles are separated by ':'
+- Roles follow beaker-hostgenerator syntax
+If you don't need any extra roles use '1;2;..'
 
 ```console
-$ metadata2gha --use-fqdn --pidfile-workaround true /path/to/metadata.json
+$ metadata2gha --beaker-hosts 'foo:primary.ma;bar:secondary.a'
+```
+
+This results in the following JSON data
+```json
+[
+  {
+    "name": "Puppet 7 - Debian 12",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64primary.ma{hostname=foo-puppet7}-debian12-64secondary.a{hostname=bar-puppet7}"
+    }
+  }
+]
+```
+
+If you need to Expand the matrix ie by product versions it could be achived by using the --beaker-facter option
+
+Option argument is 'FACT:LABEL:VALUE,VALUE,..' where
+- Fact, label and values are separated by ':'
+- Values are separated by ','
+
+```console
+$ metadata2gha --beaker-facter 'mongodb_repo_version:MongoDB:4.4,5.0,6.0,7.0'
 ```
 
 This results in the following JSON data
 ```json
 [
   {
-    "name": "CentOS 7",
-    "value": "centos7-64{hostname=centos7-64.example.com,image=centos:7.6.1810}"
+    "name": "Puppet 7 - Debian 12 - MongoDB 4.4",
+    "env": {
+        "BEAKER_PUPPET_COLLECTION": "puppet7",
+        "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7}",
+        "BEAKER_FACTER_mongodb_repo_version": "4.4"
+    }
+  },
+  {
+    "name": "Puppet 7 - Debian 12 - MongoDB 5.0",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7}",
+      "BEAKER_FACTER_mongodb_repo_version": "5.0"
+    }
   },
   {
-    "name": "Debian 10",
-    "value": "debian10-64{hostname=debian10-64.example.com}"
+    "name": "Puppet 7 - Debian 12 - MongoDB 6.0",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7}",
+      "BEAKER_FACTER_mongodb_repo_version": "6.0"
+    }
   },
   {
-    "name": "Ubuntu 18.04",
-    "value": "ubuntu1804-64{hostname=ubuntu1804-64.example.com}"
+    "name": "Puppet 7 - Debian 12 - MongoDB 7.0",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "puppet7",
+      "BEAKER_SETFILE": "debian12-64{hostname=debian12-64-puppet7}",
+      "BEAKER_FACTER_mongodb_repo_version": "7.0"
+    }
   }
 ]
 ```
 
-It is also possible to specify a comma separated list of operating systems as used in `metadata.json` (`CentOS,Ubuntu`).
+## Work with the API
+
+The API can be initialised like this:
+
+```ruby
+require 'puppet_metadata'
+metadata = PuppetMetadata.read('/path/to/a/metadata.json')
+```
+
+The metadata object has several different methods that we can call
+
+### List all supported operating systems
+
+```
+[9] pry(main)> metadata.operatingsystems
+=> {"Archlinux"=>nil, "Gentoo"=>nil, "Fedora"=>["32", "33"], "CentOS"=>["7", "8"], "RedHat"=>["7", "8"], "Ubuntu"=>["18.04"], "Debian"=>["9", "10"], "VirtuozzoLinux"=>["7"]}
+[10] pry(main)>
+```
+
+### List supported major puppet versions
+
+```
+[10] pry(main)> metadata.puppet_major_versions
+=> [6, 7]
+[11] pry(main)>
+```
+
+### Check if an operating systems is supported
+
+```
+[6] pry(main)> metadata.os_release_supported?('Archlinux', nil)
+=> true
+[7] pry(main)>
+```
 
 ## Transfer Notice
 

data/bin/metadata2gha

@@ -11,6 +11,7 @@ options = {
   domain: nil,
   minimum_major_puppet_version: nil,
   beaker_fact: nil,
+  beaker_hosts: nil,
 }
 
 OptionParser.new do |opts|
@@ -40,6 +41,15 @@ OptionParser.new do |opts|
       options[:beaker_facter] = [fact, label, values.split(',')]
     end
   end
+  opts.on('--beaker-hosts HOSTNAME:ROLES;HOSTNAME:ROLES;...', 'Expand the setfile string to create multiple hosts with custom roles. Roles string; see beaker-hostgenerator') do |opt|
+    options[:beaker_hosts] = {}
+    if opt != 'false'
+      opt.split(';').each do |host|
+        hostname, roles = host.split(':', 2)
+        options[:beaker_hosts][hostname] = roles
+      end
+    end
+  end
 end.parse!
 
 filename = ARGV[0]

data/lib/puppet_metadata/aio.rb

@@ -41,6 +41,7 @@ module PuppetMetadata
         '9' => 5..7,
         '10' => 5..8,
         '11' => 6..8,
+        '12' => 7..8,
       },
       'Ubuntu' => {
         '14.04' => 5..6,

data/lib/puppet_metadata/beaker.rb

@@ -19,6 +19,9 @@ module PuppetMetadata
     # 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
@@ -52,34 +55,69 @@ module PuppetMetadata
       #   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
+      # @param [Optional[Hash]] hosts
+      #   Key: hostname, Value: roles (roles string as defined by beaker-hostgenerator )
+      #   Override the automatically generated hostname and optionally add roles
+      #   If more than one entry this will generate multiple hosts in the setfile
+      #   The domain may still be set via the `domain` param.
       #
       # @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, domain: nil, puppet_version: nil)
+      def os_release_to_setfile(os, release, use_fqdn: false, pidfile_workaround: false, domain: nil, puppet_version: nil, hosts: nil)
         return unless os_supported?(os)
 
         aos = adjusted_os(os)
-
         name = "#{aos}#{release.tr('.', '')}-64"
-        hostname = (puppet_version.nil? && puppet_version != 'none') ? name : "#{name}-#{puppet_version}"
+        human_name = "#{os} #{release}"
         domain ||= 'example.com' if use_fqdn
 
-        options = {}
-        options[:hostname] = "#{hostname}.#{domain}" if domain
+        hosts_settings = []
+        if hosts
+          hosts.each do |hostname, roles|
+            hosts_settings << {
+              'name' => if roles
+                          name + roles
+                        elsif hosts.size > 1
+                          hosts_settings.empty? ? "#{name}.ma" : "#{name}.a"
+                        else
+                          name
+                        end,
+              'hostname' => ((puppet_version.nil? || puppet_version == 'none') ? hostname : "#{hostname}-#{puppet_version}") + (domain ? ".#{domain}" : ''),
+            }
+          end
+        else
+          hosts_settings << {
+            'name' => name,
+            'hostname' => if puppet_version && puppet_version != 'none'
+                            "#{name}-#{puppet_version}" + (domain ? ".#{domain}" : '')
+                          elsif domain
+                            name + (domain ? ".#{domain}" : '')
+                          else
+                            ''
+                          end,
+          }
+        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))
-            options[:image] = image
+            image_to_use = image
           end
         end
 
-        human_name = "#{os} #{release}"
+        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
 
-        [build_setfile(name, options), human_name]
+        [setfile_parts.join('-'), human_name]
       end
 
       # Return whether a Beaker setfile can be generated for the given OS

data/lib/puppet_metadata/github_actions.rb

@@ -144,6 +144,7 @@ module PuppetMetadata
         pidfile_workaround: options[:beaker_pidfile_workaround],
         domain: options[:domain],
         puppet_version: puppet_collection,
+        hosts: options[:beaker_hosts],
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement