knapsack_pro 7.2.0 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fa2cbdcdebace591370260b651732d348da4b27010a0059bd90cb4d193b8486
-  data.tar.gz: fbfd4447d1c74132d48bc29ceb0f3293be0825c5e9dd8e682ab874c53a6b3ab7
+  metadata.gz: 36aaf057fe65e4608728092873edfc63eaa1a667347b9a2b1a2d0d6b816be04b
+  data.tar.gz: 02cf4fd1181eece28c72266525498af71a474b954ab919056121b56a135429df
 SHA512:
-  metadata.gz: a4d0029246717da43f525bc8826b4068c7727731e532278386ef0fc8e6d76e7108ff4f660da88d97e12e531fa8e10e85c6d8626035eb4c15c5fada7ef5318258
-  data.tar.gz: ff749f54cc9ebd40ff0ae3a06e1b4693df88ee4c307d43b59b3c6fc9ef94ff1ba462a110016511ec882f8b54a172c76e0b8e16e8bb549ebc763f245357577da9
+  metadata.gz: a6c8bf772b04582dcefb03d31e589930da021e60e43b6bb660b83215920030da0f553f24bb255435ce172a78c37fb80d18cf411f150d5b9cd4c5620ba9be91b1
+  data.tar.gz: b543dc597458ad3e3fcfdf9de61117221832d8d472c96300adc8615ab7b36ab7d98951b5f849cff590a8f3db3e708f41051969f753fcaf9c5de0362ab4a6e85b

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+### 7.3.0
+
+* [Queue Mode][RSpec] Pass each batch of tests to the queue hooks: `KnapsackPro::Hooks::Queue.before_subset_queue` and `KnapsackPro::Hooks::Queue.after_subset_queue`
+
+  The `KnapsackPro::Hooks::Queue.before_subset_queue` and `KnapsackPro::Hooks::Queue.after_subset_queue` hooks get a 3rd variable - the `queue`.
+
+  The `queue` variable stores an enumerable collection with each batch of tests fetched from the Queue API. The batch has:
+
+  * a list of test file paths (`KnapsackPro::Batch#test_file_paths` returns an array like `['a_spec.rb', 'b_spec.rb']`)
+  * a status of the given set of tests in the batch (`KnapsackPro::Batch#status` returns `:not_executed`, `:passed` or `:failed`)
+
+  Example usage:
+
+  ```ruby
+  # spec_helper.rb
+
+  KnapsackPro::Hooks::Queue.before_subset_queue do |queue_id, subset_queue_id, queue|
+    print "Tests from all batches fetched from the Queue API so far:  "
+    puts queue.map(&:test_file_paths).inspect
+
+    queue.each(&:test_file_paths) # you can use each as well
+
+    print "Current batch tests: "
+    puts queue.current_batch.test_file_paths.inspect
+
+    print "Current batch status: "
+    puts queue.current_batch.status # returns :not_executed in the `before_subset_queue` hook
+  end
+
+  KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id, queue|
+    print "Tests from all batches fetched from the Queue API so far: "
+    puts queue.map(&:test_file_paths).inspect
+
+    print "Current batch tests: "
+    puts queue.current_batch.test_file_paths.inspect
+
+    print "Current batch status: "
+    puts queue.current_batch.status # returns :passed or :failed in the `after_subset_queue` hook
+  end
+  ```
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/253
+
+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
@@ -47,6 +92,25 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.0.0...v7.0.1
     __After:__<br>
     The `before(:suite)` and `after(:suite)` hooks are executed only once: `before(:suite)` is executed before starting tests, `after(:suite)` is executed after all tests are completed. (It is what you would expect from RSpec).
 
