rspec-otel 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '081125f70f4963d1a9f414811abbbe65e0113a14131a0cc982a2ce9247b447c5'
-  data.tar.gz: ab28a32cc178212a05e0216ad84a6300eb4509c17537d4499df6d0b2dfa4fd30
+  metadata.gz: f5e1d1bb621033e9a0fb1d1195d745a2d4300f00723b83ca8cb380f170a660d5
+  data.tar.gz: 0d4812bb0b05657bcae39dae45e89f2db35cbb13c25bb47c8ff180e562e6c050
 SHA512:
-  metadata.gz: d867cbc82ace4ea550c9c14024dc91db343964d749a13075f9a947f4193cdfbbba434270ba85d6de01ae7cdfc919a5ad388a13d7dc903f9dbd06ed1ea4bde0f3
-  data.tar.gz: ff369cb3a9390130bdd354cc5ac99e7b0136525f8d39bb9c5fe793d2142843edc48a9556efe232b2b6397554561d1a17dfb2e39ae36fa6b2494a54af0ab23323
+  metadata.gz: 948d9807ebe6e5a96c6555c6e707f170928feae596cfc304550342ce894b94aa51db2c755c0aa77814ff8a3e7bd518d5004a328ec9e9f4f67c278d806a5fd265
+  data.tar.gz: 7780de8e139754b3255514c49ebbf742f09c73011737245d509cc9f04284a90f28d6edf9dac148d357e09e0839d22242ffae05c4df3ad5d2cc3c8f19a9d7613c

data/README.md

@@ -37,7 +37,21 @@ RSpec.describe 'User API' do
   it 'emits a span' do
     expect do
       get :user, id: 1
-    end.to emit_span('GET /user').with_attributes({'user.id' => '1'})
+    end.to emit_span('GET /user')
+  end
+end
+```
+
+`emit_span` will also match a regular expression:
+
+```ruby
+require 'spec_helper'
+
+RSpec.describe 'User API' do
+  it 'emits a span' do
+    expect do
+      get :user, id: 1
+    end.to emit_span(/^GET /)
   end
 end
 ```
@@ -56,7 +70,22 @@ Several conditions can be added to the matcher:
 * `with_exception` - Will match only the spans that have the specified exception event.
 * `without_exception` - Will match only the spans that do not have the specified exception event.
 
-The `*_event` condition can be called multiple times with different events.
+_The `*_event` condition can be called multiple times with different events._
+
+
+### Disabling
+
+We wrap every example in a new OpenTelemetry SDK configuration by default, if you wish to disable this you can tag your example with `:rspec_otel_disable_tracing`:
+
+```ruby
+require 'spec_helper'
+
+RSpec.describe 'User API', :rspec_otel_disable_tracing do
+  it 'tests my code' do
+    expect(true).to be true
+  end
+end
+```
 
 ## Compatibility
 

data/lib/rspec_otel/matchers/emit_span.rb

@@ -7,19 +7,19 @@ module RspecOtel
 
       def initialize(name = nil)
         @name = name
-        @filters = [
-          ->(span) { span.name == name }
-        ]
+        @filters = []
+        @before_spans = []
+
+        @filters << name_filter
       end
 
       def matches?(block)
-        before_spans = []
         if block.respond_to?(:call)
-          before_spans = RspecOtel.exporter.finished_spans
+          @before_spans = RspecOtel.exporter.finished_spans
           block.call
         end
 
-        (RspecOtel.exporter.finished_spans - before_spans).each do |span|
+        (RspecOtel.exporter.finished_spans - @before_spans).each do |span|
           return true if @filters.all? { |f| f.call(span) }
         end
 
@@ -110,11 +110,21 @@ module RspecOtel
       end
 
       def failure_message
-        "expected span #{name} to have been emitted, but it couldn't be found"
+        closest = closest_span
+        expect_content = "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"
+        end
       end
 
       def failure_message_when_negated
-        "expected span #{name} to not have been emitted"
+        "expected span #{failure_match_description} #{printable_name} to not have been emitted"
       end
 
       def supports_block_expectations?
@@ -123,6 +133,44 @@ module RspecOtel
 
       private
 
+      def closest_span
+        all_spans = (RspecOtel.exporter.finished_spans - @before_spans)
+        span = all_spans.filter_map do |s|
+          span if name_filter.call(s)
+        end.first
+        span = all_spans.first if span.nil?
+        span
+      end
+
+      def failure_match_description
+        case name
+        when String
+          'named'
+        when Regexp
+          'matching'
+        end
+      end
+
+      def printable_name
+        case name
+        when String
+          "'#{name}'"
+        when Regexp
+          name.inspect
+        end
+      end
+
+      def name_filter
+        lambda do |span|
+          case name
+          when String
+            span.name == name
+          when Regexp
+            span.name.match?(name)
+          end
+        end
+      end
+
       def exception_attributes(exception)
         attributes = {}
         unless exception.nil?

data/lib/rspec_otel/rspec.rb

@@ -3,16 +3,13 @@
 require 'rspec/core'
 
 RSpec.configure do |config|
-  config.before(:suite) do
-    span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(RspecOtel.exporter)
-
-    OpenTelemetry::SDK.configure do |c|
-      c.add_span_processor span_processor
-    end
-  end
-
   config.around(:each) do |example|
-    example.run
-    RspecOtel.exporter.reset
+    if example.metadata[:rspec_otel_disable_tracing]
+      example.run
+    else
+      RspecOtel.record do
+        example.run
+      end
+    end
   end
 end

data/lib/rspec_otel/version.rb

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

data/lib/rspec_otel.rb

@@ -1,11 +1,29 @@
 # frozen_string_literal: true
 
 require 'opentelemetry/sdk'
+require 'opentelemetry-test-helpers'
 
 module RspecOtel
   def self.exporter
     @exporter ||= OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
   end
+
+  def self.record
+    span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(exporter)
+
+    OpenTelemetry::SDK.configure do |c|
+      c.add_span_processor span_processor
+    end
+
+    yield
+  ensure
+    reset
+  end
+
+  def self.reset
+    OpenTelemetry::TestHelpers.reset_opentelemetry
+    @exporter = nil
+  end
 end
 
 require 'rspec_otel/matchers'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-otel
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Damien MATHIEU
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -38,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  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: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +84,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RSpec matchers for the OpenTelemetry framework
 test_files: []