forking_test_runner 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ac83a5a2c478db627543f6aa682c2b8ecc32fdd
-  data.tar.gz: 3c0a8b85d8ee654287f57582027625fbe2ca8a07
+  metadata.gz: 989a8330a49520c4aaa7d1a073f5a9ab216793cf
+  data.tar.gz: 983e7875d09eb54246efd8f8859d0f1c3a81387c
 SHA512:
-  metadata.gz: ee1ca158532118e09bbcfd11e522a69e84cdcfc954f92d8bab55956b24c8e3eb523cf2b042d26b2ea28c3ebc851e73d8e45691fac4b7727243ff868a65964a97
-  data.tar.gz: 01302ee774cd197531acd520bf228401b6ccc4b0dbfa6a1c5a8dbf8ab98c7f169b6ce0983cb79f1c10ba3fb63a90352d97760f394a2b3e299aeb254cd8e2daa4
+  metadata.gz: e691f90b08041be6598d725959951bb7cc475e9cc98563cc32e9fb4f59d452d874c61bd60387b63effd1b4ce35b038dcf5b301282eca69569476755a49aa0ac0
+  data.tar.gz: 3e7633c9cbc4f11b946e7f9b6526f8a112faa3811cde9e49135de322fba9e56ad3ca1b4d86ed2b8e97866097a3ae53e073210a5f8a24dd12e51b1b59d9dd4596

data/lib/forking_test_runner/version.rb

@@ -1,3 +1,3 @@
 module ForkingTestRunner
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/forking_test_runner.rb

@@ -1,4 +1,5 @@
 require 'benchmark'
+require 'optparse'
 
 module ForkingTestRunner
   CLEAR = "------"
@@ -38,29 +39,18 @@ module ForkingTestRunner
 
   class << self
     def cli(argv)
-      @rspec = delete_argv("--rspec", argv, arg: false)
-      @no_fixtures = delete_argv("--no-fixtures", argv, arg: false)
-      @quiet = delete_argv("--quiet", argv, arg: false)
-      @merge_coverage = delete_argv("--merge-coverage", argv, arg: false)
-
-      if @merge_coverage
-        raise "merge_coverage does not work on ruby prior to 2.3" if RUBY_VERSION < "2.3.0"
-        require 'coverage'
-        klass = (class << Coverage; self; end)
-        klass.prepend CoverageCapture
-      end
+      @options, tests = parse_options(argv)
 
       disable_test_autorun
 
-      load_test_env(delete_argv("--helper", argv))
+      load_test_env(@options.fetch(:helper))
 
       # figure out what we need to run
-      record_runtime = delete_argv("--record-runtime", argv)
-      runtime_log = delete_argv("--runtime-log", argv)
-      group, group_count, tests = extract_group_args(argv)
+      runtime_log = @options.fetch(:runtime_log)
+      group, group_count = find_group_args
       tests = find_tests_for_group(group, group_count, tests, runtime_log)
 
-      if @quiet
+      if @options.fetch(:quiet)
         puts "Running #{tests.size} test files"
       else
         puts "Running tests #{tests.map(&:first).join(" ")}"
@@ -71,27 +61,27 @@ module ForkingTestRunner
         ActiveRecord::Base.connection.disconnect!
       end
 
-      Coverage.capture_coverage! if @merge_coverage
+      Coverage.capture_coverage! if @options.fetch(:merge_coverage)
 
       # run all the tests
       results = tests.map do |file, expected|
         puts "#{CLEAR} >>> #{file} "
         time, success, output = benchmark { run_test(file) }
 
-        puts output if !success && @quiet
+        puts output if !success && @options.fetch(:quiet)
 
-        if runtime_log && !@quiet
+        if runtime_log && !@options.fetch(:quiet)
           puts "Time: expected #{expected.round(2)}, actual #{time.round(2)}"
         end
 
-        if !success || !@quiet
+        if !success || !@options.fetch(:quiet)
           puts "#{CLEAR} <<< #{file} ---- #{success ? "OK" : "Failed"}"
         end
 
         [file, time, expected, output, success]
       end
 
-      unless @quiet
+      unless @options.fetch(:quiet)
         # pretty print the results
         puts "\nResults:"
         puts results.
@@ -110,10 +100,10 @@ module ForkingTestRunner
         puts "Time: #{diff.round(2)} diff to expected"
       end
 
-      if record_runtime
+      if mode = @options.fetch(:record_runtime)
         # store runtime log
         log = runtime_log || 'runtime.log'
-        record_test_runtime(record_runtime, results, log)
+        record_test_runtime(mode, results, log)
       end
 
       # exit with success or failure
@@ -131,7 +121,7 @@ module ForkingTestRunner
     end
 
     def summarize_results(results)
-      runner = if @rspec
+      runner = if @options.fetch(:rspec)
         require 'parallel_tests/rspec/runner'
         ParallelTests::RSpec::Runner
       else
@@ -174,36 +164,29 @@ module ForkingTestRunner
       end
     end
 
-    def extract_group_args(argv)
-      if argv.include?("--group")
+    def find_group_args
+      if @options.fetch(:group) && @options.fetch(:groups)
         # delete options we want while leaving others as they are (-v / --seed etc)
-        group, group_count = ['--group', '--groups'].map do |arg|
-          value = delete_argv(arg, argv) || raise("Did not find option #{arg}")
-          value.to_i
-        end
-        dir = argv.shift
-        raise "Unable to find directory #{dir.inspect}" unless File.exist?(dir.to_s)
-        tests = [dir]
+        group = @options.fetch(:group)
+        group_count = @options.fetch(:groups)
       else
         group = 1
         group_count = 1
-        size = argv.index { |arg| arg.start_with? "-" } || argv.size
-        tests = argv.slice!(0, size)
       end
 
-      [group, group_count, tests]
+      [group, group_count]
     end
 
     def load_test_env(helper=nil)
-      require 'rspec' if @rspec
-      helper = helper || (@rspec ? "spec/spec_helper" : "test/test_helper")
+      require 'rspec' if @options.fetch(:rspec)
+      helper = helper || (@options.fetch(:rspec) ? "spec/spec_helper" : "test/test_helper")
       require "./#{helper}"
     end
 
     # This forces Rails to load all fixtures, then prevents it from
     # "deleting and re-inserting all fixtures" when a new connection is used (forked).
     def preload_fixtures
-      return if @no_fixtures
+      return if @options.fetch(:no_fixtures)
 
       fixtures = (ActiveSupport::VERSION::MAJOR == 3 ? ActiveRecord::Fixtures : ActiveRecord::FixtureSet)
 
@@ -256,7 +239,7 @@ module ForkingTestRunner
 
     def run_test(file)
       output = change_program_name_to file do
-        fork_with_captured_output(!@quiet) do
+        fork_with_captured_output(!@options.fetch(:quiet)) do
           SimpleCov.pid = Process.pid if defined?(SimpleCov) && SimpleCov.respond_to?(:pid=) # trick simplecov into reporting in this fork
           if ar?
             key = (ActiveRecord::VERSION::STRING >= "4.1.0" ? :test : "test")
@@ -294,16 +277,6 @@ module ForkingTestRunner
       group.map { |test| [test, (tests[test] if group_by == :runtime)] }
     end
 
-    def delete_argv(name, argv, arg: true)
-      return unless index = argv.index(name)
-      argv.delete_at(index)
-      if arg
-        argv.delete_at(index) || raise("Missing argument for #{name}")
-      else
-        true
-      end
-    end
-
     def ar?
       defined?(ActiveRecord::Base)
     end
@@ -323,7 +296,7 @@ module ForkingTestRunner
     end
 
     def toggle_test_autorun(value, file=nil)
-      if @rspec
+      if @options.fetch(:rspec)
         if value
           exit(RSpec::Core::Runner.run([file] + ARGV))
         else
@@ -342,5 +315,84 @@ module ForkingTestRunner
         end
       end
     end
+
+    # we remove the args we understand and leave the rest alone
+    # so minitest / rspec can read their own options (--seed / -v ...)
+    #  - keep our options clear / unambiguous to avoid overriding
+    #  - read all serial non-flag arguments as tests and leave only unknown options behind
+    #  - use .fetch everywhere to make sure nothing is misspelled
+    # GOOD: test --ours --theirs
+    # OK: --ours test --theirs
+    # BAD: --theirs test --ours
+    def parse_options(argv)
+      arguments = [
+        [:rspec, "--rspec", "RSpec mode"],
+        [:helper, "--helper", "Helper file to load before tests start", String],
+        [:quiet, "--quiet", "Quiet"],
+        [:no_fixtures, "--no-fixtures", "Do not load fixtures"],
+        [:merge_coverage, "--merge-coverage", "Merge base code coverage into indvidual files coverage, great for SingleCov"],
+        [
+          :record_runtime,
+          "--record-runtime=MODE",
+          "\n      Record test runtime:\n" <<
+          "        simple = write to disk at --runtime-log)\n" <<
+          "        amend  = write from multiple remote workers via http://github.com/grosser/amend, needs TRAVIS_REPO_SLUG & TRAVIS_BUILD_NUMBER",
+          String
+        ],
+        [:runtime_log, "--runtime-log=FILE", "File to store runtime log in or runtime.log", String],
+        [:group, "--group=NUM", "What group this is (use with --groups / starts at 1)", Integer],
+        [:groups, "--groups=NUM", "How many groups there are in total (use with --group)", Integer],
+        [:version, "--version", "Show version"],
+        [:help, "--help", "Show help"]
+      ]
+
+      options = arguments.each_with_object({}) do |(setting, flag, _, type), all|
+        all[setting] = delete_argv(flag.split('=', 2)[0], argv, type: type)
+      end
+
+      # show version
+      if options.fetch(:version)
+        puts VERSION
+        exit 0
+      end
+
+      # # show help
+      if options[:help]
+        parser = OptionParser.new("forking-test-runner folder [options]", 32, '') do |opts|
+          arguments.each do |_, flag, desc, type|
+            opts.on(flag, desc, type)
+          end
+        end
+        puts parser
+        exit 0
+      end
+
+      # check if we can use merge_coverage
+      if options.fetch(:merge_coverage)
+        abort "merge_coverage does not work on ruby prior to 2.3" if RUBY_VERSION < "2.3.0"
+        require 'coverage'
+        klass = (class << Coverage; self; end)
+        klass.prepend CoverageCapture
+      end
+
+      # all remaining non-flag options until the next flag must be tests
+      next_flag = argv.index { |arg| arg.start_with?("-") } || argv.size
+      tests = argv.slice!(0, next_flag)
+      abort "No tests or folders found in arguments" if tests.empty?
+      tests.each { |t| abort "Unable to find #{t}" unless File.exist?(t) }
+
+      [options, tests]
+    end
+
+    def delete_argv(name, argv, type: nil)
+      return unless index = argv.index(name)
+      argv.delete_at(index)
+      if type
+        found = argv.delete_at(index) || raise("Missing argument for #{name}")
+        send(type.name, found) # case found
+      else
+        true
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forking_test_runner
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests