spork 0.6.3 → 0.7.0

data/features/spork_debugger.feature

@@ -0,0 +1,47 @@
+Feature: Spork Debugger integration
+  As a developer
+  I want to invoke the debugger my specs within Spork
+  In order to drill in and figure out what's wrong
+
+  Background: Rails App with RSpec and Spork
+
+    Given a file named "spec/spec_helper.rb" with:
+      """
+      require 'rubygems'
+      require 'spork'
+      require 'spork/ext/ruby-debug'
+
+      Spork.prefork do
+        require 'spec'
+      end
+
+      Spork.each_run do
+      end
+      """
+
+  Scenario: Invoking the debugger via 'debugger'
+    Given a file named "spec/debugger_spec.rb" with:
+      """
+      require File.dirname(__FILE__) + '/spec_helper.rb'
+
+      describe "Debugger" do
+        it "should debug" do
+          @variable = "variable contents"
+          debugger
+          puts "it worked!"
+        end
+      end
+      """
+
+    When I fire up a spork instance with "spork rspec"
+    And I run this in the background: spec --drb spec/debugger_spec.rb
+
+    Then the spork window should output a line containing "Debug Session Started"
+
+    When I type this in the spork window: "e @variable"
+    Then the spork window should output a line containing "variable contents"
+
+    When I type this in the spork window: "continue"
+
+    Then the spork window should output a line containing "Debug Session Terminated"
+    And the output should contain "it worked!"

data/features/steps/sandbox_steps.rb

@@ -33,25 +33,22 @@ Given /^the following code appears in "([^\"]*)" after \/([^\\\/]*)\/:$/ do |fil
   end
 end
 
-When /^I run (spork|spec|cucumber)($| .*$)/ do |command, spork_opts|
-  case command
-  when 'spork'
-    command = SporkWorld::BINARY
-  when 'cucumber'
-    command = Cucumber::BINARY
-  else
-    command = %x{which #{command}}.chomp
-  end
-  run "#{SporkWorld::RUBY_BINARY} -I #{Cucumber::LIBDIR} #{command} #{spork_opts}"
+When /^I run (spork|spec|cucumber)(| .*)$/ do |command, args|
+  run(localized_command(command, args))
+end
+
+When /^I run this in the background: (spork|spec|cucumber)(| .*)$/ do |command, args|
+  @background_script = run_in_background(localized_command(command, args))
 end
 
 When /^I fire up a spork instance with "spork(.*)"$/ do |spork_opts|
-  run_in_background "#{SporkWorld::RUBY_BINARY} -I #{Cucumber::LIBDIR} #{SporkWorld::BINARY} #{spork_opts}"
+  @spork_server = run_in_background("#{SporkWorld::RUBY_BINARY} -I #{Cucumber::LIBDIR} #{SporkWorld::BINARY} #{spork_opts}")
+
   output = ""
   begin
     status = Timeout::timeout(15) do
       # Something that should be interrupted if it takes too much time...
-      while line = @bg_stderr.gets
+      while line = @spork_server.stderr.gets
         output << line
         puts line
         break if line.include?("Spork is ready and listening")
@@ -63,7 +60,29 @@ When /^I fire up a spork instance with "spork(.*)"$/ do |spork_opts|
   end
 end
 
-Then /the file "([^\"]*)" should include "([^\"]*)"/ do |filename, content|
+Then /^the spork window should output a line containing "(.+)"/ do |expected|
+  output = ""
+  begin
+    status = Timeout::timeout(5) do
+      # Something that should be interrupted if it takes too much time...
+      while line = @spork_server.stdout.gets
+        output << line
+        puts line
+        break if output.include?(expected)
+      end
+    end
+  rescue Timeout::Error
+    output.should include(expected)
+  end
+end
+
+When /^I type this in the spork window: "(.+)"/ do |line|
+  @spork_server.stdin.puts(line)
+  @spork_server.stdin.flush
+end
+
+
+Then /^the file "([^\"]*)" should include "([^\"]*)"$/ do |filename, content|
   in_current_dir do
     File.read(filename).should include(content)
   end

data/features/support/background_job.rb

@@ -0,0 +1,63 @@
+class BackgroundJob
+  attr_reader :stdin, :stdout, :stderr, :pid
+  def initialize(pid, stdin, stdout, stderr)
+    @pid, @stdin, @stdout, @stderr = pid, stdin, stdout, stderr
+    ObjectSpace.define_finalizer(self) { kill }
+  end
+
+  def self.run(command)
+    command = sanitize_params(command) if command.is_a?(Array)
+    child_stdin, parent_stdin = IO::pipe
+    parent_stdout, child_stdout = IO::pipe
+    parent_stderr, child_stderr = IO::pipe
+
+    pid = Kernel.fork do
+      [parent_stdin, parent_stdout, parent_stderr].each { |io| io.close }
+
+      STDIN.reopen(child_stdin)
+      STDOUT.reopen(child_stdout)
+      STDERR.reopen(child_stderr)
+
+      [child_stdin, child_stdout, child_stderr].each { |io| io.close }
+
+      exec command
+    end
+
+    [child_stdin, child_stdout, child_stderr].each { |io| io.close }
+    parent_stdin.sync = true
+
+    new(pid, parent_stdin, parent_stdout, parent_stderr)
+  end
+
+  def self.sanitize_params(params)
+    params.map { |p| p.gsub(' ', '\ ') }.join(" ")
+  end
+
+  def kill(signal = 'TERM')
+    if running?
+      Process.kill(Signal.list[signal], @pid)
+      true
+    end
+  end
+
+  def interrupt
+    kill('INT')
+  end
+
+  def running?
+    return false unless @pid
+    Process.getpgid(@pid)
+    true
+  rescue Errno::ESRCH
+    false
+  end
+
+  def wait(timeout = 1000)
+    Timeout.timeout(timeout) do
+      Process.wait(@pid)
+    end
+    true
+  rescue Timeout::Error
+    false
+  end
+end

data/features/support/env.rb

@@ -6,6 +6,8 @@ require 'spec/expectations'
 require 'timeout'
 require 'spork'
 
+require(File.dirname(__FILE__) + '/background_job.rb')
+
 class SporkWorld
   BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/spork')
   RUBY_BINARY   = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
@@ -25,6 +27,20 @@ class SporkWorld
 
   private
   attr_reader :last_exit_status, :last_stderr, :last_stdout, :background_jobs
+  def last_stderr
+    return @last_stderr if @last_stderr
+    if @background_job
+      @last_stderr = @background_job.stderr.read
+    end
+  end
+
+
+  def last_stdout
+    return @last_stdout if @last_stdout
+    if @background_job
+      @last_stdout = @background_job.stdout.read
+    end
+  end
 
   def create_file(file_name, file_content)
     file_content.gsub!("SPORK_LIB", "'#{spork_lib_dir}'") # Some files, such as Rakefiles need to use the lib dir
@@ -38,6 +54,18 @@ class SporkWorld
     Dir.chdir(@current_dir, &block)
   end
 
+  def localized_command(command, args)
+    case command
+    when 'spork'
+      command = SporkWorld::BINARY
+    when 'cucumber'
+      command = Cucumber::BINARY
+    else
+      command = %x{which #{command}}.chomp
+    end
+    "#{SporkWorld::RUBY_BINARY} -I #{Cucumber::LIBDIR} #{command} #{args}"
+  end
+
   def run(command)
     stderr_file = Tempfile.new('spork')
     stderr_file.close
@@ -49,36 +77,21 @@ class SporkWorld
   end
 
   def run_in_background(command)
-    child_stdin, parent_stdin = IO::pipe
-    parent_stdout, child_stdout = IO::pipe
-    parent_stderr, child_stderr = IO::pipe
-    
-    background_jobs << Kernel.fork do
-      [parent_stdin, parent_stdout, parent_stderr].each { |io| io.close }
-      
-      STDIN.reopen(child_stdin)
-      STDOUT.reopen(child_stdout)
-      STDERR.reopen(child_stderr)
-      
-      [child_stdin, child_stdout, child_stderr].each { |io| io.close }
-
-      in_current_dir do
-        exec command
-      end
+    in_current_dir do
+      @background_job = BackgroundJob.run(command)
     end
-    
-    [child_stdin, child_stdout, child_stderr].each { |io| io.close }
-    parent_stdin.sync = true
-    
-    @bg_stdin, @bg_stdout, @bg_stderr = [parent_stdin, parent_stdout, parent_stderr]
+    @background_jobs << @background_job
+    @background_job
   end
 
   def terminate_background_jobs
     if @background_jobs
-      @background_jobs.each do |pid|
-        Process.kill(Signal.list['TERM'], pid)
+      @background_jobs.each do |background_job|
+        background_job.kill
       end
     end
+    @background_jobs.clear
+    @background_job = nil
   end
 
 end

data/lib/spork/ext/ruby-debug.rb

@@ -0,0 +1,142 @@
+require 'ruby-debug'
+require 'socket'
+require 'forwardable'
+
+# Experimental! No automated tests are checking this, use at your own risk!
+
+class SporkDebugger
+  DEFAULT_PORT = 10_123
+  HOST = '127.0.0.1'
+
+  extend Forwardable
+  def_delegators :state, *[:prepare_debugger, :initialize]
+  attr_reader :state
+
+  class << self
+    attr_reader :instance
+    def run
+      @instance = new
+    end
+  end
+
+  def initialize
+    @state = SporkDebugger::PreloadState.new
+    Spork.send(:each_run_procs).unshift(lambda do
+      @state = @state.transition_to_each_run_state
+    end)
+  end
+
+  module NetworkHelpers
+    def find_port(starting_with)
+      port = starting_with
+      begin
+        server = TCPServer.new(HOST, port)
+        server.close
+      rescue Errno::EADDRINUSE
+        port += 1
+        retry
+      end
+
+      port
+    end
+  end
+
+  class PreloadState
+    include NetworkHelpers
+    def initialize
+      install_hook
+      listen_for_connection_signals
+    end
+
+    def finish
+      @tcp_service.close; @tcp_service = nil;
+    end
+
+    def transition_to_each_run_state
+      finish
+      SporkDebugger::EachRunState.new(@port)
+    end
+
+    protected
+      def install_hook
+        Kernel.class_eval do
+          alias :debugger_without_spork_hook :debugger
+          def debugger(steps = 1)
+            SporkDebugger.instance.prepare_debugger
+            debugger_without_spork_hook
+          end
+        end
+      end
+
+      def listen_for_connection_signals
+        @port = SporkDebugger::DEFAULT_PORT
+        begin
+          @tcp_service = TCPServer.new(SporkDebugger::HOST, @port)
+        rescue Errno::EADDRINUSE
+          @port += 1
+          retry
+        end
+        Thread.new { main_loop }
+      end
+
+      def main_loop
+        while @tcp_service do
+          socket = @tcp_service.accept
+          port = Marshal.load(socket)
+          Marshal.dump(true, socket)
+          connect_rdebug_client(port)
+          socket.close
+        end
+      rescue => e
+        puts "#{$$} - error: #{e}"
+      end
+
+      def connect_rdebug_client(port = Debugger::PORT)
+        puts "\n\n - Debug Session Started - \n\n\n"
+        Debugger.start_client(SporkDebugger::HOST, port)
+        puts "\n\n - Debug Session Terminated - \n\n\n"
+      end
+  end
+
+  class EachRunState
+    include NetworkHelpers
+    def initialize(connection_request_port)
+      @connection_request_port = connection_request_port
+    end
+
+    def prepare_debugger
+      port, cport = start_rdebug_server
+      signal_spork_server_to_connect_to_rdebug_server(port)
+      wait_for_connection
+      puts "\n\n - breakpoint - see your spork server for the debug terminal - \n\n"
+    end
+
+    def signal_spork_server_to_connect_to_rdebug_server(rdebug_server_port)
+      socket = TCPSocket.new(SporkDebugger::HOST, @connection_request_port)
+      Marshal.dump(rdebug_server_port, socket)
+      response = Marshal.load(socket)
+      socket.close
+    end
+
+    def start_rdebug_server
+      Debugger.stop if Debugger.started?
+      port = find_port(Debugger::PORT)
+      cport = find_port(port + 1)
+      Debugger.start_remote(SporkDebugger::HOST, [port, cport]) do
+        Debugger.run_init_script(StringIO.new)
+      end
+      Debugger.start
+      [port, cport]
+    end
+
+    protected
+      def wait_for_connection
+        while Debugger.handler.interface.nil?; sleep 0.10; end
+      end
+  end
+end
+
+Spork.prefork do
+  SporkDebugger.run
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spork
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors: 
 - Tim Harper
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 -06:00
+date: 2009-09-23 00:00:00 -06:00
 default_executable: spork
 dependencies: []
 
@@ -31,9 +31,11 @@ files:
 - features/diagnostic_mode.feature
 - features/rails_delayed_loading_workarounds.feature
 - features/rspec_rails_integration.feature
+- features/spork_debugger.feature
 - features/steps/general_steps.rb
 - features/steps/rails_steps.rb
 - features/steps/sandbox_steps.rb
+- features/support/background_job.rb
 - features/support/env.rb
 - features/unknown_app_framework.feature
 - lib/spork.rb
@@ -45,6 +47,7 @@ files:
 - lib/spork/app_framework/unknown.rb
 - lib/spork/custom_io_streams.rb
 - lib/spork/diagnoser.rb
+- lib/spork/ext/ruby-debug.rb
 - lib/spork/forker.rb
 - lib/spork/run_strategy.rb
 - lib/spork/run_strategy/forking.rb
@@ -93,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: spork
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: spork