knapsack_pro 3.8.0 → 7.0.0

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,55 @@ 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 '.masked_seat_hash' do
+    subject { described_class.masked_user_seat }
+
+    before do
+      expect(described_class).to receive(:user_seat).at_least(1).and_return(user_seat)
+    end
+
+    context 'when the user seat is a name' do
+      let(:user_seat) { 'John Doe' }
+
+      it { expect(subject).to eq 'Jo** Do*' }
+    end
+
+    context 'when the user seat is an e-mail' do
+      let(:user_seat) { 'john.doe@example.com' }
+
+      it { expect(subject).to eq 'jo**.do*@ex*****.co*' }
+    end
+
+    context 'when the user seat is nil' do
+      let(:user_seat) { nil }
+
+      it { expect(subject).to be_nil }
+    end
+  end
+
   describe '.test_file_pattern' do
     subject { described_class.test_file_pattern }
 
@@ -460,40 +511,6 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.modify_default_rspec_formatters' do
-    subject { described_class.modify_default_rspec_formatters }
-
-    context 'when ENV exists' do
-      let(:modify_default_rspec_formatters) { 'false' }
-      before { stub_const("ENV", { 'KNAPSACK_PRO_MODIFY_DEFAULT_RSPEC_FORMATTERS' => modify_default_rspec_formatters }) }
-      it { should eq modify_default_rspec_formatters }
-    end
-
-    context "when ENV doesn't exist" do
-      it { should be true }
-    end
-  end
-
-  describe '.modify_default_rspec_formatters?' do
-    subject { described_class.modify_default_rspec_formatters? }
-
-    before do
-      expect(described_class).to receive(:modify_default_rspec_formatters).and_return(modify_default_rspec_formatters)
-    end
-
-    context 'when enabled' do
-      let(:modify_default_rspec_formatters) { true }
-
-      it { should be true }
-    end
-
-    context 'when disabled' do
-      let(:modify_default_rspec_formatters) { false }
-
-      it { should be false }
-    end
-  end
-
   describe '.branch_encrypted' do
     subject { described_class.branch_encrypted }
 
@@ -585,20 +602,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? }
 
@@ -620,38 +623,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 CI', {}],
+        ].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 CI', {}],
+        ].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' }, true],
+        ['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 CI', {}, 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
 
@@ -848,57 +907,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 }
 
@@ -933,7 +941,7 @@ describe KnapsackPro::Config::Env do
     end
 
     context "when ENV doesn't exist" do
-      it { should eql ::Logger::DEBUG }
+      it { should eql ::Logger::INFO }
     end
   end
 
@@ -975,4 +983,76 @@ 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 CI', {}, 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
+
+  describe '.ci?' do
+    [
+      ['CI from env', { 'CI' => 'True' }, true],
+      ['Travis CI', { 'TRAVIS' => 'true' }, true],
+      ['missing CI from ENV or development', {}, false],
+    ].each do |ci, env, expected|
+      it "detects #{ci}" do
+        stub_const("ENV", env)
+
+        expect(described_class.ci?).to eq(expected)
+      end
+    end
+  end
+
+  describe '.ci_provider' do
+    [
+      ['AppVeyor', { 'APPVEYOR' => '123' }],
+      ['Azure Pipelines', { 'SYSTEM_TEAMFOUNDATIONCOLLECTIONURI' => '123' }],
+      ['AWS CodeBuild', { 'CODEBUILD_BUILD_ARN' => '123' }],
+      ['Bamboo', { 'bamboo_planKey' => '123' }],
+      ['Bitbucket Pipelines', { 'BITBUCKET_COMMIT' => '123' }],
+      ['Buddy.works', { 'BUDDY' => 'true' }],
+      ['Buildkite', { 'BUILDKITE' => 'true' }],
+      ['CircleCI', { 'CIRCLECI' => 'true' }],
+      ['Cirrus CI', { 'CIRRUS_CI' => 'true' }],
+      ['Codefresh', { 'CF_BUILD_ID' => '123' }],
+      ['Codeship', { 'CI_NAME' => 'codeship' }],
+      ['Drone.io', { 'DRONE' => 'true' }],
+      ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }],
+      ['Gitlab CI', { 'GITLAB_CI' => 'true' }],
+      ['Google Cloud Build', { 'BUILDER_OUTPUT' => '123' }],
+      ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }],
+      ['Jenkins', { 'JENKINS_URL' => '123' }],
+      ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }],
+      ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }],
+      ['TeamCity', { 'TEAMCITY_VERSION' => '123' }],
+      ['Travis CI', { 'TRAVIS' => 'true' }],
+      ['Other', { 'CI' => 'true'}],
+      [nil, {}],
+    ].each do |ci, env|
+      it "detects #{ci || 'missing CI from env or development'}" do
+        stub_const("ENV", env)
+
+        expect(described_class.ci_provider).to eq(ci)
+      end
+    end
+  end
 end