puppet_metadata 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b9da6033c7aa055e1e88289211ad3356764ea737184fd594fce1c31e1e94c27
-  data.tar.gz: 8fdfd523619505b15568769eb276424cffcc5c257c3a08377ee8a7abd8571701
+  metadata.gz: 9c9d6561f0093dee6ac521a50bfd507ab2695e192530bb5fdd28dd5264009af3
+  data.tar.gz: 688205c5b0991c110f288b2acaa54048c6866eeb2f4ced9d392b87e5ddbad535
 SHA512:
-  metadata.gz: 574fb26918bdd3c5b7a7ccad604557cb130797f704c87102d552fe3ef5a121acd15d4be22ba67bd273ba3d0d35a4c5b44c1ed8fe48e09b019da3785f9a149a9f
-  data.tar.gz: fcf0a1b46a59fdfbd3f6269f430495a63acbfc387c187658b25b4466fd8c0a0b5835cf221a5f6b7fcfdcd8f15208ab28141815edb8701666f9cefc47a422f99b
+  metadata.gz: 1dfc8d32b372c913d9a86937328f131647f487d546e22cd105547788f3af3396b36049c0c350ee4802baa19d90c00d230acf3bccd6fd8a499170eccb91ec4440
+  data.tar.gz: d87f9a1be70d013480f72e319f4a9c8179157eb2425bf1be6ae4acafbe5d908a5ed5aa0cfa67bfb33204087a27b3844a0d1f56d0dab408ffa183beccb45981ed

data/README.md

@@ -1,3 +1,119 @@
 # puppet_metadata
 
