mcollective-client 2.2.4 → 2.4.0

data/lib/mcollective/data/base.rb

@@ -13,7 +13,7 @@ module MCollective
       def initialize
         @name = self.class.to_s.split("::").last.downcase
         @ddl = DDL.new(@name, :data)
-        @result = Result.new
+        @result = Result.new(@ddl.dataquery_interface[:output])
         @timeout = @ddl.meta[:timeout] || 1
 
         startup_hook

data/lib/mcollective/data/result.rb

@@ -6,8 +6,12 @@ module MCollective
       # method_missing lookup strategy
       undef :type if method_defined?(:type)
 
-      def initialize
+      def initialize(outputs)
         @data = {}
+
+        outputs.keys.each do |output|
+          @data[output] = Marshal.load(Marshal.dump(outputs[output].fetch(:default, nil)))
+        end
       end
 
       def include?(key)
@@ -31,7 +35,7 @@ module MCollective
       def method_missing(method, *args)
         key = method.to_sym
 
-        raise NameError, "undefined local variable or method `%s'" % key unless include?(key)
+        raise NoMethodError, "undefined local variable or method `%s'" % key unless include?(key)
 
         @data[key]
       end

data/lib/mcollective/ddl/agentddl.rb

@@ -21,7 +21,8 @@ module MCollective
     #            :type        => :string,
     #            :validation  => '^[\w\-\.]+$',
     #            :optional    => false,
-    #            :maxlength   => 40
+    #            :maxlength   => 40,
+    #            :default     => "fqdn"
     #
     #      output :fact,
     #             :description => "The name of the fact being returned",
@@ -82,6 +83,10 @@ module MCollective
       # Sets the display preference to either :ok, :failed, :flatten or :always
       # operates on action level
       def display(pref)
+        if pref == :flatten
+          Log.warn("The display option :flatten is being deprecated and will be removed in the next minor release.")
+        end
+
         # defaults to old behavior, complain if its supplied and invalid
         unless [:ok, :failed, :flatten, :always].include?(pref)
           raise "Display preference #{pref} is not valid, should be :ok, :failed, :flatten or :always"
@@ -146,6 +151,28 @@ module MCollective
         PluginManager.find("aggregate").include?(method_name.to_s)
       end
 
+      # For a given action and arguments look up the DDL interface to that action
+      # and if any arguments in the DDL have a :default value assign that to any
+      # input that does not have an argument in the input arguments
+      #
+      # This is intended to only be called on clients and not on servers as the
+      # clients should never be able to publish non compliant requests and the
+      # servers should really not tamper with incoming requests since doing so
+      # might raise validation errors that were not raised on the client breaking
+      # our fail-fast approach to input validation
+      def set_default_input_arguments(action, arguments)
+        input = action_interface(action)[:input]
+
+        return unless input
+
+        input.keys.each do |key|
+          if !arguments.include?(key) && !input[key][:default].nil? && !input[key][:optional]
+            Log.debug("Setting default value for input '%s' to '%s'" % [key, input[key][:default]])
+            arguments[key] = input[key][:default]
+          end
+        end
+      end
+
       # Helper to use the DDL to figure out if the remote call to an
       # agent should be allowed based on action name and inputs.
       def validate_rpc_request(action, arguments)

data/lib/mcollective/ddl/base.rb

@@ -36,18 +36,19 @@ module MCollective
       #
       # If no template name is provided one will be chosen based
       # on the plugin type.  If the provided template path is
-      # not absolute then the template will be loaded relative to
-      # helptemplatedir configuration parameter
+      # not absolute then the template will be loaded either from
+      # the config dir and if that does not exist, default to
+      # /etc/mcollective
       def help(template=nil)
         template = template_for_plugintype unless template
-        template = File.join(@config.helptemplatedir, template) unless template.start_with?(File::SEPARATOR)
+        template = Util.templatepath(template) unless Util.absolute_path?(template)
 
         template = File.read(template)
         meta = @meta
         entities = @entities
 
         unless template == "metadata-help.erb"
-          metadata_template = File.join(@config.helptemplatedir, "metadata-help.erb")
+          metadata_template = Util.templatepath("metadata-help.erb")
           metadata_template = File.read(metadata_template)
           metastring = ERB.new(metadata_template, 0, '%')
           metastring = metastring.result(binding)
@@ -66,7 +67,7 @@ module MCollective
         when :agent
           return "rpc-help.erb"
         else
-          if File.exists?(File.join(@config.helptemplatedir,"#{@plugintype}-help.erb"))
+          if File.exists?(Util.templatepath("#{@plugintype}-help.erb"))
             return "#{@plugintype}-help.erb"
           else
             # Default help template gets loaded if plugintype-help does not exist.
@@ -144,7 +145,7 @@ module MCollective
         raise DDLValidationError, "Cannot validate input %s: %s" % [key, e.to_s]
       end
 
-     # Registers an input argument for a given action
+      # Registers an input argument for a given action
       #
       # See the documentation for action for how to use this
       def input(argument, properties)
@@ -159,6 +160,7 @@ module MCollective
         @entities[entity][:input][argument] = {:prompt => properties[:prompt],
                                                :description => properties[:description],
                                                :type => properties[:type],
+                                               :default => properties[:default],
                                                :optional => properties[:optional]}
 
         case properties[:type]

data/lib/mcollective/log.rb

@@ -81,13 +81,15 @@ module MCollective
           end
 
           require "mcollective/logger/#{logger_type.downcase}_logger"
-          set_logger(eval("MCollective::Logger::#{logger_type.capitalize}_logger.new"))
+
+          logger_class = MCollective::Logger.const_get("#{logger_type.capitalize}_logger")
+
+          set_logger(logger_class.new)
         else
           set_logger(logger)
           @configured = true
         end
 
-
         @logger.start
       rescue Exception => e
         @configured = false
@@ -96,7 +98,13 @@ module MCollective
 
       # figures out the filename that called us
       def from
-        from = File.basename(caller[2])
+        path, line, method = execution_stack[3].split(/:(\d+)/)
+        "%s:%s%s" % [File.basename(path), line, method]
+      end
+
+      # this method is here to facilitate testing and from
+      def execution_stack
+        caller
       end
     end
   end

data/lib/mcollective/logger/file_logger.rb

@@ -28,10 +28,10 @@ module MCollective
 
       def valid_levels
         {:info  => ::Logger::INFO,
-          :warn  => ::Logger::WARN,
-          :debug => ::Logger::DEBUG,
-          :fatal => ::Logger::FATAL,
-          :error => ::Logger::ERROR}
+         :warn  => ::Logger::WARN,
+         :debug => ::Logger::DEBUG,
+         :fatal => ::Logger::FATAL,
+         :error => ::Logger::ERROR}
       end
 
       def log(level, from, msg)

data/lib/mcollective/matcher.rb

@@ -96,7 +96,12 @@ module MCollective
       result = Data.send(function_hash["name"], function_hash["params"])
 
       if function_hash["value"]
-        eval_result = result.send(function_hash["value"])
+        begin
+          eval_result = result.send(function_hash["value"])
+        rescue
+          # If data field has not been set we set the comparison result to nil
+          eval_result = nil
+        end
         return eval_result
       else
         return result
@@ -130,6 +135,9 @@ module MCollective
     def self.eval_compound_fstatement(function_hash)
       l_compare = execute_function(function_hash)
 
+      # Break out early and return false if the function returns nil
+      return false unless l_compare
+
       # Prevent unwanted discovery by limiting comparison operators
       # on Strings and Booleans
       if((l_compare.is_a?(String) || l_compare.is_a?(TrueClass) || l_compare.is_a?(FalseClass)) && function_hash["operator"].match(/<|>/))

data/lib/mcollective/message.rb

@@ -139,7 +139,7 @@ module MCollective
           @requestid = request.payload[:requestid]
           @payload = PluginManager["security_plugin"].encodereply(agent, payload, requestid, request.payload[:callerid])
         when :request, :direct_request
-          validate_compount_filter(@filter["compound"]) unless @filter["compound"].empty?
+          validate_compound_filter(@filter["compound"]) unless @filter["compound"].empty?
 
           @requestid = create_reqid unless @requestid
           @payload = PluginManager["security_plugin"].encoderequest(Config.instance.identity, payload, requestid, filter, agent, collective, ttl)
@@ -148,7 +148,7 @@ module MCollective
       end
     end
 
-    def validate_compount_filter(compound_filter)
+    def validate_compound_filter(compound_filter)
       compound_filter.each do |filter|
         filter.each do |statement|
           if statement["fstatement"]
@@ -156,11 +156,7 @@ module MCollective
             pluginname = Data.pluginname(functionname)
             value = statement["fstatement"]["value"]
 
-            begin
-              ddl = DDL.new(pluginname, :data)
-            rescue
-              raise DDLValidationError, "Could not find DDL for data plugin #{pluginname}, cannot use #{functionname}() in discovery"
-            end
+            ddl = DDL.new(pluginname, :data)
 
             # parses numbers and booleans entered as strings into proper
             # types of data so that DDL validation will pass
@@ -169,7 +165,7 @@ module MCollective
             Data.ddl_validate(ddl, statement["fstatement"]["params"])
 
             unless value && Data.ddl_has_output?(ddl, value)
-              raise DDLValidationError, "#{functionname}() does not return a #{value} value"
+              DDL.validation_fail!(:PLMC41, "Data plugin '%{functionname}()' does not return a '%{value}' value", :error, {:functionname => functionname, :value => value})
             end
           end
         end
@@ -204,7 +200,7 @@ module MCollective
         if msg_age > ttl
           PluginManager["global_stats"].ttlexpired
 
-          raise(MsgTTLExpired, "Message #{requestid} from #{cid} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}")
+          raise(MsgTTLExpired, "message #{requestid} from #{cid} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}")
         end
       end
 
@@ -215,21 +211,16 @@ module MCollective
 
     # publish a reply message by creating a target name and sending it
     def publish
-      Timeout.timeout(2) do
-        # If we've been specificaly told about hosts that were discovered
-        # use that information to do P2P calls if appropriate else just
-        # send it as is.
-        if @discovered_hosts && Config.instance.direct_addressing
-          if @discovered_hosts.size <= Config.instance.direct_addressing_threshold
-            self.type = :direct_request
-            Log.debug("Handling #{requestid} as a direct request")
-          end
-
-          PluginManager["connector_plugin"].publish(self)
-        else
-          PluginManager["connector_plugin"].publish(self)
-        end
+      # If we've been specificaly told about hosts that were discovered
+      # use that information to do P2P calls if appropriate else just
+      # send it as is.
+      config = Config.instance
+      if @discovered_hosts && config.direct_addressing && (@discovered_hosts.size <= config.direct_addressing_threshold)
+        self.type = :direct_request
+        Log.debug("Handling #{requestid} as a direct request")
       end
+
+      PluginManager['connector_plugin'].publish(self)
     end
 
     def create_reqid

data/lib/mcollective/optionparser.rb

@@ -167,7 +167,15 @@ module MCollective
         raise "Cannot read the discovery file #{v}" unless File.readable?(v)
 
         @options[:discovery_method] = "flatfile"
-        @options[:discovery_options] = v
+        @options[:discovery_options] << v
+      end
+
+      @parser.on("--publish_timeout TIMEOUT", Integer, "Timeout for publishing requests to remote agents.") do |pt|
+        @options[:publish_timeout] = pt
+      end
+
+      @parser.on("--threaded", "Start publishing requests and receiving responses in threaded mode.") do |v|
+        @options[:threaded] = true
       end
     end
 

data/lib/mcollective/pluginpackager.rb

@@ -33,7 +33,7 @@ module MCollective
     end
 
     # Quietly calls a block if verbose parameter is false
-    def self.do_quietly?(verbose, &block)
+    def self.execute_verbosely(verbose, &block)
       unless verbose
         old_stdout = $stdout.clone
         $stdout.reopen(File.new("/dev/null", "w"))
@@ -51,7 +51,7 @@ module MCollective
     end
 
     # Checks if a build tool is present on the system
-    def self.build_tool?(build_tool)
+    def self.command_available?(build_tool)
       ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
         builder = File.join(path, build_tool)
         if File.exists?(builder)
@@ -62,7 +62,28 @@ module MCollective
     end
 
     def self.safe_system(*args)
-      raise RuntimeError, "Failed: #{args.join(' ')}" unless system *args
+      raise(RuntimeError, "Failed: #{args.join(' ')}") unless system *args
+    end
+
+    # Filter out platform specific dependencies
+    # Given a list of dependencies named -
+    # debian::foo
+    # redhat::bar
+    # PluginPackager.filter_dependencies('debian', dependencies)
+    # will return foo.
+    def self.filter_dependencies(prefix, dependencies)
+      dependencies.map do |dependency|
+        if dependency[:name] =~ /^(\w+)::(\w+)/
+          if prefix == $1
+            dependency[:name] = $2
+            dependency
+          else
+            nil
+          end
+        else
+          dependency
+        end
+      end.reject{ |dependency| dependency == nil }
     end
   end
 end

data/lib/mcollective/pluginpackager/agent_definition.rb

@@ -2,25 +2,25 @@ module MCollective
   module PluginPackager
     # MCollective Agent Plugin package
     class AgentDefinition
-      attr_accessor :path, :packagedata, :metadata, :target_path, :vendor, :iteration, :preinstall
+      attr_accessor :path, :packagedata, :metadata, :target_path, :vendor, :revision, :preinstall
       attr_accessor :plugintype, :dependencies, :postinstall, :mcname, :mcversion
 
-      def initialize(path, name, vendor, preinstall, postinstall, iteration, dependencies, mcdependency, plugintype)
+      def initialize(configuration, mcdependency, plugintype)
         @plugintype = plugintype
-        @path = path
+        @path = configuration[:target]
         @packagedata = {}
-        @iteration = iteration || 1
-        @preinstall = preinstall
-        @postinstall = postinstall
-        @vendor = vendor || "Puppet Labs"
-        @dependencies = dependencies || []
+        @revision = configuration[:revision] || 1
+        @preinstall = configuration[:preinstall]
+        @postinstall = configuration[:postinstall]
+        @vendor = configuration[:vendor] || "Puppet Labs"
+        @dependencies = configuration[:dependency] || []
         @target_path = File.expand_path(@path)
         @metadata, mcversion = PluginPackager.get_metadata(@path, "agent")
         @mcname = mcdependency[:mcname] ||  "mcollective"
         @mcversion = mcdependency[:mcversion] || mcversion
+        @metadata[:version] = (configuration[:version] || @metadata[:version])
         @dependencies << {:name => "#{@mcname}-common", :version => @mcversion}
-
-        @metadata[:name] = (name || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
+        @metadata[:name] = (configuration[:pluginname] || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
         identify_packages
       end
 
@@ -48,7 +48,7 @@ module MCollective
         else
           return nil
         end
-        agent[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common", :version => @metadata[:version], :iteration => @iteration}
+        agent[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common", :version => @metadata[:version], :revision => @revision}
         agent
       end
 
@@ -63,7 +63,7 @@ module MCollective
 
         client[:files] += Dir.glob(File.join(clientdir, "*")) if PluginPackager.check_dir_present clientdir
         client[:files] += Dir.glob(File.join(aggregatedir, "*")) if PluginPackager.check_dir_present aggregatedir
-        client[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common", :version => @metadata[:version], :iteration => @iteration}
+        client[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common", :version => @metadata[:version], :revision => @revision}
         client[:files].empty? ? nil : client
       end
 

data/lib/mcollective/pluginpackager/standard_definition.rb

@@ -1,25 +1,25 @@
 module MCollective
   module PluginPackager
     class StandardDefinition
-      attr_accessor :path, :packagedata, :metadata, :target_path, :vendor, :iteration
+      attr_accessor :path, :packagedata, :metadata, :target_path, :vendor, :revision
       attr_accessor :plugintype, :preinstall, :postinstall, :dependencies, :mcname, :mcversion
 
-      def initialize(path, name, vendor, preinstall, postinstall, iteration, dependencies, mcdependency, plugintype)
+      def initialize(configuration, mcdependency, plugintype)
         @plugintype = plugintype
-        @path = path
+        @path = configuration[:target]
         @packagedata = {}
-        @iteration = iteration || 1
-        @preinstall = preinstall
-        @postinstall = postinstall
-        @vendor = vendor || "Puppet Labs"
-        @dependencies = dependencies || []
+        @revision = configuration[:revision] || 1
+        @preinstall = configuration[:preinstall]
+        @postinstall = configuration[:postinstall]
+        @vendor = configuration[:vendor] || "Puppet Labs"
+        @dependencies = configuration[:dependency] || []
         @target_path = File.expand_path(@path)
         @metadata, mcversion = PluginPackager.get_metadata(@path, @plugintype)
-
         @mcname = mcdependency[:mcname] || "mcollective"
         @mcversion = mcdependency[:mcversion] || mcversion
         @dependencies << {:name => "#{mcname}-common", :version => @mcversion}
-        @metadata[:name] = (name || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
+        @metadata[:name] = (configuration[:pluginname] || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
+        @metadata[:version] = (configuration[:version] || @metadata[:version])
         identify_packages
       end
 
@@ -28,7 +28,7 @@ module MCollective
         common_package = common
         @packagedata[:common] = common_package if common_package
         plugin_package = plugin
-        @packagedata[@plugintype] = plugin_package if plugin_package
+        @packagedata[@plugintype.to_sym] = plugin_package if plugin_package
       end
 
       # Obtain standard plugin files and dependencies
@@ -46,7 +46,7 @@ module MCollective
 
         plugindata[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common",
                                       :version => @metadata[:version],
-                                      :iteration => @iteration} if @packagedata[:common]
+                                      :revision => @revision} if @packagedata[:common]
         plugindata
       end