test-tracer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08c73d7179f4a3100079ed3fa36c5c51aaad096a'
-  data.tar.gz: c7a8df736786cb89a067ed211d5b62f677d08570
+  metadata.gz: ee64ccc49b552feba85f706f6bac12e3e533ce01
+  data.tar.gz: 8209e0cfc6486a354fee51bc126e5740fc12d7ad
 SHA512:
-  metadata.gz: e999c4923ecb4dd3bf58efe5263de0990a4635c695b4246a856548577145f58730f5a42a3c82c4cc389ed5c84fd3d368878084b3972125488d3415b21b0fdbb8
-  data.tar.gz: 0d6ddb5fa0451ddede77b7bf2430b80ac21c56006557fdf2e497448da1109afab1f0bc2bea67227987b761981b4c5d4bdf1d1a360703a1dfb7b97759be12fa86
+  metadata.gz: 703cb08e6050c4f3e43391bc6cf8ca3a45dfbd69a71117d2ee6338b3441d29d1cf858965f3757c12889850aac80c6a6b56d2e5c28988109334794346efb7bad4
+  data.tar.gz: 54d59ab71bb8a9619ba627e12ded651cb8d795fe315ed8cff7de52dad127b55812e29989da2c7191070c6da0c1689eb5860748c71f8be9f96f6f27dabd284270

data/lib/test/propagation.rb

@@ -0,0 +1,5 @@
+require "test/propagation/injector"
+require "test/propagation/extractor"
+require "test/propagation/codec"
+require "test/propagation/rack_codec"
+require "test/propagation/text_map_codec"

data/lib/test/propagation/codec.rb

@@ -0,0 +1,8 @@
+module Test
+  module Propagation
+    class Codec
+      include Injector
+      include Extractor
+    end
+  end
+end

data/lib/test/propagation/extractor.rb

@@ -0,0 +1,12 @@
+module Test
+  module Propagation
+    module Extractor
+      # Extract a SpanContext from the given carrier.
+      #
+      # @param carrier [Carrier] A carrier object
+      # @return [SpanContext, nil] the extracted SpanContext or nil if none could be found
+      def extract(carrier)
+      end
+    end
+  end
+end

data/lib/test/propagation/injector.rb

@@ -0,0 +1,12 @@
+module Test
+  module Propagation
+    module Injector
+      # Inject a SpanContext into the given carrier
+      #
+      # @param span_context [SpanContext]
+      # @param carrier [Carrier] A carrier object
+      def inject(span_context, carrier)
+      end
+    end
+  end
+end

data/lib/test/propagation/rack_codec.rb

@@ -0,0 +1,35 @@
+module Test
+  module Propagation
+    class RackCodec
+      module Headers
+        TRACE_ID = "X-Trace-Id".freeze
+        SPAN_ID = "X-Span-Id".freeze
+        PARENT_SPAN_ID = "X-Parent-Span-Id".freeze
+
+        module Rack
+          TRACE_ID = "HTTP_X_TRACE_ID".freeze
+          SPAN_ID = "HTTP_X_SPAN_ID".freeze
+          PARENT_SPAN_ID = "HTTP_X_PARENT_SPAN_ID".freeze
+        end
+      end
+
+      def inject(span_context, carrier)
+        carrier[Headers::TRACE_ID] = span_context.trace_id
+        carrier[Headers::SPAN_ID] = span_context.span_id
+        carrier[Headers::PARENT_SPAN_ID] = span_context.parent_span_id
+      end
+
+      def extract(carrier)
+        trace_id = carrier[Headers::Rack::TRACE_ID]
+        span_id = carrier[Headers::Rack::SPAN_ID]
+        parent_span_id = carrier[Headers::Rack::PARENT_SPAN_ID]
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id,
+                          span_id: span_id,
+                          parent_span_id: parent_span_id)
+        end
+      end
+    end
+  end
+end

data/lib/test/propagation/text_map_codec.rb

