debugger 1.2.4 → 1.3.0

data/test/support/test_interface.rb

@@ -0,0 +1,66 @@
+class TestInterface < Debugger::Interface
+  attr_reader :input_queue, :output_queue, :error_queue, :confirm_queue
+  attr_accessor :command_queue, :test_block, :print_queue
+  attr_accessor :restart_file, :history_save, :history_length, :readline_support, :histfile
+  def initialize
+    @input_queue = []
+    @output_queue = []
+    @error_queue = []
+    @confirm_queue = []
+    @command_queue = []
+    @print_queue = []
+    @readline_support = false
+  end
+
+  def errmsg(*args)
+    @error_queue << format(args)
+  end
+
+  def read_command(*args)
+    if @input_queue.empty? && test_block
+      test_block.call
+      self.test_block = nil
+    end
+    result = @input_queue.shift
+    result.is_a?(Proc) ? result.call : result
+  end
+
+  def print(*args)
+    @output_queue << format(args)
+  end
+
+  def confirm(message)
+    @confirm_queue << message
+    read_command message
+  end
+
+  def readline_support?
+    @readline_support
+  end
+
+  def finalize
+  end
+
+  def close
+  end
+
+  def inspect
+    [
+      "input_queue: #{input_queue.inspect}",
+      "output_queue: #{output_queue.inspect}",
+      "error_queue: #{error_queue.inspect}",
+      "confirm_queue: #{confirm_queue.inspect}",
+      "print_queue: #{print_queue.inspect}"
+    ].join("\n")
+  end
+
+  private
+
+    def format(args)
+      if args.size > 1
+        args.first % args[1..-1]
+      else
+        args.first
+      end
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'debugger'
+Dir.glob(File.expand_path("../support/*.rb", __FILE__)).each { |f| require f }
+
+Debugger::Command.settings[:debuggertesting] = true

data/test/thread_test.rb

@@ -0,0 +1,122 @@
+require_relative 'test_helper'
+
+describe "Thread Command" do
+  include TestDsl
+  let(:release) { 'eval Thread.main[:should_break] = true' }
+
+  describe "list" do
+    it "must show current thread by 'plus' sign" do
+      thnum = nil
+      enter 'break 8', 'cont', 'thread list', release
+      debug_file('thread') { thnum = Debugger.contexts.first.thnum }
+      check_output_includes '+', thnum.to_s, /#<Thread:\S+ run>/, "#{fullpath('thread')}:8"
+    end
+
+    it "must work with shortcut" do
+      thnum = nil
+      enter 'break 8', 'cont', 'th list', release
+      debug_file('thread') { thnum = Debugger.contexts.first.thnum }
+      check_output_includes '+', thnum.to_s, /#<Thread:\S+ run>/, "#{fullpath('thread')}:8"
+    end
+
+
+    it "must show 3 available threads" do
+      enter 'break 21', 'cont', 'thread list', release
+      debug_file 'thread'
+      check_output_includes /#<Thread:\S+ (sleep|run)>/, /#<Thread:\S+ (sleep|run)>/, /#<Thread:\S+ (sleep|run)>/
+    end
+  end
+
+
+  describe "stop" do
+    it "must stop one of the threads" do
+      thnum = nil
+      enter 'break 21', 'cont', ->{"thread stop #{Debugger.contexts.last.thnum}"}, release
+      debug_file('thread') { thnum = Debugger.contexts.last.thnum }
+      check_output_includes "$", thnum.to_s, /#<Thread:/
+    end
+
+    it "must show error message if thread number is not specified" do
+      enter 'break 8', 'cont', "thread stop", release
+      debug_file 'thread'
+      check_output_includes "'thread stop' needs a thread number", interface.error_queue
+    end
+
+    it "must show error message when trying to stop current thread" do
+      enter 'break 8', 'cont', ->{"thread stop #{Debugger.contexts.first.thnum}"}, release
+      debug_file 'thread'
+      check_output_includes "It's the current thread.", interface.error_queue
+    end
+  end
+
+
+  describe "resume" do
+
+    # TODO: This test sometimes causes Segmentation Fault. No idea how to fix it...
+    it "must resume one of the threads"# do
+    #  thnum = nil
+    #  # If we don't put some sleep before 'thread resume', it may not change its status yet... :(
+    #  enter(
+    #    'break 21',
+    #    'cont',
+    #    -> do
+    #      thnum = Debugger.contexts.last.thnum
+    #      "thread stop #{thnum}"
+    #    end,
+    #    -> { puts; "thread resume #{thnum}" },
+    #    -> { puts; release }
+    #  )
+    #  debug_file('thread') { Debugger.contexts.last.suspended?.must_equal false }
+    #  check_output_includes "", thnum.to_s, /#<Thread:/
+    #end
+
+    it "must show error message if thread number is not specified" do
+      enter 'break 8', 'cont', "thread resume", release
+      debug_file 'thread'
+      check_output_includes "'thread resume' needs a thread number", interface.error_queue
+    end
+
+    it "must show error message when trying to resume current thread" do
+      enter 'break 8', 'cont', ->{"thread resume #{Debugger.contexts.first.thnum}"}, release
+      debug_file 'thread'
+      check_output_includes "It's the current thread.", interface.error_queue
+    end
+
+    it "must show error message if it is not stopped" do
+      thnum = nil
+      enter 'break 21', 'cont', ->{"thread resume #{Debugger.contexts.last.thnum}"}, release
+      debug_file('thread') { thnum = Debugger.contexts.last.thnum }
+      check_output_includes "Already running."
+    end
+  end
+
+
+  describe "switch" do
+    it "must switch to another thread"# do
+    #  enter 'break 21', 'cont', ->{"thread #{Debugger.contexts.last.thnum}"}, release
+    #  debug_file('thread') { state.line.must_equal 16 }
+    #end
+
+    it "must show error message if thread number is not specified" do
+      enter 'break 8', 'cont', "thread switch", release
+      debug_file 'thread'
+      check_output_includes "thread thread switch argument 'switch' needs to be a number."
+    end
+
+    it "must show error message when trying to switch current thread" do
+      enter 'break 8', 'cont', ->{"thread switch #{Debugger.contexts.first.thnum}"}, release
+      debug_file 'thread'
+      check_output_includes "It's the current thread.", interface.error_queue
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'thread list'
+      debug_file('post_mortem')
+      check_output_includes "+", /\d+/, /#<Thread:(\S+) run/
+    end
+  end
+
+end

data/test/tmate_test.rb

@@ -0,0 +1,43 @@
+if RUBY_PLATFORM =~ /darwin/
+require_relative 'test_helper'
+
+describe "Tmate Command" do
+  include TestDsl
+
+  it "must open a current file with current frame in Textmate" do
+    Debugger::TextMateCommand.any_instance.expects(:`).with("open 'txmt://open?url=file://#{fullpath('tmate')}&line=7'")
+    enter 'break 7', 'cont', 'tmate'
+    debug_file 'tmate'
+  end
+
+  it "must open a current file with specified frame in Textmate" do
+    Debugger::TextMateCommand.any_instance.expects(:`).with("open 'txmt://open?url=file://#{fullpath('tmate')}&line=4'")
+    enter 'break 7', 'cont', 'tmate 2'
+    debug_file 'tmate'
+  end
+
+  describe "errors" do
+    it "must show an error message if frame == 0" do
+      enter 'tmate 0'
+      debug_file 'tmate'
+      check_output_includes "Wrong frame number"
+    end
+
+    it "must show an error message if frame > max frame" do
+      enter 'tmate 10'
+      debug_file 'tmate'
+      check_output_includes "Wrong frame number"
+    end
+  end
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      Debugger::TextMateCommand.any_instance.expects(:`).with(
+        "open 'txmt://open?url=file://#{fullpath('post_mortem')}&line=8'"
+      )
+      enter 'cont', 'tmate'
+      debug_file 'post_mortem'
+    end
+  end
+end
+end

data/test/trace_test.rb

@@ -0,0 +1,154 @@
+require_relative 'test_helper'
+
+describe "Trace Command" do
+  include TestDsl
+  temporary_set_const(Debugger, "PROG_SCRIPT", fullpath('trace'))
+  temporary_change_hash_value(Debugger::Command.settings, :basename, false)
+  temporary_change_method_value(Debugger, :tracing, false)
+  before { untrace_var(:$bla) if defined?($bla) }
+
+  describe "tracing on the current thread" do
+    describe "enabling" do
+      it "must trace execution by setting trace to on" do
+        temporary_set_const(Debugger, "PROG_SCRIPT", fullpath('trace_threads')) do
+          thnum = nil
+          enter 'trace on'
+          debug_file('trace_threads') { thnum = context.thnum }
+          check_output_includes(
+            "Tracing(#{thnum}):#{fullpath('trace_threads')}:4 @break1 = false",
+            "Tracing(#{thnum}):#{fullpath('trace_threads')}:5 @break2 = false"
+          )
+          check_output_doesnt_include /Tracing\(\d+\):#{fullpath('trace_threads')}:8 until @break1/
+        end
+      end
+
+      it "must show a message it is on" do
+        enter 'trace on'
+        debug_file 'trace'
+        check_output_includes "Tracing on on current thread."
+      end
+
+      it "must be able to use a shortcut" do
+        enter 'tr on'
+        debug_file 'trace'
+        check_output_includes "Tracing on on current thread."
+      end
+    end
+
+    it "must show an error message if given subcommand is incorrect" do
+      enter 'trace bla'
+      debug_file 'trace'
+      check_output_includes "expecting 'on', 'off', 'var' or 'variable'; got: bla", interface.error_queue
+    end
+
+    describe "disabling" do
+      it "must stop tracing by setting trace to off" do
+        thnum = nil
+        enter 'trace on', 'next', 'trace off'
+        debug_file('trace') { thnum = context.thnum }
+        check_output_includes "Tracing(#{thnum}):#{fullpath('trace')}:4 $bla = 4"
+        check_output_doesnt_include "Tracing(#{thnum}):#{fullpath('trace')}:5 $bla = 5"
+      end
+
+      it "must show a message it is off" do
+        enter 'trace off'
+        debug_file 'trace'
+        check_output_includes "Tracing off on current thread."
+      end
+    end
+  end
+
+
+  describe "tracing on all thread" do
+    describe "enabling" do
+      it "must trace execution by setting trace to on" do
+        temporary_set_const(Debugger, "PROG_SCRIPT", fullpath('trace_threads')) do
+          thnum = nil
+          enter 'trace on all'
+          debug_file('trace_threads') { thnum = context.thnum }
+          check_output_includes(
+            "Tracing(#{thnum}):#{fullpath('trace_threads')}:4 @break1 = false",
+            "Tracing(#{thnum}):#{fullpath('trace_threads')}:5 @break2 = false"
+          )
+          check_output_includes /Tracing\(\d+\):#{fullpath('trace_threads')}:8 until @break1/
+        end
+      end
+
+      it "must show a message it is on" do
+        enter 'trace on all'
+        debug_file 'trace'
+        check_output_includes "Tracing on all threads."
+      end
+    end
+
+    describe "disabling" do
+      it "must stop tracing by setting trace to off" do
+        temporary_set_const(Debugger, "PROG_SCRIPT", fullpath('trace_threads')) do
+          thnum = nil
+          enter 'trace on all', 'break 19', 'cont', 'trace off all'
+          debug_file('trace_threads') { thnum = context.thnum }
+          check_output_includes /Tracing\(\d+\):#{fullpath('trace_threads')}:8 until @break1/
+          check_output_includes "Tracing(#{thnum}):#{fullpath('trace_threads')}:19 t1.join"
+          check_output_doesnt_include "Tracing(#{thnum}):#{fullpath('trace_threads')}:20 t1"
+        end
+      end
+
+      it "must show a message it is off" do
+        enter 'trace off'
+        debug_file 'trace'
+        check_output_includes "Tracing off on current thread."
+      end
+    end
+  end
+
+
+  describe "tracing global variables" do
+    it "must track global variable" do
+      enter 'trace variable $bla'
+      debug_file 'trace'
+      check_output_includes(
+        "traced variable $bla has value 3",
+        "traced variable $bla has value 7",
+      )
+    end
+
+    it "must be able to use a shortcut" do
+      enter 'trace var $bla'
+      debug_file 'trace'
+      check_output_includes "traced variable $bla has value 3"
+    end
+
+    it "must track global variable with stop" do
+      enter 'trace variable $bla stop', 'break 7', 'cont'
+      debug_file('trace') { state.line.must_equal 4 }
+    end
+
+    it "must track global variable with nostop" do
+      enter 'trace variable $bla nostop', 'break 7', 'cont'
+      debug_file('trace') { state.line.must_equal 7 }
+    end
+
+    describe "errors" do
+      it "must show an error message if there is no such global variable" do
+        enter 'trace variable $foo'
+        debug_file 'trace'
+        check_output_includes "$foo is not a global variable.", interface.error_queue
+      end
+
+      it "must show an error message if subcommand is invalid" do
+        enter 'trace variable $bla foo'
+        debug_file 'trace'
+        check_output_includes "expecting 'stop' or 'nostop'; got foo", interface.error_queue
+      end
+    end
+  end
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'trace on'
+      debug_file 'post_mortem'
+      check_output_includes "Tracing on on current thread."
+    end
+  end
+
+end

data/test/variables_test.rb

@@ -0,0 +1,114 @@
+require_relative 'test_helper'
+
+describe "Variables Command" do
+  include TestDsl
+  temporary_change_hash_value(Debugger::Command.settings, :width, 40)
+
+  describe "class variables" do
+    it "must show variables" do
+      enter 'break 19', 'cont', 'var class'
+      debug_file 'variables'
+      check_output_includes "@@class_c = 3"
+    end
+
+    it "must be able to use shortcut" do
+      enter 'break 19', 'cont', 'v cl'
+      debug_file 'variables'
+      check_output_includes "@@class_c = 3"
+    end
+  end
+
+  describe "constants" do
+    it "must show constants" do
+      enter 'break 25', 'cont', 'var const VariablesExample'
+      debug_file 'variables'
+      check_output_includes 'SOMECONST => "foo"'
+    end
+
+    it "must be able to use shortcut" do
+      enter 'break 25', 'cont', 'v co VariablesExample'
+      debug_file 'variables'
+      check_output_includes 'SOMECONST => "foo"'
+    end
+
+    it "must show an error message if the given object is not a Class or Module" do
+      enter 'break 25', 'cont', 'var const v'
+      debug_file 'variables'
+      check_output_includes "Should be Class/Module: v"
+    end
+  end
+
+  describe "globals" do
+    it "must show global variables" do
+      enter 'break 25', 'cont', 'var global'
+      debug_file 'variables'
+      check_output_includes '$glob = 100'
+    end
+
+    it "must be able to use shortcut" do
+      enter 'break 25', 'cont', 'v g'
+      debug_file 'variables'
+      check_output_includes '$glob = 100'
+    end
+  end
+
+  describe "instance variables" do
+    it "must show instance variables of the given object" do
+      enter 'break 25', 'cont', 'var instance v'
+      debug_file 'variables'
+      check_output_includes "@inst_a = 1", "@inst_b = 2"
+    end
+
+    it "must show instance variables of self" do
+      enter 'break 11', 'cont', 'var instance'
+      debug_file 'variables'
+      check_output_includes "@inst_a = 1", "@inst_b = 2"
+    end
+
+    it "must show instance variables" do
+      enter 'break 25', 'cont', 'var instance v'
+      debug_file 'variables'
+      check_output_includes "@inst_a = 1", "@inst_b = 2"
+    end
+
+    it "must be able to use shortcut" do
+      enter 'break 25', 'cont', 'v ins v'
+      debug_file 'variables'
+      check_output_includes "@inst_a = 1", "@inst_b = 2"
+    end
+
+    it "must cut long variable values according to :width setting" do
+      temporary_change_hash_value(Debugger::Command.settings, :width, 20) do
+        enter 'break 25', 'cont', 'var instance v'
+        debug_file 'variables'
+        check_output_includes '@inst_c = "1111111111111111...'
+      end
+    end
+
+    it "must show fallback message if value doesn't have #to_s or #inspect methods" do
+      enter 'break 25', 'cont', 'var instance v'
+      debug_file 'variables'
+      check_output_includes '@inst_d = *Error in evaluation*'
+    end
+  end
+
+  describe "local variables" do
+    it "must show local variables" do
+      enter 'break 17', 'cont', 'var local'
+      debug_file 'variables'
+      check_output_includes "a => 4", "b => nil", "i => 1"
+    end
+  end
+
+  # TODO: Need to write tests for 'var ct' command, but I can't install the 'ruby-internal' gem
+  # on my machine, it fails to build gem native extension.
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'var local'
+      debug_file 'post_mortem'
+      check_output_includes "x => nil", "z => 4"
+    end
+  end
+
+end