test-tracer 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee64ccc49b552feba85f706f6bac12e3e533ce01
-  data.tar.gz: 8209e0cfc6486a354fee51bc126e5740fc12d7ad
+  metadata.gz: 4739863b3eb7ab8856bb7aa3a3e0e9bc7c7852b8
+  data.tar.gz: 0c9a7a17bf4adb350b2dc575db89095052b1985d
 SHA512:
-  metadata.gz: 703cb08e6050c4f3e43391bc6cf8ca3a45dfbd69a71117d2ee6338b3441d29d1cf858965f3757c12889850aac80c6a6b56d2e5c28988109334794346efb7bad4
-  data.tar.gz: 54d59ab71bb8a9619ba627e12ded651cb8d795fe315ed8cff7de52dad127b55812e29989da2c7191070c6da0c1689eb5860748c71f8be9f96f6f27dabd284270
+  metadata.gz: ce894897631dd6c8087aedaabceae8abc43a0fdb7795f41dcbfadffc14b3e274a84523289700877c9ef882acfb3d8360775cc385d93667031ab01af527a7b613
+  data.tar.gz: feb5e4eb5f9fda6b9cf2d99fd182f411f3a6e0ed55ba0f3483dbd385ac991782664f8488378a024671ebd07e4539957a1f23d802bc02d45d1dd9c4a073becf43

data/README.md

@@ -28,12 +28,52 @@ In addition to OT compatible methods `Test::Tracer` provides the following metho
 1. `spans` returns all spans, including those in progress.
 2. `finished_spans` returns only finished spans.
 
+### Usage
+
+```ruby
+require "test/tracer"
+
+describe "Test::Tracer examples" do
+  let(:tracer) { Test::Tracer.new }
+
+  context "when we expect no traces" do
+    it "does not have any traces started" do
+      expect(tracer.spans).to be_empty
+    end
+
+    it "does not have any traces recorded" do
+      expect(tracer.finished_spans).to be_empty
+    end
+  end
+
+  context "when we expect traces to be present" do
+    it "does have some traces started" do
+      expect(tracer.spans).not_to be_empty
+    end
+
+    it "does have some traces recorded" do
+      expect(tracer.finished_spans).not_to be_empty
+    end
+  end
+
+  context "when we expect exactly N traces" do
+    it "has N traces started" do
+      expect(tracer.spans.size).to eq(N)
+    end
+
+    it "has N traces recorded" do
+      expect(tracer.finished_spans.size).to eq(N)
+    end
+  end
+end
+```
+
 ## 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.
+1. `in_progress?`, `started?`, `finished?` 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.
@@ -41,6 +81,66 @@ In addition to OT compatible methods `Test::Span` provides the following methods
 
 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.
 
+### Usage
+
+```ruby
+require "test/tracer"
+
+describe "Test::Span examples" do
+  let(:tracer) { Test::Tracer.new }
+
+  context "when a new span was started" do
+    let(:span) { tracer.start_span("operation name", tags: {'component' => 'ActiveRecord'}) }
+
+    it "is in progress" do
+      expect(span.in_progress?).to eq(true) 
+    end
+
+    it "does have the proper name" do
+      expect(span.operation_name).to eq("operation name")
+    end
+
+    it "does include standard OT tags" do
+      expect(span.tags).to include('component' => 'ActiveRecord')
+    end
+
+    it "does not have any log entries" do
+      expect(span.logs).to be_empty
+    end
+  end
+
+  context "when an event was logged" do
+    let(:span) do 
+      current_span = tracer.start_span("operation name")
+      current_span.log(event: "exceptional message", severity: Logger::ERROR, pid: $1)
+      current_span
+    end
+
+    it "does have some log entries recorded" do
+      expect(span.logs).not_to be_empty
+    end
+
+    it "includes all the event attributes" do
+      log = span.logs.first
+      expect(log.event).to eq("exceptional message")
+      expect(log.fields).to include(severity: Logger::ERROR)
+    end
+  end
+
+  context "when a span was finished" do
+    let(:span) { tracer.start_span("operation name").finish }
+
+    it "is not in progress" do
+      expect(span.in_progress?).to eq(false)
+    end
+
+    it "can't be finished twice" do
+      expect { span.finish }.to raise_error(Test::Span::SpanAlreadyFinished)
+    end
+  end
+end
+```
+
 ## 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:
@@ -49,22 +149,28 @@ Context propagation is fully implemented by the tracer, and is inspired by [Jaeg
 1. `span_id` returns the ID of the current span.
 2. `parent_span_id` returns the ID of the parent span.
 
-## Usage
+
+### Usage
 
 ```ruby
-gem 'test-tracer'
+require "test/tracer"
+
+describe "Test::SpanContext examples" do
+  let(:tracer) { Test::Tracer.new }
 
-tracer = Test::Tracer.new
+  context "when a new span was started as child of root" do
+    let(:root_context) { tracer.start_span("root span").context } 
+    let(:child_context) { tracer.start_span("child span", child_of: root_context).context }
 
-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 
+    it "all have the same trace_id" do
+      expect(child_context.trace_id).to eq(root_context.trace_id)
+    end
 
-child_span.finish
-tracer.finished_spans # => will include child_span
-root_span.finish
-tracer.finished_spans # => will include child_span, root_span
+    it "propagates parent child relationship" do
+      expect(child_context.parent_span_id).to eq(root_context.span_id)
+    end
+  end
+end
 ```
 
 ## Development

data/lib/test/span.rb

@@ -29,6 +29,12 @@ module Test
       @in_progress
     end
 
+    alias_method :started?, :in_progress?
+
+    def finished?
+      !in_progress?
+    end
+
     def context
       @context
     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.1.0"
+  spec.version       = "1.1.1"
   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.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - iaintshine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing