knapsack_pro 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36aaf057fe65e4608728092873edfc63eaa1a667347b9a2b1a2d0d6b816be04b
-  data.tar.gz: 02cf4fd1181eece28c72266525498af71a474b954ab919056121b56a135429df
+  metadata.gz: 965d1d9b1d138cf0db8abe0fb44fc1672d5992d9f40f014c0f1f72c370d82585
+  data.tar.gz: 9570a9c2ffd20d1324451106f7a6144a298b6efb02981eabdc1f354d5c289940
 SHA512:
-  metadata.gz: a6c8bf772b04582dcefb03d31e589930da021e60e43b6bb660b83215920030da0f553f24bb255435ce172a78c37fb80d18cf411f150d5b9cd4c5620ba9be91b1
-  data.tar.gz: b543dc597458ad3e3fcfdf9de61117221832d8d472c96300adc8615ab7b36ab7d98951b5f849cff590a8f3db3e708f41051969f753fcaf9c5de0362ab4a6e85b
+  metadata.gz: e7b335edb2e4107b44b0bf69b7cffdf0af110e316ad3d1f07190d919e23fe7172cae3081c5f97450174f1e0597f9d71387dafd8a0861aca604531a9cb1b1c26c
+  data.tar.gz: 269bc36e25e5a2048f2105f973523bc00dfba73b38ebf7eac482b121a8cd22a129f72c671579bd230830bcb3aa600428d2f7a5a3410ce1515c7ee4353fc36dde

data/.circleci/config.yml

@@ -152,6 +152,12 @@ jobs:
           command: |
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular"
             bundle exec rake knapsack_pro:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # retry the same split ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular"
+            bundle exec rake knapsack_pro:rspec
       - run:
           working_directory: ~/rails-app-with-knapsack_pro
           command: |
@@ -285,6 +291,7 @@ jobs:
           RACK_ENV: test
           KNAPSACK_PRO_ENDPOINT: https://api-staging.knapsackpro.com
           KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: $KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST
+          KNAPSACK_PRO_RSPEC_DISABLED: true
           EXTRA_TEST_FILES_DELAY: 10
       - image: cimg/postgres:14.7
         environment:
@@ -308,6 +315,12 @@ jobs:
           command: |
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular"
             bundle exec rake knapsack_pro:minitest[--verbose]
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # retry the same split ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular"
+            bundle exec rake knapsack_pro:minitest[--verbose]
 
   e2e-queue-minitest:
     parameters:
@@ -325,6 +338,7 @@ jobs:
           RACK_ENV: test
           KNAPSACK_PRO_ENDPOINT: https://api-staging.knapsackpro.com
           KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST: $KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST
+          KNAPSACK_PRO_RSPEC_DISABLED: true
           EXTRA_TEST_FILES_DELAY: 10
       - image: cimg/postgres:14.7
         environment:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+### 7.4.0
+* Warn when `KNAPSACK_PRO_*` environment variables are set manually if their values could be automatically determined from supported CI environments.
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/254
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.3.0...v7.4.0
+
 ### 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`

data/lib/knapsack_pro/config/env.rb

@@ -13,30 +13,21 @@ module KnapsackPro
 
       class << self
         def ci_node_total
-          (ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] ||
-            ci_env_for(:node_total) ||
-            1).to_i
+          (env_for('KNAPSACK_PRO_CI_NODE_TOTAL', :node_total) || 1).to_i
         end
 
         def ci_node_index
-          (ENV['KNAPSACK_PRO_CI_NODE_INDEX'] ||
-            ci_env_for(:node_index) ||
-            0).to_i
+          (env_for('KNAPSACK_PRO_CI_NODE_INDEX', :node_index) || 0).to_i
         end
 
         def ci_node_build_id
           env_name = 'KNAPSACK_PRO_CI_NODE_BUILD_ID'
-          ENV[env_name] ||
-            ci_env_for(:node_build_id) ||
+          env_for(env_name, :node_build_id) ||
             raise("Missing environment variable #{env_name}. Read more at #{KnapsackPro::Urls::KNAPSACK_PRO_CI_NODE_BUILD_ID}")
         end
 
         def ci_node_retry_count
-          (
-            ENV['KNAPSACK_PRO_CI_NODE_RETRY_COUNT'] ||
-            ci_env_for(:node_retry_count) ||
-            0
-          ).to_i
+          (env_for('KNAPSACK_PRO_CI_NODE_RETRY_COUNT', :node_retry_count) || 0).to_i
         end
 
         def max_request_retries
@@ -47,23 +38,19 @@ module KnapsackPro
         end
 
         def commit_hash
-          ENV['KNAPSACK_PRO_COMMIT_HASH'] ||
-            ci_env_for(:commit_hash)
+          env_for('KNAPSACK_PRO_COMMIT_HASH', :commit_hash)
         end
 
         def branch
