specbandit 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0284e5da8c01b4c149f7dedf22165ba743acd715de01073c9dc5fda6dd35742b'
-  data.tar.gz: 7181e9efdc91cdeb1a80675d147f12934685c73a192aad42897d080a945675d1
+  metadata.gz: 95622117125136b9368557368697eb0b9663983289dc7a5c53692a230ac4d7ef
+  data.tar.gz: 5d74e976511d86b4c8da066cc782fc358af1c69e89ae02edcc3935b077ad473e
 SHA512:
-  metadata.gz: 7effa3ce71d27cf6cc9a4166d99529dea22ebaa488a9100369a4e2834471e5f59358812653ccf10f29872de31a35ea591c995c7ad0e4b666ef7d50c4a00494d9
-  data.tar.gz: bf2dfea12cd23511f63ccfa811a035966f81a35c6a26a93352990872908fa6eebb899855e4e5c3b4c6019d466e6e3d12eccafa0a329f4ea7741004de84b6be91
+  metadata.gz: 19a2cff1aab50ad0412e515a2081b85dcd8f94addf96232bfb2be3694b02980410df1a8788d3451907a985b26fc6cfecb1dd7d45750ba108b63f84975ea36996
+  data.tar.gz: 9af9ad631d684be5485a43620b76dcda02e7e223e50b6ecab47def52ee24fa4ab296dff43e5eea11c03acaea5146178da9cced4740ebb1036b41edef38ba0852

data/lib/specbandit/cli.rb

@@ -123,10 +123,22 @@ module Specbandit
           Specbandit.configuration.key_rerun_ttl = v
         end
 
+        opts.on('--key-failed KEY', 'Redis key to record failed test files for later review') do |v|
+          Specbandit.configuration.key_failed = v
+        end
+
+        opts.on('--key-failed-ttl SECONDS', Integer, 'TTL for failed key in seconds (default: 604800 / 1 week)') do |v|
+          Specbandit.configuration.key_failed_ttl = v
+        end
+
         opts.on('--rerun', 'Signal this is a re-run (fail hard if rerun key is empty)') do
           Specbandit.configuration.rerun = true
         end
 
+        opts.on('--report FILE', 'Write JSON report with run statistics to FILE') do |v|
+          Specbandit.configuration.report = v
+        end
+
         opts.on('--verbose', 'Show per-batch file list and full command output (default: quiet)') do
           Specbandit.configuration.verbose = true
         end
@@ -207,9 +219,12 @@ module Specbandit
           --rspec-opts OPTS      Extra options forwarded to RSpec (for rspec adapter)
           --batch-size N         Files per batch (default: 5, or set SPECBANDIT_BATCH_SIZE)
           --redis-url URL        Redis URL (default: redis://localhost:6379)
-          --key-rerun KEY        Per-runner rerun key for re-run support
-          --key-rerun-ttl N      TTL for rerun key (default: 604800 / 1 week)
-          --rerun                Signal this is a re-run (fail hard if rerun key is empty)
+           --key-rerun KEY        Per-runner rerun key for re-run support
+           --key-rerun-ttl N      TTL for rerun key (default: 604800 / 1 week)
+           --key-failed KEY       Redis key to record failed test files
+           --key-failed-ttl N     TTL for failed key (default: 604800 / 1 week)
+           --rerun                Signal this is a re-run (fail hard if rerun key is empty)
+          --report FILE          Write JSON report to FILE after run
           --verbose              Show per-batch file list and full command output
 
           Arguments after -- are forwarded to the adapter (rspec opts, command opts, etc.).
@@ -226,8 +241,11 @@ module Specbandit
           SPECBANDIT_RSPEC_OPTS       RSpec options (rspec adapter)
           SPECBANDIT_KEY_RERUN        Per-runner rerun key
           SPECBANDIT_KEY_RERUN_TTL    Rerun key TTL in seconds (default: 604800)
+          SPECBANDIT_KEY_FAILED       Redis key for failed test files
+          SPECBANDIT_KEY_FAILED_TTL   Failed key TTL in seconds (default: 604800)
           SPECBANDIT_RERUN            Signal re-run mode (1/true/yes)
           SPECBANDIT_VERBOSE          Enable verbose output (1/true/yes)
+          SPECBANDIT_REPORT           Path to write JSON report file
 
         File input priority for push:
           1. stdin (piped)     echo "spec/a_spec.rb" | specbandit push --key KEY

data/lib/specbandit/configuration.rb

@@ -4,12 +4,14 @@ module Specbandit
   class Configuration
     attr_accessor :redis_url, :batch_size, :key, :rspec_opts, :key_ttl,
                   :key_rerun, :key_rerun_ttl, :rerun, :verbose,
-                  :adapter, :command, :command_opts
+                  :adapter, :command, :command_opts,
+                  :key_failed, :key_failed_ttl, :report
 
     DEFAULT_REDIS_URL = 'redis://localhost:6379'
     DEFAULT_BATCH_SIZE = 5
     DEFAULT_KEY_TTL = 21_600 # 6 hours in seconds
     DEFAULT_KEY_RERUN_TTL = 604_800 # 1 week in seconds
+    DEFAULT_KEY_FAILED_TTL = 604_800 # 1 week in seconds
     DEFAULT_ADAPTER = 'cli'
 
     def initialize
@@ -25,6 +27,9 @@ module Specbandit
       @adapter = ENV.fetch('SPECBANDIT_ADAPTER', DEFAULT_ADAPTER)
       @command = ENV.fetch('SPECBANDIT_COMMAND', nil)
       @command_opts = parse_space_separated(ENV.fetch('SPECBANDIT_COMMAND_OPTS', nil))
+      @key_failed = ENV.fetch('SPECBANDIT_KEY_FAILED', nil)
+      @key_failed_ttl = Integer(ENV.fetch('SPECBANDIT_KEY_FAILED_TTL', DEFAULT_KEY_FAILED_TTL))
+      @report = ENV.fetch('SPECBANDIT_REPORT', nil)
     end
 
     def validate!
@@ -32,6 +37,7 @@ module Specbandit
       raise Error, 'batch_size must be a positive integer' unless batch_size.positive?
       raise Error, 'key_ttl must be a positive integer' unless key_ttl.positive?
       raise Error, 'key_rerun_ttl must be a positive integer' unless key_rerun_ttl.positive?
+      raise Error, 'key_failed_ttl must be a positive integer' unless key_failed_ttl.positive?
       raise Error, '--rerun requires --key-rerun to be set' if rerun && (key_rerun.nil? || key_rerun.empty?)
     end
 

data/lib/specbandit/rspec_adapter.rb

@@ -65,10 +65,10 @@ module Specbandit
     ensure
       # Print RSpec output through our output stream
       rspec_output = out&.string
-      output.print(rspec_output) if verbose && rspec_output && !rspec_output.empty?
+      output.print(rspec_output) if rspec_output && !rspec_output.empty?
 
       rspec_err = err&.string
-      output.print(rspec_err) if verbose && rspec_err && !rspec_err.empty?
+      output.print(rspec_err) if rspec_err && !rspec_err.empty?
 
       # Don't unlink the tempfile here — the Worker needs to read it.
       # The Worker is responsible for cleanup after accumulation.

data/lib/specbandit/version.rb

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

data/lib/specbandit/worker.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'stringio'
 require 'json'
 
 module Specbandit
   class Worker
-    attr_reader :queue, :key, :batch_size, :adapter, :key_rerun, :key_rerun_ttl, :rerun, :output, :verbose
+    attr_reader :queue, :key, :batch_size, :adapter, :key_rerun, :key_rerun_ttl, :key_failed, :key_failed_ttl, :rerun,
+                :output, :verbose, :report
 
     def initialize(
       key: Specbandit.configuration.key,
@@ -13,8 +13,11 @@ module Specbandit
       adapter: nil,
       key_rerun: Specbandit.configuration.key_rerun,
       key_rerun_ttl: Specbandit.configuration.key_rerun_ttl,
+      key_failed: Specbandit.configuration.key_failed,
+      key_failed_ttl: Specbandit.configuration.key_failed_ttl,
       rerun: Specbandit.configuration.rerun,
       verbose: Specbandit.configuration.verbose,
+      report: Specbandit.configuration.report,
       queue: nil,
       output: $stdout,
       # Legacy parameter for backward compatibility.
@@ -25,12 +28,16 @@ module Specbandit
       @batch_size = batch_size
       @key_rerun = key_rerun
       @key_rerun_ttl = key_rerun_ttl
+      @key_failed = key_failed
+      @key_failed_ttl = key_failed_ttl
       @rerun = rerun
       @verbose = verbose
+      @report = report
       @queue = queue || RedisQueue.new
       @output = output
       @batch_results = []
       @accumulated_examples = []
+      @accumulated_failed_files = []
       @accumulated_summary = { duration: 0.0, example_count: 0, failure_count: 0, pending_count: 0,
                                errors_outside_of_examples_count: 0 }
 
@@ -47,6 +54,7 @@ module Specbandit
     #
     # Returns 0 if all batches passed (or nothing to do), 1 if any batch failed.
     def run
+      @run_start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       adapter.setup
 
       exit_code = if key_rerun
@@ -67,8 +75,7 @@ module Specbandit
 
       print_summary if @batch_results.any?
       merge_json_results
-      write_github_step_summary if ENV['GITHUB_STEP_SUMMARY']
-
+      write_report
       exit_code
     ensure
       adapter.teardown
@@ -80,29 +87,32 @@ module Specbandit
     # Used when re-running a failed CI job -- the rerun key already
     # contains the exact files this runner executed previously.
     def run_replay(files)
-      output.puts "[specbandit] Replay mode: found #{files.size} files in rerun key '#{key_rerun}'."
-      output.puts '[specbandit] Running previously recorded files (not touching shared queue).'
+      output.puts "[specbandit] Replay mode: found #{files.size} files in rerun key '#{key_rerun}'." if verbose
+      output.puts '[specbandit] Running previously recorded files (not touching shared queue).' if verbose
 
       failed = false
       batch_num = 0
 
       files.each_slice(batch_size) do |batch|
         batch_num += 1
-        output.puts "[specbandit] Batch ##{batch_num}: running #{batch.size} files"
+        output.puts "[specbandit] Batch ##{batch_num}: running #{batch.size} files" if verbose
         batch.each { |f| output.puts "  #{f}" } if verbose
 
         result = adapter.run_batch(batch, batch_num)
+        record_failed_files(batch, result)
         process_batch_result(result)
 
         if result.exit_code != 0
-          output.puts "[specbandit] Batch ##{batch_num} FAILED (exit code: #{result.exit_code})"
+          output.puts "[specbandit] Batch ##{batch_num} FAILED (exit code: #{result.exit_code})" if verbose
           failed = true
-        else
+        elsif verbose
           output.puts "[specbandit] Batch ##{batch_num} passed."
         end
       end
 
-      output.puts "[specbandit] Replay finished: #{batch_num} batches. #{failed ? 'SOME FAILED' : 'All passed.'}"
+      if verbose
+        output.puts "[specbandit] Replay finished: #{batch_num} batches. #{failed ? 'SOME FAILED' : 'All passed.'}"
+      end
       failed ? 1 : 0
     end
 
@@ -111,8 +121,8 @@ module Specbandit
     # rerun key so this runner can replay them on a re-run.
     def run_steal(record:)
       mode_label = record ? 'Record' : 'Steal'
-      output.puts "[specbandit] #{mode_label} mode: stealing batches from '#{key}'."
-      output.puts "[specbandit] Recording stolen files to rerun key '#{key_rerun}'." if record
+      output.puts "[specbandit] #{mode_label} mode: stealing batches from '#{key}'." if verbose
+      output.puts "[specbandit] Recording stolen files to rerun key '#{key_rerun}'." if verbose && record
 
       failed = false
       batch_num = 0
@@ -121,7 +131,7 @@ module Specbandit
         files = queue.steal(key, batch_size)
 
         if files.empty?
-          output.puts '[specbandit] Queue exhausted. No more files to run.'
+          output.puts '[specbandit] Queue exhausted. No more files to run.' if verbose
           break
         end
 
@@ -129,34 +139,74 @@ module Specbandit
         queue.push(key_rerun, files, ttl: key_rerun_ttl) if record
 
         batch_num += 1
-        output.puts "[specbandit] Batch ##{batch_num}: running #{files.size} files"
+        output.puts "[specbandit] Batch ##{batch_num}: running #{files.size} files" if verbose
         files.each { |f| output.puts "  #{f}" } if verbose
 
         result = adapter.run_batch(files, batch_num)
+        record_failed_files(files, result)
         process_batch_result(result)
 
         if result.exit_code != 0
-          output.puts "[specbandit] Batch ##{batch_num} FAILED (exit code: #{result.exit_code})"
+          output.puts "[specbandit] Batch ##{batch_num} FAILED (exit code: #{result.exit_code})" if verbose
           failed = true
-        else
+        elsif verbose
           output.puts "[specbandit] Batch ##{batch_num} passed."
         end
       end
 
       if batch_num.zero?
-        output.puts '[specbandit] Nothing to do (queue was empty).'
-      else
+        output.puts '[specbandit] Nothing to do (queue was empty).' if verbose
+      elsif verbose
         output.puts "[specbandit] Finished #{batch_num} batches. #{failed ? 'SOME FAILED' : 'All passed.'}"
       end
 
       failed ? 1 : 0
     end
 
+    # Record failed files to the failed key in Redis for later review.
+    # Called after each batch; only pushes when key_failed is configured
+    # and the batch had a non-zero exit code.
+    #
+    # For RSpec batches with JSON output, only the individual failed file
+    # paths are recorded (not the entire batch). For CLI adapter batches
+    # (no per-file granularity), the whole batch is recorded as fallback.
+    def record_failed_files(files, result)
+      return unless key_failed
+      return if result.exit_code.zero?
+
+      failed_files = extract_failed_files(result) || files
+      return if failed_files.empty?
+
+      queue.push(key_failed, failed_files, ttl: key_failed_ttl)
+    end
+
+    # Extract individual failed file paths from an RspecBatchResult's JSON output.
+    # Returns nil when per-file data is not available (CLI adapter).
+    def extract_failed_files(result)
+      return nil unless result.is_a?(RspecBatchResult) && result.json_path && File.exist?(result.json_path)
+
+      data = JSON.parse(File.read(result.json_path))
+      failed = data.fetch('examples', [])
+                   .select { |e| e['status'] == 'failed' }
+                   .filter_map { |e| e['file_path'] }
+                   .uniq
+
+      failed.empty? ? nil : failed
+    rescue JSON::ParserError
+      nil
+    end
+
     # Process a BatchResult: store it, and for RSpec batches,
     # read the JSON output for rich reporting.
     def process_batch_result(result)
       @batch_results << result
 
+      # Accumulate failed files for the report while JSON data is still available.
+      if result.exit_code != 0
+        per_file = extract_failed_files(result)
+        @accumulated_failed_files.concat(per_file || result.files)
+      end
+
       # If the adapter returned an RspecBatchResult with a json_path,
       # accumulate the structured results for rich reporting.
       return unless result.is_a?(RspecBatchResult) && result.json_path
@@ -243,6 +293,48 @@ module Specbandit
       File.write(path, JSON.pretty_generate(merged))
     end
 
+    # Write a JSON report file with run statistics when --report is set.
+    def write_report
+      return unless report
+      return if @batch_results.empty?
+
+      wall_time = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - @run_start_time).round(2)
+      durations = batch_durations
+      failed_batches_count = @batch_results.count { |r| r.exit_code != 0 }
+      passed_batches_count = @batch_results.count { |r| r.exit_code == 0 }
+
+      data = {
+        specbandit_version: Specbandit::VERSION,
+        summary: {
+          total_files: @batch_results.sum { |r| r.files.size },
+          total_batches: @batch_results.size,
+          passed_batches: passed_batches_count,
+          failed_batches: failed_batches_count,
+          passed: failed_batches_count == 0
+        },
+        failed_files: @accumulated_failed_files.uniq,
+        total_wall_time: wall_time,
+        batch_timings: {
+          count: durations.size,
+          min: format('%.2f', durations.min || 0),
+          avg: format('%.2f', durations.empty? ? 0 : durations.sum / durations.size),
+          max: format('%.2f', durations.max || 0),
+          all: durations.map { |d| d.round(2) }
+        },
+        batches: @batch_results.map do |r|
+          {
+            batch_num: r.batch_num,
+            files: r.files,
+            exit_code: r.exit_code,
+            duration: r.duration.round(2),
+            passed: r.exit_code == 0
+          }
+        end
+      }
+
+      File.write(report, JSON.pretty_generate(data))
+    end
+
     # Print a unified summary to the output stream after all batches.
     def print_summary
       output.puts ''
@@ -310,92 +402,5 @@ module Specbandit
       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
-
-      if has_rspec_results?
-        write_rspec_github_summary(md)
-      else
-        write_generic_github_summary(md)
-      end
-
-      File.open(path, 'a') { |f| f.write(md.string) }
-    rescue StandardError
-      # Never fail the build because of summary writing
-      nil
-    end
-
-    def write_rspec_github_summary(md)
-      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' }
-      return unless 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
-
-    def write_generic_github_summary(md)
-      total_files = @batch_results.sum { |r| r.files.size }
-      failed_batch_results = @batch_results.select { |r| r.exit_code != 0 }
-
-      md.puts '### Specbandit Results'
-      md.puts ''
-      md.puts '| Metric | Value |'
-      md.puts '|--------|-------|'
-      md.puts "| Batches | #{batch_durations.size} |"
-      md.puts "| Files | #{total_files} |"
-      md.puts "| Failed batches | #{failed_batch_results.size} |"
-
-      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 ''
-
-      return unless failed_batch_results.any?
-
-      md.puts "<details><summary>#{failed_batch_results.size} failed batches</summary>"
-      md.puts ''
-      md.puts '| Batch | Exit Code | Files |'
-      md.puts '|-------|-----------|-------|'
-      failed_batch_results.each do |r|
-        files_str = r.files.map { |f| "`#{f}`" }.join(', ')
-        md.puts "| ##{r.batch_num} | #{r.exit_code} | #{files_str} |"
-      end
-      md.puts ''
-      md.puts '</details>'
-    end
   end
 end

metadata

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