specbandit 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0cef232a7dfa2dd4109d150bd63dbdaac27f65c87e9a9c4a8c495678fdc8f0
-  data.tar.gz: c0a7505268abdc305f6d095fd75788ee5180c4e911972af8f95397bb57241358
+  metadata.gz: 6e9239010371ceb4ec5c34c959413de19ecb62d31004010c4cccd74a7f558f96
+  data.tar.gz: 740235b2c5e7174b0b0b5aba2f0da1632db3b789a9deca1800ee3f61568bf0be
 SHA512:
-  metadata.gz: 93c598ec5a9e0a542c0f86159ba3a70f7d7712b4c7f1c0bdf264cd9316363b483470986af3f6b619d326a52ce6d14cbd4c3ffff91e681d8c7eb7ddb8f1a2e150
-  data.tar.gz: 7974be5fd63f662d6db8a3b99cf00aeb7a0f75b0742c74a585c8cb7388686673507e2b23e0eb836cf1ec5c6b698585ef5eba0ec106b9436f6927409cbc59c85e
+  metadata.gz: 7446e60aee84c46d4ea8e1c5c59307c7bd9593b2ba082b9f30dc4835e531b5343291cd1f42be8015f48c808faf8f65f93cd43610a799133ebffda4723b7e1a92
+  data.tar.gz: 6a698f1ccb2e6fd7840171f97ad1ffaad5b2f1e00a66349e6bcc4ea79b34768c821516bd3552ef82188c6d8cb6abc2b1218859c7981850e39ac52950b81444df

data/lib/specbandit/cli.rb

@@ -111,6 +111,10 @@ module Specbandit
           Specbandit.configuration.key_rerun_ttl = v
         end
 
+        opts.on('--verbose', 'Show per-batch file list and full RSpec output (default: quiet)') do
+          Specbandit.configuration.verbose = true
+        end
+
         opts.on('-h', '--help', 'Show this help') do
           puts opts
           return 0
@@ -120,6 +124,10 @@ module Specbandit
       parser.parse!(argv)
       Specbandit.configuration.validate!
 
+      # Remaining args after `--` are treated as extra rspec options.
+      # This allows: specbandit work --key KEY -- --format json --out results.json
+      Specbandit.configuration.rspec_opts = argv if argv.any?
+
       worker = Worker.new
       worker.run
     end
@@ -145,6 +153,8 @@ module Specbandit
           --rspec-opts OPTS    Extra options forwarded to RSpec
           --key-rerun KEY      Per-runner rerun key for re-run support
           --key-rerun-ttl N    TTL for rerun key (default: 604800 / 1 week)
+          --verbose            Show per-batch file list and full RSpec output
+          -- OPTS...           Pass remaining args as RSpec options (alternative to --rspec-opts)
 
         Environment variables:
           SPECBANDIT_KEY              Queue key
@@ -154,6 +164,7 @@ module Specbandit
           SPECBANDIT_RSPEC_OPTS       RSpec options
           SPECBANDIT_KEY_RERUN        Per-runner rerun key
           SPECBANDIT_KEY_RERUN_TTL    Rerun key TTL in seconds (default: 604800)
+          SPECBANDIT_VERBOSE          Enable verbose output (1/true/yes)
 
         File input priority for push:
           1. stdin (piped)     echo "spec/a_spec.rb" | specbandit push --key KEY

data/lib/specbandit/configuration.rb

@@ -3,7 +3,7 @@
 module Specbandit
   class Configuration
     attr_accessor :redis_url, :batch_size, :key, :rspec_opts, :key_ttl,
-                  :key_rerun, :key_rerun_ttl
+                  :key_rerun, :key_rerun_ttl, :verbose
 
     DEFAULT_REDIS_URL = 'redis://localhost:6379'
     DEFAULT_BATCH_SIZE = 5
@@ -18,6 +18,7 @@ module Specbandit
       @key_ttl = Integer(ENV.fetch('SPECBANDIT_KEY_TTL', DEFAULT_KEY_TTL))
       @key_rerun = ENV.fetch('SPECBANDIT_KEY_RERUN', nil)
       @key_rerun_ttl = Integer(ENV.fetch('SPECBANDIT_KEY_RERUN_TTL', DEFAULT_KEY_RERUN_TTL))
+      @verbose = env_truthy?('SPECBANDIT_VERBOSE')
     end
 
     def validate!
@@ -34,5 +35,9 @@ module Specbandit
 
       opts.split
     end
+
+    def env_truthy?(name)
+      %w[1 true yes].include?(ENV.fetch(name, '').downcase)
+    end
   end
 end

data/lib/specbandit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Specbandit
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

data/lib/specbandit/worker.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'stringio'
+require 'json'
+require 'tempfile'
 require 'rspec/core'
 
 module Specbandit
   class Worker
-    attr_reader :queue, :key, :batch_size, :rspec_opts, :key_rerun, :key_rerun_ttl, :output
+    attr_reader :queue, :key, :batch_size, :rspec_opts, :key_rerun, :key_rerun_ttl, :output, :verbose
 
     def initialize(
       key: Specbandit.configuration.key,
@@ -13,6 +15,7 @@ module Specbandit
       rspec_opts: Specbandit.configuration.rspec_opts,
       key_rerun: Specbandit.configuration.key_rerun,
       key_rerun_ttl: Specbandit.configuration.key_rerun_ttl,
+      verbose: Specbandit.configuration.verbose,
       queue: nil,
       output: $stdout
     )
@@ -21,24 +24,35 @@ module Specbandit
       @rspec_opts = Array(rspec_opts)
       @key_rerun = key_rerun
       @key_rerun_ttl = key_rerun_ttl
+      @verbose = verbose
       @queue = queue || RedisQueue.new
       @output = output
+      @batch_durations = []
+      @accumulated_examples = []
+      @accumulated_summary = { duration: 0.0, example_count: 0, failure_count: 0, pending_count: 0,
+                               errors_outside_of_examples_count: 0 }
     end
 
     # Main entry point. Detects the operating mode and dispatches accordingly.
     #
     # Returns 0 if all batches passed (or nothing to do), 1 if any batch failed.
     def run
-      if key_rerun
-        rerun_files = queue.read_all(key_rerun)
-        if rerun_files.any?
-          run_replay(rerun_files)
-        else
-          run_steal(record: true)
-        end
-      else
-        run_steal(record: false)
-      end
+      exit_code = if key_rerun
+                    rerun_files = queue.read_all(key_rerun)
+                    if rerun_files.any?
+                      run_replay(rerun_files)
+                    else
+                      run_steal(record: true)
+                    end
+                  else
+                    run_steal(record: false)
+                  end
+
+      print_summary if @batch_durations.any?
+      merge_json_results
+      write_github_step_summary if ENV['GITHUB_STEP_SUMMARY']
+
+      exit_code
     end
 
     private
@@ -56,7 +70,7 @@ module Specbandit
       files.each_slice(batch_size) do |batch|
         batch_num += 1
         output.puts "[specbandit] Batch ##{batch_num}: running #{batch.size} files"
-        batch.each { |f| output.puts "  #{f}" }
+        batch.each { |f| output.puts "  #{f}" } if verbose
 
         exit_code = run_rspec_batch(batch)
         if exit_code != 0
@@ -95,7 +109,7 @@ module Specbandit
 
         batch_num += 1
         output.puts "[specbandit] Batch ##{batch_num}: running #{files.size} files"
-        files.each { |f| output.puts "  #{f}" }
+        files.each { |f| output.puts "  #{f}" } if verbose
 
         exit_code = run_rspec_batch(files)
         if exit_code != 0
@@ -118,18 +132,31 @@ module Specbandit
     def run_rspec_batch(files)
       reset_rspec_state
 
-      args = files + rspec_opts
+      # Always write JSON to a tempfile so we can accumulate structured results
+      # regardless of whether the user passed --format json --out.
+      batch_json = Tempfile.new(['specbandit-batch', '.json'])
+      args = files + rspec_opts + ['--format', 'json', '--out', batch_json.path]
+
       err = StringIO.new
       out = StringIO.new
 
-      RSpec::Core::Runner.run(args, err, out)
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      exit_code = RSpec::Core::Runner.run(args, err, out)
+      duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+      @batch_durations << duration
+
+      accumulate_json_results(batch_json.path)
+      exit_code
     ensure
       # Print RSpec output through our output stream
       rspec_output = out&.string
-      output.print(rspec_output) unless rspec_output.nil? || rspec_output.empty?
+      output.print(rspec_output) if verbose && rspec_output && !rspec_output.empty?
 
       rspec_err = err&.string
-      output.print(rspec_err) unless rspec_err.nil? || rspec_err.empty?
+      output.print(rspec_err) if verbose && rspec_err && !rspec_err.empty?
+
+      batch_json&.close
+      batch_json&.unlink
     end
 
     # Reset RSpec state between batches so each batch runs cleanly.
@@ -159,5 +186,160 @@ module Specbandit
       RSpec.world.non_example_failure = false
       RSpec.configuration.output_stream = $stdout
     end
+
+    # --- Reporting helpers ---
+
+    # Extract the --out file path from rspec_opts.
+    # RSpec accepts: --out FILE or -o FILE
+    def json_output_path
+      rspec_opts.each_with_index do |opt, i|
+        return rspec_opts[i + 1] if ['--out', '-o'].include?(opt) && rspec_opts[i + 1]
+      end
+      nil
+    end
+
+    # After each batch, read the JSON output from the temp file and accumulate
+    # examples and summary fields.
+    def accumulate_json_results(path)
+      return unless path && File.exist?(path)
+
+      begin
+        data = JSON.parse(File.read(path))
+      rescue JSON::ParserError
+        return
+      end
+
+      @accumulated_examples.concat(data.fetch('examples', []))
+
+      summary = data.fetch('summary', {})
+      @accumulated_summary[:duration] += summary.fetch('duration', 0.0)
+      @accumulated_summary[:example_count] += summary.fetch('example_count', 0)
+      @accumulated_summary[:failure_count] += summary.fetch('failure_count', 0)
+      @accumulated_summary[:pending_count] += summary.fetch('pending_count', 0)
+      @accumulated_summary[:errors_outside_of_examples_count] += summary.fetch('errors_outside_of_examples_count', 0)
+    end
+
+    # After all batches, write the merged JSON back to the --out file so
+    # CI artifact collection picks up the complete results.
+    def merge_json_results
+      path = json_output_path
+      return unless path && @accumulated_examples.any?
+
+      merged = {
+        'version' => RSpec::Core::Version::STRING,
+        'specbandit_version' => Specbandit::VERSION,
+        'summary' => {
+          'duration' => @accumulated_summary[:duration],
+          'example_count' => @accumulated_summary[:example_count],
+          'failure_count' => @accumulated_summary[:failure_count],
+          'pending_count' => @accumulated_summary[:pending_count],
+          'errors_outside_of_examples_count' => @accumulated_summary[:errors_outside_of_examples_count]
+        },
+        'summary_line' => summary_line,
+        'examples' => @accumulated_examples,
+        'batch_timings' => {
+          'count' => @batch_durations.size,
+          'min' => @batch_durations.min&.round(2),
+          'avg' => @batch_durations.empty? ? 0 : (@batch_durations.sum / @batch_durations.size).round(2),
+          'max' => @batch_durations.max&.round(2),
+          'all' => @batch_durations.map { |d| d.round(2) }
+        }
+      }
+
+      File.write(path, JSON.pretty_generate(merged))
+    end
+
+    # Print a unified summary to the output stream after all batches.
+    def print_summary
+      output.puts ''
+      output.puts '=' * 60
+      output.puts '[specbandit] Summary'
+      output.puts '=' * 60
+      output.puts "  Batches:  #{@batch_durations.size}"
+      output.puts "  Examples: #{@accumulated_summary[:example_count]}"
+      output.puts "  Failures: #{@accumulated_summary[:failure_count]}"
+      output.puts "  Pending:  #{@accumulated_summary[:pending_count]}"
+
+      output.puts ''
+      output.puts format(
+        '  Batch timing: min %.1fs | avg %.1fs | max %.1fs',
+        @batch_durations.min || 0,
+        @batch_durations.empty? ? 0 : @batch_durations.sum / @batch_durations.size,
+        @batch_durations.max || 0
+      )
+
+      failed_examples = @accumulated_examples.select { |e| e['status'] == 'failed' }
+      if failed_examples.any?
+        output.puts ''
+        output.puts "  Failed specs (#{failed_examples.size}):"
+        failed_examples.each do |ex|
+          location = ex.dig('file_path') || 'unknown'
+          line = ex.dig('line_number')
+          location = "#{location}:#{line}" if line
+          desc = ex.dig('full_description') || ex.dig('description') || ''
+          message = ex.dig('exception', 'message') || ''
+          # Truncate long messages
+          message = "#{message[0, 120]}..." if message.length > 120
+          output.puts "    #{location} - #{desc}"
+          output.puts "      #{message}" unless message.empty?
+        end
+      end
+
+      output.puts '=' * 60
+      output.puts ''
+    end
+
+    def summary_line
+      parts = ["#{@accumulated_summary[:example_count]} examples"]
+      parts << "#{@accumulated_summary[:failure_count]} failures"
+      parts << "#{@accumulated_summary[:pending_count]} pending" if @accumulated_summary[:pending_count] > 0
+      parts.join(', ')
+    end
+
+    # Write a markdown summary to $GITHUB_STEP_SUMMARY for GitHub Actions.
+    def write_github_step_summary
+      path = ENV['GITHUB_STEP_SUMMARY']
+      return unless path
+
+      md = StringIO.new
+      md.puts '### 🏴‍☠️ Specbandit Results'
+      md.puts ''
+      md.puts '| Metric | Value |'
+      md.puts '|--------|-------|'
+      md.puts "| Batches | #{@batch_durations.size} |"
+      md.puts "| Examples | #{@accumulated_summary[:example_count]} |"
+      md.puts "| Failures | #{@accumulated_summary[:failure_count]} |"
+      md.puts "| Pending | #{@accumulated_summary[:pending_count]} |"
+
+      md.puts format('| Batch time (min) | %.1fs |', @batch_durations.min || 0)
+      md.puts format('| Batch time (avg) | %.1fs |',
+                     @batch_durations.empty? ? 0 : @batch_durations.sum / @batch_durations.size)
+      md.puts format('| Batch time (max) | %.1fs |', @batch_durations.max || 0)
+      md.puts ''
+
+      failed_examples = @accumulated_examples.select { |e| e['status'] == 'failed' }
+      if failed_examples.any?
+        md.puts "<details><summary>❌ #{failed_examples.size} failed specs</summary>"
+        md.puts ''
+        md.puts '| Location | Description | Error |'
+        md.puts '|----------|-------------|-------|'
+        failed_examples.each do |ex|
+          location = ex['file_path'] || 'unknown'
+          line = ex['line_number']
+          location = "#{location}:#{line}" if line
+          desc = (ex['full_description'] || ex['description'] || '').gsub('|', '\\|')
+          message = (ex.dig('exception', 'message') || '').gsub('|', '\\|').gsub("\n", ' ')
+          message = "#{message[0, 100]}..." if message.length > 100
+          md.puts "| `#{location}` | #{desc} | #{message} |"
+        end
+        md.puts ''
+        md.puts '</details>'
+      end
+
+      File.open(path, 'a') { |f| f.write(md.string) }
+    rescue StandardError
+      # Never fail the build because of summary writing
+      nil
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specbandit
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ferran Basora