parallel_tests 3.1.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0830430a73f9d4366617a98f2014e8b737b8f987a284ac959b0e83e8b0d7da1
-  data.tar.gz: 358bd27a736baec67ef7775d16d8dd2b935f69f25ca71d7065e3343fea8feee6
+  metadata.gz: b8539140ebc96ac00552e9f1e51f63789f1007a997829d86e79a786a71400b7b
+  data.tar.gz: be0f3f0785cd3b05882f9928a9fe83a6e10203a95e931b40f89566f1398e0691
 SHA512:
-  metadata.gz: 18e2aae47f9ceb0d933ac37bde90fda6936febcbd5381b48c70be9f923a347fc79116996f36c532ba9e3efc14bbf249dfd3eb697d89d80b85578bf9ebd9cb2ae
-  data.tar.gz: a6768ac48b991d984475921f64e7a7262e530303f150e9ee3e5d5322a8a34ee2a660af8ab626eda535c1be593fbf422049ac423f6bdbe0ee6292c9efc5e1603f
+  metadata.gz: 3bd0cfd72dd3a48b491198a5d2be73bb353dbdd5d1cd23cfac58f2429d44fe6b1ce6121c2ba6caed76c4b3c4aa4646fde9ef030dfd1d0a38fe30499e1a2ea38d
+  data.tar.gz: 10493da0d865c2e3987c8c11edb8a8605349d23a754bcb70ba05e1579a5f9a8693e9e80730b5c8d601b66efe4406bdf14b50a3ec3ce305a339d07075f5c77d51

data/Readme.md

@@ -37,6 +37,9 @@ test:
 ### Copy development schema (repeat after migrations)
     rake parallel:prepare
 
+### Run migrations in additional database(s) (repeat after migrations)
+    rake parallel:migrate
+
 ### Setup environment from scratch (create db and loads schema, useful for CI)
     rake parallel:setup
 
@@ -82,6 +85,8 @@ Running things once
 ===================
 
 ```Ruby
+require "parallel_tests"
+
 # preparation:
 # affected by race-condition: first process may boot slower than the second
 # either sleep a bit or use a lock for example File.lock
@@ -97,7 +102,6 @@ at_exit do
     undo_something
   end
 end
-
 ```
 
 Even test group run-times
@@ -141,17 +145,19 @@ Add the following to your `.rspec_parallel` (or `.rspec`) :
 RSpec: FailuresLogger
 -----------------------
 
-Produce pasteable command-line snippets for each failed example.
-
-E.g.
+Produce pastable command-line snippets for each failed example. For example:
 
-    rspec /path/to/my_spec.rb:123 # should do something
+```bash
+rspec /path/to/my_spec.rb:123 # should do something
+```
 
-Add the following to your `.rspec_parallel` (or `.rspec`) :
+Add to `.rspec_parallel` or use as CLI flag:
 
     --format progress
     --format ParallelTests::RSpec::FailuresLogger --out tmp/failing_specs.log
 
+(Not needed to retry failures, for that pass [--only-failures](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rspec)
+
 Cucumber: FailuresLogger
 -----------------------
 
@@ -204,8 +210,19 @@ Options are:
           default - runtime when runtime log is filled otherwise filesize
     -m, --multiply-processes [FLOAT] use given number as a multiplier of processes to run
     -s, --single [PATTERN]           Run all matching files in the same process
-    -i, --isolate                    Do not run any other tests in the group used by --single(-s)
-        --only-group INT[, INT]
+    -i, --isolate                    Do not run any other tests in the group used by --single(-s).
+                                     Automatically turned on if --isolate-n is set above 0.
+        --isolate-n                  Number of processes for isolated groups. Default to 1 when --isolate is on.
+        --specify-groups [SPECS]     Use 'specify-groups' if you want to specify multiple specs running in multiple
+                                     processes in a specific formation. Commas indicate specs in the same process,
+                                     pipes indicate specs in a new process.  Cannot use with --single, --isolate, or
+                                     --isolate-n.  Ex.
+                                     Ex.
+                                     $ parallel_tests -n 3 . --specify-groups '1_spec.rb,2_spec.rb|3_spec.rb'
+                                       Process 1 will contain 1_spec.rb and 2_spec.rb
+                                       Process 2 will contain 3_spec.rb
+                                       Process 3 will contain all other specs
+        --only-group INT[,INT]
     -e, --exec [COMMAND]             execute this code parallel and with ENV['TEST_ENV_NUMBER']
     -o, --test-options '[OPTIONS]'   execute test commands with those options
     -t, --type [TYPE]                test(default) / rspec / cucumber / spinach
@@ -258,7 +275,7 @@ TIPS
  - Use [rspec-retry](https://github.com/NoRedInk/rspec-retry) (not rspec-rerun) to rerun failed tests.
  - [JUnit formatter configuration](https://github.com/grosser/parallel_tests/wiki#with-rspec_junit_formatter----by-jgarber)
  - Use [parallel_split_test](https://github.com/grosser/parallel_split_test) to run multiple scenarios in a single spec file, concurrently. (`parallel_tests` [works at the file-level and intends to stay that way](https://github.com/grosser/parallel_tests/issues/747#issuecomment-580216980))
- 
+
 ### Cucumber
 
  - Add a `parallel: foo` profile to your `config/cucumber.yml` and it will be used to run parallel tests
@@ -279,7 +296,7 @@ TIPS
    `export PARALLEL_TEST_FIRST_IS_1=true` will provide the same result
  - [email_spec and/or action_mailer_cache_delivery](https://github.com/grosser/parallel_tests/wiki)
  - [zeus-parallel_tests](https://github.com/sevos/zeus-parallel_tests)
- - [Distributed parallel test (e.g. Travis Support)](https://github.com/grosser/parallel_tests/wiki/Distributed-Parallel-Tests-and-Travis-Support)
+ - [Distributed Parallel Tests on CI systems)](https://github.com/grosser/parallel_tests/wiki/Distributed-Parallel-Tests-on-CI-systems) learn how `parallel_tests` can run on distributed servers such as Travis and GitLab-CI. Also shows you how to use parallel_tests without adding `TEST_ENV_NUMBER`-backends
  - [Capybara setup](https://github.com/grosser/parallel_tests/wiki)
  - [Sphinx setup](https://github.com/grosser/parallel_tests/wiki)
  - [Capistrano setup](https://github.com/grosser/parallel_tests/wiki/Remotely-with-capistrano) let your tests run on a big box instead of your laptop
@@ -375,6 +392,8 @@ inspired by [pivotal labs](https://blog.pivotal.io/labs/labs/parallelize-your-rs
  - [Calaway](https://github.com/calaway)
  - [alboyadjian](https://github.com/alboyadjian)
  - [Nathan Broadbent](https://github.com/ndbroadbent)
+ - [Vikram B Kumar](https://github.com/v-kumar)
+ - [Joshua Pinter](https://github.com/joshuapinter)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/bin/parallel_cucumber

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_rspec

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_spinach

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/bin/parallel_test

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # enable local usage from cloned repo
-root = File.expand_path("../..", __FILE__)
+root = File.expand_path('..', __dir__)
 $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require "parallel_tests"

data/lib/parallel_tests.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "parallel"
 require "parallel_tests/railtie" if defined? Rails::Railtie
 require "rbconfig"
@@ -17,7 +18,7 @@ module ParallelTests
         count,
         ENV["PARALLEL_TEST_PROCESSORS"],
         Parallel.processor_count
-      ].detect{|c| not c.to_s.strip.empty? }.to_i
+      ].detect { |c| !c.to_s.strip.empty? }.to_i
     end
 
     def with_pid_file
@@ -57,7 +58,8 @@ module ParallelTests
       until !File.directory?(current) || current == previous
         filename = File.join(current, "Gemfile")
         return true if File.exist?(filename)
-        current, previous = File.expand_path("..", current), current
+        previous = current
+        current = File.expand_path("..", current)
       end
 
       false

data/lib/parallel_tests/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 require 'tempfile'
 require 'parallel_tests'
@@ -14,7 +15,7 @@ module ParallelTests
       ENV['DISABLE_SPRING'] ||= '1'
 
       num_processes = ParallelTests.determine_number_of_processes(options[:count])
-      num_processes = num_processes * (options[:multiply] || 1)
+      num_processes *= (options[:multiply] || 1)
 
       options[:first_is_1] ||= first_is_1?
 
@@ -56,12 +57,12 @@ module ParallelTests
     def run_tests_in_parallel(num_processes, options)
       test_results = nil
 
-      run_tests_proc = -> {
+      run_tests_proc = -> do
         groups = @runner.tests_in_groups(options[:files], num_processes, options)
-        groups.reject! &:empty?
+        groups.reject!(&:empty?)
 
         test_results = if options[:only_group]
-          groups_to_run = options[:only_group].collect{|i| groups[i - 1]}.compact
+          groups_to_run = options[:only_group].map { |i| groups[i - 1] }.compact
           report_number_of_tests(groups_to_run) unless options[:quiet]
           execute_in_parallel(groups_to_run, groups_to_run.size, options) do |group|
             run_tests(group, groups_to_run.index(group), 1, options)
@@ -75,7 +76,7 @@ module ParallelTests
         end
 
         report_results(test_results, options) unless options[:quiet]
-      }
+      end
 
       if options[:quiet]
         run_tests_proc.call
@@ -88,7 +89,7 @@ module ParallelTests
 
     def run_tests(group, process_number, num_processes, options)
       if group.empty?
-        {:stdout => '', :exit_status => 0, :command => '', :seed => nil}
+        { stdout: '', exit_status: 0, command: '', seed: nil }
       else
         @runner.run_tests(group, process_number, num_processes, options)
       end
@@ -115,7 +116,7 @@ module ParallelTests
     end
 
     def report_results(test_results, options)
-      results = @runner.find_results(test_results.map { |result| result[:stdout] }*"")
+      results = @runner.find_results(test_results.map { |result| result[:stdout] } * "")
       puts ""
       puts @runner.summarize_results(results)
 
@@ -140,20 +141,31 @@ module ParallelTests
     def report_number_of_tests(groups)
       name = @runner.test_file_name
       num_processes = groups.size
-      num_tests = groups.map(&:size).inject(0, :+)
+      num_tests = groups.map(&:size).sum
       tests_per_process = (num_processes == 0 ? 0 : num_tests / num_processes)
-      puts "#{num_processes} processes for #{num_tests} #{name}s, ~ #{tests_per_process} #{name}s per process"
+      puts "#{pluralize(num_processes, 'process')} for #{pluralize(num_tests, name)}, ~ #{pluralize(tests_per_process, name)} per process"
+    end
+
+    def pluralize(n, singular)
+      if n == 1
+        "1 #{singular}"
+      elsif singular.end_with?('s', 'sh', 'ch', 'x', 'z')
+        "#{n} #{singular}es"
+      else
+        "#{n} #{singular}s"
+      end
     end
 
-    #exit with correct status code so rake parallel:test && echo 123 works
+    # exit with correct status code so rake parallel:test && echo 123 works
     def any_test_failed?(test_results)
       test_results.any? { |result| result[:exit_status] != 0 }
     end
 
     def parse_options!(argv)
+      newline_padding = " " * 37
       options = {}
       OptionParser.new do |opts|
-        opts.banner = <<-BANNER.gsub(/^          /, '')
+        opts.banner = <<~BANNER
           Run all tests in parallel, giving each process ENV['TEST_ENV_NUMBER'] ('', '2', '3', ...)
 
           [optional] Only selected files & folders:
@@ -167,32 +179,51 @@ module ParallelTests
         opts.on("-n [PROCESSES]", Integer, "How many processes to use, default: available CPUs") { |n| options[:count] = n }
         opts.on("-p", "--pattern [PATTERN]", "run tests matching this regex pattern") { |pattern| options[:pattern] = /#{pattern}/ }
         opts.on("--exclude-pattern", "--exclude-pattern [PATTERN]", "exclude tests matching this regex pattern") { |pattern| options[:exclude_pattern] = /#{pattern}/ }
-        opts.on("--group-by [TYPE]", <<-TEXT.gsub(/^          /, '')
-          group tests by:
-                    found - order of finding files
-                    steps - number of cucumber/spinach steps
-                    scenarios - individual cucumber scenarios
-                    filesize - by size of the file
-                    runtime - info from runtime log
-                    default - runtime when runtime log is filled otherwise filesize
+        opts.on(
+          "--group-by [TYPE]",
+          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+            group tests by:
+            found - order of finding files
+            steps - number of cucumber/spinach steps
+            scenarios - individual cucumber scenarios
+            filesize - by size of the file
+            runtime - info from runtime log
+            default - runtime when runtime log is filled otherwise filesize
           TEXT
-          ) { |type| options[:group_by] = type.to_sym }
-        opts.on("-m [FLOAT]", "--multiply-processes [FLOAT]", Float, "use given number as a multiplier of processes to run") { |multiply| options[:multiply] = multiply }
-
-        opts.on("-s [PATTERN]", "--single [PATTERN]",
-          "Run all matching files in the same process") do |pattern|
-
-          options[:single_process] ||= []
-          options[:single_process] << /#{pattern}/
+        ) { |type| options[:group_by] = type.to_sym }
+        opts.on("-m [FLOAT]", "--multiply-processes [FLOAT]", Float, "use given number as a multiplier of processes to run") do |multiply|
+          options[:multiply] = multiply
         end
 
-        opts.on("-i", "--isolate",
-          "Do not run any other tests in the group used by --single(-s)") do |pattern|
+        opts.on("-s [PATTERN]", "--single [PATTERN]", "Run all matching files in the same process") do |pattern|
+          (options[:single_process] ||= []) << /#{pattern}/
+        end
 
+        opts.on("-i", "--isolate", "Do not run any other tests in the group used by --single(-s)") do
           options[:isolate] = true
         end
 
-        opts.on("--only-group INT[, INT]", Array) { |groups| options[:only_group] = groups.map(&:to_i) }
+        opts.on(
+          "--isolate-n [PROCESSES]",
+          Integer,
+          "Use 'isolate'  singles with number of processes, default: 1."
+        ) { |n| options[:isolate_count] = n }
+
+        opts.on(
+          "--specify-groups [SPECS]",
+          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+            Use 'specify-groups' if you want to specify multiple specs running in multiple
+            processes in a specific formation. Commas indicate specs in the same process,
+            pipes indicate specs in a new process. Cannot use with --single, --isolate, or
+            --isolate-n.  Ex.
+            $ parallel_tests -n 3 . --specify-groups '1_spec.rb,2_spec.rb|3_spec.rb'
+              Process 1 will contain 1_spec.rb and 2_spec.rb
+              Process 2 will contain 3_spec.rb
+              Process 3 will contain all other specs
+          TEXT
+        ) { |groups| options[:specify_groups] = groups }
+
+        opts.on("--only-group INT[,INT]", Array) { |groups| options[:only_group] = groups.map(&:to_i) }
 
         opts.on("-e", "--exec [COMMAND]", "execute this code parallel and with ENV['TEST_ENV_NUMBER']") { |path| options[:execute] = path }
         opts.on("-o", "--test-options '[OPTIONS]'", "execute test commands with those options") { |arg| options[:test_options] = arg.lstrip }
@@ -204,18 +235,20 @@ module ParallelTests
             abort
           end
         end
-        opts.on("--suffix [PATTERN]", <<-TEXT.gsub(/^          /, '')
-          override built in test file pattern (should match suffix):
-                    '_spec\.rb$' - matches rspec files
-                    '_(test|spec).rb$' - matches test or spec files
+        opts.on(
+          "--suffix [PATTERN]",
+          <<~TEXT.rstrip.split("\n").join("\n#{newline_padding}")
+            override built in test file pattern (should match suffix):
+            '_spec\.rb$' - matches rspec files
+            '_(test|spec).rb$' - matches test or spec files
           TEXT
-          ) { |pattern| options[:suffix] = /#{pattern}/ }
+        ) { |pattern| options[:suffix] = /#{pattern}/ }
         opts.on("--serialize-stdout", "Serialize stdout output, nothing will be written until everything is done") { options[:serialize_stdout] = true }
         opts.on("--prefix-output-with-test-env-number", "Prefixes test env number to the output when not using --serialize-stdout") { options[:prefix_output_with_test_env_number] = true }
         opts.on("--combine-stderr", "Combine stderr into stdout, useful in conjunction with --serialize-stdout") { options[:combine_stderr] = true }
         opts.on("--non-parallel", "execute same commands but do not in parallel, needs --exec") { options[:non_parallel] = true }
         opts.on("--no-symlinks", "Do not traverse symbolic links to find test files") { options[:symlinks] = false }
-        opts.on('--ignore-tags [PATTERN]', 'When counting steps ignore scenarios with tags that match this pattern')  { |arg| options[:ignore_tag_pattern] = arg }
+        opts.on('--ignore-tags [PATTERN]', 'When counting steps ignore scenarios with tags that match this pattern') { |arg| options[:ignore_tag_pattern] = arg }
         opts.on("--nice", "execute test commands with low priority.") { options[:nice] = true }
         opts.on("--runtime-log [PATH]", "Location of previously recorded test runtimes") { |path| options[:runtime_log] = path }
         opts.on("--allowed-missing [INT]", Integer, "Allowed percentage of missing runtimes (default = 50)") { |percent| options[:allowed_missing_percent] = percent }
@@ -226,13 +259,17 @@ module ParallelTests
         opts.on("--verbose-process-command", "Displays only the command that will be executed by each process") { options[:verbose_process_command] = true }
         opts.on("--verbose-rerun-command", "When there are failures, displays the command executed by each process that failed") { options[:verbose_rerun_command] = true }
         opts.on("--quiet", "Print only tests output") { options[:quiet] = true }
-        opts.on("-v", "--version", "Show Version") { puts ParallelTests::VERSION; exit }
-        opts.on("-h", "--help", "Show this.") { puts opts; exit }
+        opts.on("-v", "--version", "Show Version") do
+          puts ParallelTests::VERSION
+          exit 0
+        end
+        opts.on("-h", "--help", "Show this.") do
+          puts opts
+          exit 0
+        end
       end.parse!(argv)
 
-      if options[:verbose] && options[:quiet]
-        raise "Both options are mutually exclusive: verbose & quiet"
-      end
+      raise "Both options are mutually exclusive: verbose & quiet" if options[:verbose] && options[:quiet]
 
       if options[:count] == 0
         options.delete(:count)
@@ -249,12 +286,18 @@ module ParallelTests
 
       options[:group_by] ||= :filesize if options[:only_group]
 
-      raise "--group-by found and --single-process are not supported" if options[:group_by] == :found and options[:single_process]
+      if options[:group_by] == :found && options[:single_process]
+        raise "--group-by found and --single-process are not supported"
+      end
       allowed = [:filesize, :runtime, :found]
       if !allowed.include?(options[:group_by]) && options[:only_group]
         raise "--group-by #{allowed.join(" or ")} is required for --only-group"
       end
 
+      if options[:specify_groups] && (options.keys & [:single_process, :isolate, :isolate_count]).any?
+        raise "Can't pass --specify-groups with any of these keys: --single, --isolate, or --isolate-n"
+      end
+
       options
     end
 
@@ -266,7 +309,7 @@ module ParallelTests
 
     def extract_test_options(argv)
       dash_index = argv.index("--") || -1
-      argv[dash_index+1..-1]
+      argv[dash_index + 1..-1]
     end
 
     def append_test_options(options, argv)
@@ -286,7 +329,7 @@ module ParallelTests
 
     def execute_shell_command_in_parallel(command, num_processes, options)
       runs = if options[:only_group]
-        options[:only_group].map{|g| g - 1}
+        options[:only_group].map { |g| g - 1 }
       else
         (0...num_processes).to_a
       end
@@ -305,13 +348,13 @@ module ParallelTests
       abort if results.any? { |r| r[:exit_status] != 0 }
     end
 
-    def report_time_taken
-      seconds = ParallelTests.delta { yield }.to_i
+    def report_time_taken(&block)
+      seconds = ParallelTests.delta(&block).to_i
       puts "\nTook #{seconds} seconds#{detailed_duration(seconds)}"
     end
 
     def detailed_duration(seconds)
-      parts = [ seconds / 3600, seconds % 3600 / 60, seconds % 60 ].drop_while(&:zero?)
+      parts = [seconds / 3600, seconds % 3600 / 60, seconds % 60].drop_while(&:zero?)
       return if parts.size < 2
       parts = parts.map { |i| "%02d" % i }.join(':').sub(/^0/, '')
       " (#{parts})"

data/lib/parallel_tests/cucumber/failures_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/formatter/rerun'
 require 'parallel_tests/gherkin/io'
 
@@ -21,7 +22,6 @@ module ParallelTests
           end
         end
       end
-
     end
   end
 end