scout_agent 3.0.1 → 3.0.2

data/CHANGELOG

@@ -1,8 +1,18 @@
+== 3.0.2
+
+* Added xmpp4r gem dependency
+* Locked gem version numbers at load time
+* Upgraded to Amalgalite 0.9.0 for Ruby 1.9 compatibility
+* Upgraded to RestClient 0.9.2 to remove a couple of bug workarounds
+* Changed the API to always shell out to the same version of Ruby it is running
+  under
+* Made a first pass at Ruby 1.9 support
+
 == 3.0.1
 
 * Added more error protection to the server wrapper so thinks like
-  OpenSSL::SSL::SSLError and SocketError don't kill the agent.
-* Switched to the beta URL.
+  OpenSSL::SSL::SSLError and SocketError don't kill the agent
+* Switched to the beta URL
 
 == 3.0.0
 

data/Rakefile

@@ -34,10 +34,11 @@ SA_SPEC = Gem::Specification.new do |spec|
 
 	spec.require_path = "lib"
 	
-  spec.add_dependency("arrayfields", "=4.7.2")
-  spec.add_dependency("amalgalite",  "=0.7.7")
-  spec.add_dependency("rest-client", "=0.9")
+  spec.add_dependency("arrayfields", "=4.7.2")  # fix Amalgalite's results
+  spec.add_dependency("amalgalite",  "=0.9.0")
+  spec.add_dependency("rest-client", "=0.9.2")
   spec.add_dependency("json",        "=1.1.3")
+  spec.add_dependency("xmpp4r",      "=0.4")
   spec.add_dependency("elif",        "=0.1.0")  # used by some plugins
 
 	spec.authors           = [ "James Edward Gray II",

data/bin/scout_agent

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# encoding: UTF-8
 
-$VERBOSE = true # -w
-$KCODE   = "u"  # -Ku
+$VERBOSE = true                        # -w
+$KCODE   = "u" if RUBY_VERSION < "1.9" # -Ku
 
 # load the agent
 $LOAD_PATH << File.join(File.expand_path(File.dirname(__FILE__)), *%w[.. lib])

data/lib/scout_agent.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 # require standard libraries
 require "etc"
@@ -25,11 +26,11 @@ require "scout_agent/lifeline"
 require "scout_agent/dispatcher"
 
 # require gems
-require_lib_or_gem "json"
-require_lib_or_gem "amalgalite"
-require_lib_or_gem "rest_client"
-require_lib_or_gem "xmpp4r"
-require_lib_or_gem "xmpp4r/roster"
+require_lib_or_gem "json",          "=1.1.3"
+require_lib_or_gem "amalgalite",    "=0.9.0"
+require_lib_or_gem "rest_client",   "=0.9.2"
+require_lib_or_gem "xmpp4r",        "=0.4"
+require_lib_or_gem "xmpp4r/roster"  # loads from xmpp4r's version
 
 # The namespace for all agent software.
 module ScoutAgent
@@ -64,7 +65,7 @@ module ScoutAgent
   end
 
   # The version of this agent.
-  VERSION = "3.0.1".freeze
+  VERSION = "3.0.2".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.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Agent

data/lib/scout_agent/agent/communication_agent.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 # load agent extensions
 require "scout_agent/api"
@@ -44,10 +45,10 @@ module ScoutAgent
       
       def login
         Thread.abort_on_exception = true  # make XMPP4R fail fast
-        @agent_jid = Jabber::JID.new("#{Plan.agent_key}@jabber.org/agent")
+        @agent_jid = Jabber::JID.new("#{agent_key}@#{jabber_server}/agent")
         @jabber    = Jabber::Client.new(@agent_jid)
         no_warnings { @jabber.connect }
-        @jabber.auth(Plan.agent_key)
+        @jabber.auth(agent_key)
       end
       
       def update_status(message, status = nil)
@@ -80,6 +81,16 @@ module ScoutAgent
         Thread.stop
         @jabber.close
       end
+      
+      def agent_key
+        @agent_key ||= Plan.test_mode?                        ?
+                       "a7349498-bec3-4ddf-963c-149a666433a4" :
+                       Plan.agent_key
+      end
+      
+      def jabber_server
+        @jabber_server ||= Plan.test_mode? ? "jabber.org" : "FIXME"
+      end
     end
   end
 end

data/lib/scout_agent/agent/master_agent.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 # load agent extensions
 require "scout_agent/mission"

data/lib/scout_agent/api.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
+require "rbconfig"  # used to find the Ruby we are running under
 require "pathname"  # all paths are Pathname objects
 
 begin
@@ -69,7 +71,8 @@ module ScoutAgent
       private
       
       def run
-        command        = [API.path_to_agent, @name, *Array(@args)].
+        command        = [ API.path_to_ruby, API.path_to_agent,
+                           @name,            *Array(@args) ].
                          map { |s| "'#{API.shell_escape(s)}'" }.join(" ")
         begin
           response     = open("| #{command} 2>&1", "r+") do |agent|
@@ -136,14 +139,26 @@ module ScoutAgent
                   sub(/^$/,                                  "''")
     end
     
+    # 
+    # This method returns the path to the Ruby executable used to load this code
+    # as a Pathname object.  The API uses this path to make sure another version
+    # of Ruby isn't invoked when shelling out.
+    # 
+    def path_to_ruby
+      @path_to_ruby ||= Pathname.new(
+        File.join(Config::CONFIG.values_at(*%w[bindir ruby_install_name])) +
+        Config::CONFIG["EXEEXT"]
+      )
+    end
+    
     # 
     # This method returns the path to the agent executable as a Pathname object.
     # This is convience for those who wish to manually communicate with the
     # agent and not needed if you stick to the higher level interface.
     # 
     def path_to_agent
-      Pathname.new( File.join( File.dirname(__FILE__),
-                               *%w[.. .. bin scout_agent] ) )
+      @path_to_agent ||= Pathname.new( File.join( File.dirname(__FILE__),
+                                                  *%w[.. .. bin scout_agent] ) )
     end
     
     #

data/lib/scout_agent/assignment.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/configuration.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/identify.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/queue.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 # require standard libraries
 require "io/wait"

data/lib/scout_agent/assignment/reset.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/snapshot.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment
@@ -68,9 +69,9 @@ module ScoutAgent
 
       # Escape +str+ to make it useable in a shell as one "word".
       def shell_escape(str)
-        str.to_s.gsub( /(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/, '\\'   ).
-                 gsub( /\n/,                                "'\n'" ).
-                 sub(  /^$/,                                "''"   )
+        str.to_s.gsub( /(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/n, '\\'   ).
+                 gsub( /\n/,                                 "'\n'" ).
+                 sub(  /^$/,                                 "''"   )
       end
       
       def abort_with_missing_db

data/lib/scout_agent/assignment/start.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment
@@ -47,9 +48,11 @@ module ScoutAgent
           Lifeline.new(agent, log)
         }
         %w[TERM INT].each do |signal|
-          trap(signal) do 
-            lifelines.each { |line| line.terminate }
-            Process.waitall
+          trap(signal) do
+            Thread.new do
+              lifelines.each { |line| line.terminate }
+              Process.waitall
+            end
           end
         end
         lifelines.each { |line| line.launch_and_monitor }

data/lib/scout_agent/assignment/status.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/stop.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Assignment

data/lib/scout_agent/assignment/upload_log.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 # require standard libraries
 require "tempfile"

data/lib/scout_agent/core_extensions.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   # 
@@ -55,21 +56,56 @@ module ScoutAgent
       # RubyGems and tries the require again.  If that too fails, this process
       # will exit with a message about the missing library.
       # 
-      def require_lib_or_gem(name)
-        require name
+      # Setting +version+ will cause this method to try to lock the gem with
+      # that version, if loading via RubyGems.  This helps prevent gem upgrades
+      # from causing issues with the agent, but it's still possible to load 
+      # directly from installed libraries if you need to bypass RubyGems for any
+      # reason.
+      # 
+      def require_lib_or_gem(name, version = nil)
+        # special case JSON, which became a standard library in Ruby 1.9
+        if name == "json" and RUBY_VERSION >= "1.9"
+          no_warnings { return require(name) }
+        end
+        
+        lock_gem_version(name, version) if version
+        if %w[amalgalite rest_client].include?(name) and RUBY_VERSION >= "1.9"
+          no_warnings { require name }
+        else
+          require name
+        end
       rescue LoadError    # library not found
         begin
           require "rubygems"
-          require name
+          lock_gem_version(name, version) if version
+          if %w[amalgalite rest_client].include?(name) and RUBY_VERSION >= "1.9"
+            no_warnings { require name }
+          else
+            require name
+          end
         rescue LoadError  # library not found
+          v_str = version.to_s[/\d\.\d(?:\.\d)?/]
+          v_str = "-v #{v_str}" if v_str
           abort <<-END_LOAD_ERROR.trim
           Unable to load the required '#{name}' library.  Try:
 
-              sudo gem install #{name.tr('_', '-')}
+              sudo gem install #{name.tr('_', '-')} #{v_str}
 
           END_LOAD_ERROR
         end
       end
+      
+      # 
+      # Locks the +library+ at +version+, if gem() is available (a recent
+      # version of RubyGems is loaded).
+      # 
+      def lock_gem_version(library, version)
+        begin
+          gem(library.tr("_", "-"), version)
+        rescue NoMethodError  # gem() not available
+          # do nothing:  RubyGems not loaded
+        end
+      end
 
       # 
       # This is a helper for those libraries that aren't well enough behaved not
@@ -253,6 +289,7 @@ end
 
 # load all core extensions
 ScoutAgent::CoreExtensions.constants.each do |name|
+  name      = name.to_s  # needed for Ruby 1.9 compatibility
   extension = ScoutAgent::CoreExtensions.const_get(name)
   mixer     = name.sub!(/([a-z])(?:Module|Class)\z/, "\\1") ? :extend : :include
   core      = Object.const_get(name)

data/lib/scout_agent/database.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   #
@@ -49,7 +50,7 @@ module ScoutAgent
     # 
     def initialize(log = WireTap.new(nil))
       @log          = log
-      @sqlite       = Amalgalite::Database.new(path)
+      @sqlite       = Amalgalite::Database.new(path.to_s)
       @read_locked  = false
       @write_locked = false
     end

data/lib/scout_agent/database/mission_log.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Database

data/lib/scout_agent/database/queue.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Database

data/lib/scout_agent/database/snapshots.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Database

data/lib/scout_agent/database/statuses.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Database

data/lib/scout_agent/dispatcher.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   module Dispatcher
@@ -117,7 +118,8 @@ module ScoutAgent
     
     def load_assignment(assignment)
       dir     = LIB_DIR + "assignment"
-      matches = dir.entries.grep(/#{Regexp.escape(assignment)}\w*\.rb\z/)
+      matches = dir.entries.map { |path| path.to_s }.
+                            grep(/#{Regexp.escape(assignment)}\w*\.rb\z/)
       if matches.size > 1
         abort_with_ambiguous_assignment(assignment, matches)
       elsif matches.first and (code = dir + matches.first).exist?

data/lib/scout_agent/id_card.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   #

data/lib/scout_agent/lifeline.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Lifeline
@@ -228,7 +229,9 @@ module ScoutAgent
       close_writer
 
       if @code
-        @code.finish
+        Thread.new do
+          @code.finish
+        end
       else
         exit
       end
@@ -236,7 +239,9 @@ module ScoutAgent
     
     def alert_code
       if @code
-        @code.notice_changes
+        Thread.new do
+          @code.notice_changes
+        end
       end
     end
   end

data/lib/scout_agent/mission.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Mission

data/lib/scout_agent/order.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Order

data/lib/scout_agent/order/check_in_order.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Order

data/lib/scout_agent/order/snapshot_order.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   class Order

data/lib/scout_agent/plan.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   #
@@ -211,7 +212,7 @@ module ScoutAgent
     # 
     %w[os_config_path os_db_path os_pid_path os_log_path].each do |path|
       define_method(path) do
-        prefix_path + super
+        prefix_path + super()
       end
     end
     
@@ -230,7 +231,7 @@ module ScoutAgent
     # 
     %w[db pid log].each do |path|
       define_method("#{path}_dir") do
-        send("os_#{path}_path") + (super || ScoutAgent.agent_name)
+        send("os_#{path}_path") + (super() || ScoutAgent.agent_name)
       end
     end
     

data/lib/scout_agent/server.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   # 
@@ -80,14 +81,9 @@ module ScoutAgent
       log.error("Check-in could not be zipped.")
       false
     rescue RestClient::RequestFailed => error  # RestClient bug workaround
-      # all success codes are OK, but other codes are not
-      if error.http_code.between? 200, 299
-        true
-      else
-        log.warn( "Check-in was returned as a failure code:  " +
-                  "#{error.http_code}." )
-        false
-      end
+      log.warn( "Check-in was returned as a failure code:  " +
+                "#{error.http_code}." )
+      false
     rescue Exception => error  # networking problem
       log.warn("Check-in could not be sent:  #{error.class}.")
       false  # we failed to send and will retry later
@@ -107,14 +103,9 @@ module ScoutAgent
       end
       true
     rescue RestClient::RequestFailed => error  # RestClient bug workaround
-      # all success codes are OK, but other codes are not
-      if error.http_code.between? 200, 299
-        true
-      else
-        log.warn( "Log upload was returned as a failure code:  " +
-                  "#{error.http_code}." )
-        false
-      end
+      log.warn( "Log upload was returned as a failure code:  " +
+                "#{error.http_code}." )
+      false
     rescue Errno::ECONNREFUSED, RestClient::Exception  # networking problem
       log.warn("Log could not be sent:  #{error.class}.")
       false  # could not send log

data/lib/scout_agent/tracked.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   # 

data/lib/scout_agent/wire_tap.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -wKU
+# encoding: UTF-8
 
 module ScoutAgent
   # 
@@ -479,6 +480,7 @@ module ScoutAgent
     # Builds a Hash of all levels used.
     def levels
       @levels ||= Hash[ *Severity.constants.
+                                  map { |name| name.to_s }.  # for Ruby 1.9
                                   map { |name| [name, level_by_name(name)] }.
                                   flatten ]
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout_agent
 version: !ruby/object:Gem::Version 
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-01 00:00:00 -05:00
+date: 2009-04-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.7.7
+        version: 0.9.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: "0.9"
+        version: 0.9.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -55,6 +55,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: elif
   type: :runtime