crash-watch 1.1.12 → 1.2.0

data/lib/crash_watch/lldb_controller.rb

@@ -0,0 +1,178 @@
+# encoding: binary
+#
+# Copyright (c) 2016 Phusion Holding B.V.
+#
+# 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 'rbconfig'
+require 'crash_watch/base'
+require 'crash_watch/utils'
+
+module CrashWatch
+  class LldbNotFound < Error
+  end
+
+  class LldbController
+    class ExitInfo
+      attr_reader :exit_code, :signal, :backtrace, :snapshot
+
+      def initialize(exit_code, signal, backtrace, snapshot)
+        @exit_code = exit_code
+        @signal = signal
+        @backtrace = backtrace
+        @snapshot = snapshot
+      end
+
+      def signaled?
+        !!@signal
+      end
+    end
+
+    END_OF_RESPONSE_MARKER = '--------END_OF_RESPONSE--------'
+
+    attr_accessor :debug
+
+    def initialize
+      @pid, @in, @out = Utils.popen_command(find_lldb, "-x")
+      execute("settings set prompt 'LLDB:'")
+      execute("settings set auto-confirm false")
+    end
+
+    def execute(command_string, timeout = nil)
+      raise "LLDB session is already closed" if !@pid
+      puts "lldb write #{command_string.inspect}" if @debug
+      marker = "\n#{END_OF_RESPONSE_MARKER}\n"
+      @in.puts(command_string)
+      @in.puts("script print #{marker.inspect}")
+      done = false
+      result = []
+      while !done
+        begin
+          if select([@out], nil, nil, timeout)
+            line = @out.readline.chomp
+            line.sub!(/^LLDB:/, '')
+            puts "lldb read #{line.inspect}" if @debug
+            if line == "#{END_OF_RESPONSE_MARKER}"
+              done = true
+            else
+              result << line
+            end
+          else
+            close!
+            done = true
+            result = nil
+          end
+        rescue EOFError
+          done = true
+        end
+      end
+
+      if result
+        # Remove echo of the command string
+        result.slice!(0, 2)
+        # Remove echo of the marker print command
+        result.pop
+        result.pop
+
+        result.join("\n") << "\n"
+      else
+        nil
+      end
+    end
+
+    def closed?
+      !@pid
+    end
+
+    def close
+      if !closed?
+        begin
+          execute("process detach", 5) if !closed?
+          execute("quit", 5) if !closed?
+        rescue Errno::EPIPE
+        end
+        if !closed?
+          @in.close
+          @out.close
+          Process.waitpid(@pid)
+          @pid = nil
+        end
+      end
+    end
+
+    def close!
+      if !closed?
+        @in.close
+        @out.close
+        Process.kill('KILL', @pid)
+        Process.waitpid(@pid)
+        @pid = nil
+      end
+    end
+
+    def attach(pid)
+      pid = pid.to_s.strip
+      raise ArgumentError if pid.empty?
+      result = execute("attach -p #{pid}")
+      result !~ /(unable to attach|cannot attach)/
+    end
+
+    def program_counter
+      execute("p/x $pc").gsub(/.* = /, '')
+    end
+
+    def current_thread
+      execute("thread info") =~ /^thread #(.+?): /
+      $1
+    end
+
+    def current_thread_backtrace
+      execute("bt").strip
+    end
+
+    def all_threads_backtraces
+      execute("bt all").strip
+    end
+
+  private
+    def find_lldb
+      result = nil
+      if ENV['LLDB'] && File.executable?(ENV['LLDB'])
+        result = ENV['LLDB']
+      else
+        ENV['PATH'].to_s.split(/:+/).each do |path|
+          filename = "#{path}/lldb"
+          if File.file?(filename) && File.executable?(filename)
+            result = filename
+            break
+          end
+        end
+      end
+
+      puts "Found lldb at: #{result}" if result
+
+      if result.nil?
+        raise LldbNotFound
+      else
+        result
+      end
+    end
+  end
+end

data/lib/crash_watch/packaging.rb

@@ -1,15 +1,34 @@
+# Copyright (c) 2010-2016 Phusion Holding B.V.
+#
+# 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.
+
 CRASH_WATCH_FILES = [
-	"README.markdown",
-	"LICENSE.txt",
-	"Rakefile",
-	"crash-watch.gemspec",
-	"bin/**/*",
-	"lib/**/*",
-	"test/**/*"
+  "README.markdown",
+  "LICENSE.txt",
+  "Rakefile",
+  "crash-watch.gemspec",
+  "bin/**/*",
+  "lib/**/*",
+  "test/**/*"
 ]
 
 CRASH_WATCH_EXCLUDE_FILES = [
-	"Rakefile",
-	"debian.template/**/*",
-	"rpm/**/*"
+  "Rakefile"
 ]

data/lib/crash_watch/utils.rb

@@ -0,0 +1,94 @@
+# encoding: binary
+#
+# Copyright (c) 2016 Phusion Holding B.V.
+#
+# 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 CrashWatch
+  module Utils
+    extend Utils
+
+    def self.included(klass)
+      # When included into another class, make sure that Utils
+      # methods are made private.
+      public_instance_methods(false).each do |method_name|
+        klass.send(:private, method_name)
+      end
+    end
+
+    def gdb_installed?
+      command_installed?('gdb')
+    end
+
+    def lldb_installed?
+      command_installed?('lldb')
+    end
+
+    def command_installed?(command)
+      path = ENV['PATH'].to_s
+      path.split(File::PATH_SEPARATOR).each do |dir|
+        next if dir.empty?
+        filename = "#{dir}/#{command}"
+        if File.file?(filename) && File.executable?(filename)
+          return true
+        end
+      end
+      false
+    end
+
+    def popen_command(*command)
+      a, b = IO.pipe
+      c, d = IO.pipe
+      if Process.respond_to?(:spawn)
+        args = command.dup
+        args << {
+          STDIN  => a,
+          STDOUT => d,
+          STDERR => d,
+          :close_others => true
+        }
+        pid = Process.spawn(*args)
+      else
+        pid = fork do
+          STDIN.reopen(a)
+          STDOUT.reopen(d)
+          STDERR.reopen(d)
+          b.close
+          c.close
+          exec(*command)
+        end
+      end
+      a.close
+      d.close
+      b.binmode
+      c.binmode
+      [pid, b, c]
+    end
+
+    def find_signal_name(signo)
+      Signal.list.each_pair do |name, number|
+        if number == signo
+          return name
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/crash_watch/version.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2010-2016 Phusion Holding B.V.
+#
+# 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 CrashWatch
-	VERSION_STRING = '1.1.12'
+  VERSION_STRING = '1.2.0'
 end

data/test/controller_sharedspec.rb

@@ -0,0 +1,34 @@
+require 'shellwords'
+
+shared_examples_for 'a CrashWatch controller' do
+  def run_script_and_wait(code, snapshot_callback = nil, &block)
+    @process = IO.popen(%Q{exec ruby -e #{Shellwords.escape code}}, 'w')
+    @gdb.attach(@process.pid)
+    thread = Thread.new do
+      sleep 0.1
+      if block
+        block.call
+      end
+      @process.write("\n")
+    end
+    exit_info = @gdb.wait_until_exit(&snapshot_callback)
+    thread.join
+    exit_info
+  end
+
+  describe "#attach" do
+    before :each do
+      @process = IO.popen("exec ruby -e 'sleep 9999'", "w")
+    end
+
+    it "returns true if attaching worked" do
+      expect(@gdb.attach(@process.pid)).to be_truthy
+    end
+
+    it "returns false if the PID doesn't exist" do
+      Process.kill('KILL', @process.pid)
+      sleep 0.25
+      expect(@gdb.attach(@process.pid)).to be_falsey
+    end
+  end
+end

data/test/gdb_controller_spec.rb

@@ -1,116 +1,89 @@
 source_root = File.expand_path(File.dirname(__FILE__) + "/..")
-$LOAD_PATH.unshift("#{source_root}/lib")
-Thread.abort_on_exception = true
-
+require "#{source_root}/test/spec_helper"
+require "#{source_root}/test/controller_sharedspec"
 require 'crash_watch/gdb_controller'
+require 'crash_watch/utils'
+
+if CrashWatch::Utils.gdb_installed?
+  describe CrashWatch::GdbController do
+    before :each do
+      @gdb = CrashWatch::GdbController.new
+    end
+
+    after :each do
+      @gdb.close
+      if @process
+        Process.kill('KILL', @process.pid)
+        @process.close
+      end
+    end
+
+    include_examples 'a CrashWatch controller'
+
+    describe "#execute" do
+      it "executes the desired command and returns its output" do
+        expect(@gdb.execute("echo hello world")).to eq("hello world\n")
+      end
+    end
+
+    describe "#wait_until_exit" do
+      it "returns the expected information if the process exited normally" do
+        exit_info = run_script_and_wait('STDIN.readline')
+        expect(exit_info.exit_code).to eq(0)
+        expect(exit_info).not_to be_signaled
+      end
+
+      it "returns the expected information if the process exited with a non-zero exit code" do
+        exit_info = run_script_and_wait('STDIN.readline; exit 3')
+        expect(exit_info.exit_code).to eq(3)
+        expect(exit_info).not_to be_signaled
+        expect(exit_info.backtrace).not_to be_nil
+        expect(exit_info.backtrace).not_to be_empty
+      end
+
+      it "returns the expected information if the process exited because of a signal" do
+        exit_info = run_script_and_wait(
+          'STDIN.readline;' +
+          'require "rubygems";' +
+          'require "ffi";' +
+          'module MyLib;' +
+            'extend FFI::Library;' +
+            'ffi_lib "c";' +
+            'attach_function :abort, [], :void;' +
+          'end;' +
+          'MyLib.abort')
+        expect(exit_info).to be_signaled
+        expect(exit_info.backtrace).to match(/abort/)
+      end
+
+      it "ignores non-fatal signals" do
+        exit_info = run_script_and_wait('trap("INT") { }; STDIN.readline; exit 2') do
+          Process.kill('INT', @process.pid)
+        end
+        expect(exit_info.exit_code).to eq(2)
+        expect(exit_info).not_to be_signaled
+        expect(exit_info.backtrace).not_to be_nil
+        expect(exit_info.backtrace).not_to be_empty
+      end
 
-describe CrashWatch::GdbController do
-	before :each do
-		@gdb = CrashWatch::GdbController.new
-	end
-	
-	after :each do
-		@gdb.close
-		if @process
-			Process.kill('KILL', @process.pid)
-			@process.close
-		end
-	end
-	
-	def run_script_and_wait(code, snapshot_callback = nil, &block)
-		@process = IO.popen(%Q{ruby -e '#{code}'}, 'w')
-		@gdb.attach(@process.pid)
-		thread = Thread.new do
-			sleep 0.1
-			if block
-				block.call
-			end
-			@process.write("\n")
-		end
-		exit_info = @gdb.wait_until_exit(&snapshot_callback)
-		thread.join
-		return exit_info
-	end
-	
-	describe "#execute" do
-		it "executes the desired command and returns its output" do
-			@gdb.execute("echo hello world").should == "hello world\n"
-		end
-	end
-	
-	describe "#attach" do
-		before :each do
-			@process = IO.popen("sleep 9999", "w")
-		end
-		
-		it "returns true if attaching worked" do
-			@gdb.attach(@process.pid).should be_true
-		end
-		
-		it "returns false if the PID doesn't exist" do
-			Process.kill('KILL', @process.pid)
-			sleep 0.25
-			@gdb.attach(@process.pid).should be_false
-		end
-	end
-	
-	describe "#wait_until_exit" do
-		it "returns the expected information if the process exited normally" do
-			exit_info = run_script_and_wait('STDIN.readline')
-			exit_info.exit_code.should == 0
-			exit_info.should_not be_signaled
-		end
-		
-		it "returns the expected information if the process exited with a non-zero exit code" do
-			exit_info = run_script_and_wait('STDIN.readline; exit 3')
-			exit_info.exit_code.should == 3
-			exit_info.should_not be_signaled
-			exit_info.backtrace.should_not be_nil
-			exit_info.backtrace.should_not be_empty
-		end
-		
-		it "returns the expected information if the process exited because of a signal" do
-			exit_info = run_script_and_wait(
-				'STDIN.readline;' +
-				'require "rubygems";' +
-				'require "ffi";' +
-				'module MyLib;' +
-					'extend FFI::Library;' +
-					'ffi_lib "c";' +
-					'attach_function :abort, [], :void;' +
-				'end;' +
-				'MyLib.abort')
-			exit_info.should be_signaled
-			exit_info.backtrace.should =~ /abort/
-		end
-		
-		it "ignores non-fatal signals" do
-			exit_info = run_script_and_wait('trap("INT") { }; STDIN.readline; exit 2') do
-				Process.kill('INT', @process.pid)
-			end
-			exit_info.exit_code.should == 2
-			exit_info.should_not be_signaled
-			exit_info.backtrace.should_not be_nil
-			exit_info.backtrace.should_not be_empty
-		end
-		
-		it "returns information of the signal that aborted the process, not information of ignored signals" do
-			exit_info = run_script_and_wait(
-				'trap("INT") { };' +
-				'STDIN.readline;' +
-				'require "rubygems";' +
-				'require "ffi";' +
-				'module MyLib;' +
-					'extend FFI::Library;' +
-					'ffi_lib "c";' +
-					'attach_function :abort, [], :void;' +
-				'end;' +
-				'MyLib.abort'
-			) do
-				Process.kill('INT', @process.pid)
-			end
-			exit_info.should be_signaled
-			exit_info.backtrace.should =~ /abort/
-		end
-	end
-end
+      it "returns information of the signal that aborted the process, not information of ignored signals" do
+        exit_info = run_script_and_wait(
+          'trap("INT") { };' +
+          'STDIN.readline;' +
+          'require "rubygems";' +
+          'require "ffi";' +
+          'module MyLib;' +
+            'extend FFI::Library;' +
+            'ffi_lib "c";' +
+            'attach_function :abort, [], :void;' +
+          'end;' +
+          'MyLib.abort'
+        ) do
+          Process.kill('INT', @process.pid)
+        end
+        expect(exit_info).to be_signaled
+        expect(exit_info.backtrace).to match(/abort/)
+      end
+    end
+  end
+end