Add access to batches of tests fetched from the Queue API in RSpec, Minitest, Cucumber

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 7.3.0
+
+* Add access to batches of tests fetched from the Queue API in RSpec, Minitest, Cucumber
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/252
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.2.0...v7.3.0
+
 ### 7.2.0
 
 * Always use the original `Net::HTTP` client, even when WebMock replaces it with its own

lib/knapsack_pro.rb

@@ -9,6 +9,8 @@
 require 'digest'
 require 'securerandom'
 require 'timeout'
+require 'drb/drb'
+require 'forwardable'
 require_relative 'knapsack_pro/urls'
 require_relative 'knapsack_pro/version'
 require_relative 'knapsack_pro/hooks/queue'
@@ -77,6 +79,10 @@
 require_relative 'knapsack_pro/runners/queue/rspec_runner'
 require_relative 'knapsack_pro/runners/queue/cucumber_runner'
 require_relative 'knapsack_pro/runners/queue/minitest_runner'
+require_relative 'knapsack_pro/store/server'
+require_relative 'knapsack_pro/store/client'
+require_relative 'knapsack_pro/store/queue_batch_manager'
+require_relative 'knapsack_pro/store/test_batch'
 require_relative 'knapsack_pro/test_case_detectors/rspec_test_example_detector'
 require_relative 'knapsack_pro/crypto/encryptor'
 require_relative 'knapsack_pro/crypto/branch_encryptor'

lib/knapsack_pro/extensions/rspec_extension.rb

@@ -90,15 +90,20 @@ def knapsack__run_specs(queue_runner)
 
           configuration.reporter.report(_expected_example_count = 0) do |reporter|
             configuration.with_suite_hooks do
-              queue_runner.with_batch do |test_file_paths|
+              queue_runner.with_batch do |test_file_paths, store|
                 knapsack__load_spec_files_batch(test_file_paths)
 
                 examples_passed = ordering_strategy.order(world.example_groups).map do |example_group|
                   queue_runner.handle_signal!
                   example_group.run(reporter)
                 end.all?
 
-                node_examples_passed = false unless examples_passed
+                if examples_passed
+                  store.last_batch_passed!
+                else
+                  store.last_batch_failed!
+                  node_examples_passed = false
+                end
 
                 knapsack__persist_example_statuses
 

lib/knapsack_pro/runners/queue/base_runner.rb

@@ -26,7 +26,9 @@ def initialize(adapter_class)
         def test_file_paths(args)
           can_initialize_queue = args.fetch(:can_initialize_queue)
           executed_test_files = args.fetch(:executed_test_files)
-          allocator.test_file_paths(can_initialize_queue, executed_test_files)
+          test_file_paths = allocator.test_file_paths(can_initialize_queue, executed_test_files)
+          store.add_batch(test_file_paths)
+          test_file_paths
         end
 
         def test_dir
@@ -38,6 +40,10 @@ def test_dir
         attr_reader :allocator_builder,
           :allocator
 
+        def store
+          KnapsackPro::Store::Server.client
+        end
+
         def self.child_status
           $?
         end

lib/knapsack_pro/runners/queue/cucumber_runner.rb

@@ -11,6 +11,8 @@ def self.run(args)
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
           ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
 
+          KnapsackPro::Store::Server.start
+
           adapter_class = KnapsackPro::Adapters::CucumberAdapter
           KnapsackPro::Config::Env.set_test_runner_adapter(adapter_class)
           runner = new(adapter_class)
@@ -68,7 +70,12 @@ def self.run_tests(accumulator)
             node_test_file_paths += test_file_paths
 
             result_exitstatus = cucumber_run(runner, test_file_paths, args)
-            exitstatus = result_exitstatus if result_exitstatus != 0
+            if result_exitstatus == 0
+              store.last_batch_passed!
+            else
+              store.last_batch_failed!
+              exitstatus = result_exitstatus
+            end
 
             # KnapsackPro::Hooks::Queue.call_after_subset_queue
             # KnapsackPro::Report.save_subset_queue_to_file
@@ -111,6 +118,10 @@ def self.cucumber_run(runner, test_file_paths, args)
 
           child_status.exitstatus
         end
+
+        def self.store
+          KnapsackPro::Store::Server.client
+        end
       end
     end
   end

lib/knapsack_pro/runners/queue/minitest_runner.rb

@@ -15,6 +15,8 @@ def self.run(args)
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
           ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
 
+          KnapsackPro::Store::Server.start
+
           adapter_class = KnapsackPro::Adapters::MinitestAdapter
           KnapsackPro::Config::Env.set_test_runner_adapter(adapter_class)
           runner = new(adapter_class)
@@ -79,7 +81,12 @@ def self.run_tests(accumulator)
             node_test_file_paths += test_file_paths
 
             result = minitest_run(runner, test_file_paths, args)
-            exitstatus = 1 unless result
+            if result
+              store.last_batch_passed!
+            else
+              store.last_batch_failed!
+              exitstatus = 1
+            end
 
             KnapsackPro::Hooks::Queue.call_after_subset_queue
 
@@ -116,6 +123,10 @@ def self.minitest_run(runner, test_file_paths, args)
 
           result
         end
+
+        def self.store
+          KnapsackPro::Store::Server.client
+        end
       end
     end
   end

lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -14,6 +14,8 @@ def self.run(args, stream_error = $stderr, stream_out = $stdout)
 
           ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_rspec
 
+          KnapsackPro::Store::Server.start
+
           rspec_pure = KnapsackPro::Pure::Queue::RSpecPure.new
 
           queue_runner = new(KnapsackPro::Adapters::RSpecAdapter, rspec_pure, args, stream_error, stream_out)
@@ -84,7 +86,7 @@ def with_batch
 
             KnapsackPro::Hooks::Queue.call_before_subset_queue
 
-            yield test_file_paths
+            yield test_file_paths, store
 
             KnapsackPro::Hooks::Queue.call_after_subset_queue
 
@@ -101,6 +103,10 @@ def with_batch
           end
         end
 
+        def store
+          KnapsackPro::Store::Server.client
+        end
+
         def handle_signal!
           self.class.handle_signal!
         end

lib/knapsack_pro/store/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Store
+    # Consumers of this class are the gem's users.
+    # Ensure the API is backward compatible when introducing changes.
+    class Client
+      def self.batches
+        client.batches
+      end
+
+      private
+
+      def self.client
+        KnapsackPro::Store::Server.client
+      end
+    end
+  end
+end

lib/knapsack_pro/store/queue_batch_manager.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Store
+    class QueueBatchManager
+      attr_reader :batches
+
+      def initialize
+        @batches = []
+      end
+
+      def add_batch(test_file_paths)
+        return if test_file_paths.empty?
+        @batches << KnapsackPro::Store::TestBatch.new(test_file_paths)
+      end
+
+      def last_batch_passed!
+        @batches.last.send(:passed!)
+      end
+
+      def last_batch_failed!
+        @batches.last.send(:failed!)
+      end
+    end
+  end
+end

lib/knapsack_pro/store/server.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Store
+    class Server
+      extend Forwardable
+
+      def self.start
+        return unless @server_pid.nil?
+
+        assign_available_store_server_uri
+
+        @server_pid = fork do
+          queue = Thread::Queue.new
+
+          Signal.trap("TERM") {
+            queue.push(nil)
+          }
+
+          DRb.start_service(store_server_uri, new)
+          queue.pop
+          DRb.stop_service
+
+          # Wait for the drb server thread to finish before exiting.
+          DRb.thread&.join
+        end
+
+        ::Kernel.at_exit do
+          stop
+        end
+      end
+
+      def self.client
+        return @client unless @client.nil?
+
+        # must be called at least once per process
+        # https://ruby-doc.org/stdlib-2.7.0/libdoc/drb/rdoc/DRb.html
+        DRb.start_service
+
+        @client = DRbObject.new_with_uri(store_server_uri)
+
+        begin
+          retries ||= 0
+          @client.ping
+          @client
+        rescue DRb::DRbConnError
+          wait_seconds = 0.1
+          retries += wait_seconds
+          sleep wait_seconds
+          retry if retries <= 3 # seconds
+          raise
+        end
+      end
+
+      def_delegators :@queue_batch_manager, :add_batch, :last_batch_passed!, :last_batch_failed!, :batches
+
+      def initialize
+        @queue_batch_manager = KnapsackPro::Store::QueueBatchManager.new
+      end
+
+      def ping
+        true
+      end
+
+      private
+
+      def self.stop
+        return if @server_pid.nil?
+        Process.kill('TERM', @server_pid)
+        Process.waitpid2(@server_pid)
+        @server_pid = nil
+      rescue Errno::ESRCH # process does not exist
+        @server_pid = nil
+      end
+
+      def self.set_store_server_uri(uri)
+        ENV['KNAPSACK_PRO_STORE_SERVER_URI'] = uri
+      end
+
+      def self.store_server_uri
+        ENV['KNAPSACK_PRO_STORE_SERVER_URI'] || raise("KNAPSACK_PRO_STORE_SERVER_URI must be set to available DRb port.")
+      end
+
+      # must be set in the main/parent process to make the env var available to the child process
+      def self.assign_available_store_server_uri
+        @assigned_store_server_uri ||=
+          begin
+            find_available_drb_port_for_dummy_service
+            set_store_server_uri(DRb.uri)
+            stop_dummy_service
+            true
+          end
+      end
+
+      def self.find_available_drb_port_for_dummy_service
+        DRb.start_service('druby://localhost:0')
+      end
+
+      def self.stop_dummy_service
+        DRb.stop_service
+      end
+    end
+
+    class TestableServer < Server
+      def self.assign_available_store_server_uri
+        super
+      end
+
+      def self.reset
+        stop
+        set_store_server_uri(nil)
+        @assigned_store_server_uri = nil
+        @client = nil
+      end
+    end
+  end
+end

lib/knapsack_pro/store/test_batch.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  module Store
+    class TestBatch
+      BatchNotExecutedError = Class.new(StandardError)
+
+      attr_reader :test_file_paths
+
+      def initialize(test_file_paths)
+        @test_file_paths = test_file_paths
+        @passed = nil
+      end
+
+      def executed?
+        !@passed.nil?
+      end
+
+      def passed?
+        raise BatchNotExecutedError.new unless executed?
+        return @passed
+      end
+
+      private
+
+      def passed!
+        @passed = true
+      end
+
+      def failed!
+        @passed = false
+      end
+    end
+  end
+end