Extract bisect formatter base class.

Also, rename the bisect formatter to indicate it communicates over DRb.

Author: myronmarston

lib/rspec/core/bisect/server.rb

@@ -1,5 +1,6 @@
 require 'drb/drb'
 require 'drb/acl'
+RSpec::Support.require_rspec_core "bisect/utilities"
 
 module RSpec
   module Core
@@ -49,10 +50,10 @@ def drb_port
           @drb_port ||= Integer(@drb.uri[/\d+$/])
         end
 
-        # Fetched via DRb by the BisectFormatter to determine when to abort.
+        # Fetched via DRb by the BisectDRbFormatter to determine when to abort.
         attr_accessor :expected_failures
 
-        # Set via DRb by the BisectFormatter with the results of the run.
+        # Set via DRb by the BisectDRbFormatter with the results of the run.
         attr_accessor :latest_run_results
 
         # Fetched via DRb to tell clients which files to run

lib/rspec/core/bisect/shell_command.rb

@@ -20,7 +20,7 @@ def command_for(locations, server)
           parts << RUBY << load_path
           parts << open3_safe_escape(RSpec::Core.path_to_executable)
 
-          parts << "--format"   << "bisect"
+          parts << "--format"   << "bisect-drb"
           parts << "--drb-port" << server.drb_port
 
           parts.concat(reusable_cli_options)

lib/rspec/core/bisect/utilities.rb

@@ -0,0 +1,8 @@
+module RSpec
+  module Core
+    module Bisect
+      # @private
+      ExampleSetDescriptor = Struct.new(:all_example_ids, :failed_example_ids)
+    end
+  end
+end

lib/rspec/core/formatters.rb

@@ -72,7 +72,7 @@ module RSpec::Core::Formatters
   autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'
   autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'
   autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'
-  autoload :BisectFormatter,          'rspec/core/formatters/bisect_formatter'
+  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'
   autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'
 
   # Register the formatter class
@@ -203,8 +203,8 @@ def built_in_formatter(key)
         ProgressFormatter
       when 'j', 'json'
         JsonFormatter
-      when 'bisect'
-        BisectFormatter
+      when 'bisect-drb'
+        BisectDRbFormatter
       end
     end
 

lib/rspec/core/formatters/base_bisect_formatter.rb

@@ -0,0 +1,45 @@
+RSpec::Support.require_rspec_core "bisect/utilities"
+
+module RSpec
+  module Core
+    module Formatters
+      # Contains common logic for formatters used by `--bisect` to communicate results
+      # back to the bisect runner.
+      #
+      # Subclasses must define a `notify_results(all_example_ids, failed_example_ids)`
+      # method.
+      # @private
+      class BaseBisectFormatter
+        def self.inherited(formatter)
+          Formatters.register formatter, :start_dump, :example_failed, :example_finished
+        end
+
+        def initialize(expected_failures)
+          @all_example_ids = []
+          @failed_example_ids = []
+          @remaining_failures = expected_failures
+        end
+
+        def example_failed(notification)
+          @failed_example_ids << notification.example.id
+        end
+
+        def example_finished(notification)
+          @all_example_ids << notification.example.id
+          return unless @remaining_failures.include?(notification.example.id)
+          @remaining_failures.delete(notification.example.id)
+
+          status = notification.example.execution_result.status
+          return if status == :failed && !@remaining_failures.empty?
+          RSpec.world.wants_to_quit = true
+        end
+
+        def start_dump(_notification)
+          # `notify_results` is defined in the subclass
+          notify_results(Bisect::ExampleSetDescriptor.new(
+            @all_example_ids, @failed_example_ids))
+        end
+      end
+    end
+  end
+end

lib/rspec/core/formatters/bisect_drb_formatter.rb

@@ -0,0 +1,29 @@
+require 'drb/drb'
+RSpec::Support.require_rspec_core "formatters/base_bisect_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # Used by `--bisect`. When it shells out and runs a portion of the suite, it uses
+      # this formatter as a means to have the status reported back to it, via DRb.
+      #
+      # Note that since DRb calls carry considerable overhead compared to normal
+      # method calls, we try to minimize the number of DRb calls for perf reasons,
+      # opting to communicate only at the start and the end of the run, rather than
+      # after each example.
+      # @private
+      class BisectDRbFormatter < BaseBisectFormatter
+        def initialize(_output)
+          drb_uri = "druby://localhost:#{RSpec.configuration.drb_port}"
+          @bisect_server = DRbObject.new_with_uri(drb_uri)
+          RSpec.configuration.files_or_directories_to_run = @bisect_server.files_or_directories_to_run
+          super(Set.new(@bisect_server.expected_failures))
+        end
+
+        def notify_results(results)
+          @bisect_server.latest_run_results = results
+        end
+      end
+    end
+  end
+end

lib/rspec/core/formatters/bisect_formatter.rb

@@ -1,5 +1,4 @@
 require 'rspec/core/bisect/example_minimizer'
-require 'rspec/core/formatters/bisect_formatter'
 require 'rspec/core/bisect/server'
 require 'rspec/core/bisect/shell_command'
 require 'support/fake_bisect_runner'

spec/rspec/core/bisect/example_minimizer_spec.rb

@@ -41,7 +41,7 @@ module RSpec::Core
       end
     end
 
-    context "when used in combination with the BisectFormatter", :slow do
+    context "when used in combination with the BisectDRbFormatter", :slow do
       include FormatterSupport
 
       attr_reader :server
@@ -55,7 +55,7 @@ module RSpec::Core
 
       def run_formatter_specs
         RSpec.configuration.drb_port = server.drb_port
-        run_rspec_with_formatter("bisect")
+        run_rspec_with_formatter("bisect-drb")
       end
 
       it 'receives suite results' do

spec/rspec/core/bisect/server_spec.rb

@@ -1,5 +1,5 @@
 require 'rspec/core/bisect/shell_command'
-require 'rspec/core/formatters/bisect_formatter'
+require 'rspec/core/formatters/bisect_drb_formatter'
 
 module RSpec::Core
   RSpec.describe Bisect::ShellCommand do

spec/rspec/core/bisect/shell_command_spec.rb

@@ -1,6 +1,6 @@
-require 'rspec/core/bisect/shell_runner'
 require 'rspec/core/bisect/shell_command'
-require 'rspec/core/formatters/bisect_formatter'
+require 'rspec/core/bisect/shell_runner'
+require 'rspec/core/bisect/utilities'
 
 module RSpec::Core
   RSpec.describe Bisect::ShellRunner do
@@ -13,7 +13,7 @@ module RSpec::Core
       let(:target_specs) { %w[ spec/1_spec.rb[1:1] spec/1_spec.rb[1:2] ] }
 
       it "passes the failed examples from the original run as the expected failures so the runs can abort early" do
-        original_results = Formatters::BisectFormatter::RunResults.new(
+        original_results = Bisect::ExampleSetDescriptor.new(
           [], %w[ spec/failure_spec.rb[1:1] spec/failure_spec.rb[1:2] ]
         )
 

spec/rspec/core/bisect/shell_runner_spec.rb

@@ -1,7 +1,9 @@
+require 'rspec/core/bisect/utilities'
+
 FakeBisectRunner = Struct.new(:all_ids, :always_failures, :dependent_failures) do
   def original_results
     failures = always_failures | dependent_failures.keys
-    RSpec::Core::Formatters::BisectFormatter::RunResults.new(all_ids, failures.sort)
+    RSpec::Core::Bisect::ExampleSetDescriptor.new(all_ids, failures.sort)
   end
 
   def run(ids)
@@ -10,7 +12,7 @@ def run(ids)
       failures << failing_example if dependency_satisfied?(depends_upon, ids)
     end
 
-    RSpec::Core::Formatters::BisectFormatter::RunResults.new(ids.sort, failures.sort)
+    RSpec::Core::Bisect::ExampleSetDescriptor.new(ids.sort, failures.sort)
   end
 
 private