knapsack_pro 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a97f9fbc29f0a109fbbf35b6a544f2ad86208feb697b7ff81f8458b679843c91
-  data.tar.gz: 434871e67293512331dfe99ed7915eb0f96ae27d2a7b3a1023e8752c752455ac
+  metadata.gz: 534699a91609a71a2621b9625a3ff555a58bf385728be90adce4cfe6d6b771dd
+  data.tar.gz: 913fc4a85433a50f3639bdc087995f9dc5e482b33d7768cfdb84c0f767326c2c
 SHA512:
-  metadata.gz: 3d5be26f0d227707d789b5d7243f3617ea6f839154725b555f0ada89b6600aef0b18aaa2532d018344c797a1f79465e27d3caadebb955d1ca00684b08f1be4ea
-  data.tar.gz: ddb85043aad801bbb9f47f51c36bace0c34b73f958968e821c7b2e8845cc0a302ef05d9e55033d260a86817d4a99d924084f8c29c86b87ce2c2a75fd96fef4af
+  metadata.gz: da5e5ef1c262d97b6214eddff32c8aa2031fe122ad1597a1cf4bd2a939fe82f9fd6b0c7287861f5373521f731318a0e856a331220ae0076eef9cdf8323ab0548
+  data.tar.gz: 2e058c2c3b82c9c97481ab84873c652fb3ab4844521c4746efeaca2dccca8b265b58ba427d44af56b130769bf56c6cbacd84b516b1e6b44d099a8a33b2ef340b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 2.16.0
+
+* Improve test time execution tracking for RSpec
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/145
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.15.0...v2.16.0
+
 ### 2.15.0
 
 * Do not allow to use the RSpec tag option together with the RSpec split by test examples feature

data/README.md

@@ -793,43 +793,7 @@ $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_branch_names[not
 
 If you are using circleci.com you can omit `KNAPSACK_PRO_CI_NODE_TOTAL` and `KNAPSACK_PRO_CI_NODE_INDEX`. Knapsack Pro will use `CIRCLE_NODE_TOTAL` and `CIRCLE_NODE_INDEX` provided by CircleCI.
 
-Here is an example for test configuration in your `circleci.yml` file.
-
-```yaml
-# CircleCI 1.0
-
-machine:
-  environment:
-    # Tokens should be set in CircleCI settings to avoid expose tokens in build logs
-    # KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC: rspec-token
-    # KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER: cucumber-token
-    # KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: minitest-token
-    # KNAPSACK_PRO_TEST_SUITE_TOKEN_TEST_UNIT: test-unit-token
-    # KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH: spinach-token
-test:
-  override:
-    # Step for RSpec
-    - bundle exec rake knapsack_pro:rspec:
-        parallel: true # Caution: there are 8 spaces indentation!
-
-    # Step for Cucumber
-    - bundle exec rake knapsack_pro:cucumber:
-        parallel: true # Caution: there are 8 spaces indentation!
-
-    # Step for Minitest
-    - bundle exec rake knapsack_pro:minitest:
-        parallel: true # Caution: there are 8 spaces indentation!
-
-    # Step for test-unit
-    - bundle exec rake knapsack_pro:test_unit:
-        parallel: true # Caution: there are 8 spaces indentation!
-
-    # Step for Spinach
-    - bundle exec rake knapsack_pro:spinach:
-        parallel: true # Caution: there are 8 spaces indentation!
-```
-
-Here is another example for CircleCI 2.0 platform.
+Here is an example for test configuration in your `.circleci/config.yml` file.
 
 ```yaml
 # CircleCI 2.0
@@ -866,7 +830,7 @@ Please remember to add additional containers for your project in CircleCI settin
 
 ##### CircleCI and knapsack_pro Queue Mode
 
-If you use knapsack_pro Queue Mode with CircleCI you may want to [collect metadata](https://circleci.com/docs/1.0/test-metadata/#metadata-collection-in-custom-test-steps) like junit xml report about your RSpec test suite.
+If you use knapsack_pro Queue Mode with CircleCI you may want to [collect metadata](https://circleci.com/docs/2.0/collect-test-data/#metadata-collection-in-custom-test-steps) like junit xml report about your RSpec test suite.
 
 Here you can read how to configure [junit formatter](https://knapsackpro.com/faq/question/how-to-use-junit-formatter#how-to-use-junit-formatter-with-knapsack_pro-queue-mode). Step for CircleCI is to copy the xml report to `$CIRCLE_TEST_REPORTS` directory. Below is full config for your `spec_helper.rb`:
 
@@ -913,6 +877,8 @@ Ensure you have in CircleCI config yml
     destination: test-results
 ```
 
+You can find a complete CircleCI YML config example in [the article](https://docs.knapsackpro.com/2021/rspec-testing-parallel-jobs-with-circleci-and-junit-xml-report).
+
 #### Info for Travis users
 
 You can parallelize your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -26,6 +26,10 @@ module KnapsackPro
           end
 
           config.around(:each) do |example|
+            # stop timer to update time for a previously run test example
+            # this way we count time spend in runtime for the previous test example after around(:each) is already done
+            KnapsackPro.tracker.stop_timer
+
             current_example_group =
               if ::RSpec.respond_to?(:current_example)
                 ::RSpec.current_example.metadata[:example_group]
@@ -46,6 +50,8 @@ module KnapsackPro
           end
 
           config.append_after(:context) do
+            # after(:context) hook is run one time only, after all of the examples in a group
+            # stop timer to count time for the very last executed test example
             KnapsackPro.tracker.stop_timer
           end
 

data/lib/knapsack_pro/tracker.rb

@@ -19,23 +19,28 @@ module KnapsackPro
     end
 
     def start_timer
+      @start_time ||= now_without_mock_time.to_f
+    end
+
+    def reset_timer
       @start_time = now_without_mock_time.to_f
     end
 
     def stop_timer
       execution_time = @start_time ? now_without_mock_time.to_f - @start_time : 0.0
 
-      if current_test_path
+      if @current_test_path
         update_global_time(execution_time)
         update_test_file_time(execution_time)
-        @current_test_path = nil
+        reset_timer
       end
 
       execution_time
     end
 
     def current_test_path
-      KnapsackPro::TestFileCleaner.clean(@current_test_path) if @current_test_path
+      raise("current_test_path needs to be set by Knapsack Pro Adapter's bind method") unless @current_test_path
+      KnapsackPro::TestFileCleaner.clean(@current_test_path)
     end
 
     def set_prerun_tests(test_file_paths)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.15.0'
+  VERSION = '2.16.0'
 end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -87,16 +87,20 @@ describe KnapsackPro::Adapters::RSpecAdapter do
 
         it 'records time for current test path' do
           expect(config).to receive(:prepend_before).with(:context).and_yield
+
+          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+          expect(tracker).to receive(:start_timer).ordered
+
           expect(config).to receive(:around).with(:each).and_yield(example)
           expect(config).to receive(:append_after).with(:context).and_yield
           expect(config).to receive(:after).with(:suite).and_yield
           expect(::RSpec).to receive(:configure).and_yield(config)
 
+          expect(tracker).to receive(:stop_timer).ordered
+
           expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
           expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-          expect(tracker).to receive(:start_timer).ordered
           expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
           expect(example).to receive(:run)
@@ -127,16 +131,20 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             expect(example).to receive(:id).and_return(test_example_path)
 
             expect(config).to receive(:prepend_before).with(:context).and_yield
+
+            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+            expect(tracker).to receive(:start_timer).ordered
+
             expect(config).to receive(:around).with(:each).and_yield(example)
             expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
             expect(::RSpec).to receive(:configure).and_yield(config)
 
+            expect(tracker).to receive(:stop_timer).ordered
+
             expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
             expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:start_timer).ordered
             expect(tracker).to receive(:current_test_path=).with(test_example_path).ordered
 
             expect(example).to receive(:run)
@@ -158,6 +166,10 @@ describe KnapsackPro::Adapters::RSpecAdapter do
 
           it 'records time for current test path' do
             expect(config).to receive(:prepend_before).with(:context).and_yield
+
+            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+            expect(tracker).to receive(:start_timer).ordered
+
             expect(config).to receive(:around).with(:each).and_yield(example)
             expect(config).to receive(:append_after).with(:context).and_yield
             expect(config).to receive(:after).with(:suite).and_yield
@@ -166,8 +178,8 @@ describe KnapsackPro::Adapters::RSpecAdapter do
             expect(::RSpec).to receive(:current_example).twice.and_return(current_example)
             expect(described_class).to receive(:test_path).with(example_group).and_return(test_path)
 
-            allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-            expect(tracker).to receive(:start_timer).ordered
+            expect(tracker).to receive(:stop_timer).ordered
+
             expect(tracker).to receive(:current_test_path=).with(test_path).ordered
 
             expect(example).to receive(:run)

data/spec/knapsack_pro/tracker_spec.rb

@@ -12,7 +12,9 @@ describe KnapsackPro::Tracker do
     subject { tracker.current_test_path }
 
     context 'when current_test_path not set' do
-      it { expect(subject).to be_nil }
+      it do
+        expect { subject }.to raise_error("current_test_path needs to be set by Knapsack Pro Adapter's bind method")
+      end
     end
 
     context 'when current_test_path set' do
@@ -56,9 +58,6 @@ describe KnapsackPro::Tracker do
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
       it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to be_within(delta).of(0.1) }
       it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0.2) }
-      it 'resets current_test_path after time is measured' do
-        expect(tracker.current_test_path).to be_nil
-      end
       it_behaves_like '#to_a'
     end
 
@@ -84,9 +83,6 @@ describe KnapsackPro::Tracker do
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
       it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to be_within(delta).of(0) }
       it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be_within(delta).of(0) }
-      it 'resets current_test_path after time is measured' do
-        expect(tracker.current_test_path).to be_nil
-      end
       it_behaves_like '#to_a'
     end
 
@@ -99,10 +95,12 @@ describe KnapsackPro::Tracker do
         end
       end
 
-      it { expect(tracker.global_time).to eq 0 }
+      it { expect(tracker.global_time).to be > 0 }
       it { expect(tracker.test_files_with_time.keys.size).to eql 2 }
       it { expect(tracker.test_files_with_time['a_spec.rb'][:time_execution]).to eq 0 }
-      it { expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to eq 0 }
+      it '2nd spec (b_spec.rb) should have recorded time execution - because start_time was set during first call of stop_timer for the first spec (a_spec.rb)' do
+        expect(tracker.test_files_with_time['b_spec.rb'][:time_execution]).to be > 0
+      end
       it_behaves_like '#to_a'
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake