knapsack_pro 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290f2d4d36346c2b4d87ccd475600a2fe68b61ed92f0f4c5e3d706321274482c
-  data.tar.gz: c363a381f9b18c4f8c8449cfe0477c7c6b987c6a356865d1fcdb34849168674b
+  metadata.gz: ee1c87eca84a9ac30345268d7d2e9ac71d09003098e5173f73c0a3afccfea7bf
+  data.tar.gz: 52d53bd9c42699151ec2ac5ed6d340cbcdd0b632b88f2da60fcae54db3984090
 SHA512:
-  metadata.gz: cd0e5c7dbe72f032c6eaa0399bef86a944781adaacb894f3165f4b34720c2bf79cbf7f6f4b316c179ea91fd6f344a653e1441fd02d4e6d4d316e432c301374e9
-  data.tar.gz: 8f921a5501043c19f52069c4325062102dab01b0cd3ca89657093e4083fe736e6e1d2962fa6beb3c9d0f657d3d05873a7d261a706ad2531eff9edcb9c7163f00
+  metadata.gz: 8afa9cc8410a16af780fcc854ebed0f50959eaa8c5cbdbe8fadb67e3822494ef2f18d56ee6158b1503d4db5be129a308e1e7794aab853685163b9888d70f18be
+  data.tar.gz: 4304ce7d54d20e43ed4576989f9700ef68f25a099671cb42a578f27ccb6fcc67dd1d2c7c0c546a96a0af9a570bc5b6c8c6c2d0742c6f1868f7a77557cd50d45f

data/CHANGELOG.md

@@ -1,8 +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

@@ -16,6 +16,14 @@ module KnapsackPro
           ENV['GITHUB_RUN_ID']
         end
 
+        def node_retry_count
+          # A unique number for each attempt of a particular workflow run in a repository.
+          # This number begins at 1 for the workflow run's first attempt, and increments with each re-run.
+          run_attempt = ENV['GITHUB_RUN_ATTEMPT']
+          return unless run_attempt
+          run_attempt.to_i - 1
+        end
+
         def commit_hash
           ENV['GITHUB_SHA']
         end
@@ -33,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.0.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/ci/app_veyor_spec.rb

@@ -22,12 +22,12 @@ describe KnapsackPro::Config::CI::AppVeyor do
   describe '#node_build_id' do
     subject { described_class.new.node_build_id }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'APPVEYOR_BUILD_ID' => 123 } }
       it { should eql 123 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -35,12 +35,12 @@ describe KnapsackPro::Config::CI::AppVeyor do
   describe '#commit_hash' do
     subject { described_class.new.commit_hash }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'APPVEYOR_REPO_COMMIT' => '2e13512fc230d6f9ebf4923352718e4d' } }
       it { should eql '2e13512fc230d6f9ebf4923352718e4d' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -48,12 +48,12 @@ describe KnapsackPro::Config::CI::AppVeyor do
   describe '#branch' do
     subject { described_class.new.branch }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'APPVEYOR_REPO_BRANCH' => 'master' } }
       it { should eql 'master' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -61,12 +61,12 @@ describe KnapsackPro::Config::CI::AppVeyor do
   describe '#project_dir' do
     subject { described_class.new.project_dir }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'APPVEYOR_BUILD_FOLDER' => '/path/to/clone/repo' } }
       it { should eql '/path/to/clone/repo' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end

data/spec/knapsack_pro/config/ci/buildkite_spec.rb

@@ -10,12 +10,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#node_total' do
     subject { described_class.new.node_total }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_PARALLEL_JOB_COUNT' => 4 } }
       it { should eql 4 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -23,12 +23,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#node_index' do
     subject { described_class.new.node_index }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_PARALLEL_JOB' => 3 } }
       it { should eql 3 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -36,12 +36,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#node_build_id' do
     subject { described_class.new.node_build_id }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_BUILD_NUMBER' => 1514 } }
       it { should eql 1514 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -49,12 +49,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#node_retry_count' do
     subject { described_class.new.node_retry_count }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_RETRY_COUNT' => '1' } }
       it { should eql '1' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -62,12 +62,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#commit_hash' do
     subject { described_class.new.commit_hash }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_COMMIT' => '3fa64859337f6e56409d49f865d13fd7' } }
       it { should eql '3fa64859337f6e56409d49f865d13fd7' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -75,12 +75,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#branch' do
     subject { described_class.new.branch }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_BRANCH' => 'main' } }
       it { should eql 'main' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -88,12 +88,12 @@ describe KnapsackPro::Config::CI::Buildkite do
   describe '#project_dir' do
     subject { described_class.new.project_dir }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'BUILDKITE_BUILD_CHECKOUT_PATH' => '/home/user/knapsack_pro-ruby' } }
       it { should eql '/home/user/knapsack_pro-ruby' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end

data/spec/knapsack_pro/config/ci/circle_spec.rb

@@ -10,12 +10,12 @@ describe KnapsackPro::Config::CI::Circle do
   describe '#node_total' do
     subject { described_class.new.node_total }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRCLE_NODE_TOTAL' => 4 } }
       it { should eql 4 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -23,12 +23,12 @@ describe KnapsackPro::Config::CI::Circle do
   describe '#node_index' do
     subject { described_class.new.node_index }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRCLE_NODE_INDEX' => 3 } }
       it { should eql 3 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -36,12 +36,12 @@ describe KnapsackPro::Config::CI::Circle do
   describe '#node_build_id' do
     subject { described_class.new.node_build_id }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRCLE_BUILD_NUM' => 123 } }
       it { should eql 123 }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -49,12 +49,12 @@ describe KnapsackPro::Config::CI::Circle do
   describe '#commit_hash' do
     subject { described_class.new.commit_hash }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRCLE_SHA1' => '3fa64859337f6e56409d49f865d13fd7' } }
       it { should eql '3fa64859337f6e56409d49f865d13fd7' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -62,12 +62,12 @@ describe KnapsackPro::Config::CI::Circle do
   describe '#branch' do
     subject { described_class.new.branch }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRCLE_BRANCH' => 'main' } }
       it { should eql 'main' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end
@@ -80,7 +80,7 @@ describe KnapsackPro::Config::CI::Circle do
       it { should eql '~/knapsack_pro-ruby' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end