testament-probe-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 337fe8994c7ab64268d451d7b9f91e671251036eade4ed01905f42a10dd366f8
-  data.tar.gz: 5faf2fb1f40a1df3cbed28907b6871940ec05d498a284d955fa1b06fc2f78c18
+  metadata.gz: 1ab715c89e0d43c163220f9f1633de46ad9e9e254d2fbff375ff8b54372de558
+  data.tar.gz: e915052f16dee7902514be50a7288b5073a89ade62e43a5b8231b031d58a92f9
 SHA512:
-  metadata.gz: 55f1e5ff0529789880754d15acd90be7ee2a58d4104983800d5c592175f74de4a97597e3e49f1009dcc0c6f2114ada4ca4c1687ff00e1730ab841cdacdd6763c
-  data.tar.gz: 4c6d77433a6e09c18b446672af24937812a71c7a49c0cdd31213d2a89b544c5ca9634b576806d74027a0107db3328dc5b6b68d705442d35fc8b0102d2b3d05d9
+  metadata.gz: 8bcd3d5d9076e7b8fcc933792b78330fce86e4eda94b7e4cf0eefc5df0fcea37d1981c214201b17e05c1947f692329bef0d652c126e24918d46969186f8738df
+  data.tar.gz: db97ce291dfdf7342216d1977d7c0bc941ebeeb28c378f7a316c81c9a7fcf6591211ea39d4615ffb4a3735795eb4875b459d0971817484e24a89326b8dfa1244

data/README.md

@@ -19,10 +19,12 @@ The trace output records executed project lines, lines executed while assertion
 methods are active, and recent executed lines observed when assertions begin.
 `TESTAMENT_PROJECT_ROOT` controls the project-root filter, and
 `TESTAMENT_TRACE_WINDOW` controls how many recent lines are attributed to an
-assertion.
+assertion. The trace JSON records this window and the temporal approximation
+method alongside the cases.
 
-Line/call tracing adds noticeable overhead to the test run. Set
-`TESTAMENT_TRACE=0` to collect per-test line coverage without trace evidence.
+Line tracing collects per-test coverage without changing Ruby's process-wide
+`Coverage` counters. Call tracing adds further overhead for assertion evidence;
+set `TESTAMENT_TRACE=0` to disable that evidence while retaining line coverage.
 
 The probe installs hooks for RSpec and Minitest when those constants are loaded.
 Load the probe after the test framework is required.

data/lib/testament/probe/version.rb

@@ -2,6 +2,6 @@
 
 module Testament
   module Probe
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/testament/probe.rb

@@ -1,4 +1,3 @@
-require "coverage"
 require "fileutils"
 require "json"
 require_relative "probe/version"
@@ -8,6 +7,7 @@ module Testament
     DEFAULT_OUTPUT = ".testament/per-test-coverage.json"
     DEFAULT_TRACE_OUTPUT = ".testament/trace.json"
     DEFAULT_TRACE_WINDOW = 200
+    THREAD_STATE_KEY = :testament_probe_recording
     ASSERTION_METHODS = %i[
       expect should should_not to not_to to_not
       assert assert_equal assert_same assert_nil assert_not_nil assert_empty
@@ -32,29 +32,27 @@ module Testament
         @probe_file = File.expand_path(__FILE__)
         @trace_window = ENV.fetch("TESTAMENT_TRACE_WINDOW", DEFAULT_TRACE_WINDOW).to_i
         @trace_enabled = ENV.fetch("TESTAMENT_TRACE", "1") != "0"
-        start_coverage
-        capture_coverage
         install_rspec if defined?(RSpec)
         install_minitest if defined?(Minitest::Test)
         at_exit { write! }
       end
 
       def record(case_id)
-        start_coverage
         start_trace
-        previous_case = @current_case
-        previous_recent_lines = @recent_lines
-        previous_assertion_depth = @assertion_depth
-        @recent_lines = []
-        @assertion_depth = 0
-        @current_case = case_id
-        trace_cases[case_id]
+        previous = Thread.current[THREAD_STATE_KEY]
+        recording = {
+          case_id: case_id,
+          coverage: {},
+          executed: {},
+          checked: {},
+          recent_lines: [],
+          assertion_depth: 0
+        }
+        Thread.current[THREAD_STATE_KEY] = recording
         yield
       ensure
-        merge_case(case_id, capture_coverage) if case_id
-        @recent_lines = previous_recent_lines || []
-        @assertion_depth = previous_assertion_depth || 0
-        @current_case = previous_case
+        merge_recording(recording) if case_id && recording
+        Thread.current[THREAD_STATE_KEY] = previous
       end
 
       def write!
@@ -64,7 +62,11 @@ module Testament
 
         trace_output = @trace_output || DEFAULT_TRACE_OUTPUT
         FileUtils.mkdir_p(File.dirname(trace_output))
-        File.write(trace_output, JSON.pretty_generate("cases" => trace_cases))
+        File.write(trace_output, JSON.pretty_generate(
+          "method" => "temporal-recent-line-window",
+          "window" => trace_window,
+          "cases" => trace_cases
+        ))
       end
 
       private
@@ -79,17 +81,10 @@ module Testament
         end
       end
 
-      def start_coverage
-        return false if coverage_running?
-
-        Coverage.start(lines: true)
-        true
-      end
-
       def start_trace
-        return unless @trace_enabled
-
-        @tracepoint ||= TracePoint.new(:line, :call, :c_call, :return, :c_return) do |event|
+        events = [:line]
+        events.concat([:call, :c_call, :return, :c_return]) if @trace_enabled
+        @tracepoint ||= TracePoint.new(*events) do |event|
           case event.event
           when :line
             record_trace_line(event.path, event.lineno)
@@ -102,49 +97,56 @@ module Testament
         @tracepoint.enable unless @tracepoint.enabled?
       end
 
-      def coverage_running?
-        Coverage.respond_to?(:running?) && Coverage.running?
+      def merge_recording(recording)
+        mutex.synchronize do
+          merge_lines(cases, recording[:case_id], recording[:coverage])
+          if @trace_enabled
+            trace = trace_cases[recording[:case_id]]
+            merge_files(trace["executed"], recording[:executed])
+            merge_files(trace["checked"], recording[:checked])
+          end
+        end
       end
 
-      def capture_coverage
-        Coverage.result(stop: false, clear: true)
-      rescue ArgumentError
-        Coverage.result
+      def merge_lines(collection, case_id, files)
+        merge_files(collection[case_id] ||= {}, files)
       end
 
-      def merge_case(case_id, coverage)
-        normalized = normalize_coverage(coverage)
-        return if normalized.empty?
-
-        existing = cases.fetch(case_id, {})
-        normalized.each do |path, lines|
-          merged = (existing.fetch(path, []) + lines).uniq.sort
-          existing[path] = merged
+      def merge_files(existing, additions)
+        additions.each do |path, lines|
+          existing[path] = (existing.fetch(path, []) + lines).uniq.sort
         end
-        cases[case_id] = existing
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
       end
 
       def record_trace_line(path, line)
-        return unless @current_case
+        recording = Thread.current[THREAD_STATE_KEY]
+        return unless recording
 
         path = normalize_trace_path(path)
         return unless path
 
-        trace = trace_cases[@current_case]
-        append_trace_line(trace["executed"], path, line)
-        append_trace_line(trace["checked"], path, line) if assertion_active?
-        @recent_lines ||= []
-        @recent_lines << [path, line]
-        @recent_lines.shift while @recent_lines.length > trace_window
+        append_trace_line(recording[:coverage], path, line)
+        return unless @trace_enabled
+
+        append_trace_line(recording[:executed], path, line)
+        append_trace_line(recording[:checked], path, line) if assertion_active?
+        recording[:recent_lines] << [path, line]
+        recording[:recent_lines].shift while recording[:recent_lines].length > trace_window
       end
 
       def enter_assertion
         mark_recent_lines_checked
-        @assertion_depth = assertion_depth + 1
+        recording = Thread.current[THREAD_STATE_KEY]
+        recording[:assertion_depth] = assertion_depth + 1 if recording
       end
 
       def leave_assertion
-        @assertion_depth = [assertion_depth - 1, 0].max
+        recording = Thread.current[THREAD_STATE_KEY]
+        recording[:assertion_depth] = [assertion_depth - 1, 0].max if recording
       end
 
       def assertion_active?
@@ -152,15 +154,15 @@ module Testament
       end
 
       def assertion_depth
-        @assertion_depth ||= 0
+        Thread.current[THREAD_STATE_KEY]&.fetch(:assertion_depth, 0) || 0
       end
 
       def mark_recent_lines_checked
-        return unless @current_case
+        recording = Thread.current[THREAD_STATE_KEY]
+        return unless recording
 
-        checked = trace_cases[@current_case]["checked"]
-        @recent_lines.each do |path, line|
-          append_trace_line(checked, path, line)
+        recording[:recent_lines].each do |path, line|
+          append_trace_line(recording[:checked], path, line)
         end
       end
 
@@ -193,39 +195,11 @@ module Testament
         [@trace_window || DEFAULT_TRACE_WINDOW, 1].max
       end
 
-      def normalize_coverage(coverage)
-        coverage.each_with_object({}) do |(path, value), result|
-          lines = line_hits(value)
-          covered = lines.each_with_index.filter_map do |hits, index|
-            index + 1 if hits && hits.positive?
-          end
-          result[path] = covered unless covered.empty?
-        end
-      end
-
-      def line_hits(value)
-        if value.is_a?(Hash)
-          unless value.key?(:lines) || value.key?("lines")
-            warn_missing_line_coverage
-            return []
-          end
-          value.fetch(:lines, value.fetch("lines", []))
-        else
-          value || []
-        end
-      end
-
-      def warn_missing_line_coverage
-        return if @warned_missing_line_coverage
-
-        warn "testament probe: Coverage is active without lines mode; per-test coverage will be empty"
-        @warned_missing_line_coverage = true
-      end
-
       def install_rspec
         RSpec.configure do |config|
           config.around(:each) do |example|
-            Testament::Probe.record(example.full_description) { example.run }
+            location = example.metadata[:location].to_s.sub(%r{\A\./}, "")
+            Testament::Probe.record("#{location}::#{example.full_description}") { example.run }
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testament-probe-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yudai Takada
@@ -44,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Per-test Ruby coverage and trace probe for testament
 test_files: []