ci-queue 0.77.0 → 0.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d179aa863885754053bf872092be72aab9f8fc521e01b4a06998fd4f52d4abcb
-  data.tar.gz: 464c80baf9b169ef4dc7fddd91bb893074ff3b15d89e430f2447b3fce8fc8a82
+  metadata.gz: 3a6bc964bea9e748549dc7e57a2ec4c0207e080fa5d644fac6d75165b88b44cf
+  data.tar.gz: 22acfa15e29f811514aea54861ae9f4c422e11d42eadbed7241b030f5a3ed79f
 SHA512:
-  metadata.gz: 93c43b61bbcf9ac0f92dcbb257e5d58605e6bc6d047c1c4db8455750db69ec95033e4bedeabdc615d887804d2174e74cea832b0589511d9d0546f4593d6c9c94
-  data.tar.gz: e708efad7772916ed5aab6fd34070a10be745509689cc31896d104ba5ac69c3f81960bc1cf8c76b5fe88fda152c472ed3c6368d20d6ebdc6ca6a0c5d53d91089
+  metadata.gz: 02b7be5eea0c4f50eacd9caa19bb64f7ab52720deb92897573efad680bf1130aa717f09302b3c6573bd0c7e5eed592ba3acb601cfeb8a2eabbdc9cb422826d2e
+  data.tar.gz: dbdca360f7eba2da549559f982c73175302dc5e92f414972f39c8a6fb77de9a95d3dfc783bae4be3a63dcefa2844c69e5fae3842f828dff42d66a2b9058aae64

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci-queue (0.77.0)
+    ci-queue (0.79.0)
       logger
 
 GEM

data/lib/ci/queue/version.rb

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

data/lib/minitest/queue/build_status_reporter.rb

@@ -153,7 +153,10 @@ module Minitest
         puts
 
         errors = error_reports
-        puts errors
+        if errors.any?
+          pretty_print_summary(errors)
+          pretty_print_failures(errors)
+        end
 
         build.worker_errors.to_a.sort.each do |worker_id, error|
           puts red("Worker #{worker_id } crashed")
@@ -224,6 +227,37 @@ module Minitest
 
       attr_reader :build, :supervisor
 
+      def pretty_print_summary(errors)
+        test_paths = errors.map(&:test_file).compact
+        return unless test_paths.any?
+
+        file_counts = test_paths.each_with_object(Hash.new(0)) { |path, counts| counts[path] += 1 }
+
+        puts "\n" + "=" * 80
+        puts "FAILED TESTS SUMMARY:"
+        puts "=" * 80
+        file_counts.sort_by { |path, _| path }.each do |path, count|
+          relative_path = Minitest::Queue.relative_path(path)
+          if count == 1
+            puts "  #{relative_path}"
+          else
+            puts "  #{relative_path} (#{count} failures)"
+          end
+        end
+        puts "=" * 80
+      end
+
+      def pretty_print_failures(errors)
+        errors.each_with_index do |error, index|
+          puts "\n" + "-" * 80
+          puts "Error #{index + 1} of #{errors.size}"
+          puts "-" * 80
+          puts error
+        end
+
+        puts "=" * 80
+      end
+
       def timed_out?
         supervisor.time_left.to_i <= 0
       end

data/lib/minitest/queue/runner.rb

@@ -193,6 +193,7 @@ module Minitest
           puts reopen_previous_step
           puts red("The failing test does not exist.")
           File.write('log/test_order.log', "")
+          File.write('log/bisect_test_details.log', "")
           exit! 1
         end
 
@@ -200,6 +201,7 @@ module Minitest
           puts reopen_previous_step
           puts red("The test fail when ran alone, no need to bisect.")
           File.write('log/test_order.log', queue_config.failing_test)
+          File.write('log/bisect_test_details.log', "")
           exit! 0
         end
 
@@ -218,6 +220,7 @@ module Minitest
         if queue.suspects_left == 0
           step(yellow("The failing test was the first test in the test order so there is nothing to bisect."))
           File.write('log/test_order.log', "")
+          File.write('log/bisect_test_details.log', "")
           exit! 1
         end
 
@@ -226,6 +229,7 @@ module Minitest
         if run_tests_in_fork(failing_order)
           step(yellow("The bisection was inconclusive, there might not be any leaky test here."))
           File.write('log/test_order.log', "")
+          File.write('log/bisect_test_details.log', "")
           exit! 1
         else
           step(green('The following command should reproduce the leak on your machine:'), collapsed: false)
@@ -238,6 +242,16 @@ module Minitest
           puts
 
           File.write('log/test_order.log', failing_order.to_a.map(&:id).join("\n"))
+          
+          bisect_test_details = failing_order.to_a.map do |test|
+            source_location = test.source_location
+            file_path = source_location&.first || 'unknown'
+            line_number = source_location&.last || -1
+            "#{test.id} #{file_path}:#{line_number}"
+          end
+          
+          File.write('log/bisect_test_details.log', bisect_test_details.join("\n"))
+          
           exit! 0
         end
       end

data/lib/minitest/queue.rb

@@ -257,6 +257,12 @@ module Minitest
         Minitest.queue.flaky?(self)
       end
 
+      def source_location
+        @runnable.instance_method(@method_name).source_location
+      rescue NameError, NoMethodError
+        nil
+      end
+
       private
 
       def current_timestamp

data/lib/rspec/queue/build_status_recorder.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+require 'rspec/queue/failure_formatter'
+require 'rspec/queue/error_report'
+
 module RSpec
   module Queue
     class BuildStatusRecorder
@@ -6,7 +9,9 @@ module RSpec
 
       class << self
         attr_accessor :build
+        attr_accessor :failure_formatter
       end
+      self.failure_formatter = FailureFormatter
 
       def initialize(*)
       end
@@ -18,17 +23,13 @@ module RSpec
 
       def example_failed(notification)
         example = notification.example
-        build.record_error(example.id, [
-          notification.fully_formatted(nil),
-          colorized_rerun_command(example),
-        ].join("\n"))
+        build.record_error(example.id, dump(notification))
       end
 
       private
 
-      def colorized_rerun_command(example, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        colorizer.wrap("rspec #{example.location_rerun_argument}", RSpec.configuration.failure_color) + " " +
-        colorizer.wrap("# #{example.full_description}",   RSpec.configuration.detail_color)
+      def dump(notification)
+        ErrorReport.new(self.class.failure_formatter.new(notification).to_h).dump
       end
 
       def build

data/lib/rspec/queue/error_report.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+module RSpec
+  module Queue
+    class ErrorReport
+      class << self
+        attr_accessor :coder
+
+        def load(payload)
+          new(coder.load(payload))
+        end
+      end
+
+      # Default to Marshal
+      self.coder = Marshal
+
+      # Try to use SnappyPack if available from consumer's bundle
+      begin
+        require 'snappy'
+        require 'msgpack'
+        require 'stringio'
+
+        module SnappyPack
+          extend self
+
+          MSGPACK = MessagePack::Factory.new
+          MSGPACK.register_type(0x00, Symbol)
+
+          def load(payload)
+            io = StringIO.new(Snappy.inflate(payload))
+            MSGPACK.unpacker(io).unpack
+          end
+
+          def dump(object)
+            io = StringIO.new
+            packer = MSGPACK.packer(io)
+            packer.pack(object)
+            packer.flush
+            io.rewind
+            Snappy.deflate(io.string).force_encoding(Encoding::UTF_8)
+          end
+        end
+
+        self.coder = SnappyPack
+      rescue LoadError
+      end
+
+      def initialize(data)
+        @data = data
+      end
+
+      def dump
+        self.class.coder.dump(@data)
+      end
+
+      def test_name
+        @data[:test_name]
+      end
+
+      def error_class
+        @data[:error_class]
+      end
+
+      def test_and_module_name
+        @data[:test_and_module_name]
+      end
+
+      def test_suite
+        @data[:test_suite]
+      end
+
+      def test_file
+        @data[:test_file]
+      end
+
+      def test_line
+        @data[:test_line]
+      end
+
+      def to_h
+        @data
+      end
+
+      def to_s
+        output
+      end
+
+      def output
+        @data[:output]
+      end
+    end
+  end
+end

data/lib/rspec/queue/failure_formatter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'delegate'
+require 'ci/queue/output_helpers'
+
+module RSpec
+  module Queue
+    class FailureFormatter < SimpleDelegator
+      include ::CI::Queue::OutputHelpers
+
+      def initialize(notification)
+        @notification = notification
+        super
+      end
+
+      def to_s
+        [
+          @notification.fully_formatted(nil),
+          colorized_rerun_command(@notification.example)
+        ].join("\n")
+      end
+
+      def to_h
+        example = @notification.example
+        {
+          test_file: example.file_path,
+          test_line: example.metadata[:line_number],
+          test_and_module_name: example.id,
+          test_name: example.description,
+          test_suite: example.example_group.description,
+          error_class: @notification.exception.class.name,
+          output: to_s,
+        }
+      end
+
+      private
+
+      attr_reader :notification
+
+      def colorized_rerun_command(example, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        colorizer.wrap("rspec #{example.location_rerun_argument}", RSpec.configuration.failure_color) + " " +
+        colorizer.wrap("# #{example.full_description}", RSpec.configuration.detail_color)
+      end
+    end
+  end
+end

data/lib/rspec/queue.rb

@@ -5,6 +5,7 @@ require 'rspec/core'
 require 'ci/queue'
 require 'rspec/queue/build_status_recorder'
 require 'rspec/queue/order_recorder'
+require 'rspec/queue/error_report'
 
 module RSpec
   module Queue
@@ -291,16 +292,56 @@ module RSpec
           end
         end
 
-        # TODO: better reporting
-        errors = supervisor.build.error_reports.sort_by(&:first).map(&:last)
+        errors = supervisor.build.error_reports.sort_by(&:first).map do |_, error_data|
+            RSpec::Queue::ErrorReport.load(error_data)
+        end
         if errors.empty?
           step(green('No errors found'))
           0
         else
           message = errors.size == 1 ? "1 error found" : "#{errors.size} errors found"
           step(red(message), collapsed: false)
-          puts errors
+
+          pretty_print_summary(errors)
+          pretty_print_failures(errors)
           1
+          # Example output
+          #
+          # FAILED TESTS SUMMARY:
+          # =================================================================================
+          #   ./spec/dummy_spec.rb
+          #   ./spec/dummy_spec_2.rb (2 failures)
+          #   ./spec/dummy_spec_3.rb (3 failures)
+          # =================================================================================
+          #
+          # --------------------------------------------------------------------------------
+          # Error 1 of 3
+          # --------------------------------------------------------------------------------
+          #
+          #   Object doesn't work on first try
+          #   Failure/Error: expect(1 + 1).to be == 42
+          #
+          #     expected: == 42
+          #      got:    2
+          #
+          # --- stacktrace will be here ---
+          # --- rerun command will be here ---
+          #
+          # --------------------------------------------------------------------------------
+          # Error 2 of 3
+          # --------------------------------------------------------------------------------
+          #
+          #   Object doesn't work on first try
+          #   Failure/Error: expect(1 + 1).to be == 42
+          #
+          #     expected: == 42
+          #      got:    2
+          #
+          # --- stacktrace will be here ---
+          # --- rerun command will be here ---
+          #
+          #  ... etc
+          # =================================================================================
         end
       end
 
@@ -320,6 +361,38 @@ module RSpec
         invalid_usage!('Missing --queue parameter') unless queue_url
         invalid_usage!('Missing --build parameter') unless RSpec::Queue.config.build_id
       end
+
+      private
+
+      def pretty_print_summary(errors)
+        test_paths = errors.map(&:test_file).compact
+        return unless test_paths.any?
+
+        file_counts = test_paths.each_with_object(Hash.new(0)) { |path, counts| counts[path] += 1 }
+
+        puts "\n" + "=" * 80
+        puts "FAILED TESTS SUMMARY:"
+        puts "=" * 80
+        file_counts.sort_by { |path, _| path }.each do |path, count|
+          if count == 1
+            puts "  #{path}"
+          else
+            puts "  #{path} (#{count} failures)"
+          end
+        end
+        puts "=" * 80
+      end
+
+      def pretty_print_failures(errors)
+        errors.each_with_index do |error, index|
+          puts "\n" + "-" * 80
+          puts "Error #{index + 1} of #{errors.size}"
+          puts "-" * 80
+          puts error.to_s
+        end
+
+        puts "=" * 80
+      end
     end
 
     class QueueReporter < SimpleDelegator
@@ -362,7 +435,18 @@ module RSpec
         invalid_usage!('Missing --queue parameter') unless queue_url
         invalid_usage!('Missing --build parameter') unless RSpec::Queue.config.build_id
         invalid_usage!('Missing --worker parameter') unless RSpec::Queue.config.worker_id
-        RSpec.configuration.backtrace_formatter.filter_gem('ci-queue')
+        RSpec.configure do |config|
+          config.backtrace_exclusion_patterns = [
+            # Filter bundler paths
+            %r{/tmp/bundle/},
+            # RSpec internals
+            %r{/gems/rspec-},
+            # ci-queue and rspec-queue internals
+            %r{exe/rspec-queue},
+            %r{lib/ci/queue/},
+            %r{rspec/queue}
+          ]
+        end
       end
 
       def run_specs(example_groups)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci-queue
 version: !ruby/object:Gem::Version
-  version: 0.77.0
+  version: 0.79.0
 platform: ruby
 authors:
 - Jean Boussier
@@ -234,6 +234,8 @@ files:
 - lib/minitest/reporters/statsd_reporter.rb
 - lib/rspec/queue.rb
 - lib/rspec/queue/build_status_recorder.rb
+- lib/rspec/queue/error_report.rb
+- lib/rspec/queue/failure_formatter.rb
 - lib/rspec/queue/order_recorder.rb
 homepage: https://github.com/Shopify/ci-queue
 licenses:
@@ -254,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Distribute tests over many workers using a queue
 test_files: []