feat: autoconfigure KNAPSACK_PRO_FIXED_QUEUE_SPLIT

KnapsackPro · Jun 7, 2023 · 40076ee · 40076ee
1 parent f7756e8
commit 40076ee
Show file tree

Hide file tree

Showing 16 changed files with 149 additions and 42 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,16 +2,20 @@
 
 ### Unreleased
 
-* Set `RAILS_ENV=test` / `RACK_ENV=test` in Queue Mode
+* __(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/199
-
-### Unreleased
+    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
@@ -24,7 +28,7 @@ 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
 

diff --git a/lib/knapsack_pro/config/ci/app_veyor.rb b/lib/knapsack_pro/config/ci/app_veyor.rb
@@ -30,6 +30,10 @@ def project_dir
         def detected
           ENV.key?('APPVEYOR') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/base.rb b/lib/knapsack_pro/config/ci/base.rb
@@ -28,6 +28,10 @@ def user_seat
 
         def detected
         end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/buildkite.rb b/lib/knapsack_pro/config/ci/buildkite.rb
@@ -37,6 +37,10 @@ def user_seat
         def detected
           ENV.key?('BUILDKITE') ? self.class : nil
         end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/circle.rb b/lib/knapsack_pro/config/ci/circle.rb
@@ -33,6 +33,10 @@ def user_seat
         def detected
           ENV.key?('CIRCLECI') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/cirrus_ci.rb b/lib/knapsack_pro/config/ci/cirrus_ci.rb
@@ -29,6 +29,10 @@ def project_dir
         def detected
           ENV.key?('CIRRUS_CI') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/codefresh.rb b/lib/knapsack_pro/config/ci/codefresh.rb
@@ -30,6 +30,10 @@ def project_dir
         def detected
           ENV.key?('CF_BUILD_ID') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/codeship.rb b/lib/knapsack_pro/config/ci/codeship.rb
@@ -29,6 +29,10 @@ def project_dir
         def detected
           ENV['CI_NAME'] == 'codeship' ? self.class : nil
         end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/github_actions.rb b/lib/knapsack_pro/config/ci/github_actions.rb
@@ -45,6 +45,10 @@ def user_seat
         def detected
           ENV.key?('GITHUB_ACTIONS') ? self.class : nil
         end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/gitlab_ci.rb b/lib/knapsack_pro/config/ci/gitlab_ci.rb
@@ -41,6 +41,10 @@ def user_seat
         def detected
           ENV.key?('GITLAB_CI') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/heroku.rb b/lib/knapsack_pro/config/ci/heroku.rb
@@ -29,6 +29,10 @@ def project_dir
         def detected
           ENV.key?('HEROKU_TEST_RUN_ID') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/semaphore.rb b/lib/knapsack_pro/config/ci/semaphore.rb
@@ -30,6 +30,10 @@ def project_dir
         def detected
           ENV.key?('SEMAPHORE_BUILD_NUMBER') ? self.class : nil
         end
+
+        def fixed_queue_split
+          false
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/ci/semaphore2.rb b/lib/knapsack_pro/config/ci/semaphore2.rb
@@ -34,6 +34,10 @@ 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

diff --git a/lib/knapsack_pro/config/ci/travis.rb b/lib/knapsack_pro/config/ci/travis.rb
@@ -21,6 +21,10 @@ def project_dir
         def detected
           ENV.key?('TRAVIS') ? self.class : nil
         end
+
+        def fixed_queue_split
+          true
+        end
       end
     end
   end

diff --git a/lib/knapsack_pro/config/env.rb b/lib/knapsack_pro/config/env.rb
@@ -186,7 +186,16 @@ def fixed_test_suite_split?
         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?

diff --git a/spec/knapsack_pro/config/env_spec.rb b/spec/knapsack_pro/config/env_spec.rb
@@ -632,20 +632,6 @@
     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 @@
     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
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,6 +30,10 @@ def project_dir @@
             def detected
               ENV.key?('APPVEYOR') ? self.class : nil
             end
+            def fixed_queue_split
+              false
+            end
           end
         end
       end
@@ Expand Down @@