choria-mcorpc-support 2.20.6 → 2.20.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29d095eecde9726e77979a330ff4ed2a27ac7912
-  data.tar.gz: a6aa7aa304f84aa576e711e40184d492c245295e
+  metadata.gz: '069a8ceae281b1be5fc39b924c2b95c3fddb8242'
+  data.tar.gz: 97d52bf4968e7acc2c3534c74bc84e2ff75c0f27
 SHA512:
-  metadata.gz: da30c83fef47986f8acb747d284ace2ecc736cfd9f7045b938c51684c801837080b346dbcdde7ca27a692e00181bb4b616af1d172457312217d26bd0d113bc92
-  data.tar.gz: ad9ca3e3fc6e99bad8eafd7a97764519d0e490644d9b80c39933b020d26c1f307ba4891e34d63bf8d79ac207533981dfa6a2a1bc201a99bb9ce9c4798747758c
+  metadata.gz: 2d5810c5b35911eba73e85086caa5764efbfb0d9b77aa504bf64ad538a35da7a0f40552d6dc3a6e43e6f41420684f83f27922b1f8d33018b8b439ac0ecaee670
+  data.tar.gz: a69247825c9d2cc0c598f01ac46832ef02508522ca69a6fc886bed37866ad8652562b683a3f25901c5a8ea6feadf38a3af93d7a948ae018e96050a03c93541a4

data/lib/mcollective.rb

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

data/lib/mcollective/ddl/agentddl.rb

@@ -37,7 +37,7 @@ module MCollective
     #         aggregate summary(:value)
     #     end
     # end
-    class AgentDDL<Base
+    class AgentDDL < Base
       def initialize(plugin, plugintype=:agent, loadddl=true)
         @process_aggregate_functions = nil
 
@@ -65,18 +65,18 @@ module MCollective
       def summarize(&block)
         unless @config.mode == :server
           @process_aggregate_functions = true
-          block.call
+          yield
           @process_aggregate_functions = nil
         end
       end
 
       # Sets the aggregate array for the given action
-      def aggregate(function, format = {:format => nil})
+      def aggregate(function, format={:format => nil})
         raise(DDLValidationError, "Formats supplied to aggregation functions should be a hash") unless format.is_a?(Hash)
         raise(DDLValidationError, "Formats supplied to aggregation functions must have a :format key") unless format.keys.include?(:format)
         raise(DDLValidationError, "Functions supplied to aggregate should be a hash") unless function.is_a?(Hash)
 
-        unless (function.keys.include?(:args)) && function[:args]
+        unless function.keys.include?(:args) && function[:args]
           raise DDLValidationError, "aggregate method for action '%s' missing a function parameter" % entities[@current_entity][:action]
         end
 
@@ -133,7 +133,7 @@ module MCollective
         # we set @current_entity so the input block can know what its talking
         # to, this is probably an epic hack, need to improve.
         @current_entity = name
-        block.call if block_given?
+        yield if block_given?
         @current_entity = nil
       end
 
@@ -141,11 +141,13 @@ module MCollective
       # with args as a hash.  This will only be active if the @process_aggregate_functions
       # is set to true which only happens in the #summarize block
       def method_missing(name, *args, &block)
-        unless @process_aggregate_functions || is_function?(name)
-          raise NoMethodError, "undefined local variable or method `#{name}'", caller
-        end
+        super unless @process_aggregate_functions || is_function?(name)
+
+        {:function => name, :args => args}
+      end
 
-        return {:function => name, :args => args}
+      def respond_to_missing?(method, *)
+        @process_aggregate_functions || is_function?(name) || super
       end
 
       # Checks if a method name matches a aggregate plugin.
@@ -169,7 +171,7 @@ module MCollective
 
         return unless input
 
-        input.keys.each do |key|
+        input.each_key do |key|
           if key.is_a?(Symbol) && arguments.include?(key.to_s) && !input.include?(key.to_s)
             compat_arg = key.to_s
           else
@@ -228,7 +230,7 @@ module MCollective
         input = action_interface(action)[:input] || {}
         compatible_args = symbolize_basic_input_arguments(input, arguments)
 
-        input.keys.each do |key|
+        input.each_key do |key|
           unless input[key][:optional]
             unless compatible_args.include?(key)
               raise DDLValidationError, "Action #{action} needs a #{key} argument"

data/lib/mcollective/ddl/base.rb

@@ -42,7 +42,7 @@ module MCollective
       # the config dir and if that does not exist, default to
       # /etc/mcollective
       def help(template=nil)
-        template = template_for_plugintype unless template
+        template ||= template_for_plugintype
         template = Util.templatepath(template) unless Util.absolute_path?(template)
 
         template = File.read(template)
@@ -52,14 +52,15 @@ module MCollective
         unless template == "metadata-help.erb"
           metadata_template = Util.templatepath("metadata-help.erb")
           metadata_template = File.read(metadata_template)
-          metastring = ERB.new(metadata_template, 0, '%')
+          metastring = ERB.new(metadata_template, 0, "%")
           metastring = metastring.result(binding)
         end
 
-        erb = ERB.new(template, 0, '%')
+        erb = ERB.new(template, 0, "%")
         erb.result(binding)
       end
 
+      # rubocop:disable Lint/DuplicateMethods, Style/TrivialAccessors
       def usage(usage_text)
         @usage = usage_text
       end
@@ -67,13 +68,13 @@ module MCollective
       def template_for_plugintype
         case @plugintype
         when :agent
-          return "rpc-help.erb"
+          "rpc-help.erb"
         else
-          if File.exists?(Util.templatepath("#{@plugintype}-help.erb"))
-            return "#{@plugintype}-help.erb"
+          if File.exist?(Util.templatepath("#{@plugintype}-help.erb"))
+            "#{@plugintype}-help.erb"
           else
             # Default help template gets loaded if plugintype-help does not exist.
-            return "metadata-help.erb"
+            "metadata-help.erb"
           end
         end
       end
@@ -91,8 +92,8 @@ module MCollective
       end
 
       def findddlfile(ddlname=nil, ddltype=nil)
-        ddlname = @pluginname unless ddlname
-        ddltype = @plugintype unless ddltype
+        ddlname ||= @pluginname
+        ddltype ||= @plugintype
 
         @config.libdir.each do |libdir|
           ddlfile = File.join([libdir, "mcollective", ddltype.to_s, "#{ddlname}.ddl"])
@@ -170,17 +171,17 @@ module MCollective
                                                :optional => properties[:optional]}
 
         case properties[:type]
-          when :string
-            raise "Input type :string needs a :validation argument" unless properties.include?(:validation)
-            raise "Input type :string needs a :maxlength argument" unless properties.include?(:maxlength)
+        when :string
+          raise "Input type :string needs a :validation argument" unless properties.include?(:validation)
+          raise "Input type :string needs a :maxlength argument" unless properties.include?(:maxlength)
 
-            @entities[entity][:input][argument][:validation] = properties[:validation]
-            @entities[entity][:input][argument][:maxlength] = properties[:maxlength]
+          @entities[entity][:input][argument][:validation] = properties[:validation]
+          @entities[entity][:input][argument][:maxlength] = properties[:maxlength]
 
-          when :list
-            raise "Input type :list needs a :list argument" unless properties.include?(:list)
+        when :list
+          raise "Input type :list needs a :list argument" unless properties.include?(:list)
 
-            @entities[entity][:input][argument][:list] = properties[:list]
+          @entities[entity][:input][argument][:list] = properties[:list]
         end
       end
 
@@ -206,7 +207,7 @@ module MCollective
 
         valid_requirements = [:mcollective]
 
-        requirement.keys.each do |key|
+        requirement.each_key do |key|
           unless valid_requirements.include?(key)
             raise "Requirement %s is not a valid requirement, only %s is supported" % [key, valid_requirements.join(", ")]
           end

data/lib/mcollective/ddl/dataddl.rb

@@ -27,17 +27,17 @@ module MCollective
     #              :display_as => item.to_s.capitalize
     #     end
     # end
-    class DataDDL<Base
+    class DataDDL < Base
       def dataquery(input, &block)
         raise "Data queries need a :description" unless input.include?(:description)
         raise "Data queries can only have one definition" if @entities[:data]
 
