semaphore_test_boosters 2.2.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9b81adbced4c33522f4e33249abdec12d731839
-  data.tar.gz: 6854ab8456f245a05cc349043d99c54ca8b2ee82
+  metadata.gz: 502cd665598a91e82706246e1f4ce9ec49f74d42
+  data.tar.gz: d30decefa24819ecaf7b9e81496bb9f67fb5255a
 SHA512:
-  metadata.gz: 1702c760ab390cc4483c8d68b9b7f63cb54aac1a5859ae816ec74aa5496812c96c77f6f779a1fdd1389e54f87eb19be685ae18f0910cdb022d3545d4d44c28a1
-  data.tar.gz: 44ff6f24265265b3a58a57c8219897172245848a4356e54eafd63860efc1c2a6dd1b296a2715949c30dcbfb7fbd0d2414aa0a496b9ecb173457ba5879aeb31b6
+  metadata.gz: 8d5625893720c3d00920a712ae5ea306cb179043c52c692fdb2d19dc4d69646fff8243e7a84f2e0acb7ef3648f617a6c72fddd7b3d2e69fb034805cfdb8b4944
+  data.tar.gz: 6e57270af8ed571fd2350ea023e7bffd13aa5fa75109014e987080c949865d18afa6889a740c3b833f852516af7d6097962a8ffa1585e1405e0a14ec160afa80

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

@@ -18,6 +18,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 +31,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

data/lib/test_boosters/boosters/minitest.rb

@@ -9,13 +9,33 @@ module TestBoosters
       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, 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,9 @@ 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
     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/shell.rb

@@ -12,9 +12,12 @@ module TestBoosters
         system(command)
       end
 
+      signaled    = $?.signaled?
+      termsig     = $?.termsig
       exited      = $?.exited?
       exit_status = $?.exitstatus
 
+      TestBoosters::Logger.info("Command signaled with: #{termsig}") if signaled
       TestBoosters::Logger.info("Command exited : #{exited}")
       TestBoosters::Logger.info("Command finished, exit status : #{exit_status}")
 

data/lib/test_boosters/version.rb

@@ -1,3 +1,3 @@
 module TestBoosters
-  VERSION = "2.2.3".freeze
+  VERSION = "2.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semaphore_test_boosters
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.6.0
 platform: ruby
 authors:
 - Developers at Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semaphore_cucumber_booster_config