emissary 1.3.20 → 1.3.21

data/lib/emissary/agent.rb

@@ -0,0 +1,61 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+module Emissary
+  class Agent
+    attr_reader :name, :message, :method, :config, :operator
+    attr_accessor :args
+    
+    def initialize message, config, operator
+      @message  = message
+      @operator = operator
+      @config   = config
+      
+      @method   = message.method.to_sym rescue :__bad_method__
+      @args     = message.args.clone
+      
+      unless valid_methods.first == :any or valid_methods.include? @method 
+        raise ArgumentError, "Invalid method '#{@method.to_s}' for agent '#{message.agent}'"
+      end
+      
+      post_init
+    end
+  
+    def post_init(); end
+
+    def valid_methods
+      raise StandardError, 'Not implemented'
+    end
+    
+    def activate
+      catch(:skip_implicit_response) do
+        result = self.__send__(method, *args)
+        response = if not result.kind_of? ::Emissary::Message
+          response = message.response
+          response.status = [ :ok, (result == true || result.nil? ? 'Succeeded.' : result ) ]
+          response
+        else
+          result
+        end
+        
+        send response
+      end
+    end
+    
+    def send message
+      operator.send message
+    end
+  end
+end

data/lib/emissary/agent/emissary.rb

@@ -0,0 +1,163 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+require 'tempfile'
+require 'fileutils'
+
+module Emissary
+  class Agent::Emissary < Agent
+    INIT_DATA = [
+      ::Emissary.identity.name,
+      ::Emissary.identity.public_ip,
+      ::Emissary.identity.local_ip,
+      ::Emissary.identity.instance_id,
+      ::Emissary.identity.server_id,
+      ::Emissary.identity.cluster_id,
+      ::Emissary.identity.account_id,
+      ::Emissary.identity.queue_name,
+      ::Emissary.version
+    ]
+    
+    def valid_methods
+      [ :reconfig, :selfupdate, :startup, :shutdown, :initdata, :reinit ]
+    end
+    
+    def reconfig new_config
+      throw :skip_implicit_response if new_config.strip.empty?
+      
+      if (test(?w, config[:agents][:emissary][:config_path]))
+        begin
+          ((tmp = Tempfile.new('new_config')) << new_config).flush
+          Emissary::Daemon.get_config(tmp.path)
+        rescue Exception => e
+          resonse = message.response
+          response.status_type = :error
+          response.status_note = e.message
+          return response
+        else
+          FileUtils.mv tmp.path, config[:agents][:emissary][:config_path]
+          # signal a USR1 to our parent, which will cause it to kill the
+          # children and restart them after rereading it's configuration
+          Process.kill('HUP', config[:parent_pid])
+        ensure
+          tmp.close
+        end
+      end      
+
+    end
+
+    def selfupdate version = :latest
+      begin
+        emissary_gem = ::Emissary::GemHelper.new('emissary')
+        request_version, source_uri = emissary_gem.versions(version).flatten
+        current_version, _ = emissary_gem.versions(:current).flatten
+
+        unless not emissary_gem.installable? request_version
+          ::Emissary.logger.debug "Emissary SelfUpdate to version '#{request_version.to_s}' requested."
+          new_version = emissary_gem.update(request_version, source_uri)
+          ::Emissary.logger.debug "Emissary gem updated from '#{::Emissary.version}' to '#{new_version}'"
+        else
+          ::Emissary.logger.debug " -- SELFUPDATE -- [         VERSION: #{version}]"
+          ::Emissary.logger.debug " -- SELFUPDATE -- [ CURRENT_VERSION: #{current_version}]"
+          ::Emissary.logger.debug " -- SELFUPDATE -- [ REQUEST_VERSION: #{request_version}]"
+          
+          notice = 'Emissary selfupdate skipped - ' + case true
+            when request_version.nil?
+              if version == :latest
+                "already at latest version."
+              else
+                "non-existent version '#{version}'"
+              end
+            when current_version == request_version
+              "already at specified version #{version}."
+            when current_version > request_version
+              "downgrade to version #{request_version} not allowed."
+            else
+              "unable to update from #{::Emissary.version} to requested version #{request_version}."
+          end
+          ::Emissary.logger.warn notice
+          response = message.response
+          response.status_note = notice
+          return response
+        end
+      rescue ::Gem::InstallError, ::Gem::GemNotFoundException => e
+        ::Emissary.logger.error "Emissary selfupdate failed with reason: #{e.message}"
+        return message.error(e)
+      else
+        ::Emissary.logger.debug "SelfUpdate: About to detach and run commands"
+        with_detached_process('emissary-selfupdate') do
+          %x{
+            emissary stop;
+            sleep 2; 
+            ps uxa | grep -v grep | grep '(emissary|emop_)' | awk '{ print $2 }' | xargs kill -9;
+            sleep 1;
+            source /etc/cloudrc;
+            emissary start -d;
+          }
+        end
+        ::Emissary.logger.debug "SelfUpdate: Child detached"
+        throw :skip_implicit_response
+      end
+    end
+    
+    def startup
+      message = initdata
+      message.recipient = config[:startup]
+      ::Emissary.logger.notice "Sending Startup message with args: #{message.args.inspect}"
+      message
+    end
+    alias :reinit :startup
+    
+    def initdata
+      response = message.response
+      response.args = INIT_DATA
+      response
+    end
+    
+    def shutdown
+      message.recipient = config[:shutdown]
+      message.args = [
+        ::Emissary.identity.server_id,
+        ::Emissary.identity.cluster_id,
+        ::Emissary.identity.account_id,
+        ::Emissary.identity.instance_id
+      ]
+      ::Emissary.logger.notice "Sending Shutdown message with args: #{message.args.inspect}"
+      message
+    end
+
+private
+
+    def with_detached_process(name = nil)
+      raise Exception, 'Block missing for with_detached_process call' unless block_given?
+
+      # completely seperate from our parent process
+      pid = Kernel.fork do
+        Process.setsid
+        exit!(0) if fork
+        $0 = name unless name.nil?
+        Dir.chdir '/'
+        ::Emissary.logger.debug "SelfUpdate: Detached and running update command block now..."
+        yield
+        ::Emissary.logger.debug "SelfUpdate: Finished running update command block - exiting..."
+        exit!(0)
+      end
+
+      ::Emissary.logger.debug "SelfUpdate: Detaching child process now."
+      #don't worry about the child anymore - it's on it's own
+      Process.detach(pid)
+    end
+  end
+end

data/lib/emissary/agent/error.rb

@@ -0,0 +1,26 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+module Emissary
+  class Agent::Error < Agent
+    def valid_methods
+      [ :any ]
+    end
+		
+    def activate
+      message
+    end
+  end
+end

data/lib/emissary/agent/file.rb

@@ -0,0 +1,26 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+module Emissary
+  class Agent::File < Agent
+    def valid_methods
+      [ :any ]
+    end
+		
+    def activate
+      throw :skip_implicit_response 
+    end
+  end
+end

data/lib/emissary/agent/gem.rb

@@ -0,0 +1,42 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+
+module Emissary
+  class Agent::Gem < Agent
+    def valid_methods
+      [ :update, :install, :remove, :uninstall, :version ]
+    end
+
+    def version gem_name
+      ::Emissary.GemHelper.new(gem_name).version
+    end
+    
+    # Updates Emissary from the given source to the given version
+    def install gem_name, version = :latest, source_url = :default
+      ::Emissary::GemHelper.new(gem_name).install(version, source_url)
+    end
+    
+    def update gem_name, version = :latest, source_url = :default
+      ::Emissary::GemHelper.new(gem_name).update(version, source_url)
+    end
+    
+    def uninstall gem_name, version = :latest, ignore_dependencies = true, remove_executables = false
+      ::Emissary::GemHelper.new(gem_name).uninstall(version, ignore_dependencies, remove_executables)
+    end
+    alias :remove :uninstall    
+  end
+
+end

data/lib/emissary/agent/mysql.rb

@@ -0,0 +1,230 @@
+#   Copyright 2010 The New York Times
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+require "mysql"
+require "monitor"
+require 'timeout'
+
+module Emissary
+  class Agent::Mysql < Agent
+    DEFAULT_COORDINATES_FILE = '/var/nyt/mysql/master.coordinates'.freeze
+    
+    def valid_methods
+      [ :lock, :unlock, :status ]
+    end
+
+    attr_accessor :coordinates_file
+    
+    def lock(host, user, password, timeout = Agent::Mysql::Helper::DEFAULT_TIMEOUT, coordinates_file = nil)
+      @coordinates_file ||= coordinates_file
+      @coordinates_file ||= config[:agents][:mysql][:coordinates_file] rescue nil
+      @coordinates_file ||= DEFAULT_COORDINATES_FILE
+      
+      locker = ::Emissary::Agent::Mysql::Helper.new(host, user, password, timeout)
+      locker.lock!
+        
+      filename, position = locker.get_binlog_info
+      
+      unless filename.nil?
+        write_lock_info(filename, position) 
+        response = message.response
+        response.args = [ filename, position ]
+        response.status_note = 'Locked'
+      else
+        response = message.response
+        response.status_note = "No binlog information - can't lock."
+      end
+
+      response
+    end
+    
+    def unlock(host, user, password)
+      locker = ::Emissary::Agent::Mysql::Helper.new(host, user, password)
+      raise "The database was not locked!  (Possibly timed out.)" unless locker.locked?
+
+      locker.unlock!
+      
+      response = message.response
+      response.status_note = 'Unlocked'
+      response
+    end
+    
+    def status(host, user, password)
+      locker = ::Emissary::Agent::Mysql::Helper.new(host, user, password)
+      
+      response = message.response
+      response.status_note = locker.locked? ? 'Locked' : 'Unlocked'
+      response
+    end
+
+    private
+    
+    def write_lock_info(filename, position)
+      File.open(coordinates_file, "w") do |file|
+        file << "#{filename},#{position}"
+      end
+    end
+    
+  end
+  
+  class Agent::Mysql::Helper
+    DEFAULT_TIMEOUT = 30
+
+    @@class_monitor = Monitor.new
+    
+    # only return one locker per host+user combination
+    def self.new(host, user, password, timeout = nil)
+      @@class_monitor.synchronize do
+        (@@lockers||={})["#{host}:#{user}"] ||= begin
+            allocate.instance_eval(<<-EOS, __FILE__, __LINE__)
+              initialize(host, user, password, timeout || DEFAULT_TIMEOUT)
+              self
+            EOS
+        end
+        @@lockers["#{host}:#{user}"].timeout = timeout unless timeout.nil?
+        @@lockers["#{host}:#{user}"]
+      end
+    end
+  
+    @@locked_M = Mutex.new
+    def locked_M() @@locked_M; end
+  
+    private 
+  
+    def initialize(host, user, password, timeout = DEFAULT_TIMEOUT)
+      @host       = host
+      @user       = user
+      @password   = password
+      @timeout    = timeout
+  
+      @watcher    = nil
+      @connection = nil
+      @locked     = false
+    end
+  
+    
+    def connection
+      begin
+        @connection.ping() unless @connection.nil?
+      rescue ::Mysql::Error => e
+        if e.message =~ /server has gone away/
+          ::Emissary.logger.notice "Agent::MySQL: MySQL server went away - reconnecting..."
+          @connection = nil
+        else
+          raise e
+        end
+      end
+      
+      @connection ||= ::Mysql.real_connect(@host, @user, @password)
+    end
+  
+    def disconnect
+      unless not connected?
+        ::Emissary.logger.notice "Agent::MySQL: disconnecting from MySQL Server .."
+        @connection.close
+        @connection = nil
+      end
+    end
+  
+    public
+    attr_accessor :timeout
+    
+    def connected?
+      !!@connection
+    end
+  
+    # Acquire a lock and, with that lock, run a block/closure.
+    def with_lock
+      begin
+        lock! && yield
+      ensure
+        unlock!
+      end
+    end
+  
+    def locked?
+      !!@locked
+    end
+  
+    def lock!
+      unless locked?
+        kill_watcher_thread! # make sure we have a new thread for watching
+        locked_M.synchronize { @locked = true }
+        connection.query("FLUSH TABLES WITH READ LOCK")
+        spawn_lockwatch_thread!
+      end
+    end
+  
+    def unlock!
+      begin
+        unless not locked?
+          locked_M.synchronize {
+            connection.query("UNLOCK TABLES")
+            @locked = false
+          }
+        end
+      ensure
+        disconnect
+        kill_watcher_thread!
+      end
+    end
+  
+    # Test whether our login info is valid by attempting a database 
+    # connection.  
+    def valid?
+      begin
+        !!connection
+      rescue => e
+        false			# Don't throw an exception, just return false.
+      ensure 
+        disconnect if connected? 
+      end
+    end
+  
+    # Returns [file, position] 
+    def get_binlog_info
+      raise "get_binlog_info must be called from within a lock." unless locked?
+      (result = connection.query("SHOW MASTER STATUS")).fetch_row[0,2]
+    ensure
+      result.free unless result.nil?
+    end
+  
+    def spawn_lockwatch_thread!
+      if @watcher.is_a?(Thread) and not @watcher.alive?
+        ::Emissary.logger.notice "Agent::MySQL: Watcher is dead - restarting..."
+        @watcher = nil
+      end
+      
+      @watcher ||= Thread.new {
+        begin
+          ::Emissary.logger.debug "Agent::MySQL: Entering Watcher Loop"
+          Timeout.timeout(@timeout) do
+            loop { break unless locked? }
+          end
+        rescue Timeout::Error
+        ensure
+          unlock!
+          Thread.exit
+        end
+      }
+    end
+    
+    def kill_watcher_thread!
+      @watcher.kill unless not @watcher.is_a?(Thread) or not @watcher.alive?
+      @watcher = nil
+    end
+  end
+end
+