ci-queue 0.20.0 → 0.20.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020e4e1012b0be90bc94deac97a2fb6e00a11aeed0c35e1cffba506145f0b2aa
-  data.tar.gz: 86a96759c23bacf51457b1a24c0284e40dba6904e16ac6a8bc52fdf83fd4243e
+  metadata.gz: 8b3b09a46db2e51a46c56d7621c04519733ae879c654fb1f40b501ee83ccc18e
+  data.tar.gz: ce5611bebdb7d779a4d4cc9ed5c647445b1f1e11f684739e50d723dc62c9b724
 SHA512:
-  metadata.gz: a77b0ee4af5f570ef8a398377049afdd88ce611ac9c16319decb9b627c265ef7f2efa773317e9ae04a5472d88d595471e2384fc7bfd4778c291c59d8fa79a08b
-  data.tar.gz: ba72651f0072f98167131617a2635b05260d343108ac4d073a5dba56bcb9e5f7980b14abe66ac10d88662967a86b8cd682d549cf8a22f37dad3b5ea94aa82018
+  metadata.gz: 9ae21355372fd174e00228a23c52ac09dafd7660f0931178602e96ae1b0c38f50d7a931f16781190e8de90b5fcc26715b518c87ff94d75923e26b736eeca6b8a
+  data.tar.gz: 302a5dc245808eda350733554e87b176e9e5b949a041c09adf3da3dfb119d1cac9e4af7301952aeebc96280c896bb6bb4f7abfc48cf83739cb970a1eaa8d4189

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/ci-queue.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest', ENV.fetch('MINITEST_VERSION', '~> 5.11')
   spec.add_development_dependency 'rspec', '~> 3.7.0'
-  spec.add_development_dependency 'redis', '~> 3.3'
+  spec.add_development_dependency 'redis'
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
 

data/lib/ci/queue/redis/worker.rb

@@ -56,10 +56,18 @@ module CI
         rescue *CONNECTION_ERRORS
         end
 
-        def retrying?
-          redis.exists(key('worker', worker_id, 'queue'))
-        rescue *CONNECTION_ERRORS
-          false
+        if ::Redis.method_defined?(:exists?)
+          def retrying?
+            redis.exists?(key('worker', worker_id, 'queue'))
+          rescue *CONNECTION_ERRORS
+            false
+          end
+        else
+          def retrying?
+            redis.exists(key('worker', worker_id, 'queue'))
+          rescue *CONNECTION_ERRORS
+            false
+          end
         end
 
         def retry_queue

data/lib/ci/queue/version.rb

@@ -2,7 +2,7 @@
 
 module CI
   module Queue
-    VERSION = '0.20.0'
+    VERSION = '0.20.5'
     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

@@ -16,7 +16,12 @@ module Minitest
       def generate_document
         suites = tests.group_by { |test| test.klass }
 
-        doc = REXML::Document.new
+        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)
@@ -25,7 +30,6 @@ module Minitest
       end
 
       def format_document(doc, io)
-        io << "<?xml version='1.0' encoding='UTF-8'?>\n"
         formatter = REXML::Formatters::Pretty.new
         formatter.write(doc, io)
         io << "\n"
@@ -44,17 +48,7 @@ module Minitest
 
       def add_tests_to(testsuites, suite, tests)
         suite_result = analyze_suite(tests)
-        relative_path = if tests.first.source_location.first == 'unknown'
-          Pathname.new('')
-        else
-          file_path = Pathname.new(tests.first.source_location.first)
-          if file_path.relative?
-            file_path
-          else
-            base_path = Pathname.new(@base_path)
-            file_path.relative_path_from(base_path)
-          end
-        end
+        relative_path = location_for_runnable(tests.first) || '<unknown>'
 
         testsuite = testsuites.add_element(
           'testsuite',
@@ -75,7 +69,8 @@ module Minitest
             'classname' => suite,
             'assertions' => test.assertions,
             'time' => test.time,
-            'flaky_test' => test.flaked?
+            'flaky_test' => test.flaked?,
+            'run-command' => Minitest.run_command_for_runnable(test),
           }
           attributes['lineno'] = lineno if lineno != -1
 
@@ -101,29 +96,33 @@ module Minitest
         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?
-          "\nSkipped:\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
-          "\nFailure:\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?
-          "\nError:\n#{name}(#{suite}) [#{location(error)}]:\n#{error.message}\n"
+          "\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.20.0
+  version: 0.20.5
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement