debugger 1.0.0.rc1

data/test/data/setshow.cmd

@@ -0,0 +1,56 @@
+# This tests the functioning of some set/show debugger commands
+set debuggertesting on
+### *******************************
+### ***   Set/show commands     ***
+### *******************************
+########################################
+###   test args and baseneme...
+########################################
+set args this is a test
+show args
+show basename
+set basename foo
+show base
+set basename off
+show basename
+set basename 0
+show basename
+set basename 1
+show basename
+########################################
+###   test listsize tests...
+########################################
+show listsize
+show listsi
+set listsize abc
+set listsize -20
+########################################
+###  test linetrace...
+########################################
+set linetrace on
+show linetrace
+set linetrace off
+show linetrace
+########################################
+###  show history
+########################################
+set history
+set history size 10
+show history size
+set history save off
+show history save
+set history save 1
+show history save
+#### Test 'autoeval'...
+set autoeval on
+puts 'printed via autoeval'
+set autoeval off
+puts 'autoeval should not run this'
+#### Test 'callstyle'...
+set callstyle
+set callstyle short
+set callstyle last
+set callstyle tracked
+set callstyle foo
+
+

data/test/data/setshow.right

@@ -0,0 +1,98 @@
+gcd.rb:4
+def gcd(a, b)
+# # This tests the functioning of some set/show debugger commands
+# set debuggertesting on
+Currently testing the debugger is on.
+# ### *******************************
+# ### ***   Set/show commands     ***
+# ### *******************************
+# ########################################
+# ###   test args and baseneme...
+# ########################################
+# set args this is a test
+Argument list to give program being debugged when it is started is "this is a test".
+# show args
+Argument list to give program being debugged when it is started is "this is a test".
+# show basename
+basename is on.
+# set basename foo
+Expecting 'on', 1, 'off', or 0. Got: foo.
+# show base
+basename is on.
+# set basename off
+basename is off.
+# show basename
+basename is off.
+# set basename 0
+basename is off.
+# show basename
+basename is off.
+# set basename 1
+basename is on.
+# show basename
+basename is on.
+# ########################################
+# ###   test listsize tests...
+# ########################################
+# show listsize
+Number of source lines to list by default is 10.
+# show listsi
+Number of source lines to list by default is 10.
+# set listsize abc
+Set listsize argument 'abc' needs to be a number.
+# set listsize -20
+Set listsize argument '-20' needs to at least 1.
+# ########################################
+# ###  test linetrace...
+# ########################################
+# set linetrace on
+line tracing is on.
+# show linetrace
+line tracing is on.
+# set linetrace off
+line tracing is off.
+# show linetrace
+line tracing is off.
+# ########################################
+# ###  show history
+# ########################################
+# set history
+Need two parameters for 'set history'; got 0.
+# set history size 10
+Debugger history size is 10
+# show history size
+Debugger history size is 10
+# set history save off
+Saving of history save is off.
+# show history save
+Saving of history save is off.
+# set history save 1
+Saving of history save is on.
+# show history save
+Saving of history save is on.
+# #### Test 'autoeval'...
+# set autoeval on
+autoeval is on.
+# puts 'printed via autoeval'
+printed via autoeval
+nil
+# set autoeval off
+autoeval is off.
+# puts 'autoeval should not run this'
+*** Unknown command: "puts 'autoeval should not run this'".  Try "help".
+# #### Test 'callstyle'...
+# set callstyle
+Invalid call style . Should be one of: 'short' or 'last'.
+Frame call-display style is last.
+# set callstyle short
+Frame call-display style is short.
+# set callstyle last
+Frame call-display style is last.
+# set callstyle tracked
+Invalid call style tracked. Should be one of: 'short' or 'last'.
+Frame call-display style is last.
+# set callstyle foo
+Invalid call style foo. Should be one of: 'short' or 'last'.
+Frame call-display style is last.
+# 
+# 

data/test/data/source.cmd

@@ -0,0 +1,5 @@
+# Test the source command
+# rdebug-save has breakpoint commands
+set debuggertesting on
+source ./rdebug-save.1
+quit

data/test/data/source.right

@@ -0,0 +1,15 @@
+gcd.rb:4
+def gcd(a, b)
+# # Test the source command
+# # rdebug-save has breakpoint commands
+# set debuggertesting on
+Currently testing the debugger is on.
+# source ./rdebug-save.1
+Breakpoint 1 file gcd.rb, line 10
+Breakpoint 2 file gcd.rb, line 12
+autoeval is on.
+basename is off.
+Currently testing the debugger is on.
+autolist is off.
+autoirb is off.
+# quit

data/test/data/stepping.cmd

@@ -0,0 +1,21 @@
+# ***************************************************
+# This tests step, next, finish and continue
+# ***************************************************
+set debuggertesting on
+set callstyle last
+next
+where
+step a
+set forcestep on
+step- ; step-
+set forcestep off
+where
+next
+step+
+where
+step 3
+step+
+where
+next+	
+# finish
+quit

data/test/data/stepping.right

@@ -0,0 +1,50 @@
+gcd.rb:4
+def gcd(a, b)
+# # ***************************************************
+# # This tests step, next, finish and continue
+# # ***************************************************
+# set debuggertesting on
+Currently testing the debugger is on.
+# set callstyle last
+Frame call-display style is last.
+# next
+gcd.rb:18
+gcd(3,5)
+# where
+--> #0 at line gcd.rb:18
+# step a
+Step argument 'a' needs to be a number.
+# set forcestep on
+force-stepping is on.
+# step- ; step-
+gcd.rb:6
+if a > b
+# set forcestep off
+force-stepping is off.
+# where
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+    #1 at line gcd.rb:18
+# next
+gcd.rb:10
+return nil if a <= 0
+# step+
+gcd.rb:12
+if a == 1 or b-a == 0
+# where
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:12
+    #1 at line gcd.rb:18
+# step 3
+gcd.rb:10
+return nil if a <= 0
+# step+
+gcd.rb:12
+if a == 1 or b-a == 0
+# where
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:12
+    #1 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:15
+    #2 at line gcd.rb:18
+# next+	
+gcd.rb:15
+gcd(b-a, a)
+# # finish
+# quit

data/test/data/test-init-cygwin.right

@@ -0,0 +1,7 @@
+gcd-dbg.rb:18
+if a > b
+(rdb:1) p Debugger::PROG_SCRIPT
+"./gcd-dbg.rb"
+(rdb:1) show args
+Argument list to give program being debugged when it is started is "5".
+(rdb:1) quit unconditionally

data/test/data/test-init-osx.right

@@ -0,0 +1,4 @@
+gcd-dbg.rb:18
+if a > b
+"./gcd-dbg.rb"
+Argument list to give program being debugged when it is started is "5".

data/test/data/test-init.right

@@ -0,0 +1,5 @@
+gcd-dbg.rb:18
+if a > b
+(rdb:1) "./gcd-dbg.rb"
+(rdb:1) Argument list to give program being debugged when it is started is "5".
+(rdb:1) 

data/test/data/trace.right

@@ -0,0 +1,14 @@
+Tracing(1):./gcd.rb:4 def gcd(a, b)
+Tracing(1):./gcd.rb:18 gcd(3,5)
+Tracing(1):./gcd.rb:6 if a > b
+Tracing(1):./gcd.rb:10 return nil if a <= 0
+Tracing(1):./gcd.rb:12 if a == 1 or b-a == 0
+Tracing(1):./gcd.rb:15 gcd(b-a, a)
+Tracing(1):./gcd.rb:6 if a > b
+Tracing(1):./gcd.rb:10 return nil if a <= 0
+Tracing(1):./gcd.rb:12 if a == 1 or b-a == 0
+Tracing(1):./gcd.rb:15 gcd(b-a, a)
+Tracing(1):./gcd.rb:6 if a > b
+Tracing(1):./gcd.rb:10 return nil if a <= 0
+Tracing(1):./gcd.rb:12 if a == 1 or b-a == 0
+Tracing(1):./gcd.rb:13 return a