-          ENV['KNAPSACK_PRO_BRANCH'] ||
-            ci_env_for(:branch)
+          env_for('KNAPSACK_PRO_BRANCH', :branch)
         end
 
         def project_dir
-          ENV['KNAPSACK_PRO_PROJECT_DIR'] ||
-            ci_env_for(:project_dir)
+          env_for('KNAPSACK_PRO_PROJECT_DIR', :project_dir)
         end
 
         def user_seat
-          ENV['KNAPSACK_PRO_USER_SEAT'] ||
-            ci_env_for(:user_seat)
+          env_for('KNAPSACK_PRO_USER_SEAT', :user_seat)
         end
 
         def masked_user_seat
@@ -183,7 +170,7 @@ module KnapsackPro
         def fixed_queue_split
           @fixed_queue_split ||= begin
             env_name = 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT'
-            computed = ENV.fetch(env_name, ci_env_for(:fixed_queue_split)).to_s
+            computed = env_for(env_name, :fixed_queue_split).to_s
 
             if !ENV.key?(env_name)
               KnapsackPro.logger.info("#{env_name} is not set. Using default value: #{computed}. Learn more at #{KnapsackPro::Urls::FIXED_QUEUE_SPLIT}")
@@ -249,10 +236,6 @@ module KnapsackPro
           end
         end
 
-        def ci_env_for(env_name)
-          detected_ci.new.send(env_name)
-        end
-
         def detected_ci
           detected = KnapsackPro::Config::CI.constants.map do |constant|
             Object.const_get("KnapsackPro::Config::CI::#{constant}").new.detected
@@ -293,6 +276,21 @@ module KnapsackPro
         def required_env(env_name)
           ENV[env_name] || raise("Missing environment variable #{env_name}")
         end
+
+        def env_for(knapsack_env_name, ci_env_method)
+          knapsack_env_value = ENV[knapsack_env_name]
+          ci_env_value = ci_env_for(ci_env_method)
+
+          if !knapsack_env_value.nil? && !ci_env_value.nil? && knapsack_env_value != ci_env_value.to_s
+            KnapsackPro.logger.info("You have set the environment variable #{knapsack_env_name} to #{knapsack_env_value} which could be automatically determined from the CI environment as #{ci_env_value}.")
+          end
+
+          knapsack_env_value != nil ? knapsack_env_value : ci_env_value
+        end
+
+        def ci_env_for(env_name)
+          detected_ci.new.send(env_name)
+        end
       end
     end
   end

data/lib/knapsack_pro/version.rb

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

data/spec/knapsack_pro/config/env_spec.rb

@@ -17,6 +17,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 4 }
       end
+
+      context 'when both KNAPSACK_PRO_CI_NODE_TOTAL and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_TOTAL' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:node_total).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '5' }
+          let(:ci_value) { 4 }
+
+          it { should eq 5 }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_CI_NODE_TOTAL to 5 which could be automatically determined from the CI environment as 4.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '5' }
+          let(:ci_value) { 5 }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -41,6 +75,40 @@ describe KnapsackPro::Config::Env do
         it { should eq 2 }
       end
 
+      context 'when both KNAPSACK_PRO_CI_NODE_INDEX and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_INDEX' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:node_index).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '3' }
+          let(:ci_value) { 2 }
+
+          it { should eq 3 }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_CI_NODE_INDEX to 3 which could be automatically determined from the CI environment as 2.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '3' }
+          let(:ci_value) { 3 }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
+
       context 'when order of loading envs does matter' do
         context 'when GitLab CI' do
           before { stub_const("ENV", { 'CI_NODE_INDEX' => '2', 'GITLAB_CI' => 'true' }) }
@@ -70,6 +138,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq '8' }
       end
+
+      context 'when both KNAPSACK_PRO_CI_NODE_BUILD_ID and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_BUILD_ID' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:node_build_id).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '7' }
+          let(:ci_value) { '8' }
+
+          it { should eq '7' }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_CI_NODE_BUILD_ID to 7 which could be automatically determined from the CI environment as 8.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '7' }
+          let(:ci_value) { '7' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV does not exist" do
@@ -95,6 +197,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 2 }
       end
+
+      context 'when both KNAPSACK_PRO_CI_NODE_RETRY_COUNT and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_RETRY_COUNT' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:node_retry_count).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '1' }
+          let(:ci_value) { 2 }
+
+          it { should eq 1 }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_CI_NODE_RETRY_COUNT to 1 which could be automatically determined from the CI environment as 2.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '7' }
+          let(:ci_value) { '7' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -131,6 +267,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 'fe61a08118d0d52e97c38666eba1eaf3' }
       end
+
+      context 'when both KNAPSACK_PRO_COMMIT_HASH and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_COMMIT_HASH' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:commit_hash).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '3fa64859337f6e56409d49f865d13fd7' }
+          let(:ci_value) { 'fe61a08118d0d52e97c38666eba1eaf3' }
+
+          it { should eq '3fa64859337f6e56409d49f865d13fd7' }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_COMMIT_HASH to 3fa64859337f6e56409d49f865d13fd7 which could be automatically determined from the CI environment as fe61a08118d0d52e97c38666eba1eaf3.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '3fa64859337f6e56409d49f865d13fd7' }
+          let(:ci_value) { '3fa64859337f6e56409d49f865d13fd7' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -154,6 +324,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 'feature-branch' }
       end
+
+      context 'when both KNAPSACK_PRO_BRANCH and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_BRANCH' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:branch).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { 'master' }
+          let(:ci_value) { 'feature-branch' }
+
+          it { should eq 'master' }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_BRANCH to master which could be automatically determined from the CI environment as feature-branch.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { 'master' }
+          let(:ci_value) { 'master' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -177,6 +381,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq '/home/runner/myapp' }
       end
+
+      context 'when both KNAPSACK_PRO_PROJECT_DIR and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_PROJECT_DIR' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:project_dir).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { '/home/user/myapp' }
+          let(:ci_value) { '/home/runner/myapp' }
+
+          it { should eq '/home/user/myapp' }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_PROJECT_DIR to /home/user/myapp which could be automatically determined from the CI environment as /home/runner/myapp.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { '/home/user/myapp' }
+          let(:ci_value) { '/home/user/myapp' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -200,6 +438,40 @@ describe KnapsackPro::Config::Env do
 
         it { should eq 'Jane Doe' }
       end
+
+      context 'when both KNAPSACK_PRO_USER_SEAT and CI environment have value' do
+        let(:logger) { instance_double(Logger, info: nil) }
+
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_USER_SEAT' => env_value })
+          expect(described_class).to receive(:ci_env_for).with(:user_seat).and_return(ci_value)
+          allow(KnapsackPro).to receive(:logger).and_return(logger)
+        end
+
+        context 'when values are different' do
+          let(:env_value) { 'John Doe' }
+          let(:ci_value) { 'Jane Doe' }
+
+          it { should eq 'John Doe' }
+
+          it 'logs a warning' do
+            expect(logger).to receive(:info).with(
+              'You have set the environment variable KNAPSACK_PRO_USER_SEAT to John Doe which could be automatically determined from the CI environment as Jane Doe.'
+            )
+            subject
+          end
+        end
+
+        context 'when values are the same' do
+          let(:env_value) { 'John Doe' }
+          let(:ci_value) { 'John Doe' }
+
+          it 'does not log a warning' do
+            expect(logger).not_to receive(:info)
+            subject
+          end
+        end
+      end
     end
 
     context "when ENV doesn't exist" do
@@ -345,7 +617,6 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-
   describe '.regular_mode?' do
     subject { described_class.regular_mode? }
 
@@ -645,11 +916,18 @@ describe KnapsackPro::Config::Env do
           ['Unsupported CI', {}],
         ].each do |ci, env|
           it "on #{ci} it is false" do
+            stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'false' }))
+
             logger = instance_double(Logger)
             allow(KnapsackPro).to receive(:logger).and_return(logger)
-            expect(logger).not_to receive(:info)
-
-            stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'false' }))
+            ci_env = described_class.detected_ci.new.fixed_queue_split
+            if ci_env == false
+              expect(logger).not_to receive(:info)
+            else
+              expect(logger).to receive(:info).with(
+                'You have set the environment variable KNAPSACK_PRO_FIXED_QUEUE_SPLIT to false which could be automatically determined from the CI environment as true.'
+              )
+            end
 
             expect(subject).to eq(false)
           end
@@ -673,11 +951,18 @@ describe KnapsackPro::Config::Env do
           ['Unsupported CI', {}],
         ].each do |ci, env|
           it "on #{ci} it is true" do
+            stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'true' }))
+
             logger = instance_double(Logger)
             allow(KnapsackPro).to receive(:logger).and_return(logger)
-            expect(logger).not_to receive(:info)
-
-            stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'true' }))
+            ci_env = described_class.detected_ci.new.fixed_queue_split
+            if ci_env == true
+              expect(logger).not_to receive(:info)
+            else
+              expect(logger).to receive(:info).with(
+                'You have set the environment variable KNAPSACK_PRO_FIXED_QUEUE_SPLIT to true which could be automatically determined from the CI environment as false.'
+              )
+            end
 
             expect(subject).to eq(true)
           end
@@ -702,12 +987,12 @@ describe KnapsackPro::Config::Env do
         ['Unsupported CI', {}, true],
       ].each do |ci, env, expected|
         it "on #{ci} it is #{expected}" do
+          stub_const("ENV", env)
+
           logger = instance_double(Logger)
           expect(KnapsackPro).to receive(:logger).and_return(logger)
           expect(logger).to receive(:info).with("KNAPSACK_PRO_FIXED_QUEUE_SPLIT is not set. Using default value: #{expected}. Learn more at #{KnapsackPro::Urls::FIXED_QUEUE_SPLIT}")
 
-          stub_const("ENV", env)
-
           expect(subject).to eq(expected)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -415,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel