bc-lightstep-ruby 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58c01708c8b34494f5d5f4ddc5a5cb8b6b581b9b1dd3f9f7297ea1e4e9abb1c2
-  data.tar.gz: c19459c44193e5693691ce9c005c64cca1d8df2c2076147913d856fcf7fe17d5
+  metadata.gz: 07ca22705b74ee7e761a63732cc416f45ca6a9db01a4a8c28615db57342301b1
+  data.tar.gz: e9856c08fc1bfacec3f57d8f9481d278c1133db5bbc199b14428782b4ad7b805
 SHA512:
-  metadata.gz: 0e7699221456ddab9993f18d304275df2e11331bba58f9fe09f98794d1747e39fc65bba412d253cc379788969961babd433facfad7646da3c86956290c3b677f
-  data.tar.gz: 9a7507f2afd324b38ffed8c62a2fc71cff6cc12a8d5a56bcb880c2f0e478840a995c22fd095aca39979f1aa0b153e24ebaba7d6ce7448b29c4e593fa164d98a6
+  metadata.gz: 35096ce470d7bb32b059752e14612ebed5815e88b885c851e9e20c62e6bee0c41e512244b4ef462ccb2b5f7c07ef27d5509ed1c01697a1742ff46b1035c30770
+  data.tar.gz: 595f9ff72ee56b899b959cfbc5f7fb5e0b370db4fa40da7eaa7a673e48ca89068f04904685cff78c548d4d7aaee3590ea41cd8be2f82d605c1d0ce59a751826c

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.5.2
+
+- Add rspec helper for testing custom lightstep spans
+
 h3. 1.5.1
 
 - Add `hostname` preset for env var injection into spans

data/README.md

@@ -86,6 +86,22 @@ re-enable this by setting the `redis_allow_root_spans` configuration option to `
 It also excludes `ping` commands, and you can provide a custom list by setting the `redis_excluded_commands` 
 configuration option to an array of commands to exclude.
 
+## RSpec
+
+This library comes with a built-in matcher for testing span blocks. In your rspec config:
+
+```ruby
+require 'bigcommerce/lightstep/rspec'
+```
+
+Then, in a test:
+
+```ruby
+it 'should create a lightstep span' do
+  expect { my_code_here }.to create_a_lightstep_span(name: 'my-span-name', tags: { tag_one: 'value-here' })
+end
+```
+
 ## License
 
 Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 

data/lib/bigcommerce/lightstep/rspec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+begin
+  require 'rspec/core'
+  require 'rspec/expectations'
+  BC_LIGHTSTEP_RSPEC_NAMESPACE = RSpec
+  BC_LIGHTSTEP_RSPEC_RUNNER = RSpec
+rescue LoadError # old rspec compat
+  require 'spec'
+  BC_LIGHTSTEP_RSPEC_NAMESPACE = Spec
+  BC_LIGHTSTEP_RSPEC_RUNNER = Spec::Runner
+end
+
+module Bigcommerce
+  module Lightstep
+    ##
+    # RSpec helper for lightstep traces
+    #
+    module RspecHelpers
+      def lightstep_tracer
+        ::Bigcommerce::Lightstep::Tracer.instance
+      end
+    end
+  end
+end
+
+##
+# Usage:
+#   expect { my_code_here }.to create_a_lightstep_span(name: 'my-span-name', tags: { tag_one: 'value-here' })
+#
+BC_LIGHTSTEP_RSPEC_NAMESPACE::Matchers.define :create_a_lightstep_span do |opts|
+  match(notify_expectation_failures: true) do |proc|
+    span_name = opts.fetch(:name)
+    lightstep_span = ::LightStep::Span.new(
+      tracer: ::Bigcommerce::Lightstep::Tracer.instance,
+      operation_name: span_name,
+      max_log_records: 0,
+      start_micros: 0
+    )
+    expect(::Bigcommerce::Lightstep::Tracer.instance).to receive(:start_span).with(span_name).and_yield(lightstep_span).ordered
+    opts.fetch(:tags, {}).each do |key, value|
+      expect(lightstep_span).to receive(:set_tag).with(key.to_s, value)
+    end
+    proc.call
+  end
+  supports_block_expectations
+end
+
+BC_LIGHTSTEP_RSPEC_RUNNER.configure do |config|
+  config.include Bigcommerce::Lightstep::RspecHelpers
+  config.before do
+    # provide a dummy span for noop calls
+    lightstep_span = ::LightStep::Span.new(
+      tracer: ::Bigcommerce::Lightstep::Tracer.instance,
+      operation_name: 'default',
+      max_log_records: 0,
+      start_micros: 0
+    )
+    allow(::Bigcommerce::Lightstep::Tracer.instance).to receive(:start_span).and_yield(lightstep_span)
+  end
+end

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.5.1'
+    VERSION = '1.5.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/bigcommerce/lightstep/rails_controller_instrumentation.rb
 - lib/bigcommerce/lightstep/redis/tracer.rb
 - lib/bigcommerce/lightstep/redis/wrapper.rb
+- lib/bigcommerce/lightstep/rspec.rb
 - lib/bigcommerce/lightstep/tracer.rb
 - lib/bigcommerce/lightstep/transport.rb
 - lib/bigcommerce/lightstep/transport_factory.rb