spork 0.9.0.rc8-x86-mingw32

data/lib/spork/forker.rb

@@ -0,0 +1,71 @@
+# 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
+      begin
+        @server_io.close
+        Marshal.dump(yield, @child_io)
+        # wait for the parent to acknowledge receipt of the result.
+        master_response = Marshal.load(@child_io)
+      rescue EOFError
+        nil
+      rescue Exception => e
+        puts "Exception encountered: #{e.inspect}\nbacktrace:\n#{e.backtrace * %(\n)}"
+      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/gem_helpers.rb

@@ -0,0 +1,38 @@
+module Spork::GemHelpers
+  extend self
+
+  class GemPath
+    attr_reader :name, :version, :path, :version_numbers
+    include Comparable
+    def initialize(p)
+      @path = p
+      @name, @version = File.basename(p).scan(/^(.+?)-([^-]+)$/).flatten
+      @version_numbers = @version.split(/[^0-9]+/).map(&:to_i)
+    end
+
+    def <=>(other)
+      raise "Not comparable gem paths ('#{name}' is not '#{other.name}')" unless name == other.name
+      @version_numbers <=> other.version_numbers
+    end
+  end
+
+  def latest_load_paths
+    case
+    when defined?(Bundler)
+      $LOAD_PATH.uniq
+    when Gem.respond_to?(:path)
+      Dir["{#{Gem.path.join(',')}}" + "/gems/*"].inject({}) do |h,f|
+        gem_path = GemPath.new(f)
+        if h[gem_path.name]
+          h[gem_path.name] = gem_path if gem_path > h[gem_path.name]
+        else
+          h[gem_path.name] = gem_path
+        end
+        h
+      end.values.map(&:path)
+    else
+      STDERR.puts "No mechanism available to scan for other gems implementing spork hooks. "
+      []
+    end
+  end
+end

data/lib/spork/run_strategy.rb

@@ -0,0 +1,48 @@
+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 assert_ready!
+    raise NotImplementedError
+  end
+
+  def abort
+    raise NotImplementedError
+  end
+
+  protected
+    def self.factory(test_framework)
+      if RUBY_PLATFORM =~ /mswin|mingw|java/
+        Spork::RunStrategy::Magazine.new(test_framework)
+      else
+        Spork::RunStrategy::Forking.new(test_framework)
+      end
+    end
+
+    def self.inherited(subclass)
+      @@run_strategies << subclass
+    end
+
+end
+
+Dir[File.dirname(__FILE__) + "/run_strategy/*.rb"].each { |file| require file }

data/lib/spork/run_strategy/forking.rb

@@ -0,0 +1,35 @@
+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
+      result = test_framework.run_tests(argv, stderr, stdout)
+      Spork.exec_after_each_run
+      result
+    end
+    @child.result
+  end
+
+  def abort
+    @child && @child.abort
+  end
+
+  def preload
+    test_framework.preload
+  end
+
+  def running?
+    @child && @child.running?
+  end
+
+  def assert_ready!
+    raise RuntimeError, "This process hasn't loaded the environment yet by loading the prefork block" unless Spork.using_spork?
+  end
+end

data/lib/spork/run_strategy/magazine.rb

@@ -0,0 +1,151 @@
+# this class' goal:
+# to boldly just run test after test
+# as they come in
+require 'drb'
+require 'rinda/ring'
+if RUBY_PLATFORM =~ /mswin|mingw/  and RUBY_VERSION < '1.9.1'
+  begin
+    require 'win32/process'
+  rescue LoadError
+    puts "The 'win32-process' gem is required for windows Spork support with ruby 1.9.1 and lower. Install it, or if using bundler, add it to your Gemfile."
+    exit 1
+  end
+end
+
+require 'rubygems' # used for Gem.ruby
+
+$:.unshift(File.dirname(__FILE__))
+require 'magazine/magazine_slave'
+
+class Spork::RunStrategy::Magazine < Spork::RunStrategy
+
+  Slave_Id_Range = 1..2 # Ringserver uses id: 0. Slave use: 1..MAX_SLAVES
+
+  def slave_max
+    Slave_Id_Range.to_a.size
+  end
+
+  def initialize(test_framework)
+    @test_framework = test_framework
+    this_path = File.expand_path(File.dirname(__FILE__))
+    @path = File.join(this_path, 'magazine')
+    @pids = []
+
+    @pids << start_Rinda_ringserver
+    sleep 1
+
+    fill_slave_pool
+  rescue RuntimeError => e
+    kill_all_processes
+    raise e
+  end
+
+  def start_Rinda_ringserver
+    app_name = "#{Gem.ruby} ring_server.rb"
+    spawn_process(app_name)
+  end
+
+  def fill_slave_pool
+    Slave_Id_Range.each do |id|
+      start_slave(id)
+    end
+    puts "  -- Starting to fill pool..."
+    puts "     Wait until at least one slave is provided before running tests..."
+    puts "  ** CTRL+BREAK to stop Spork and kill all ruby slave processes **"
+    $stdout.flush
+  end
+
+  def start_slave(id)
+    app_pwd = Dir.pwd  # path running app in
+    app = "#{Gem.ruby} magazine_slave_provider.rb #{id} '#{app_pwd}' #{@test_framework.short_name}"
+    @pids[id] = spawn_process(app)
+  end
+
+  def spawn_process(app)
+
+    if RUBY_PLATFORM =~ /java/
+      # jruby 1.8 has no easy way to just spawn, so use a thread
+      Dir.chdir(@path) do
+        io = IO.popen app
+        Thread.new { puts io.read }        
+        return io.pid
+      end
+    end
+    
+    if RUBY_VERSION < '1.9.1'
+      Process.create( :app_name => app, :cwd => @path ).process_id
+    else
+      Process.spawn( app, :chdir => @path )
+    end
+  end
+
+  def self.available?
+    true
+  end
+
+  def run(argv, stderr, stdout)
+        DRb.start_service
+        ts = Rinda::RingFinger.primary
+        if ts.read_all([:name, :MagazineSlave, nil, nil]).size > 0
+          print '  <-- take tuple'; stdout.flush
+          tuple = ts.take([:name, :MagazineSlave, nil, nil])
+          slave = tuple[2]
+          id = tuple[3]
+
+          puts "(#{slave.id_num}); slave.run..."; $stdout.flush
+          begin
+            slave.run(argv,stderr,stdout)
+            puts "   -- (#{slave.id_num});run done"; $stdout.flush
+          ensure
+            restart_slave(id)
+          end
+        else
+          puts '- NO tuple'; $stdout.flush
+        end
+  end
+
+  def restart_slave(id)
+    pid   = @pids[id]
+    Process.kill(9, pid)
+    start_slave(id)
+  end
+
+  def windows?
+    ENV['OS'] == 'Windows_NT'
+  end
+  
+  def kill_all_processes
+
+    @pids.each {|pid| 
+      if windows?
+        system("taskkill /f /pid #{pid}")
+      else
+        Process.kill(9, pid)
+      end
+    }
+    puts "\nKilling processes."; $stdout.flush
+  end
+
+  def slave_count
+    DRb.start_service
+    ts = Rinda::RingFinger.primary
+    ts.read_all([:name, :MagazineSlave, nil, nil]).size
+  end
+
+
+  def abort
+    kill_all_processes
+  end
+
+  def preload
+    true
+    #    @test_framework.preload
+  end
+
+  def running?
+    @running
+  end
+
+  def assert_ready!
+  end
+end

data/lib/spork/run_strategy/magazine/magazine_slave.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'drb'
+$:.unshift(File.dirname(__FILE__) + "/../../..")  # directory of spork.rb
+require 'spork'
+
+class MagazineSlave
+  include DRb::DRbUndumped
+  attr_reader :id_num
+  def initialize(id_num, test_framework_short_name)
+    @id_num = id_num
+    @test_framework = Spork::TestFramework.factory(STDOUT, STDERR,
+                                                   test_framework_short_name)
+#    ENV["DRB"] = 'true'
+#    Spork.using_spork!
+    return(nil) unless preload
+  end
+
+  def run(argv, stderr, stdout)
+    $stdout, $stderr = stdout, stderr
+    Spork.exec_each_run
+    load @test_framework.helper_file
+    @test_framework.run_tests(argv, stderr, stdout)
+    puts "  <-- Slave(#{@id_num}) run done!"; stdout.flush
+  end
+
+  def preload
+    @test_framework.preload
+  end
+
+end

data/lib/spork/run_strategy/magazine/magazine_slave_provider.rb

@@ -0,0 +1,30 @@
+# magazine_slave_provider.rb
+require 'drb'
+require 'rinda/ring'
+require 'rinda/tuplespace'
+require './magazine_slave'
+
+
+
+# pass on
+
+id = ARGV[0].to_i || "?"
+app_pwd = ARGV[1]
+test_framework_short_name = ARGV[2]
+
+# start up the Rinda service
+
+DRb.start_service
+
+Dir.chdir app_pwd
+puts "   -- build slave #{id}..."; $stdout.flush
+magazine_slave = MagazineSlave.new(id, test_framework_short_name )
+
+# never expire, the renewer returns nil, which means expiration of *nix clock
+renewer = Rinda::SimpleRenewer.new(nil)
+Rinda::RingProvider.new(:MagazineSlave, magazine_slave, id, renewer).provide
+
+puts "  --> DRb magazine_slave_service: #{id} provided..."; $stdout.flush
+
+# wait for the DRb service to finish before exiting
+DRb.thread.join

data/lib/spork/run_strategy/magazine/ring_server.rb

@@ -0,0 +1,10 @@
+# ring_server.rb
+require 'rinda/ring'
+require 'rinda/tuplespace'
+
+DRb.start_service
+
+Rinda::RingServer.new(Rinda::TupleSpace.new)
+puts "  -- Rinda Ring Server listening for connections...\n\n"
+$stdout.flush
+DRb.thread.join

data/lib/spork/runner.rb

@@ -0,0 +1,90 @@
+require 'optparse'
+require 'stringio'
+
+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
+        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
+
+
+
+
+
+