-        @entities[:data]  = {:description => input[:description],
-                             :input => {},
-                             :output => {}}
+        @entities[:data] = {:description => input[:description],
+                            :input => {},
+                            :output => {}}
 
         @current_entity = :data
-        block.call if block_given?
+        yield if block_given?
         @current_entity = nil
       end
 

data/lib/mcollective/ddl/discoveryddl.rb

@@ -13,7 +13,7 @@ module MCollective
     # discovery do
     #     capabilities [:classes, :facts, :identity, :agents, :compound]
     # end
-    class DiscoveryDDL<Base
+    class DiscoveryDDL < Base
       def discovery_interface
         @entities[:discovery]
       end
@@ -44,7 +44,7 @@ module MCollective
         @entities[:discovery] = {:capabilities => []}
 
         @current_entity = :discovery
-        block.call if block_given?
+        yield if block_given?
         @current_entity = nil
       end
     end

data/lib/mcollective/ddl/validatorddl.rb

@@ -1,6 +1,6 @@
 module MCollective
   module DDL
-    class ValidatorDDL<Base
+    class ValidatorDDL < Base
     end
   end
 end

data/lib/mcollective/pluginpackager/agent_definition.rb

@@ -16,7 +16,7 @@ module MCollective
         @dependencies = configuration[:dependency] || []
         @target_path = File.expand_path(@path)
         @metadata, mcversion = PluginPackager.get_metadata(@path, "agent")
-        @mcname = mcdependency[:mcname] ||  "mcollective"
+        @mcname = mcdependency[:mcname] || "mcollective"
         @mcversion = mcdependency[:mcversion] || mcversion
         @metadata[:version] = (configuration[:version] || @metadata[:version])
         @dependencies << {:name => "#{@mcname}-common", :version => @mcversion}
@@ -38,19 +38,23 @@ module MCollective
       def agent
         agent = {
           :files => [],
+          :executable_files => [],
           :dependencies => @dependencies.clone,
           :description => "Agent plugin for #{@metadata[:name]}"
         }
 
         agentdir = File.join(@path, "agent")
 
-        if (PluginPackager.check_dir_present(agentdir))
-          ddls = Dir.glob(File.join(agentdir, "*.ddl"))
-          agent[:files] = (Dir.glob(File.join(agentdir, "**", "**")) - ddls)
-        else
-          return nil
-        end
+        return nil unless PluginPackager.check_dir_present(agentdir)
+
+        ddls = Dir.glob(File.join(agentdir, "*.{ddl,json}"))
+        agent[:files] = (Dir.glob(File.join(agentdir, "**", "**")) - ddls)
         agent[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common", :version => @metadata[:version], :revision => @revision}
+
+        if @metadata[:provider] == "external"
+          agent[:executable_files] << File.join(agentdir, @metadata[:name])
+        end
+
         agent
       end
 
@@ -72,14 +76,14 @@ module MCollective
       # Obtain common package files and dependencies.
       def common
         common = {
-          :files =>[],
+          :files => [],
           :dependencies => @dependencies.clone,
           :description => "Common libraries for #{@metadata[:name]}"
         }
 
         datadir = File.join(@path, "data", "**")
         utildir = File.join(@path, "util", "**", "**")
-        ddldir = File.join(@path, "agent", "*.ddl")
+        ddldir = File.join(@path, "agent", "*.{ddl,json}")
         validatordir = File.join(@path, "validator", "**")
 
         [datadir, utildir, validatordir, ddldir].each do |directory|
@@ -88,9 +92,11 @@ module MCollective
 
         # We fail if there is no ddl file present
         if common[:files].grep(/^.*\.ddl$/).empty?
-          raise "cannot create package - No ddl file found in #{File.join(@path, "agent")}"
+          raise "cannot create package - No ddl file found in #{File.join(@path, 'agent')}"
         end
 
+        common[:files].uniq!
+
         common[:files].empty? ? nil : common
       end
     end

data/lib/mcollective/pluginpackager/forge_packager.rb

@@ -3,11 +3,11 @@ require "yaml"
 module MCollective
   module PluginPackager
     class ForgePackager
-      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+      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', 'forge')
+        @module_template = module_template || File.join(File.dirname(__FILE__), "templates", "forge")
       end
 
       def which(cmd)
@@ -18,11 +18,11 @@ module MCollective
             return exe if File.executable?(exe) && !File.directory?(exe)
           end
         end
-        return nil
+        nil
       end
 
       def create_packages
-        assert_new_enough_puppet
+        assert_new_enough_pdk
         validate_environment
 
         begin
@@ -44,7 +44,7 @@ module MCollective
         ensure
           if @keep_artifacts
             puts("Keeping build artifacts")
-            puts("Build artifacts saved in %s" %  @tmpdir)
+            puts("Build artifacts saved in %s" % @tmpdir)
           else
             cleanup_tmpdirs
           end
@@ -81,7 +81,15 @@ module MCollective
       def filelist(type)
         @plugin.packagedata[type][:files].map do |file|
           file.gsub(/^\.\//, "") unless File.directory?(file)
-        end.compact
+        end.compact.uniq
+      rescue
+        []
+      end
+
+      def executablelist(type)
+        @plugin.packagedata[type][:executable_files].map do |file|
+          file.gsub(/^\.\//, "") unless File.directory?(file)
+        end.compact.uniq
       rescue
         []
       end
@@ -100,11 +108,12 @@ module MCollective
         {
           hierakey(:config_name) => @plugin.metadata[:name].downcase,
           hierakey(:common_files) => filelist(:common),
+          hierakey(:executable_files) => executablelist(:agent),
           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),
+          hierakey(:client_directories) => dirlist(:client)
         }.merge(module_override_data)
       end
 
@@ -123,7 +132,7 @@ module MCollective
       end
 
       def copy_module_files
-        @plugin.packagedata.each do |klass, data|
+        @plugin.packagedata.each_value do |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)))
@@ -142,13 +151,18 @@ module MCollective
             agent_name = File.basename(file, ".ddl")
             json_file = File.join(agent_dir, "%s.json" % agent_name)
 
+            if File.exist?(json_file)
+              Log.warn("JSON DDL %s already exist, not regenerating from the %s" % [json_file, agent_name])
+              next
+            end
+
             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" => [],
+              "actions" => []
             }
 
             ddl.actions.sort.each do |action|
@@ -165,7 +179,7 @@ module MCollective
       end
 
       def render_templates
-        templates = Dir.chdir(@module_template) do |path|
+        templates = Dir.chdir(@module_template) do |_path|
           Dir.glob("**/*.erb")
         end
 
@@ -177,69 +191,62 @@ module MCollective
       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
+        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
 
       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(" ")
+        raise("Vendor names may not have a space in them, please specify a valid vendor using --vendor") if @plugin.vendor.include?(" ")
       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
+      def pdk_path
+        pdk_bin = which("pdk")
+        pdk_bin ||= "/opt/puppetlabs/pdk/bin/pdk"
 
-        s = Shell.new("#{puppet_bin} --version")
+        pdk_bin
+      end
+
+      def assert_new_enough_pdk
+        s = Shell.new("#{pdk_path} --version")
         s.runcommand
         actual_version = s.stdout.chomp
-        required_version = '4.5.1'
+        required_version = "1.12.0"
 
         if Util.versioncmp(actual_version, required_version) < 0
-          raise("Cannot build package. puppet #{required_version} or greater required.  We have #{actual_version}.")
+          raise("Cannot build package. pdk #{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('pdk build --force')
-            end
+        PluginPackager.execute_verbosely(@verbose) do
+          Dir.chdir(@tmpdir) do
+            PluginPackager.safe_system("#{pdk_path} build --force")
           end
-        rescue
-          STDERR.puts("Build process has failed")
-          raise
         end
+      rescue
+        STDERR.puts("Build process has failed")
+        raise
       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
+        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
 
       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
+        FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+      rescue
+        STDERR.puts("Could not remove temporary build directory %s" % [@tmpdir])
+        raise
       end
     end
   end

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

@@ -6,6 +6,7 @@ class <%= module_name %> (
   Array[String] $server_directories = [],
   Array[String] $common_files = [],
   Array[String] $common_directories = [],
+  Array[String] $executable_files = [],
   Boolean $manage_gem_dependencies = true,
   Hash $gem_dependencies = {},
   Boolean $manage_package_dependencies = true,
@@ -26,6 +27,7 @@ class <%= module_name %> (
     client_files                => $client_files,
     server_files                => $server_files,
     common_files                => $common_files,
+    executable_files            => $executable_files,
     client_directories          => $client_directories,
     server_directories          => $server_directories,
     common_directories          => $common_directories,

data/lib/mcollective/validator/array_validator.rb

@@ -2,7 +2,7 @@ module MCollective
   module Validator
     class ArrayValidator
       def self.validate(validator, array)
-        raise ValidatorError, "value should be one of %s" % [ array.join(", ") ] unless array.include?(validator)
+        raise ValidatorError, "value should be one of %s" % [array.join(", ")] unless array.include?(validator)
       end
     end
   end

data/lib/mcollective/validator/ipv4address_validator.rb

@@ -1,15 +1,13 @@
 module MCollective
   module Validator
     class Ipv4addressValidator
-      require 'ipaddr'
+      require "ipaddr"
 
       def self.validate(validator)
-        begin
-          ip = IPAddr.new(validator)
-          raise ValidatorError, "value should be an ipv4 adddress" unless ip.ipv4?
-        rescue
-          raise ValidatorError, "value should be an ipv4 address"
-        end
+        ip = IPAddr.new(validator)
+        raise ValidatorError, "value should be an ipv4 adddress" unless ip.ipv4?
+      rescue
+        raise ValidatorError, "value should be an ipv4 address"
       end
     end
   end

data/lib/mcollective/validator/ipv6address_validator.rb

@@ -1,15 +1,13 @@
 module MCollective
   module Validator
     class Ipv6addressValidator
-      require 'ipaddr'
+      require "ipaddr"
 
       def self.validate(validator)
-        begin
-          ip = IPAddr.new(validator)
-          raise ValidatorError, "value should be an ipv6 adddress" unless ip.ipv6?
-        rescue
-          raise ValidatorError, "value should be an ipv6 address"
-        end
+        ip = IPAddr.new(validator)
+        raise ValidatorError, "value should be an ipv6 adddress" unless ip.ipv6?
+      rescue
+        raise ValidatorError, "value should be an ipv6 address"
       end
     end
   end

data/lib/mcollective/validator/shellsafe_validator.rb

@@ -4,7 +4,7 @@ module MCollective
       def self.validate(validator)
         raise ValidatorError, "value should be a String" unless validator.is_a?(String)
 
-        ['`', '$', ';', '|', '&&', '>', '<'].each do |chr|
+        ["`", "$", ";", "|", "&&", ">", "<"].each do |chr|
           raise ValidatorError, "value should not have #{chr} in it" if validator.match(Regexp.escape(chr))
         end
       end

data/lib/mcollective/validator/typecheck_validator.rb

@@ -2,25 +2,25 @@ module MCollective
   module Validator
     class TypecheckValidator
       def self.validate(validator, validation_type)
-        raise ValidatorError, "value should be a #{validation_type.to_s}" unless check_type(validator, validation_type)
+        raise ValidatorError, "value should be a #{validation_type}" unless check_type(validator, validation_type)
       end
 
       def self.check_type(validator, validation_type)
         case validation_type
-          when Class
-            validator.is_a?(validation_type)
-          when :integer
-            validator.is_a?(Integer)
-          when :float
-            validator.is_a?(Float)
-          when :number
-            validator.is_a?(Numeric)
-          when :string
-            validator.is_a?(String)
-          when :boolean
-            [TrueClass, FalseClass].include?(validator.class)
-          else
-            false
+        when Class
+          validator.is_a?(validation_type)
+        when :integer
+          validator.is_a?(Integer)
+        when :float
+          validator.is_a?(Float)
+        when :number
+          validator.is_a?(Numeric)
+        when :string
+          validator.is_a?(String)
+        when :boolean
+          [TrueClass, FalseClass].include?(validator.class)
+        else
+          false
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-mcorpc-support
 version: !ruby/object:Gem::Version
-  version: 2.20.6
+  version: 2.20.7
 platform: ruby
 authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu