byebug 3.1.2 → 3.2.0

data/test/test_helper.rb

@@ -1,19 +1,37 @@
 if ENV['CI']
-  require 'coveralls'
-  Coveralls.wear! do
-    add_filter 'test'
-  end
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
 end
 
 require 'minitest'
-require 'minitest/spec'
 require 'pathname'
 require 'mocha/mini_test'
 require 'byebug'
 
-Dir.glob(File.expand_path('../support/*.rb', __FILE__)).each { |f| require f }
+require_relative 'support/utils'
+
+class Byebug::TestCase < Minitest::Test
+  #
+  # Reset to default state before each test
+  #
+  def setup
+    Byebug.handler = Byebug::CommandProcessor.new(Byebug::TestInterface.new)
+    Byebug.breakpoints.clear if Byebug.breakpoints
+    Byebug.catchpoints.clear if Byebug.catchpoints
+
+    Byebug::Setting.load
+    Byebug::Setting[:autolist] = false
+    Byebug::Setting[:testing] = true
+    Byebug::Setting[:verbose] = true
+    Byebug::Setting[:width] = 80
 
-Byebug::Setting[:testing] = true
+    byebug_bin = File.expand_path('../../../bin/byebug', __FILE__)
+    force_set_const(Byebug, 'BYEBUG_SCRIPT', byebug_bin)
+    force_set_const(Byebug, 'PROG_SCRIPT', $0)
+  end
+
+  include Byebug::TestUtils
+end
 
 # Init globals to avoid warnings
 $bla = nil

data/test/thread_test.rb

@@ -1,5 +1,5 @@
-module ThreadTest
-  class Example
+module Byebug
+  class ThreadExample
     def initialize
       Thread.main[:should_break] = false
     end
@@ -27,17 +27,21 @@ module ThreadTest
     end
   end
 
-  class ThreadTestCase < TestDsl::TestCase
-    let(:release) { 'eval Thread.main[:should_break] = true' }
-
-    before do
+  class ThreadTestCase < TestCase
+    def setup
       @example = -> do
         byebug
 
-        t = Example.new
+        t = ThreadExample.new
         t.launch
         t.kill
       end
+
+      super
+    end
+
+    def release
+      @release ||= 'eval Thread.main[:should_break] = true'
     end
 
     def first_thnum
@@ -48,105 +52,113 @@ module ThreadTest
       Byebug.contexts.last.thnum
     end
 
-    describe 'list' do
-      it 'must show current thread by "plus" sign' do
-        thnum = nil
-        enter 'break 8', 'cont', 'thread list', release
-        debug_proc(@example) { thnum = first_thnum }
-        check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:8/)
-      end
+    def test_thread_list_marks_current_thread_with_a_plus_sign
+      skip 'for now'
+      thnum = nil
+      enter 'break 8', 'cont', 'thread list', release
+      debug_proc(@example) { thnum = first_thnum }
+      check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:8/)
+    end
 
-      it 'must work with shortcut' do
-        thnum = nil
-        enter 'break 8', 'cont', 'th list', release
-        debug_proc(@example) { thnum = first_thnum }
-        check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:8/)
-      end
+    def test_thread_list_works_with_shortcut
+      skip 'for now'
+      thnum = nil
+      enter 'break 8', 'cont', 'th list', release
+      debug_proc(@example) { thnum = first_thnum }
+      check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:8/)
+    end
 
-      it 'must show 3 available threads' do
-        enter 'break 21', 'cont', 'thread list', release
-        debug_proc(@example)
-        check_output_includes(/(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
-                              /(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
-                              /(\+)?\d+ #<Thread:\S+ (sleep|run)>/)
-      end
+    def test_thread_list_show_all_available_threads
+      skip 'for now'
+      enter 'break 21', 'cont', 'thread list', release
+      debug_proc(@example)
+      check_output_includes(/(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
+                            /(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
+                            /(\+)?\d+ #<Thread:\S+ (sleep|run)>/)
     end
 
-    describe 'stop' do
-      it 'must mark thread as suspended' do
-        thnum = nil
-        enter 'break 21', 'cont', ->{ "thread stop #{last_thnum}" }, release
-        debug_proc(@example) { thnum = last_thnum }
-        check_output_includes(/\$ #{thnum} #<Thread:/)
-      end
+    def test_thread_stop_marks_thread_as_suspended
+      skip 'for now'
+      thnum = nil
+      enter 'break 21', 'cont', -> { "thread stop #{last_thnum}" }, release
+      debug_proc(@example) { thnum = last_thnum }
+      check_output_includes(/\$ #{thnum} #<Thread:/)
+    end
 
-      it 'must actually suspend thread execution' do
-        enter 'break 21', 'cont', 'trace on',
-              ->{ "thread stop #{last_thnum}" }, release
-        debug_proc(@example)
-        check_output_doesnt_include(/Tracing: #{__FILE__}:16/,
-                                    /Tracing: #{__FILE__}:17/)
-      end
+    def test_thread_stop_actually_suspends_thread_execution
+      skip 'for now'
+      enter 'break 21', 'cont', 'trace on',
+            -> { "thread stop #{last_thnum}" }, release
+      debug_proc(@example)
+      check_output_doesnt_include(/Tracing: #{__FILE__}:16/,
+                                  /Tracing: #{__FILE__}:17/)
+    end
 
-      it 'must show error message if thread number is not specified' do
-        enter 'break 8', 'cont', 'thread stop', release
-        debug_proc(@example)
-        check_error_includes '"thread stop" needs a thread number'
-      end
+    def test_thread_stop_shows_error_when_thread_number_not_specified
+      skip 'for now'
+      enter 'break 8', 'cont', 'thread stop', release
+      debug_proc(@example)
+      check_error_includes '"thread stop" needs a thread number'
+    end
 
-      it 'must show error message when trying to stop current thread' do
-        enter 'break 8', 'cont', -> { "thread stop #{first_thnum}" }, release
-        debug_proc(@example)
-        check_error_includes "It's the current thread"
-      end
+    def test_thread_stop_shows_error_when_trying_to_stop_current_thread
+      skip 'for now'
+      enter 'break 8', 'cont', -> { "thread stop #{first_thnum}" }, release
+      debug_proc(@example)
+      check_error_includes "It's the current thread"
     end
 
-    describe 'resume' do
-      it 'must mark remove thread from the suspended state' do
-        thnum = nil
-        enter 'break 21', 'cont',
-              -> { thnum = last_thnum ; "thread stop #{thnum}" },
-              -> { "thread resume #{thnum}" }, release
-        debug_proc(@example) { Byebug.contexts.last.suspended?.must_equal false }
-        check_output_includes(/\$ #{thnum} #<Thread:/, /#{thnum} #<Thread:/)
+    def test_thread_resume_removes_threads_from_the_suspended_state
+      skip 'for now'
+      thnum = nil
+      enter 'break 21', 'cont',
+            -> { thnum = last_thnum ; "thread stop #{thnum}" },
+            -> { "thread resume #{thnum}" }, release
+      debug_proc(@example) do
+        assert_equal false, Byebug.contexts.last.suspended?
       end
+      check_output_includes(/\$ #{thnum} #<Thread:/, /#{thnum} #<Thread:/)
+    end
 
-      it 'must show error message if thread number is not specified' do
-        enter 'break 8', 'cont', 'thread resume', release
-        debug_proc(@example)
-        check_error_includes '"thread resume" needs a thread number'
-      end
+    def test_thread_resume_shows_error_if_thread_number_not_specified
+      skip 'for now'
+      enter 'break 8', 'cont', 'thread resume', release
+      debug_proc(@example)
+      check_error_includes '"thread resume" needs a thread number'
+    end
 
-      it 'must show error message when trying to resume current thread' do
-        enter 'break 8', 'cont', ->{ "thread resume #{first_thnum}" }, release
-        debug_proc(@example)
-        check_error_includes "It's the current thread"
-      end
+    def test_thread_resume_shows_error_when_trying_to_resume_current_thread
+      skip 'for now'
+      enter 'break 8', 'cont', -> { "thread resume #{first_thnum}" }, release
+      debug_proc(@example)
+      check_error_includes "It's the current thread"
+    end
 
-      it 'must show error message if it is not stopped' do
-        enter 'break 21', 'cont', ->{ "thread resume #{last_thnum}" }, release
-        debug_proc(@example)
-        check_error_includes 'Already running'
-      end
+    def test_thread_resume_shows_error_if_thread_is_already_running
+      skip 'for now'
+      enter 'break 21', 'cont', -> { "thread resume #{last_thnum}" }, release
+      debug_proc(@example)
+      check_error_includes 'Already running'
     end
 
-    describe 'switch' do
-      it 'must switch to another thread' do
-        enter 'break 21', 'cont', ->{ "thread switch #{last_thnum}" }, release
-        debug_proc(@example) { assert_equal state.line, 16 }
-      end
+    def test_thread_switch_changes_execution_to_another_thread
+      skip 'for now'
+      enter 'break 21', 'cont', -> { "thread switch #{last_thnum}" }, release
+      debug_proc(@example) { assert_equal state.line, 16 }
+    end
 
-      it 'must show error message if thread number is not specified' do
-        enter 'break 8', 'cont', 'thread switch', release
-        debug_proc(@example)
-        check_error_includes '"thread switch" needs a thread number'
-      end
+    def test_thread_switch_shows_error_if_thread_number_not_specified
+      skip 'for now'
+      enter 'break 8', 'cont', 'thread switch', release
+      debug_proc(@example)
+      check_error_includes '"thread switch" needs a thread number'
+    end
 
-      it 'must show error message when trying to switch current thread' do
-        enter 'break 8', 'cont', ->{ "thread switch #{first_thnum}" }, release
-        debug_proc(@example)
-        check_error_includes "It's the current thread"
-      end
+    def test_thread_switch_shows_error_when_trying_to_switch_current_thread
+      skip 'for now'
+      enter 'break 8', 'cont', -> { "thread switch #{first_thnum}" }, release
+      debug_proc(@example)
+      check_error_includes "It's the current thread"
     end
   end
 end

data/test/trace_test.rb

@@ -1,6 +1,6 @@
-module TraceTest
-  class TraceTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class TraceTestCase < TestCase
+    def setup
       @example = -> do
         $bla = 5
         byebug
@@ -11,98 +11,61 @@ module TraceTest
         $bla = (0 == (10 % $bla))
       end
       untrace_var(:$bla) if defined?($bla)
-    end
-
-    describe 'line tracing' do
-      describe 'enabling' do
-        it 'must trace execution by setting trace to on' do
-          enter 'set linetrace', 'cont 10', 'set nolinetrace'
-          debug_proc(@example)
-          check_output_includes 'linetrace is on',
-                                "Tracing: #{__FILE__}:8 $bla = 8",
-                                "Tracing: #{__FILE__}:10 $bla = 10"
-        end
-
-        it 'must be able to use a shortcut' do
-          enter 'set lin on', 'cont 10', 'set nolin'
-          debug_proc(@example)
-          check_output_includes 'linetrace is on',
-                                "Tracing: #{__FILE__}:8 $bla = 8",
-                                "Tracing: #{__FILE__}:10 $bla = 10"
-        end
-
-        it 'must correctly print lines containing % sign' do
-          enter 'cont 10', 'set linetrace', 'next', 'set nolinetrace'
-          debug_proc(@example)
-          check_output_includes "Tracing: #{__FILE__}:11 $bla = (0 == (10 % $bla))"
-        end
-
-        describe 'when basename set' do
-          temporary_change_hash Byebug::Setting, :basename, true
 
-          it 'must correctly print file lines' do
-            enter 'set linetrace on', 'cont 10', 'set nolinetrace'
-            debug_proc(@example)
-            check_output_includes \
-              "Tracing: #{File.basename(__FILE__)}:10 $bla = 10"
-          end
-        end
-      end
+      super
+    end
 
-      describe 'disabling' do
-        it 'must stop tracing by setting trace to off' do
-          enter 'set linetrace', 'next', 'set nolinetrace'
-          debug_proc(@example)
-          check_output_includes "Tracing: #{__FILE__}:8 $bla = 8"
-          check_output_doesnt_include "Tracing: #{__FILE__}:9 $bla = 9"
-        end
+    def test_linetrace_setting_enables_tracing_program_execution
+      enter 'set linetrace', 'cont 11', 'set nolinetrace'
+      debug_proc(@example)
+      check_output_includes 'linetrace is on',
+        "Tracing: #{__FILE__}:8         $bla = 8",
+        "Tracing: #{__FILE__}:9         $bla = 9",
+        "Tracing: #{__FILE__}:10         $bla = 10",
+        "Tracing: #{__FILE__}:11         $bla = (0 == (10 % $bla))"
+    end
 
-        it 'must show a message when turned off' do
-          enter 'set nolinetrace'
-          debug_proc(@example)
-          check_output_includes 'linetrace is off'
-        end
-      end
+    def test_basename_setting_affects_tracing_output
+      enter 'set basename', 'set linetrace on', 'cont 10', 'set nolinetrace'
+      debug_proc(@example)
+      check_output_includes \
+        "Tracing: #{File.basename(__FILE__)}:10         $bla = 10"
     end
 
-    describe 'global variable tracing' do
-      it 'must track global variable' do
-        enter 'tracevar bla'
-        debug_proc(@example)
-        check_output_includes "traced global variable 'bla' has value '7'",
-                              "traced global variable 'bla' has value '10'"
-      end
+    def test_disabling_linetrace_setting_stops_tracing
+      enter 'set linetrace', 'next', 'set nolinetrace'
+      debug_proc(@example)
+      check_output_includes "Tracing: #{__FILE__}:8         $bla = 8"
+      check_output_doesnt_include "Tracing: #{__FILE__}:9         $bla = 9"
+    end
 
-      it 'must be able to use a shortcut' do
-        enter 'tracevar bla'
-        debug_proc(@example)
-        check_output_includes "traced global variable 'bla' has value '7'"
-                              "traced global variable 'bla' has value '10'"
-      end
+    def test_tracevar_tracks_global_variables
+      enter 'tracevar bla'
+      debug_proc(@example)
+      check_output_includes "traced global variable 'bla' has value '7'",
+                            "traced global variable 'bla' has value '10'"
+    end
 
-      it 'must track global variable with stop' do
-        enter 'tracevar bla stop', 'break 10', 'cont'
-        debug_proc(@example) { state.line.must_equal 8 }
-      end
+    def test_tracevar_stop_makes_program_stop_when_global_var_changes
+      enter 'tracevar bla stop', 'break 10', 'cont'
+      debug_proc(@example) { assert_equal 8, state.line }
+    end
 
-      it 'must track global variable with nostop' do
-        enter 'tracevar bla nostop', 'break 10', 'cont'
-        debug_proc(@example) { state.line.must_equal 10 }
-      end
+    def test_tracevar_nostop_does_not_stop_when_global_var_changes
+      enter 'tracevar bla nostop', 'break 10', 'cont'
+      debug_proc(@example) { assert_equal 10, state.line }
+    end
 
-      describe 'errors' do
-        it 'must show an error message if there is no such global variable' do
-          enter 'tracevar foo'
-          debug_proc(@example)
-          check_error_includes "'foo' is not a global variable."
-        end
+    def test_tracevar_shows_an_error_message_if_there_is_no_such_global_var
+      enter 'tracevar foo'
+      debug_proc(@example)
+      check_error_includes "'foo' is not a global variable."
+    end
 
-        it 'must show an error message if subcommand is invalid' do
-          enter 'tracevar bla foo'
-          debug_proc(@example)
-          check_error_includes 'expecting "stop" or "nostop"; got "foo"'
-        end
-      end
+    def test_tracevar_shows_an_error_message_if_subcommand_is_invalid
+      enter 'tracevar bla foo'
+      debug_proc(@example)
+      check_error_includes 'expecting "stop" or "nostop"; got "foo"'
     end
   end
 end

data/test/variables_test.rb

@@ -1,5 +1,5 @@
-module VariablesTest
-  class Example
+module Byebug
+  class VariablesExample
     SOMECONST = 'foo' unless defined?(SOMECONST)
 
     def initialize
@@ -18,116 +18,79 @@ module VariablesTest
     end
   end
 
-
-  class VariablesTestCase < TestDsl::TestCase
-    before do
+  class VariablesTestCase < TestCase
+    def setup
       @example = -> do
         byebug
 
-        v = Example.new
+        v = VariablesExample.new
         v.run
       end
+
+      super
     end
 
     # we check a class minitest variable... brittle but ok for now
-    describe 'class variables' do
-      before { enter 'break 28', 'cont' }
-
-      it 'must show variables' do
-        enter 'var class'
-        debug_proc(@example)
-        check_output_includes(/@@runnables/)
-      end
-
-      it 'must be able to use shortcut' do
-        enter 'v cl'
+    ['var class', 'v cl'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_class_variables") do
+        enter cmd_alias
         debug_proc(@example)
         check_output_includes(/@@runnables/)
       end
     end
 
-    describe 'constants' do
-      it 'must show constants' do
-        enter 'break 28', 'cont', 'var const Example'
+    ['var const', 'v co'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_constants_in_class_or_module") do
+        enter "#{cmd_alias} VariablesExample"
         debug_proc(@example)
         check_output_includes 'SOMECONST => "foo"'
       end
-
-      it 'must be able to use shortcut' do
-        enter 'break 28', 'cont', 'v co Example'
-        debug_proc(@example)
-        check_output_includes 'SOMECONST => "foo"'
-      end
-
-      it 'must show error message if given object is not a class or a module' do
-        enter 'break 28', 'cont', 'var const v'
-        debug_proc(@example)
-        check_output_includes 'Should be Class/Module: v'
-      end
     end
 
-    describe 'globals' do
-      it 'must show global variables' do
-        enter 'break 28', 'cont', 'var global'
-        debug_proc(@example)
-        check_output_includes '$VERBOSE = true'
-      end
+    def test_var_const_shows_error_if_given_object_is_not_a_class_or_module
+      enter 'var const v'
+      debug_proc(@example)
+      check_output_includes 'Should be Class/Module: v'
+    end
 
-      it 'must be able to use shortcut' do
-        enter 'break 28', 'cont', 'v g'
+    ['var global', 'v g'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_global_variables") do
+        enter cmd_alias
         debug_proc(@example)
         check_output_includes '$VERBOSE = true'
       end
     end
 
-    describe 'instance variables' do
-      it 'must show instance variables of the given object' do
-        enter 'break 28', 'cont', 'var instance v'
-        debug_proc(@example)
-        check_output_includes '@inst_a = 1', '@inst_b = 2'
-      end
-
-      it 'must show instance variables of self' do
-        enter 'break 9', 'cont', 'var instance'
-        debug_proc(@example)
-        check_output_includes '@inst_a = 1', '@inst_b = 2'
-      end
-
-      it 'must show instance variables' do
-        enter 'break 28', 'cont', 'var instance v'
-        debug_proc(@example)
-        check_output_includes '@inst_a = 1', '@inst_b = 2'
-      end
-
-      it 'must be able to use shortcut' do
-        enter 'break 28', 'cont', 'v ins v'
+    ['var instance', 'v ins'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_instance_vars_of_an_object") do
+        enter 'break 27', 'cont', "#{cmd_alias} v"
         debug_proc(@example)
         check_output_includes '@inst_a = 1', '@inst_b = 2'
       end
+    end
 
-      describe 'when width is too small' do
-        temporary_change_hash Byebug::Setting, :width, 20
+    def test_var_instance_shows_instance_variables_of_self_if_no_object_given
+      enter 'break 9', 'cont', 'var instance'
+      debug_proc(@example)
+      check_output_includes '@inst_a = 1', '@inst_b = 2'
+    end
 
-        it 'must cut long variable values according it' do
-          enter 'break 28', 'cont', 'var instance v'
-          debug_proc(@example)
-          check_output_includes '@inst_c = "1111111111111111...'
-        end
-      end
+    def test_var_instance_cuts_long_variable_values_according_to_width_setting
+      enter 'break 27', 'cont', 'set width 45', 'var instance v'
+      debug_proc(@example)
+      check_output_includes '@inst_c = "1111111111111111111111111111111...'
+    end
 
-      it 'must show error if value doesn\'t have #to_s/#inspect methods' do
-        enter 'break 28', 'cont', 'var instance v'
-        debug_proc(@example)
-        check_output_includes '@inst_d = *Error in evaluation*'
-      end
+    def test_v_ins_shows_error_if_value_does_not_have_to_s_or_inspect_methods
+      enter 'break 27', 'cont', 'v ins v'
+      debug_proc(@example)
+      check_output_includes '@inst_d = *Error in evaluation*'
     end
 
-    describe 'local variables' do
-      it 'must show local variables' do
-        enter 'break 15', 'cont', 'var local'
-        debug_proc(@example)
-        check_output_includes 'a => 4', 'b => nil', 'i => 1'
-      end
+    def test_var_local_shows_local_variables
+      enter 'break 15', 'cont', 'var local'
+      debug_proc(@example)
+      check_output_includes 'a => 4', 'b => nil', 'i => 1'
     end
   end
 end