byebug 3.2.0 → 3.3.0

data/test/{quit_test.rb → commands/quit_test.rb}

@@ -13,28 +13,28 @@ module Byebug
       QuitCommand.any_instance.expects(:exit!)
       enter 'quit', 'y'
       debug_proc(@example)
-      check_output_includes 'Really quit? (y/n)', interface.confirm_queue
+      check_confirm_includes 'Really quit? (y/n)'
     end
 
     def test_does_not_quit_if_user_did_not_confirm
       QuitCommand.any_instance.expects(:exit!).never
       enter 'quit', 'n'
       debug_proc(@example)
-      check_output_includes 'Really quit? (y/n)', interface.confirm_queue
+      check_confirm_includes 'Really quit? (y/n)'
     end
 
     def test_quits_inmediately_if_used_with_bang
       QuitCommand.any_instance.expects(:exit!)
       enter 'quit!'
       debug_proc(@example)
-      check_output_doesnt_include 'Really quit? (y/n)', interface.confirm_queue
+      check_confirm_doesnt_include 'Really quit? (y/n)'
     end
 
     def test_quits_inmediately_if_used_with_unconditionally
       QuitCommand.any_instance.expects(:exit!)
       enter 'quit unconditionally'
       debug_proc(@example)
-      check_output_doesnt_include 'Really quit? (y/n)', interface.confirm_queue
+      check_confirm_doesnt_include 'Really quit? (y/n)'
     end
 
     def test_closes_interface_before_quitting

data/test/{restart_test.rb → commands/restart_test.rb}

@@ -15,9 +15,15 @@ module Byebug
         RestartExample.new.concat_args(a, b, c)
       end
 
+      @old_prog_script = Byebug::PROG_SCRIPT if defined?(Byebug::PROG_SCRIPT)
+
       super
     end
 
+    def after
+      force_set_const(Byebug, 'PROG_SCRIPT', @old_prog_script)
+    end
+
     def must_restart(cmd = nil)
       expectation = RestartCommand.any_instance.expects(:exec)
       expectation = expectation.with(cmd) if cmd

data/test/{save_test.rb → commands/save_test.rb}

@@ -54,14 +54,14 @@ module Byebug
       enter 'save'
       debug_proc(@example)
       assert_includes File.read(interface.restart_file), 'set autoirb false'
-      FileUtils.rm(interface.restart_file)
+      File.delete(interface.restart_file)
     end
 
     def test_save_without_a_filename_shows_a_message_with_the_file_used
       enter 'save'
       debug_proc(@example)
       check_output_includes "Saved to '#{interface.restart_file}'"
-      FileUtils.rm(interface.restart_file)
+      File.delete(interface.restart_file)
     end
   end
 end

data/test/{set_test.rb → commands/set_test.rb}

@@ -96,7 +96,7 @@ module Byebug
     def test_set_histsize_shows_an_error_message_if_no_size_is_provided
       enter 'set histsize'
       debug_proc(@example)
-      check_output_includes 'You must specify a value for setting :histsize'
+      check_error_includes 'You must specify a value for setting :histsize'
     end
 
     def test_set_histfile_sets_command_history_file
@@ -110,7 +110,7 @@ module Byebug
     def test_set_histfile_shows_an_error_message_if_no_filename_is_provided
       enter 'set histfile'
       debug_proc(@example)
-      check_output_includes 'You must specify a value for setting :histfile'
+      check_error_includes 'You must specify a value for setting :histfile'
     end
 
     [:listsize, :width].each do |set|
@@ -122,6 +122,13 @@ module Byebug
       end
     end
 
+    def test_verbose_prints_tracepoint_api_event_information
+      enter 'set verbose'
+      debug_proc(@example)
+      assert_equal true, Byebug.verbose?
+      Byebug.verbose = false
+    end
+
     def test_set_without_arguments_shows_help_for_set_command
       enter 'set'
       debug_proc(@example)

data/test/{show_test.rb → commands/show_test.rb}

@@ -48,7 +48,7 @@ module Byebug
     def test_show_unknown_setting
       enter 'show bla'
       debug_proc(@example)
-      check_output_includes 'Unknown setting :bla'
+      check_error_includes 'Unknown setting :bla'
     end
 
     def test_show_histfile

data/test/{source_test.rb → commands/source_test.rb}

@@ -16,7 +16,7 @@ module Byebug
     end
 
     def teardown
-      FileUtils.rm('source_example.txt')
+      File.delete('source_example.txt')
     end
 
     %w(source so).each do |cmd_alias|
@@ -38,8 +38,8 @@ module Byebug
       define_method(:"test_#{cmd_alias}_without_arguments_shows_help") do
         enter 'source'
         debug_proc(@example)
-        check_output_includes \
-          "source FILE\texecutes a file containing byebug commands"
+        check_output_includes(
+          /Executes file <file> containing byebug commands./)
       end
     end
   end

data/test/{stepping_test.rb → commands/stepping_test.rb}

@@ -47,9 +47,14 @@ module Byebug
       enter 's'
       debug_proc(@example) { assert_equal 14, state.line }
     end
+
+    def test_next_does_not_stop_at_byebug_internal_frames
+      enter 'set forcestep', 'next 2'
+      debug_proc(@example) { refute_match(/byebug.test.support/, state.file) }
+    end
   end
 
-  class AdvancedStepping < TestCase
+  class AdvancedSteppingTestCase < TestCase
     def setup
       @example = -> do
         byebug
@@ -101,7 +106,7 @@ module Byebug
 
     def test_next_goes_the_specified_number_of_lines_forward_by_default
       enter 'set forcestep', 'next 2'
-      debug_proc(@example) { assert_equal 58, state.line }
+      debug_proc(@example) { assert_equal 63, state.line }
     end
 
     def test_next_informs_when_not_staying_in_the_same_frame
@@ -113,35 +118,37 @@ module Byebug
 
     def step_goes_the_specified_number_of_statements_forward_by_default
       enter 'set forcestep', 'step 2'
-      debug_proc(@example) { assert_equal 58, state.line }
+      debug_proc(@example) { assert_equal 63, state.line }
     end
 
     def test_next_steps_OVER_blocks
-      enter 'break 58', 'cont', 'next'
-      debug_proc(@example) { assert_equal 62, state.line }
+      enter 'break 63', 'cont', 'next'
+      debug_proc(@example) { assert_equal 67, state.line }
     end
 
     def test_step_steps_INTO_blocks
-      enter 'break 58', 'cont', 'step'
-      debug_proc(@example) { assert_equal 59, state.line }
+      enter 'break 63', 'cont', 'step'
+      debug_proc(@example) { assert_equal 64, state.line }
     end
+  end
 
-    class RaiseFromCMethodExample
-      def a
-        b
-      rescue NameError
-        1
-      end
+  class RaiseFromCMethodExample
+    def a
+      b
+    rescue NameError
+      1
+    end
 
-      def b
-        c
-      end
+    def b
+      c
+    end
 
-      def c
-        d
-      end
+    def c
+      d
     end
+  end
 
+  class RaiseFromCMethodTestCase < TestCase
     def test_next_steps_over_rescue_when_raising_from_c_method
       example_raise = -> do
         byebug
@@ -149,26 +156,28 @@ module Byebug
         RaiseFromCMethodExample.new.a
       end
 
-      enter 'break 131', 'cont', 'next'
-      debug_proc(example_raise) { assert_equal 133, state.line }
+      enter 'break 137', 'cont', 'next'
+      debug_proc(example_raise) { assert_equal 139, state.line }
     end
+  end
 
-    class RaiseFromRubyMethodExample
-      def a
-        b
-      rescue
-        1
-      end
+  class RaiseFromRubyMethodExample
+    def a
+      b
+    rescue
+      1
+    end
 
-      def b
-        c
-      end
+    def b
+      c
+    end
 
-      def c
-        raise 'bang'
-      end
+    def c
+      raise 'bang'
     end
+  end
 
+  class RaiseFromRubyMethodTestCase < TestCase
     def test_next_steps_over_rescue_when_raising_from_ruby_method
       example_raise = -> do
         byebug
@@ -176,8 +185,8 @@ module Byebug
         RaiseFromRubyMethodExample.new.a
       end
 
-      enter 'break 158', 'cont', 'next'
-      debug_proc(example_raise) { assert_equal 160, state.line }
+      enter 'break 166', 'cont', 'next'
+      debug_proc(example_raise) { assert_equal 168, state.line }
     end
   end
 end

data/test/{display_test.rb → commands/undisplay_test.rb}

@@ -1,40 +1,4 @@
 module Byebug
-  class DisplayTestCase < TestCase
-    def setup
-      @example = -> do
-        d = 0
-        byebug
-        d = d + 3
-        d = d + 6
-      end
-
-      super
-    end
-
-    def test_shows_expressions
-      enter 'display d + 1'
-      debug_proc(@example)
-      check_output_includes '1: ', 'd + 1 = 1'
-    end
-
-    def test_works_when_using_a_shortcut
-      enter 'disp d + 1'
-      debug_proc(@example)
-      check_output_includes '1: ', 'd + 1 = 1'
-    end
-
-    def test_saves_displayed_expressions
-      enter 'display d + 1'
-      debug_proc(@example) { assert_equal [[true, 'd + 1']], state.display }
-    end
-
-    def test_displays_all_expressions_available
-      enter 'display d', 'display d + 1', 'display'
-      debug_proc(@example)
-      check_output_includes '1: ', 'd = 0', '2: ', 'd + 1 = 1'
-    end
-  end
-
   class UndisplayTestCase < TestCase
     def setup
       @example = -> do
@@ -50,8 +14,7 @@ module Byebug
     def test_asks_for_confirmation
       enter 'display d', 'display d + 1', 'undisplay'
       debug_proc(@example)
-      check_output_includes \
-        'Clear all expressions? (y/n)', interface.confirm_queue
+      check_confirm_includes 'Clear all expressions? (y/n)'
     end
 
     def test_removes_all_expressions_from_list_if_confirmed
@@ -59,7 +22,7 @@ module Byebug
       debug_proc(@example) do
         assert_equal [[false, 'd'], [false, 'd + 1']], state.display
       end
-      check_output_doesnt_include '1: ', 'd = 3', '2: ', 'd + 1 = 4'
+      check_output_doesnt_include '1: d = 3', '2: d + 1 = 4'
     end
 
     def test_does_not_remove_all_expressions_from_list_unless_confirmed
@@ -68,7 +31,7 @@ module Byebug
         assert_equal [[true, 'd'], [true, 'd + 1']], state.display
       end
 
-      check_output_includes '1: ', 'd = 0', '2: ', 'd + 1 = 1'
+      check_output_includes '1: d = 0', '2: d + 1 = 1'
     end
 
     def test_marks_specific_expression_from_list_as_inactive
@@ -82,8 +45,8 @@ module Byebug
     def test_displays_only_the_active_position
       enter 'display d', 'display d + 1', 'undisplay 1', 'next'
       debug_proc(@example)
-      check_output_includes '2: ', 'd + 1 = 4'
-      check_output_doesnt_include '1: ', 'd = 3'
+      check_output_includes '2: d + 1 = 4'
+      check_output_doesnt_include '1: d = 3'
     end
 
     def test_disable_display_removes_the_expression_from_display_list
@@ -94,14 +57,13 @@ module Byebug
     def test_disable_display_shows_an_error_if_no_displays_are_set
       enter 'disable display 1'
       debug_proc(@example)
-      check_output_includes \
-        'No display expressions have been set', interface.error_queue
+      check_error_includes 'No display expressions have been set'
     end
 
     def test_disable_display_shows_an_error_if_theres_no_such_display_position
       enter 'display d', 'disable display 4'
       debug_proc(@example)
-      check_output_includes \
+      check_error_includes \
         '"disable display" argument "4" needs to be at most 1'
     end
 

data/test/{variables_test.rb → commands/variables_test.rb}

@@ -30,7 +30,7 @@ module Byebug
       super
     end
 
-    # we check a class minitest variable... brittle but ok for now
+    # TODO: we check a class minitest variable... brittle...
     ['var class', 'v cl'].each do |cmd_alias|
       define_method(:"test_#{cmd_alias}_shows_class_variables") do
         enter cmd_alias
@@ -92,5 +92,14 @@ module Byebug
       debug_proc(@example)
       check_output_includes 'a => 4', 'b => nil', 'i => 1'
     end
+
+    # TODO: class variables not currently checked
+    ['var all', 'v a'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_all_variables") do
+        enter 'break 15', 'cont', cmd_alias
+        debug_proc(@example)
+        check_output_includes '$VERBOSE = true', '@inst_a = 1', 'a => 4'
+      end
+    end
   end
 end

data/test/debugger_alias_test.rb

@@ -1,5 +1,5 @@
-module DebuggerAlias
-  class DebuggerAliasTest < Minitest::Test
+module Byebug
+  class DebuggerAliasTestCase < TestCase
     def test_aliases_debugger_to_byebug
       assert_equal Kernel.method(:byebug), Kernel.method(:debugger)
     end

data/test/runner_test.rb

@@ -0,0 +1,127 @@
+require 'byebug/runner'
+
+module Byebug
+
+  class RunnerTest < TestCase
+    def setup
+      super
+      @old_argv = ARGV
+    end
+
+    def after
+      ARGV.replace(@old_argv)
+    end
+
+    def test_run_with_version_flag
+      ARGV.replace(%w(--version))
+      Byebug::Runner.new.run
+
+      check_output_includes(/#{Byebug::VERSION}/)
+    end
+
+    def test_run_with_help_flag
+      ARGV.replace(%w(--help))
+      Byebug::Runner.new.run
+
+      check_output_includes(/-d.*-I.*-q.*-s.*-x.*-m.*-r.*-R.*-t.*-v.*-h/m)
+    end
+
+    def test_run_with_remote_option_only_with_a_port_number
+      ARGV.replace(%w(--remote 9999))
+      Byebug.expects(:start_client)
+      Byebug::Runner.new.run
+
+      check_output_includes(/Connecting to byebug server localhost:9999/)
+    end
+
+    def test_run_with_remote_option_with_host_and_port_specification
+      ARGV.replace(%w(--remote myhost:9999))
+      Byebug.expects(:start_client)
+      Byebug::Runner.new.run
+
+      check_output_includes(/Connecting to byebug server myhost:9999/)
+    end
+
+    def test_run_without_a_script_to_debug
+      ARGV.replace([])
+
+      assert_raises(SystemExit) { Byebug::Runner.new.run }
+
+      check_output_includes(/You must specify a program to debug.../)
+    end
+
+    def expect_it_debugs_script
+      Byebug.expects(:start)
+      Byebug::Runner.any_instance.expects(:debug_program)
+      Byebug.expects(:run_init_script)
+    end
+
+    def test_run_with_a_script_to_debug
+      ARGV.replace(%w(my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+    end
+
+    def test_run_with_no_rc_option
+      ARGV.replace(%w(--no-rc my_script))
+      Byebug.expects(:start)
+      Byebug::Runner.any_instance.expects(:debug_program)
+      Byebug.expects(:run_init_script).never
+
+      Byebug::Runner.new.run
+    end
+
+    def test_run_with_post_mortem_mode_flag
+      ARGV.replace(%w(-m my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+      assert_equal true, Byebug.post_mortem?
+      Byebug::Setting[:post_mortem] = false
+    end
+
+    def test_run_with_linetracing_flag
+      ARGV.replace(%w(-t my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+      assert_equal true, Byebug.tracing?
+      Byebug::Setting[:linetrace] = false
+    end
+
+    def test_run_with_no_quit_flag
+      skip 'for now'
+      ARGV.replace(%w(--no-quit my_script))
+
+      Byebug::Runner.new.run
+      check_output_includes('(byebug:ctrl)')
+    end
+
+    def test_run_with_require_flag
+      ARGV.replace(%w(-r abbrev my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+      hsh = { 'can' => 'can', 'cat' => 'cat' }
+      assert_equal hsh, %w(can cat).abbrev
+    end
+
+    def test_run_with_include_flag
+      ARGV.replace(%w(-I custom_dir my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+      assert_includes $LOAD_PATH, 'custom_dir'
+    end
+
+    def test_run_with_debug_flag
+      ARGV.replace(%w(-d my_script))
+      expect_it_debugs_script
+
+      Byebug::Runner.new.run
+      assert_equal $DEBUG, true
+      $DEBUG = false
+    end
+  end
+end