ci-queue 0.19.0 → 0.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436b1f0bca2725e6f532cbd4a4df9a880e6b1dd2e11a80b9587178d213fe6137
-  data.tar.gz: 93fe3b4055e7c99e6c61af1f106e63157e79dd2fe3717d5b1cfc74e096195e9a
+  metadata.gz: 4c7ce73cd1dd2d350b7e9b5293f92380d0bdb61a21aea1924e587fe897a31755
+  data.tar.gz: 70fb38ffa65e591ee0f86b3990dbc07bf587776f9e6d05937209efb50565b467
 SHA512:
-  metadata.gz: 2bc328cd567173a875bc8273a812d2ad48ea32bad0eb0f7b0a586b279a80c4eaf08eede41a15e98d71929776dc1a5d59e7fee94b844b55a1924b3f1aa0be4272
-  data.tar.gz: fab60979f729dd77fbf8661d8e1b644deb7e9c126a5ea27a97537e0fb960416b71c69b2b01b4123e6f19216b6a764a136079412875686c93f949a6323ebf0a63
+  metadata.gz: b3affe2bb8f9d7f1b4b25acd42257e671c981ee212f5c792c69af917cfdc4394de0d0e83c5b94b155d71ef60004c66a01115a3aaf2b19f872dbe81b63cdc7191
+  data.tar.gz: b8493fa643cb3405a42879b320a8714d192c7dfed6be62efd39220ee9d951c10a074ee4a69204784eb9119faa523c50f17788cb286032baf447cca3bbb636e84

data/README.md

@@ -51,7 +51,9 @@ The runner also comes with a tool to investigate leaky tests:
 minitest-queue --queue path/to/test_order.log --failing-test 'SomeTest#test_something' bisect -Itest test/**/*_test.rb
 ```
 
-### RSpec
+### RSpec [DEPRECATED]
+
+The rspec-queue runner is deprecated. The minitest-queue runner continues to be supported and is actively being improved. At Shopify, we strongly recommend that new projects set up their test suite using Minitest rather than RSpec.
 
 Assuming you use one of the supported CI providers, the command can be as simple as:
 
@@ -67,4 +69,4 @@ rspec-queue --queue redis://example.com --timeout 600 --report
 
 #### Limitations
 
-Because of how `ci-queue` execute the examples, `before(:all)` and `after(:all)` hooks are not supported. `rspec-queue` will explicitly reject them.
+Because of how `ci-queue` executes the examples, `before(:all)` and `after(:all)` hooks are not supported. `rspec-queue` will explicitly reject them.

data/lib/ci/queue/version.rb

@@ -2,7 +2,7 @@
 
 module CI
   module Queue
-    VERSION = '0.19.0'
+    VERSION = '0.20.4'
     DEV_SCRIPTS_ROOT = ::File.expand_path('../../../../../redis', __FILE__)
     RELEASE_SCRIPTS_ROOT = ::File.expand_path('../redis', __FILE__)
   end

data/lib/minitest/queue.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'shellwords'
 require 'minitest'
 require 'minitest/reporters'
 
@@ -102,6 +103,47 @@ module Minitest
   end
 
   module Queue
+    attr_writer :run_command_formatter, :project_root
+
+    def run_command_formatter
+      @run_command_formatter ||= if defined?(Rails) && defined?(Rails::TestUnitRailtie)
+        RAILS_RUN_COMMAND_FORMATTER
+      else
+        DEFAULT_RUN_COMMAND_FORMATTER
+      end
+    end
+
+    DEFAULT_RUN_COMMAND_FORMATTER = lambda do |runnable|
+      filename = Minitest::Queue.relative_path(runnable.source_location[0])
+      identifier = "#{runnable.klass}##{runnable.name}"
+      ['bundle', 'exec', 'ruby', '-Ilib:test', filename, '-n', identifier]
+    end
+
+    RAILS_RUN_COMMAND_FORMATTER = lambda do |runnable|
+      filename = Minitest::Queue.relative_path(runnable.source_location[0])
+      lineno = runnable.source_location[1]
+      ['bin/rails', 'test', "#{filename}:#{lineno}"]
+    end
+
+    def run_command_for_runnable(runnable)
+      command = run_command_formatter.call(runnable)
+      if command.is_a?(Array)
+        Shellwords.join(command)
+      else
+        command
+      end
+    end
+
+    def self.project_root
+      @project_root ||= Dir.pwd
+    end
+
+    def self.relative_path(path, root: project_root)
+      Pathname(path).relative_path_from(Pathname(root)).to_s
+    rescue ArgumentError
+      path
+    end
+
     class SingleExample
 
       def initialize(runnable, method_name)

data/lib/minitest/queue/error_report.rb

@@ -58,6 +58,10 @@ module Minitest
         @data[:test_and_module_name]
       end
 
+      def test_suite
+        @data[:test_suite]
+      end
+
       def test_file
         @data[:test_file]
       end

data/lib/minitest/queue/failure_formatter.rb

@@ -27,6 +27,7 @@ module Minitest
           test_line: test_line,
           test_and_module_name: "#{test.klass}##{test.name}",
           test_name: test.name,
+          test_suite: test.klass,
           error_class: test.failure.exception.class.name,
           output: to_s,
         }

data/lib/minitest/queue/junit_reporter.rb

@@ -1,101 +1,128 @@
 # frozen_string_literal: true
+
 require 'minitest/reporters'
-require 'builder'
+require 'rexml/document'
 require 'fileutils'
 
 module Minitest
   module Queue
     class JUnitReporter < Minitest::Reporters::BaseReporter
-      class XmlMarkup < ::Builder::XmlMarkup
-        def trunc!(txt)
-          txt.sub(/\n.*/m, '...')
-        end
-      end
-
       def initialize(report_path = 'log/junit.xml', options = {})
         super({})
         @report_path = File.absolute_path(report_path)
         @base_path = options[:base_path] || Dir.pwd
       end
 
-      def report
-        super
-
+      def generate_document
         suites = tests.group_by { |test| test.klass }
 
-        xml = Builder::XmlMarkup.new(indent: 2)
-        xml.instruct!
-        xml.testsuites do
-          suites.each do |suite, tests|
-            add_tests_to(xml, suite, tests)
-          end
+        doc = REXML::Document.new(nil, {
+          :prologue_quote => :quote,
+          :attribute_quote => :quote,
+        })
+        doc << REXML::XMLDecl.new('1.1', 'utf-8')
+
+        testsuites = doc.add_element('testsuites')
+        suites.each do |suite, tests|
+          add_tests_to(testsuites, suite, tests)
         end
+        doc
+      end
+
+      def format_document(doc, io)
+        formatter = REXML::Formatters::Pretty.new
+        formatter.write(doc, io)
+        io << "\n"
+      end
+
+      def report
+        super
+
         FileUtils.mkdir_p(File.dirname(@report_path))
-        File.open(@report_path, 'w+') { |file| file << xml.target! }
+        File.open(@report_path, 'w+') do |file|
+          format_document(generate_document, file)
+        end
       end
 
       private
 
-      def add_tests_to(xml, suite, tests)
+      def add_tests_to(testsuites, suite, tests)
         suite_result = analyze_suite(tests)
-        file_path = Pathname.new(tests.first.source_location.first)
-        base_path = Pathname.new(@base_path)
-        relative_path = file_path.relative_path_from(base_path)
-
-        xml.testsuite(name: suite, filepath: relative_path,
-                      skipped: suite_result[:skip_count], failures: suite_result[:fail_count],
-                      errors: suite_result[:error_count], tests: suite_result[:test_count],
-                      assertions: suite_result[:assertion_count], time: suite_result[:time]) do
-          tests.each do |test|
-            lineno = test.source_location.last
-            xml.testcase(name: test.name, lineno: lineno, classname: suite, assertions: test.assertions,
-                         time: test.time, flaky_test: test.flaked?) do
-              xml << xml_message_for(test) unless test.passed?
-            end
-          end
+        relative_path = location_for_runnable(tests.first) || '<unknown>'
+
+        testsuite = testsuites.add_element(
+          'testsuite',
+          'name' => suite,
+          'filepath' => relative_path,
+          'skipped' => suite_result[:skip_count],
+          'failures' => suite_result[:fail_count],
+          'errors' => suite_result[:error_count],
+          'tests' => suite_result[:test_count],
+          'assertions' => suite_result[:assertion_count],
+          'time' => suite_result[:time],
+        )
+
+        tests.each do |test|
+          lineno = tests.first.source_location.last
+          attributes = {
+            'name' => test.name,
+            'classname' => suite,
+            'assertions' => test.assertions,
+            'time' => test.time,
+            'flaky_test' => test.flaked?,
+            'run-command' => Minitest.run_command_for_runnable(test),
+          }
+          attributes['lineno'] = lineno if lineno != -1
+
+          testcase = testsuite.add_element('testcase', attributes)
+          add_xml_message_for(testcase, test) unless test.passed?
         end
       end
 
-      def xml_message_for(test)
-        xml = XmlMarkup.new(indent: 2, margin: 2)
+      def add_xml_message_for(testcase, test)
         failure = test.failure
-
         if test.skipped? && !test.flaked?
-          xml.skipped(type: failure.error.class.name)
+          testcase.add_element('skipped', 'type' => failure.error.class.name)
         elsif test.error?
-          xml.error(type: failure.error.class.name, message: xml.trunc!(failure.message)) do
-            xml.text!(message_for(test))
-          end
+          error = testcase.add_element('error', 'type' => failure.error.class.name, 'message' => truncate_message(failure.message))
+          error.add_text(REXML::CData.new(message_for(test)))
         elsif failure
-          xml.failure(type: failure.error.class.name, message: xml.trunc!(failure.message)) do
-            xml.text!(message_for(test))
-          end
+          failure = testcase.add_element('failure', 'type' => failure.error.class.name, 'message' => truncate_message(failure.message))
+          failure.add_text(REXML::CData.new(message_for(test)))
         end
       end
 
+      def truncate_message(message)
+        message.lines.first.chomp.gsub(/\e\[[^m]+m/, '')
+      end
+
+      def project_root_path_matcher
+        @project_root_path_matcher ||= %r{(?<=\s)#{Regexp.escape(Minitest::Queue.project_root)}/}
+      end
+
       def message_for(test)
         suite = test.klass
         name = test.name
         error = test.failure
 
+        message_with_relative_paths = error.message.gsub(project_root_path_matcher, '')
         if test.passed?
           nil
         elsif test.skipped?
-          "Skipped:\n#{name}(#{suite}) [#{location(error)}]:\n#{error.message}\n"
+          "\nSkipped:\n#{name}(#{suite}) [#{location_for_runnable(test)}]:\n#{message_with_relative_paths}\n"
         elsif test.failure
-          "Failure:\n#{name}(#{suite}) [#{location(error)}]:\n#{error.message}\n"
+          "\nFailure:\n#{name}(#{suite}) [#{location_for_runnable(test)}]:\n#{message_with_relative_paths}\n"
         elsif test.error?
-          "Error:\n#{name}(#{suite}):\n#{error.message}"
+          "\nError:\n#{name}(#{suite}) [#{location_for_runnable(test)}]:\n#{message_with_relative_paths}\n"
         end
       end
 
-      def location(exception)
-        last_before_assertion = ''
-        exception.backtrace.reverse_each do |s|
-          break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
-          last_before_assertion = s
+      def location_for_runnable(runnable)
+        if runnable.source_location.first == 'unknown'
+          nil
+        else
+          Minitest::Queue.relative_path(runnable.source_location.first)
         end
-        last_before_assertion.sub(/:in .*$/, '')
       end
 
       def analyze_suite(tests)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci-queue
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.4
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler