knapsack_pro 3.8.0 → 7.0.0

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

@@ -7,6 +7,9 @@ describe KnapsackPro::Client::API::V1::Queues do
     let(:node_index) { double }
     let(:test_files) { double }
     let(:node_build_id) { double }
+    let(:masked_user_seat) { double }
+    let(:can_initialize_queue) { [false, true].sample }
+    let(:attempt_connect_to_queue) { [false, true].sample }
 
     subject do
       described_class.queue(
@@ -23,6 +26,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(:masked_user_seat).and_return(masked_user_seat)
     end
 
     context 'when can_initialize_queue=true and attempt_connect_to_queue=true' do
@@ -31,20 +35,9 @@ describe KnapsackPro::Client::API::V1::Queues do
 
       it 'does not send test_files among other params' do
         action = double
-        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
-          endpoint_path: '/v1/queues/queue',
-          http_method: :post,
-          request_hash: {
-            fixed_queue_split: fixed_queue_split,
-            can_initialize_queue: can_initialize_queue,
-            attempt_connect_to_queue: attempt_connect_to_queue,
-            commit_hash: commit_hash,
-            branch: branch,
-            node_total: node_total,
-            node_index: node_index,
-            node_build_id: node_build_id,
-          }
-        }).and_return(action)
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with(
+          hash_including(request_hash: hash_excluding(:test_files))
+        ).and_return(action)
         expect(subject).to eq action
       end
     end
@@ -55,21 +48,19 @@ describe KnapsackPro::Client::API::V1::Queues do
 
       it 'sends test_files among other params' do
         action = double
-        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
-          endpoint_path: '/v1/queues/queue',
-          http_method: :post,
-          request_hash: {
-            fixed_queue_split: fixed_queue_split,
-            can_initialize_queue: can_initialize_queue,
-            attempt_connect_to_queue: attempt_connect_to_queue,
-            commit_hash: commit_hash,
-            branch: branch,
-            node_total: node_total,
-            node_index: node_index,
-            node_build_id: node_build_id,
-            test_files: test_files
-          }
-        }).and_return(action)
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with(
+          hash_including(request_hash: hash_including(test_files: test_files))
+        ).and_return(action)
+        expect(subject).to eq action
+      end
+
+      it "sends authors" do
+        action = double
+
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with(
+          hash_including(request_hash: hash_including(:build_author, :commit_authors))
+        ).and_return(action)
+
         expect(subject).to eq action
       end
     end
@@ -80,20 +71,9 @@ describe KnapsackPro::Client::API::V1::Queues do
 
       it 'does not send test_files among other params' do
         action = double
-        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
-          endpoint_path: '/v1/queues/queue',
-          http_method: :post,
-          request_hash: {
-            fixed_queue_split: fixed_queue_split,
-            can_initialize_queue: can_initialize_queue,
-            attempt_connect_to_queue: attempt_connect_to_queue,
-            commit_hash: commit_hash,
-            branch: branch,
-            node_total: node_total,
-            node_index: node_index,
-            node_build_id: node_build_id,
-          }
-        }).and_return(action)
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with(
+          hash_including(request_hash: hash_excluding(:test_files))
+        ).and_return(action)
         expect(subject).to eq action
       end
     end

data/spec/knapsack_pro/client/connection_spec.rb

@@ -282,14 +282,17 @@ describe KnapsackPro::Client::Connection do
                     request_hash: request_hash)
   end
   let(:test_suite_token) { '3fa64859337f6e56409d49f865d13fd7' }
-
   let(:connection) { described_class.new(action) }
-
-  before do
-    stub_const('ENV', {
+  let(:headers) do
+    {
       'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
       'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
-    })
+      'GITHUB_ACTIONS' => 'true',
+    }
+  end
+
+  before do
+    stub_const('ENV', headers)
   end
 
   describe '#call' do
@@ -310,7 +313,7 @@ describe KnapsackPro::Client::Connection do
       expect(http).to receive(:read_timeout=).with(15)
     end
 
-    context 'when http method is POST' do
+    context 'when http method is POST on GitHub Actions' do
       let(:http_method) { :post }
 
       before do
@@ -323,6 +326,7 @@ describe KnapsackPro::Client::Connection do
             'KNAPSACK-PRO-CLIENT-NAME' => 'knapsack_pro-ruby',
             'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
             'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
+            'KNAPSACK-PRO-CI-PROVIDER' => 'GitHub Actions',
           }
         ).and_return(http_response)
       end
@@ -332,7 +336,30 @@ describe KnapsackPro::Client::Connection do
       end
     end
 
-    context 'when http method is GET' do
+    context 'when http method is POST and CI is undetected' do
+      let(:http_method) { :post }
+
+      let(:headers) do
+        {
+          'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
+          'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+        }
+      end
+
+      before do
+        expect(http).to receive(:post).with(
+          anything,
+          anything,
+          hash_not_including('KNAPSACK-PRO-CI-PROVIDER')
+        ).and_return(http_response)
+      end
+
+      it_behaves_like 'when request got response from API' do
+        let(:expected_http_method) { 'POST' }
+      end
+    end
+
+    context 'when http method is GET on GitHub Actions' do
       let(:http_method) { :get }
 
       before do
@@ -346,6 +373,7 @@ describe KnapsackPro::Client::Connection do
             'KNAPSACK-PRO-CLIENT-NAME' => 'knapsack_pro-ruby',
             'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
             'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
+            'KNAPSACK-PRO-CI-PROVIDER' => 'GitHub Actions',
           }
         ).and_return(http_response)
       end
@@ -355,6 +383,28 @@ describe KnapsackPro::Client::Connection do
       end
     end
 
+    context 'when http method is GET and CI is undetected' do
+      let(:http_method) { :get }
+
+      let(:headers) do
+        {
+          'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
+          'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+        }
+      end
+
+      before do
+        expect(http).to receive(:get).with(
+          anything,
+          hash_not_including('KNAPSACK-PRO-CI-PROVIDER')
+        ).and_return(http_response)
+      end
+
+      it_behaves_like 'when request got response from API' do
+        let(:expected_http_method) { 'GET' }
+      end
+    end
+
     context 'when retry request for http method POST' do
       let(:http_method) { :post }
 
@@ -368,6 +418,7 @@ describe KnapsackPro::Client::Connection do
             'KNAPSACK-PRO-CLIENT-NAME' => 'knapsack_pro-ruby',
             'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
             'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
+            'KNAPSACK-PRO-CI-PROVIDER' => 'GitHub Actions',
           }
         ).and_return(http_response)
       end
@@ -391,6 +442,7 @@ describe KnapsackPro::Client::Connection do
             'KNAPSACK-PRO-CLIENT-NAME' => 'knapsack_pro-ruby',
             'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
             'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
+            'KNAPSACK-PRO-CI-PROVIDER' => 'GitHub Actions',
           }
         ).and_return(http_response)
       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,26 @@ 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
+
+  describe '#user_seat' do
+    subject { described_class.new.user_seat }
+
+    context 'when the APPVEYOR_REPO_COMMIT_AUTHOR environment variable exists' do
+      let(:env) { { 'APPVEYOR_REPO_COMMIT_AUTHOR' => 'jane_doe' } }
+
+      it { should eql 'jane_doe' }
+    end
+
+    context "when the APPVEYOR_REPO_COMMIT_AUTHOR environment variable doesn't exist" do
       it { should be nil }
     end
   end

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

@@ -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
-      let(:env) { { 'BUILDKITE_BRANCH' => 'master' } }
-      it { should eql 'master' }
+    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,47 @@ 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
+
+  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

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
-      let(:env) { { 'CIRCLE_BRANCH' => 'master' } }
-      it { should eql 'master' }
+    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,42 @@ 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
+
+  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

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

@@ -10,12 +10,12 @@ describe KnapsackPro::Config::CI::CirrusCI do
   describe '#node_total' do
     subject { described_class.new.node_total }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CI_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::CirrusCI do
   describe '#node_index' do
     subject { described_class.new.node_index }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CI_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::CirrusCI 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) { { 'CIRRUS_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
@@ -49,12 +49,12 @@ describe KnapsackPro::Config::CI::CirrusCI do
   describe '#commit_hash' do
     subject { described_class.new.commit_hash }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRRUS_CHANGE_IN_REPO' => '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
@@ -62,12 +62,12 @@ describe KnapsackPro::Config::CI::CirrusCI do
   describe '#branch' do
     subject { described_class.new.branch }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRRUS_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
@@ -75,12 +75,12 @@ describe KnapsackPro::Config::CI::CirrusCI do
   describe '#project_dir' do
     subject { described_class.new.project_dir }
 
-    context 'when environment exists' do
+    context 'when the environment exists' do
       let(:env) { { 'CIRRUS_WORKING_DIR' => '/tmp/cirrus-ci-build' } }
       it { should eql '/tmp/cirrus-ci-build' }
     end
 
-    context "when environment doesn't exist" do
+    context "when the environment doesn't exist" do
       it { should be nil }
     end
   end