lenjador 1.2.1 → 2.1.0

data/spec/lenjador/preprocessors/whitelist_spec.rb

@@ -0,0 +1,319 @@
+require 'spec_helper'
+require_relative '../../../lib/lenjador/preprocessors/whitelist'
+
+RSpec.describe Lenjador::Preprocessors::Whitelist do
+  context '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 '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
+
+  context '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
+
+    def process(pointers, data)
+      described_class.new(pointers: pointers, action: :prune).process(data)
+    end
+  end
+end

data/spec/lenjador/utils_spec.rb

@@ -0,0 +1,99 @@
+# 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(now)
+    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 # rubocop:disable RSpec/MultipleMemoizedHelpers
+      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 '.generate_json' do
+    it 'serializes time objects to iso8601' do
+      serialized_time = now.iso8601(3)
+      json = described_class.generate_json(time: now)
+      expect(json).to eq(%({"time":"#{serialized_time}"}))
+    end
+  end
+end

data/spec/lenjador_spec.rb

@@ -3,34 +3,31 @@ require 'spec_helper'
 describe Lenjador do
   describe '.build' do
     it 'creates stdout logger' do
-      expect(described_class).to receive(:new) do |adapters|
-        expect(adapters.count).to be(1)
-        expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
+      expect(described_class).to receive(:new) do |adapter|
+        expect(adapter).to be_a(described_class::Adapters::StdoutAdapter)
       end
 
-      described_class.build('test_service', stdout: nil)
+      described_class.build('test_service', {})
     end
 
     it 'creates stdout json logger' do
-      expect(described_class).to receive(:new) do |adapters|
-        expect(adapters.count).to be(1)
-        expect(adapters.first).to be_a(described_class::Adapters::StdoutJsonAdapter)
+      expect(described_class).to receive(:new) do |adapter|
+        expect(adapter).to be_a(described_class::Adapters::StdoutJsonAdapter)
       end
 
-      described_class.build('test_service', stdout: {json: true})
+      described_class.build('test_service', json: true)
     end
 
     it 'creates stdout logger when no loggers are specified' do
-      expect(described_class).to receive(:new) do |adapters|
-        expect(adapters.count).to be(1)
-        expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
+      expect(described_class).to receive(:new) do |adapter|
+        expect(adapter).to be_a(described_class::Adapters::StdoutAdapter)
       end
 
       described_class.build('test_service', nil)
     end
 
     it 'creates preprocessor when preprocessor defined' do
-      expect(described_class).to receive(:new) do |adapters, preprocessors|
+      expect(described_class).to receive(:new) do |_adapter, _level, preprocessors|
         expect(preprocessors.count).to be(1)
         expect(preprocessors.first).to be_a(described_class::Preprocessors::Blacklist)
       end
@@ -41,74 +38,74 @@ describe Lenjador do
   end
 
   context 'when preprocessor defined' do
-    let(:lenjador) { described_class.new([adapter], [preprocessor]) }
+    let(:lenjador) { described_class.new(adapter, level, [preprocessor]) }
     let(:adapter) { double }
+    let(:level) { Lenjador::Severity::DEBUG }
     let(:preprocessor) { double }
     let(:data) { {data: 'data'} }
 
     it 'preprocesses data before logging' do
       expect(preprocessor).to receive(:process).with(data).and_return(data.merge(processed: true)).ordered
-      expect(adapter).to receive(:log).with(:info, data.merge(processed: true)).ordered
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, data.merge(processed: true)).ordered
 
       lenjador.info(data)
     end
   end
 
   context 'when parsing log data' do
-    let(:lenjador) { described_class.new([adapter], preprocessors) }
+    let(:lenjador) { described_class.new(adapter, level, preprocessors) }
     let(:adapter) { double }
+    let(:level) { Lenjador::Severity::DEBUG }
     let(:preprocessors) { [] }
 
     it 'parses empty string with nil metadata' do
-      expect(adapter).to receive(:log).with(:info, message: '')
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: '')
 
       lenjador.info('', nil)
     end
 
     it 'parses nil as metadata' do
-      expect(adapter).to receive(:log).with(:info, message: nil)
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: nil)
 
       lenjador.info(nil)
     end
 
     it 'parses only message' do
-      expect(adapter).to receive(:log).with(:info, message: 'test message')
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: 'test message')
 
       lenjador.info 'test message'
     end
 
     it 'parses only metadata' do
-      expect(adapter).to receive(:log).with(:info, test: 'data')
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, test: 'data')
 
       lenjador.info test: 'data'
     end
 
     it 'parses message and metadata' do
-      expect(adapter).to receive(:log).with(:info, message: 'test message', test: 'data')
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: 'test message', test: 'data')
 
       lenjador.info 'test message', test: 'data'
     end
 
     it 'parses block as a message' do
       message = 'test message'
-      expect(adapter).to receive(:log).with(:info, message: message)
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: message)
 
       lenjador.info { message }
     end
 
     it 'ignores progname on block syntax' do
       message = 'test message'
-      expect(adapter).to receive(:log).with(:info, message: message)
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: message)
 
       lenjador.info('progname') { message }
     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'})
-      end
+      let(:logger) { described_class.build('test_service', level: 'debug') }
 
       it 'responds true to debug? and higher levels' do
         expect(logger.debug?).to be(true)
@@ -120,9 +117,7 @@ describe Lenjador do
     end
 
     context 'when adapter has info level' do
-      let(:logger) do
-        described_class.build('test_service', stdout: {level: 'info'})
-      end
+      let(:logger) { described_class.build('test_service', level: 'info') }
 
       it 'responds true to info? and higher levels' do
         expect(logger.debug?).to be(false)
@@ -134,9 +129,22 @@ describe Lenjador do
     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)
+  it 'allows changing log level on existing instance' do
+    logger = described_class.build('test_service', level: 'info')
+
+    logger.level = ::Logger::DEBUG
+    expect(logger.debug?).to eq(true)
+
+    logger.level = ::Logger::INFO
+    expect(logger.debug?).to eq(false)
+    expect(logger.info?).to eq(true)
+
+    logger.level = ::Logger::WARN
+    expect(logger.info?).to eq(false)
+    expect(logger.warn?).to eq(true)
+
+    logger.level = ::Logger::ERROR
+    expect(logger.warn?).to eq(false)
+    expect(logger.error?).to eq(true)
   end
 end