rspec-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ace1f9c18c62b0764ca54620189d5fc24ce40a54c1286e2e4175d21126702597
+  data.tar.gz: 8b1d125baaa519fe94e34b7e6c51fb9918ad70e27eef0024b40a37f0ce1cf770
+SHA512:
+  metadata.gz: 9824916ea0800a44a3289d8d4b18b51e725579db5e00b85f8749c8766c513ef5f524497d35cb053174fd4ed14f59c5ca165176ec23e05c623be68bb19a77a920
+  data.tar.gz: e0355ddbead096ffaa7c893a19d2811134f2fab0434f9a1143aa880632d3b7ae3bca826587043822396ead61d712790c760ccc7cdb7a8c8c1aea7d3acf7f6368

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Mattia Roccoberton
+
+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,56 @@
+# RSpec instrumentation
+
+RSpec instrumentation component to measure performances, profile and monitor the test suite using an external service.
+
+> DISCLAIMER: this is an initial version, major changes will probably happens in the first releases
+
+Support for:
+- New Relic
+- Sentry APM (partial for now)
+
+Setup the gem, execute the test suite, check the results in the service interface.
+
+## Install
+
+- Add to the Gemfile (in the test group): `gem 'rspec-instrumentation'`
+- Follow the specific instructions below per service
+
+### New Relic
+
+- Configure New Relic on your application (also adding the gem 'newrelic_rpm' to the Gemfile)
+- Add an initializer in your app (_config/initializers/new_relic.rb_) with:
+
+```rb
+RSpecInstrumentation::NewRelic.setup if Rails.env.test?
+```
+
+- Add to your _rails_helper.rb_ (or _spec_helper.rb_):
+
+```rb
+# It's better to put in at the end, after the other configuration options
+RSpec.configure do |config|
+  RSpecInstrumentation::RSpec.setup(config, service: :new_relic)
+end
+```
+
+- If you are using VCR, depending on your configuration you could need also to permit external requests to the New Relic service, example:
+
+```rb
+VCR.configure do |config|
+  config.ignore_hosts 'collector-001.eu01.nr-data.net' # the host could be different for your account
+end
+```
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
+
+## Contributors
+
+- [Mattia Roccoberton](https://www.blocknot.es): author
+
+## License
+
+The gem is available as open-source under the terms of the [MIT](LICENSE.txt).

data/lib/rspec-instrumentation.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'rspec_instrumentation/rspec'
+
+require_relative 'rspec_instrumentation/new_relic'
+require_relative 'rspec_instrumentation/sentry'

data/lib/rspec_instrumentation/new_relic.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RSpecInstrumentation
+  class NewRelic
+    RSPEC_EVENTS = %i[example_finished example_started start stop].freeze
+
+    def initialize(config)
+      config.reporter.register_listener(self, *RSPEC_EVENTS)
+    end
+
+    def example_finished(notification)
+      result = notification.example.execution_result
+      if result.status == :failed
+        details = failed_example_details(notification.example)
+        ::NewRelic::Agent.notice_error(result.exception.to_s, custom_params: details)
+      end
+      @transaction.finish
+    end
+
+    def example_started(notification)
+      name = notification.example.id.delete_prefix('./')
+      @transaction = ::NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: name, category: :task)
+    end
+
+    def failed_example_details(example)
+      {
+        location: example.metadata[:location],
+        type: example.metadata[:type]
+      }
+    end
+
+    def start(_notification)
+      # puts '> start'
+    end
+
+    def stop(_notification)
+      ::NewRelic::Agent.shutdown
+    end
+
+    class << self
+      def setup
+        require 'newrelic_rpm'
+        require 'new_relic/agent/tracer'
+
+        ::NewRelic::Agent.manual_start
+      end
+    end
+  end
+end

data/lib/rspec_instrumentation/rspec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RSpecInstrumentation
+  module RSpec
+    module_function
+
+    def setup(config, service:)
+      case service
+      when :new_relic then NewRelic.new(config)
+      when :sentry then Sentry.new(config)
+      else warn("Unknown service: #{service}")
+      end
+    end
+  end
+end

data/lib/rspec_instrumentation/sentry.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RSpecInstrumentation
+  class Sentry
+    RSPEC_EVENTS = %i[example_finished example_started start stop].freeze
+
+    def initialize(config)
+      config.reporter.register_listener(self, *RSPEC_EVENTS)
+    end
+
+    def example_finished(notification)
+      example = notification.example
+      case example.execution_result.status
+      when :passed
+        @transaction.set_status('ok')
+      when :failed
+        @transaction.set_data('failure', example.execution_result.exception.to_s)
+        @transaction.set_status('internal_error')
+      end
+      @transaction.finish
+    end
+
+    def example_started(notification)
+      example = notification.example
+      location = example.metadata[:location].delete_prefix('./')
+      @transaction = ::Sentry.start_transaction(name: example.full_description, op: 'test-run', description: location)
+      @transaction.set_tag('type', example.metadata[:type])
+      @transaction.set_data('location', example.metadata[:location])
+    end
+
+    def start(_notification)
+      @start_timestamp = Time.now.to_f
+    end
+
+    def stop(notification)
+      info = "#{notification.examples.count} examples, #{notification.failed_examples.count} failures"
+      attrs = { name: 'Suite run', op: 'suite-run', start_timestamp: @start_timestamp, description: info }
+      transaction = ::Sentry.start_transaction(attrs)
+      transaction.set_data('examples_count', notification.examples.count)
+      transaction.set_data('failed_examples_count', notification.failed_examples.count)
+      transaction.finish
+    end
+  end
+end

data/lib/rspec_instrumentation/version.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rspec-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+description: A RSpec instrumentation component
+email: mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rspec-instrumentation.rb
+- lib/rspec_instrumentation/new_relic.rb
+- lib/rspec_instrumentation/rspec.rb
+- lib/rspec_instrumentation/sentry.rb
+- lib/rspec_instrumentation/version.rb
+homepage: https://github.com/blocknotes/rspec-instrumentation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blocknotes/rspec-instrumentation
+  source_code_uri: https://github.com/blocknotes/rspec-instrumentation
+  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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: RSpec instrumentation
+test_files: []