choria-mcorpc-support 2.20.5 → 2.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b40e519fe1594ef21f3842e4786bdfbe9359f1
-  data.tar.gz: ae87678ad14ba3d22805143c59c5558f271286c4
+  metadata.gz: c7838c880fe400df6a4ba9cc315b99f8e53cf5ed
+  data.tar.gz: eb1af548ab4d9f79abf4accb138d6aa6becbe620
 SHA512:
-  metadata.gz: 92c39adc948b47af880815b13597c4205a4e0dcb3058c82d5e2c8e762cc11a15b7ae15028093bf3a04e9f01458bde03e3a91b678b783fbb49875ea93bbc85786
-  data.tar.gz: e49b19a7e16acec11b619e1492ef6e7f3cadb819bf93ac0759889fa1032e53529e7432404b8a10cbde6e8152204e069372d493bf0c6ff908ce87684bfd3add8b
+  metadata.gz: 8e1a3b75838b504abc5e16cd6a4e653ccc70eba34a5c2fb40ac39ff4d764f5960a4535b5e6eace6ab28fc75d839c7b57f9c67613d3886f3d37364ae873878df4
+  data.tar.gz: b0dadeac2193e6a043a00e6bc90592485db8bfdf35563787e024457b248c391b7fe5628510af7cb7d3a0ddf455359cf148968c43db0d3cd80b304ea3f97fd9b6

data/lib/mcollective.rb

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

data/lib/mcollective/application/facts.rb

@@ -12,6 +12,8 @@ class MCollective::Application::Facts
   def show_single_fact_report(fact, facts, verbose=false)
     puts("Report for fact: #{fact}\n\n")
 
+    facts = stringify_facts_hash(facts)
+
     field_size = MCollective::Util.field_size(facts.keys)
     facts.keys.sort.each do |k|
       printf("        %-#{field_size}s found %d times\n", k, facts[k].size)
@@ -28,6 +30,12 @@ class MCollective::Application::Facts
     end
   end
 
+  def stringify_facts_hash(facts)
+    res = Hash.new([])
+    facts.each { |k, v| res[k.to_s] += v }
+    res
+  end
+
   def main
     rpcutil = rpcclient("rpcutil")
     rpcutil.progress = false

data/lib/mcollective/application/plugin.rb

@@ -213,7 +213,7 @@ mco plugin package [options]
     def load_plugin_ddl(plugin, type)
       [plugin, "#{plugin}_#{type}"].each do |p|
         ddl = DDL.new(p, type, false)
-        if ddl.findddlfile(p, type)
+        if ddl.client_activated? && ddl.findddlfile(p, type)
           ddl.loadddlfile
           return ddl
         end
@@ -224,9 +224,14 @@ mco plugin package [options]
 
     # Show application list and plugin help
     def doc_command
-      known_plugin_types = [["Agents", :agent], ["Aggregate", :aggregate],
-                            ["Connectors", :connector], ["Data Queries", :data],
-                            ["Discovery Methods", :discovery], ["Validator Plugins", :validator]]
+      known_plugin_types = [
+        ["Agents", :agent],
+        ["Aggregate", :aggregate],
+        ["Connectors", :connector],
+        ["Data Queries", :data],
+        ["Discovery Methods", :discovery],
+        ["Validator Plugins", :validator]
+      ]
 
       if configuration.include?(:target) && configuration[:target] != "."
         if configuration[:target] =~ /^(.+?)\/(.+)$/
@@ -265,7 +270,11 @@ mco plugin package [options]
 
           PluginManager.find(plugin_type[1], "ddl").each do |ddl|
             begin
-              help = DDL.new(ddl, plugin_type[1])
+              help = DDL.new(ddl, plugin_type[1], false)
+
+              next unless help.client_activated?
+
+              help.loadddlfile
               pluginname = ddl.gsub(/_#{plugin_type[1]}$/, "")
               puts "  %-25s %s" % [pluginname, help.meta[:description]]
             rescue => e
@@ -289,7 +298,7 @@ mco plugin package [options]
     # Creates the correct package plugin object.
     def prepare_plugin
       plugintype = set_plugin_type unless configuration[:plugintype]
-      configuration[:format] = "puppet_module" unless configuration[:format]
+      configuration[:format] = "forge" unless configuration[:format]
       PluginPackager.load_packagers
       plugin_class = PluginPackager[configuration[:plugintype]]
 
@@ -299,7 +308,10 @@ mco plugin package [options]
         configuration[:dependency].map!{|dep| {:name => dep, :version => nil}}
       end
 
-      mcdependency = {:mcname => configuration[:mcname], :mcversion => configuration[:mcversion]}
+      mcdependency = {
+        :mcname => configuration[:mcname],
+        :mcversion => configuration[:mcversion]
+      }
 
       # Deprecation warning for --iteration
       if configuration[:iteration]

data/lib/mcollective/applications.rb

@@ -10,7 +10,7 @@ module MCollective
 
       begin
         load_application(appname)
-      rescue Exception # rubocop:disable Lint/RescueException
+      rescue Exception => e # rubocop:disable Lint/RescueException
         e.backtrace.first << Util.colorize(:red, "  <----")
         STDERR.puts "Application '%s' failed to load:" % appname
         STDERR.puts
@@ -98,6 +98,7 @@ module MCollective
 
       # avoid option parsers own internal version handling that sux
       parser.on("-v", "--verbose")
+      parser.on("--version")
 
       if original_extra_opts
         begin

data/lib/mcollective/ddl/agentddl.rb

@@ -37,13 +37,17 @@ module MCollective
     #         aggregate summary(:value)
     #     end
     # end
-    class AgentDDL<Base
+    class AgentDDL < Base
       def initialize(plugin, plugintype=:agent, loadddl=true)
         @process_aggregate_functions = nil
 
         super
       end
 
+      def client_activated?
+        Util.str_to_bool(@config.pluginconf.fetch("%s.activate_client" % @pluginname, ACTIVATION_DEFAULT.to_s))
+      end
+
       def input(argument, properties)
         raise "Input needs a :optional property" unless properties.include?(:optional)
 
@@ -61,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
 
@@ -129,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
 
@@ -137,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.
@@ -165,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
@@ -224,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

@@ -19,6 +19,8 @@ module MCollective
     class Base
       attr_reader :meta, :entities, :pluginname, :plugintype, :usage, :requirements
 
+      ACTIVATION_DEFAULT = true
+
       def initialize(plugin, plugintype=:agent, loadddl=true)
         @entities = {}
         @meta = {}
@@ -40,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)
@@ -50,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
@@ -65,18 +68,22 @@ 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
 
       def loadddlfile
+        if @config.mode == :client && !client_activated?
+          raise("%s/%s is disabled, cannot load DDL file" % [@plugintype, @pluginname])
+        end
+
         if ddlfile = findddlfile
           instance_eval(File.read(ddlfile), ddlfile, 1)
         else
@@ -85,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"])
@@ -95,7 +102,12 @@ module MCollective
             return ddlfile
           end
         end
-        return false
+
+        false
+      end
+
+      def client_activated?
+        ACTIVATION_DEFAULT
       end
 
       def validate_requirements
@@ -137,7 +149,7 @@ module MCollective
 
         return true
       rescue => e
-        raise DDLValidationError, "Cannot validate input %s: %s" % [key, e.to_s]
+        raise DDLValidationError, "Cannot validate input %s: %s" % [key, e.to_s], e.backtrace
       end
 
       # Registers an input argument for a given action
@@ -159,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
 
@@ -186,6 +198,8 @@ module MCollective
         @entities[action][:output][argument] = {:description => properties[:description],
                                                 :display_as  => properties[:display_as],
                                                 :default     => properties[:default]}
+
+        @entities[action][:output][argument][:type] = properties[:type] if properties[:type]
       end
 
       def requires(requirement)
@@ -193,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

@@ -12,15 +12,17 @@ module MCollective
         @revision = configuration[:revision] || 1
         @preinstall = configuration[:preinstall]
         @postinstall = configuration[:postinstall]
-        @vendor = configuration[:vendor] || "Puppet Labs"
+        @vendor = configuration[:vendor] || "Choria.IO User"
         @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}
+        @agent_name = @metadata[:name].downcase
         @metadata[:name] = (configuration[:pluginname] || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
+
         identify_packages
       end
 
@@ -36,27 +38,35 @@ module MCollective
 
       # Obtain Agent package files and dependencies.
       def agent
-        agent = {:files => [],
-                 :dependencies => @dependencies.clone,
-                 :description => "Agent plugin for #{@metadata[:name]}"}
+        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, @agent_name)
+        end
+
         agent
       end
 
       # Obtain client package files and dependencies.
       def client
-        client = {:files => [],
-                  :dependencies => @dependencies.clone,
-                  :description => "Client plugin for #{@metadata[:name]}"}
+        client = {
+          :files => [],
+          :dependencies => @dependencies.clone,
+          :description => "Client plugin for #{@metadata[:name]}"
+        }
 
         clientdir = File.join(@path, "application")
         aggregatedir = File.join(@path, "aggregate")
@@ -69,13 +79,15 @@ module MCollective
 
       # Obtain common package files and dependencies.
       def common
-        common = {:files =>[],
-                  :dependencies => @dependencies.clone,
-                  :description => "Common libraries for #{@metadata[:name]}"}
+        common = {
+          :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|
@@ -84,9 +96,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