rspec-otel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa13ed2e866b0e8f13946b28298356ba677c05e0c1939e3dbd1c887dc5c1d5fc
+  data.tar.gz: 388d62d4c072e238dcb85a4afce75b02bd444a79b78d14dc4e4a891e4dff3a16
+SHA512:
+  metadata.gz: 85046ba3269a35fc48aee92cb1b3e3170fbd3a195a4441febc5739da34e2e73dfbf4931f292c33fcbdd0472d7bf21d28389251c1cca0eb95a57c91055b298996
+  data.tar.gz: 3119c4a902e011a8b801315b0bd9db1064eac49bc86b951cac2ce6916fd84229f475f5517a3feb7b20071ff84bf0b19b31a6aa9028c250515c6023e31cc3da26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Damien MATHIEU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# RSpec Otel
+
+RSpec matchers to be used with the OpenTelemetry framework
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'rspec-otel'
+```
+
+Within your spec helper, require the gem:
+
+```ruby
+require 'rspec_otel'
+```
+
+And include the matchers within the rspec configuration:
+
+```ruby
+RSpec.configure do |config|
+  config.include RspecOtel::Matchers
+end
+```
+
+## Usage
+
+### Matching the presence of a span
+
+You can match the emission of a span with the `have_emitted_span` matcher:
+
+```ruby
+require 'spec_helper'
+
+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
+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.
+* `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.

data/lib/rspec_otel/matchers/have_emitted_span.rb

@@ -0,0 +1,96 @@
+# 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

data/lib/rspec_otel/matchers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RspecOtel
+  module Matchers
+    def have_emitted_span(name) # rubocop:disable Naming/PredicateName
+      HaveEmittedSpan.new(name)
+    end
+  end
+end
+
+require 'rspec_otel/matchers/have_emitted_span'

data/lib/rspec_otel/rspec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/expectations'
+
+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
+  end
+end

data/lib/rspec_otel/version.rb

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

data/lib/rspec_otel.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'opentelemetry/sdk'
+
+module RspecOtel
+  def self.exporter
+    @exporter ||= OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+  end
+end
+
+require 'rspec_otel/matchers'
+require 'rspec_otel/rspec'
+require 'rspec_otel/version'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rspec-otel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damien MATHIEU
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RSpec matchers for the OpenTelemetry framework
+email:
+- 42@dmathieu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec_otel.rb
+- lib/rspec_otel/matchers.rb
+- lib/rspec_otel/matchers/have_emitted_span.rb
+- lib/rspec_otel/rspec.rb
+- lib/rspec_otel/version.rb
+homepage: https://github.com/dmathieu/rspec-otel
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: RSpec matchers for the OpenTelemetry framework
+test_files: []