knapsack_pro 3.10.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a557f5e56b1700cf9391abc05a6ce45321dcc2a79812927d1c78dbecf00dd09
-  data.tar.gz: 908a4ac991778a85e3168fb5db8f06d77573a79e182cfed1e48b719037bf68dd
+  metadata.gz: 290f2d4d36346c2b4d87ccd475600a2fe68b61ed92f0f4c5e3d706321274482c
+  data.tar.gz: c363a381f9b18c4f8c8449cfe0477c7c6b987c6a356865d1fcdb34849168674b
 SHA512:
-  metadata.gz: cbba79dc7e72bf2785654ab7cf82d39cfbd34ff44395dd378c24a77ad283c7c7e243f3daf84e99206f439a4535b539dd20cd183454682ba38719cd24e0da7a5b
-  data.tar.gz: e326a929107db8167d023b12c133edada0b849808f0b848e6eb235d5156f588e5bd6a347637fd7e689e844620717f178ca7c7dd395de000e19bc225f423d6666
+  metadata.gz: cd0e5c7dbe72f032c6eaa0399bef86a944781adaacb894f3165f4b34720c2bf79cbf7f6f4b316c179ea91fd6f344a653e1441fd02d4e6d4d316e432c301374e9
+  data.tar.gz: 8f921a5501043c19f52069c4325062102dab01b0cd3ca89657093e4083fe736e6e1d2962fa6beb3c9d0f657d3d05873a7d261a706ad2531eff9edcb9c7163f00

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+### 4.0.0
+
+* Raise when `KNAPSACK_PRO_CI_NODE_BUILD_ID` is missing
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/195
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.11.0...v4.0.0
+
+### 3.11.0
+
+* Send distinguishable user seat info over to the API
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/192
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.10.0...v3.11.0
+
 ### 3.10.0
 
 * Remove Solano CI and Snap CI support because they do not exist anymore

data/lib/knapsack_pro/client/api/v1/build_distributions.rb

@@ -15,6 +15,7 @@ module KnapsackPro
                 :node_total => args.fetch(:node_total),
                 :node_index => args.fetch(:node_index),
                 :ci_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+                :user_seat => KnapsackPro::Config::Env.user_seat_hash,
               }
 
               unless request_hash[:cache_read_attempt]

data/lib/knapsack_pro/client/api/v1/queues.rb

@@ -16,6 +16,7 @@ module KnapsackPro
                 :node_total => args.fetch(:node_total),
                 :node_index => args.fetch(:node_index),
                 :node_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+                :user_seat => KnapsackPro::Config::Env.user_seat_hash,
               }
 
               if request_hash[:can_initialize_queue] && !request_hash[:attempt_connect_to_queue]

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

@@ -22,6 +22,9 @@ module KnapsackPro
 
         def project_dir
         end
+
+        def user_seat
+        end
       end
     end
   end

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

@@ -29,6 +29,10 @@ module KnapsackPro
         def project_dir
           ENV['BUILDKITE_BUILD_CHECKOUT_PATH']
         end
+
+        def user_seat
+          ENV['BUILDKITE_BUILD_AUTHOR'] || ENV['BUILDKITE_BUILD_CREATOR']
+        end
       end
     end
   end

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

@@ -25,6 +25,10 @@ module KnapsackPro
         def project_dir
           ENV['CIRCLE_WORKING_DIRECTORY']
         end
+
+        def user_seat
+          ENV['CIRCLE_USERNAME'] || ENV['CIRCLE_PR_USERNAME']
+        end
       end
     end
   end

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

@@ -29,6 +29,10 @@ module KnapsackPro
         def project_dir
           ENV['GITHUB_WORKSPACE']
         end
+
+        def user_seat
+          ENV['GITHUB_ACTOR']
+        end
       end
     end
   end

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

@@ -16,7 +16,7 @@ module KnapsackPro
 
         def node_build_id
           ENV['CI_PIPELINE_ID'] || # Gitlab Release 9.0+
-          ENV['CI_BUILD_ID']  # Gitlab Release 8.x
+          ENV['CI_BUILD_ID'] # Gitlab Release 8.x
         end
 
         def commit_hash
@@ -32,6 +32,11 @@ module KnapsackPro
         def project_dir
           ENV['CI_PROJECT_DIR']
         end
+
+        def user_seat
+          ENV['GITLAB_USER_NAME'] || # Gitlab Release 10.0
+          ENV['GITLAB_USER_EMAIL'] # Gitlab Release 8.12
+        end
       end
     end
   end

data/lib/knapsack_pro/config/env.rb

@@ -23,9 +23,10 @@ module KnapsackPro
         end
 
         def ci_node_build_id
-          ENV['KNAPSACK_PRO_CI_NODE_BUILD_ID'] ||
+          env_name = 'KNAPSACK_PRO_CI_NODE_BUILD_ID'
+          ENV[env_name] ||
             ci_env_for(:node_build_id) ||
-            'missing-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
@@ -58,6 +59,16 @@ module KnapsackPro
             ci_env_for(:project_dir)
         end
 
+        def user_seat
+          ENV['KNAPSACK_PRO_USER_SEAT'] ||
+            ci_env_for(:user_seat)
+        end
+
+        def user_seat_hash
+          return unless user_seat
+          Digest::SHA2.hexdigest(user_seat)
+        end
+
         def test_file_pattern
           ENV['KNAPSACK_PRO_TEST_FILE_PATTERN']
         end

data/lib/knapsack_pro/urls.rb

@@ -18,6 +18,8 @@ module KnapsackPro
 
     INSTALLATION_GUIDE = "#{HOST}/perma/ruby/installation-guide"
 
+    KNAPSACK_PRO_CI_NODE_BUILD_ID= "#{HOST}/perma/ruby/knapsack-pro-ci-node-build-id"
+
     QUEUE_MODE__CONNECTION_ERROR_WITH_FALLBACK_ENABLED_FALSE = "#{HOST}/perma/ruby/queue-mode-connection-error-with-fallback-enabled-false"
 
     QUEUE_MODE__CONNECTION_ERROR_WITH_FALLBACK_ENABLED_TRUE_AND_POSITIVE_RETRY_COUNT = "#{HOST}/perma/ruby/queue-mode-connection-error-with-fallback-enabled-true-and-positive-retry-count"

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '3.10.0'
+  VERSION = '4.0.0'
 end

data/spec/integration/api/build_distributions_subset_spec.rb

@@ -29,6 +29,7 @@ describe 'Request API /v1/build_distributions/subset' do
     stub_const('ENV', {
       'KNAPSACK_PRO_ENDPOINT' => endpoint,
       'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+      'KNAPSACK_PRO_CI_NODE_BUILD_ID' => 'some-build-id',
     })
   end
 

data/spec/knapsack_pro/client/api/v1/build_distributions_spec.rb

@@ -6,6 +6,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
     let(:node_total) { double }
     let(:node_index) { double }
     let(:ci_build_id) { double }
+    let(:user_seat_hash) { double }
     let(:test_files) { double }
 
     subject do
@@ -22,6 +23,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
     before do
       expect(KnapsackPro::Config::Env).to receive(:fixed_test_suite_split).and_return(fixed_test_suite_split)
       expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(ci_build_id)
+      expect(KnapsackPro::Config::Env).to receive(:user_seat_hash).and_return(user_seat_hash)
     end
 
     context 'when cache_read_attempt=true' do
@@ -40,6 +42,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
             node_total: node_total,
             node_index: node_index,
             ci_build_id: ci_build_id,
+            user_seat: user_seat_hash,
           }
         }).and_return(action)
         expect(subject).to eq action
@@ -62,6 +65,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
             node_total: node_total,
             node_index: node_index,
             ci_build_id: ci_build_id,
+            user_seat: user_seat_hash,
             test_files: test_files
           }
         }).and_return(action)

data/spec/knapsack_pro/client/api/v1/queues_spec.rb

@@ -7,6 +7,7 @@ describe KnapsackPro::Client::API::V1::Queues do
     let(:node_index) { double }
     let(:test_files) { double }
     let(:node_build_id) { double }
+    let(:user_seat_hash) { double }
 
     subject do
       described_class.queue(
@@ -23,6 +24,7 @@ describe KnapsackPro::Client::API::V1::Queues do
     before do
       expect(KnapsackPro::Config::Env).to receive(:fixed_queue_split).and_return(fixed_queue_split)
       expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(node_build_id)
+      expect(KnapsackPro::Config::Env).to receive(:user_seat_hash).and_return(user_seat_hash)
     end
 
     context 'when can_initialize_queue=true and attempt_connect_to_queue=true' do
@@ -43,6 +45,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
+            user_seat: user_seat_hash,
           }
         }).and_return(action)
         expect(subject).to eq action
@@ -67,6 +70,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
+            user_seat: user_seat_hash,
             test_files: test_files
           }
         }).and_return(action)
@@ -92,6 +96,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
+            user_seat: user_seat_hash,
           }
         }).and_return(action)
         expect(subject).to eq action

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

@@ -6,4 +6,5 @@ describe KnapsackPro::Config::CI::Base do
   its(:commit_hash) { should be nil }
   its(:branch) { should be nil }
   its(:project_dir) { should be nil }
+  its(:user_seat) { should be nil }
 end

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

@@ -76,8 +76,8 @@ describe KnapsackPro::Config::CI::Buildkite do
     subject { described_class.new.branch }
 
     context 'when environment exists' do
-      let(:env) { { 'BUILDKITE_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'BUILDKITE_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when environment doesn't exist" do
@@ -97,4 +97,39 @@ describe KnapsackPro::Config::CI::Buildkite do
       it { should be nil }
     end
   end
+
+  describe '#user_seat' do
+    subject { described_class.new.user_seat }
+
+    context 'when the BUILDKITE_BUILD_AUTHOR env var exists' do
+      let(:env) do
+        { 'BUILDKITE_BUILD_AUTHOR' => 'Jane Doe',
+          'BUILDKITE_BUILD_CREATOR' => nil }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context 'when the BUILDKITE_BUILD_CREATOR env var exists' do
+      let(:env) do
+        { 'BUILDKITE_BUILD_AUTHOR' => nil,
+          'BUILDKITE_BUILD_CREATOR' => 'John Doe' }
+      end
+
+      it { should eql 'John Doe' }
+    end
+
+    context 'when both BUILDKITE_BUILD_AUTHOR and BUILDKITE_BUILD_CREATOR env vars exist' do
+      let(:env) do
+        { 'BUILDKITE_BUILD_AUTHOR' => 'Jane Doe',
+          'BUILDKITE_BUILD_CREATOR' => 'John Doe' }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context "when neither env var exists" do
+      it { should be nil }
+    end
+  end
 end

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

@@ -63,8 +63,8 @@ describe KnapsackPro::Config::CI::Circle do
     subject { described_class.new.branch }
 
     context 'when environment exists' do
-      let(:env) { { 'CIRCLE_BRANCH' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'CIRCLE_BRANCH' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when environment doesn't exist" do
@@ -84,4 +84,39 @@ describe KnapsackPro::Config::CI::Circle do
       it { should be nil }
     end
   end
+
+  describe '#user_seat' do
+    subject { described_class.new.user_seat }
+
+    context 'when the CIRCLE_USERNAME env var exists' do
+      let(:env) do
+        { 'CIRCLE_USERNAME' => 'Jane Doe',
+          'CIRCLE_PR_USERNAME' => nil }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context 'when the CIRCLE_PR_USERNAME env var exists' do
+      let(:env) do
+        { 'CIRCLE_USERNAME' => nil,
+          'CIRCLE_PR_USERNAME' => 'John Doe' }
+      end
+
+      it { should eql 'John Doe' }
+    end
+
+    context 'when both CIRCLE_USERNAME and CIRCLE_PR_USERNAME env vars exist' do
+      let(:env) do
+        { 'CIRCLE_USERNAME' => 'Jane Doe',
+          'CIRCLE_PR_USERNAME' => 'John Doe' }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context "when neither env var exists" do
+      it { should be nil }
+    end
+  end
 end

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

@@ -52,12 +52,12 @@ describe KnapsackPro::Config::CI::GithubActions do
       context 'when GITHUB_REF has value' do
         let(:env) do
           {
-            'GITHUB_REF' => 'master',
+            'GITHUB_REF' => 'main',
             'GITHUB_SHA' => '2e13512fc230d6f9ebf4923352718e4d',
           }
         end
 
-        it { should eql 'master' }
+        it { should eql 'main' }
       end
 
       context 'when GITHUB_REF is not set' do
@@ -88,4 +88,18 @@ describe KnapsackPro::Config::CI::GithubActions do
       it { should be nil }
     end
   end
+
+  describe '#user_seat' do
+    subject { described_class.new.user_seat }
+
+    context 'when the GITHUB_ACTOR environment variable exists' do
+      let(:env) { { 'GITHUB_ACTOR' => 'jane_doe' } }
+
+      it { should eql 'jane_doe' }
+    end
+
+    context "when the GITHUB_ACTOR environment variable doesn't exist" do
+      it { should be nil }
+    end
+  end
 end

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

@@ -73,13 +73,13 @@ describe KnapsackPro::Config::CI::GitlabCI do
     subject { described_class.new.branch }
 
     context 'when Gitlab Release 9.0+ and environment exists' do
-      let(:env) { { 'CI_COMMIT_REF_NAME' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'CI_COMMIT_REF_NAME' => 'main' } }
+      it { should eql 'main' }
     end
 
     context 'when Gitlab Release 8.x and environment exists' do
-      let(:env) { { 'CI_BUILD_REF_NAME' => 'master' } }
-      it { should eql 'master' }
+      let(:env) { { 'CI_BUILD_REF_NAME' => 'main' } }
+      it { should eql 'main' }
     end
 
     context "when environment doesn't exist" do
@@ -99,4 +99,39 @@ describe KnapsackPro::Config::CI::GitlabCI do
       it { should be nil }
     end
   end
+
+  describe '#user_seat' do
+    subject { described_class.new.user_seat }
+
+    context 'when the GITLAB_USER_NAME env var exists' do
+      let(:env) do
+        { 'GITLAB_USER_NAME' => 'Jane Doe',
+          'GITLAB_USER_EMAIL' => nil }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context 'when the GITLAB_USER_EMAIL env var exists' do
+      let(:env) do
+        { 'GITLAB_USER_NAME' => nil,
+          'GITLAB_USER_EMAIL' => 'janed@example.com' }
+      end
+
+      it { should eql 'janed@example.com' }
+    end
+
+    context 'when both GITLAB_USER_NAME and GITLAB_USER_EMAIL env vars exist' do
+      let(:env) do
+        { 'GITLAB_USER_NAME' => 'Jane Doe',
+          'GITLAB_USER_EMAIL' => 'janed@example.com' }
+      end
+
+      it { should eql 'Jane Doe' }
+    end
+
+    context "when neither env var exists" do
+      it { should be nil }
+    end
+  end
 end

data/spec/knapsack_pro/config/env_spec.rb

@@ -72,8 +72,10 @@ describe KnapsackPro::Config::Env do
       end
     end
 
-    context "when ENV doesn't exist" do
-      it { should eq 'missing-build-id' }
+    context "when ENV does not exist" do
+      it 'raises' do
+        expect { subject }.to raise_error(/Missing environment variable KNAPSACK_PRO_CI_NODE_BUILD_ID/)
+      end
     end
   end
 
@@ -182,6 +184,51 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.user_seat' do
+    subject { described_class.user_seat }
+
+    context 'when ENV exists' do
+      context 'when KNAPSACK_PRO_USER_SEAT has value' do
+        before { stub_const("ENV", { 'KNAPSACK_PRO_USER_SEAT' => 'John Doe' }) }
+        it { should eq 'John Doe' }
+      end
+
+      context 'when CI environment has value' do
+        before do
+          expect(described_class).to receive(:ci_env_for).with(:user_seat).and_return('Jane Doe')
+        end
+
+        it { should eq 'Jane Doe' }
+      end
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be nil }
+    end
+  end
+
+  describe '.user_seat_hash' do
+    subject { described_class.user_seat_hash }
+
+    before do
+      expect(described_class).to receive(:user_seat).at_least(1).and_return(user_seat)
+    end
+
+    context 'when the user seat has a value' do
+      let(:user_seat) { 'John Doe' }
+
+      it 'returns a SHA256 hash for the user seat' do
+        expect(subject).to eq '6cea57c2fb6cbc2a40411135005760f241fffc3e5e67ab99882726431037f908'
+      end
+    end
+
+    context 'when the user seat has no value' do
+      let(:user_seat) { nil }
+
+      it { expect(subject).to be_nil }
+    end
+  end
+
   describe '.test_file_pattern' do
     subject { described_class.test_file_pattern }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 4.0.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -404,7 +404,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel