knapsack_pro 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58063b1846ea84151755a05ad9f4cca8297246b78ff0c47d140576cb0d32e19c
-  data.tar.gz: bf36f5e4232ae62eb835dea8f6aeb0d767f5bef88e7aabf7fea2508c8017068a
+  metadata.gz: f00531028caf0501edea4bf33df1bd81fe7ec9fbc888875797289f488e51851e
+  data.tar.gz: dbe2e29cdb257ef772348653e40bcccc0ae4d70e8fc0fdd72fd26193784a60b7
 SHA512:
-  metadata.gz: 756a63cd54c3e35e60cd09ba057c026d5ab279dab5bdd295bccfb49c6f235f68835e956171a19d9a8c5ca21db46de204e22867c879dae331fe482ffefe906189
-  data.tar.gz: 54e7d11084f8eab1ace9e225f0a1455dd9b391f33742cafa475b2ce144024f8509d7afcb0915f663784f0ead5407b7accee33d90acb19c44a6ab845c8507e0b5
+  metadata.gz: 8ac1af3bf5eff25233ddb17294c56d9de6c9ec0d94c6412182a69ce2f4c04082eb705b0f204e42a342486c2001862171503d6726012421b336fe25c851e103c8
+  data.tar.gz: 52d4b68c5793defaf162659597d63afa7461964c78e6b78385ffe21af5cdf529124a15c9d5d96f2ca7216e175daa8b9aa6d2b04698e23c59b2a71b6603b13318

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+### 5.2.0
+
+* Send authors to the API
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/208
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.1.2...v5.2.0
+
+### 5.1.2
+
+* Fix broken RSpec split by test examples feature when `SPEC_OPTS` is set in Queue Mode. Ignore `SPEC_OPTS` when generating test examples report for slow test files.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/191
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.1.1...v5.1.2
+
 ### 5.1.1
 
 * Use `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true` as default value in Queue Mode for GitLab CI

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

@@ -16,6 +16,8 @@ module KnapsackPro
                 :node_index => args.fetch(:node_index),
                 :ci_build_id => KnapsackPro::Config::Env.ci_node_build_id,
                 :user_seat => KnapsackPro::Config::Env.masked_user_seat,
+                :build_author => KnapsackPro::RepositoryAdapters::GitAdapter.new.build_author,
+                :commit_authors => KnapsackPro::RepositoryAdapters::GitAdapter.new.commit_authors,
               }
 
               unless request_hash[:cache_read_attempt]

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

@@ -17,6 +17,8 @@ module KnapsackPro
                 :node_index => args.fetch(:node_index),
                 :node_build_id => KnapsackPro::Config::Env.ci_node_build_id,
                 :user_seat => KnapsackPro::Config::Env.masked_user_seat,
+                :build_author => KnapsackPro::RepositoryAdapters::GitAdapter.new.build_author,
+                :commit_authors => KnapsackPro::RepositoryAdapters::GitAdapter.new.commit_authors,
               }
 
               if request_hash[:can_initialize_queue] && !request_hash[:attempt_connect_to_queue]

data/lib/knapsack_pro/config/env.rb

@@ -67,7 +67,7 @@ module KnapsackPro
         def masked_user_seat
           return unless user_seat
 
-          user_seat.gsub(/(?<=\w{2})[a-zA-Z]/, "*")
+          KnapsackPro::MaskString.call(user_seat)
         end
 
         def test_file_pattern

data/lib/knapsack_pro/mask_string.rb

@@ -0,0 +1,7 @@
+module KnapsackPro
+  class MaskString
+    def self.call(string)
+      string.gsub(/(?<=\w{2})[a-zA-Z]/, "*")
+    end
+  end
+end

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -14,8 +14,40 @@ module KnapsackPro
         str_branches.split("\n")
       end
 
+      def commit_authors
+        authors = git_commit_authors
+          .split("\n")
+          .map { |line| line.strip }
+          .map { |line| line.split("\t") }
+          .map do |commits, author|
+            { commits: commits.to_i, author: KnapsackPro::MaskString.call(author) }
+          end
+
+        raise if authors.empty?
+
+        authors
+      rescue Exception
+        []
+      end
+
+      def build_author
+        author = KnapsackPro::MaskString.call(git_build_author.strip)
+        raise if author.empty?
+        author
+      rescue Exception
+        "no git <no.git@example.com>"
+      end
+
       private
 
+      def git_commit_authors
+        `git fetch --shallow-since "1 month ago" >/dev/null 2>&1 && git shortlog --summary --email --since "one month ago"`
+      end
+
+      def git_build_author
+        `git log --format="%aN <%aE>" -1`
+      end
+
       def working_dir
         dir = KnapsackPro::Config::Env.project_dir
         File.expand_path(dir)

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -87,6 +87,7 @@ module KnapsackPro
             all_test_file_paths += test_file_paths
             cli_args = args + test_file_paths
 
+            ensure_spec_opts_have_rspec_queue_summary_formatter
             options = ::RSpec::Core::ConfigurationOptions.new(cli_args)
             rspec_runner = ::RSpec::Core::Runner.new(options)
 
@@ -113,6 +114,15 @@ module KnapsackPro
           end
         end
 
+        def self.ensure_spec_opts_have_rspec_queue_summary_formatter
+          spec_opts = ENV['SPEC_OPTS']
+
+          return unless spec_opts
+          return if spec_opts.include?(KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s)
+
+          ENV['SPEC_OPTS'] = "#{spec_opts} --format #{KnapsackPro::Formatters::RSpecQueueSummaryFormatter.to_s}"
+        end
+
         private
 
         def self.adapter_class

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '5.1.1'
+  VERSION = '5.2.0'
 end

data/lib/knapsack_pro.rb

@@ -55,6 +55,7 @@ require_relative 'knapsack_pro/adapters/test_unit_adapter'
 require_relative 'knapsack_pro/adapters/spinach_adapter'
 require_relative 'knapsack_pro/allocator'
 require_relative 'knapsack_pro/queue_allocator'
+require_relative 'knapsack_pro/mask_string'
 require_relative 'knapsack_pro/test_case_mergers/base_merger'
 require_relative 'knapsack_pro/test_case_mergers/rspec_merger'
 require_relative 'knapsack_pro/build_distribution_fetcher'

data/lib/tasks/rspec.rake

@@ -7,6 +7,9 @@ namespace :knapsack_pro do
 
   desc "Generate JSON report for test suite based on default test pattern or based on defined pattern with ENV vars"
   task :rspec_test_example_detector do
+    # ignore the `SPEC_OPTS` options to not affect RSpec execution within this rake task
+    ENV.delete('SPEC_OPTS')
+
     detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
     detector.generate_json_report
   end

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

@@ -8,6 +8,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
     let(:ci_build_id) { double }
     let(:masked_user_seat) { double }
     let(:test_files) { double }
+    let(:cache_read_attempt) { [false, true].sample }
 
     subject do
       described_class.subset(
@@ -31,20 +32,9 @@ describe KnapsackPro::Client::API::V1::BuildDistributions 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/build_distributions/subset',
-          http_method: :post,
-          request_hash: {
-            fixed_test_suite_split: fixed_test_suite_split,
-            cache_read_attempt: cache_read_attempt,
-            commit_hash: commit_hash,
-            branch: branch,
-            node_total: node_total,
-            node_index: node_index,
-            ci_build_id: ci_build_id,
-            user_seat: masked_user_seat,
-          }
-        }).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
@@ -54,24 +44,22 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
 
       it 'sends test_files among other params' do
         action = double
-        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
-          endpoint_path: '/v1/build_distributions/subset',
-          http_method: :post,
-          request_hash: {
-            fixed_test_suite_split: fixed_test_suite_split,
-            cache_read_attempt: cache_read_attempt,
-            commit_hash: commit_hash,
-            branch: branch,
-            node_total: node_total,
-            node_index: node_index,
-            ci_build_id: ci_build_id,
-            user_seat: masked_user_seat,
-            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
     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
 
   describe '.last' do

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

@@ -8,6 +8,8 @@ describe KnapsackPro::Client::API::V1::Queues do
     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(
@@ -33,21 +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,
-            user_seat: masked_user_seat,
-          }
-        }).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
@@ -58,22 +48,9 @@ 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,
-            user_seat: masked_user_seat,
-            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
     end
@@ -84,23 +61,21 @@ 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,
-            user_seat: masked_user_seat,
-          }
-        }).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
+
+    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
 end

data/spec/knapsack_pro/repository_adapters/git_adapter_spec.rb

@@ -31,4 +31,76 @@ describe KnapsackPro::RepositoryAdapters::GitAdapter do
     it { expect(subject.include?('master')).to be true }
     it { expect(subject.include?(circle_branch)).to be true } if ENV['CIRCLECI']
   end
+
+  describe '#build_author' do
+    it "returns the masked build author" do
+      allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_build_author).and_return(
+        "John Doe <john.doe@example.com>" + "\n"
+      )
+
+      subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+      expect(subject.build_author).to eq 'Jo** Do* <jo**.do*@ex*****.co*>'
+    end
+
+    context "when the command raises an exception" do
+      it "returns the no-git author" do
+        allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_build_author).and_raise(Exception)
+
+        subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+        expect(subject.build_author).to eq "no git <no.git@example.com>"
+      end
+    end
+
+    context "when the command returns an empty string" do
+      it "returns the no-git author" do
+        allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_build_author).and_return("")
+
+        subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+        expect(subject.build_author).to eq "no git <no.git@example.com>"
+      end
+    end
+  end
+
+  describe '#commit_authors' do
+    it "returns the masked commit authors" do
+      allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_commit_authors).and_return([
+        "     5\t3v0k4 <riccardo@example.com>\n",
+        "    10\tArtur Nowak <artur@example.com>\n",
+        "     2\tRiccardo <riccardo@example.com>\n",
+        "     3 \tshadre <shadi@example.com>\n",
+      ].join(""))
+
+      subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+      expect(subject.commit_authors).to eq([
+        { commits: 5, author: "3v0*4 <ri******@ex*****.co*>" },
+        { commits: 10, author: "Ar*** No*** <ar***@ex*****.co*>" },
+        { commits: 2, author: "Ri****** <ri******@ex*****.co*>" },
+        { commits: 3, author: "sh**** <sh***@ex*****.co*>" },
+      ])
+    end
+
+    context "when the authors command raises an exception" do
+      it "returns []" do
+        allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_commit_authors).and_raise(Exception)
+
+        subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+        expect(subject.commit_authors).to eq []
+      end
+    end
+
+    context "when the authors command returns an empty string" do
+      it "returns []" do
+        allow_any_instance_of(KnapsackPro::RepositoryAdapters::GitAdapter).to receive(:git_commit_authors).and_return("")
+
+        subject = KnapsackPro::RepositoryAdapters::GitAdapter.new
+
+        expect(subject.commit_authors).to eq []
+      end
+    end
+  end
 end

data/spec/knapsack_pro/runners/queue/rspec_runner_spec.rb

@@ -212,6 +212,7 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
         expect(tracker).to receive(:reset!)
         expect(tracker).to receive(:set_prerun_tests).with(test_file_paths)
 
+        expect(described_class).to receive(:ensure_spec_opts_have_rspec_queue_summary_formatter)
         options = double
         expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
           '--no-color',
@@ -339,4 +340,39 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       end
     end
   end
+
+  describe '.ensure_spec_opts_have_rspec_queue_summary_formatter' do
+    subject { described_class.ensure_spec_opts_have_rspec_queue_summary_formatter }
+
+    context 'when `SPEC_OPTS` is set' do
+      context 'when `SPEC_OPTS` has RSpec Queue Summary Formatter' do
+        before do
+          stub_const('ENV', { 'SPEC_OPTS' => '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter' })
+        end
+
+        it 'does nothing' do
+          subject
+          expect(ENV['SPEC_OPTS']).to eq '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter'
+        end
+      end
+
+      context 'when `SPEC_OPTS` has no RSpec Queue Summary Formatter' do
+        before do
+          stub_const('ENV', { 'SPEC_OPTS' => '--format json' })
+        end
+
+        it 'adds RSpec Queue Summary Formatter to `SPEC_OPTS`' do
+          subject
+          expect(ENV['SPEC_OPTS']).to eq '--format json --format KnapsackPro::Formatters::RSpecQueueSummaryFormatter'
+        end
+      end
+    end
+
+    context 'when `SPEC_OPTS` is not set' do
+      it 'does nothing' do
+        subject
+        expect(ENV['SPEC_OPTS']).to be_nil
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -192,6 +192,7 @@ files:
 - ".circleci/config.yml"
 - ".github/assets/install-button.png"
 - ".github/assets/knapsack-diamonds.png"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -244,6 +245,7 @@ files:
 - lib/knapsack_pro/formatters/rspec_queue_summary_formatter.rb
 - lib/knapsack_pro/hooks/queue.rb
 - lib/knapsack_pro/logger_wrapper.rb
+- lib/knapsack_pro/mask_string.rb
 - lib/knapsack_pro/presenter.rb
 - lib/knapsack_pro/queue_allocator.rb
 - lib/knapsack_pro/queue_allocator_builder.rb