+  * It is recommended that you define your `before(:suite)` hooks in `spec_helper.rb` or `rails_helper.rb`. These files should be loaded before any test files so that the hook is registered by RSpec.
+
+    The `before(:suite)` hook is executed first. After that, test files are dynamically loaded in multiple batches from the Knapsack Pro Queue API. __The `before(:suite)` hooks defined in test files won't be executed because it is too late!__
+
+    If you need to have something that is similar to `before(:suite)` and you want to define it in a test file, then you can use this:
+
+    ```ruby
+    RSpec.configure do |config|
+      config.before(:context) do
+        unless ENV['MY_HOOK_NAME']
+          # your code to run in the hook
+        end
+        ENV['MY_HOOK_NAME'] = 'hook_called'
+      end
+    end
+    ```
+
+    Alternatively, if you need to [load code only once for a specific type of specs you can check this](https://docs.knapsackpro.com/ruby/rspec/#load-code-only-once-for-a-specific-type-of-specs).
+
   * The `KnapsackPro::Hooks::Queue.after_queue` hook change:
 
     __Before:__<br>

data/lib/knapsack_pro/batch.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  class Batch
+    attr_reader :test_file_paths, :status
+
+    def initialize(test_file_paths)
+      @test_file_paths = test_file_paths
+      @status = :not_executed
+    end
+
+    def _passed
+      @status = :passed
+    end
+
+    def _failed
+      @status = :failed
+    end
+  end
+end

data/lib/knapsack_pro/extensions/rspec_extension.rb

@@ -90,7 +90,7 @@ module KnapsackPro
 
           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, queue|
                 knapsack__load_spec_files_batch(test_file_paths)
 
                 examples_passed = ordering_strategy.order(world.example_groups).map do |example_group|
@@ -98,7 +98,12 @@ module KnapsackPro
                   example_group.run(reporter)
                 end.all?
 
-                node_examples_passed = false unless examples_passed
+                if examples_passed
+                  queue.mark_batch_passed
+                else
+                  queue.mark_batch_failed
+                  node_examples_passed = false
+                end
 
                 knapsack__persist_example_statuses
 

data/lib/knapsack_pro/hooks/queue.rb

@@ -54,22 +54,25 @@ module KnapsackPro
           end
         end
 
-        def call_before_subset_queue
+        # `queue` is always present for RSpec
+        def call_before_subset_queue(queue = nil)
           return unless before_subset_queue_store
           before_subset_queue_store.each do |block|
             block.call(
               KnapsackPro::Config::Env.queue_id,
-              KnapsackPro::Config::Env.subset_queue_id
+              KnapsackPro::Config::Env.subset_queue_id,
+              queue
             )
           end
         end
 
-        def call_after_subset_queue
+        def call_after_subset_queue(queue = nil)
           return unless after_subset_queue_store
           after_subset_queue_store.each do |block|
             block.call(
               KnapsackPro::Config::Env.queue_id,
-              KnapsackPro::Config::Env.subset_queue_id
+              KnapsackPro::Config::Env.subset_queue_id,
+              queue
             )
           end
         end

data/lib/knapsack_pro/queue.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module KnapsackPro
+  class Queue
+    include Enumerable
+
+    def initialize
+      @batches = []
+    end
+
+    def each(&block)
+      @batches.each(&block)
+    end
+
+    def add_batch_for(test_file_paths)
+      return if test_file_paths.empty?
+      @batches << KnapsackPro::Batch.new(test_file_paths)
+    end
+
+    def mark_batch_passed
+      current_batch._passed
+    end
+
+    def mark_batch_failed
+      current_batch._failed
+    end
+
+    def current_batch
+      @batches.last
+    end
+
+    def size
+      @batches.size
+    end
+
+    def [](index)
+      @batches[index]
+    end
+  end
+end

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -33,6 +33,7 @@ module KnapsackPro
           @stream_out = stream_out
           @node_test_file_paths = []
           @rspec_runner = nil # RSpec::Core::Runner is lazy initialized
+          @queue = KnapsackPro::Queue.new
         end
 
         # Based on:
@@ -82,11 +83,13 @@ module KnapsackPro
             subset_queue_id = KnapsackPro::Config::EnvGenerator.set_subset_queue_id
             ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = subset_queue_id
 
-            KnapsackPro::Hooks::Queue.call_before_subset_queue
+            @queue.add_batch_for(test_file_paths)
 
-            yield test_file_paths
+            KnapsackPro::Hooks::Queue.call_before_subset_queue(@queue)
 
-            KnapsackPro::Hooks::Queue.call_after_subset_queue
+            yield test_file_paths, @queue
+
+            KnapsackPro::Hooks::Queue.call_after_subset_queue(@queue)
 
             if @rspec_runner.knapsack__wants_to_quit?
               KnapsackPro.logger.warn('RSpec wants to quit.')

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '7.2.0'
+  VERSION = '7.3.0'
 end

data/lib/knapsack_pro.rb

@@ -67,6 +67,8 @@ require_relative 'knapsack_pro/test_files_with_test_cases_composer'
 require_relative 'knapsack_pro/base_allocator_builder'
 require_relative 'knapsack_pro/allocator_builder'
 require_relative 'knapsack_pro/queue_allocator_builder'
+require_relative 'knapsack_pro/batch'
+require_relative 'knapsack_pro/queue'
 require_relative 'knapsack_pro/runners/base_runner'
 require_relative 'knapsack_pro/runners/rspec_runner'
 require_relative 'knapsack_pro/runners/cucumber_runner'

data/spec/integration/runners/queue/rspec_runner_spec.rb

@@ -739,6 +739,139 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
       expect(actual.exit_code).to eq 0
     end
+
+    it 'gives access to batch of tests in queue hooks' do
+      rspec_options = ''
+
+      spec_helper = <<~SPEC
+      require 'knapsack_pro'
+      KnapsackPro::Adapters::RSpecAdapter.bind
+
+      KnapsackPro::Hooks::Queue.before_subset_queue do |queue_id, subset_queue_id, queue|
+        print "Tests in batches in before_subset_queue: "
+        puts queue.map(&:test_file_paths).inspect
+
+        print "Batches' statuses in before_subset_queue: "
+        puts queue.map(&:status).inspect
+      end
+
+      KnapsackPro::Hooks::Queue.after_subset_queue do |queue_id, subset_queue_id, queue|
+        print "Tests in batches in after_subset_queue: "
+        puts queue.map(&:test_file_paths).inspect
+        print "Batches' statuses in after_subset_queue: "
+        puts queue.map(&:status).inspect
+
+        # call public API methods that must be backward compatible
+        print "Current batch tests: "
+        puts queue.current_batch.test_file_paths.inspect
+        print "Current batch status: "
+        puts queue.current_batch.status
+      end
+      SPEC
+
+      spec_a = Spec.new('a_spec.rb', <<~SPEC)
+        describe 'A_describe' do
+          it 'A1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      spec_b = Spec.new('b_spec.rb', <<~SPEC)
+        describe 'B_describe' do
+          it 'B1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      spec_c = Spec.new('c_spec.rb', <<~SPEC)
+        describe 'C_describe' do
+          it 'C1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      failing_spec_d = Spec.new('d_spec.rb', <<~SPEC)
+        describe 'D_describe' do
+          it 'D1 test example' do
+            expect(1).to eq 0
+          end
+        end
+      SPEC
+
+      spec_e = Spec.new('e_spec.rb', <<~SPEC)
+        describe 'E_describe' do
+          it 'E1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      spec_f = Spec.new('f_spec.rb', <<~SPEC)
+        describe 'F_describe' do
+          it 'F1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      failing_spec_g = Spec.new('g_spec.rb', <<~SPEC)
+        describe 'G_describe' do
+          it 'G1 test example' do
+            expect(1).to eq 0
+          end
+        end
+      SPEC
+
+      spec_h = Spec.new('h_spec.rb', <<~SPEC)
+        describe 'h_describe' do
+          it 'H1 test example' do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      generate_specs(spec_helper, rspec_options, [
+        [spec_a, spec_b],
+        [spec_c, failing_spec_d],
+        [spec_e, spec_f],
+        [failing_spec_g, spec_h],
+      ])
+
+      actual = subject
+
+      expect(actual.stdout).to include('Tests in batches in before_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in before_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in before_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"], ["spec_integration/e_spec.rb", "spec_integration/f_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in before_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"], ["spec_integration/e_spec.rb", "spec_integration/f_spec.rb"], ["spec_integration/g_spec.rb", "spec_integration/h_spec.rb"]]')
+
+      expect(actual.stdout).to include('Tests in batches in after_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in after_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in after_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"], ["spec_integration/e_spec.rb", "spec_integration/f_spec.rb"]]')
+      expect(actual.stdout).to include('Tests in batches in after_subset_queue: [["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"], ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"], ["spec_integration/e_spec.rb", "spec_integration/f_spec.rb"], ["spec_integration/g_spec.rb", "spec_integration/h_spec.rb"]]')
+
+
+      expect(actual.stdout).to include("Batches' statuses in before_subset_queue: [:not_executed]")
+      expect(actual.stdout).to include("Batches' statuses in before_subset_queue: [:passed, :not_executed]")
+      expect(actual.stdout).to include("Batches' statuses in before_subset_queue: [:passed, :failed, :not_executed]")
+      expect(actual.stdout).to include("Batches' statuses in before_subset_queue: [:passed, :failed, :passed, :not_executed]")
+
+      expect(actual.stdout).to include("Batches' statuses in after_subset_queue: [:passed]")
+      expect(actual.stdout).to include("Batches' statuses in after_subset_queue: [:passed, :failed]")
+      expect(actual.stdout).to include("Batches' statuses in after_subset_queue: [:passed, :failed, :passed]")
+      expect(actual.stdout).to include("Batches' statuses in after_subset_queue: [:passed, :failed, :passed, :failed]")
+
+      expect(actual.stdout).to include('Current batch tests: ["spec_integration/a_spec.rb", "spec_integration/b_spec.rb"]')
+      expect(actual.stdout).to include('Current batch tests: ["spec_integration/c_spec.rb", "spec_integration/d_spec.rb"]')
+      expect(actual.stdout).to include('Current batch tests: ["spec_integration/e_spec.rb", "spec_integration/f_spec.rb"]')
+      expect(actual.stdout).to include('Current batch tests: ["spec_integration/g_spec.rb", "spec_integration/h_spec.rb"]')
+      expect(actual.stdout).to include('Current batch status: passed').twice
+      expect(actual.stdout).to include('Current batch status: failed').twice
+
+      expect(actual.exit_code).to eq 1
+    end
   end
 
   context 'when the RSpec seed is used' do

data/spec/knapsack_pro/hooks/queue_spec.rb

@@ -2,34 +2,32 @@ describe KnapsackPro::Hooks::Queue do
   describe '.call_before_queue' do
     subject { described_class.call_before_queue }
 
-    context 'when callback is not set' do
-      before do
-        described_class.reset_before_queue
-      end
+    before do
+      described_class.reset_before_queue
+    end
 
+    context 'when no callback is set' do
       it { should be_nil }
     end
 
-    context 'when callback is set multiple times' do
+    context 'when multiple callbacks are set' do
       let(:queue_id) { double }
 
-      before do
+      it 'calls each block' do
         expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
 
-        $expected_called_blocks = []
+        expected_called_blocks = []
 
         described_class.before_queue do |q_id|
-          $expected_called_blocks << [:block_1_called, q_id]
+          expected_called_blocks << [:block_1_called, q_id]
         end
         described_class.before_queue do |q_id|
-          $expected_called_blocks << [:block_2_called, q_id]
+          expected_called_blocks << [:block_2_called, q_id]
         end
-      end
 
-      it 'each block is called' do
         subject
 
-        expect($expected_called_blocks).to eq([
+        expect(expected_called_blocks).to eq([
           [:block_1_called, queue_id],
           [:block_2_called, queue_id],
         ])
@@ -40,114 +38,158 @@ describe KnapsackPro::Hooks::Queue do
   describe '.call_before_subset_queue' do
     subject { described_class.call_before_subset_queue }
 
-    context 'when callback is not set' do
-      before do
-        described_class.reset_before_subset_queue
-      end
+    before do
+      described_class.reset_before_subset_queue
+    end
 
+    context 'when no callback is set' do
       it { should be_nil }
     end
 
-    context 'when callback is set multiple times' do
+    context 'when multiple callbacks are set' do
       let(:queue_id) { double }
       let(:subset_queue_id) { double }
 
-      before do
+      it 'calls each block' do
         expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
         expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).twice.and_return(subset_queue_id)
 
-        $expected_called_blocks = []
+        expected_called_blocks = []
 
         described_class.before_subset_queue do |q_id, subset_q_id|
-          $expected_called_blocks << [:block_1_called, q_id, subset_q_id]
+          expected_called_blocks << [:block_1_called, q_id, subset_q_id]
         end
         described_class.before_subset_queue do |q_id, subset_q_id|
-          $expected_called_blocks << [:block_2_called, q_id, subset_q_id]
+          expected_called_blocks << [:block_2_called, q_id, subset_q_id]
         end
-      end
 
-      it 'each block is called' do
         subject
 
-        expect($expected_called_blocks).to eq([
+        expect(expected_called_blocks).to eq([
           [:block_1_called, queue_id, subset_queue_id],
           [:block_2_called, queue_id, subset_queue_id],
         ])
       end
     end
+
+    context 'when a callback is set AND the queue is passed' do
+      let(:queue_id) { double }
+      let(:subset_queue_id) { double }
+      let(:queue) { instance_double(KnapsackPro::Queue) }
+
+      subject { described_class.call_before_subset_queue(queue) }
+
+      it 'calls each block' do
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
+
+        expected_called_blocks = []
+
+        described_class.before_subset_queue do |q_id, subset_q_id, queue|
+          expected_called_blocks << [:block_1_called, q_id, subset_q_id, queue]
+        end
+
+        subject
+
+        expect(expected_called_blocks).to eq([
+          [:block_1_called, queue_id, subset_queue_id, queue],
+        ])
+      end
+    end
   end
 
   describe '.call_after_subset_queue' do
     subject { described_class.call_after_subset_queue }
 
-    context 'when callback is not set' do
-      before do
-        described_class.reset_after_subset_queue
-      end
+    before do
+      described_class.reset_after_subset_queue
+    end
 
+    context 'when no callback is set' do
       it { should be_nil }
     end
 
-    context 'when callback is set multiple times' do
+    context 'when multiple callbacks are set' do
       let(:queue_id) { double }
       let(:subset_queue_id) { double }
 
-      before do
+      it 'calls each block' do
         expect(KnapsackPro::Config::Env).to receive(:queue_id).at_least(:once).and_return(queue_id)
         expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).at_least(:once).and_return(subset_queue_id)
 
-        $expected_called_blocks = []
+        expected_called_blocks = []
 
         described_class.after_subset_queue do |q_id, subset_q_id|
-          $expected_called_blocks << [:block_1_called, q_id, subset_q_id]
+          expected_called_blocks << [:block_1_called, q_id, subset_q_id]
         end
         described_class.after_subset_queue do |q_id, subset_q_id|
-          $expected_called_blocks << [:block_2_called, q_id, subset_q_id]
+          expected_called_blocks << [:block_2_called, q_id, subset_q_id]
         end
-      end
 
-      it 'each block is called' do
         subject
 
-        expect($expected_called_blocks).to eq([
+        expect(expected_called_blocks).to eq([
           [:block_1_called, queue_id, subset_queue_id],
           [:block_2_called, queue_id, subset_queue_id],
         ])
       end
     end
+
+    context 'when a callback is set AND the queue is passed' do
+      let(:queue_id) { double }
+      let(:subset_queue_id) { double }
+      let(:queue) { instance_double(KnapsackPro::Queue) }
+
+      subject { described_class.call_after_subset_queue(queue) }
+
+      it 'calls each block' do
+        expect(KnapsackPro::Config::Env).to receive(:queue_id).and_return(queue_id)
+        expect(KnapsackPro::Config::Env).to receive(:subset_queue_id).and_return(subset_queue_id)
+
+        expected_called_blocks = []
+
+        described_class.after_subset_queue do |q_id, subset_q_id, queue|
+          expected_called_blocks << [:block_1_called, q_id, subset_q_id, queue]
+        end
+
+        subject
+
+        expect(expected_called_blocks).to eq([
+          [:block_1_called, queue_id, subset_queue_id, queue],
+        ])
+      end
+    end
   end
 
   describe '.call_after_queue' do
     subject { described_class.call_after_queue }
 
-    context 'when callback is not set' do
-      before do
-        described_class.reset_after_queue
-      end
+    before do
+      described_class.reset_after_queue
+    end
 
+    context 'when no callback is set' do
       it { should be_nil }
     end
 
-    context 'when callback is set multiple times' do
+    context 'when multiple callbacks are set' do
       let(:queue_id) { double }
 
-      before do
+      it 'calls each block' do
         expect(KnapsackPro::Config::Env).to receive(:queue_id).twice.and_return(queue_id)
 
-        $expected_called_blocks = []
+        expected_called_blocks = []
 
         described_class.after_queue do |q_id|
-          $expected_called_blocks << [:block_1_called, q_id]
+          expected_called_blocks << [:block_1_called, q_id]
         end
         described_class.after_queue do |q_id|
-          $expected_called_blocks << [:block_2_called, q_id]
+          expected_called_blocks << [:block_2_called, q_id]
         end
-      end
 
-      it 'each block is called' do
         subject
 
-        expect($expected_called_blocks).to eq([
+        expect(expected_called_blocks).to eq([
           [:block_1_called, queue_id],
           [:block_2_called, queue_id],
         ])

data/spec/knapsack_pro/queue_spec.rb

@@ -0,0 +1,35 @@
+describe KnapsackPro::Queue do
+  it 'simulates a Queue Mode build' do
+    queue = described_class.new
+
+    expect(queue.current_batch).to be_nil
+
+    # 1st batch
+    test_files_paths_1 = ['a_spec.rb', 'b_spec.rb']
+    queue.add_batch_for(test_files_paths_1)
+
+    expect(queue.current_batch.test_file_paths).to eq(['a_spec.rb', 'b_spec.rb'])
+    expect(queue.current_batch.status).to eq :not_executed
+    queue.mark_batch_passed
+    expect(queue.current_batch.status).to eq :passed
+
+
+    # 2nd batch
+    test_files_paths_2 = ['c_spec.rb', 'd_spec.rb']
+    queue.add_batch_for(test_files_paths_2)
+
+    expect(queue.current_batch.test_file_paths).to eq(['c_spec.rb', 'd_spec.rb'])
+    expect(queue.current_batch.status).to eq :not_executed
+    queue.mark_batch_failed
+    expect(queue.current_batch.status).to eq :failed
+
+
+    # last batch from the Queue API is always empty
+    test_files_paths_3 = []
+    queue.add_batch_for(test_files_paths_3)
+
+    expect(queue.size).to eq 2
+    expect(queue[0].status).to eq :passed
+    expect(queue[1].status).to eq :failed
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.3.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -214,6 +214,7 @@ files:
 - lib/knapsack_pro/allocator.rb
 - lib/knapsack_pro/allocator_builder.rb
 - lib/knapsack_pro/base_allocator_builder.rb
+- lib/knapsack_pro/batch.rb
 - lib/knapsack_pro/build_distribution_fetcher.rb
 - lib/knapsack_pro/client/api/action.rb
 - lib/knapsack_pro/client/api/v1/base.rb
@@ -250,6 +251,7 @@ files:
 - lib/knapsack_pro/mask_string.rb
 - lib/knapsack_pro/presenter.rb
 - lib/knapsack_pro/pure/queue/rspec_pure.rb
+- lib/knapsack_pro/queue.rb
 - lib/knapsack_pro/queue_allocator.rb
 - lib/knapsack_pro/queue_allocator_builder.rb
 - lib/knapsack_pro/railtie.rb
@@ -348,6 +350,7 @@ files:
 - spec/knapsack_pro/pure/queue/rspec_pure_spec.rb
 - spec/knapsack_pro/queue_allocator_builder_spec.rb
 - spec/knapsack_pro/queue_allocator_spec.rb
+- spec/knapsack_pro/queue_spec.rb
 - spec/knapsack_pro/report_spec.rb
 - spec/knapsack_pro/repository_adapter_initiator_spec.rb
 - spec/knapsack_pro/repository_adapters/base_adapter_spec.rb
@@ -412,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
@@ -471,6 +474,7 @@ test_files:
 - spec/knapsack_pro/pure/queue/rspec_pure_spec.rb
 - spec/knapsack_pro/queue_allocator_builder_spec.rb
 - spec/knapsack_pro/queue_allocator_spec.rb
+- spec/knapsack_pro/queue_spec.rb
 - spec/knapsack_pro/report_spec.rb
 - spec/knapsack_pro/repository_adapter_initiator_spec.rb
 - spec/knapsack_pro/repository_adapters/base_adapter_spec.rb