lenjador 1.2.1 → 1.3.0

data/spec/lenjador/utils_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Lenjador::Utils do
+  let(:now) { Time.utc(2015, 10, 11, 23, 10, 21, 123_456) }
+
+  before do
+    allow(Time).to receive(:now) { now }
+  end
+
+  describe '.build_event' do
+    subject(:event) { described_class.build_event(metadata, level, application_name) }
+
+    let(:application_name) { 'test_service' }
+    let(:level) { :info }
+    let(:metadata) { {x: 'y'} }
+
+    it 'includes it in the event as application' do
+      expect(event[:application]).to eq(application_name)
+    end
+
+    it 'includes log level' do
+      expect(event[:level]).to eq(:info)
+    end
+
+    it 'includes timestamp' do
+      expect(event[:@timestamp]).to eq('2015-10-11T23:10:21.123Z')
+    end
+
+    context 'when @timestamp provided' do
+      let(:metadata) { {message: 'test', :@timestamp => 'a timestamp'} }
+
+      it 'overwrites @timestamp' do
+        expect(event[:message]).to eq('test')
+        expect(event[:@timestamp]).to eq('a timestamp')
+      end
+    end
+
+    context 'when host provided' do
+      let(:metadata) { {message: 'test', host: 'xyz'} }
+
+      it 'overwrites host' do
+        expect(event[:message]).to eq('test')
+        expect(event[:host]).to eq('xyz')
+      end
+    end
+
+    context 'when OpenTracing is defined' do
+      let(:trace_id) { 'trace-id' }
+      let(:span_id) { 'span-id' }
+
+      it 'includes tracing data in the event when active span is present' do
+        span_context = double(trace_id: trace_id, span_id: span_id)
+        span = double(context: span_context)
+        open_tracing = double(active_span: span)
+        stub_const('OpenTracing', open_tracing)
+
+        expect(event).to include(
+          trace_id: trace_id,
+          span_id: span_id
+        )
+      end
+
+      it 'does not include tracing data if active span is not present' do
+        open_tracing = double(active_span: nil)
+        stub_const('OpenTracing', open_tracing)
+
+        expect(event).not_to include(:trace_id, :span_id)
+      end
+
+      it 'does not include tracing data if active span does not respond to trace_id' do
+        span_context = double(span_id: span_id)
+        span = double(context: span_context)
+        open_tracing = double(active_span: span)
+        stub_const('OpenTracing', open_tracing)
+
+        expect(event).not_to include(:trace_id, :span_id)
+      end
+
+      it 'does not include tracing data if active span does not respond to span_id' do
+        span_context = double(trace_id: trace_id)
+        span = double(context: span_context)
+        open_tracing = double(active_span: span)
+        stub_const('OpenTracing', open_tracing)
+
+        expect(event).not_to include(:trace_id, :span_id)
+      end
+    end
+  end
+
+  describe '.serialize_time_objects!' do
+    let(:object) do
+      {
+        time: Time.now,
+        hash: {
+          time: Time.now
+        },
+        array: [
+          Time.now,
+          {
+            time: Time.now
+          }
+        ]
+      }
+    end
+
+    let(:serialized_time) { now.iso8601 }
+
+    it 'recursively serializes time objects to iso8601' do
+      o = object.dup
+      described_class.serialize_time_objects!(o)
+
+      expect(o).to eq(
+        time: serialized_time,
+        hash: {
+          time: serialized_time
+        },
+        array: [
+          serialized_time,
+          {
+            time: serialized_time
+          }
+        ]
+      )
+    end
+  end
+end

data/spec/lenjador_spec.rb

@@ -30,7 +30,7 @@ describe Lenjador do
     end
 
     it 'creates preprocessor when preprocessor defined' do
-      expect(described_class).to receive(:new) do |adapters, preprocessors|
+      expect(described_class).to receive(:new) do |_adapters, preprocessors|
         expect(preprocessors.count).to be(1)
         expect(preprocessors.first).to be_a(described_class::Preprocessors::Blacklist)
       end
@@ -104,7 +104,7 @@ describe Lenjador do
     end
   end
 
-  context 'log level queries' do
+  context 'with log level' do
     context 'when adapter has debug level' do
       let(:logger) do
         described_class.build('test_service', stdout: {level: 'debug'})
@@ -133,10 +133,4 @@ describe Lenjador do
       end
     end
   end
-
-  it 'has the same interface as Ruby logger' do
-    skip "https://salemove.atlassian.net/browse/INF-464"
-    logger = described_class.build('test_service', stdout: {level: 'debug'})
-    expect(logger).to implement_interface(Logger)
-  end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ Bundler.setup
 
 require 'lenjador'
 
-Dir[File.dirname(__FILE__) + '/support/*.rb'].each {|f| require f}
+Dir[File.dirname(__FILE__) + '/support/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenjador
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: rubocop-salemove
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -103,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -123,15 +166,16 @@ files:
 - lib/lenjador/preprocessors/strategies/prune.rb
 - lib/lenjador/preprocessors/whitelist.rb
 - lib/lenjador/utils.rb
-- spec/adapters/stdout_adapter_spec.rb
-- spec/adapters/stdout_json_adapter_spec.rb
+- profiler/logs.rb
+- spec/lenjador/adapters/stdout_adapter_spec.rb
+- spec/lenjador/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador/preprocessors/blacklist_spec.rb
+- spec/lenjador/preprocessors/json_pointer_trie_spec.rb
+- spec/lenjador/preprocessors/whitelist_spec.rb
+- spec/lenjador/utils_spec.rb
 - spec/lenjador_spec.rb
-- spec/preprocessors/blacklist_spec.rb
-- spec/preprocessors/json_pointer_trie.rb
-- spec/preprocessors/whitelist_spec.rb
 - spec/spec_helper.rb
 - spec/support/implement_interface.rb
-- spec/utils_spec.rb
 homepage: 
 licenses:
 - MIT
@@ -157,12 +201,12 @@ signing_key:
 specification_version: 4
 summary: What description said
 test_files:
-- spec/adapters/stdout_adapter_spec.rb
-- spec/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador/adapters/stdout_adapter_spec.rb
+- spec/lenjador/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador/preprocessors/blacklist_spec.rb
+- spec/lenjador/preprocessors/json_pointer_trie_spec.rb
+- spec/lenjador/preprocessors/whitelist_spec.rb
+- spec/lenjador/utils_spec.rb
 - spec/lenjador_spec.rb
-- spec/preprocessors/blacklist_spec.rb
-- spec/preprocessors/json_pointer_trie.rb
-- spec/preprocessors/whitelist_spec.rb
 - spec/spec_helper.rb
 - spec/support/implement_interface.rb
-- spec/utils_spec.rb

data/spec/preprocessors/whitelist_spec.rb

@@ -1,335 +0,0 @@
-require 'spec_helper'
-require_relative '../../lib/lenjador/preprocessors/whitelist'
-
-RSpec.describe Lenjador::Preprocessors::Whitelist, 'when :action is :mask or omitted' do
-  subject(:processed_data) { described_class.new(config).process(data) }
-
-  let(:config) { { pointers: pointers } }
-  let(:pointers) { [] }
-  let(:data) do
-    {
-      field: 'secret',
-      data: {
-        field: 'secret'
-      },
-      array: [{ field: 'secret' }]
-    }
-  end
-
-  it 'masks all non-whitelisted fields' do
-    expect(processed_data).to eq(
-      field: '*****',
-      data: '*****',
-      array: '*****'
-    )
-  end
-
-  context 'when pointer has trailing slash' do
-    let(:pointers) { ['/field/'] }
-
-    it 'throws exception' do
-      expect { processed_data }.to raise_exception(Lenjador::Preprocessors::Whitelist::InvalidPointerFormatException)
-    end
-  end
-
-  context 'with whitelisted field' do
-    let(:pointers) { ['/field'] }
-
-    it 'includes the field' do
-      expect(processed_data).to eq(
-        field: 'secret',
-        data: '*****',
-        array: '*****'
-      )
-    end
-  end
-
-  context 'with whitelisted nested field' do
-    let(:pointers) { ['/data/field'] }
-
-    it 'includes nested field' do
-      expect(processed_data).to eq(
-        field: '*****',
-        data: {
-          field: 'secret'
-        },
-        array: '*****'
-      )
-    end
-  end
-
-  context 'with whitelisted array element field' do
-    let(:pointers) { ['/array/0/field'] }
-
-    it 'includes array element' do
-      expect(processed_data).to eq(
-        field: '*****',
-        data: '*****',
-        array: [{ field: 'secret' }]
-      )
-    end
-  end
-
-  context 'with whitelisted hash' do
-    it 'includes all whitelisted hash elements' do
-      source = { foo: { bar: 'baz' } }
-      target = { foo: { bar: 'baz' } }
-      expect(process(['/foo/~'], source)).to eq(target)
-    end
-
-    it 'does not include nested elements' do
-      source = { foo: { bar: { baz: 'asd' } } }
-      target = { foo: { bar: { baz: '*****' } } }
-      expect(process(['/foo/~'], source)).to eq(target)
-    end
-  end
-
-  context 'with whitelisted array elements field with wildcard' do
-    let(:data) do
-      {
-        array: [
-          { field: 'data1', secret: 'secret1' },
-          { field: 'data2', secret: 'secret2' }
-        ]
-      }
-    end
-    let(:pointers) { ['/array/~/field'] }
-
-    it 'includes array elements field' do
-      expect(processed_data).to include(
-        array: [
-          { field: 'data1', secret: '*****' },
-          { field: 'data2', secret: '*****' }
-        ]
-      )
-    end
-  end
-
-  context 'with whitelisted string array elements with wildcard' do
-    let(:data) do
-      { array: %w[secret secret] }
-    end
-    let(:pointers) { ['/array/~'] }
-
-    it 'includes array elements' do
-      expect(processed_data).to include(array: %w[secret secret])
-    end
-  end
-
-  context 'with whitelisted string array elements in an array with wildcard' do
-    let(:data) do
-      {
-        nested: [{ array: %w[secret secret] }]
-      }
-    end
-    let(:pointers) { ['/nested/~/array/~'] }
-
-    it 'includes array elements' do
-      expect(processed_data).to include(nested: [{ array: %w[secret secret] }])
-    end
-  end
-
-
-  context 'with whitelisted array element' do
-    let(:pointers) { ['/array/0'] }
-
-    it 'masks array element' do
-      expect(processed_data).to include(array: [{ field: '*****' }])
-    end
-  end
-
-  context 'with whitelisted array' do
-    let(:pointers) { ['/array'] }
-
-    it 'masks array' do
-      expect(processed_data).to include(array: ['*****'])
-    end
-  end
-
-  context 'with whitelisted hash' do
-    let(:pointers) { ['/data'] }
-
-    it 'masks hash' do
-      expect(processed_data).to include(data: { field: '*****' })
-    end
-  end
-
-  context 'when boolean present' do
-    let(:data) { { bool: true } }
-
-    it 'masks it with asteriks' do
-      expect(processed_data).to eq(bool: '*****')
-    end
-  end
-
-  context 'when field has slash in the name' do
-    let(:data) do
-      { 'field_with_/' => 'secret' }
-    end
-    let(:pointers) { ['/field_with_~1'] }
-
-    it 'includes field' do
-      expect(processed_data).to include('field_with_/'=> 'secret')
-    end
-  end
-
-  context 'when field has tilde in the name' do
-    let(:data) do
-      { 'field_with_~' => 'secret' }
-    end
-    let(:pointers) { ['/field_with_~0'] }
-
-    it 'includes field' do
-      expect(processed_data).to include('field_with_~'=> 'secret')
-    end
-  end
-
-  context 'when field has tilde and 1' do
-    let(:data) do
-      { 'field_with_~1' => 'secret' }
-    end
-    let(:pointers) { ['/field_with_~01'] }
-
-    it 'includes field' do
-      expect(processed_data).to include('field_with_~1'=> 'secret')
-    end
-  end
-
-  def process(pointers, data)
-    described_class.new(pointers: pointers).process(data)
-  end
-end
-
-RSpec.describe Lenjador::Preprocessors::Whitelist, 'when :action is :exclude or :prune' do
-  subject(:processed_data) { described_class.new(config).process(data) }
-
-  let(:config) { { pointers: pointers, action: :prune } }
-  let(:pointers) { [] }
-  let(:data) do
-    {
-      field: 'secret',
-      data: {
-        field: 'secret'
-      },
-      array: [{ field: 'secret' }, { field2: 'secret' }]
-    }
-  end
-
-  context 'when pointers is empty' do
-    it 'prunes all fields from the input' do
-      expect(processed_data).to eq({})
-    end
-  end
-
-  context 'with whitelisted field' do
-    let(:pointers) { ['/field'] }
-
-    it 'includes the field' do
-      expect(processed_data).to eq(field: 'secret')
-    end
-  end
-
-  context 'with whitelisted nested field' do
-    let(:pointers) { ['/data/field'] }
-
-    it 'includes nested field' do
-      expect(processed_data).to eq(data: { field: 'secret' })
-    end
-  end
-
-  context 'with whitelisted array element field' do
-    let(:pointers) { ['/array/0/field'] }
-
-    it 'includes array element' do
-      expect(processed_data).to eq(array: [{ field: 'secret' }])
-    end
-  end
-
-  context 'with whitelisted hash' do
-    it 'includes all whitelisted hash elements' do
-      source = { foo: { bar: 'baz' } }
-      target = { foo: { bar: 'baz' } }
-      expect(process(['/foo/~'], source)).to eq(target)
-    end
-
-    it 'does not include nested elements' do
-      source = { foo: { bar: { baz: 'asd' } } }
-      target = { foo: { bar: {} } }
-      expect(process(['/foo/~'], source)).to eq(target)
-    end
-  end
-
-  context 'with whitelisted array elements field with wildcard' do
-    let(:data) do
-      {
-        array: [
-          { field: 'data1', secret: 'secret1' },
-          { field: 'data2', secret: 'secret2' }
-        ]
-      }
-    end
-    let(:pointers) { ['/array/~/field'] }
-
-    it 'includes array elements field' do
-      expect(processed_data).to include(
-                                  array: [
-                                    { field: 'data1' },
-                                    { field: 'data2' }
-                                  ]
-                                )
-    end
-  end
-
-  context 'with whitelisted string array elements with wildcard' do
-    let(:data) do
-      { array: %w[secret1 secret2] }
-    end
-    let(:pointers) { ['/array/~'] }
-
-    it 'includes array elements' do
-      expect(processed_data).to include(array: %w[secret1 secret2])
-    end
-  end
-
-  context 'with whitelisted string array elements in an array with wildcard' do
-    let(:data) do
-      {
-        nested: [{ array: %w[secret1 secret2] }]
-      }
-    end
-    let(:pointers) { ['/nested/~/array/~'] }
-
-    it 'includes array elements' do
-      expect(processed_data).to include(nested: [{ array: %w[secret1 secret2] }])
-    end
-  end
-
-
-  context 'with whitelisted array element' do
-    let(:pointers) { ['/array/0'] }
-
-    it 'masks array element' do
-      expect(processed_data).to eq(array: [{}])
-    end
-  end
-
-  context 'with whitelisted array' do
-    let(:pointers) { ['/array'] }
-
-    it 'masks array' do
-      expect(processed_data).to include(array: [])
-    end
-  end
-
-  context 'with whitelisted hash' do
-    let(:pointers) { ['/data'] }
-
-    it 'masks hash' do
-      expect(processed_data).to include(data: {})
-    end
-  end
-
-  def process(pointers, data)
-    described_class.new(pointers: pointers, action: :prune).process(data)
-  end
-end