branchproof 0.9.0 → 0.10.0

data/lib/branchproof/worker.rb

@@ -8,19 +8,18 @@ require "stringio"
 require "fileutils"
 
 module Branchproof
-  # Runs one isolated Minitest worker and atomically exports its result.
+  # Runs one isolated test worker and atomically exports its result.
   module Worker
     module_function
 
     def child_process(config_path)
+      $stdout.sync = true
+      $stderr.sync = true
       payload = JSON.parse(File.binread(config_path))
       project = symbolize(payload.fetch("project"))
       prepend_load_paths(project)
       inventory = symbolize(payload.fetch("inventory"))
       limits = symbolize(payload.fetch("limits"))
-      require "minitest"
-      require "minitest/test"
-      require_relative "minitest_adapter"
       evidence = Branchproof::Evidence.new(inventory: inventory, limits: limits, run_id: payload.fetch("run_id"))
       runtime = Branchproof::Runtime
       runtime.boot(evidence: evidence)
@@ -28,23 +27,38 @@ module Branchproof
       status = loader.install
       return write_failure(payload, "loader", status) unless status[:status].to_sym == :installed
 
-      adapter = Branchproof::MinitestAdapter.new(runtime: runtime)
+      adapter = adapter_for(project, runtime)
+      guard_late_rspec_execution(adapter, payload) if project[:framework].to_s == "rspec"
       rails_metadata = nil
       ARGV.replace(payload.fetch("runner_args"))
-      adapter.run(test_files: payload.fetch("test_files"), runner_args: payload.fetch("runner_args"),
-                  before_load: lambda {
-                    rails_metadata = boot_project(project)
-                  }, on_complete: lambda { |baseline|
-                    result = completion_result(baseline: baseline, project: project, rails_metadata: rails_metadata,
-                                               evidence: runtime.snapshot, tests: adapter.tests.values,
-                                               diagnostics: loader.diagnostics)
-                    write_completion(payload, result)
-                  })
+      callbacks = if project[:framework].to_s == "rspec"
+                    { test_selection_explicit: payload.fetch("test_selection_explicit", false), after_load: lambda {
+                      require_relative "rails_support"
+                      rails_metadata = Branchproof::RailsSupport.validate_rspec!(project: project)
+                    } }
+                  else
+                    {}
+                  end
+      before_load = lambda do
+        rails_metadata = boot_project(project) unless project[:framework].to_s == "rspec"
+      end
+      on_complete = lambda do |baseline|
+        result = completion_result(baseline: baseline, project: project, rails_metadata: rails_metadata,
+                                   evidence: runtime.snapshot, tests: adapter.tests.values,
+                                   diagnostics: loader.diagnostics)
+        write_completion(payload, result)
+      end
+      exit_status = adapter.run(test_files: payload.fetch("test_files"), runner_args: payload.fetch("runner_args"),
+                                before_load: before_load, on_complete: on_complete, **callbacks)
+      return exit_status if project[:framework].to_s == "rspec"
+
       adapter.validate_runner!
       Minitest.autorun
       nil
     rescue StandardError => e
-      code = if e.message.include?("parallel")
+      code = if e.respond_to?(:diagnostic_code)
+               e.diagnostic_code
+             elsif e.message.match?(/parallel|runner|bisect|DRb|dry.run/)
                "unsupported_runner"
              elsif defined?(Branchproof::RailsSupport::Error) && e.is_a?(Branchproof::RailsSupport::Error)
                "rails_boot"
@@ -55,6 +69,44 @@ module Branchproof
       2
     end
 
+    def adapter_for(project, runtime)
+      if project[:framework].to_s == "rspec"
+        begin
+          require "rspec/core"
+        rescue LoadError => e
+          raise unless e.path == "rspec/core"
+
+          error = ArgumentError.new("RSpec is not available; add rspec to the application's test bundle")
+          def error.diagnostic_code = "rspec_missing"
+          raise error
+        end
+        require_relative "rspec_adapter"
+        Branchproof::RSpecAdapter.new(runtime: runtime)
+      else
+        require "minitest"
+        require "minitest/test"
+        require_relative "minitest_adapter"
+        Branchproof::MinitestAdapter.new(runtime: runtime)
+      end
+    end
+
+    # Installed before application hooks, so this runs after their at_exit work.
+    # A rescued second runner must still invalidate the already-exported result.
+    def guard_late_rspec_execution(adapter, payload)
+      at_exit do
+        error = adapter.late_execution_error
+        if error
+          result = symbolize(JSON.parse(File.binread(payload.fetch("result_path"))))
+          diagnostic = { code: "unsupported_runner", severity: "error", message: error.message }
+          result.merge!(status: "ERROR", finalized: false, exit_status: 2,
+                        diagnostics: Array(result[:diagnostics]) + [diagnostic])
+          result[:evidence] = incomplete_evidence(result[:evidence], [diagnostic]) if result[:evidence]
+          write_completion(payload, result)
+          exit(2)
+        end
+      end
+    end
+
     def legacy_project
       { "kind" => "ruby", "root" => Dir.pwd,
         "load_paths" => [File.join(Dir.pwd, "lib"), File.join(Dir.pwd, "test")],
@@ -76,7 +128,14 @@ module Branchproof
     end
 
     def project_metadata(project, rails_metadata)
+      framework = project[:framework].to_s.empty? ? "minitest" : project[:framework].to_s
+      version = if framework == "rspec" && defined?(RSpec::Core::Version::STRING)
+                  RSpec::Core::Version::STRING
+                elsif framework == "minitest" && defined?(Minitest::VERSION)
+                  Minitest::VERSION
+                end
       metadata = { kind: project[:kind].to_s, root: project[:root].to_s,
+                   framework: framework, framework_version: version,
                    load_paths: Array(project[:load_paths]).map(&:to_s), serial_policy: { mode: "single_process", workers: 1 } }
       metadata.merge!(rails_metadata) if rails_metadata
       metadata
@@ -85,6 +144,7 @@ module Branchproof
     # This result boundary intentionally carries the complete worker payload.
     # rubocop:disable-next Metrics/ParameterLists
     def completion_result(baseline:, project:, rails_metadata:, evidence:, tests:, diagnostics:)
+      diagnostics = Array(baseline[:diagnostics]) + diagnostics
       result = baseline.merge(project: project_metadata(project, rails_metadata), evidence: evidence,
                               tests: tests, diagnostics: diagnostics)
       return result unless diagnostics.any? { |diagnostic| diagnostic[:severity].to_s == "error" }

data/lib/branchproof.rb

@@ -14,6 +14,7 @@ module Branchproof
   autoload :Loader, "branchproof/loader"
   autoload :Runtime, "branchproof/runtime"
   autoload :MinitestAdapter, "branchproof/minitest_adapter"
+  autoload :RSpecAdapter, "branchproof/rspec_adapter"
   autoload :Evidence, "branchproof/evidence"
   autoload :Analyzer, "branchproof/analyzer"
   autoload :Constraints, "branchproof/constraints"

data/llms.txt

@@ -2,7 +2,7 @@
 
 |  |  |
 | --- | --- |
-| **Defined in** | lib/branchproof.rb, lib/branchproof/cli.rb, lib/branchproof/limits.rb, lib/branchproof/loader.rb, lib/branchproof/report.rb, lib/branchproof/source.rb, lib/branchproof/worker.rb, lib/branchproof/project.rb, lib/branchproof/records.rb, lib/branchproof/runtime.rb, lib/branchproof/version.rb, lib/branchproof/analyzer.rb, lib/branchproof/evidence.rb, lib/branchproof/minimizer.rb, lib/branchproof/comparison.rb, lib/branchproof/constraints.rb, lib/branchproof/instrumenter.rb, lib/branchproof/runtime_flow.rb, lib/branchproof/saved_report.rb, lib/branchproof/value_syntax.rb, lib/branchproof/rails_support.rb, lib/branchproof/value_runtime.rb, lib/branchproof/coverage_index.rb, lib/branchproof/decision_table.rb, lib/branchproof/default_syntax.rb, lib/branchproof/focused_report.rb, lib/branchproof/decision_syntax.rb, lib/branchproof/default_runtime.rb, lib/branchproof/exception_syntax.rb, lib/branchproof/iteration_syntax.rb, lib/branchproof/minitest_adapter.rb, lib/branchproof/comparison_report.rb, lib/branchproof/exception_runtime.rb, lib/branchproof/iteration_runtime.rb, lib/branchproof/flow_instrumentation.rb, lib/branchproof/value_instrumentation.rb, lib/branchproof/default_instrumentation.rb, lib/branchproof/exception_instrumentation.rb, lib/branchproof/iteration_instrumentation.rb, lib/branchproof/extended_alternative_runtime.rb |
+| **Defined in** | lib/branchproof.rb, lib/branchproof/cli.rb, lib/branchproof/limits.rb, lib/branchproof/loader.rb, lib/branchproof/report.rb, lib/branchproof/source.rb, lib/branchproof/worker.rb, lib/branchproof/project.rb, lib/branchproof/records.rb, lib/branchproof/runtime.rb, lib/branchproof/version.rb, lib/branchproof/analyzer.rb, lib/branchproof/evidence.rb, lib/branchproof/minimizer.rb, lib/branchproof/comparison.rb, lib/branchproof/constraints.rb, lib/branchproof/instrumenter.rb, lib/branchproof/runtime_flow.rb, lib/branchproof/saved_report.rb, lib/branchproof/value_syntax.rb, lib/branchproof/rails_support.rb, lib/branchproof/rspec_adapter.rb, lib/branchproof/value_runtime.rb, lib/branchproof/coverage_index.rb, lib/branchproof/decision_table.rb, lib/branchproof/default_syntax.rb, lib/branchproof/focused_report.rb, lib/branchproof/decision_syntax.rb, lib/branchproof/default_runtime.rb, lib/branchproof/exception_syntax.rb, lib/branchproof/iteration_syntax.rb, lib/branchproof/minitest_adapter.rb, lib/branchproof/comparison_report.rb, lib/branchproof/exception_runtime.rb, lib/branchproof/iteration_runtime.rb, lib/branchproof/flow_instrumentation.rb, lib/branchproof/value_instrumentation.rb, lib/branchproof/default_instrumentation.rb, lib/branchproof/exception_instrumentation.rb, lib/branchproof/iteration_instrumentation.rb, lib/branchproof/extended_alternative_runtime.rb |
 
 Keep source-boundary and parameter-binding rules together for auditing.
 rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity,
@@ -43,6 +43,13 @@ Not documented.
 - [Branchproof/Minimizer.md](doc/Branchproof/Minimizer.md)
 - [Branchproof/MinitestAdapter.md](doc/Branchproof/MinitestAdapter.md)
 - [Branchproof/Project.md](doc/Branchproof/Project.md)
+- [Branchproof/RSpecAdapter/ClassRunnerGuard.md](doc/Branchproof/RSpecAdapter/ClassRunnerGuard.md)
+- [Branchproof/RSpecAdapter/ContextLifecycle.md](doc/Branchproof/RSpecAdapter/ContextLifecycle.md)
+- [Branchproof/RSpecAdapter/DefaultDiscovery.md](doc/Branchproof/RSpecAdapter/DefaultDiscovery.md)
+- [Branchproof/RSpecAdapter/ExampleLifecycle.md](doc/Branchproof/RSpecAdapter/ExampleLifecycle.md)
+- [Branchproof/RSpecAdapter/RunnerGuard.md](doc/Branchproof/RSpecAdapter/RunnerGuard.md)
+- [Branchproof/RSpecAdapter/UnsupportedRunner.md](doc/Branchproof/RSpecAdapter/UnsupportedRunner.md)
+- [Branchproof/RSpecAdapter.md](doc/Branchproof/RSpecAdapter.md)
 - [Branchproof/RailsSupport/Error.md](doc/Branchproof/RailsSupport/Error.md)
 - [Branchproof/RailsSupport.md](doc/Branchproof/RailsSupport.md)
 - [Branchproof/Records.md](doc/Branchproof/Records.md)

data/sig/branchproof.rbs

@@ -34,13 +34,15 @@ module Branchproof
 
   class Project
     MODES: Array[String]
+    FRAMEWORKS: Array[String]
     RAILS_ENVIRONMENT: record
-    def initialize: (root: String, ?mode: String) -> void
+    def initialize: (root: String, ?mode: String, ?framework: String) -> void
     def to_h: () -> record
   end
 
   module RailsSupport
     def self.boot: (project: record) -> record
+    def self.validate_rspec!: (project: record) -> record?
   end
 
   class Instrumenter
@@ -57,6 +59,8 @@ module Branchproof
   end
 
   module Runtime
+    def self.register_test: (test: record) -> record?
+    def self.test_phase_counts: () -> Hash[String, Hash[String, Integer]]
     def self.boot: (evidence: Evidence) -> nil
     def self.enter: (String decision_id) -> nil
     def self.condition: (String decision_id, Integer index, untyped value) -> untyped
@@ -100,6 +104,7 @@ module Branchproof
     def register_test: (test: record) -> record
     def record: (execution: record) -> record
     def diagnose: (diagnostic: record) -> nil
+    def test_phase_counts: () -> Hash[String, Hash[String, Integer]]
     def snapshot: () -> record
     def merge: (snapshot: record) -> record
   end
@@ -164,6 +169,27 @@ module Branchproof
     def run: (test_files: Array[String], runner_args: Array[String], on_complete: ^(record) -> untyped, ?before_load: ^() -> untyped?) -> nil
   end
 
+  class RSpecAdapter
+    class UnsupportedRunner < ArgumentError
+      def diagnostic_code: () -> String
+    end
+
+    FORBIDDEN_OPTIONS: Hash[Symbol, String]
+    attr_reader tests: Hash[String, record]
+    def self.active_adapter: () -> RSpecAdapter?
+    def self.active_adapter=: (RSpecAdapter?) -> RSpecAdapter?
+    def self.runner_adapter: () -> RSpecAdapter?
+    def self.runner_adapter=: (RSpecAdapter?) -> RSpecAdapter?
+    attr_reader late_execution_error: ArgumentError?
+    def initialize: (runtime: untyped) -> void
+    def reject_execution!: (String message) -> bot
+    def enter_runner!: (untyped runner) -> bool
+    def example_started: (untyped notification) -> untyped
+    def example_finished: (untyped notification) -> untyped
+    def run: (test_files: Array[String], runner_args: Array[String], on_complete: ^(record) -> untyped, ?before_load: ^() -> untyped?, ?after_load: ^() -> untyped?, ?test_selection_explicit: bool) -> untyped
+    def validate_runner!: () -> nil
+  end
+
   class Report
     SCHEMA_VERSION: String
     CRITERION_VERSION: String
@@ -175,6 +201,7 @@ module Branchproof
     def decision_table_requirement: (untyped value) -> String?
     def decision_table_reachability: (document rule) -> String
     def decision_table_expected_heading: (document decision) -> String
+    def rerun_command: (String test_id) -> String?
     def write: (io: _WriteIO, format: Symbol | String) -> nil
     def exit_code: () -> Integer
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branchproof
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Lucian Ghinda
@@ -50,7 +50,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 description: Inventory Ruby decisions and report masking MC/DC evidence from Minitest
-  runs.
+  or RSpec runs.
 email:
 - lucianghinda@users.noreply.github.com
 executables:
@@ -95,6 +95,13 @@ files:
 - doc/Branchproof/Minimizer.md
 - doc/Branchproof/MinitestAdapter.md
 - doc/Branchproof/Project.md
+- doc/Branchproof/RSpecAdapter.md
+- doc/Branchproof/RSpecAdapter/ClassRunnerGuard.md
+- doc/Branchproof/RSpecAdapter/ContextLifecycle.md
+- doc/Branchproof/RSpecAdapter/DefaultDiscovery.md
+- doc/Branchproof/RSpecAdapter/ExampleLifecycle.md
+- doc/Branchproof/RSpecAdapter/RunnerGuard.md
+- doc/Branchproof/RSpecAdapter/UnsupportedRunner.md
 - doc/Branchproof/RailsSupport.md
 - doc/Branchproof/RailsSupport/Error.md
 - doc/Branchproof/Records.md
@@ -142,6 +149,7 @@ files:
 - lib/branchproof/rails_support.rb
 - lib/branchproof/records.rb
 - lib/branchproof/report.rb
+- lib/branchproof/rspec_adapter.rb
 - lib/branchproof/runtime.rb
 - lib/branchproof/runtime_flow.rb
 - lib/branchproof/saved_report.rb