scout_agent 3.2.2 → 3.2.3

data/lib/scout_agent.rb

@@ -27,9 +27,9 @@ require "scout_agent/dispatcher"
 require "scout_agent/api"
 
 # require gems
-require_lib_or_gem "json",          "=1.1.4"
+require_lib_or_gem "json",          "=1.1.6"
 require_lib_or_gem "amalgalite",    "=0.9.0"
-require_lib_or_gem "rest_client",   "=0.9.2"
+require_lib_or_gem "rest_client",   "=1.0"
 require_lib_or_gem "xmpp4r",        "=0.4"
 require_lib_or_gem "xmpp4r/roster"  # loads from xmpp4r's version
 
@@ -92,7 +92,7 @@ module ScoutAgent
   end
 
   # The version of this agent.
-  VERSION = "3.2.2".freeze
+  VERSION = "3.2.3".freeze
   # A Pathname reference to the agent code directory, used in dynamic loading.
   LIB_DIR = Pathname.new(File.dirname(__FILE__)) + agent_name
 end

data/lib/scout_agent/agent/master_agent.rb

@@ -17,6 +17,21 @@ module ScoutAgent
     # databases and cleaning out old log files.
     # 
     class MasterAgent < Agent
+      # 
+      # These are the error codes and descriptions for failure conditions the
+      # mission process may not be able to report.
+      # 
+      MISSION_ERRORS      = { 76 => "was already running",
+                              16 => "couldn't be compiled",
+                               6 => "couldn't be loaded" }
+      # 
+      # These are the +MISSION_ERRORS+ by name (the last word of the description
+      # as a Symbol).
+      # 
+      MISSION_ERROR_NAMES = Hash[ *MISSION_ERRORS.map { |code, name|
+        [name[/\S+\z/].to_sym, code]
+      }.flatten ]
+      
       #
       # Prepares the primary event loop for execution.  The main function at
       # this point is to ensure that we can load all of the needed databases.
@@ -182,13 +197,26 @@ module ScoutAgent
             end
             @mission_pid = nil
             unless $?.success?  # record that the Mission exited with an error
+              error_status = $?.exitstatus
               log.warn( "#{mission[:name]} exited with an error:  " +
-                        "#{$?.exitstatus}." )
+                        "#{error_status}." )
+              body = "Exit status:  #{error_status}"
+              if description = MISSION_ERRORS[error_status]
+                body << <<-END_ERROR_DESCRIPTION
+                
+                
+                This error often means that a mission #{description}.
+                This can be a natural function of the agent cleaning up after
+                itself and it shouldn't be any cause for alarm if just see it
+                now and then.  However, if you are seeing this error a lot,
+                please contact Scout support.
+                END_ERROR_DESCRIPTION
+              end
               @db.write_report(
                 mission[:id],
                 :error,
                 :subject => "#{mission[:name]} exited with an error",
-                :body    => "Exit status:  #{$?.exitstatus}"
+                :body    => body
               )
             end
           rescue Timeout::Error  # Mission exceeded allowed execution
@@ -345,7 +373,7 @@ module ScoutAgent
 
         # clear the parent's identity and assume mine
         IDCard.me = nil
-        IDCard.new(:mission).authorize or exit(1)
+        IDCard.new(:mission).authorize or exit(MISSION_ERROR_NAMES[:running])
 
         # get a handle on the log
         @log = ScoutAgent.prepare_wire_tap(:mission)
@@ -373,7 +401,8 @@ module ScoutAgent
             :subject => "#{mission[:name]} could not be compiled",
             :body    => "#{error.message}\n#{error.backtrace.join("\n")}"
           )
-          exit(reported ? 0 : 2)  # warn parent if we can't report
+          # warn parent if we can't report
+          exit(reported ? 0 : MISSION_ERROR_NAMES[:compiled])
         end
       end
       
@@ -400,7 +429,8 @@ module ScoutAgent
             :subject => "#{mission[:name]} could not be prepared",
             :body    => "The code didn't define a Scout::Plugin subclass"
           )
-          exit(reported ? 0 : 3)  # warn parent if we can't report
+          # warn parent if we can't report
+          exit(reported ? 0 : MISSION_ERROR_NAMES[:loaded])
         end
       end
       

data/lib/scout_agent/api.rb

@@ -4,26 +4,6 @@
 require "rbconfig"  # used to find the Ruby we are running under
 require "pathname"  # all paths are Pathname objects
 
-begin
-  # 
-  # the agent communicates in JSON, so we need to load the gem unless we are in
-  # something like Rails that already provides us with JSON capabilities
-  # 
-  require "json" unless Hash.new.respond_to? :to_json
-rescue LoadError    # library not found
-  begin
-    require "rubygems"
-    begin
-      gem("json", "=1.1.4")
-    rescue NoMethodError
-      abort "Please upgrade RubyGems as the gem() method is required."
-    end
-    require "json"
-  rescue LoadError  # library not found
-    abort "Please install the 'json' gem to use this API."
-  end
-end
-
 module ScoutAgent
   # 
   # This module contains methods used to communicate with the agent
@@ -96,7 +76,7 @@ module ScoutAgent
                          map { |s| "'#{API.shell_escape(s)}'" }.join(" ")
         begin
           response     = open("| #{command} 2>&1", "r+") { |agent|
-            agent.puts @input.to_json if @input
+            agent.print Marshal.dump(@input) if @input
             agent.close_write
             agent.read
           }
@@ -144,7 +124,7 @@ module ScoutAgent
       # 
       def validate(mission_id_or_report_type, fields)
         unless mission_id_or_report_type.to_s =~
-               /\A(?:report|hint|alert|error|\d*[1-9])\z/
+               /\A(?:report|hint|alert|error|0*[1-9]\d*)\z/
           raise ArgumentError, "Invalid mission ID or report type"
         end
         
@@ -156,7 +136,7 @@ module ScoutAgent
           unless plugin_id
             raise ArgumentError, "A :plugin_id is a required field for reports"
           end
-          unless plugin_id.to_s =~ /\A\d*[1-9]\z/
+          unless plugin_id.to_s =~ /\A0*[1-9]\d*\z/
             raise ArgumentError, "The :plugin_id must be a positive Integer"
           end
         end

data/lib/scout_agent/assignment/queue.rb

@@ -11,6 +11,11 @@ module ScoutAgent
     # 
     #   scout_agent q ID_OR_TYPE <<< '{"fields": "in JSON"}'
     # 
+    # or:
+    # 
+    #   ruby -e 'print Marshal.dump(:fields => "in Ruby")' | \
+    #   scout_agent q ID_OR_TYPE
+    # 
     # This command queues some data from an external source for a plugin.  The
     # plugin to receive the message is given by ID in +ID_OR_TYPE+.  That plugin
     # will be able to collect this data during its next run.
@@ -21,6 +26,9 @@ module ScoutAgent
     # be a Hash (object in JSON terminology) that includes the key "plugin_id"
     # associated with an ID value for the reporting plugin.
     # 
+    # If you prefer, you can pass Marshal data from Ruby for the fields instead
+    # of JSON.
+    # 
     class Queue < Assignment
       # 
       # A list of errors that can be sent to the user when attempting to queue a
@@ -37,7 +45,7 @@ module ScoutAgent
                  [ :missing_fields,
                    "You must provide fields to queue." ],
                  [ :invalid_fields,
-                   "You must pass valid JSON for the fields." ],
+                   "You must pass valid JSON or Marshal data for the fields." ],
                  [ :invalid_report_fields,
                    "Field data must be a Hash to pass to the server." ],
                  [ :missing_plugin_id_field,
@@ -80,8 +88,15 @@ module ScoutAgent
         end
         bytes = fields.size
         begin
-          fields = JSON.parse(fields.to_s)
-        rescue JSON::ParserError
+          if ["{", "["].include? fields[0, 1]  # it's JSON
+            fields = JSON.parse(fields)
+          else                                 # it's Marshal
+            fields = Marshal.load(fields)
+            if fields.is_a? Hash               # Stringify Hash keys
+              fields = Hash[*fields.map { |k, v| [k.to_s, v] }.flatten]
+            end
+          end
+        rescue Exception
           abort_with_error(:invalid_fields)
         end
         

data/lib/scout_agent/server.rb

@@ -15,8 +15,12 @@ module ScoutAgent
       @log         = log
       @rest_client = RestClient::Resource.new(
         Plan.agent_url,
-        :headers => { :client_version   => ScoutAgent::VERSION,
-                      :accept_encoding  => "gzip" }
+        :headers     => { :client_version   => ScoutAgent::VERSION,
+                          :accept_encoding  => "gzip" },
+        :ssl_ca_file => File.join( File.dirname(__FILE__),
+                                   *%w[.. .. data cacert.pem] ),
+        :verify_ssl  => OpenSSL::SSL::VERIFY_PEER |
+                        OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
       )
       # make sure proxy is set, if needed
       RestClient.proxy = Plan.proxy_url
@@ -47,6 +51,9 @@ module ScoutAgent
     rescue RestClient::NotModified
       log.info("Plan was not modified.")
       ""  # empty plan
+    rescue OpenSSL::SSL::SSLError
+      log.warn("SSL verification failed.  The plan could not be trusted.")
+      nil  # cannot trust any plan we received
     rescue Exception => error  # networking problem
       log.warn("Plan could not be retrieved:  #{error.class}.")
       nil  # failed to retrieve plan
@@ -81,6 +88,10 @@ module ScoutAgent
       log.warn( "Check-in was returned as a failure code:  " +
                 "#{error.http_code}." )
       false
+    rescue OpenSSL::SSL::SSLError
+      log.warn( "SSL verification failed.  " +
+                "Could not send check-in to untrusted server." )
+      false  # cannot trust server
     rescue Exception => error  # networking problem
       log.warn("Check-in could not be sent:  #{error.class}.")
       false  # we failed to send and will retry later
@@ -103,7 +114,11 @@ module ScoutAgent
       log.warn( "Log upload was returned as a failure code:  " +
                 "#{error.http_code}." )
       false
-    rescue Errno::ECONNREFUSED, RestClient::Exception  # networking problem
+    rescue OpenSSL::SSL::SSLError
+      log.warn( "SSL verification failed.  " +
+                "Could not send log to untrusted server." )
+      false  # cannot trust server
+    rescue Exception => error  # networking problem
       log.warn("Log could not be sent:  #{error.class}.")
       false  # could not send log
     end

data/test/tc_core_extensions.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby -wKU
 
 require "test/unit"
+require "timeout"  # required for the core extensions
 
 require "scout_agent/core_extensions"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout_agent
 version: !ruby/object:Gem::Version 
-  version: 3.2.2
+  version: 3.2.3
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-27 00:00:00 -05:00
+date: 2009-06-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.9.2
+        version: "1.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -53,7 +53,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 1.1.4
+        version: 1.1.6
     version: 
 - !ruby/object:Gem::Dependency 
   name: xmpp4r
@@ -136,6 +136,9 @@ files:
 - test/ts_all.rb
 - Rakefile
 - setup.rb
+- data/cacert.pem
+- data/gpl-2.0.txt
+- data/lgpl-2.1.txt
 - AUTHORS
 - COPYING
 - README
@@ -182,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: scout
-rubygems_version: 1.3.3
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Scout makes monitoring and reporting on your servers as flexible and simple as possible.