rspec-otel 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea44639a383fcb72b5c235528dc72363e0f3b431198e97c7d0c740bd5032bcd1
-  data.tar.gz: ed21a83d381fc8441ac7e09aa6e06d48582bbb256eaf0f5830c02363d4308f7d
+  metadata.gz: c2db5ebf1aa940bae5b290f6d6683e1f1bea754fc83e8eaf9997bb3971235244
+  data.tar.gz: 5c7b7ca60e93ca6ccf82479cfe3374c5420ab5be80484787c4cdc74ed67548cb
 SHA512:
-  metadata.gz: b59d5eb23c4e42a7fb8489ca49a68aed7adf095da7277ea7e372648f678e39851dc5d4bc31e4ecaf8d3fef9d55ff5129168898bbde7430a0fde4feb851a746ee
-  data.tar.gz: 5270c5b5dd720e89e5243cfddeb26ac3aac76d44ff4ef42b75b79fe13667825b1633db676323c573a5d7154a3470e311aaae39f7c4ca1e640b0e323833c450aa
+  metadata.gz: f99a6e31d6acc0fc5dc26453690a7b66a6ed8352cc4790b26fccdad93dfa1692adaaa9f3f4fd5798c8d1e9084a8c509ebf1800936a3b4a1354ca3ddc6e9b701e
+  data.tar.gz: 12a5346b1eb3b3247d9d5d62e46aa1c4e3c13f891a0abdd72a2f2931e054f86bcc6d9634959faf65329689933af438075de259682b7357995bb596dfd8b5a008

data/README.md

@@ -37,22 +37,55 @@ 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
 ```
 
 Several conditions can be added to the matcher:
 
+* `as_root` - Will match spans that are the root of a trace.
+* `as_child` - Will match spans that are not the root of a trace
 * `with_attributes` - Will match only the spans with the specified attributes.
 * `without_attributes` - Will only match the spans that do not have the specified attributes
 * `with_event` - Will match only the spans with the specified event.
 * `without_event` - Will only match the spans that do not have the specified event
+* `with_link` - Will match only the spans with the specified link.
+* `without_link` - Will only match the spans that do not have the specified link
 * `with_status` - Will match only the spans that have the proper status.
 * `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

@@ -2,14 +2,14 @@
 
 module RspecOtel
   module Matchers
-    class EmitSpan
+    class EmitSpan # rubocop:disable Metrics/ClassLength
       attr_reader :name
 
       def initialize(name = nil)
         @name = name
-        @filters = [
-          ->(span) { span.name == name }
-        ]
+        @filters = []
+
+        add_name_filter
       end
 
       def matches?(block)
@@ -26,6 +26,22 @@ module RspecOtel
         false
       end
 
+      def as_child
+        @filters << lambda do |span|
+          span.parent_span_id && span.parent_span_id != OpenTelemetry::Trace::INVALID_SPAN_ID
+        end
+
+        self
+      end
+
+      def as_root
+        @filters << lambda do |span|
+          span.parent_span_id == OpenTelemetry::Trace::INVALID_SPAN_ID
+        end
+
+        self
+      end
+
       def with_attributes(attributes)
         @filters << lambda do |span|
           attributes_match?(span.attributes, attributes)
@@ -42,17 +58,39 @@ module RspecOtel
         self
       end
 
+      def with_link(attributes = {})
+        @filters << lambda do |span|
+          span.links &&
+            link_match?(span.links, attributes)
+        end
+
+        self
+      end
+
+      def without_link(attributes = {})
+        @filters << lambda do |span|
+          span.links.nil? ||
+            !link_match?(span.links, attributes)
+        end
+
+        self
+      end
+
       def with_event(name, attributes = {})
         @filters << lambda do |span|
-          event_match?(span.events, OpenTelemetry::SDK::Trace::Event.new(name, attributes))
+          span.events &&
+            event_match?(span.events, OpenTelemetry::SDK::Trace::Event.new(name, attributes))
         end
+
         self
       end
 
       def without_event(name, attributes = {})
         @filters << lambda do |span|
-          !event_match?(span.events, OpenTelemetry::SDK::Trace::Event.new(name, attributes))
+          span.events.nil? ||
+            !event_match?(span.events, OpenTelemetry::SDK::Trace::Event.new(name, attributes))
         end
+
         self
       end
 
@@ -72,11 +110,11 @@ module RspecOtel
       end
 
       def failure_message
-        "expected span #{name} to have been emitted, but it couldn't be found"
+        "expected span #{failure_match_description} #{printable_name} to have been emitted, but it couldn't be found"
       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?
@@ -85,6 +123,35 @@ module RspecOtel
 
       private
 
+      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 add_name_filter
+        @filters << 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?
@@ -112,8 +179,6 @@ module RspecOtel
       end
 
       def event_match?(span_events, event)
-        return true if span_events.nil?
-
         se = span_events.select do |s|
           s.name == event.name &&
             attributes_match?(s.attributes, event.attributes || {})
@@ -121,6 +186,14 @@ module RspecOtel
 
         !se.empty?
       end
+
+      def link_match?(links, attributes)
+        link = links.select do |l|
+          attributes_match?(l.attributes, attributes || {})
+        end
+
+        !link.empty?
+      end
     end
   end
 end

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.3'
+  VERSION = '0.0.5'
 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,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-otel
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Damien MATHIEU
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -38,6 +38,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