pietervisser-spork 0.7.5

data/lib/spork/diagnoser.rb

@@ -0,0 +1,103 @@
+# The Diagnoser hooks into load and require and keeps track of when files are required / loaded, and who loaded them.
+# It's used when you run spork --diagnose
+#
+# = Example
+#  
+#  Spork::Diagnoser.install_hook!('/path/env.rb', '/path')
+#  require '/path/to/env.rb'
+#  Spork::Diagnoser.output_results(STDOUT)
+class Spork::Diagnoser
+  class << self
+    def loaded_files
+      @loaded_files ||= {}
+    end
+    
+    # Installs the diagnoser hook into Kernel#require and Kernel#load
+    #
+    # == Parameters
+    #
+    # * +entry_file+ - The file that is used to load the project.  Used to filter the backtrace so anything that happens after it is hidden.
+    # * +dir+ - The project directory.  Any file loaded outside of this directory will not be logged.
+    def install_hook!(entry_file = nil, dir = Dir.pwd)
+      @dir = File.expand_path(Dir.pwd, dir)
+      @entry_file = entry_file
+      
+      Kernel.class_eval do
+        alias :require_without_diagnoser :require
+        alias :load_without_diagnoser :load
+        
+        def require(string)
+          ::Spork::Diagnoser.add_included_file(string, caller)
+          require_without_diagnoser(string)
+        end
+        
+        def load(string)
+          ::Spork::Diagnoser.add_included_file(string, caller)
+          load_without_diagnoser(string)
+        end
+      end
+    end
+    
+    def add_included_file(filename, callstack)
+      filename = expand_filename(filename)
+      return unless File.exist?(filename)
+      loaded_files[filename] = filter_callstack(caller) if subdirectory?(filename)
+    end
+    
+    # Uninstall the hook. Generally useful only for testing the Diagnoser.
+    def remove_hook!
+      return unless Kernel.private_instance_methods.include?('require_without_diagnoser')
+      Kernel.class_eval do
+        alias :require :require_without_diagnoser
+        alias :load :load_without_diagnoser
+        
+        undef_method(:require_without_diagnoser)
+        undef_method(:load_without_diagnoser)
+      end
+      true
+    end
+    
+    # output the results of a diagnostic run.
+    #
+    # == Parameters
+    #
+    # * +stdout+ - An IO stream to output the results to.
+    def output_results(stdout)
+      project_prefix = Dir.pwd + "/"
+      minimify = lambda { |f| f.gsub(project_prefix, '')}
+      stdout.puts "- Spork Diagnosis -\n"
+      stdout.puts "-- Summary --"
+      stdout.puts loaded_files.keys.sort.map(&minimify)
+      stdout.puts "\n\n\n"
+      stdout.puts "-- Detail --"
+      loaded_files.keys.sort.each do |file|
+        stdout.puts "\n\n\n--- #{minimify.call(file)} ---\n"
+        stdout.puts loaded_files[file].map(&minimify)
+      end
+    end
+    
+    private
+      def filter_callstack(callstack, entry_file = @entry_file)
+        callstack.pop until callstack.empty? || callstack.last.include?(@entry_file) if @entry_file
+        callstack.map do |line|
+          next if line.include?('lib/spork/diagnoser.rb')
+          line.gsub!('require_without_diagnoser', 'require')
+          line
+        end.compact
+      end
+    
+      def expand_filename(filename)
+        ([Dir.pwd] + $:).each do |attempted_path|
+          attempted_filename = File.expand_path(filename, attempted_path)
+          return attempted_filename if File.file?(attempted_filename)
+          attempted_filename = attempted_filename + ".rb"
+          return attempted_filename if File.file?(attempted_filename)
+        end
+        filename
+      end
+    
+      def subdirectory?(directory)
+        File.expand_path(directory, Dir.pwd).include?(@dir)
+      end
+  end
+end

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

@@ -0,0 +1,150 @@
+require 'socket'
+require 'forwardable'
+
+begin
+require 'ruby-debug'
+
+# Experimental!
+
+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
+      Spork.each_run { 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.class} - #{e}"
+      end
+
+      def connect_rdebug_client(port = Debugger::PORT)
+        puts "\n\n - Debug Session Started - \n\n\n"
+        begin
+          Debugger.start_client(SporkDebugger::HOST, port)
+        rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED
+        end
+        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
+      return if @debugger_prepared
+      @debugger_prepared = true
+      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 { SporkDebugger.run } if Spork.using_spork?
+
+rescue LoadError
+  raise LoadError, "Your project has loaded spork/ext/ruby-debug, which relies on the ruby-debug gem. It appears that ruby-debug is not installed. Please install it."
+end

data/lib/spork/forker.rb

@@ -0,0 +1,70 @@
+# A helper class that allows you to run a block inside of a fork, and then get the result from that block.
+#
+# == Example:
+#
+#   forker = Spork::Forker.new do
+#     sleep 3
+#     "success"
+#   end
+#   
+#   forker.result # => "success"
+class Spork::Forker
+  
+  # Raised if the fork died (was killed) before it sent it's response back.
+  class ForkDiedException < Exception; end
+  def initialize(&block)
+    return unless block_given?
+    @child_io, @server_io = UNIXSocket.socketpair
+    @child_pid = Kernel.fork do
+      @server_io.close
+      Marshal.dump(yield, @child_io)
+      # wait for the parent to acknowledge receipt of the result.
+      master_response = 
+        begin
+          Marshal.load(@child_io)
+        rescue EOFError
+          nil
+        end
+      
+      # terminate, skipping any at_exit blocks.
+      exit!(0)
+    end
+    @child_io.close
+  end
+  
+  # Wait for the fork to finish running, and then return its return value.
+  #
+  # If the fork was aborted, then result returns nil.
+  def result
+    return unless running?
+    result_thread = Thread.new do
+      begin
+        @result = Marshal.load(@server_io)
+        Marshal.dump('ACK', @server_io)
+      rescue ForkDiedException, EOFError
+        @result = nil
+      end
+    end
+    Process.wait(@child_pid)
+    result_thread.raise(ForkDiedException) if @result.nil?
+    @child_pid = nil
+    @result
+  end
+  
+  # abort the current running fork
+  def abort
+    if running?
+      Process.kill(Signal.list['TERM'], @child_pid)
+      @child_pid = nil
+      true
+    end
+  end
+  
+  def running?
+    return false unless @child_pid
+    Process.getpgid(@child_pid)
+    true
+  rescue Errno::ESRCH
+    false
+  end
+end

data/lib/spork/run_strategy/forking.rb

@@ -0,0 +1,30 @@
+class Spork::RunStrategy::Forking < Spork::RunStrategy
+  def self.available?
+    Kernel.respond_to?(:fork)
+  end
+
+  def run(argv, stderr, stdout)
+    abort if running?
+
+    @child = ::Spork::Forker.new do
+      $stdout, $stderr = stdout, stderr
+      load test_framework.helper_file
+      Spork.exec_each_run
+      test_framework.run_tests(argv, stderr, stdout)
+    end
+    @child.result
+  end
+
+  def abort
+    @child && @child.abort
+  end
+
+  def preload
+    test_framework.preload
+  end
+
+  def running?
+    @child && @child.running?
+  end
+
+end

data/lib/spork/run_strategy.rb

@@ -0,0 +1,40 @@
+class Spork::RunStrategy
+  attr_reader :test_framework
+  @@run_strategies = []
+
+  def initialize(test_framework)
+    @test_framework = test_framework
+  end
+
+  def preload
+    raise NotImplementedError
+  end
+
+  def run(argv, input, output)
+    raise NotImplementedError
+  end
+
+  def cleanup
+    raise NotImplementedError
+  end
+
+  def running?
+    raise NotImplementedError
+  end
+
+  def abort
+    raise NotImplementedError
+  end
+
+  protected
+    def self.factory(test_framework)
+      Spork::RunStrategy::Forking.new(test_framework)
+    end
+
+    def self.inherited(subclass)
+      @@run_strategies << subclass
+    end
+
+end
+
+Dir[File.dirname(__FILE__) + "/run_strategy/*.rb"].each { |file| require file }

data/lib/spork/runner.rb

@@ -0,0 +1,90 @@
+require 'optparse'
+
+module Spork
+  # This is used by bin/spork. It's wrapped in a class because it's easier to test that way.
+  class Runner
+    attr_reader :test_framework
+    
+    def self.run(args, output, error)
+      self.new(args, output, error).run
+    end
+    
+    def initialize(args, output, error)
+      raise ArgumentError, "expected array of args" unless args.is_a?(Array)
+      @output = output
+      @error = error
+      @options = {}
+      opt = OptionParser.new
+      opt.banner = "Usage: spork [test framework name] [options]\n\n"
+      
+      opt.separator "Options:"
+      opt.on("-b", "--bootstrap")  {|ignore| @options[:bootstrap] = true }
+      opt.on("-d", "--diagnose")  {|ignore| @options[:diagnose] = true }
+      opt.on("-h", "--help")  {|ignore| @options[:help] = true }
+      opt.on("-p", "--port [PORT]") {|port| @options[:port] = port }
+      non_option_args = args.select { |arg| ! args[0].match(/^-/) }
+      @options[:server_matcher] = non_option_args[0]
+      opt.parse!(args)
+      
+      if @options[:help]
+        @output.puts opt
+        @output.puts
+        @output.puts supported_test_frameworks_text
+        exit(0)
+      end
+    end
+    
+    def supported_test_frameworks_text
+      text = StringIO.new
+      
+      text.puts "Supported test frameworks:"
+      text.puts Spork::TestFramework.supported_test_frameworks.sort { |a,b| a.short_name <=> b.short_name }.map { |s| (s.available? ? '(*) ' : '( ) ') + s.short_name }
+      text.puts "\nLegend: ( ) - not detected in project   (*) - detected\n"
+      text.string
+    end
+    
+    # Returns a server for the specified (or the detected default) testing framework.  Returns nil if none detected, or if the specified is not supported or available.
+    def find_test_framework
+      Spork::TestFramework.factory(@output, @error, options[:server_matcher])
+    rescue Spork::TestFramework::NoFrameworksAvailable => e
+      @error.puts e.message
+    rescue Spork::TestFramework::FactoryException => e
+      @error.puts "#{e.message}\n\n#{supported_test_frameworks_text}"
+    end
+    
+    def run
+      return false unless test_framework = find_test_framework
+      ENV["DRB"] = 'true'
+      @error.puts "Using #{test_framework.short_name}"
+      @error.flush
+
+      case
+      when options[:bootstrap]
+        test_framework.bootstrap
+      when options[:diagnose]
+        require 'spork/diagnoser'
+        
+        Spork::Diagnoser.install_hook!(test_framework.entry_point)
+        test_framework.preload
+        Spork::Diagnoser.output_results(@output)
+        return true
+      else
+        Spork.using_spork!
+        run_strategy = Spork::RunStrategy.factory(test_framework)
+        return(false) unless run_strategy.preload
+        Spork::Server.run(:port => @options[:port] || test_framework.default_port, :run_strategy => run_strategy)
+        return true
+      end
+    end
+    
+    private
+    attr_reader :options 
+
+  end
+end
+
+
+
+
+
+

data/lib/spork/server.rb

@@ -0,0 +1,74 @@
+require 'drb/drb'
+require 'rbconfig'
+require 'spork/forker.rb'
+require 'spork/custom_io_streams.rb'
+require 'spork/app_framework.rb'
+
+# An abstract class that is implemented to create a server
+#
+# (This was originally based off of spec_server.rb from rspec-rails (David Chelimsky), which was based on Florian Weber's TDDMate)
+class Spork::Server
+  attr_reader :run_strategy
+  include Spork::CustomIOStreams
+  
+  def initialize(options = {})
+    @run_strategy = options[:run_strategy]
+    @port = options[:port]
+  end
+  
+  def self.run(options = {})
+    new(options).listen
+  end
+  
+  # Sets up signals and starts the DRb service. If it's successful, it doesn't return. Not ever.  You don't need to override this.
+  def listen
+    raise RuntimeError, "you must call Spork.using_spork! before starting the server" unless Spork.using_spork?
+    trap("SIGINT") { sig_int_received }
+    trap("SIGTERM") { abort; exit!(0) }
+    trap("USR2") { abort; restart } if Signal.list.has_key?("USR2")
+    @drb_service = DRb.start_service("druby://127.0.0.1:#{port}", self)
+    Spork.each_run { @drb_service.stop_service }
+    stderr.puts "Spork is ready and listening on #{port}!"
+    stderr.flush
+    DRb.thread.join
+  end
+  
+  attr_accessor :port
+
+  # This is the public facing method that is served up by DRb.  To use it from the client side (in a testing framework):
+  # 
+  #   DRb.start_service("druby://localhost:0") # this allows Ruby to do some magical stuff so you can pass an output stream over DRb.
+  #                                            # see http://redmine.ruby-lang.org/issues/show/496 to see why localhost:0 is used.
+  #   spec_server = DRbObject.new_with_uri("druby://127.0.0.1:8989")
+  #   spec_server.run(options.argv, $stderr, $stdout)
+  #
+  # When implementing a test server, don't override this method: override run_tests instead.
+  def run(argv, stderr, stdout)
+    run_strategy.run(argv, stderr, stdout)
+  end
+  
+  def abort
+    run_strategy.abort
+  end
+
+  private
+    def restart
+      stderr.puts "restarting"
+      stderr.flush
+      config       = ::Config::CONFIG
+      ruby         = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
+      command_line = [ruby, $0, ARGV].flatten.join(' ')
+      exec(command_line)
+    end
+    
+    def sig_int_received
+      stdout.puts "\n"
+      if run_strategy.running?
+        abort
+        stderr.puts "Running tests stopped.  Press CTRL-C again to stop the server."
+        stderr.flush
+      else
+        exit!(0)
+      end
+    end
+end

data/lib/spork/test_framework/cucumber.rb

@@ -0,0 +1,24 @@
+class Spork::TestFramework::Cucumber < Spork::TestFramework
+  DEFAULT_PORT = 8990
+  HELPER_FILE = File.join(Dir.pwd, "features/support/env.rb")
+
+  class << self
+    # REMOVE WHEN SUPPORT FOR 0.3.95 AND EARLIER IS DROPPED
+    attr_accessor :mother_object
+  end
+
+  def preload
+    require 'cucumber'
+    begin
+      @step_mother = ::Cucumber::StepMother.new
+      @step_mother.load_programming_language('rb')
+    rescue NoMethodError => pre_cucumber_0_4 # REMOVE WHEN SUPPORT FOR PRE-0.4 IS DROPPED
+      @step_mother = Spork::Server::Cucumber.mother_object
+    end
+    super
+  end
+
+  def run_tests(argv, stderr, stdout)
+    ::Cucumber::Cli::Main.new(argv, stdout, stderr).execute!(@step_mother)
+  end
+end

data/lib/spork/test_framework/rspec.rb

@@ -0,0 +1,14 @@
+class Spork::TestFramework::RSpec < Spork::TestFramework
+  DEFAULT_PORT = 8989
+  HELPER_FILE = File.join(Dir.pwd, "spec/spec_helper.rb")
+
+  def run_tests(argv, stderr, stdout)
+    ::Spec::Runner::CommandLine.run(
+      ::Spec::Runner::OptionParser.parse(
+        argv,
+        stderr,
+        stdout
+      )
+    )
+  end
+end