knapsack_pro 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf60d8383722268ee562e030a1012cf20544e072faf94017bf21e417782cc4a5
-  data.tar.gz: 91f304357d4228bdfda1c43e3387681abfe56fcbf2e75f202df565cbff0f3ec0
+  metadata.gz: ee1c87eca84a9ac30345268d7d2e9ac71d09003098e5173f73c0a3afccfea7bf
+  data.tar.gz: 52d53bd9c42699151ec2ac5ed6d340cbcdd0b632b88f2da60fcae54db3984090
 SHA512:
-  metadata.gz: 533b1f156df0b779e1ebe476ed87a9f3811929ae4a4e271bb2d880f8deda2f0e23da41ae727d5c3d38a3828f50dce5ed99c10af5857d0abdb45a674f6a128bf2
-  data.tar.gz: c3f1f95e7ed656c0347d09650f08b11f3a5987df3e31a54fb3b9cecc0113dd5c5e1181615803f8f938f1402b70ee3ca2649f6db5e64b135590e2e2d10c94b528
+  metadata.gz: 8afa9cc8410a16af780fcc854ebed0f50959eaa8c5cbdbe8fadb67e3822494ef2f18d56ee6158b1503d4db5be129a308e1e7794aab853685163b9888d70f18be
+  data.tar.gz: 4304ce7d54d20e43ed4576989f9700ef68f25a099671cb42a578f27ccb6fcc67dd1d2c7c0c546a96a0af9a570bc5b6c8c6c2d0742c6f1868f7a77557cd50d45f

data/CHANGELOG.md

@@ -1,16 +1,34 @@
-# Change Log
+# Changelog
+
+### 5.0.0
+
+* __(breaking change)__ Use `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true` as default value in Queue Mode and use `false` for proper CI providers
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/198
+
+* Detect CI from environment and get the correct ENVs instead of trying all of them and risk conflicts
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/201
+
+* Set `RAILS_ENV=test` / `RACK_ENV=test` in Queue Mode
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/199
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v4.1.0...v5.0.0
 
 ### 4.1.0
 
 * Add support for CI node retry count on GitHub Actions
 
+    __(breaking change)__ for open-source forked repositories using GitHub Actions. See a fix in PR description:
+
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/197
 
 https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v4.0.0...v4.1.0
 
 ### 4.0.0
 
-* Raise when `KNAPSACK_PRO_CI_NODE_BUILD_ID` is missing
+* __(breaking change)__  Raise when `KNAPSACK_PRO_CI_NODE_BUILD_ID` is missing
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/195
 

data/lib/knapsack_pro/config/ci/app_veyor.rb

@@ -26,6 +26,14 @@ module KnapsackPro
         def project_dir
           ENV['APPVEYOR_BUILD_FOLDER']
         end
+
+        def detected
+          ENV.key?('APPVEYOR') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/base.rb

@@ -25,6 +25,13 @@ module KnapsackPro
 
         def user_seat
         end
+
+        def detected
+        end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/buildkite.rb

@@ -33,6 +33,14 @@ module KnapsackPro
         def user_seat
           ENV['BUILDKITE_BUILD_AUTHOR'] || ENV['BUILDKITE_BUILD_CREATOR']
         end
+
+        def detected
+          ENV.key?('BUILDKITE') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/circle.rb

@@ -29,6 +29,14 @@ module KnapsackPro
         def user_seat
           ENV['CIRCLE_USERNAME'] || ENV['CIRCLE_PR_USERNAME']
         end
