byebug 3.0.0 → 3.1.0

data/test/support/test_dsl.rb

@@ -5,7 +5,6 @@ module TestDsl
 
     def setup
       Byebug.handler = Byebug::CommandProcessor.new(Byebug::TestInterface.new)
-      Byebug.tracing = false
       Byebug.breakpoints.clear if Byebug.breakpoints
     end
 
@@ -78,7 +77,7 @@ module TestDsl
   end
 
   #
-  # Runs byebug with the provided basename for a file.
+  # Runs the provided Proc.
   #
   # You also can specify a block, which will be executed when Processor extracts
   # all the commands from the input queue. You can use that for making asserts
@@ -86,16 +85,20 @@ module TestDsl
   # the test will fail.
   #
   # Usage:
-  #   debug_file '/path/to/ex1.rb'
+  #   debug_proc -> { byebug; puts 'Hello' }
   #
   #   enter 'b 4', 'cont'
-  #   debug_file('/path/to/ex2.rb') { state.line.must_equal 4 }
+  #   code = -> do
+  #     byebug
+  #     puts 'hello'
+  #   end
+  #   debug_proc(code) { state.line.must_equal 4 }
   #
-  def debug_file(filename, options = {}, &block)
+  def debug_proc(program, &block)
     Byebug.stubs(:run_init_script)
     interface.test_block = block
     begin
-      load fullpath(filename)
+      program.call
     ensure
       interface.test_block.call if interface.test_block
     end
@@ -160,9 +163,4 @@ module TestDsl
                              .join("\n") + "\n"
     File.open(file, 'w') { |f| f.write(new_content) }
   end
-
-  def must_restart
-    Byebug::RestartCommand.any_instance.unstub(:exec)
-    Byebug::RestartCommand.any_instance.expects(:exec)
-  end
 end

data/test/test_helper.rb

@@ -11,14 +11,9 @@ require 'pathname'
 require 'mocha/mini_test'
 require 'byebug'
 
-Dir.glob(File.expand_path("../support/*.rb", __FILE__)).each { |f| require f }
+Dir.glob(File.expand_path('../support/*.rb', __FILE__)).each { |f| require f }
 
-Byebug.settings[:testing] = true
-
-class DummyObject
-  def initialize(*args)
-  end
-end
+Byebug::Setting[:testing] = true
 
 # Init globals to avoid warnings
 $bla = nil

data/test/thread_test.rb

@@ -1,138 +1,152 @@
-class ThreadExample
-  def initialize
-    Thread.main[:should_break] = false
-  end
-
-  def launch
-    @t1 = Thread.new do
-      while true
-        break if Thread.main[:should_break]
-        sleep 0.02
+module ThreadTest
+  class Example
+    def initialize
+      Thread.main[:should_break] = false
+    end
+
+    def launch
+      @t1 = Thread.new do
+        while true
+          break if Thread.main[:should_break]
+          sleep 0.02
+        end
       end
-    end
 
-    @t2 = Thread.new do
-      while true
-        sleep 0.02
+      @t2 = Thread.new do
+        while true
+          sleep 0.02
+        end
       end
+
+      @t1.join
+      Thread.main[:should_break]
     end
 
-    @t1.join
-    Thread.main[:should_break]
+    def kill
+      @t2.kill
+    end
   end
 
-  def kill
-    @t2.kill
-  end
-end
+  class ThreadTestCase < TestDsl::TestCase
+    let(:release) { 'eval Thread.main[:should_break] = true' }
 
-class TestThread < TestDsl::TestCase
-  let(:release) { 'eval Thread.main[:should_break] = true' }
+    before do
+      @example = -> do
+        byebug
 
-  describe 'list' do
-    it 'must show current thread by "plus" sign' do
-      thnum = nil
-      enter "break #{__FILE__}:7", 'cont', 'thread list', release
-      debug_file('thread') { thnum = Byebug.contexts.first.thnum }
-      check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:7/)
+        t = Example.new
+        t.launch
+        t.kill
+      end
     end
 
-    it 'must work with shortcut' do
-      thnum = nil
-      enter "break #{__FILE__}:7", 'cont', 'th list', release
-      debug_file('thread') { thnum = Byebug.contexts.first.thnum }
-      check_output_includes(/\+ #{thnum} #<Thread:\S+ run>\t#{__FILE__}:7/)
+    def first_thnum
+      Byebug.contexts.first.thnum
     end
 
-    it 'must show 3 available threads' do
-      enter "break #{__FILE__}:20", 'cont', 'thread list', release
-      debug_file 'thread'
-      check_output_includes(/(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
-                            /(\+)?\d+ #<Thread:\S+ (sleep|run)>/,
-                            /(\+)?\d+ #<Thread:\S+ (sleep|run)>/)
+    def last_thnum
+      Byebug.contexts.last.thnum
     end
-  end
 
-  describe 'stop' do
-    it 'must mark thread as suspended' do
-      thnum = nil
-      enter "break #{__FILE__}:20", 'cont',
-            ->{ "thread stop #{Byebug.contexts.last.thnum}" }, release
-      debug_file('thread') { thnum = Byebug.contexts.last.thnum }
-      check_output_includes(/\$ #{thnum} #<Thread:/)
-    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
 
-    it 'must actually suspend thread execution' do
-      enter "break #{__FILE__}:20", 'cont', 'trace on',
-            ->{ "thread stop #{Byebug.contexts.last.thnum}" }, release
-      debug_file('thread')
-      check_output_doesnt_include(/Tracing: #{__FILE__}:15/,
-                                  /Tracing: #{__FILE__}:16/)
-    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
 
-    it 'must show error message if thread number is not specified' do
-      enter "break #{__FILE__}:7", 'cont', 'thread stop', release
-      debug_file 'thread'
-      check_error_includes '"thread stop" needs a thread number'
+      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
     end
 
-    it 'must show error message when trying to stop current thread' do
-      enter "break #{__FILE__}:7", 'cont',
-            ->{"thread stop #{Byebug.contexts.first.thnum}"}, release
-      debug_file 'thread'
-      check_error_includes "It's the current thread"
-    end
-  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
 
-  describe 'resume' do
-    it 'must mark remove thread from the suspended state' do
-      thnum = nil
-      enter "break #{__FILE__}:20", 'cont',
-            -> { thnum = Byebug.contexts.last.thnum ; "thread stop #{thnum}" },
-            -> { "thread resume #{thnum}" }, release
-      debug_file('thread') { Byebug.contexts.last.suspended?.must_equal false }
-      check_output_includes(/\$ #{thnum} #<Thread:/, /#{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
 
-    it 'must show error message if thread number is not specified' do
-      enter "break #{__FILE__}:7", 'cont', 'thread resume', release
-      debug_file 'thread'
-      check_error_includes '"thread resume" needs a thread number'
-    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
 
-    it 'must show error message when trying to resume current thread' do
-      enter "break #{__FILE__}:7", 'cont',
-            ->{ "thread resume #{Byebug.contexts.first.thnum}" }, release
-      debug_file 'thread'
-      check_error_includes "It's the current thread"
+      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
     end
 
-    it 'must show error message if it is not stopped' do
-      enter "break #{__FILE__}:20", 'cont',
-            ->{ "thread resume #{Byebug.contexts.last.thnum}" }, release
-      debug_file 'thread'
-      check_error_includes 'Already running'
-    end
-  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:/)
+      end
 
-  describe 'switch' do
-    it 'must switch to another thread' do
-      enter "break #{__FILE__}:20", 'cont',
-            ->{ "thread switch #{Byebug.contexts.last.thnum}" }, release
-      debug_file('thread') { assert_equal state.line, 15 }
-    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
 
-    it 'must show error message if thread number is not specified' do
-      enter "break #{__FILE__}:7", 'cont', 'thread switch', release
-      debug_file 'thread'
-      check_error_includes '"thread switch" needs a thread number'
+      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
+
+      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
     end
 
-    it 'must show error message when trying to switch current thread' do
-      enter "break #{__FILE__}:7", 'cont',
-            ->{ "thread switch #{Byebug.contexts.first.thnum}" }, release
-      debug_file 'thread'
-      check_error_includes "It's the current thread"
+    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
+
+      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
+
+      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
     end
   end
 end

data/test/trace_test.rb

@@ -1,104 +1,107 @@
-class TestTrace < TestDsl::TestCase
-  before do
-    untrace_var(:$bla) if defined?($bla)
-  end
+module TraceTest
+  class TraceTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        $bla = 5
+        byebug
+        $bla = 7
+        $bla = 8
+        $bla = 9
+        $bla = 10
+        $bla = (0 == (10 % $bla))
+      end
+      untrace_var(:$bla) if defined?($bla)
+    end
 
-  describe 'tracing' do
+    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
 
-    describe 'enabling' do
-      it 'must trace execution by setting trace to on' do
-        enter 'trace on', 'cont 7', 'trace off'
-        debug_file 'trace'
-        check_output_includes 'line tracing is on.',
-                              "Tracing: #{fullpath('trace')}:4 $bla = 4",
-                              "Tracing: #{fullpath('trace')}:7 $bla = 7"
-      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 be able to use a shortcut' do
-        enter 'tr on', 'cont 7', 'trace off'
-        debug_file 'trace'
-        check_output_includes 'line tracing is on.',
-                              "Tracing: #{fullpath('trace')}:4 $bla = 4",
-                              "Tracing: #{fullpath('trace')}:7 $bla = 7"
-      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
 
-      it 'must correctly print lines containing % sign' do
-        enter 'cont 7', 'trace on', 'next', 'trace off'
-        debug_file 'trace'
-        check_output_includes \
-          "Tracing: #{fullpath('trace')}:8 $bla = (0 == (7 % $bla))"
+        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
 
-      describe 'when basename set' do
-        temporary_change_hash Byebug.settings, :basename, true
+      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
 
-        it 'must correctly print file lines' do
-          enter 'tr on', 'cont 7', 'trace off'
-          debug_file 'trace'
-          check_output_includes \
-            "Tracing: #{File.basename(fullpath('trace'))}:7 $bla = 7"
+        it 'must show a message when turned off' do
+          enter 'set nolinetrace'
+          debug_proc(@example)
+          check_output_includes 'linetrace is off'
         end
       end
     end
 
-    it 'must show an error message if given subcommand is incorrect' do
-      enter 'trace bla'
-      debug_file 'trace'
-      check_error_includes \
-        'expecting "on", "off", "var" or "variable"; got: "bla"'
-    end
-
-    describe 'disabling' do
-      it 'must stop tracing by setting trace to off' do
-        enter 'trace on', 'next', 'trace off'
-        debug_file 'trace'
-        check_output_includes "Tracing: #{fullpath('trace')}:4 $bla = 4"
-        check_output_doesnt_include "Tracing: #{fullpath('trace')}:5 $bla = 5"
+    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
 
-      it 'must show a message when turned off' do
-        enter 'trace off'
-        debug_file 'trace'
-        check_output_includes 'line tracing is off.'
+      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
-    end
-  end
-
-  describe 'tracing global variables' do
-    it 'must track global variable' do
-      enter 'trace variable bla'
-      debug_file 'trace'
-      check_output_includes "traced global variable 'bla' has value '3'",
-                            "traced global variable 'bla' has value '7'"
-    end
-
-    it 'must be able to use a shortcut' do
-      enter 'trace var bla'
-      debug_file 'trace'
-      check_output_includes "traced global variable 'bla' has value '3'"
-    end
 
-    it 'must track global variable with stop' do
-      enter 'trace variable bla stop', 'break 7', 'cont'
-      debug_file('trace') { state.line.must_equal 4 }
-    end
-
-    it 'must track global variable with nostop' do
-      enter 'trace variable bla nostop', 'break 7', 'cont'
-      debug_file('trace') { state.line.must_equal 7 }
-    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
 
-    describe 'errors' do
-      it 'must show an error message if there is no such global variable' do
-        enter 'trace variable foo'
-        debug_file 'trace'
-        check_error_includes "'foo' is not a global variable."
+      it 'must track global variable with nostop' do
+        enter 'tracevar bla nostop', 'break 10', 'cont'
+        debug_proc(@example) { state.line.must_equal 10 }
       end
 
-      it 'must show an error message if subcommand is invalid' do
-        enter 'trace variable bla foo'
-        debug_file 'trace'
-        check_error_includes 'expecting "stop" or "nostop"; got "foo"'
+      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
+
+        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
     end
   end