debugger 1.2.4 → 1.3.0

data/test/help_test.rb

@@ -0,0 +1,50 @@
+require_relative 'test_helper'
+
+describe "Help Command" do
+  include TestDsl
+  include Columnize
+
+  let(:available_commands) do
+    Debugger::Command.commands.select(&:event).map(&:help_command).flatten.uniq.sort
+  end
+
+  it "must show help how to use 'help'" do
+    temporary_change_hash_value(Debugger::HelpCommand.settings, :width, 50) do
+      enter 'help'
+      debug_file('help')
+      check_output_includes(
+        "Type 'help <command-name>' for help on a specific command",
+        "Available commands:",
+        columnize(available_commands, 50)
+      )
+    end
+  end
+
+  it "must show help when use shortcut" do
+    enter 'h'
+    debug_file('help')
+    check_output_includes "Type 'help <command-name>' for help on a specific command"
+  end
+
+  it "must show an error if undefined command is specified" do
+    enter 'help foobar'
+    debug_file('help')
+    check_output_includes 'Undefined command: "foobar".  Try "help".', interface.error_queue
+  end
+
+  it "must show a command's help" do
+    enter 'help break'
+    debug_file('help')
+    check_output_includes Debugger::AddBreakpoint.help(nil).split("\n").map { |l| l.gsub(/^ +/, '') }.join("\n")
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'help'
+      debug_file "post_mortem"
+      check_output_includes "Available commands:"
+    end
+  end
+
+end

data/test/info_test.rb

@@ -0,0 +1,325 @@
+require_relative 'test_helper'
+
+describe "Info Command" do
+  include TestDsl
+  include Columnize
+
+  describe "Args info" do
+    temporary_change_hash_value(Debugger::InfoCommand.settings, :width, 15)
+
+    it "must show info about all args" do
+      enter 'break 3', 'cont', 'info args'
+      debug_file 'info'
+      check_output_includes 'a = "aaaaaaa...', 'b = "b"'
+    end
+  end
+
+  describe "Breakpoints info" do
+    it "must show info about all breakpoints" do
+      enter 'break 7', 'break 9 if a == b', 'info breakpoints'
+      debug_file 'info'
+      check_output_includes(
+        "Num Enb What",
+        /\d+ y   at #{fullpath('info')}:7/,
+        /\d+ y   at #{fullpath('info')}:9 if a == b/
+      )
+    end
+
+    it "must show info about specific breakpoint" do
+      enter 'break 7', 'break 9', ->{"info breakpoints #{breakpoint.id}"}
+      debug_file 'info'
+      check_output_includes "Num Enb What", /\d+ y   at #{fullpath('info')}:7/
+      check_output_doesnt_include  /\d+ y   at #{fullpath('info')}:9/
+    end
+
+    it "must show an error if no breakpoints are found" do
+      enter 'info breakpoints'
+      debug_file 'info'
+      check_output_includes "No breakpoints."
+    end
+
+    it "must show an error if no breakpoints are found" do
+      enter 'break 7', 'info breakpoints 123'
+      debug_file 'info'
+      check_output_includes "No breakpoints found among list given.", interface.error_queue
+    end
+
+    it "must show hit count" do
+      enter 'break 9', 'cont', 'info breakpoints'
+      debug_file 'info'
+      check_output_includes /\d+ y   at #{fullpath('info')}:9/, "breakpoint already hit 1 time"
+    end
+  end
+
+  describe "Display info" do
+    it "must show all display expressions" do
+      enter 'display 3 + 3', 'display a + b', 'info display'
+      debug_file 'info'
+      check_output_includes(
+        "Auto-display expressions now in effect:",
+        "Num Enb Expression",
+          "1: y  3 + 3",
+          "2: y  a + b"
+      )
+    end
+
+    it "must show a message if there are no display expressions created" do
+      enter 'info display'
+      debug_file 'info'
+      check_output_includes "There are no auto-display expressions now."
+    end
+  end
+
+  describe "Files info" do
+    let(:files) { (LineCache.cached_files + SCRIPT_LINES__.keys).uniq.sort }
+    it "must show all files read in" do
+      enter 'info files'
+      debug_file 'info'
+      check_output_includes files.map { |f| "File #{f}" }
+    end
+
+    it "must show all files read in using 'info file' too" do
+      enter 'info file'
+      debug_file 'info'
+      check_output_includes files.map { |f| "File #{f}" }
+    end
+
+    it "must show explicitly loaded files" do
+      enter 'info files stat'
+      debug_file 'info'
+      check_output_includes "File #{fullpath('info')}", LineCache.stat(fullpath('info')).mtime.to_s
+    end
+  end
+
+  describe "File info" do
+    let(:file) { fullpath('info') }
+    let(:filename) { "File #{file}" }
+    let(:lines) { "#{LineCache.size(file)} lines" }
+    let(:mtime) { LineCache.stat(file).mtime.to_s }
+    let(:sha1) { LineCache.sha1(file) }
+    let(:breakpoint_line_numbers) do
+      columnize(LineCache.trace_line_numbers(file).to_a.sort, Debugger::InfoCommand.settings[:width])
+    end
+
+    it "must show basic about the file" do
+      enter "info file #{file} basic"
+      debug_file 'info'
+      check_output_includes filename, lines
+      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
+    end
+
+    it "must show number of lines" do
+      enter "info file #{file} lines"
+      debug_file 'info'
+      check_output_includes filename, lines
+      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
+    end
+
+    it "must show mtime of the file" do
+      enter "info file #{file} mtime"
+      debug_file 'info'
+      check_output_includes filename, mtime
+      check_output_doesnt_include lines, breakpoint_line_numbers, sha1
+    end
+
+    it "must show sha1 of the file" do
+      enter "info file #{file} sha1"
+      debug_file 'info'
+      check_output_includes filename, sha1
+      check_output_doesnt_include lines, breakpoint_line_numbers, mtime
+    end
+
+    it "must show breakpoints in the file" do
+      enter 'break 5', 'break 7', "info file #{file} breakpoints"
+      debug_file 'info'
+      check_output_includes(
+        filename, "breakpoint line numbers:", breakpoint_line_numbers,
+        /Breakpoint \d+ at #{file}:5/, /Breakpoint \d+ at #{file}:7/
+      )
+      check_output_doesnt_include lines, mtime, sha1
+    end
+
+    it "must show all info about the file" do
+      enter "info file #{file} all"
+      debug_file 'info'
+      check_output_includes filename, lines, breakpoint_line_numbers, mtime, sha1
+    end
+
+    it "must not show info about the file if the file is not loaded" do
+      enter "info file #{fullpath('info2')} basic"
+      debug_file 'info'
+      check_output_includes "File #{fullpath('info2')} is not cached"
+    end
+
+    it "must not show any info if the parameter is invalid" do
+      enter "info file #{file} blabla"
+      debug_file 'info'
+      check_output_includes "Invalid parameter blabla", interface.error_queue
+    end
+  end
+
+  describe "Instance variables info" do
+    it "must show instance variables" do
+      enter 'break 21', 'cont', 'info instance_variables'
+      debug_file 'info'
+      check_output_includes '@bla = "blabla"', '@foo = "bar"'
+    end
+  end
+
+  describe "Line info" do
+    it "must show the current line" do
+      enter 'break 21', 'cont', 'info line'
+      debug_file 'info'
+      check_output_includes "Line 21 of \"#{fullpath('info')}\""
+    end
+  end
+
+  describe "Locals info" do
+    it "must show the current local variables" do
+      temporary_change_hash_value(Debugger::InfoCommand.settings, :width, 12) do
+        enter 'break 21', 'cont', 'info locals'
+        debug_file 'info'
+        check_output_includes 'a = "1111...', 'b = 2'
+      end
+    end
+
+    it "must fail if the local variable doesn't respond to #to_s or to #inspect" do
+      enter 'break 26', 'cont', 'info locals'
+      debug_file 'info'
+      check_output_includes "*Error in evaluation*"
+    end
+  end
+
+  describe "Program info" do
+    it "must show the initial stop reason" do
+      enter 'info program'
+      debug_file 'info'
+      check_output_includes "It stopped after stepping, next'ing or initial start."
+    end
+
+    it "must show the step stop reason" do
+      enter 'step', 'info program'
+      debug_file 'info'
+      check_output_includes "Program stopped.", "It stopped after stepping, next'ing or initial start."
+    end
+
+    it "must show the breakpoint stop reason" do
+      enter 'break 7', 'cont', 'info program'
+      debug_file 'info'
+      check_output_includes "Program stopped.", "It stopped at a breakpoint."
+    end
+
+    it "must show the catchpoint stop reason"
+
+    it "must show the unknown stop reason" do
+      enter 'break 7', 'cont', ->{context.stubs(:stop_reason).returns("blabla"); 'info program'}
+      debug_file 'info'
+      check_output_includes "Program stopped.", "unknown reason: blabla"
+    end
+
+    it "must show an error if the program is crashed"
+  end
+
+  describe "Stack info" do
+    it "must show stack info" do
+      enter 'break 20', 'cont', 'info stack'
+      debug_file 'info'
+      check_output_includes(
+        "-->", "#0", "A.a", "at line #{fullpath('info')}:20",
+               "#1",        "at line #{fullpath('info')}:30"
+      )
+    end
+  end
+
+  describe "Threads info" do
+    it "must show threads info" do
+      enter 'break 36', 'cont', 'info threads'
+      debug_file 'info'
+      check_output_includes /#<Thread:\S+ run>/
+    end
+
+    it "must show verbose threads info" # TODO: Unreliable due to race conditions, need to fix to be reliable
+    #  enter 'break 20', 'cont', ->{sleep 0.01; "info threads verbose"}
+    #  debug_file 'info'
+    #  check_output_includes /#<Thread:\S+ run>/, "#0", "A.a", "at line #{fullpath('info')}:20"
+    #end
+  end
+
+  describe "Thread info" do
+    it "must show threads info when without args" # TODO: Unreliable due to race conditions, need to fix to be reliable
+    #   enter 'break 48', 'cont', 'info threads'
+    #   debug_file 'info'
+    #   check_output_includes /#<Thread:\S+ run>/, /#<Thread:\S+ run>/
+    # end
+
+    it "must show thread info" do
+      thread_number = nil
+      enter ->{thread_number = context.thnum; "info thread #{context.thnum}"}
+      debug_file 'info'
+      check_output_includes "+", thread_number.to_s, /#<Thread:\S+ run>/
+    end
+
+    it "must show verbose thread info" do
+      enter 'break 20', 'cont', ->{"info thread #{context.thnum} verbose"}
+      debug_file 'info'
+      check_output_includes /#<Thread:\S+ run>/, "#0", "A.a", "at line #{fullpath('info')}:20"
+    end
+
+    it "must show error when unknown parameter is used" do
+      enter ->{"info thread #{context.thnum} blabla"}
+      debug_file 'info'
+      check_output_includes "'terse' or 'verbose' expected. Got 'blabla'", interface.error_queue
+    end
+  end
+
+  describe "Global Variables info" do
+    it "must show global variables" do
+      enter 'info global_variables'
+      debug_file 'info'
+      check_output_includes "$$ = #{Process.pid}"
+    end
+  end
+
+  describe "Variables info" do
+    it "must show all variables" do
+      temporary_change_hash_value(Debugger::InfoCommand.settings, :width, 30) do
+        enter 'break 21', 'cont', 'info variables'
+        debug_file 'info'
+        check_output_includes(
+          'a = "1111111111111111111111...',
+          "b = 2",
+          /self = #<A:\S+.../,
+          '@bla = "blabla"',
+          '@foo = "bar"'
+        )
+      end
+    end
+
+    it "must fail if the variable doesn't respond to #to_s or to #inspect" do
+      enter 'break 26', 'cont', 'info variables'
+      debug_file 'info'
+      check_output_includes(
+        'a = *Error in evaluation*',
+        /self = #<A:\S+.../,
+        '@bla = "blabla"',
+        '@foo = "bar"'
+      )
+    end
+
+    it "must handle printf strings correctly" do
+      enter 'break 32', 'cont', 'info variables'
+      debug_file 'info'
+      check_output_includes 'e = "%%.2f"'
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      enter 'cont', 'info line'
+      debug_file "post_mortem"
+      check_output_includes "Line 8 of \"#{fullpath('post_mortem')}\""
+    end
+  end
+
+end

data/test/irb_test.rb

@@ -0,0 +1,81 @@
+require_relative 'test_helper'
+
+describe "Irb Command" do
+  include TestDsl
+  before do
+    interface.stubs(:kind_of?).with(Debugger::LocalInterface).returns(true)
+    IRB::Irb.stubs(:new).returns(irb)
+    Signal.trap("SIGINT", "IGNORE")
+  end
+  after do
+    Signal.trap("SIGINT", "DEFAULT")
+  end
+  let(:irb) { stub(context: ->{}) }
+
+  it "must support next command" do
+    irb.stubs(:eval_input).throws(:IRB_EXIT, :next)
+    enter 'irb'
+    debug_file('irb') { state.line.must_equal 3 }
+  end
+
+  it "must support step command" do
+    irb.stubs(:eval_input).throws(:IRB_EXIT, :step)
+    enter 'irb'
+    debug_file('irb') { state.line.must_equal 3 }
+  end
+
+  it "must support cont command" do
+    irb.stubs(:eval_input).throws(:IRB_EXIT, :cont)
+    enter 'break 4', 'irb'
+    debug_file('irb') { state.line.must_equal 4 }
+  end
+
+  describe "autoirb" do
+    temporary_change_hash_value(Debugger::Command.settings, :autoirb, 0)
+
+    it "must call irb automatically after breakpoint" do
+      irb.expects(:eval_input)
+      enter 'set autoirb', 'break 4', 'cont'
+      debug_file 'irb'
+    end
+  end
+
+  # TODO: Can't reliably test the signal, from time to time Signal.trap, which is defined in IRBCommand, misses
+  # the SIGINT signal, which makes the test suite exit. Not sure how to fix that...
+  it "must translate SIGINT into 'cont' command" # do
+  #  irb.stubs(:eval_input).calls { Process.kill("SIGINT", Process.pid) }
+  #  enter 'break 4', 'irb'
+  #  debug_file('irb') { state.line.must_equal 4 }
+  #end
+
+  describe "setting context to $rdebug_state" do
+    before { $rdebug_state = nil }
+    temporary_change_hash_value(Debugger::Command.settings, :debuggertesting, false)
+
+    it "must set $rdebug_state if irb is in the debug mode" do
+      rdebug_state = nil
+      irb.stubs(:eval_input).calls { rdebug_state = $rdebug_state }
+      enter 'irb -d'
+      debug_file('irb')
+      rdebug_state.must_be_kind_of Debugger::CommandProcessor::State
+    end
+
+    it "must not set $rdebug_state if irb is not in the debug mode" do
+      rdebug_state = nil
+      irb.stubs(:eval_input).calls { rdebug_state = $rdebug_state }
+      enter 'irb'
+      debug_file('irb')
+      rdebug_state.must_be_nil
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      irb.stubs(:eval_input).throws(:IRB_EXIT, :cont)
+      enter 'cont', 'break 12', 'irb'
+      debug_file("post_mortem") { state.line.must_equal 12 }
+    end
+  end
+
+end