puppet_metadata 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0637a24f15f5fbe1876402af082cfdb245d68683de8397dd11703cdc996788
-  data.tar.gz: 5ec9738ce657cc4dba65d4af0a4b40093acdd934fcf1d302001efae788633fdd
+  metadata.gz: 98140c70afa012445fc26f6db9b1f6f2a5b1fb58660d2d9c450c4f93bafc9b6d
+  data.tar.gz: 1078ef0d2c8d722ad76f2a9aae5160182ccbc50169a95e45989a48eadbc5abbc
 SHA512:
-  metadata.gz: 444af6b66b4dc964b254767c1f8fed67219e7e0d7e8504318700d50f3cca7e2cba367b32a75c871b36b1089a65af016322522086b6d0a197658f34b70f175520
-  data.tar.gz: 873eb62634fb24e2a904225ceb730e1349c8f216a475e530601b1724d7bc35ad08c6e34b9ef3afe38f5cfb8dabcb64bbaab74a04dbae75e7d8f323c6f40652c8
+  metadata.gz: 6382308409c4cf5043b0296ecef6242a1ff71a9e1682bdcb31906214dacc367c128f72ff2fb431dcb8d431b89f5a0123358c9e4e8319ea95c8359e26ce6b8141
+  data.tar.gz: cbef56666c77918ab1789ebe89bebaa54eb8fdde34c993ae82cb53bcd426154f252b12ff58c0efbfb695bc8f47a33066506615a147679f20df1a73705469fc47

data/README.md

@@ -1,3 +1,92 @@
 # puppet_metadata
 
 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`).

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,7 @@
 # A module that provides abstractions around Puppet's metadata format.
 module PuppetMetadata
   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/github_actions.rb

@@ -0,0 +1,67 @@
+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,
+      }
+    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
+  end
+end

data/lib/puppet_metadata/metadata.rb

@@ -135,6 +135,17 @@ 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
+
+      (requirement.begin.major..requirement.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 +178,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
@@ -112,14 +112,17 @@ 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/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