debugger 1.2.4 → 1.3.0

data/test/conditions_test.rb

@@ -0,0 +1,76 @@
+require_relative 'test_helper'
+
+describe "Conditions" do
+  include TestDsl
+
+  describe "setting condition" do
+    before { enter 'break 3' }
+
+    describe "successfully" do
+      before { enter ->{"cond #{breakpoint.id} b == 5"}, "cont" }
+      it "must stop at the breakpoint if condition is true" do
+        debug_file('conditions') { state.line.must_equal 3 }
+      end
+
+      it "must assign that expression to breakpoint" do
+        debug_file('conditions') { breakpoint.expr.must_equal "b == 5" }
+      end
+    end
+
+    it "must not stop at the breakpoint if condition is false" do
+      enter "break 4", ->{"cond #{breakpoint.id} b == 3"}, "cont"
+      debug_file('conditions') { state.line.must_equal 4 }
+    end
+
+    it "must ignore the condition if its syntax is incorrect" do
+      enter "break 3", ->{"cond #{breakpoint.id} b =="}, "break 4", "cont"
+      debug_file('conditions') { state.line.must_equal 4 }
+    end
+
+    it "must assign the expression to the breakpoint anyway, even if its syntax is incorrect" do
+      enter "break 3", ->{"cond #{breakpoint.id} b =="}, "break 4", "cont"
+      debug_file('conditions') { breakpoint.expr.must_equal "b ==" }
+    end
+
+    it "must work with full command name too" do
+      enter ->{"condition #{breakpoint.id} b == 5"}, "cont"
+      debug_file('conditions') { state.line.must_equal 3 }
+    end
+  end
+
+
+  describe "removing conditions" do
+    before { enter "break 3 if b == 3", "break 4", ->{"cond #{breakpoint.id}"}, "cont" }
+
+    it "must remove the condition from the breakpoint" do
+      debug_file('conditions') { breakpoint.expr.must_be_nil }
+    end
+
+    it "must not stop on the breakpoint" do
+      debug_file('conditions') { state.line.must_equal 3 }
+    end
+  end
+
+
+  describe "errors" do
+    it "must show error if there are no breakpoints" do
+      enter 'cond 1 true'
+      debug_file('conditions')
+      check_output_includes "No breakpoints have been set."
+    end
+
+    it "must not set breakpoint condition if breakpoint id is incorrect" do
+      enter 'break 3', 'cond 8 b == 3', 'cont'
+      debug_file('conditions') { state.line.must_equal 3 }
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must be able to set conditions in post-mortem mode" do
+      enter 'cont', 'break 12', ->{"cond #{breakpoint.id} true"}, 'cont'
+      debug_file("post_mortem") { state.line.must_equal 12 }
+    end
+  end
+
+end

data/test/continue_test.rb

@@ -0,0 +1,28 @@
+require_relative 'test_helper'
+
+describe "Continue Command" do
+  include TestDsl
+
+  it "must continue up to breakpoint" do
+    enter 'break 4', 'continue'
+    debug_file('continue') { state.line.must_equal 4 }
+  end
+
+  it "must continue up to specified line" do
+    enter 'cont 4'
+    debug_file('continue') { state.line.must_equal 4 }
+  end
+
+  it "must ignore the command if there is no specified line" do
+    enter 'cont 123'
+    debug_file('continue') { state.line.must_equal 2 }
+  end
+
+  it "must show error if there is no specified line" do
+    enter 'cont 123'
+    debug_file('continue')
+    check_output_includes "Line 123 is not a stopping point in file \"#{fullpath('continue')}\".", interface.error_queue
+  end
+
+  it "must ignore the line if the context is dead"
+end

data/test/display_test.rb

@@ -0,0 +1,141 @@
+require_relative 'test_helper'
+
+describe "Display Command" do
+  include TestDsl
+
+  it "must show expressions" do
+    enter 'display d + 1', 'break 3', 'cont'
+    debug_file('display')
+    check_output_includes "1: ", "d + 1 = 5"
+  end
+
+  it "must work with shortcut" do
+    enter 'disp d + 1', 'break 3', 'cont'
+    debug_file('display')
+    check_output_includes "1: ", "d + 1 = 5"
+  end
+
+  it "must save displayed expressions" do
+    enter 'display d + 1'
+    debug_file('display') { state.display.must_equal [[true, "d + 1"]] }
+  end
+
+  it "displays all expressions available" do
+    enter 'break 3', 'cont', -> do
+      Debugger.handler.display.concat([[true, "abc"], [true, "d"]]); 'display'
+    end
+    debug_file('display')
+    check_output_includes "1: ", "abc = ", "2: ", "d = 4"
+  end
+
+  describe "undisplay" do
+    describe "undisplay all" do
+      before do
+        enter 'break 3', 'cont', -> do
+          Debugger.handler.display.concat([[true, "abc"], [true, "d"]])
+          'undisplay'
+        end, confirm_response, 'display'
+      end
+
+      describe "confirmation is successful" do
+        let(:confirm_response) { 'y' }
+
+        it "must ask about confirmation" do
+          debug_file('display')
+          check_output_includes "Clear all expressions? (y/n)", interface.confirm_queue
+        end
+
+        it "must set all expressions saved to 'false'" do
+          debug_file('display') { state.display.must_equal [[false, "abc"], [false, "d"]] }
+        end
+
+        it "must not show any output" do
+          debug_file('display')
+          check_output_doesnt_include "1: ", "abc = ", "2: ", "d = 4"
+        end
+      end
+
+      describe "confirmation is unsuccessful" do
+        let(:confirm_response) { 'n' }
+
+        it "must set all expressions saved to 'false'" do
+          debug_file('display') { state.display.must_equal [[true, "abc"], [true, "d"]] }
+        end
+
+        it "must not show any output" do
+          debug_file('display')
+          check_output_includes "1: ", "abc = ", "2: ", "d = 4"
+        end
+      end
+    end
+
+    describe "undisplay specific position" do
+      before do
+        enter 'break 3', 'cont', -> do
+          Debugger.handler.display.concat([[true, "abc"], [true, "d"]])
+          'undisplay 1'
+        end, 'display'
+      end
+
+      it "must set inactive positions" do
+        debug_file('display') { state.display.must_equal [[nil, "abc"], [true, "d"]] }
+      end
+
+      it "must display only the active position" do
+        debug_file('display')
+        check_output_includes "2: ", "d = 4"
+      end
+
+      it "must not display the disabled position" do
+        debug_file('display')
+        check_output_doesnt_include "1: ", "abc"
+      end
+    end
+  end
+
+  describe "disable" do
+    it "must disable a position" do
+      enter 'display d', 'disable display 1'
+      debug_file('display') { state.display.must_equal [[false, "d"]] }
+    end
+
+    it "must show an error if no displays are set" do
+      enter 'disable display 1'
+      debug_file('display')
+      check_output_includes "No display expressions have been set.", interface.error_queue
+    end
+
+    it "must show an error if there is no such display position" do
+      enter 'display d', 'disable display 4'
+      debug_file('display')
+      check_output_includes "Disable display argument '4' needs to at most 1."
+    end
+  end
+
+  describe "enable" do
+    it "must enable a position" do
+      enter 'display d', 'disable display 1', 'enable display 1'
+      debug_file('display') { state.display.must_equal [[true, "d"]] }
+    end
+  end
+
+  describe "annotate" do
+    temporary_change_method_value(Debugger, :annotate, 0)
+
+    it "must show display expression in annotation" do
+      enter 'display 2 + 2', 'set annotate 3', 'next', 'next'
+      debug_file 'display'
+      check_output_includes "\x1A\x1Adisplay", "1:", "2 + 2 = 4"
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must be able to set display expressions in post-mortem mode" do
+      enter 'cont', 'display 2 + 2', 'cont'
+      debug_file("post_mortem")
+      check_output_includes "1:", "2 + 2 = 4"
+    end
+  end
+
+end

data/test/edit_test.rb

@@ -0,0 +1,55 @@
+require_relative 'test_helper'
+
+describe "Edit Command" do
+  include TestDsl
+
+  it "must open an editor with current file and line" do
+    temporary_change_hash_value(ENV, "EDITOR", 'editr') do
+      Debugger::Edit.any_instance.expects(:system).with("editr +2 #{fullpath('edit')}")
+      enter 'edit'
+      debug_file 'edit'
+    end
+  end
+
+  it "must open a default editor with current file and line" do
+    temporary_change_hash_value(ENV, "EDITOR", nil) do
+      Debugger::Edit.any_instance.expects(:system).with("ex +2 #{fullpath('edit')}")
+      enter 'edit'
+      debug_file 'edit'
+    end
+  end
+
+  it "must open an editor with specified file and line" do
+    temporary_change_hash_value(ENV, "EDITOR", 'editr') do
+      Debugger::Edit.any_instance.expects(:system).with("editr +3 #{fullpath('edit2')}")
+      enter "edit #{fullpath('edit2')}:3"
+      debug_file 'edit'
+    end
+  end
+
+  it "must show an error if there is no such line" do
+    enter "edit #{fullpath('edit3')}:6"
+    debug_file 'edit'
+    check_output_includes "File \"#{fullpath('edit3')}\" is not readable.", interface.error_queue
+  end
+
+  it "must show an error if there is incorrect syntax" do
+    enter "edit blabla"
+    debug_file 'edit'
+    check_output_includes "Invalid file/line number specification: blabla", interface.error_queue
+  end
+
+
+  describe "Post Mortem" do
+    # TODO: This test fails with "Segmentation fault". Probably need to fix it somehow, or forbid this
+    # command in the post mortem mode
+    it "must work in post-mortem mode"
+    #  temporary_change_hash_value(ENV, "EDITOR", 'editr') do
+    #    Debugger::Edit.any_instance.expects(:system).with("editr +2 #{fullpath('edit')}")
+    #    enter 'cont', "edit #{fullpath('edit')}:2", 'cont'
+    #    debug_file "post_mortem"
+    #  end
+    #end
+  end
+
+end

data/test/eval_test.rb

@@ -0,0 +1,92 @@
+require_relative 'test_helper'
+
+describe "Eval Command" do
+  include TestDsl
+
+  it "must evaluate an expression" do
+    enter 'eval 3 + 2'
+    debug_file 'eval'
+    check_output_includes "5"
+  end
+
+  it "must work with shortcut" do
+    enter 'e 3 + 2'
+    debug_file 'eval'
+    check_output_includes "5"
+  end
+
+  it "must work with another syntax" do
+    enter 'p 3 + 2'
+    debug_file 'eval'
+    check_output_includes "5"
+  end
+
+  describe "autoeval" do
+    temporary_change_hash_value(Debugger::Command.settings, :autoeval, false)
+
+    it "must eval the expression if no matching command is found" do
+      enter 'set autoeval', '[5,6,7].inject(&:+)'
+      debug_file 'eval'
+      check_output_includes "18"
+    end
+  end
+
+  describe "stack trace on error" do
+    temporary_change_hash_value(Debugger::Command.settings, :stack_trace_on_error, false)
+
+    it "must show a stack trace if showing trace on error is enabled" do
+      enter 'set notrace', 'eval 2 / 0'
+      debug_file 'eval'
+      check_output_includes "ZeroDivisionError Exception: divided by 0"
+      check_output_doesnt_include /\S+:\d+:in `eval':divided by 0/
+    end
+
+    it "must show a stack trace if showing trace on error is enabled" do
+      enter 'set trace', 'eval 2 / 0'
+      debug_file 'eval'
+      check_output_includes /\S+:\d+:in `eval':divided by 0/
+      check_output_doesnt_include "ZeroDivisionError Exception: divided by 0"
+    end
+  end
+
+
+  it "must pretty print the expression result" do
+    enter 'pp {a: "3" * 40, b: "4" * 30}'
+    debug_file 'eval'
+    check_output_includes "{:a=>\"#{"3" * 40}\",\n :b=>\"#{"4" * 30}\"}"
+  end
+
+  it "must print expression and columnize the result" do
+    temporary_change_hash_value(Debugger::PutLCommand.settings, :width, 20) do
+      enter 'putl [1, 2, 3, 4, 5, 9, 8, 7, 6]'
+      debug_file 'eval'
+      check_output_includes "1  3  5  8  6\n2  4  9  7"
+    end
+  end
+
+  it "must print expression and sort and columnize the result" do
+    temporary_change_hash_value(Debugger::PSCommand.settings, :width, 20) do
+      enter 'ps [1, 2, 3, 4, 5, 9, 8, 7, 6]'
+      debug_file 'eval'
+      check_output_includes "1  3  5  7  9\n2  4  6  8"
+    end
+  end
+
+  it "must set width by the 'set' command" do
+    temporary_change_hash_value(Debugger::PSCommand.settings, :width, 20) do
+      enter 'set width 10', 'ps [1, 2, 3, 4, 5, 9, 8, 7, 6]'
+      debug_file 'eval'
+      check_output_includes "1  4  7\n2  5  8\n3  6  9"
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'eval 2 + 2'
+      debug_file "post_mortem"
+      check_output_includes "4"
+    end
+  end
+
+end

data/test/examples/breakpoint1.rb

@@ -0,0 +1,15 @@
+class A
+  def self.a
+    4
+  end
+  def b
+    3
+  end
+end
+
+a = 3
+# A comment
+debugger
+b = 5
+c = a + b
+load Pathname.new(__FILE__ + "/../breakpoint2.rb").cleanpath

data/test/examples/breakpoint2.rb

@@ -0,0 +1,7 @@
+d = 4
+c = 3
+e = 3 + 4
+f = e + 5
+
+A.a
+A.new.b

data/test/examples/conditions.rb

@@ -0,0 +1,4 @@
+debugger
+b = 5
+c = b + 5
+c

data/test/examples/continue.rb

@@ -0,0 +1,4 @@
+debugger
+b = 5
+c = b + 5
+c

data/test/examples/display.rb

@@ -0,0 +1,5 @@
+debugger
+d = 4
+d = d + 2
+d = d + 3
+d = d + 6

data/test/examples/edit.rb

@@ -0,0 +1,3 @@
+debugger
+d = 1
+b = 2