knapsack_pro 7.5.1 → 7.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0358e24e8030869e858b896df6bbb3188433fcd973e073e773e6f6735b481a
-  data.tar.gz: 33c9a7233e1fc1c14450d3e72eea10568bbab8dd37c90df93db37253db78b8b3
+  metadata.gz: 11356d7eace33ba43c1dec527436091c103ac8b5d6c9bd2ae28851294854d4df
+  data.tar.gz: 15717cbb12d7d9143be84504464ecd32a25841bb984e70ec88ec6b3c05b0dcbe
 SHA512:
-  metadata.gz: 43966d1dc8df454ede86e53226927e43f7d622e7605a04b1eb6331ca33e8e1c5e5ab7ba3e1ed9e9616088bd729cf95baf5aa28503ab36062828869ef5d5a8943
-  data.tar.gz: f1ace143ed62bbbb8d210470990cbf44baeef4473c23d5a303ad28fbf9aa8708ad04c95f920639af588406a7541542c2db8a04db7021c7144a583cc6c120ba41
+  metadata.gz: 5a12e300c1a6a7427836b2a62d71b7ccb35174c31d444ac77fdd19847a7b9b85fc805adb9bd966329d0c7e21e58c233230e63e8943b14bad6b9267236c69ee3a
+  data.tar.gz: 3ac187d311a35d343c5c6fd86c667049642638862d5dff4d68ecff91d63191b05a1206881d24efebd3163d92cbd69e08bd8d0a4b129f69bf45b348dde49662be

data/CHANGELOG.md

@@ -2,9 +2,29 @@
 
 ### UNRELEASED
 
+### 7.6.1
+
+* Add support for the Timecop 0.9.9 gem version so that we could track proper tests' execution time when `Process.clock_gettime` is mocked.
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/262
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.6.0...v7.6.1
+
+### 7.6.0
+
+* Avoid starting an unnecessary process in Queue Mode.
+  * Fix: the terminal is returned to the user correctly (output looks good) when you use CTRL+C
+  * Improvement: the backtrace looks better when something fails (for example, the gem handles an OS signal)
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/260
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.5.1...v7.6.0
+
 ### 7.5.1
 
-Revert to 7.4.0.
+* Revert to 7.4.0.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.5.0...v7.5.1
 
 ### 7.5.0
 
@@ -233,6 +253,34 @@ https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v6.0.4...v7.0.0
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/236
 
+    __(breaking change)__ for SimpleCov and Minitest in Knapsack Pro Queue Mode users.
+
+    Please add the following to your configuration:
+
+    ```ruby
+    KnapsackPro::Hooks::Queue.after_queue do
+      SimpleCov.result.format!
+    end
+    ```
+
+    The full example:
+
+    ```ruby
+    # test/test_helper.rb
+    require 'knapsack_pro'
+    require 'simplecov'
+
+    SimpleCov.start
+
+    KnapsackPro::Hooks::Queue.before_queue do |queue_id|
+      SimpleCov.command_name("minitest_ci_node_#{KnapsackPro::Config::Env.ci_node_index}")
+    end
+
+    KnapsackPro::Hooks::Queue.after_queue do
+      SimpleCov.result.format!
+    end
+    ```
+
 https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v6.0.3...v6.0.4
 
 ### 6.0.3

data/knapsack_pro.gemspec

@@ -38,5 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0'
   spec.add_development_dependency 'vcr', '>= 6.0'
   spec.add_development_dependency 'webmock', '>= 3.13'
-  spec.add_development_dependency 'timecop', '>= 0.9.4'
+  spec.add_development_dependency 'timecop', '>= 0.9.9'
 end

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -145,7 +145,7 @@ module KnapsackPro
       end
 
       def now
-        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        KnapsackPro::Utils.time_now
       end
     end
   end

data/lib/knapsack_pro/tracker.rb

@@ -155,7 +155,7 @@ module KnapsackPro
     end
 
     def now_without_mock_time
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      KnapsackPro::Utils.time_now
     end
   end
 end

data/lib/knapsack_pro/utils.rb

@@ -5,5 +5,13 @@ module KnapsackPro
     def self.unsymbolize(obj)
       JSON.parse(obj.to_json)
     end
+
+    def self.time_now
+      if defined?(Timecop) && Process.respond_to?(:clock_gettime_without_mock)
+        Process.clock_gettime_without_mock(Process::CLOCK_MONOTONIC)
+      else
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
   end
 end

data/lib/knapsack_pro/version.rb

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

data/lib/tasks/queue/cucumber.rake

@@ -5,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :cucumber, [:cucumber_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:cucumber_go[#{args[:cucumber_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:cucumber_go[#{args[:cucumber_args]}]'")
     end
 
     task :cucumber_go, [:cucumber_args] do |_, args|

data/lib/tasks/queue/minitest.rake

@@ -5,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :minitest, [:minitest_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:minitest_go[#{args[:minitest_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:minitest_go[#{args[:minitest_args]}]'")
     end
 
     task :minitest_go, [:minitest_args] do |_, args|

data/lib/tasks/queue/rspec.rake

@@ -5,14 +5,7 @@ require 'knapsack_pro'
 namespace :knapsack_pro do
   namespace :queue do
     task :rspec, [:rspec_args] do |_, args|
-      Kernel.system("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:rspec_go[#{args[:rspec_args]}]'")
-      exitstatus = $?.exitstatus
-      if exitstatus.nil?
-        puts 'Something went wrong. Most likely, the process has been killed. Knapsack Pro has been terminated.'
-        Kernel.exit(1)
-      else
-        Kernel.exit(exitstatus)
-      end
+      Kernel.exec("RAILS_ENV=test RACK_ENV=test #{$PROGRAM_NAME} 'knapsack_pro:queue:rspec_go[#{args[:rspec_args]}]'")
     end
 
     task :rspec_go, [:rspec_args] do |_, args|

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

@@ -18,18 +18,23 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
   # @param spec_batches Array[Array[String]]
   def generate_specs(spec_helper, rspec_options, spec_batches)
     ENV['TEST__RSPEC_OPTIONS'] = rspec_options
+    generate_spec_helper(spec_helper)
+    paths = generate_spec_files(spec_batches.flatten)
+    stub_spec_batches(
+      spec_batches.map { _1.map(&:path) }
+    )
+  end
 
+  def generate_spec_helper(spec_helper)
     spec_helper_path = "#{SPEC_DIRECTORY}/spec_helper.rb"
     File.open(spec_helper_path, 'w') { |file| file.write(spec_helper) }
+  end
 
-    paths = spec_batches.flatten.map do |spec_item|
+  def generate_spec_files(specs)
+    specs.map do |spec_item|
       File.open(spec_item.path, 'w') { |file| file.write(spec_item.content) }
       spec_item.path
     end
-
-    stub_spec_batches(
-      spec_batches.map { _1.map(&:path) }
-    )
   end
 
   def create_rails_helper_file(rails_helper)
@@ -73,8 +78,9 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
     SPEC
   end
 
+  let(:command) { 'ruby spec/integration/runners/queue/rspec_runner.rb' }
+
   subject do
-    command = 'ruby spec/integration/runners/queue/rspec_runner.rb'
     stdout, stderr, status = Open3.capture3(command)
     log_command_result(stdout, stderr, status)
     OpenStruct.new(stdout: stdout, stderr: stderr, exit_code: status.exitstatus)
@@ -2537,4 +2543,28 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
       expect(actual.exit_code).to eq 0
     end
   end
+
+  context 'when rspec is run without knapsack_pro' do
+    let(:spec) { Spec.new('a_spec.rb', <<~SPEC) }
+      require_relative "spec_helper.rb"
+
+      describe 'A_describe' do
+        it 'A1 test example' do
+          expect(1).to eq 1
+        end
+      end
+    SPEC
+
+    let(:command) { "bundle exec rspec #{spec.path}" }
+
+    it 'runs successfully' do
+      generate_spec_helper(spec_helper_with_knapsack)
+      generate_spec_files([spec])
+
+      actual = subject
+
+      expect(actual.stdout).to include('1 example, 0 failures')
+      expect(actual.exit_code).to eq 0
+    end
+  end
 end

data/spec/knapsack_pro/utils_spec.rb

@@ -16,4 +16,40 @@ describe KnapsackPro::Utils do
       ])
     end
   end
+
+  describe '.time_now' do
+    subject { described_class.time_now }
+
+    context 'when Timecop does not mock the time' do
+      it do
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        expect(subject).to be_within(0.001).of(now)
+      end
+    end
+
+    context 'when Timecop does mock the process clock' do
+      around(:example) do |ex|
+        unless Gem::Version.new(Timecop::VERSION) >= Gem::Version.new('0.9.9')
+          raise 'Timecop >= 0.9.9 is required to run this test. Please run: bundle update'
+        end
+
+        if Gem::Version.new(Timecop::VERSION) >= Gem::Version.new('0.9.10')
+          Timecop.mock_process_clock = true
+          ex.run
+          Timecop.mock_process_clock = false
+        else
+          ex.run
+        end
+      end
+
+      it do
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        time = Time.local(2020, 1, 31)
+        Timecop.travel(time) do
+          expect(subject).to be_within(0.001).of(now)
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.5.1
+  version: 7.6.1
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.9.9
 description: Knapsack Pro wraps your current test runner(s) and works with your existing
   CI infrastructure to parallelize tests optimally. It dynamically splits your tests
   based on up-to-date test execution data. It's designed from the ground up for CI
@@ -415,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.5.9
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel