specjour 0.2.0 → 0.2.1

data/.gitignore

@@ -19,3 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+.specjour
+spec/spec.opts

data/History.markdown

@@ -1,8 +1,17 @@
 History
 =======
 
+0.2.1
+-----
+*2010-04-21*
+
+* [added] The rsync daemon configuration file now lives in
+  project_path/.specjour/rsyncd.conf. Edit your rsync exclusions there.
+* [fixed] Don't report connection errors when CTRL-C is sent.
+
 0.2.0
 -----
 *2010-04-20*
 
 * [added] Cucumber support. `rake specjour:cucumber`
+* [added] CPU Core detection, use -w to override with less or more workers

data/README.markdown

@@ -17,7 +17,7 @@ _Distribute your spec suite amongst your LAN via Bonjour._
     gem install specjour
 
 ## Start a manager
-Running `specjour` on the command-line will start a manager which advertises that it's ready to run specs. By default, the manager will only use one worker to run yours specs. If you had 4 cores however, you could use `specjour --workers 4` to run 4 sets of specs at once.
+Running `specjour` on the command-line will start a manager which advertises that it's ready to run specs. By default, the manager will use your system cores to determine the number of workers to use. Two cores equals two workers. If you only want to dedicate 1 core to running specs, use `$ specjour --workers 1`.
 
     $ specjour
 
@@ -57,6 +57,22 @@ You could also listen to multiple projects:
 
     $ specjour --projects bizconf,workbeast # only run specs for the bizconf and workbeast projects
 
+## Customize what gets rsync'd
+The standard rsync configuration file may be too broad for your
+project. If you find you're rsyncing gigs of extraneous data from your public
+directory, add an exclusion to your projects rsyncd.conf file.
+
+    $ vi workbeast/.specjour/rsyncd.conf
+
+## Use one machine
+Distributed testing doesn't have to happen over multiple machines, just multiple processes. Specjour is an excellent candidiate for running 4 tests at once on one machine with 4 cores. Just run `$ specjour` in one window and `$ rake specjour` in another.
+
+## Thanks
+
+* shayarnett - Cucumber support, pairing and other various patches
+* voxdolo - Endless support, alpha testing, various patches
+* leshill - Made rsync daemon configurable
+
 ## Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/specjour/cucumber/final_report.rb

@@ -29,14 +29,12 @@ module Specjour
       end
 
       def scenarios(status=nil)
-        require 'ostruct'
         length = status ? @scenarios[status] : @scenarios.inject(0) {|h,(k,v)| h += v}
         any = @scenarios[status] > 0 if status
         OpenStruct.new(:length => length , :any? => any)
       end
 
       def steps(status=nil)
-        require 'ostruct'
         length = status ? @steps[status] : @steps.inject(0) {|h,(k,v)| h += v}
         any = @steps[status] > 0 if status
         OpenStruct.new(:length => length , :any? => any)

data/lib/specjour/db_scrub.rb

@@ -6,7 +6,7 @@ module Specjour
     def scrub
       connect_to_database
       if pending_migrations?
-        puts "Migrating schema for database #{ENV['TEST_ENV_NUMBER'] || 1}..."
+        puts "Migrating schema for database #{ENV['TEST_ENV_NUMBER']}..."
         Rake::Task['db:test:load'].invoke
       else
         purge_tables

data/lib/specjour/dispatcher.rb

@@ -4,6 +4,11 @@ module Specjour
     Thread.abort_on_exception = true
     include SocketHelpers
 
+    class << self
+      attr_accessor :interrupted
+      alias interrupted? interrupted
+    end
+
     attr_reader :project_path, :managers, :manager_threads, :hosts
     attr_accessor :worker_size
 
@@ -55,7 +60,7 @@ module Specjour
 
     def gather_managers
       puts "Waiting for managers"
-      Signal.trap('INT') { exit }
+      Signal.trap('INT') { self.class.interrupted = true; exit }
       browser = DNSSD::Service.new
       begin
         Timeout.timeout(10) do

data/lib/specjour/printer.rb

@@ -1,4 +1,6 @@
 module Specjour
+  require 'specjour/rspec'
+
   class Printer < GServer
     include Protocol
     RANDOM_PORT = 0
@@ -48,7 +50,8 @@ module Specjour
     def disconnecting(client_port)
       self.disconnections += 1
       if disconnections == worker_size
-        stop
+        shutdown
+        stop unless stopped?
       end
     end
 
@@ -56,6 +59,10 @@ module Specjour
       # noop
     end
 
+    def error(exception)
+      Specjour.logger.debug exception.inspect
+    end
+
     def process(message, client)
       if message.is_a?(String)
         $stdout.print message
@@ -71,11 +78,15 @@ module Specjour
 
     def stopping
       report.summarize
-      if disconnections != completed_workers
-        puts "*" * 63
-        puts "* ERROR: NOT ALL WORKERS COMPLETED PROPERLY, RE-RUN THE SUITE *"
-        puts "*" * 63
+      if disconnections != completed_workers && !Specjour::Dispatcher.interrupted?
+        puts abandoned_worker_message
       end
     end
+
+    def abandoned_worker_message
+      data = "* ERROR: NOT ALL WORKERS COMPLETED PROPERLY *"
+      filler = "*" * data.size
+      [filler, data, filler].join "\n"
+    end
   end
 end

data/lib/specjour/rspec/final_report.rb

@@ -1,7 +1,6 @@
 module Specjour
   module Rspec
     class FinalReport
-      require 'specjour/rspec/marshalable_rspec_failure'
       attr_reader :duration, :example_count, :failure_count, :pending_count, :pending_examples, :failing_examples
 
       def initialize
@@ -38,7 +37,7 @@ module Specjour
 
       def formatter
         @formatter ||= begin
-          f = MarshalableFailureFormatter.new(formatter_options, $stdout)
+          f = Spec::Runner::Formatter::BaseTextFormatter.new(formatter_options, $stdout)
           f.instance_variable_set(:@pending_examples, pending_examples)
           f
         end

data/lib/specjour/rspec/marshalable_rspec_failure.rb

@@ -1,33 +1,35 @@
-module Specjour::Rspec
-  class Spec::Runner::Reporter::Failure
-    attr_reader :backtrace, :message, :header, :exception_class_name
+module Specjour
+  module Rspec
+    class ::Spec::Runner::Reporter::Failure
 
-    def initialize(group_description, example_description, exception)
-      @example_name = "#{group_description} #{example_description}"
-      @message = exception.message
-      @backtrace = exception.backtrace
-      @exception_class_name = exception.class.name
-      @pending_fixed = exception.is_a?(Spec::Example::PendingExampleFixedError)
-      @exception_not_met = exception.is_a?(Spec::Expectations::ExpectationNotMetError)
-      set_header
-    end
+      def initialize(group_description, example_description, exception)
+        @example_name = "#{group_description} #{example_description}"
+        @exception = MarshalableException.new(exception)
+        @pending_fixed = exception.is_a?(Spec::Example::PendingExampleFixedError)
+        @exception_not_met = exception.is_a?(Spec::Expectations::ExpectationNotMetError)
+      end
+
+      def pending_fixed?
+        @pending_fixed
+      end
 
-    def set_header
-      if expectation_not_met?
-        @header = "'#{@example_name}' FAILED"
-      elsif pending_fixed?
-        @header = "'#{@example_name}' FIXED"
-      else
-        @header = "#{exception_class_name} in '#{@example_name}'"
+      def expectation_not_met?
+        @exception_not_met
       end
     end
+  end
+
+  class MarshalableException
+    attr_accessor :message, :backtrace, :class_name
 
-    def pending_fixed?
-      @pending_fixed
+    def initialize(exception)
+      self.class_name = exception.class.name
+      self.message = exception.message
+      self.backtrace = exception.backtrace
     end
 
-    def expectation_not_met?
-      @exception_not_met
+    def class
+      @class ||= OpenStruct.new :name => class_name
     end
   end
 end

data/lib/specjour/rspec.rb

@@ -3,8 +3,7 @@ module Specjour
     require 'spec'
     require 'spec/runner/formatter/base_text_formatter'
 
-    autoload :DistributedFormatter, 'specjour/rspec/distributed_formatter'
-    autoload :FinalReport, 'specjour/rspec/final_report'
-    autoload :MarshalableFailureFormatter, 'specjour/rspec/marshalable_failure_formatter'
+    require 'specjour/rspec/distributed_formatter'
+    require 'specjour/rspec/final_report'
   end
 end

data/lib/specjour/rsync_daemon.rb

@@ -1,20 +1,36 @@
 module Specjour
   class RsyncDaemon
     require 'fileutils'
+    include SocketHelpers
 
     attr_reader :project_path, :project_name
+
     def initialize(project_path, project_name)
       @project_path = project_path
       @project_name = project_name
     end
 
+    def config_directory
+      @config_directory ||= File.join(project_path, ".specjour")
+    end
+
     def config_file
-      File.join("/tmp", "rsyncd.conf")
+      @config_file ||= File.join(config_directory, "rsyncd.conf")
+    end
+
+    def pid
+      if File.exists?(pid_file)
+        File.read(pid_file).strip.to_i
+      end
+    end
+
+    def pid_file
+      File.join(config_directory, "rsync_daemon.pid")
     end
 
     def start
       write_config
-      system("rsync", "--daemon", "--config=#{config_file}", "--port=8989")
+      system *command
       at_exit { stop }
     end
 
@@ -28,32 +44,38 @@ module Specjour
     protected
 
     def write_config
-      File.open(config_file, 'w') do |f|
-        f.write config
-      end
-    end
+      unless File.exists? config_file
+        FileUtils.mkdir_p config_directory
 
-    def pid
-      if File.exists?(pid_file)
-        File.read(pid_file).strip.to_i
+        File.open(config_file, 'w') do |f|
+          f.write config
+        end
       end
     end
 
-    def pid_file
-      File.join("/tmp", "#{project_name}_rsync_daemon.pid")
+    def command
+      ["rsync", "--daemon", "--config=#{config_file}", "--port=8989"]
     end
 
     def config
       <<-CONFIG
-# global configuration
+# #{Specjour::VERSION}
+# Anonymous rsync daemon config for #{project_name}
+#
+# Serve this project with the following command:
+# $ #{command.join(' ')}
+#
+# Rsync with the following command:
+# $ rsync -a --port=8989 #{hostname}::#{project_name} ~/#{project_name}
+#
 use chroot = no
-timeout = 60
+timeout = 20
 read only = yes
 pid file = #{pid_file}
 
 [#{project_name}]
   path = #{project_path}
-  exclude = .git* doc tmp/* log script
+  exclude = .git* .specjour doc tmp/* log script
       CONFIG
     end
   end

data/lib/specjour/worker.rb

@@ -22,28 +22,28 @@ module Specjour
     end
 
     def run
-      printer.send_message(:ready)
+      connection.send_message(:ready)
       run_time = 0
       Dir.chdir(project_path)
-      while !printer.closed? && data = printer.gets(TERMINATOR)
+      while !connection.closed? && data = connection.gets(TERMINATOR)
         test = load_object(data)
         if test
           run_time += Benchmark.realtime do
             run_test test
           end
-          printer.send_message(:ready)
+          connection.send_message(:ready)
         else
-          printer.send_message(:worker_summary=, {:duration => sprintf("%6f", run_time)})
-          printer.send_message(:done)
-          printer.disconnect
+          connection.send_message(:worker_summary=, {:duration => sprintf("%6f", run_time)})
+          connection.send_message(:done)
+          connection.disconnect
         end
       end
     end
 
     protected
 
-    def printer
-      @printer ||= printer_connection
+    def connection
+      @connection ||= printer_connection
     end
 
     def printer_connection
@@ -51,7 +51,7 @@ module Specjour
     end
 
     def run_test(test)
-      puts "Running #{test}"
+      puts "[#{ENV['TEST_ENV_NUMBER']}] Running #{test}"
       if test =~ /\.feature$/
         run_feature test
       else
@@ -61,7 +61,7 @@ module Specjour
 
     def run_feature(feature)
       set_up_cucumber
-      cli = ::Cucumber::Cli::Main.new(['--format', 'Specjour::Cucumber::DistributedFormatter', feature], printer)
+      cli = ::Cucumber::Cli::Main.new(['--format', 'Specjour::Cucumber::DistributedFormatter', feature], connection)
       cli.execute!(::Cucumber::Cli::Main.step_mother)
     end
 
@@ -69,7 +69,7 @@ module Specjour
       options = Spec::Runner::OptionParser.parse(
         ['--format=Specjour::Rspec::DistributedFormatter', spec],
         $stderr,
-        printer
+        connection
       )
       Spec::Runner.use options
       options.run_examples

data/lib/specjour.rb

@@ -13,6 +13,7 @@ module Specjour
   autoload :Connection, 'specjour/connection'
   autoload :Dispatcher, 'specjour/dispatcher'
   autoload :Manager, 'specjour/manager'
+  autoload :OpenStruct, 'ostruct'
   autoload :Printer, 'specjour/printer'
   autoload :Protocol, 'specjour/protocol'
   autoload :RsyncDaemon, 'specjour/rsync_daemon'
@@ -22,7 +23,7 @@ module Specjour
   autoload :Cucumber, 'specjour/cucumber'
   autoload :Rspec, 'specjour/rspec'
 
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 
   class Error < StandardError; end
 

data/spec/rsync_daemon_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Specjour::RsyncDaemon do
+  subject do
+    Specjour::RsyncDaemon.new('/tmp/seasonal', 'seasonal')
+  end
+
+  before do
+    stub(:system)
+    stub(:at_exit)
+    subject.stub(:write_config)
+  end
+
+  describe "#config_directory" do
+    specify { subject.config_directory.should == '/tmp/seasonal/.specjour' }
+  end
+
+  describe "#config_file" do
+    specify { subject.config_file.should == '/tmp/seasonal/.specjour/rsyncd.conf' }
+  end
+
+  describe "#start" do
+    it "writes the config" do
+      subject.should_receive(:write_config)
+      subject.start
+    end
+
+    it "executes the system command" do
+      subject.should_receive(:system).with(*subject.send(:command))
+      subject.start
+    end
+
+    it "stops at_exit" do
+      subject.should_receive(:at_exit)
+      subject.start
+    end
+  end
+
+  describe "#stop" do
+    context "with pid" do
+      before do
+        subject.stub(:pid => 100_000_000)
+        Process.stub(:kill)
+        FileUtils.stub(:rm)
+      end
+
+      it "kills the pid with TERM" do
+        Process.should_receive(:kill).with('TERM', subject.pid)
+        subject.stop
+      end
+
+      it "removes the pid file" do
+        FileUtils.should_receive(:rm).with(subject.pid_file)
+        subject.stop
+      end
+    end
+
+    context "without pid" do
+      it "does nothing" do
+        subject.stub(:pid => nil)
+        subject.stop.should be_nil
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -1,2 +1,2 @@
 --color
---backtrace
+--format specdoc

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Sandro Turriate
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 -04:00
+date: 2010-04-21 00:00:00 -04:00
 default_executable: specjour
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,7 +104,6 @@ files:
 - lib/specjour/rspec.rb
 - lib/specjour/rspec/distributed_formatter.rb
 - lib/specjour/rspec/final_report.rb
-- lib/specjour/rspec/marshalable_failure_formatter.rb
 - lib/specjour/rspec/marshalable_rspec_failure.rb
 - lib/specjour/rsync_daemon.rb
 - lib/specjour/socket_helpers.rb
@@ -113,6 +112,7 @@ files:
 - lib/specjour/worker.rb
 - rails/init.rb
 - spec/lib/specjour/worker_spec.rb
+- spec/rsync_daemon_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/specjour_spec.rb
@@ -148,5 +148,6 @@ specification_version: 3
 summary: Distribute your spec suite amongst your LAN via Bonjour.
 test_files: 
 - spec/lib/specjour/worker_spec.rb
+- spec/rsync_daemon_spec.rb
 - spec/spec_helper.rb
 - spec/specjour_spec.rb

data/lib/specjour/rspec/marshalable_failure_formatter.rb

@@ -1,11 +0,0 @@
-module Specjour::Rspec
-  class MarshalableFailureFormatter < Spec::Runner::Formatter::BaseTextFormatter
-    def dump_failure(counter, failure)
-      @output.puts
-      @output.puts "#{counter.to_s})"
-      @output.puts colorize_failure("#{failure.header}\n#{failure.message}", failure)
-      @output.puts format_backtrace(failure.backtrace)
-      @output.flush
-    end
-  end
-end