@@ -0,0 +1,27 @@
+module Test
+  module Propagation
+    class TextMapCodec
+      TRACE_ID = "trace_id".freeze
+      SPAN_ID = "span_id".freeze
+      PARENT_SPAN_ID = "parent_span_id".freeze
+
+      def inject(span_context, carrier)
+        carrier[TRACE_ID] = span_context.trace_id
+        carrier[SPAN_ID] = span_context.span_id
+        carrier[PARENT_SPAN_ID] = span_context.parent_span_id
+      end
+
+      def extract(carrier)
+        trace_id = carrier[TRACE_ID]
+        span_id = carrier[SPAN_ID]
+        parent_span_id = carrier[PARENT_SPAN_ID]
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id,
+                          span_id: span_id,
+                          parent_span_id: parent_span_id)
+        end
+      end
+    end
+  end
+end

data/lib/test/tracer.rb

@@ -1,21 +1,56 @@
 require 'opentracing'
 
 require_relative 'type_check'
-require_relative 'id_provider'
-require_relative 'span_context'
-require_relative  'span'
+require 'test/id_provider'
+require 'test/span_context'
+require 'test/span'
+require 'test/propagation'
 
 module Test
   class Tracer < OpenTracing::Tracer
     include TypeCheck
 
     attr_reader :spans, :finished_spans
+    attr_reader :injectors, :extractors
+
+    attr_accessor :logger
+
+    def initialize(logger: nil)
+      @logger = logger
 
-    def initialize
       @spans = []
       @finished_spans = []
+
+      @injectors = {}
+      @extractors = {}
+
+      register_codec(OpenTracing::FORMAT_TEXT_MAP, Propagation::TextMapCodec.new)
+      register_codec(OpenTracing::FORMAT_RACK, Propagation::RackCodec.new)
+    end
+
+    def register_injector(format, injector)
+      NotNull! format
+      Argument! injector.respond_to?(:inject), "Injector must respond to 'inject' method"
+
+      @injectors[format] = injector
+      self
+    end
+
+    def register_extractor(format, extractor)
+      NotNull! format
+      Argument! extractor.respond_to?(:extract), "Extractor must respond to 'extract' method"
+
+      @extractors[format] = extractor
+      self
     end
 
+    def register_codec(format, codec)
+      register_injector(format, codec)
+      register_extractor(format, codec)
+      self
+    end
+
+    # OT complaiant
     def start_span(operation_name, child_of: nil, references: nil, start_time: Time.now, tags: nil)
       Type! child_of, ::Test::Span, ::Test::SpanContext, NilClass
 
@@ -31,10 +66,43 @@ module Test
       new_span
     end
 
+    # OT complaiant
+    def inject(span_context, format, carrier)
+      Type! span_context, ::Test::SpanContext, NilClass
+      NotNull! format
+      NotNull! carrier
+
+      injector = @injectors[format]
+      if injector
+        injector.inject(span_context, carrier)
+      else
+        log(Logger::WARN, "No injector found for '#{format}' format")
+      end
+    end
+
+    # OT complaiant
+    def extract(format, carrier)
+      NotNull! format
+      NotNull! carrier
+
+      extractor = @extractors[format]
+      if extractor
+        extractor.extract(carrier)
+      else
+        log(Logger::WARN, "No extractor found for '#{format}' format")
+        nil
+      end
+    end
+
     def clear
       @spans.clear
       @finished_spans.clear
       self
     end
+
+  private
+    def log(severity, message)
+      logger.log(severity, message) if logger
+    end
   end
 end

data/lib/test/type_check.rb

@@ -15,5 +15,9 @@ module Test
     def NotNull!(value)
       raise NullError, "Value must not be nil" unless value
     end
+
+    def Argument!(expression, message = "Illegal argument")
+      raise ArgumentError, message unless expression
+    end
   end
 end

data/test-tracer.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "test-tracer"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.0"
   spec.authors       = ["iaintshine"]
   spec.email         = ["bodziomista@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-tracer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - iaintshine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-13 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -84,6 +84,12 @@ files:
 - bin/console
 - bin/setup
 - lib/test/id_provider.rb
+- lib/test/propagation.rb
+- lib/test/propagation/codec.rb
+- lib/test/propagation/extractor.rb
+- lib/test/propagation/injector.rb
+- lib/test/propagation/rack_codec.rb
+- lib/test/propagation/text_map_codec.rb
 - lib/test/span.rb
 - lib/test/span_context.rb
 - lib/test/tracer.rb