test-tracer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '08c73d7179f4a3100079ed3fa36c5c51aaad096a'
+  data.tar.gz: c7a8df736786cb89a067ed211d5b62f677d08570
+SHA512:
+  metadata.gz: e999c4923ecb4dd3bf58efe5263de0990a4635c695b4246a856548577145f58730f5a42a3c82c4cc389ed5c84fd3d368878084b3972125488d3415b21b0fdbb8
+  data.tar.gz: 0d6ddb5fa0451ddede77b7bf2430b80ac21c56006557fdf2e497448da1109afab1f0bc2bea67227987b761981b4c5d4bdf1d1a360703a1dfb7b97759be12fa86

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in test-tracer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+[![Build Status](https://travis-ci.org/iaintshine/ruby-test-tracer.svg?branch=master)](https://travis-ci.org/iaintshine/ruby-test-tracer)
+# Test::Tracer
+
+Fully OpenTracing compatible in-memory Tracer implementation which records all the spans, and includes methods which you might find helpful during testing. The tracer is fully agnostic to any testing framework.
+
+The framework came to alive, because I had a constant need of some kind of "recording" tracer that I could use during tests of new instrumentation libraries for OpenTracing like rails-tracer, tracing-logger etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'test-tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install test-tracer
+
+## Test::Tracer
+
+In addition to OT compatible methods `Test::Tracer` provides the following methods:
+
+1. `spans` returns all spans, including those in progress.
+2. `finished_spans` returns only finished spans.
+
+## Test::Span
+
+In addition to OT compatible methods `Test::Span` provides the following methods:
+
+1. `tracer` returns the tracer the span was created by.
+1. `in_progress?` informs whether the span is in progress, or it's finished.
+2. `start_time` returns when the span was started.
+2. `end_time` returns when the span was finished, or nil if still in progress.
+2. `tags` returns the span's tags.
+2. `logs` returns the span's logs, an array of `Test::Span::LogEntry`s.
+
+The modification operations e.g. `operation_name=`, `set_tag`, `set_baggage_item` on a span are not allowed after it's finished. It throws `Test::Span::SpanAlreadyFinished` exception. The same with `finish`. The span can be finished only once.
+
+## Test::SpanContext
+
+Context propagation is fully implemented by the tracer, and is inspired by [Jaeger](http://jaeger.readthedocs.io/en/latest/) and [TraceContext](https://github.com/TraceContext/tracecontext-spec/pull/1/files). In addition to OT compatible methods `Test::SpanContext` provides the following methods:
+
+1. `trace_id` returns the ID of the whole trace forest.
+1. `span_id` returns the ID of the current span.
+2. `parent_span_id` returns the ID of the parent span.
+
+## Usage
+
+```ruby
+gem 'test-tracer'
+
+tracer = Test::Tracer.new
+
+root_span = tracer.start_span("root")
+tracer.spans # => will include root_span
+child_span = tracer.start_span("child", child_of: root_span)
+tracer.spans # => will include both root_span, child_span 
+
+child_span.finish
+tracer.finished_spans # => will include child_span
+root_span.finish
+tracer.finished_spans # => will include child_span, root_span
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iaintshine/ruby-test-tracer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "test/tracer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/test/id_provider.rb

@@ -0,0 +1,11 @@
+require 'securerandom'
+
+module Test
+  module IdProvider
+    class << self
+      def generate
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/test/span.rb

@@ -0,0 +1,91 @@
+module Test
+  class Span < OpenTracing::Span
+    class SpanAlreadyFinished < StandardError; end
+
+    class LogEntry < Struct.new(:event, :timestamp, :fields); end
+
+    include TypeCheck
+
+    attr_reader :tracer, :operation_name, :start_time, :end_time, :tags, :logs
+
+    def initialize(tracer:, context:, operation_name:, start_time: Time.now, tags: nil)
+      Type! tracer, ::Test::Tracer
+      Type! context, ::Test::SpanContext
+      Type! operation_name, String
+      Type! start_time, Time
+      Type! tags, Hash, NilClass
+
+      @tracer = tracer
+      @context = context
+      @operation_name = operation_name
+      @tags = tags || {}
+      @logs = []
+      @start_time = start_time
+      @end_time = nil
+      @in_progress = true
+    end
+
+    def in_progress?
+      @in_progress
+    end
+
+    def context
+      @context
+    end
+
+    def operation_name=(name)
+      Type! name, String
+      ensure_in_progress!
+
+      @operation_name = name
+    end
+
+    def set_tag(key, value)
+      Type! key, String
+      ensure_in_progress!
+
+      @tags[key] = Type?(value, String, Fixnum, Bignum, Float, TrueClass, FalseClass) ? value : value.to_s
+      self
+    end
+
+    def set_baggage_item(key, value)
+      Type! key, String
+      Type! value, String, NilClass
+      ensure_in_progress!
+
+      @context.baggage[key] = value.to_s
+      self
+    end
+
+    def get_baggage_item(key)
+      Type! key, String
+      @context.baggage[key]
+    end
+
+    def log(event: nil, timestamp: Time.now, **fields)
+      Type! event, String, NilClass
+      Type! timestamp, Time
+      ensure_in_progress!
+
+      @logs << LogEntry.new(event, timestamp, fields)
+    end
+
+    def finish(end_time: Time.now)
+      Type! end_time, Time
+      ensure_in_progress!
+
+      @end_time = end_time
+      @in_progress = false
+      @tracer.finished_spans << self
+      self
+    end
+
+  private
+
+    def ensure_in_progress!
+      unless in_progress?
+        raise SpanAlreadyFinished.new("No modification operations allowed. The span is already finished.")
+      end
+    end
+  end
+end

data/lib/test/span_context.rb

@@ -0,0 +1,35 @@
+module Test
+  class SpanContext < OpenTracing::SpanContext
+    class << self
+      def root
+        new(trace_id: IdProvider.generate,
+            span_id: IdProvider.generate)
+      end
+
+      def child_of(parent_context)
+        new(trace_id: parent_context.trace_id,
+            span_id: IdProvider.generate,
+            parent_span_id: parent_context.span_id,
+            baggage: parent_context.baggage)
+      end
+    end
+
+    include TypeCheck
+
+    attr_reader :trace_id, :span_id, :parent_span_id
+
+    def initialize(trace_id:, span_id:, parent_span_id: nil, baggage: {})
+      Type! trace_id, String
+      Type! span_id, String
+      Type! parent_span_id, String, NilClass
+      Type! baggage, Hash
+
+      super(baggage: baggage)
+
+      @trace_id = trace_id
+      @span_id = span_id
+      @parent_span_id = parent_span_id
+      @baggage = baggage
+    end
+  end
+end

data/lib/test/tracer.rb

@@ -0,0 +1,40 @@
+require 'opentracing'
+
+require_relative 'type_check'
+require_relative 'id_provider'
+require_relative 'span_context'
+require_relative  'span'
+
+module Test
+  class Tracer < OpenTracing::Tracer
+    include TypeCheck
+
+    attr_reader :spans, :finished_spans
+
+    def initialize
+      @spans = []
+      @finished_spans = []
+    end
+
+    def start_span(operation_name, child_of: nil, references: nil, start_time: Time.now, tags: nil)
+      Type! child_of, ::Test::Span, ::Test::SpanContext, NilClass
+
+      parent_context = child_of && child_of.respond_to?(:context) ? child_of.context : child_of
+      new_context = parent_context ? ::Test::SpanContext.child_of(parent_context) : ::Test::SpanContext.root
+
+      new_span = Span.new(tracer: self,
+                          operation_name: operation_name,
+                          context: new_context,
+                          start_time: start_time,
+                          tags: tags)
+      @spans << new_span
+      new_span
+    end
+
+    def clear
+      @spans.clear
+      @finished_spans.clear
+      self
+    end
+  end
+end

data/lib/test/type_check.rb

@@ -0,0 +1,19 @@
+module Test
+  module TypeCheck
+    class NullError < StandardError; end
+
+    def Type?(value, *types)
+      types.any? { |t| value.is_a? t }
+    end
+
+    def Type!(value, *types)
+      Type?(value, *types) or
+        raise TypeError, "Value (#{value.class}) '#{value}' is not any of: #{types.join('; ')}."
+      value
+    end
+
+    def NotNull!(value)
+      raise NullError, "Value must not be nil" unless value
+    end
+  end
+end

data/test-tracer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "test-tracer"
+  spec.version       = "1.0.0"
+  spec.authors       = ["iaintshine"]
+  spec.email         = ["bodziomista@gmail.com"]
+
+  spec.summary       = %q{OpenTracing compatible Tracer implementation to be used in tests in Ruby}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/iaintshine/ruby-test-tracer"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'opentracing', '~> 0.3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: test-tracer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- iaintshine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- bodziomista@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/test/id_provider.rb
+- lib/test/span.rb
+- lib/test/span_context.rb
+- lib/test/tracer.rb
+- lib/test/type_check.rb
+- test-tracer.gemspec
+homepage: https://github.com/iaintshine/ruby-test-tracer
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: OpenTracing compatible Tracer implementation to be used in tests in Ruby
+test_files: []