choria-mcorpc-support 2.20.4 → 2.20.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3f6b0f73405083156308dae503d0498332bc81c
-  data.tar.gz: 7c780d21ec775ddbc5b17640682be709a343c94b
+  metadata.gz: f2b40e519fe1594ef21f3842e4786bdfbe9359f1
+  data.tar.gz: ae87678ad14ba3d22805143c59c5558f271286c4
 SHA512:
-  metadata.gz: 70b7fb634326c07bf3940692641a4e66b734d2388647186d25080025f019c66ad39b07f4b7d60b90e6a8da7171f6f6dbfbb7f5f79aced3e146149f5cc94828be
-  data.tar.gz: de2c15f4c16831773119ce0c167d3a17f9b55aa9f3546e0a90b017353879b74b198fd50b65839f251d387c93f3247faf81941bd54c7de4c85958953038da8b8c
+  metadata.gz: 92c39adc948b47af880815b13597c4205a4e0dcb3058c82d5e2c8e762cc11a15b7ae15028093bf3a04e9f01458bde03e3a91b678b783fbb49875ea93bbc85786
+  data.tar.gz: e49b19a7e16acec11b619e1492ef6e7f3cadb819bf93ac0759889fa1032e53529e7432404b8a10cbde6e8152204e069372d493bf0c6ff908ce87684bfd3add8b

data/lib/mcollective.rb

@@ -54,7 +54,7 @@ module MCollective
   require "mcollective/util"
   require "mcollective/validator"
 
-  VERSION = "2.20.4".freeze
+  VERSION = "2.20.5".freeze
 
   def self.version
     VERSION

data/lib/mcollective/application/facts.rb

@@ -36,8 +36,9 @@ class MCollective::Application::Facts<MCollective::Application
 
     rpcutil.get_fact(:fact => configuration[:fact]) do |resp|
       begin
-        value = resp[:body][:data][:value]
-        if value
+        value = resp[:body][:data][:value].to_s
+
+        if resp[:body][:data].include?(:value)
           if facts.include?(value)
             facts[value] << resp[:senderid]
           else

data/lib/mcollective/application/plugin.rb

@@ -289,7 +289,7 @@ mco plugin package [options] <directory>
     # Creates the correct package plugin object.
     def prepare_plugin
       plugintype = set_plugin_type unless configuration[:plugintype]
-      configuration[:format] = "ospackage" unless configuration[:format]
+      configuration[:format] = "puppet_module" unless configuration[:format]
       PluginPackager.load_packagers
       plugin_class = PluginPackager[configuration[:plugintype]]
 

data/lib/mcollective/pluginpackager/puppet_module_packager.rb

@@ -0,0 +1,246 @@
+require "yaml"
+
+module MCollective
+  module PluginPackager
+    class PuppetmodulePackager
+      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+        @plugin = plugin
+        @verbose = verbose
+        @keep_artifacts = keep_artifacts
+        @module_template = module_template || File.join(File.dirname(__FILE__), 'templates', 'puppet_module')
+      end
+
+      def which(cmd)
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
+        end
+        return nil
+      end
+
+      def create_packages
+        assert_new_enough_puppet
+        validate_environment
+
+        begin
+          puts("Building Choria module %s" % module_name)
+
+          @tmpdir = Dir.mktmpdir("mcollective_packager")
+
+          make_module_dirs
+          copy_module_files
+          generate_agent_json_ddls
+          render_templates
+          copy_additional_files
+          run_build
+          move_package
+
+          puts("Completed building module for %s" % module_name)
+        rescue
+          STDERR.puts("Failed to build plugin module: %s: %s" % [$!.class, $!.to_s])
+        ensure
+          if @keep_artifacts
+            puts("Keeping build artifacts")
+            puts("Build artifacts saved in %s" %  @tmpdir)
+          else
+            cleanup_tmpdirs
+          end
+        end
+      end
+
+      def version
+        if Integer(@plugin.revision) > 1
+          "%s-%s" % [@plugin.metadata[:version], @plugin.revision]
+        else
+          @plugin.metadata[:version]
+        end
+      end
+
+      def module_name
+        "mcollective_%s_%s" % [
+          @plugin.plugintype.downcase,
+          @plugin.metadata[:name].downcase.gsub("-", "_")
+        ]
+      end
+
+      def module_file_name
+        "%s-%s-%s.tar.gz" % [@plugin.vendor, module_name, version]
+      end
+
+      def dirlist(type)
+        @plugin.packagedata[type][:files].map do |file|
+          file.gsub(/^\.\//, "") if File.directory?(file)
+        end.compact
+      rescue
+        []
+      end
+
+      def filelist(type)
+        @plugin.packagedata[type][:files].map do |file|
+          file.gsub(/^\.\//, "") unless File.directory?(file)
+        end.compact
+      rescue
+        []
+      end
+
+      def hierakey(var)
+        "%s::%s" % [module_name, var]
+      end
+
+      def module_override_data
+        YAML.safe_load(File.read(".plugin.yaml"))
+      rescue
+        {}
+      end
+
+      def plugin_hiera_data
+        {
+          hierakey(:config_name) => @plugin.metadata[:name].downcase,
+          hierakey(:common_files) => filelist(:common),
+          hierakey(:common_directories) => dirlist(:common),
+          hierakey(:server_files) => filelist(:agent),
+          hierakey(:server_directories) => dirlist(:agent),
+          hierakey(:client_files) => filelist(:client),
+          hierakey(:client_directories) => dirlist(:client),
+        }.merge(module_override_data)
+      end
+
+      def make_module_dirs
+        ["data", "manifests", "files/mcollective"].each do |dir|
+          FileUtils.mkdir_p(File.join(@tmpdir, dir))
+        end
+      end
+
+      def copy_additional_files
+        if File.exist?("puppet")
+          Dir.glob("puppet/*").each do |file|
+            FileUtils.cp_r(file, @tmpdir)
+          end
+        end
+      end
+
+      def copy_module_files
+        @plugin.packagedata.each do |klass, data|
+          data[:files].each do |file|
+            clean_dest_file = file.gsub("./lib/mcollective", "")
+            dest_dir = File.expand_path(File.join(@tmpdir, "files", "mcollective", File.dirname(clean_dest_file)))
+
+            FileUtils.mkdir_p(dest_dir) unless File.directory?(dest_dir)
+            FileUtils.cp(file, dest_dir) if File.file?(file)
+          end
+        end
+      end
+
+      def generate_agent_json_ddls
+        agent_dir = File.expand_path(File.join(@tmpdir, "files", "mcollective", "agent"))
+
+        if File.directory?(agent_dir)
+          Dir.glob(File.join(agent_dir, "*.ddl")) do |file|
+            agent_name = File.basename(file, ".ddl")
+            json_file = File.join(agent_dir, "%s.json" % agent_name)
+
+            ddl = DDL.new(agent_name, :agent, false)
+            ddl.instance_eval(File.read(file))
+
+            data = {
+              "$schema" => "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
+              "metadata" => ddl.meta,
+              "actions" => [],
+            }
+
+            ddl.actions.sort.each do |action|
+              data["actions"] << ddl.action_interface(action)
+            end
+
+            File.open(json_file, "w") do |jddl|
+              jddl.print(JSON.pretty_generate(data))
+            end
+
+            @plugin.packagedata[:common][:files] << "agent/%s.json" % agent_name
+          end
+        end
+      end
+
+      def render_templates
+        templates = Dir.chdir(@module_template) do |path|
+          Dir.glob("**/*.erb")
+        end
+
+        templates.each do |template|
+          infile = File.join(@module_template, template)
+          outfile = File.join(@tmpdir, template.gsub(/\.erb$/, ""))
+          render_template(infile, outfile)
+        end
+      end
+
+      def render_template(infile, outfile)
+        begin
+          erb = ERB.new(File.read(infile), nil, "-")
+          File.open(outfile, "w") do |f|
+            f.puts erb.result(binding)
+          end
+        rescue
+          STDERR.puts("Could not render template %s to %s" % [infile, outfile])
+          raise
+        end
+      end
+
+      def validate_environment
+        raise("Supplying a vendor is required, please use --vendor") if @plugin.vendor == "Puppet Labs"
+        raise("Vendor names may not have a space in them, please specify a valid vendor using --vendor") if @plugin.vendor.match(" ")
+      end
+
+      def assert_new_enough_puppet
+        puppet_bin = which("puppet")
+        puppet_bin = "/opt/puppetlabs/bin/puppet" if !puppet_bin
+        if !puppet_bin
+          raise("Cannot build package. 'puppet' not found on path, and '/opt/puppetlabs/bin/puppet' is not present on the system.")
+        end
+
+        s = Shell.new("#{puppet_bin} --version")
+        s.runcommand
+        actual_version = s.stdout.chomp
+        required_version = '4.5.1'
+
+        if Util.versioncmp(actual_version, required_version) < 0
+          raise("Cannot build package. puppet #{required_version} or greater required.  We have #{actual_version}.")
+        end
+      end
+
+      def run_build
+        begin
+          PluginPackager.execute_verbosely(@verbose) do
+            Dir.chdir(@tmpdir) do
+              PluginPackager.safe_system('puppet module build')
+            end
+          end
+        rescue
+          STDERR.puts("Build process has failed")
+          raise
+        end
+      end
+
+      def move_package
+        begin
+          package_file = File.join(@tmpdir, "pkg", module_file_name)
+          FileUtils.cp(package_file, ".")
+        rescue
+          STDERR.puts("Could not copy package to working directory")
+          raise
+        end
+      end
+
+      def cleanup_tmpdirs
+        begin
+          FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+        rescue
+          STDERR.puts("Could not remove temporary build directory %s" % [@tmpdir])
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/pluginpackager/templates/puppet_module/README.md.erb

@@ -0,0 +1,72 @@
+# <%= module_name %> version <%= @plugin.metadata[:version] %>
+
+#### Table of Contents
+
+1. [Overview](#overview)
+1. [Usage](#usage)
+1. [Configuration](#configuration)
+
+## Overview
+
+<%= @plugin.metadata[:description] %>
+
+The <%= module_name %> module is generated automatically, based on the source from <%= @plugin.metadata[:url] %>.
+<%- if @plugin.plugintype == "Agent" -%>
+<%-
+      ddl = DDL.new("package", :agent, false)
+      ddl.instance_eval(File.read(Dir.glob(File.join("**/agent/*.ddl")).first))
+-%>
+
+Available Actions:
+
+<%-   ddl.entities.keys.sort.each do |action| -%>
+  * **<%= action %>** - <%= ddl.entities[action][:description] %>
+<%-   end -%>
+<%- end -%>
+
+## Usage
+
+You can include this module into your infrastructure as any other module, but as it's designed to work with the [choria mcollective](http://forge.puppet.com/choria/mcollective) module you can configure it via Hiera:
+
+```yaml
+mcollective::plugin_classes:
+  - <%= module_name %>
+```
+
+## Configuration
+
+Server and Client configuration can be added via Hiera and managed through tiers in your site Hiera, they will be merged with any included in this module
+
+```yaml
+<%= module_name %>::config:
+   example: value
+```
+
+This will be added to both the `client.cfg` and `server.cfg`, you can likewise configure server and client specific settings using `<%= module_name %>::client_config` and `<%= module_name %>::server_config`.
+
+These settings will be added to the `/etc/puppetlabs/mcollective/plugin.d/` directory in individual files.
+
+For a full list of possible configuration settings see the module [source repository documentation](<%= @plugin.metadata[:url] %>).
+
+## Data Reference
+
+  * `<%= module_name %>::gem_dependencies` - Deep Merged Hash of gem name and version this module depends on
+  * `<%= module_name %>::manage_gem_dependencies` - disable managing of gem dependencies
+  * `<%= module_name %>::package_dependencies` - Deep Merged Hash of package name and version this module depends on
+  * `<%= module_name %>::manage_package_dependencies` - disable managing of packages dependencies
+  * `<%= module_name %>::class_dependencies` - Array of classes to include when installing this module
+  * `<%= module_name %>::package_dependencies` - disable managing of class dependencies
+  * `<%= module_name %>::config` - Deep Merged Hash of common config items for this module
+  * `<%= module_name %>::server_config` - Deep Merged Hash of config items specific to managed nodes
+  * `<%= module_name %>::client_config` - Deep Merged Hash of config items specific to client nodes
+  * `<%= module_name %>::policy_default` - `allow` or `deny`
+  * `<%= module_name %>::policies` - List of `actionpolicy` policies to deploy with an agent
+  * `<%= module_name %>::client` - installs client files when true - defaults to `$mcollective::client`
+  * `<%= module_name %>::server` - installs server files when true - defaults to `$mcollective::server`
+  * `<%= module_name %>::ensure` - `present` or `absent`
+
+## Development:
+
+To contribute to this MCollective plugin please visit <%= @plugin.metadata[:url] %>.
+
+This module was generated using the Choria Plugin Packager based on templates found at the [GitHub Project](https://github.com/choria-io/).

data/lib/mcollective/pluginpackager/templates/puppet_module/data/defaults.yaml.erb

@@ -0,0 +1,16 @@
+lookup_options:
+  <%= module_name %>::gem_dependencies:
+    merge:
+      strategy: deep
+  <%= module_name %>::package_dependencies:
+    merge:
+      strategy: deep
+  <%= module_name %>::config:
+    merge:
+      strategy: deep
+  <%= module_name %>::client_config:
+    merge:
+      strategy: deep
+  <%= module_name %>::server_config:
+    merge:
+      strategy: deep

data/lib/mcollective/pluginpackager/templates/puppet_module/data/plugin.yaml.erb

@@ -0,0 +1 @@
+<%= YAML.dump(plugin_hiera_data) %>

data/lib/mcollective/pluginpackager/templates/puppet_module/hiera.yaml.erb

@@ -0,0 +1,12 @@
+---
+version: 5
+
+defaults:
+  datadir: "data"
+  data_hash: yaml_data
+
+hierarchy:
+  - name: "plugin"
+    path: "plugin.yaml"
+  - name: "defaults"
+    path: "defaults.yaml"

data/lib/mcollective/pluginpackager/templates/puppet_module/manifests/init.pp.erb

@@ -0,0 +1,46 @@
+class <%= module_name %> (
+  String $config_name,
+  Array[String] $client_files = [],
+  Array[String] $client_directories = [],
+  Array[String] $server_files = [],
+  Array[String] $server_directories = [],
+  Array[String] $common_files = [],
+  Array[String] $common_directories = [],
+  Boolean $manage_gem_dependencies = true,
+  Hash $gem_dependencies = {},
+  Boolean $manage_package_dependencies = true,
+  Hash $package_dependencies = {},
+  Boolean $manage_class_dependencies = true,
+  Array[String] $class_dependencies = [],
+  Mcollective::Policy_action $policy_default = $mcollective::policy_default,
+  Array[Mcollective::Policy] $policies = [],
+  Hash $config = {},
+  Hash $client_config = {},
+  Hash $server_config = {},
+  Boolean $client = $mcollective::client,
+  Boolean $server = $mcollective::server,
+  Enum["present", "absent"] $ensure = "present"
+) {
+  mcollective::module_plugin{$name:
+    config_name                 => $config_name,
+    client_files                => $client_files,
+    server_files                => $server_files,
+    common_files                => $common_files,
+    client_directories          => $client_directories,
+    server_directories          => $server_directories,
+    common_directories          => $common_directories,
+    gem_dependencies            => $gem_dependencies,
+    manage_gem_dependencies     => $manage_gem_dependencies,
+    package_dependencies        => $package_dependencies,
+    manage_package_dependencies => $manage_package_dependencies,
+    class_dependencies          => $class_dependencies,
+    policy_default              => $policy_default,
+    policies                    => $policies,
+    config                      => $config,
+    client_config               => $client_config,
+    server_config               => $server_config,
+    client                      => $client,
+    server                      => $server,
+    ensure                      => $ensure
+  }
+}

data/lib/mcollective/pluginpackager/templates/puppet_module/metadata.json.erb

@@ -0,0 +1,19 @@
+{
+  "name": "<%= @plugin.vendor %>-<%= module_name %>",
+  "version": "<%= version %>",
+  "author": "<%= @plugin.metadata[:author] %>",
+  "license": "<%= @plugin.metadata[:license] %>",
+  "summary": "<%= @plugin.metadata[:description] %>",
+  "source": "<%= @plugin.metadata[:url] %>",
+  "project_page": "<%= @plugin.metadata[:url] %>",
+  "dependencies": [
+  {"name": "choria/mcollective", "version_requirement": ">= 0.4.0 < 2.0.0"}
+  ],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": ">= 4.9.0"
+    }
+  ]
+}
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-mcorpc-support
 version: !ruby/object:Gem::Version
-  version: 2.20.4
+  version: 2.20.5
 platform: ruby
 authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -138,6 +138,7 @@ files:
 - lib/mcollective/pluginpackager/debpackage_packager.rb
 - lib/mcollective/pluginpackager/modulepackage_packager.rb
 - lib/mcollective/pluginpackager/ospackage_packager.rb
+- lib/mcollective/pluginpackager/puppet_module_packager.rb
 - lib/mcollective/pluginpackager/rpmpackage_packager.rb
 - lib/mcollective/pluginpackager/standard_definition.rb
 - lib/mcollective/pluginpackager/templates/debian/Makefile.erb
@@ -149,6 +150,12 @@ files:
 - lib/mcollective/pluginpackager/templates/module/Modulefile.erb
 - lib/mcollective/pluginpackager/templates/module/README.md.erb
 - lib/mcollective/pluginpackager/templates/module/_manifest.pp.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/README.md.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/data/defaults.yaml.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/data/plugin.yaml.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/hiera.yaml.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/manifests/init.pp.erb
+- lib/mcollective/pluginpackager/templates/puppet_module/metadata.json.erb
 - lib/mcollective/pluginpackager/templates/redhat/rpm_spec.erb
 - lib/mcollective/registration/base.rb
 - lib/mcollective/rpc.rb