+[![License](https://img.shields.io/github/license/voxpupuli/puppet_metadata.svg)](https://github.com/voxpupuli/puppet_metadata/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet_metadata/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet_metadata/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/puppet_metadata/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/puppet_metadata)
+[![Release](https://github.com/voxpupuli/puppet_metadata/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet_metadata/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet_metadata.svg)](https://rubygems.org/gems/puppet_metadata)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet_metadata.svg)](https://rubygems.org/gems/puppet_metadata)
+[![Donated by Ewoud Kohl van Wijngaarden](https://img.shields.io/badge/donated%20by-Ewoud%20Kohl%20van%20Wijngaarden-fb7047.svg)](#copyright)
+
 The gem intends to provide an abstraction over Puppet's metadata.json file. Its API allow easy iteration over its illogical data structures.
+
+## Generating Github Actions outputs
+
+To get outputs [usable in Github Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions), there is the `metadata2gha` command available. This generates based on metadata.json, such as [Beaker](https://github.com/voxpupuli/beaker) setfiles, Puppet major versions and a Puppet unit test matrix.
+
+```console
+$ metadata2gha-beaker
+::set-output name=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"}]
+::set-output name=puppet_major_versions::[{"name":"Puppet 6","value":6,"collection":"puppet6"},{"name":"Puppet 5","value":5,"collection":"puppet5"}]
+::set-output name=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
+[
+  {
+    "name": "Puppet 6",
+    "value": 6,
+    "collection": "puppet6"
+  },
+  {
+    "name": "Puppet 5",
+    "value": 5,
+    "collection": "puppet5"
+  }
+]
+```
+
+Puppet unit test matrix formatted for readability:
+```json
+[
+  {
+    "puppet": 6,
+    "ruby": "2.5"
+  },
+  {
+    "puppet": 5,
+    "ruby": "2.4"
+  }
+]
+```
+
+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).
+
+```console
+$ metadata2gha --use-fqdn --pidfile-workaround true /path/to/metadata.json
+```
+
+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": "Debian 10",
+    "value": "debian10-64{hostname=debian10-64.example.com}"
+  },
+  {
+    "name": "Ubuntu 18.04",
+    "value": "ubuntu1804-64{hostname=ubuntu1804-64.example.com}"
+  }
+]
+```
+
+It is also possible to specify a comma separated list of operating systems as used in `metadata.json` (`CentOS,Ubuntu`).
+
+## Transfer Notice
+
+This plugin was originally authored by [Ewoud Kohl van Wijngaarden](https://github.com/ekohl).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org/) take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred, please fork and continue to contribute [here](https://github.com/voxpupuli/puppet_metadata).
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## Release information
+
+To make a new release, please do:
+* Update the version in the puppet_metadata.gemspec file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Create a PR with it
+* After it got merged, push a tag. A github workflow will do the actual release

data/bin/metadata2gha

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'json'
+require 'puppet_metadata'
+
+PidfileWorkaround = Object.new
+
+options = {}
+OptionParser.new do |opts|
+  opts.accept(PidfileWorkaround) do |value|
+    case value
+    when 'true'
+      true
+    when 'false'
+      false
+    else
+      value.split(',')
+    end
+  end
+
+  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)
+
+filename = ARGV[0]
+if filename.nil? || filename.empty?
+  filename = 'metadata.json'
+end
+
+begin
+  metadata = PuppetMetadata.read(filename)
+rescue StandardError => e
+  STDERR.puts "Failed to read #{filename}: #{e}"
+  exit 2
+end
+
+metadata.github_actions.outputs(beaker_use_fqdn: options[:'use-fqdn'], beaker_pidfile_workaround: options[:'pidfile-workaround']).each do |name, value|
+  puts "::set-output name=#{name}::#{value.to_json}"
+end

data/lib/puppet_metadata.rb

@@ -1,6 +1,8 @@
 # A module that provides abstractions around Puppet's metadata format.
 module PuppetMetadata
+  autoload :AIO, 'puppet_metadata/aio'
   autoload :Beaker, 'puppet_metadata/beaker'
+  autoload :GithubActions, 'puppet_metadata/github_actions'
   autoload :Metadata, 'puppet_metadata/metadata'
   autoload :OperatingSystem, 'puppet_metadata/operatingsystem'
 

data/lib/puppet_metadata/aio.rb

@@ -0,0 +1,58 @@
+module PuppetMetadata
+  class AIO 
+    COMPATIBLE = {
+      'AlmaLinux'   => 'RedHat',
+      'Amazon'      => 'RedHat',
+      'CentOS'      => 'RedHat',
+      'OracleLinux' => 'RedHat',
+      'Rocky'       => 'RedHat',
+      'Scientific'  => 'RedHat',
+    }
+
+    BUILDS = { 
+      # RPM-based
+      'RedHat' => {
+        '5' => 5..7,
+        '6' => 5..7,
+        '7' => 5..7,
+        '8' => 5..7,
+      },
+      'Fedora' => {
+        '26' => [5],
+        '27' => 5..6,
+        '28' => 5..6,
+        '29' => 5..6,
+        '30' => 5..7,
+        '31' => 5..7,
+        '32' => 6..7,
+        '34' => 6..7,
+      },
+      'SLES' => {
+        '11' => [7],
+        '12' => [7],
+        '15' => [7],
+      },
+      # deb-based
+      'Debian' => {
+        '7' => [5],
+        '8' => 5..7,
+        '9' => 5..7,
+        '10' => 5..7,
+      },
+      'Ubuntu' => {
+        '14.04' => 5..6,
+        '16.04' => 5..7,
+        '18.04' => 5..7,
+        '20.04' => 6..7,
+      },
+    }
+
+    def self.find_base_os(os)
+      COMPATIBLE.fetch(os, os)
+    end
+
+    def self.has_aio_build?(os, release, puppet_version)
+      BUILDS.dig(find_base_os(os), release)&.include?(puppet_version)
+    end
+  end
+end

data/lib/puppet_metadata/beaker.rb

@@ -12,13 +12,16 @@ module PuppetMetadata
     # @param [String] release The OS release
     # @param [Boolean] use_fqdn
     #   Whether or not to use a FQDN, ensuring a domain
-    # @param [Boolean] pidfile_workaround
+    # @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.
     #
-    # @return [String] The beaker setfile description or nil
+    # @return [nil] If no setfile is available
+    # @return [Array<(String, String)>] The beaker setfile description with a readable name
     def self.os_release_to_setfile(os, release, use_fqdn: false, pidfile_workaround: false)
       return unless os_supported?(os)
 
@@ -26,12 +29,20 @@ module PuppetMetadata
 
       options = {}
       options[:hostname] = "#{name}.example.com" if use_fqdn
+
       # Docker messes up cgroups and modern systemd can't deal with that when
       # PIDFile is used.
-      if pidfile_workaround
+      if pidfile_workaround && (!pidfile_workaround.is_a?(Array) || pidfile_workaround.include?(os))
         case os
         when 'CentOS'
-          options[:image] = 'centos:7.6.1810' if release == '7'
+          case release
+          when '7'
+            options[:image] = 'centos:7.6.1810'
+          when '8'
+            # There is no CentOS 8 image that works with PIDFile in systemd
+            # unit files
+            return
+          end
         when 'Ubuntu'
           options[:image] = 'ubuntu:xenial-20191212' if release == '16.04'
         end
@@ -39,7 +50,10 @@ module PuppetMetadata
 
       setfile = name
       setfile += "{#{options.map { |key, value| "#{key}=#{value}" }.join(',')}}" if options.any?
-      setfile
+
+      human_name = "#{os} #{release}"
+
+      [setfile, human_name]
     end
 
     # Return whether a Beaker setfile can be generated for the given OS

data/lib/puppet_metadata/github_actions.rb

@@ -0,0 +1,94 @@
+module PuppetMetadata
+  class GithubActions
+    attr_reader :metadata
+
+    # @param [PuppetMetadata::Metadata] metadata
+    def initialize(metadata)
+      @metadata = metadata
+    end
+
+    # @return [Hash[Symbol, Any]] The outputs for Github Actions
+    def outputs(beaker_use_fqdn: false, beaker_pidfile_workaround: false)
+      {
+        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,
+      }
+    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|
+        {
+          name: "Puppet #{version}",
+          value: version,
+          collection: "puppet#{version}",
+        }
+      end
+    end
+
+    def puppet_unit_test_matrix
+      metadata.puppet_major_versions.sort.reverse.map do |puppet|
+        ruby = puppet_ruby_version(puppet)
+        next unless ruby
+
+        {
+          puppet: puppet,
+          ruby: ruby,
+        }
+      end.compact
+    end
+
+    def puppet_ruby_version(puppet_version)
+      case puppet_version
+      when 4
+        '2.1'
+      when 5
+        '2.4'
+      when 6
+        '2.5'
+      when 7
+        '2.7'
+      end
+    end
+
+
+    def github_action_test_matrix(use_fqdn: false, pidfile_workaround: false)
+      matrix_include = []
+
+      metadata.operatingsystems.each do |os, releases|
+        releases&.each do |release|
+          puppet_major_versions.each do |puppet_version|
+            next unless AIO.has_aio_build?(os, release, puppet_version[:value])
+
+            setfile = PuppetMetadata::Beaker.os_release_to_setfile(os, release, use_fqdn: use_fqdn, pidfile_workaround: pidfile_workaround)
+            next unless setfile
+
+            matrix_include << {
+              setfile: {
+                name: setfile[1],
+                value: setfile[0],
+              },
+              puppet: puppet_version
+            }
+          end
+        end
+      end
+
+      matrix_include
+    end
+  end
+end

data/lib/puppet_metadata/metadata.rb

@@ -135,6 +135,21 @@ module PuppetMetadata
       matches?(requirements[name], version)
     end
 
+    # @return [Array[Integer]] Supported major Puppet versions
+    # @see #requirements
+    def puppet_major_versions
+      requirement = requirements['puppet']
+      raise Exception, 'No Puppet requirement found' unless requirement
+
+      # Current latest major is 7. It is highly recommended that modules
+      # actually specify exact bounds, but this prevents an infinite loop.
+      end_major = requirement.end == SemanticPuppet::Version::MAX ? 7 : requirement.end.major
+
+      (requirement.begin.major..end_major).select do |major|
+        requirement.include?(SemanticPuppet::Version.new(major, 0, 0)) || requirement.include?(SemanticPuppet::Version.new(major, 99, 99))
+      end
+    end
+
     # A hash representation of the dependencies
     #
     # Every element in the original array is converted. The name is used as a
@@ -167,6 +182,11 @@ module PuppetMetadata
       matches?(dependencies[name], version)
     end
 
+    # @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

metadata

@@ -1,30 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 - Ewoud Kohl van Wijngaarden
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: semantic_puppet
   requirement: !ruby/object:Gem::Requirement
@@ -112,21 +118,25 @@ dependencies:
 description: A package that provides abstractions for the Puppet Metadata
 email:
 - voxpupuli@groups.io
-executables: []
+executables:
+- metadata2gha
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
 - README.md
+- bin/metadata2gha
 - lib/puppet_metadata.rb
+- lib/puppet_metadata/aio.rb
 - lib/puppet_metadata/beaker.rb
+- lib/puppet_metadata/github_actions.rb
 - lib/puppet_metadata/metadata.rb
 - lib/puppet_metadata/operatingsystem.rb
 homepage: http://github.com/voxpupuli/puppet_metadata
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
@@ -143,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: Data structures for the Puppet Metadata
 test_files: []