knapsack_pro 5.5.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 792df8662b070a5352ff707690d0ea394a938787a2656856aa5e8a4098954765
-  data.tar.gz: 668a573e3cda8c09b99013d8c2b9ea962e13abc1febc0e88bd8613daf7341bd3
+  metadata.gz: 87b8a5c7eb2a78f487c9029cdeda3a1cc367b15e248eb1f3b5aaaf1959ebe333
+  data.tar.gz: 12fef31bb8aac248014b3d808190f7f2e7ae6217e83e4af9e40b17b6f98ed379
 SHA512:
-  metadata.gz: 1bdd45d85651fc9528a45f9f8604accce2abc04788d0c81809617ce30319901020decb75bdb164cccda7e70fcc9de09c5d08fde4693420684100a502dc5d7bd0
-  data.tar.gz: 8c500895bf104fdde5e0817e55a30c2d3d54f3020e19039e291fe6dde836f9ede1e5dc5371c91b1413d23fc2fec998242bae539dbade17c21d08bb05a7d87cb5
+  metadata.gz: 43379ac46ef1c5fa6a3fccf0d598831e009564ba37bdb264c681799aa893d5a9d8fbb569ce2bd83fe297b9c885117e95a5439731fd16ea35aa2f294acb88d936
+  data.tar.gz: 1be1143ac276347a0dee92bb15b7660f36b666c9cb8d025e9b1931f463803f9efc2a38ced34d4ca27bbfaa466fc1b6afc71d2960ced12b09888ca09a6572b14b

data/.circleci/config.yml

@@ -30,10 +30,14 @@ jobs:
           command: |
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
+      - run: gem install rubocop
+
       - save_cache:
           paths:
             - ./vendor/bundle
           key: v2-dependencies-bundler-{{ checksum "knapsack_pro.gemspec" }}
 
-      # run tests!
+      # enforce `frozen_string_literal: true` in the gem files
+      - run: rubocop -A --only Style/FrozenStringLiteralComment,Layout/EmptyLineAfterMagicComment lib/
+
       - run: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+### 5.7.0
+
+* Performance improvement: don't run `rake knapsack_pro:rspec_test_example_detector` when no slow test files are detected for RSpec.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/225
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.6.0...v5.7.0
+
+### 5.6.0
+
+* Use `frozen_string_literal: true` to reduce memory usage
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/220
+
+* Enforce `frozen_string_literal: true` in the gem files with Rubocop
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/222
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.5.0...v5.6.0
+
 ### 5.5.0
 
 * Detect user seats for AppVeyor, Codefresh, Codeship

data/lib/knapsack_pro/adapters/base_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class BaseAdapter
@@ -9,6 +11,14 @@ module KnapsackPro
         "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/#{adapter_name}-bind_method_called_for_node_#{KnapsackPro::Config::Env.ci_node_index}.txt"
       end
 
+      def self.split_by_test_cases_enabled?
+        false
+      end
+
+      def self.test_file_cases_for(slow_test_files)
+        raise NotImplementedError
+      end
+
       def self.slow_test_file?(adapter_class, test_file_path)
         @slow_test_file_paths ||=
           begin

data/lib/knapsack_pro/adapters/cucumber_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class CucumberAdapter < BaseAdapter

data/lib/knapsack_pro/adapters/minitest_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class MinitestAdapter < BaseAdapter

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -1,8 +1,39 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class RSpecAdapter < BaseAdapter
       TEST_DIR_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
+      def self.split_by_test_cases_enabled?
+        return false unless KnapsackPro::Config::Env.rspec_split_by_test_examples?
+
+        require 'rspec/core/version'
+        unless Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
+          raise "RSpec >= 3.3.0 is required to split test files by test examples. Learn more: #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
+        end
+
+        true
+      end
+
+      def self.test_file_cases_for(slow_test_files)
+        KnapsackPro.logger.info("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing #{slow_test_files.size} slow test files.")
+
+        # generate the RSpec JSON report in a separate process to not pollute the RSpec state
+        cmd = [
+          'RACK_ENV=test',
+          'RAILS_ENV=test',
+          KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
+          'rake knapsack_pro:rspec_test_example_detector',
+        ].join(' ')
+        unless Kernel.system(cmd)
+          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
+        end
+
+        # read the JSON report
+        KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new.test_file_example_paths
+      end
+
       def self.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
         if KnapsackPro::Config::Env.rspec_split_by_test_examples? && has_tag_option?(cli_args)
           error_message = "It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: #{KnapsackPro::Urls::RSPEC__SPLIT_BY_TEST_EXAMPLES__TAG}"

data/lib/knapsack_pro/adapters/spinach_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class SpinachAdapter < BaseAdapter

data/lib/knapsack_pro/adapters/test_unit_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Adapters
     class TestUnitAdapter < BaseAdapter

data/lib/knapsack_pro/allocator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Allocator
     def initialize(args)

data/lib/knapsack_pro/allocator_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class AllocatorBuilder < BaseAllocatorBuilder
     def allocator

data/lib/knapsack_pro/base_allocator_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class BaseAllocatorBuilder
     TEST_RUNNER_MAP = {
@@ -33,35 +35,16 @@ module KnapsackPro
     def fast_and_slow_test_files_to_run
       test_files_to_run = all_test_files_to_run
 
-      if adapter_class == KnapsackPro::Adapters::RSpecAdapter && KnapsackPro::Config::Env.rspec_split_by_test_examples?
-        require 'rspec/core/version'
-        unless Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('3.3.0')
-          raise "RSpec >= 3.3.0 is required to split test files by test examples. Learn more: #{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}"
-        end
-
+      if adapter_class.split_by_test_cases_enabled?
         slow_test_files = get_slow_test_files
+        return test_files_to_run if slow_test_files.empty?
 
-        KnapsackPro.logger.info("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual 'it's. Thanks to that a single slow test file can be split across parallel CI nodes). Analyzing #{slow_test_files.size} slow test files.")
-
-        # generate RSpec JSON report in separate process to not pollute RSpec state
-        cmd = [
-          'RACK_ENV=test',
-          'RAILS_ENV=test',
-          KnapsackPro::Config::Env.rspec_test_example_detector_prefix,
-          'rake knapsack_pro:rspec_test_example_detector',
-        ].join(' ')
-        unless Kernel.system(cmd)
-          raise "Could not generate JSON report for RSpec. Rake task failed when running #{cmd}"
-        end
-
-        # read JSON report
-        detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
-        test_file_example_paths = detector.test_file_example_paths
+        test_file_cases = adapter_class.test_file_cases_for(slow_test_files)
 
-        KnapsackPro::TestFilesWithTestCasesComposer.call(test_files_to_run, slow_test_files, test_file_example_paths)
-      else
-        test_files_to_run
+        return KnapsackPro::TestFilesWithTestCasesComposer.call(test_files_to_run, slow_test_files, test_file_cases)
       end
+
+      test_files_to_run
     end
 
     private

data/lib/knapsack_pro/build_distribution_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class BuildDistributionFetcher
     class BuildDistributionEntity

data/lib/knapsack_pro/client/api/action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     module API

data/lib/knapsack_pro/client/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Client
     class Connection

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://www.appveyor.com/docs/environment-variables/
 module KnapsackPro
   module Config

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://codefresh.io/docs/docs/codefresh-yaml/variables/#system-provided-variables
 module KnapsackPro
   module Config

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
 module KnapsackPro
   module Config

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://docs.gitlab.com/ce/ci/variables/
 module KnapsackPro
   module Config

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # https://docs.semaphoreci.com/article/12-environment-variables
 module KnapsackPro
   module Config

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     module CI

data/lib/knapsack_pro/config/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class Env

data/lib/knapsack_pro/config/env_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class EnvGenerator

data/lib/knapsack_pro/config/temp_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Config
     class TempFiles
@@ -22,10 +24,12 @@ module KnapsackPro
       end
 
       def self.gitignore_file_content
-        "# This directory is used by knapsack_pro gem for storing temporary files during tests runtime.\n" <<
-        "# Ignore all files, and do not commit this directory into your repository.\n" <<
-        "# Learn more at https://knapsackpro.com\n" <<
-        "*"
+        <<~GITIGNORE
+        # This directory is used by knapsack_pro gem for storing temporary files during tests runtime.
+        # Ignore all files, and do not commit this directory into your repository.
+        # Learn more at https://knapsackpro.com
+        *
+        GITIGNORE
       end
 
       def self.create_gitignore_file!

data/lib/knapsack_pro/crypto/branch_encryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class BranchEncryptor

data/lib/knapsack_pro/crypto/decryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Decryptor

data/lib/knapsack_pro/crypto/digestor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Digestor

data/lib/knapsack_pro/crypto/encryptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Crypto
     class Encryptor

data/lib/knapsack_pro/extensions/time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 class Time

data/lib/knapsack_pro/formatters/rspec_json_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_core('formatters/json_formatter')
 
 # based on https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/formatters/json_formatter.rb

data/lib/knapsack_pro/formatters/rspec_queue_profile_formatter_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_core('formatters/profile_formatter')
 
 module KnapsackPro

data/lib/knapsack_pro/formatters/rspec_queue_summary_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::Support.require_rspec_core('formatters/base_formatter')
 RSpec::Support.require_rspec_core('formatters/base_text_formatter')
 

data/lib/knapsack_pro/hooks/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Hooks
     class Queue

data/lib/knapsack_pro/logger_wrapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class LoggerWrapper
     def initialize(logger)

data/lib/knapsack_pro/mask_string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class MaskString
     def self.call(string)

data/lib/knapsack_pro/presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Presenter
     class << self

data/lib/knapsack_pro/queue_allocator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class QueueAllocator
     def initialize(args)

data/lib/knapsack_pro/queue_allocator_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class QueueAllocatorBuilder < BaseAllocatorBuilder
     def allocator

data/lib/knapsack_pro/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'knapsack_pro'
 

data/lib/knapsack_pro/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Report
     def self.save

data/lib/knapsack_pro/repository_adapter_initiator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class RepositoryAdapterInitiator
     def self.call

data/lib/knapsack_pro/repository_adapters/base_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class BaseAdapter

data/lib/knapsack_pro/repository_adapters/env_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class EnvAdapter < BaseAdapter

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module RepositoryAdapters
     class GitAdapter < BaseAdapter

data/lib/knapsack_pro/runners/base_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class BaseRunner

data/lib/knapsack_pro/runners/cucumber_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class CucumberRunner < BaseRunner

data/lib/knapsack_pro/runners/minitest_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class MinitestRunner < BaseRunner

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     module Queue

data/lib/knapsack_pro/runners/rspec_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class RSpecRunner < BaseRunner

data/lib/knapsack_pro/runners/spinach_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class SpinachRunner < BaseRunner

data/lib/knapsack_pro/runners/test_unit_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module Runners
     class TestUnitRunner < BaseRunner

data/lib/knapsack_pro/slow_test_file_determiner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class SlowTestFileDeterminer
     TIME_THRESHOLD_PER_CI_NODE = 0.7 # 70%

data/lib/knapsack_pro/slow_test_file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class SlowTestFileFinder
     # Get recorded test files from API.

data/lib/knapsack_pro/task_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 
 module KnapsackPro

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector

data/lib/knapsack_pro/test_case_mergers/base_merger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module TestCaseMergers
     class BaseMerger

data/lib/knapsack_pro/test_case_mergers/rspec_merger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   module TestCaseMergers
     class RSpecMerger < BaseMerger

data/lib/knapsack_pro/test_file_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFileCleaner
     def self.clean(test_file_path)

data/lib/knapsack_pro/test_file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFileFinder
     def self.call(test_file_pattern, test_file_list_enabled: true)

data/lib/knapsack_pro/test_file_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFilePattern
     def self.call(adapter_class)

data/lib/knapsack_pro/test_file_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFilePresenter
     def self.stringify_paths(test_file_paths)

data/lib/knapsack_pro/test_files_with_test_cases_composer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFilesWithTestCasesComposer
     # Args:

data/lib/knapsack_pro/test_flat_distributor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class TestFlatDistributor
     DIR_TYPES = [

data/lib/knapsack_pro/tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Tracker
     include Singleton

data/lib/knapsack_pro/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
   class Utils
     def self.unsymbolize(obj)

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KnapsackPro
-  VERSION = '5.5.0'
+  VERSION = '5.7.0'
 end

data/lib/knapsack_pro.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'singleton'
 require 'net/http'

data/lib/tasks/cucumber.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/encrypted_branch_names.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/encrypted_test_file_names.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/minitest.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/queue/cucumber.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/queue/minitest.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/queue/rspec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/rspec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/salt.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :knapsack_pro do
   task :salt, [:size] do |_, args|
     default_size = 32

data/lib/tasks/spinach.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/lib/tasks/test_unit.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'knapsack_pro'
 
 namespace :knapsack_pro do

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -42,6 +42,18 @@ describe KnapsackPro::Adapters::BaseAdapter do
     end
   end
 
+  describe '.split_by_test_cases_enabled?' do
+    subject { described_class.split_by_test_cases_enabled? }
+
+    it { expect(subject).to be false }
+  end
+
+  describe '.test_file_cases_for' do
+    subject { described_class.test_file_cases_for([]) }
+
+    it { expect { subject }.to raise_error NotImplementedError }
+  end
+
   describe '.slow_test_file?' do
     let(:adapter_class) { double }
     let(:slow_test_files) do

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -12,6 +12,81 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     it_behaves_like 'adapter'
   end
 
+  describe '.split_by_test_cases_enabled?' do
+    subject { described_class.split_by_test_cases_enabled? }
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(rspec_split_by_test_examples_enabled)
+    end
+
+    context 'when the RSpec split by test examples is enabled' do
+      let(:rspec_split_by_test_examples_enabled) { true }
+
+      it { expect(subject).to be true }
+
+      context 'when the RSpec version is < 3.3.0' do
+        before do
+          stub_const('RSpec::Core::Version::STRING', '3.2.0')
+        end
+
+        it do
+          expect { subject }.to raise_error RuntimeError, 'RSpec >= 3.3.0 is required to split test files by test examples. Learn more: https://knapsackpro.com/perma/ruby/split-by-test-examples'
+        end
+      end
+    end
+
+    context 'when the RSpec split by test examples is disabled' do
+      let(:rspec_split_by_test_examples_enabled) { false }
+
+      it { expect(subject).to be false }
+    end
+  end
+
+  describe '.test_file_cases_for' do
+    let(:slow_test_files) do
+      [
+        '1_spec.rb',
+        '2_spec.rb',
+        '3_spec.rb',
+        '4_spec.rb',
+        '5_spec.rb',
+      ]
+    end
+
+    subject { described_class.test_file_cases_for(slow_test_files) }
+
+    before do
+      logger = instance_double(Logger)
+      expect(KnapsackPro).to receive(:logger).and_return(logger)
+      expect(logger).to receive(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing 5 slow test files.")
+
+      cmd = 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector'
+      expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
+    end
+
+    context 'when the rake task to detect RSpec test examples succeeded' do
+      let(:cmd_result) { true }
+
+      it 'returns test example paths for slow test files' do
+        rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
+        expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
+
+        test_file_example_paths = double
+        expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
+
+        expect(subject).to eq test_file_example_paths
+      end
+    end
+
+    context 'when the rake task to detect RSpec test examples failed' do
+      let(:cmd_result) { false }
+
+      it do
+        expect { subject }.to raise_error(RuntimeError, 'Could not generate JSON report for RSpec. Rake task failed when running RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector')
+      end
+    end
+  end
+
   describe '.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!' do
     let(:cli_args) { double }
 

data/spec/knapsack_pro/base_allocator_builder_spec.rb

@@ -117,8 +117,8 @@ describe KnapsackPro::BaseAllocatorBuilder do
   describe '#fast_and_slow_test_files_to_run' do
     subject { allocator_builder.fast_and_slow_test_files_to_run }
 
-    context 'when looking for test files on disk by default' do
-      it do
+    context 'when split by test cases disabled' do
+      it 'returns test files to run based on test files on the disk' do
         test_file_pattern = double
         expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
 
@@ -129,70 +129,44 @@ describe KnapsackPro::BaseAllocatorBuilder do
       end
     end
 
-    context 'when RSpec adapter AND rspec split by test examples is enabled' do
-      let(:adapter_class) { KnapsackPro::Adapters::RSpecAdapter }
+    context 'when split by test cases enabled' do
       let(:test_files_to_run) { double }
-      let(:cmd) { 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector' }
 
-      before do
-        expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(true)
+      before  do
+        expect(adapter_class).to receive(:split_by_test_cases_enabled?).and_return(true)
 
         test_file_pattern = double
         expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
 
         expect(KnapsackPro::TestFileFinder).to receive(:call).with(test_file_pattern).and_return(test_files_to_run)
-      end
 
-      context 'when RSpec version < 3.3.0' do
-        before do
-          stub_const('RSpec::Core::Version::STRING', '3.2.0')
-        end
-
-        it do
-          expect { subject }.to raise_error RuntimeError, 'RSpec >= 3.3.0 is required to split test files by test examples. Learn more: https://knapsackpro.com/perma/ruby/split-by-test-examples'
-        end
+        expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
       end
 
-      context 'when rake task to detect RSpec test examples works' do
-        let(:slow_test_files) { double(size: 5) }
-        let(:cmd_result) { true }
-        let(:test_file_example_paths) { double }
-        let(:logger) { instance_double(Logger) }
-        let(:test_files_with_test_cases) { double }
-
-        before do
-          expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
-
-          expect(KnapsackPro).to receive(:logger).and_return(logger)
-
-          expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
-
-          rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
-          expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
-          expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
-
-          expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_example_paths).and_return(test_files_with_test_cases)
+      context 'when slow test files are detected' do
+        let(:slow_test_files) do
+          [
+            '1_spec.rb',
+            '2_spec.rb',
+          ]
         end
 
-        it do
-          expect(logger).to receive(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual 'it's. Thanks to that a single slow test file can be split across parallel CI nodes). Analyzing 5 slow test files.")
+        it 'returns test files with test cases' do
+          test_file_cases = double
+          expect(adapter_class).to receive(:test_file_cases_for).with(slow_test_files).and_return(test_file_cases)
+
+          test_files_with_test_cases = double
+          expect(KnapsackPro::TestFilesWithTestCasesComposer).to receive(:call).with(test_files_to_run, slow_test_files, test_file_cases).and_return(test_files_with_test_cases)
 
           expect(subject).to eq test_files_with_test_cases
         end
       end
 
-      context 'when rake task to detect RSpec test examples failed' do
-        let(:slow_test_files) { double(size: 5) }
-        let(:cmd_result) { false }
-
-        before do
-          expect(allocator_builder).to receive(:get_slow_test_files).and_return(slow_test_files)
-
-          expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
-        end
+      context 'when slow test files are not detected' do
+        let(:slow_test_files) { [] }
 
-        it do
-          expect { subject }.to raise_error(RuntimeError, 'Could not generate JSON report for RSpec. Rake task failed when running RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector')
+        it 'returns test files without test cases' do
+          expect(subject).to eq test_files_to_run
         end
       end
     end

data/spec/knapsack_pro/client/connection_spec.rb

@@ -282,15 +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
@@ -311,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
@@ -334,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
@@ -358,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 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.7.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake