rspec-otel 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b966349d533ad57a8ee5fc1fd79b7ed99922beb6aad8fc1fb59e97d8062cdf5e
-  data.tar.gz: e167fba956f24f180846574e5b87214f906b0d35377d7b92230df99aa6244dc2
+  metadata.gz: 494c22ee6a688468f77094d8b4f27242edd872ec3a24232337375b8dd611d38e
+  data.tar.gz: ecc743b5a1752adfa8d624d17ab3f6ce87a291ce4393d480fb33f7ef92068e77
 SHA512:
-  metadata.gz: 5f19d4e4b8c94818c8d11e373380fc527c8e61f875e24189c3fa401a38d49f1647eb4f5e4862dea702de3397fd2ec81ee6deca4612056678c8de9faa90208eae
-  data.tar.gz: a3320a67e728db92483d66a7cad492abbc7785cb7088417ab8e9e23b1648db348b0b32e869b308d6369a0cb7c267c613a17e7f0f810d11ab5138a4cbb6072b98
+  metadata.gz: 496f2ac07d3b62cc36c4027266d0dbd6188e75fb075140b52791d3697845585223cdaebaf7e79e60b733a175b1b2352ffbbac88c00c0920c7567c319f2526253
+  data.tar.gz: d26ee3edc01891c632cb97cd92b02507849ee4c33c20faae47057a7f523f01e010c38ccabf4940dbdc601ac9f8734ffe56fae5f0c7c6aea4aced9ce7103feb2f

data/lib/rspec_otel/matchers/emit_span.rb

@@ -116,15 +116,12 @@ module RspecOtel
 
       def failure_message
         closest = closest_span
-        expect_content = "expected span #{failure_match_description} #{printable_name} to have been emitted"
+        prefix = "expected span #{failure_match_description} #{printable_name} to have been emitted"
 
         case closest
-        when nil
-          "#{expect_content}, but there were no spans emitted at all"
-        when OpenTelemetry::SDK::Trace::SpanData
-          "#{expect_content}, but it couldn't be found. Found a close matching span named `#{closest.name}`"
-        else
-          raise "I don't know what to do with a #{closest.class} span"
+        when nil then "#{prefix}, but there were no spans emitted at all"
+        when OpenTelemetry::SDK::Trace::SpanData then closest_not_found_message(prefix, closest)
+        else raise "I don't know what to do with a #{closest.class} span"
         end
       end
 
@@ -219,6 +216,11 @@ module RspecOtel
 
         !link.empty?
       end
+
+      def closest_not_found_message(prefix, span)
+        "#{prefix}, but it couldn't be found. " \
+          "Found a close matching span named `#{span.name}`#{SpanDetails.new(span)}"
+      end
     end
   end
 end

data/lib/rspec_otel/matchers/span_details.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RspecOtel
+  module Matchers
+    class SpanDetails
+      def initialize(span)
+        @span = span
+      end
+
+      def to_s
+        lines = [attributes_details, events_details, links_details, status_details].compact
+        return '' if lines.empty?
+
+        "\n#{lines.join("\n")}"
+      end
+
+      private
+
+      def attributes_details
+        return unless @span.attributes&.any?
+
+        "  attributes: #{@span.attributes.inspect}"
+      end
+
+      def events_details
+        return unless @span.events&.any?
+
+        format_collection('events', @span.events) { |e| format_item(e.name, e.attributes) }
+      end
+
+      def links_details
+        return unless @span.links&.any?
+
+        format_collection('links', @span.links) { |l| format_item('link', l.attributes) }
+      end
+
+      def status_details
+        return if @span.status.nil? || @span.status.code == OpenTelemetry::Trace::Status::UNSET
+
+        label = status_label(@span.status.code)
+        desc = @span.status.description
+        status_str = desc.to_s.empty? ? label : "#{label} (#{desc})"
+        "  status: #{status_str}"
+      end
+
+      def format_collection(header, collection, &)
+        item_lines = collection.map(&)
+        "  #{header}:\n#{item_lines.join("\n")}"
+      end
+
+      def format_item(label, attributes)
+        attributes&.any? ? "    - #{label} #{attributes.inspect}" : "    - #{label}"
+      end
+
+      def status_label(code)
+        case code
+        when OpenTelemetry::Trace::Status::OK    then 'ok'
+        when OpenTelemetry::Trace::Status::ERROR then 'error'
+        else 'unknown'
+        end
+      end
+    end
+  end
+end

data/lib/rspec_otel/matchers.rb

@@ -9,3 +9,4 @@ module RspecOtel
 end
 
 require 'rspec_otel/matchers/emit_span'
+require 'rspec_otel/matchers/span_details'

data/lib/rspec_otel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RspecOtel
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-otel
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Damien MATHIEU
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +91,7 @@ files:
 - lib/rspec_otel.rb
 - lib/rspec_otel/matchers.rb
 - lib/rspec_otel/matchers/emit_span.rb
+- lib/rspec_otel/matchers/span_details.rb
 - lib/rspec_otel/rspec.rb
 - lib/rspec_otel/version.rb
 homepage: https://github.com/dmathieu/rspec-otel
@@ -98,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: RSpec matchers for the OpenTelemetry framework
 test_files: []