cli.rb in parallel_tests-3.5.0

- old
+ new

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require 'optparse'
 require 'tempfile'
 require 'parallel_tests'
 require 'shellwords'
 require 'pathname'
@@ -12,11 +13,11 @@
       options = parse_options!(argv)
 
       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?
 
       if options[:execute]
         execute_shell_command_in_parallel(options[:execute], num_processes, options)
@@ -54,16 +55,16 @@
     end
 
     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)
           end
         else
@@ -73,11 +74,11 @@
             run_tests(group, groups.index(group), num_processes, options)
           end
         end
 
         report_results(test_results, options) unless options[:quiet]
-      }
+      end
 
       if options[:quiet]
         run_tests_proc.call
       else
         report_time_taken(&run_tests_proc)
@@ -86,11 +87,11 @@
       abort final_fail_message if any_test_failed?(test_results)
     end
 
     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
     end
 
@@ -113,11 +114,11 @@
         end
       end
     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)
 
       report_failure_rerun_commmand(test_results, options)
     end
@@ -138,24 +139,35 @@
     end
 
     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
 
-    #exit with correct status code so rake parallel:test && echo 123 works
+    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
     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:
             parallel_test test/bar test/baz/xxx_text.rb
 
@@ -165,82 +177,101 @@
           Options are:
         BANNER
         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 }
+        ) { |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("-s [PATTERN]", "--single [PATTERN]",
-          "Run all matching files in the same process") do |pattern|
-
-          options[:single_process] ||= []
-          options[:single_process] << /#{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 |pattern|
-
+        opts.on("-i", "--isolate", "Do not run any other tests in the group used by --single(-s)") do
           options[:isolate] = true
         end
 
-        opts.on("--isolate-n [PROCESSES]",
+        opts.on(
+          "--isolate-n [PROCESSES]",
           Integer,
-          "Use 'isolate'  singles with number of processes, default: 1.") do |n|
-          options[:isolate_count] = n
-        end
+          "Use 'isolate'  singles with number of processes, default: 1."
+        ) { |n| options[:isolate_count] = n }
 
-        opts.on("--only-group INT[, INT]", Array) { |groups| options[:only_group] = groups.map(&:to_i) }
+        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 }
         opts.on("-t", "--type [TYPE]", "test(default) / rspec / cucumber / spinach") do |type|
           begin
             @runner = load_runner(type)
           rescue NameError, LoadError => e
             puts "Runner for `#{type}` type has not been found! (#{e})"
             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 }
         opts.on("--unknown-runtime [FLOAT]", Float, "Use given number as unknown runtime (otherwise use average time)") { |time| options[:unknown_runtime] = time }
         opts.on("--first-is-1", "Use \"1\" as TEST_ENV_NUMBER to not reuse the default test environment") { options[:first_is_1] = true }
         opts.on("--fail-fast", "Stop all groups when one group fails (best used with --test-options '--fail-fast' if supported") { options[:fail_fast] = true }
         opts.on("--verbose", "Print debug output") { options[:verbose] = true }
         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)
         options[:non_parallel] = true
       end
@@ -253,16 +284,22 @@
 
       append_test_options(options, remaining)
 
       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
 
     def extract_file_paths(argv)
       dash_index = argv.rindex("--")
@@ -270,11 +307,11 @@
       [argv[file_args_at..-1], argv[0...(dash_index || 0)]]
     end
 
     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)
       new_opts = extract_test_options(argv)
       return if new_opts.empty?
@@ -290,11 +327,11 @@
       klass_name.split('::').inject(Object) { |x, y| x.const_get(y) }
     end
 
     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
       results = if options[:non_parallel]
         ParallelTests.with_pid_file do
@@ -309,16 +346,16 @@
       end.flatten
 
       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})"
     end
 