semaphore_test_boosters 2.2.4 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2189a996558a44b4d0453251e6a3e96ba0b54016
-  data.tar.gz: c41de6015ae95d6b61c662a80a894426b9296e63
+  metadata.gz: 9539e2ccd028897753026672723046e6741cb3d2
+  data.tar.gz: 7a1a80632401a154f602e10909292f2f9284b608
 SHA512:
-  metadata.gz: d65a0867543561e731fbb2737d8d65b55a2321068888487fbf61e398ddeccdabfd0ebe7c156f361edfccb0674aec9daef82120286ba04332a951437b40cab0b3
-  data.tar.gz: 2b28fd345ad819625f404cb3052795fbb7fba3644db205aed05bf5a95c61581881f5e38e05098d75a78ef60effa2b61e4ebb2de8956098f7f1c491e09498327c
+  metadata.gz: bcbffca8de73d690246389ec3107a85999a3fe831d2889026074bfc4bd3ee90bc1267f0ca6337f68d6b7190c3791aeb39f07d8230386b9cf8a7404a9096565d1
+  data.tar.gz: 208e3cb145617be8dde5e7e4f4119cb8ac367a9ee5a7080f3299410c4ec57f4f1196ad0ce03a926c219d9507548d2e711914c0ffbdc5c2ad2d4b6bc7e1f0a664

data/README.md

@@ -122,16 +122,16 @@ bundle exec rspec --format documentation --format json --out /home/<user>/rspec_
 ```
 
 Optionally, you can pass additional RSpec flags with the `TB_RSPEC_OPTIONS`
-environment variable:
+environment variable. You can also set a RSpec formatter with the `TB_RSPEC_FORMATTER` environment variable.
+Default formatter is `documentation`.
 
-``` bash
-TB_RSPEC_OPTIONS='--fail-fast=3' rspec_booster --job 4/32
-```
-
-The above command will execute:
 
+Example:
 ``` bash
-bundle exec rspec --fail-fast=3 --format documentation --format json --out /home/<user>/rspec_report.json <file_list>
+TB_RSPEC_OPTIONS='--fail-fast=3' TB_RSPEC_FORMATTER=Fivemat rspec_booster --job 4/32
+
+# will execute:
+bundle exec rspec --fail-fast=3 --format Fivemat --format json --out /home/<user>/rspec_report.json <file_list>
 ```
 
 ## Cucumber Booster
@@ -164,12 +164,29 @@ Example of running job 4 out of 32 jobs:
 minitest_booster --job 4/32
 ```
 
-Under the hood, the Minitest Booster uses the following command:
+If minitest booster is executed in a scope of a Rails project, the following is
+executed:
+
+``` bash
+bundle exec rails test <file_list>
+```
+
+If minitest booster is running outside of a Rails project, the following is
+executed:
 
 ``` bash
 ruby -e 'ARGV.each { |f| require ".#{f}" }' <file_list>
 ```
 
+If you want to run a custom command for minitest, use the
+`MINITEST_BOOSTER_COMMAND` environment variable:
+
+``` bash
+export MINITEST_BOOSTER_COMMAND="bundle exec rake test"
+
+minitest_booster --job 1/42
+```
+
 ## ExUnit Booster
 
 The `ex_unit_booster` loads all the files that match the `test/**/*_test.exs`

data/lib/test_boosters/boosters/base.rb

@@ -2,9 +2,10 @@ module TestBoosters
   module Boosters
     class Base
 
-      def initialize(file_pattern, split_configuration_path, command)
+      def initialize(file_pattern, exclude_pattern, split_configuration_path, command)
         @command = command
         @file_pattern = file_pattern
+        @exclude_pattern = exclude_pattern
         @split_configuration_path = split_configuration_path
       end
 
@@ -18,6 +19,12 @@ module TestBoosters
 
         known, leftover = distribution.files_for(job_index)
 
+        if cli_options[:dry_run]
+          show_files_for_dry_run("known", known)
+          show_files_for_dry_run("leftover", leftover)
+          return 0
+        end
+
         exit_status = TestBoosters::Job.run(@command, known, leftover)
 
         after_job # execute some activities when the job finishes
@@ -25,6 +32,16 @@ module TestBoosters
         exit_status
       end
 
+      def show_files_for_dry_run(label, files)
+        if files.empty?
+          puts "[DRY RUN] No #{label} files."
+          return
+        end
+
+        puts "\n[DRY RUN] Running tests for #{label} files:"
+        puts files.map { |file| "- #{file}" }.join("\n")
+      end
+
       def before_job
         # Do nothing
       end
@@ -43,6 +60,7 @@ module TestBoosters
       def distribution
         @distribution ||= TestBoosters::Files::Distributor.new(@split_configuration_path,
                                                                @file_pattern,
+                                                               @exclude_pattern,
                                                                job_count)
       end
 

data/lib/test_boosters/boosters/cucumber.rb

@@ -5,7 +5,7 @@ module TestBoosters
       FILE_PATTERN = "features/**/*.feature".freeze
 
       def initialize
-        super(FILE_PATTERN, split_configuration_path, "bundle exec cucumber")
+        super(FILE_PATTERN, nil, split_configuration_path, "bundle exec cucumber")
       end
 
       def before_job

data/lib/test_boosters/boosters/ex_unit.rb

@@ -5,7 +5,7 @@ module TestBoosters
       FILE_PATTERN = "test/**/*_test.exs".freeze
 
       def initialize
-        super(FILE_PATTERN, split_configuration_path, "mix test")
+        super(FILE_PATTERN, nil, split_configuration_path, "mix test")
       end
 
       def split_configuration_path

data/lib/test_boosters/boosters/go_test.rb

@@ -5,7 +5,7 @@ module TestBoosters
       FILE_PATTERN = "**/*/*_test.go".freeze
 
       def initialize
-        super(FILE_PATTERN, split_configuration_path, "go test")
+        super(FILE_PATTERN, nil, split_configuration_path, "go test")
       end
 
       def split_configuration_path

data/lib/test_boosters/boosters/minitest.rb

@@ -5,17 +5,37 @@ module TestBoosters
       FILE_PATTERN = "test/**/*_test.rb".freeze
 
       def initialize
-        super(FILE_PATTERN, split_configuration_path, command)
+        super(FILE_PATTERN, nil, split_configuration_path, command)
       end
 
       def command
-        "ruby -e 'ARGV.each { |f| require \"./\#{f}\" }'"
+        if command_set_with_env_var?
+          command_from_env_var
+        elsif rails_app?
+          "bundle exec rails test"
+        else
+          "ruby -e 'ARGV.each { |f| require \"./\#{f}\" }'"
+        end
       end
 
       def split_configuration_path
         ENV["MINITEST_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/minitest_split_configuration.json"
       end
 
+      def command_set_with_env_var?
+        !command_from_env_var.empty?
+      end
+
+      def command_from_env_var
+        ENV["MINITEST_BOOSTER_COMMAND"].to_s
+      end
+
+      private
+
+      def rails_app?
+        File.exist?("app") && File.exist?("config") && File.exist?("config/application.rb")
+      end
+
     end
   end
 end

data/lib/test_boosters/boosters/rspec.rb

@@ -1,11 +1,8 @@
 module TestBoosters
   module Boosters
     class Rspec < Base
-
-      FILE_PATTERN = "spec/**/*_spec.rb".freeze
-
       def initialize
-        super(FILE_PATTERN, split_configuration_path, command)
+        super(file_pattern, exclude_pattern, split_configuration_path, command)
       end
 
       def display_header
@@ -25,8 +22,11 @@ module TestBoosters
       end
 
       def rspec_options
-        # rubocop:disable LineLength
-        @rspec_options ||= "#{ENV["TB_RSPEC_OPTIONS"]} --format documentation --require #{formatter_path} --format SemaphoreFormatter --out #{report_path}"
+        @rspec_options ||= begin
+          output_formatter = ENV.fetch("TB_RSPEC_FORMATTER", "documentation")
+          # rubocop:disable LineLength
+          "#{ENV["TB_RSPEC_OPTIONS"]} --format #{output_formatter} --require #{formatter_path} --format SemaphoreFormatter --out #{report_path}"
+        end
       end
 
       def report_path
@@ -41,6 +41,13 @@ module TestBoosters
         @formatter_path ||= File.join(::TestBoosters::ROOT_PATH, "rspec_formatters/semaphore_rspec3_json_formatter.rb")
       end
 
+      def file_pattern
+        ENV["TEST_BOOSTERS_RSPEC_TEST_FILE_PATTERN"] || "spec/**/*_spec.rb"
+      end
+
+      def exclude_pattern
+        ENV["TEST_BOOSTERS_RSPEC_TEST_EXCLUDE_PATTERN"]
+      end
     end
   end
 end

data/lib/test_boosters/cli_parser.rb

@@ -9,15 +9,28 @@ module TestBoosters
       options = {}
 
       parser = OptionParser.new do |opts|
-        opts.on("--thread INDEX") do |parameter|
+        opts.on(
+          "--thread INDEX",
+          "[DEPRECATED] Use the '--job' option instead"
+        ) do |parameter|
           puts "[DEPRECATION WARNING] The '--thread' parameter is deprecated. Please use '--job' instead."
 
           options.merge!(parse_job_params(parameter))
         end
 
-        opts.on("--job INDEX") do |parameter|
+        opts.on(
+          "--job INDEX",
+          "The job index and number of total jobs. e.g. --job 4/32"
+        ) do |parameter|
           options.merge!(parse_job_params(parameter))
         end
+
+        opts.on(
+          "--dry-run",
+          "Only print the files that will be run for this job index"
+        ) do |parameter|
+          options.merge!(:dry_run => parameter)
+        end
       end
 
       parser.parse!
@@ -25,7 +38,7 @@ module TestBoosters
       options
     end
 
-    # parses input like '1/32' and ouputs { :job_index => 1, :job_count => 32 }
+    # parses input like '1/32' and outputs { :job_index => 1, :job_count => 32 }
     def parse_job_params(input_parameter)
       job_index, job_count, _rest = input_parameter.split("/")
 

data/lib/test_boosters/files/distributor.rb

@@ -6,9 +6,10 @@ module TestBoosters
     #
     class Distributor
 
-      def initialize(split_configuration_path, file_pattern, job_count)
+      def initialize(split_configuration_path, file_pattern, exclude_pattern, job_count)
         @split_configuration_path = split_configuration_path
         @file_pattern = file_pattern
+        @exclude_pattern = exclude_pattern
         @job_count = job_count
       end
 
@@ -26,7 +27,11 @@ module TestBoosters
       end
 
       def all_files
-        @all_files ||= Dir[@file_pattern].sort
+        @all_files ||= begin
+          files = Dir[@file_pattern].sort
+          files -= Dir[@exclude_pattern] if @exclude_pattern
+          files
+        end
       end
 
       private

data/lib/test_boosters/version.rb

@@ -1,3 +1,3 @@
 module TestBoosters
-  VERSION = "2.2.4".freeze
+  VERSION = "2.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semaphore_test_boosters
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.7.0
 platform: ruby
 authors:
 - Developers at Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semaphore_cucumber_booster_config