rspec-otel 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa13ed2e866b0e8f13946b28298356ba677c05e0c1939e3dbd1c887dc5c1d5fc
-  data.tar.gz: 388d62d4c072e238dcb85a4afce75b02bd444a79b78d14dc4e4a891e4dff3a16
+  metadata.gz: ea44639a383fcb72b5c235528dc72363e0f3b431198e97c7d0c740bd5032bcd1
+  data.tar.gz: ed21a83d381fc8441ac7e09aa6e06d48582bbb256eaf0f5830c02363d4308f7d
 SHA512:
-  metadata.gz: 85046ba3269a35fc48aee92cb1b3e3170fbd3a195a4441febc5739da34e2e73dfbf4931f292c33fcbdd0472d7bf21d28389251c1cca0eb95a57c91055b298996
-  data.tar.gz: 3119c4a902e011a8b801315b0bd9db1064eac49bc86b951cac2ce6916fd84229f475f5517a3feb7b20071ff84bf0b19b31a6aa9028c250515c6023e31cc3da26
+  metadata.gz: b59d5eb23c4e42a7fb8489ca49a68aed7adf095da7277ea7e372648f678e39851dc5d4bc31e4ecaf8d3fef9d55ff5129168898bbde7430a0fde4feb851a746ee
+  data.tar.gz: 5270c5b5dd720e89e5243cfddeb26ac3aac76d44ff4ef42b75b79fe13667825b1633db676323c573a5d7154a3470e311aaae39f7c4ca1e640b0e323833c450aa

data/README.md

@@ -28,7 +28,7 @@ end
 
 ### Matching the presence of a span
 
-You can match the emission of a span with the `have_emitted_span` matcher:
+You can match the emission of a span with the `emit_span` matcher:
 
 ```ruby
 require 'spec_helper'
@@ -37,7 +37,7 @@ RSpec.describe 'User API' do
   it 'emits a span' do
     expect do
       get :user, id: 1
-    end.to have_emitted_span('GET /user').with_attributes({'user.id' => '1'})
+    end.to emit_span('GET /user').with_attributes({'user.id' => '1'})
   end
 end
 ```
@@ -45,6 +45,16 @@ end
 Several conditions can be added to the matcher:
 
 * `with_attributes` - Will match only the spans with the specified attributes.
-* `with_event` - Will match only the spans with the specified event. This condition can be called multiple times with different events.
+* `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_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.
+
+## Compatibility
+
+RSpec Otel ensures compatibility with the currently supported versions of the
+[Ruby Language](https://www.ruby-lang.org/en/downloads/branches/).

data/lib/rspec_otel/matchers/emit_span.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module RspecOtel
+  module Matchers
+    class EmitSpan
+      attr_reader :name
+
+      def initialize(name = nil)
+        @name = name
+        @filters = [
+          ->(span) { span.name == name }
+        ]
+      end
+
+      def matches?(block)
+        before_spans = []
+        if block.respond_to?(:call)
+          before_spans = RspecOtel.exporter.finished_spans
+          block.call
+        end
+
+        (RspecOtel.exporter.finished_spans - before_spans).each do |span|
+          return true if @filters.all? { |f| f.call(span) }
+        end
+
+        false
+      end
+
+      def with_attributes(attributes)
+        @filters << lambda do |span|
+          attributes_match?(span.attributes, attributes)
+        end
+
+        self
+      end
+
+      def without_attributes(attributes)
+        @filters << lambda do |span|
+          !attributes_match?(span.attributes, attributes)
+        end
+
+        self
+      end
+
+      def with_event(name, attributes = {})
+        @filters << lambda do |span|
+          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))
+        end
+        self
+      end
+
+      def with_status(code, description)
+        @filters << lambda do |span|
+          status_match?(span.status, code, description)
+        end
+        self
+      end
+
+      def with_exception(exception = nil)
+        with_event('exception', exception_attributes(exception))
+      end
+
+      def without_exception(exception = nil)
+        without_event('exception', exception_attributes(exception))
+      end
+
+      def failure_message
+        "expected span #{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"
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      private
+
+      def exception_attributes(exception)
+        attributes = {}
+        unless exception.nil?
+          attributes['exception.type'] = exception.class.to_s
+          attributes['exception.message'] = exception.message
+        end
+
+        attributes
+      end
+
+      def attributes_match?(span_attributes, attributes)
+        attributes.each do |ak, av|
+          sa = span_attributes.select do |k, v|
+            ak == k && av == v
+          end
+
+          return false if sa.empty?
+        end
+
+        true
+      end
+
+      def status_match?(span_status, code, description)
+        code == span_status.code && description == span_status.description
+      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 || {})
+        end
+
+        !se.empty?
+      end
+    end
+  end
+end

data/lib/rspec_otel/matchers.rb

@@ -2,10 +2,10 @@
 
 module RspecOtel
   module Matchers
-    def have_emitted_span(name) # rubocop:disable Naming/PredicateName
-      HaveEmittedSpan.new(name)
+    def emit_span(name)
+      EmitSpan.new(name)
     end
   end
 end
 
-require 'rspec_otel/matchers/have_emitted_span'
+require 'rspec_otel/matchers/emit_span'

data/lib/rspec_otel/rspec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rspec/core'
-require 'rspec/expectations'
 
 RSpec.configure do |config|
   config.before(:suite) do

data/lib/rspec_otel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-otel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Damien MATHIEU
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -63,7 +63,7 @@ files:
 - README.md
 - lib/rspec_otel.rb
 - lib/rspec_otel/matchers.rb
-- lib/rspec_otel/matchers/have_emitted_span.rb
+- lib/rspec_otel/matchers/emit_span.rb
 - lib/rspec_otel/rspec.rb
 - lib/rspec_otel/version.rb
 homepage: https://github.com/dmathieu/rspec-otel
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: RSpec matchers for the OpenTelemetry framework

data/lib/rspec_otel/matchers/have_emitted_span.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module RspecOtel
-  module Matchers
-    class HaveEmittedSpan
-      attr_reader :name
-
-      def initialize(name)
-        @name = name
-        @attributes = {}
-      end
-
-      def matches?(block)
-        block.call if block.respond_to?(:call)
-
-        RspecOtel.exporter.finished_spans.each do |span|
-          return true if span.name == name &&
-                         attributes_match?(span.attributes, @attributes) &&
-                         status_match?(span.status, @status) &&
-                         events_match?(span.events, @events)
-        end
-
-        false
-      end
-
-      def with_attributes(attributes)
-        @attributes = attributes
-        self
-      end
-
-      def with_event(name, attributes = {})
-        @events ||= []
-        @events << OpenTelemetry::SDK::Trace::Event.new(name, attributes)
-        self
-      end
-
-      def with_status(code, description)
-        @status = { code:, description: }
-        self
-      end
-
-      def with_exception(exception)
-        with_event('exception', {
-                     'exception.type' => exception.class.to_s,
-                     'exception.message' => exception.message
-                   })
-      end
-
-      def failure_message
-        "expected span #{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"
-      end
-
-      def supports_block_expectations?
-        true
-      end
-
-      private
-
-      def attributes_match?(span_attributes, attributes)
-        attributes.each do |ak, av|
-          sa = span_attributes.select do |k, v|
-            ak == k && av == v
-          end
-
-          return false if sa.empty?
-        end
-
-        true
-      end
-
-      def status_match?(span_status, status)
-        status.nil? ||
-          (status[:code] == span_status.code && status[:description] == span_status.description)
-      end
-
-      def events_match?(span_events, events)
-        return true if span_events.nil?
-
-        events.each do |e|
-          se = span_events.select do |s|
-            s.name == e.name &&
-              attributes_match?(s.attributes, e.attributes)
-          end
-
-          return false if se.empty?
-        end
-
-        true
-      end
-    end
-  end
-end