console-mux 2.0.2

data/lib/console/mux/process.rb

@@ -0,0 +1,206 @@
+#
+# Copyright (C) 2012 Common Ground Publishing
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'log4r'
+require 'pty'
+
+require 'console/mux/env_with_merged'
+require 'console/mux/pty_handler'
+require 'console/mux/events'
+
+module Console
+  module Mux
+    class Process
+      include Log4r
+      include Console::Mux::Events
+
+      attr_reader :command, :pid, :logger, :started_at, :name
+
+      class << self
+        alias_method :start, :new
+      end
+
+      def initialize(command, name = nil)
+        @command = command
+        @name = name
+        @logger = Logger["process::#{name}"] || Logger.new("process::#{name}")
+        start
+      end
+
+      def stop(&block)
+        if @handler
+          @handler.detach
+        end
+      end
+
+      def running?
+        @handler != nil
+      end
+
+      def name
+        command.name
+      end
+
+      def to_s
+        "#{command} (#{running? ? pid : 'stopped'})"
+      end
+
+      # Called by the child handler
+      def unbind
+        @stdin.close rescue nil
+        @stdout.close rescue nil
+
+        pid2, status = ::Process.waitpid2(pid, ::Process::WNOHANG)
+        if pid2
+          on_exit(status)
+        else
+          try_kill(['INT', 'TERM', 'KILL'])
+        end
+      end
+
+      def receive_line(line)
+        logger.info { line }
+      end
+
+      # @return [Integer] uptime in seconds
+      def uptime
+        Time.now.to_i - started_at.to_i
+      end
+
+      # Capture the output of a single field using the 'ps' command.
+      def ps1(field)
+        `ps -o #{field}= -p #{pid}`.strip
+      end
+
+      # @return [String] elapsed time
+      def etime
+        ps1('etime')
+      end
+
+      # @return [Integer] resident size in bytes
+      def rss
+        ps1('rss').to_i * 1024
+      end
+
+      # @return [String] cputime in 
+      def cputime
+        ps1('cputime')
+      end
+
+      protected
+
+      # This is for comparison purposes.
+      def to_hash
+        {
+          :name => name,
+          :command => command,
+          :opts => opts
+        }
+      end
+
+      private
+
+      # Clean some common crud from ENV before spawning a command.
+      def with_clean_env(env)
+        ENV.restore do
+          ENV.delete_if do |k,_|
+            k.start_with?('BUNDLE_') ||
+              k == 'RUBY' ||
+              k.start_with?('GEM_')
+          end
+          ENV.update(env)
+          yield
+        end
+      end
+
+      def start
+        raise 'already started' if @handler
+
+        @started_at = Time.now
+
+        stdin, stdout, pid = Dir.chdir command.dir do
+          with_clean_env(command.env) do
+            PTY.spawn(command.commandline)
+          end
+        end
+
+        @stdin = stdin
+        @stdout = stdout
+        @pid = pid
+        
+        logger.info { "in #{File.expand_path(command.dir)}" }
+        logger.info { "with #{command.env.to_a.map{|k,v| "#{k}=#{v}"}.join(' ')}" }
+        logger.info { command }
+        logger.info { "started process #{pid}" }
+        
+        @handler = EventMachine.attach(stdout, PTYHandler, self)
+      end
+
+      def try_kill(signals)
+        if (signals.size > 0)
+          signal = signals.shift
+          logger.info "sending #{signal} to #{pid}"
+          ::Process.kill(signal, pid) rescue nil
+          
+          check(20, 0.1) do
+            try_kill(signals)
+          end
+        else
+          on_exit(nil)
+        end
+      end
+
+      def check(tries, period, &on_fail)
+        if tries <= 0
+          on_fail.call
+          return
+        end
+
+        EventMachine.add_timer(period) do
+          pid2, status = ::Process.waitpid2(pid, ::Process::WNOHANG)
+          if !pid2
+            check(tries - 1, period, &on_fail)
+          else
+            on_exit(status)
+          end
+        end
+      end
+
+      def on_exit(status)
+        begin
+          if status == nil
+            logger.warn { "error killing process #{pid}" }
+          elsif status.signaled?
+            signo = status.termsig
+            signm = SignalException.new(signo).signm
+            logger.warn { "process #{pid} exited with uncaught signal #{signm} (#{signo})" }
+          elsif status.exited?
+            logger.info { "process #{pid} exited #{status.exitstatus}" }
+          else
+            logger.warn { "process #{pid} exited #{status.inspect}" }
+          end
+        ensure
+          @handler = nil
+          fire(:exit)
+        end
+      end
+    end
+  end
+end

data/lib/console/mux/pty_handler.rb

@@ -0,0 +1,46 @@
+#
+# Copyright (C) 2012 Common Ground Publishing
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Console
+  module Mux
+    # Handle input from a PTY that has been connected to EventMachine
+    module PTYHandler
+      include EventMachine::Protocols::LineText2
+
+      attr_reader :parent
+
+      # @param [Object] parent unbind and receive_line events are
+      # forwarded to this object
+      def initialize(parent)
+        super()
+        @parent = parent
+      end
+      
+      def unbind
+        parent.unbind
+        super
+      end
+      
+      def receive_line(line)
+        parent.receive_line(line)
+      end
+    end
+  end
+end

data/lib/console/mux/rolling_array.rb

@@ -0,0 +1,41 @@
+#
+# Copyright (C) 2012 Common Ground Publishing
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Console
+  module Mux
+    # Array that limits itself to some fixed size.  Newly added elements
+    # kick out the oldest element when at the limit.
+    class RollingArray < Array
+      attr_accessor :maxsize
+
+      # @param maxsize the maximum size of the array
+      def initialize(maxsize)
+        @maxsize = maxsize
+      end
+
+      # Append an element to the array.  If the size of the array would
+      # overflow the maxsize, the array is shifted.
+      def <<(other)
+        super
+        shift if size > maxsize
+      end
+    end
+  end
+end

data/lib/console/mux/run_with.rb

@@ -0,0 +1,74 @@
+#
+# Copyright (C) 2012 Common Ground Publishing
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Console
+  module Mux
+    class RunWith
+      class << self
+        # A filter for running a command with RVM shell.  Looks at the
+        # :ruby option.
+        #
+        # @param [Command] c
+        # @param [String] str the command string
+        def rvm_shell(c, str)
+          rvm_command = 'rvm-shell '
+          rvm_command += "'#{c[:ruby]}' " if c[:ruby]
+          rvm_command += "-c '#{str}'"
+          rvm_command
+        end
+
+        # A filter for running a command with rbenv. Sets RBENV_VERSION
+        # environment var will be set to the value of the :ruby
+        # option.
+        #
+        # @param [Command] c
+        # @param [String] str the command string
+        def rbenv(c, str)
+          c.env['RBENV_VERSION'] = c[:ruby]
+
+          # Strip out any rbenv version bin path.  Assumes rbenv is
+          # installed in .rbenv.  This is necessary because if we run
+          # console-mux via an rbenv shim, that shim first tacks on
+          # the bin path to the in-use ruby version prior to exec'ing
+          # the actual console-mux...  But we don't want that path to
+          # follow down to sub processes spawned by console-mux.
+          c.env['PATH'] =
+            ENV['PATH'].
+            split(File::PATH_SEPARATOR).
+            reject{|p| p =~ %r{.rbenv/versions}}.
+            join(File::PATH_SEPARATOR)
+          
+          str
+        end
+
+        # A filter for running a command with bundle exec.  Ensures
+        # the BUNDLE_GEMFILE environment variable is cleared before
+        # running bundle exec.
+        def bundle_exec(c, str)
+          "bundle exec #{str}"
+        end
+
+        def bundle_exec_sh(c, str)
+          "#{::Console::Mux::BUNDLE_EXEC_SH} #{str}"
+        end
+      end
+    end
+  end
+end

data/lib/console/mux/shell.rb

@@ -0,0 +1,85 @@
+#
+# Copyright (C) 2012 Common Ground Publishing
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Console
+  module Mux
+    # The interactive console is run within an instance of Shell.  All
+    # instance methods are thus available as user commands.
+    class Shell
+      attr_reader :console
+
+      class << self
+        def delegate(obj_getter, method_syms)
+          method_syms.each do |sym|
+            send(:define_method, sym) do |*args, &block|
+              obj = send(obj_getter)
+              obj.send(sym, *args, &block)
+            end
+          end
+        end
+
+        def delegate_ok(obj_getter, method_syms)
+          method_syms.each do |sym|
+            send(:define_method, sym) do |*args, &block|
+              obj = send(obj_getter)
+              obj.send(sym, *args, &block)
+              :ok
+            end
+          end
+        end
+      end
+
+      def initialize(console)
+        @console = console
+      end
+
+      def commands
+        console.commands
+      end
+
+      delegate :console, [
+                          :default_options
+                         ]
+
+      delegate_ok :console, [
+                             :status,
+                             :lastlog,
+                             :run,
+                             :start,
+                             :stop,
+                             :restart,
+                             :set_default_options,
+                             :shutdown
+                            ]
+
+      # Yield the block with +hash+ merged into the default options.
+      # The options are restored.
+      def with_defaults(hash={})
+        orig_options = default_options
+        set_default_options(default_options.merge(hash))
+        begin
+          yield
+        ensure
+          set_default_options(orig_options)
+        end
+      end
+    end
+  end
+end