data/test/dollar-0.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# A test to see that rdebug set's $0 properly.
+puts $0
+puts __FILE__
+

data/test/gcd-dbg-nox.rb

@@ -0,0 +1,31 @@
+# This program is *NOT* supposed to be executable, but called
+# via ruby (in order to test that restart provides a funky $:).
+# This program is used to test that 'restart' works when we didn't call
+# the debugger initially.
+
+TOP_SRC_DIR = File.join(File.expand_path(File.dirname(__FILE__), '..')) unless 
+  defined?(TOP_SRC_DIR)
+
+$:.unshift File.join(TOP_SRC_DIR, 'ext')
+$:.unshift File.join(TOP_SRC_DIR, 'lib')
+$:.unshift File.join(TOP_SRC_DIR, 'cli')
+require 'ruby-debug'
+Debugger.init
+
+# GCD. We assume positive numbers
+def gcd(a, b)
+  # Make: a <= b
+  debugger
+  if a > b
+    a, b = [b, a]
+  end
+
+  return nil if a <= 0
+
+  if a == 1 or b-a == 0
+    return a
+  end
+  return gcd(b-a, a)
+end
+
+gcd(3,5)

data/test/gcd-dbg.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# This program is used to test that 'restart' works when we didn't call
+# the debugger initially.
+
+TOP_SRC_DIR = File.join(File.expand_path(File.dirname(__FILE__), "..")) unless 
+  defined?(TOP_SRC_DIR)
+
+$:.unshift File.join(TOP_SRC_DIR, "ext")
+$:.unshift File.join(TOP_SRC_DIR, "lib")
+$:.unshift File.join(TOP_SRC_DIR, "cli")
+require 'ruby-debug'
+
+
+# GCD. We assume positive numbers
+def gcd(a, b)
+  # Make: a <= b
+  debugger
+  if a > b
+    a, b = [b, a]
+  end
+
+  return nil if a <= 0
+
+  if a == 1 or b-a == 0
+    return a
+  end
+  return gcd(b-a, a)
+end
+
+gcd(3,5)

data/test/gcd.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# GCD. We assume positive numbers
+def gcd(a, b)
+  # Make: a <= b
+  if a > b
+    a, b = [b, a]
+  end
+
+  return nil if a <= 0
+
+  if a == 1 or b-a == 0
+    return a
+  end
+  gcd(b-a, a)
+end
+
+gcd(3,5)

data/test/helper.rb

@@ -0,0 +1,144 @@
+# Some common routines used in testing.
+
+require 'fileutils'
+require 'yaml'
+# require 'diff/lcs'
+# require 'diff/lcs/hunk'
+
+# begin require 'rubygems' rescue LoadError end
+# require 'ruby-debug'; Debugger.start
+
+module TestHelper
+
+  # FIXME: turn args into a hash.
+  def run_debugger(testname, args='', outfile=nil, filter=nil, old_code=false,
+                   debug_pgm='tdebug.rb')
+    rightfile = File.join('data', "#{testname}.right")
+    
+    outfile = "#{testname}.out" unless outfile
+
+    if File.exists?(outfile)
+      FileUtils.rm(outfile)
+    end
+    
+    ENV['RDEBUG'] = debug_pgm
+
+    if old_code
+      cmd = "/bin/sh #{File.join('..', 'runner.sh')} #{args} >#{outfile}"
+    else
+      cmd = "#{"#{load_ruby} #{load_params} "}../rdbg.rb #{args} > #{outfile}"
+    end
+    puts "'#{cmd}'" if $DEBUG
+    output = `#{cmd}`
+    
+    curr_path = Dir.pwd
+    got_lines     = File.read(outfile).split(/\n/).map{|s| s.sub(curr_path, '.') }
+    correct_lines = File.read(rightfile).split(/\n/)
+    filter.call(got_lines, correct_lines) if filter
+    if cheap_diff(got_lines, correct_lines)
+      FileUtils.rm(outfile)
+      return true
+    end
+    return false
+  end
+
+  def cheap_diff(got_lines, correct_lines)
+    if $DEBUG
+      got_lines.each_with_index do |line, i|
+        printf "%3d %s\n", i+1, line
+      end
+    end
+    correct_lines.each_with_index do |line, i|
+      correct_lines[i].chomp!
+      if got_lines[i] != correct_lines[i]
+        puts "difference found at line #{i+1}"
+        puts "got : #{got_lines[i]}"
+        puts "need: #{correct_lines[i]}"
+        return false
+      end
+    end
+    if correct_lines.size != got_lines.size
+      puts("difference in number of lines: " + 
+           "#{correct_lines.size} vs. #{got_lines.size}")
+      return false
+    end
+    return true
+  end
+
+  # FIXME: using this causes the same test to get run several times 
+  # and some tests fail probably because of a lack of environment isolation.
+  # Many tests follow a basic pattern: run the debugger with a given
+  # debugger script and compare output produced. The following creates
+  # this kind of test.
+  def add_test(base_name, src_dir, script_name=nil, cmd=nil, test_name=nil)
+    puts "+++ Adding #{base_name} ++++" if $DEBUG
+    test_name   = base_name unless test_name
+    script_name = File.join('data', test_name + '.cmd') unless script_name
+    cmd         = 'gcd.rb 3 5' unless cmd
+    eval <<-EOF
+    def test_#{test_name}
+      Dir.chdir(\"#{src_dir}\") do 
+        assert_equal(true, 
+                     run_debugger(\"#{base_name}\", 
+                                  \"--script #{script_name} -- #{cmd}\"))
+      end
+    end
+    EOF
+  end
+  module_function :add_test
+               
+  # Adapted from the Ruby Cookbook, Section 6.10: Comparing two files.
+  # def diff_as_string(rightfile, checkfile, format=:unified, context_lines=3)
+  #   right_data = File.read(rightfile)
+  #   check_data = File.read(checkfile)
+  #   output = ''
+  #   diffs = Diff::LCS.diff(right_data, check_data)
+  #   return output if diffs.empty?
+  #   oldhunk = hunk = nil
+  #   file_length_difference = 0
+  #   diffs.each do |piece|
+  #     begin
+  #       hunk = Diff::LCS::Hunk.new(right_data, check_data, piece, 
+  #                                  context_lines, file_length_difference)
+  #       next unless oldhunk
+  #
+  #       # Hunks may overlap, which is why we need to be careful when our
+  #       # diff includes lines of context. Otherwise, we might print
+  #       # redundant lines.
+  #       if (context_lines > 0) and hunk.overlaps?(oldhunk)
+  #         hunk.unshift(oldhunk)
+  #         else
+  #         output << oldhunk.diff(format)
+  #       end
+  #     ensure
+  #       oldhunk = hunk
+  #       output << '\n'
+  #     end
+  #   end
+  
+  #   # Handle the last remaining hunk 
+  #   output << oldhunk.diff(format) << '\n'
+  # end
+  
+  # Loads key from the _config_._yaml_ file.
+  def config_load(key, may_be_nil=false, default_value='')
+    conf = File.join('config.private.yaml') # try private first
+    conf = File.join('config.yaml') unless File.exists?(conf)
+    value = YAML.load_file(conf)[key]
+    assert_not_nil(value, "#{key} is set in config.yaml") unless may_be_nil
+    value || default_value
+  end
+  module_function :config_load
+
+  def load_ruby
+    config_load('ruby', true)
+  end
+  module_function :load_ruby
+
+  def load_params
+    config_load('ruby_params', true)
+  end
+  module_function :load_params
+  
+end
+