+
+        def detected
+          ENV.key?('CIRCLECI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/cirrus_ci.rb

@@ -25,6 +25,14 @@ module KnapsackPro
         def project_dir
           ENV['CIRRUS_WORKING_DIR']
         end
+
+        def detected
+          ENV.key?('CIRRUS_CI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/codefresh.rb

@@ -26,6 +26,14 @@ module KnapsackPro
         def project_dir
           # not provided
         end
+
+        def detected
+          ENV.key?('CF_BUILD_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/codeship.rb

@@ -25,6 +25,14 @@ module KnapsackPro
         def project_dir
           # not provided
         end
+
+        def detected
+          ENV['CI_NAME'] == 'codeship' ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/github_actions.rb

@@ -41,6 +41,14 @@ module KnapsackPro
         def user_seat
           ENV['GITHUB_ACTOR']
         end
+
+        def detected
+          ENV.key?('GITHUB_ACTIONS') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/gitlab_ci.rb

@@ -37,6 +37,14 @@ module KnapsackPro
           ENV['GITLAB_USER_NAME'] || # Gitlab Release 10.0
           ENV['GITLAB_USER_EMAIL'] # Gitlab Release 8.12
         end
+
+        def detected
+          ENV.key?('GITLAB_CI') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/heroku.rb

@@ -25,6 +25,14 @@ module KnapsackPro
         def project_dir
           '/app' if node_build_id
         end
+
+        def detected
+          ENV.key?('HEROKU_TEST_RUN_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/semaphore.rb

@@ -26,6 +26,14 @@ module KnapsackPro
         def project_dir
           ENV['SEMAPHORE_PROJECT_DIR']
         end
+
+        def detected
+          ENV.key?('SEMAPHORE_BUILD_NUMBER') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/semaphore2.rb

@@ -29,6 +29,15 @@ module KnapsackPro
             "#{ENV['HOME']}/#{ENV['SEMAPHORE_GIT_DIR']}"
           end
         end
+
+        def detected
+          # check 2 keys to be sure we are using Semaphore 2.0
+          ENV.key?('SEMAPHORE') && ENV.key?('SEMAPHORE_WORKFLOW_ID') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

data/lib/knapsack_pro/config/ci/travis.rb

@@ -17,6 +17,14 @@ module KnapsackPro
         def project_dir
           ENV['TRAVIS_BUILD_DIR']
         end
+
+        def detected
+          ENV.key?('TRAVIS') ? self.class : nil
+        end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

data/lib/knapsack_pro/config/env.rb

@@ -186,7 +186,16 @@ module KnapsackPro
         end
 
         def fixed_queue_split
-          ENV.fetch('KNAPSACK_PRO_FIXED_QUEUE_SPLIT', false)
+          @fixed_queue_split ||= begin
+            env_name = 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT'
+            computed = ENV.fetch(env_name, ci_env_for(: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}")
+            end
+
+            computed
+          end
         end
 
         def fixed_queue_split?
@@ -246,17 +255,17 @@ module KnapsackPro
         end
 
         def ci_env_for(env_name)
-          value = nil
-          ci_list = KnapsackPro::Config::CI.constants - [:Base, :GitlabCI]
-          # load GitLab CI first to avoid edge case with order of loading envs for CI_NODE_INDEX
-          ci_list = [:GitlabCI] + ci_list
-          ci_list.each do |ci_name|
-            ci_class = Object.const_get("KnapsackPro::Config::CI::#{ci_name}")
-            ci = ci_class.new
-            value = ci.send(env_name)
-            break unless value.nil?
+          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
           end
-          value
+            .compact
+            .first
+
+          detected || KnapsackPro::Config::CI::Base
         end
 
         def log_level

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '4.1.0'
+  VERSION = '5.0.0'
 end

data/lib/tasks/queue/cucumber.rake

@@ -3,6 +3,11 @@ 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]}]'")
+      Kernel.exit($?.exitstatus)
+    end
+
+    task :cucumber_go, [:cucumber_args] do |_, args|
       KnapsackPro::Runners::Queue::CucumberRunner.run(args[:cucumber_args])
     end
   end

data/lib/tasks/queue/minitest.rake

@@ -3,6 +3,11 @@ 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]}]'")
+      Kernel.exit($?.exitstatus)
+    end
+
+    task :minitest_go, [:minitest_args] do |_, args|
       KnapsackPro::Runners::Queue::MinitestRunner.run(args[:minitest_args])
     end
   end

data/lib/tasks/queue/rspec.rake

@@ -3,6 +3,11 @@ 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]}]'")
+      Kernel.exit($?.exitstatus)
+    end
+
+    task :rspec_go, [:rspec_args] do |_, args|
       KnapsackPro::Runners::Queue::RSpecRunner.run(args[:rspec_args])
     end
   end

data/spec/knapsack_pro/config/env_spec.rb

@@ -632,20 +632,6 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.fixed_test_suite_split' do
-    subject { described_class.fixed_test_suite_split }
-
-    context 'when ENV exists' do
-      before { stub_const("ENV", { 'KNAPSACK_PRO_FIXED_TEST_SUITE_SPLIT' => false }) }
-      it { should eq false }
-    end
-
-    context "when ENV doesn't exist" do
-      before { stub_const("ENV", {}) }
-      it { should be true }
-    end
-  end
-
   describe '.fixed_test_suite_split?' do
     subject { described_class.fixed_test_suite_split? }
 
@@ -667,38 +653,94 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.fixed_queue_split' do
-    subject { described_class.fixed_queue_split }
-
-    context 'when ENV exists' do
-      before { stub_const("ENV", { 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => true }) }
-      it { should eq true }
-    end
-
-    context "when ENV doesn't exist" do
-      before { stub_const("ENV", {}) }
-      it { should be false }
-    end
-  end
-
   describe '.fixed_queue_split?' do
     subject { described_class.fixed_queue_split? }
+    after(:each) { described_class.remove_instance_variable(:@fixed_queue_split) }
 
     context 'when ENV exists' do
-      context 'when KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true' do
-        before { stub_const("ENV", { 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'true' }) }
-        it { should be true }
+      context 'when KNAPSACK_PRO_FIXED_QUEUE_SPLIT=false' do
+        [
+          ['AppVeyor', { 'APPVEYOR' => '123' }],
+          ['Buildkite', { 'BUILDKITE' => 'true' }],
+          ['CircleCI', { 'CIRCLECI' => 'true' }],
+          ['Cirrus CI', { 'CIRRUS_CI' => 'true' }],
+          ['Codefresh', { 'CF_BUILD_ID' => '123' }],
+          ['Codeship', { 'CI_NAME' => 'codeship' }],
+          ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }],
+          ['GitLab CI', { 'GITLAB_CI' => 'true' }],
+          ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }],
+          ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }],
+          ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }],
+          ['Travis CI', { 'TRAVIS' => 'true' }],
+          ['Unsupported', {}],
+        ].each do |ci, env|
+          it "on #{ci} it is false" do
+            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' }))
+
+            expect(subject).to eq(false)
+          end
+        end
       end
 
-      context 'when KNAPSACK_PRO_FIXED_QUEUE_SPLIT=false' do
-        before { stub_const("ENV", { 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'false' }) }
-        it { should be false }
+      context 'when KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true' do
+        [
+          ['AppVeyor', { 'APPVEYOR' => '123' }],
+          ['Buildkite', { 'BUILDKITE' => 'true' }],
+          ['CircleCI', { 'CIRCLECI' => 'true' }],
+          ['Cirrus CI', { 'CIRRUS_CI' => 'true' }],
+          ['Codefresh', { 'CF_BUILD_ID' => '123' }],
+          ['Codeship', { 'CI_NAME' => 'codeship' }],
+          ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }],
+          ['GitLab CI', { 'GITLAB_CI' => 'true' }],
+          ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }],
+          ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }],
+          ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }],
+          ['Travis CI', { 'TRAVIS' => 'true' }],
+          ['Unsupported', {}],
+        ].each do |ci, env|
+          it "on #{ci} it is true" do
+            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' }))
+
+            expect(subject).to eq(true)
+          end
+        end
       end
     end
 
     context "when ENV doesn't exist" do
-      before { stub_const("ENV", {}) }
-      it { should be false }
+      [
+        ['AppVeyor', { 'APPVEYOR' => '123' }, false],
+        ['Buildkite', { 'BUILDKITE' => 'true' }, true],
+        ['CircleCI', { 'CIRCLECI' => 'true' }, false],
+        ['Cirrus CI', { 'CIRRUS_CI' => 'true' }, false],
+        ['Codefresh', { 'CF_BUILD_ID' => '123' }, false],
+        ['Codeship', { 'CI_NAME' => 'codeship' }, true],
+        ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }, true],
+        ['GitLab CI', { 'GITLAB_CI' => 'true' }, false],
+        ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }, false],
+        ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }, false],
+        ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }, false],
+        ['Travis CI', { 'TRAVIS' => 'true' }, true],
+        ['Unsupported', {}, true],
+      ].each do |ci, env, expected|
+        it "on #{ci} it is #{expected}" do
+          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
     end
   end
 
@@ -895,57 +937,6 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.ci_env_for' do
-    let(:env_name) { :node_total }
-
-    subject { described_class.ci_env_for(env_name) }
-
-    context 'when CI has no value for env_name method' do
-      before do
-        expect(KnapsackPro::Config::CI::Circle).to receive_message_chain(:new, env_name).and_return(nil)
-        expect(KnapsackPro::Config::CI::Semaphore).to receive_message_chain(:new, env_name).and_return(nil)
-        expect(KnapsackPro::Config::CI::Buildkite).to receive_message_chain(:new, env_name).and_return(nil)
-      end
-
-      it do
-        expect(subject).to be_nil
-      end
-    end
-
-    context 'when CI has value for env_name method' do
-      let(:circle_env) { double(:circle) }
-      let(:semaphore_env) { double(:semaphore) }
-      let(:buildkite_env) { double(:buildkite) }
-
-      before do
-        allow(KnapsackPro::Config::CI::Circle).to receive_message_chain(:new, env_name).and_return(circle_env)
-        allow(KnapsackPro::Config::CI::Semaphore).to receive_message_chain(:new, env_name).and_return(semaphore_env)
-        allow(KnapsackPro::Config::CI::Buildkite).to receive_message_chain(:new, env_name).and_return(buildkite_env)
-      end
-
-      context do
-        let(:buildkite_env) { nil }
-        let(:semaphore_env) { nil }
-
-        it { should eq circle_env }
-      end
-
-      context do
-        let(:circle_env) { nil }
-        let(:buildkite_env) { nil }
-
-        it { should eq semaphore_env }
-      end
-
-      context do
-        let(:circle_env) { nil }
-        let(:semaphore_env) { nil }
-
-        it { should eq buildkite_env }
-      end
-    end
-  end
-
   describe '.log_level' do
     subject { described_class.log_level }
 
@@ -1022,4 +1013,28 @@ describe KnapsackPro::Config::Env do
       expect(described_class.test_runner_adapter).to eql 'RSpecAdapter'
     end
   end
+
+  describe '.detected_ci' do
+    [
+      ['AppVeyor', { 'APPVEYOR' => '123' }, KnapsackPro::Config::CI::AppVeyor],
+      ['Buildkite', { 'BUILDKITE' => 'true' }, KnapsackPro::Config::CI::Buildkite],
+      ['CircleCI', { 'CIRCLECI' => 'true' }, KnapsackPro::Config::CI::Circle],
+      ['Cirrus CI', { 'CIRRUS_CI' => 'true' }, KnapsackPro::Config::CI::CirrusCI],
+      ['Codefresh', { 'CF_BUILD_ID' => '123' }, KnapsackPro::Config::CI::Codefresh],
+      ['Codeship', { 'CI_NAME' => 'codeship' }, KnapsackPro::Config::CI::Codeship],
+      ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }, KnapsackPro::Config::CI::GithubActions],
+      ['GitLab CI', { 'GITLAB_CI' => 'true' }, KnapsackPro::Config::CI::GitlabCI],
+      ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }, KnapsackPro::Config::CI::Heroku],
+      ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }, KnapsackPro::Config::CI::Semaphore],
+      ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }, KnapsackPro::Config::CI::Semaphore2],
+      ['Travis CI', { 'TRAVIS' => 'true' }, KnapsackPro::Config::CI::Travis],
+      ['Unsupported', {}, KnapsackPro::Config::CI::Base],
+    ].each do |ci, env, expected|
+      it "detects #{ci}" do
+        stub_const("ENV", env)
+
+        expect(described_class.detected_ci).to eq(expected)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake