mutineer 1.5.0 → 1.7.0

data/lib/mutineer/test_runners/rspec.rb

@@ -12,7 +12,8 @@ module Mutineer
     # Child-process-only RSpec runner.
     #
     # Mirrors MinitestIntegration's contract: run the given spec files and
-    # return 0 (all passed) or 1 (any failure).
+    # return 0 (all passed), 1 (an example failed) or 2 (only an error
+    # outside examples, such as a spec file that raised while loading).
     module RSpec
       # Runs the given RSpec files.
       #
@@ -21,7 +22,7 @@ module Mutineer
       #   first failing example (RSpec `--fail-fast`).
       # @param record_to [IO, nil] a `--matrix` run: send each example's outcome
       #   to this channel (see {KillFormatter}) and run every example.
-      # @return [Integer] 0 on success, 1 on failure.
+      # @return [Integer] 0 on success, else {.failure_code}.
       # @raise [ArgumentError] when both options are given: a matrix run never stops.
       def self.run(spec_files, stop_at_first_failure: false, record_to: nil)
         if stop_at_first_failure && record_to
@@ -44,6 +45,7 @@ module Mutineer
         # silenced here: the fork boundary that calls this method has already
         # pointed stdout at File::NULL (see ChildStdout).
         sink = StringIO.new
+        keep_file_order(spec_files) if stop_at_first_failure || record_to
         args = ["--no-color"]
         args << "--fail-fast" if stop_at_first_failure
         status = with_fail_fast_off(record_to) do
@@ -55,7 +57,56 @@ module Mutineer
         # early, so `end` needs a reported outcome for every planned example.
         KillChannel.write_end(record_to) if record_to && KillFormatter.last&.saw_every_example?
 
-        status.zero? ? 0 : 1
+        status.zero? ? 0 : failure_code
+      ensure
+        FileOrder.rank = nil
+      end
+
+      # The exit status of a failed run: 2 when no example failed and RSpec
+      # recorded an error outside examples, else 1.
+      #
+      # @api private
+      # @return [Integer] 1 or 2.
+      def self.failure_code
+        world = ::RSpec.world
+        outside_examples = world.respond_to?(:non_example_failure) && world.non_example_failure
+        outside_examples && ::RSpec.configuration.reporter.failed_examples.empty? ? 2 : 1
+      end
+
+      # Runs the top-level example groups in the order of `spec_files` (#203),
+      # after RSpec's own ordering, which then decides the order within a file.
+      #
+      # @api private
+      # @param spec_files [String, Array<String>] the files, in run order.
+      # @return [void]
+      def self.keep_file_order(spec_files)
+        FileOrder.rank = Array(spec_files).each_with_index.to_h { |f, i| [File.expand_path(f), i] }
+        ::RSpec::Core::World.prepend(FileOrder) unless ::RSpec::Core::World <= FileOrder
+      end
+
+      # Prepended on `RSpec::Core::World`: a stable sort of the ordered
+      # top-level groups by their file's position. Does nothing without a rank.
+      module FileOrder
+        class << self
+          # Each spec file's position, keyed by absolute path, or nil.
+          #
+          # @return [Hash{String => Integer}, nil]
+          attr_accessor :rank
+        end
+
+        # The groups RSpec ordered, sorted by file position.
+        #
+        # @return [Array<RSpec::Core::ExampleGroup>]
+        def ordered_example_groups
+          groups = super
+          rank = FileOrder.rank
+          return groups unless rank
+
+          groups.sort_by.with_index do |group, i|
+            file = group.metadata[:absolute_file_path] || File.expand_path(group.file_path)
+            [rank.fetch(file, rank.size), i]
+          end
+        end
       end
 
       # Runs the block with fail-fast forced off when `record_to` is set: a

data/lib/mutineer/test_runners.rb

@@ -7,8 +7,9 @@ module Mutineer
   # Picks the test-framework runner.
   #
   # Each runner responds to
-  # `.run(files, stop_at_first_failure: false, record_to: nil) -> 0/1`
-  # (0 = all passed, 1 = any failure) and is called only inside a forked child.
+  # `.run(files, stop_at_first_failure: false, record_to: nil) -> 0/1/2`
+  # (0 = all passed, 1 = any failure, 2 = only an error outside tests, which
+  # the RSpec runner reports) and is called only inside a forked child.
   # Only the mutant path passes `stop_at_first_failure: true`; a `--matrix`
   # mutant run passes `record_to:` instead (a {KillChannel} pipe) and runs every
   # test. The fork boundary silences stdout (see ChildStdout); the runners do not.

data/lib/mutineer/triage.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "json"
+require "optparse"
+require "yaml"
+
+module Mutineer
+  # Prints `.mutineer.yml` `ignore:` entries for survivors in a JSON report.
+  # The command writes to stdout and does not edit files. The user pastes the
+  # lines under `ignore:`.
+  module Triage
+    # Usage line for a bad invocation.
+    USAGE = "Usage: mutineer triage REPORT.json --reason TEXT (--id ID ... | --all)"
+
+    # Reads argv, prints the entries, and returns the process exit code.
+    # 0 is success. 2 is a usage error.
+    #
+    # @param argv [Array<String>] arguments after the `triage` command.
+    # @param out [IO] where the entries go.
+    # @param err [IO] where usage errors go.
+    # @return [Integer] 0 or 2.
+    def self.run(argv, out: $stdout, err: $stderr)
+      reason = nil
+      ids = []
+      all = false
+      parser = OptionParser.new do |o|
+        o.banner = USAGE
+        o.on("--reason TEXT") { |text| reason = text }
+        o.on("--id ID") { |id| ids << id }
+        o.on("--all") { all = true }
+      end
+      begin
+        parser.parse!(argv)
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        err.puts "mutineer: #{e.message}"
+        return 2
+      end
+
+      report = argv.shift
+      if argv.any?
+        err.puts "mutineer: triage takes one report file"
+        return 2
+      end
+      if report.nil? || report.empty?
+        err.puts "mutineer: triage requires a JSON report file"
+        return 2
+      end
+      text = reason.to_s.strip
+      if reason.nil? || text.empty?
+        err.puts "mutineer: triage requires --reason TEXT"
+        return 2
+      end
+      if all && !ids.empty?
+        err.puts "mutineer: triage takes --id or --all, not both"
+        return 2
+      end
+      if !all && ids.empty?
+        err.puts "mutineer: triage requires --id ID or --all"
+        return 2
+      end
+
+      survivors = survivor_ids(report, err)
+      return 2 if survivors.nil?
+
+      chosen = all ? survivors : ids
+      missing = chosen.reject { |id| survivors.include?(id) }
+      unless missing.empty?
+        err.puts "mutineer: triage id is not a survivor: #{missing.join(', ')}"
+        return 2
+      end
+
+      entries = chosen.uniq.map { |id| { "id" => id, "reason" => text } }
+      if entries.empty?
+        err.puts "mutineer: triage has nothing to paste under ignore:"
+        return 0
+      end
+
+      body = YAML.dump(entries).sub(/\A---\n/, "")
+      out.write(body.end_with?("\n") ? body : "#{body}\n")
+      0
+    end
+
+    # Survivor ids from a JSON report, in report order. Nil when the file
+    # cannot be used, after a message on `err`.
+    #
+    # @param path [String] report path.
+    # @param err [IO] usage errors.
+    # @return [Array<String>, nil]
+    def self.survivor_ids(path, err)
+      unless File.file?(path)
+        err.puts "mutineer: triage report not found: #{path}"
+        return nil
+      end
+
+      doc = JSON.parse(File.read(path))
+      rows = doc.is_a?(Hash) ? doc["survivors"] : nil
+      unless rows.is_a?(Array)
+        err.puts "mutineer: triage report has no survivors list"
+        return nil
+      end
+
+      rows.filter_map { |row| row["id"] if row.is_a?(Hash) && row["id"].is_a?(String) }
+    rescue JSON::ParserError => e
+      err.puts "mutineer: triage report is not JSON: #{e.message}"
+      nil
+    rescue SystemCallError
+      err.puts "mutineer: triage report cannot be read: #{path}"
+      nil
+    end
+  end
+end

data/lib/mutineer/version.rb

@@ -2,5 +2,5 @@
 
 module Mutineer
   # Current Mutineer release version.
-  VERSION = "1.5.0"
+  VERSION = "1.7.0"
 end

data/lib/mutineer.rb

@@ -29,6 +29,7 @@ require_relative "mutineer/mutators/safe_navigation"
 require_relative "mutineer/mutators/range_literal"
 require_relative "mutineer/mutators/negation_removal"
 require_relative "mutineer/mutators/chain_link"
+require_relative "mutineer/mutators/call_to_receiver"
 require_relative "mutineer/mutators/operand_removal"
 require_relative "mutineer/mutators/array_literal"
 require_relative "mutineer/mutators/condition_forcing"
@@ -36,10 +37,14 @@ require_relative "mutineer/mutators/operator_assignment"
 require_relative "mutineer/mutator_registry"
 require_relative "mutineer/worker_pool"
 require_relative "mutineer/progress"
+require_relative "mutineer/job_plan"
 require_relative "mutineer/runner"
 require_relative "mutineer/kill_matrix"
 require_relative "mutineer/reporter"
 require_relative "mutineer/baseline"
+require_relative "mutineer/triage"
+require_relative "mutineer/migrate"
+require_relative "mutineer/init"
 require_relative "mutineer/cli"
 
 # Mutineer is the top-level namespace for the mutation-testing library.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutineer
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - David Teren
@@ -54,8 +54,10 @@ files:
 - lib/mutineer.rb
 - lib/mutineer/baseline.rb
 - lib/mutineer/changed_lines.rb
+- lib/mutineer/child_coverage.rb
 - lib/mutineer/child_stdout.rb
 - lib/mutineer/cli.rb
+- lib/mutineer/concern_blocks.rb
 - lib/mutineer/config.rb
 - lib/mutineer/coverage_map.rb
 - lib/mutineer/daemon_backend.rb
@@ -63,9 +65,12 @@ files:
 - lib/mutineer/daemon_server.rb
 - lib/mutineer/external_backend.rb
 - lib/mutineer/file_swap.rb
+- lib/mutineer/init.rb
 - lib/mutineer/isolation.rb
+- lib/mutineer/job_plan.rb
 - lib/mutineer/kill_channel.rb
 - lib/mutineer/kill_matrix.rb
+- lib/mutineer/migrate.rb
 - lib/mutineer/minitest_integration.rb
 - lib/mutineer/minitest_integration/kill_recorder.rb
 - lib/mutineer/minitest_integration/outer_reporter.rb
@@ -78,6 +83,7 @@ files:
 - lib/mutineer/mutators/base.rb
 - lib/mutineer/mutators/boolean_connector.rb
 - lib/mutineer/mutators/boolean_literal.rb
+- lib/mutineer/mutators/call_to_receiver.rb
 - lib/mutineer/mutators/chain_link.rb
 - lib/mutineer/mutators/collection_method.rb
 - lib/mutineer/mutators/comparison.rb
@@ -93,12 +99,15 @@ files:
 - lib/mutineer/mutators/safe_navigation.rb
 - lib/mutineer/mutators/statement_removal.rb
 - lib/mutineer/mutators/string_literal.rb
+- lib/mutineer/orphan_guard.rb
 - lib/mutineer/pairing.rb
 - lib/mutineer/parser.rb
 - lib/mutineer/progress.rb
 - lib/mutineer/project.rb
 - lib/mutineer/project_path.rb
+- lib/mutineer/rails_run_env.rb
 - lib/mutineer/rails_worker_db.rb
+- lib/mutineer/redaction.rb
 - lib/mutineer/reporter.rb
 - lib/mutineer/result.rb
 - lib/mutineer/runner.rb
@@ -107,6 +116,7 @@ files:
 - lib/mutineer/test_runners.rb
 - lib/mutineer/test_runners/minitest.rb
 - lib/mutineer/test_runners/rspec.rb
+- lib/mutineer/triage.rb
 - lib/mutineer/version.rb
 - lib/mutineer/worker_pool.rb
 homepage: https://github.com/davidteren/mutineer