debugger 1.2.4 → 1.3.0

data/test/restart_test.rb

@@ -0,0 +1,143 @@
+require_relative 'test_helper'
+
+describe "Restart Command" do
+  include TestDsl
+
+  let(:initial_dir) { Pathname.new(__FILE__ + "/../..").realpath.to_s }
+  let(:prog_script) do
+    Pathname.new(fullpath('restart')).relative_path_from(Pathname.new(Debugger::INITIAL_DIR)).cleanpath.to_s
+  end
+  let(:rdebug_script) { 'rdebug-script' }
+
+  def must_restart
+    Debugger::RestartCommand.any_instance.unstub(:exec)
+    Debugger::RestartCommand.any_instance.expects(:exec)
+  end
+
+  before do
+    force_set_const(Debugger, "INITIAL_DIR", initial_dir)
+    force_set_const(Debugger, "PROG_SCRIPT", prog_script)
+    force_set_const(Debugger, "RDEBUG_SCRIPT", rdebug_script)
+    Debugger::Command.settings[:argv] = ['argv']
+    Debugger::RestartCommand.any_instance.stubs(:exec).with("#{rdebug_script} argv")
+  end
+
+  it "must be restarted with arguments" do
+    Debugger::RestartCommand.any_instance.expects(:exec).with("#{rdebug_script} test/examples/restart.rb 1 2 3")
+    enter 'restart 1 2 3'
+    debug_file('restart')
+  end
+
+  it "must be restarted without arguments" do
+    Debugger::RestartCommand.any_instance.expects(:exec).with("#{rdebug_script} argv")
+    enter 'restart'
+    debug_file('restart')
+  end
+
+  it "must specify arguments by 'set' command" do
+    temporary_change_hash_value(Debugger::Command.settings, :argv, []) do
+      Debugger::RestartCommand.any_instance.expects(:exec).with("#{rdebug_script}  1 2 3")
+      enter 'set args 1 2 3', 'restart'
+      debug_file('restart')
+    end
+  end
+
+  describe "messaging" do
+    before { enter 'restart' }
+
+    describe "reexecing" do
+      it "must restart" do
+        must_restart
+        debug_file('restart')
+      end
+
+      it "must show a message about reexecing" do
+        debug_file('restart')
+        check_output_includes "Re exec'ing:\n\t#{rdebug_script} argv"
+      end
+    end
+
+    describe "no script is specified and don't use $0" do
+      before do
+        Debugger.send(:remove_const, "PROG_SCRIPT")
+        force_set_const(Debugger, "DEFAULT_START_SETTINGS", init: false, post_mortem: false, tracing: nil)
+      end
+
+      it "must not restart" do
+        must_restart.never
+        debug_file('restart')
+      end
+
+      it "must show an error message" do
+        debug_file('restart')
+        check_output_includes "Don't know name of debugged program", interface.error_queue
+      end
+    end
+
+    it "must use prog_script from $0 if PROG_SCRIPT is undefined" do
+      $0 = 'prog-0'
+      Debugger.send(:remove_const, "PROG_SCRIPT")
+      force_set_const(Debugger, "DEFAULT_START_SETTINGS", init: true, post_mortem: false, tracing: nil)
+      debug_file('restart')
+      check_output_includes "Ruby program prog-0 doesn't exist", interface.error_queue
+    end
+
+    describe "no script at the specified path" do
+      before { force_set_const(Debugger, "PROG_SCRIPT", 'blabla') }
+
+      it "must not restart" do
+        must_restart.never
+        debug_file('restart')
+      end
+
+      it "must show an error message" do
+        debug_file('restart')
+        check_output_includes "Ruby program blabla doesn't exist", interface.error_queue
+      end
+    end
+
+    describe "debugger runner script is not specified" do
+      before { Debugger.send(:remove_const, "RDEBUG_SCRIPT") }
+
+      it "must restart anyway" do
+        must_restart
+        debug_file('restart')
+      end
+
+      it "must show a warning message" do
+        debug_file('restart')
+        check_output_includes "Debugger was not called from the outset..."
+      end
+
+      it "must show a warning message when prog script is not executable" do
+        debug_file('restart')
+        check_output_includes "Ruby program #{prog_script} doesn't seem to be executable..."
+        check_output_includes "We'll add a call to Ruby."
+      end
+    end
+
+    describe "when can't change the dir to INITIAL_DIR" do
+      before { force_set_const(Debugger, "INITIAL_DIR", "unexisted/path") }
+
+      it "must restart anyway" do
+        must_restart
+        debug_file('restart')
+      end
+
+      it "must show an error message " do
+        debug_file('restart')
+        check_output_includes "Failed to change initial directory unexisted/path"
+      end
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must work in post-mortem mode" do
+      must_restart
+      enter 'cont', 'restart'
+      debug_file 'post_mortem'
+    end
+  end
+
+end

data/test/save_test.rb

@@ -0,0 +1,92 @@
+require_relative 'test_helper'
+
+describe "Save Command" do
+  include TestDsl
+  let(:file_name) { 'save_output.txt' }
+
+  describe "successful saving" do
+    let(:file_contents) { File.read(file_name) }
+    before do
+      enter 'break 2', 'break 3 if true', 'catch NoMethodError', 'display 2 + 3', 'display 5 + 6',
+        'set autoeval', 'set autolist',
+        "save #{file_name}"
+      debug_file 'save'
+    end
+    after do
+      FileUtils.rm(file_name)
+    end
+
+    it "must save usual breakpoints" do
+      file_contents.must_include "break #{fullpath('save')}:2"
+    end
+
+    it "must save conditinal breakpoints" do
+      file_contents.must_include "break #{fullpath('save')}:3 if true"
+    end
+
+    it "must save catchpoints" do
+      file_contents.must_include "catch NoMethodError"
+    end
+
+    # Not sure why it is suppressed, but this is like it is now.
+    it "must not save displays" do
+      file_contents.wont_include "display 2 + 3"
+    end
+
+    describe "saving settings" do
+      it "must save autoeval" do
+        file_contents.must_include "set autoeval on"
+      end
+
+      it "must save basename" do
+        file_contents.must_include "set basename off"
+      end
+
+      it "must save debuggertesting" do
+        file_contents.must_include "set debuggertesting on"
+      end
+
+      it "must save autolist" do
+        file_contents.must_include "set autolist on"
+      end
+
+      it "must save autoirb" do
+        file_contents.must_include "set autoirb off"
+      end
+    end
+
+    it "must show a message about successful saving" do
+      check_output_includes "Saved to '#{file_name}'"
+    end
+
+  end
+
+  describe "without filename" do
+    let(:file_contents) { File.read(interface.restart_file) }
+    after { FileUtils.rm(interface.restart_file) }
+
+    it "must fabricate a filename if not provided" do
+      enter "save"
+      debug_file 'save'
+      file_contents.must_include "set autoirb"
+    end
+
+    it "must show a message where the file is saved" do
+      enter "save"
+      debug_file 'save'
+      check_output_includes "Saved to '#{interface.restart_file}'"
+    end
+  end
+
+
+  describe "Post Mortem" do
+    let(:file_contents) { File.read(file_name) }
+    after { FileUtils.rm(file_name) }
+    it "must work in post-mortem mode" do
+      enter 'cont', "save #{file_name}"
+      debug_file 'post_mortem'
+      file_contents.must_include "set autoirb off"
+    end
+  end
+
+end

data/test/set_test.rb

@@ -0,0 +1,163 @@
+require_relative 'test_helper'
+
+describe "Set Command" do
+  include TestDsl
+
+  describe "setting to on" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 0)
+
+    it "must set a setting to on" do
+      enter 'set autolist on'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 1
+    end
+
+    it "must set a setting to on by 1" do
+      enter 'set autolist 1'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 1
+    end
+
+    it "must set a setting to on by default" do
+      enter 'set autolist'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 1
+    end
+
+    it "must set a setting using shortcut" do
+      enter 'set autol'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 1
+    end
+  end
+
+  describe "setting to off" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 1)
+
+    it "must set a setting to off" do
+      enter 'set autolist off'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 0
+    end
+
+    it "must set a setting to off by 0" do
+      enter 'set autolist 0'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 0
+    end
+
+    it "must set a setting to off by 'no' suffix" do
+      enter 'set noautolist'
+      debug_file 'set'
+      Debugger::Command.settings[:autolist].must_equal 0
+    end
+  end
+
+  describe "messages" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 0)
+
+    it "must show a message after setting" do
+      enter 'set autolist on'
+      debug_file 'set'
+      check_output_includes "autolist is on."
+    end
+  end
+
+  describe "debuggertesting" do
+    temporary_change_hash_value(Debugger::Command.settings, :debuggertesting, false)
+    before { $rdebug_state = nil }
+    after { $rdebug_state = nil }
+
+    it "must set $rdebug_context if debuggersetting is on" do
+      enter 'set debuggertesting', 'break 3', 'cont'
+      debug_file('set') { state.must_be_kind_of Debugger::CommandProcessor::State }
+    end
+
+    it "must set basename on too" do
+      temporary_change_hash_value(Debugger::Command.settings, :basename, false) do
+        enter 'set debuggertesting', 'show basename'
+        debug_file('set')
+        check_output_includes "basename is on."
+      end
+    end
+
+    it "must not set $rdebug_context if debuggersetting is off" do
+      enter 'set nodebuggertesting', 'break 3', 'cont'
+      debug_file('set') { state.must_be_nil }
+    end
+  end
+
+  describe "history" do
+    describe "save" do
+      it "must set history save to on" do
+        enter 'set history save on'
+        debug_file 'set'
+        interface.history_save.must_equal true
+      end
+
+      it "must show a message" do
+        enter 'set history save on'
+        debug_file 'set'
+        check_output_includes "Saving of history save is on."
+      end
+
+      it "must set history save to off" do
+        enter 'set history save off'
+        debug_file 'set'
+        interface.history_save.must_equal false
+      end
+    end
+
+    describe "size" do
+      it "must set history size" do
+        enter 'set history size 250'
+        debug_file 'set'
+        interface.history_length.must_equal 250
+      end
+
+      it "must show a message" do
+        enter 'set history size 250'
+        debug_file 'set'
+        check_output_includes "Debugger history size is 250"
+      end
+    end
+
+    it "must show an error message if used wrong subcommand" do
+      enter 'set history bla 2'
+      debug_file 'set'
+      check_output_includes "Invalid history parameter bla. Should be 'save' or 'size'."
+    end
+
+    it "must show an error message if provided only one argument" do
+      enter 'set history save'
+      debug_file 'set'
+      check_output_includes "Need two parameters for 'set history'; got 1."
+    end
+  end
+
+  describe "width" do
+    temporary_change_hash_value(Debugger::Command.settings, :width, 20)
+
+    it "must set ENV['COLUMNS'] by the 'set width' command" do
+      old_columns = ENV["COLUMNS"]
+      begin
+        enter 'set width 10'
+        debug_file 'set'
+        ENV["COLUMNS"].must_equal '10'
+      ensure
+        ENV["COLUMNS"] = old_columns
+      end
+    end
+  end
+
+
+  describe "Post Mortem" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 0)
+    it "must work in post-mortem mode" do
+      enter 'cont', "set autolist on"
+      debug_file 'post_mortem'
+      check_output_includes "autolist is on."
+    end
+  end
+
+end

data/test/show_test.rb

@@ -0,0 +1,292 @@
+require_relative 'test_helper'
+
+describe "Show Command" do
+  include TestDsl
+
+  describe "annotate" do
+    temporary_change_method_value(Debugger, :annotate, nil)
+
+    it "must show annotate setting" do
+      enter 'show annotate'
+      debug_file 'show'
+      check_output_includes "Annotation level is 0"
+    end
+
+    it "must show annotate setting" do
+      enter 'show annotate'
+      debug_file 'show'
+      Debugger.annotate.must_equal 0
+    end
+  end
+
+
+  describe "args" do
+    temporary_change_hash_value(Debugger::Command.settings, :argv, %w{foo bar})
+
+    it "must show args" do
+      Debugger.send(:remove_const, "RDEBUG_SCRIPT") if Debugger.const_defined?("RDEBUG_SCRIPT")
+      enter 'show args'
+      debug_file 'show'
+      check_output_includes 'Argument list to give program being debugged when it is started is "foo bar".'
+    end
+
+    it "must not show the first arg if RDEBUG_SCRIPT is defined" do
+      temporary_set_const(Debugger, "RDEBUG_SCRIPT", "bla") do
+        enter 'show args'
+        debug_file 'show'
+        check_output_includes 'Argument list to give program being debugged when it is started is "bar".'
+      end
+    end
+  end
+
+
+  it "must show autolist" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 1) do
+      enter 'show autolist'
+      debug_file 'show'
+      check_output_includes 'autolist is on.'
+    end
+  end
+
+  it "must show autoeval" do
+    temporary_change_hash_value(Debugger::Command.settings, :autoeval, true) do
+      enter 'show autoeval'
+      debug_file 'show'
+      check_output_includes 'autoeval is on.'
+    end
+  end
+
+  it "must show autoreload" do
+    temporary_change_hash_value(Debugger::Command.settings, :reload_source_on_change, true) do
+      enter 'show autoreload'
+      debug_file 'show'
+      check_output_includes 'autoreload is on.'
+    end
+  end
+
+  it "must show autoirb" do
+    Debugger::IRBCommand.any_instance.stubs(:execute)
+    temporary_change_hash_value(Debugger::Command.settings, :autoirb, 1) do
+      enter 'show autoirb'
+      debug_file 'show'
+      check_output_includes 'autoirb is on.'
+    end
+  end
+
+  it "must show basename" do
+    temporary_change_hash_value(Debugger::Command.settings, :basename, true) do
+      enter 'show basename'
+      debug_file 'show'
+      check_output_includes 'basename is on.'
+    end
+  end
+
+  it "must show callstyle" do
+    temporary_change_hash_value(Debugger::Command.settings, :callstyle, :short) do
+      enter 'show callstyle'
+      debug_file 'show'
+      check_output_includes 'Frame call-display style is short.'
+    end
+  end
+
+  it "must show forcestep" do
+    temporary_change_hash_value(Debugger::Command.settings, :force_stepping, true) do
+      enter 'show forcestep'
+      debug_file 'show'
+      check_output_includes 'force-stepping is on.'
+    end
+  end
+
+  it "must show fullpath" do
+    temporary_change_hash_value(Debugger::Command.settings, :full_path, true) do
+      enter 'show fullpath'
+      debug_file 'show'
+      check_output_includes "Displaying frame's full file names is on."
+    end
+  end
+
+  it "must show linetrace" do
+    temporary_change_method_value(Debugger, :tracing, true) do
+      enter 'show linetrace'
+      debug_file 'show'
+      check_output_includes "line tracing is on."
+    end
+  end
+
+
+  describe "linetrace+" do
+    it "must show a message when linetrace+ is on" do
+      temporary_change_hash_value(Debugger::Command.settings, :tracing_plus, true) do
+        enter 'show linetrace+'
+        debug_file 'show'
+        check_output_includes "line tracing style is different consecutive lines."
+      end
+    end
+
+    it "must show a message when linetrace+ is off" do
+      temporary_change_hash_value(Debugger::Command.settings, :tracing_plus, false) do
+        enter 'show linetrace+'
+        debug_file 'show'
+        check_output_includes "line tracing style is every line."
+      end
+    end
+  end
+
+
+  it "must show listsize" do
+    temporary_change_hash_value(Debugger::Command.settings, :listsize, 10) do
+      enter 'show listsize'
+      debug_file 'show'
+      check_output_includes 'Number of source lines to list by default is 10.'
+    end
+  end
+
+  it "must show port" do
+    temporary_set_const(Debugger, "PORT", 12345) do
+      enter 'show port'
+      debug_file 'show'
+      check_output_includes 'server port is 12345.'
+    end
+  end
+
+  it "must show trace" do
+    temporary_change_hash_value(Debugger::Command.settings, :stack_trace_on_error, true) do
+      enter 'show trace'
+      debug_file 'show'
+      check_output_includes "Displaying stack trace is on."
+    end
+  end
+
+  it "must show version" do
+    enter 'show version'
+    debug_file 'show'
+    check_output_includes "ruby-debug #{Debugger::VERSION}"
+  end
+
+  it "must show forcestep" do
+    temporary_change_hash_value(Debugger::Command.settings, :width, 35) do
+      enter 'show width'
+      debug_file 'show'
+      check_output_includes 'width is 35.'
+    end
+  end
+
+  it "must show a message about unknown command" do
+    enter 'show bla'
+    debug_file 'show'
+    check_output_includes 'Unknown show command bla'
+  end
+
+
+  describe "history" do
+    describe "without arguments" do
+      before do
+        interface.histfile = "hist_file.txt"
+        interface.history_save = true
+        interface.history_length = 25
+        enter 'show history'
+        debug_file 'show'
+      end
+
+      it "must show history file" do
+        check_output_includes /filename: The filename in which to record the command history is "hist_file\.txt"/
+      end
+
+      it "must show history save setting" do
+        check_output_includes /save: Saving of history save is on\./
+      end
+
+      it "must show history length" do
+        check_output_includes /size: Debugger history size is 25/
+      end
+    end
+
+    describe "with 'filename' argument" do
+      it "must show history filename" do
+        interface.histfile = "hist_file.txt"
+        enter 'show history filename'
+        debug_file 'show'
+        check_output_includes 'The filename in which to record the command history is "hist_file.txt"'
+      end
+
+      it "must show history save setting" do
+        interface.history_save = true
+        enter 'show history save'
+        debug_file 'show'
+        check_output_includes 'Saving of history save is on.'
+      end
+
+      it "must show history length" do
+        interface.history_length = 30
+        enter 'show history size'
+        debug_file 'show'
+        check_output_includes 'Debugger history size is 30'
+      end
+    end
+  end
+
+
+  describe "commands" do
+    before { interface.readline_support = true }
+
+    it "must not show records from readline if there is no readline support" do
+      interface.readline_support = false
+      enter 'show commands'
+      debug_file 'show'
+      check_output_includes "No readline support"
+    end
+
+    it "must show records from readline history" do
+      temporary_set_const(Readline, "HISTORY", %w{aaa bbb ccc ddd eee fff}) do
+        enter 'show commands'
+        debug_file 'show'
+        check_output_includes /1  aaa/
+        check_output_includes /6  fff/
+      end
+    end
+
+    it "must show last 10 records from readline history" do
+      temporary_set_const(Readline, "HISTORY", %w{aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll mmm nnn}) do
+        enter 'show commands'
+        debug_file 'show'
+        check_output_doesnt_include /3  ccc/
+        check_output_includes /4  eee/
+        check_output_includes /13  nnn/
+      end
+    end
+
+    describe "with specified positions" do
+      it "must show records within boundaries" do
+        temporary_set_const(Readline, "HISTORY", %w{aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll mmm nnn}) do
+          # Really don't know why it substracts 4, and shows starting from position 6
+          enter 'show commands 10'
+          debug_file 'show'
+          check_output_doesnt_include /5  fff/
+          check_output_includes /6  ggg/
+          check_output_includes /13  nnn/
+        end
+      end
+
+      it "must adjust first line if it is < 0" do
+        temporary_set_const(Readline, "HISTORY", %w{aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll mmm nnn}) do
+          enter 'show commands 3'
+          debug_file 'show'
+          check_output_includes /1  bbb/
+          check_output_includes /8  iii/
+          check_output_doesnt_include /9  jjj/
+        end
+      end
+    end
+  end
+
+  describe "Post Mortem" do
+    temporary_change_hash_value(Debugger::Command.settings, :autolist, 0)
+
+    it "must work in post-mortem mode" do
+      enter 'cont', "show autolist"
+      debug_file 'post_mortem'
+      check_output_includes "autolist is off."
+    end
+  end
+
+end