knapsack_pro 5.3.5 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202eb37b7550c8556fadd902ed204ea71d5c928b2ed79f3452aa2f7dabee1a35
-  data.tar.gz: 846ec0dd9f9953bbbfeed2b9f77535a25e5182de8b3798dcff88a48fce1ba0f9
+  metadata.gz: 9403659bbc5c95b9b6f0998b7ffdbffbe919522811c651644428eea2df6f3887
+  data.tar.gz: 139709a119b184958ef73d2268bfeca618f5456c0a410e6198baf8a4d269e05b
 SHA512:
-  metadata.gz: 6e9e1bffd253bade681efd59cdb43a13c8ae99bb43981dbf8aaea0f7adc3e5d2cce530488e6308a7eb35821abfc9245f26236e3e3dc323b68dbd3fd457905865
-  data.tar.gz: aedf904bdf8f765e1fdcbe651ee9d1f839201c48fdad7750668c88cb2f70bb1f61fff1fa633062f0be3bf31770656d48b0467b61b970f6d03526c430b7dc12c8
+  metadata.gz: 9a5152b40b810546160663243f259b82de186be4c01169cb2881315eadbacaf50a47bc6a8f851dcf0c08aa0f392aeaff3d618886f0cd8aaa1cbb06eac6d2f8b2
+  data.tar.gz: e20d7cb45f17fffd7420d16ed15cca4c44a0bc022407f97871d6e03290b09fd69da11e06d5dced21a77dcab059c00394909c7977eed849496e805f18a99c7580

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 5.4.0
+
+* Send to the API the CI provider with a header
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/216
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.3.5...v5.4.0
+
 ### 5.3.5
 
 * Handle RSpec exceptions when running RSpec in Queue Mode

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/knapsack_pro/client/connection.rb

@@ -59,18 +59,15 @@ module KnapsackPro
         request_hash.to_json
       end
 
-      def test_suite_token
-        KnapsackPro::Config::Env.test_suite_token
-      end
-
       def json_headers
         {
           'Content-Type' => 'application/json',
           'Accept' => 'application/json',
           'KNAPSACK-PRO-CLIENT-NAME' => client_name,
           'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
-          'KNAPSACK-PRO-TEST-SUITE-TOKEN' => test_suite_token,
-        }
+          'KNAPSACK-PRO-TEST-SUITE-TOKEN' => KnapsackPro::Config::Env.test_suite_token,
+          'KNAPSACK-PRO-CI-PROVIDER' => KnapsackPro::Config::Env.ci_provider,
+        }.compact
       end
 
       def client_name

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

@@ -34,6 +34,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "AppVeyor"
+        end
       end
     end
   end

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

@@ -32,6 +32,21 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          return 'AWS CodeBuild' if ENV.key?('CODEBUILD_BUILD_ARN')
+          return 'Azure Pipelines' if ENV.key?('SYSTEM_TEAMFOUNDATIONCOLLECTIONURI')
+          return 'Bamboo' if ENV.key?('bamboo_planKey')
+          return 'Bitbucket Pipelines' if ENV.key?('BITBUCKET_COMMIT')
+          return 'Buddy.works' if ENV.key?('BUDDY')
+          return 'Drone.io' if ENV.key?('DRONE')
+          return 'Google Cloud Build' if ENV.key?('BUILDER_OUTPUT')
+          return 'Jenkins' if ENV.key?('JENKINS_URL')
+          return 'TeamCity' if ENV.key?('TEAMCITY_VERSION')
+          return 'Other' if KnapsackPro::Config::Env.ci?
+
+          nil
+        end
       end
     end
   end

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

@@ -41,6 +41,10 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          "Buildkite"
+        end
       end
     end
   end

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

@@ -37,6 +37,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "CircleCI"
+        end
       end
     end
   end

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

@@ -33,6 +33,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "Cirrus CI"
+        end
       end
     end
   end

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

@@ -34,6 +34,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "Codefresh"
+        end
       end
     end
   end

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

@@ -33,6 +33,10 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          "Codeship"
+        end
       end
     end
   end

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

@@ -49,6 +49,10 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          "GitHub Actions"
+        end
       end
     end
   end

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

@@ -45,6 +45,10 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          "Gitlab CI"
+        end
       end
     end
   end

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

@@ -33,6 +33,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "Heroku CI"
+        end
       end
     end
   end

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

@@ -34,6 +34,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "Semaphore CI 1.0"
+        end
       end
     end
   end

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

@@ -38,6 +38,10 @@ module KnapsackPro
         def fixed_queue_split
           false
         end
+
+        def ci_provider
+          "Semaphore CI 2.0"
+        end
       end
     end
   end

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

@@ -25,6 +25,10 @@ module KnapsackPro
         def fixed_queue_split
           true
         end
+
+        def ci_provider
+          "Travis CI"
+        end
       end
     end
   end

data/lib/knapsack_pro/config/env.rb

@@ -269,6 +269,10 @@ module KnapsackPro
           detected || KnapsackPro::Config::CI::Base
         end
 
+        def ci_provider
+          detected_ci.new.ci_provider
+        end
+
         def log_level
           LOG_LEVELS[ENV['KNAPSACK_PRO_LOG_LEVEL'].to_s.downcase] || ::Logger::DEBUG
         end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '5.3.5'
+  VERSION = '5.4.0'
 end

data/spec/knapsack_pro/client/connection_spec.rb

@@ -289,6 +289,7 @@ describe KnapsackPro::Client::Connection do
     stub_const('ENV', {
       'KNAPSACK_PRO_ENDPOINT' => 'http://api.knapsackpro.test:3000',
       'KNAPSACK_PRO_TEST_SUITE_TOKEN' => test_suite_token,
+      'GITHUB_ACTIONS' => 'true',
     })
   end
 
@@ -323,6 +324,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
@@ -346,6 +348,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
@@ -368,6 +371,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 +395,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/env_spec.rb

@@ -676,7 +676,7 @@ describe KnapsackPro::Config::Env do
           ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }],
           ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }],
           ['Travis CI', { 'TRAVIS' => 'true' }],
-          ['Unsupported', {}],
+          ['Unsupported CI', {}],
         ].each do |ci, env|
           it "on #{ci} it is false" do
             logger = instance_double(Logger)
@@ -704,7 +704,7 @@ describe KnapsackPro::Config::Env do
           ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }],
           ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }],
           ['Travis CI', { 'TRAVIS' => 'true' }],
-          ['Unsupported', {}],
+          ['Unsupported CI', {}],
         ].each do |ci, env|
           it "on #{ci} it is true" do
             logger = instance_double(Logger)
@@ -733,7 +733,7 @@ describe KnapsackPro::Config::Env do
         ['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],
+        ['Unsupported CI', {}, true],
       ].each do |ci, env, expected|
         it "on #{ci} it is #{expected}" do
           logger = instance_double(Logger)
@@ -1032,7 +1032,7 @@ describe KnapsackPro::Config::Env do
       ['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', {}, KnapsackPro::Config::CI::Base],
+      ['Unsupported CI', {}, KnapsackPro::Config::CI::Base],
     ].each do |ci, env, expected|
       it "detects #{ci}" do
         stub_const("ENV", env)
@@ -1046,7 +1046,7 @@ describe KnapsackPro::Config::Env do
     [
       ['CI from env', { 'CI' => 'True' }, true],
       ['Travis CI', { 'TRAVIS' => 'true' }, true],
-      ['Unsupported', {}, false],
+      ['missing CI from ENV or development', {}, false],
     ].each do |ci, env, expected|
       it "detects #{ci}" do
         stub_const("ENV", env)
@@ -1055,4 +1055,38 @@ describe KnapsackPro::Config::Env do
       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} name" do
+        stub_const("ENV", env)
+
+        expect(described_class.ci_provider).to eq(ci)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.3.5
+  version: 5.4.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -186,6 +186,7 @@ email:
 - arturtrzop@gmail.com
 executables:
 - knapsack_pro
+- rspec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -201,6 +202,7 @@ files:
 - README.md
 - Rakefile
 - bin/knapsack_pro
+- bin/rspec
 - knapsack_pro.gemspec
 - lib/knapsack_pro.rb
 - lib/knapsack_pro/adapters/base_adapter.rb