appmap 0.98.1 → 0.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e852506550e061f5525d6dc83fd12facb5a77f17d1e3bcc78573c0a9d71294a
-  data.tar.gz: 0dea32a345dee9a20a91d2b1e034cbad8fcaae03dbc75d6f64c88639219241c0
+  metadata.gz: ff070f04eeeb2d79a08d4f93462a84e277dfad345bffd1d6b87bd063a63b8f00
+  data.tar.gz: 27e47f4e5a85fce938cbd259bf76cce952490851cfee98315fddf6d6b1c798d3
 SHA512:
-  metadata.gz: bb509b820a5b0c29bb906c9bf37b75bcad27f5abf6d36df19b2a1d4cbba7969e8b548a8e9fc5f77c6f5d9db1e5a7d607bdf52b41859ef5b0b9e77400c60a8324
-  data.tar.gz: 9d35cb3828fa3088825f933242c60e61d4fc71ec06bda382874424f6b3401cb55c9b14545e72976b1ea1d80df8fd642cea147d39c315507250a525dd48a35cff
+  metadata.gz: 97db1ff69373241c3e2ca4633fcca4c800d72b60734bde3b32aae2d3765e86f484e490a4148b98c9e90c40b3fa68cc9b734e56ce9175d1e26ec9bfc767b9707e
+  data.tar.gz: 074b036daecfc348fbe13510ab7c6cca46fe8d2d630bd81e28808ef4f05e15b47dedda31e9d3a2e423f426ba0980ea04e50439b3533b8b7690c9047be199a1a9

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.99.1](https://github.com/getappmap/appmap-ruby/compare/v0.99.0...v0.99.1) (2023-04-24)
+
+
+### Bug Fixes
+
+* backtrace_locations may be nil ([7f3890a](https://github.com/getappmap/appmap-ruby/commit/7f3890a00d5f4425fac273c72e5576cf7752eeaf)), closes [#324](https://github.com/getappmap/appmap-ruby/issues/324)
+
+# [0.99.0](https://github.com/getappmap/appmap-ruby/compare/v0.98.1...v0.99.0) (2023-04-13)
+
+
+### Bug Fixes
+
+* Don't report vendored paths as local ([e09cb4f](https://github.com/getappmap/appmap-ruby/commit/e09cb4f9764d275c7ba0858f16b545c2d287b473))
+* Report the first relative path in the backtrace ([f81b346](https://github.com/getappmap/appmap-ruby/commit/f81b346ebc66a4f60ca26ad384d72672893d1333))
+
+
+### Features
+
+* Report metadata.test_failure ([82c87d2](https://github.com/getappmap/appmap-ruby/commit/82c87d2453ce7c040bce138bf55d94d47aca58fc))
+
 ## [0.98.1](https://github.com/getappmap/appmap-ruby/compare/v0.98.0...v0.98.1) (2023-03-09)
 
 

data/lib/appmap/minitest.rb

@@ -26,13 +26,21 @@ module AppMap
       end
 
       def source_location
-        test.method(test_name).source_location.join(':')
+        location = test.method(test_name).source_location
+        [ Util.normalize_path(location.first), location.last ].join(':')
       end
 
-      def finish(failed, exception)
-        warn "Finishing recording of #{failed || exception ? 'failed ' : ''} test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
+      def finish(failures, exception)
+        failed = failures.any? || exception
+        warn "Finishing recording of #{failed ? 'failed ' : ''} test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
         warn "Exception: #{exception}" if exception && AppMap::Minitest::LOG
 
+        if failed
+          failure_exception = failures.first || exception
+          warn "Failure exception: #{failure_exception}" if AppMap::Minitest::LOG
+          test_failure = Util.extract_test_failure(failure_exception)
+        end
+
         events = []
         AppMap.tracing.delete @trace
 
@@ -49,7 +57,8 @@ module AppMap
         AppMap::Minitest.save name: scenario_name,
                               class_map: class_map,
                               source_location: source_location,
-                              test_status: failed || exception ? 'failed' : 'succeeded',
+                              test_status: failed ? 'failed' : 'succeeded',
+                              test_failure: test_failure,
                               exception: exception,
                               events: events
       end
@@ -79,7 +88,7 @@ module AppMap
         recording = @recordings_by_test.delete(test.object_id)
         return warn "No recording found for #{test}" unless recording
 
-        recording.finish (test.failures || []).any?, exception
+        recording.finish test.failures || [], exception
       end
 
       def config
@@ -90,7 +99,7 @@ module AppMap
         @event_methods += event_methods
       end
 
-      def save(name:, class_map:, source_location:, test_status:, exception:, events:)
+      def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:)
         metadata = AppMap::Minitest.metadata.tap do |m|
           m[:name] = name
           m[:source_location] = source_location
@@ -105,11 +114,9 @@ module AppMap
             type: 'tests',
           }
           m[:test_status] = test_status
+          m[:test_failure] = test_failure if test_failure
           if exception
-            m[:exception] = {
-              class: exception.class.name,
-              message: AppMap::Event::MethodEvent.display_string(exception.to_s),
-            }
+            m[:exception] = Util.format_exception(exception)
           end
         end
 

data/lib/appmap/rspec.rb

@@ -8,7 +8,7 @@ require 'fileutils'
 module AppMap
   module RSpec
     APPMAP_OUTPUT_DIR = 'tmp/appmap/rspec'
-    LOG = false
+    LOG = (ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true')
 
     def self.metadata
       AppMap.detect_metadata
@@ -96,10 +96,17 @@ module AppMap
         result
       end
 
-      def finish(exception)
-        warn "Finishing recording of example #{example}" if AppMap::RSpec::LOG
+      def finish(failure, exception)
+        failed = true if failure || exception
+        warn "Finishing recording of #{failed ? 'failed ' : ''} example #{example}" if AppMap::RSpec::LOG
         warn "Exception: #{exception}" if exception && AppMap::RSpec::LOG
 
+        if failed
+          failure_exception = failure || exception
+          warn "Failure exception: #{failure_exception}" if AppMap::RSpec::LOG
+          test_failure = Util.extract_test_failure(failure_exception)
+        end
+
         events = []
         AppMap.tracing.delete @trace
 
@@ -134,6 +141,7 @@ module AppMap
                            class_map: class_map,
                            source_location: source_location,
                            test_status: exception ? 'failed' : 'succeeded',
+                           test_failure: test_failure,
                            exception: exception,
                            events: events
       end
@@ -169,7 +177,7 @@ module AppMap
         recording = @recordings_by_example.delete(example.object_id)
         return warn "No recording found for #{example}" unless recording
 
-        recording.finish exception unless recording == :false
+        recording.finish example.execution_result.exception || exception, exception unless recording == :false
       end
 
       def config
@@ -180,7 +188,7 @@ module AppMap
         @event_methods += event_methods
       end
 
-      def save(name:, class_map:, source_location:, test_status:, exception:, events:)
+      def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:)
         metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = name
           m[:source_location] = source_location
@@ -195,8 +203,10 @@ module AppMap
             type: 'tests'
           }
           m[:test_status] = test_status
+          m[:test_failure] = test_failure if test_failure
           if exception
-            m[:exception] = {
+            m[:exception] = Util.format_exception(exception)
+            {
               class: exception.class.name,
               message: AppMap::Event::MethodEvent.display_string(exception.to_s)
             }

data/lib/appmap/util.rb

@@ -139,13 +139,33 @@ module AppMap
       end
 
       def normalize_path(path)
-        if path.index(Dir.pwd) == 0 && !path.index(Bundler.bundle_path.to_s)
+        is_local_path    = -> { path.index(Dir.pwd) == 0 }
+        is_bundled_path  = -> { path.index(Bundler.bundle_path.to_s) == 0 }
+        is_vendored_path = -> { path.index(File.join(Dir.pwd, 'vendor/bundle')) == 0 }
+
+        if is_local_path.() && !is_bundled_path.() && !is_vendored_path.()
           path[Dir.pwd.length + 1..-1]
         else
           path
         end
       end
 
+      def format_exception(exception)
+        {
+          class: exception.class.name,
+          message: AppMap::Event::MethodEvent.display_string(exception.to_s),
+        }
+      end
+
+      def extract_test_failure(exception)
+        return unless exception
+
+        { message: exception.message }.tap do |test_failure|
+          first_location = exception.backtrace_locations&.find { |location| !Pathname.new(normalize_path(location.absolute_path)).absolute? }
+          test_failure[:location] = [ normalize_path(first_location.path), first_location.lineno ].join(':') if first_location
+        end
+      end
+
       # Convert a Rails-style path from /org/:org_id(.:format)
       # to Swagger-style paths like /org/{org_id}
       def swaggerize_path(path)

data/lib/appmap/version.rb

@@ -3,9 +3,9 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.98.1'
+  VERSION = '0.99.1'
 
-  APPMAP_FORMAT_VERSION = '1.10.0'
+  APPMAP_FORMAT_VERSION = '1.12.0'
 
   SUPPORTED_RUBY_VERSIONS = %w[2.5 2.6 2.7 3.0 3.1 3.2].freeze
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.98.1
+  version: 0.99.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source