loga 2.2.0 → 2.3.0

data/spec/integration/sinatra_spec.rb

@@ -24,23 +24,10 @@ end
 RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
   let(:io) { StringIO.new }
   let(:format) {}
-  before do
-    Loga.reset
-    Loga.configure(
-      device: io,
-      filter_parameters: [:password],
-      format: format,
-      service_name: 'hello_world_app',
-      service_version: '1.0',
-      tags: [:uuid, 'TEST_TAG'],
-    )
-  end
-
   let(:last_log_entry) do
     io.rewind
     JSON.parse(io.read)
   end
-
   let(:app) do
     Rack::Builder.new do
       use Loga::Rack::RequestId
@@ -49,13 +36,26 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
     end
   end
 
+  before do
+    Loga.reset
+    Loga.configure(
+      device: io,
+      filter_parameters: [:password],
+      format: format,
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      tags: [:uuid, 'TEST_TAG'],
+    )
+  end
+
   context 'when RACK_ENV is production', if: ENV['RACK_ENV'].eql?('production') do
     let(:format) { :gelf }
+
     include_examples 'request logger'
 
     it 'does not include the controller name and action' do
       get '/ok'
-      expect(last_log_entry).to_not include('_request.controller')
+      expect(last_log_entry).not_to include('_request.controller')
     end
   end
 
@@ -85,7 +85,7 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
       allow(Process).to receive(:pid).and_return(999)
     end
 
-    context 'get request' do
+    describe 'get request' do
       it 'logs the request' do
         get '/ok', { username: 'yoshi' }, 'HTTP_X_REQUEST_ID' => '700a6a01'
 
@@ -93,7 +93,7 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
       end
     end
 
-    context 'request with redirect' do
+    describe 'request with redirect' do
       let(:data) do
         super().merge(
           'status' => 302,
@@ -101,6 +101,7 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
           'params' => {},
         )
       end
+
       it 'specifies the original path' do
         get '/new', {}, 'HTTP_X_REQUEST_ID' => '700a6a01'
         expect(last_log_entry).to eql("I, #{time_pid_tags} GET /new 302 in 0ms type=request #{data_as_text}\n")

data/spec/loga/sidekiq/job_logger_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+RSpec.describe Loga::Sidekiq::JobLogger do
+  subject(:job_logger) { described_class.new }
+
+  let(:target) { StringIO.new }
+
+  let(:json_line) do
+    target.rewind
+    JSON.parse(target.read.split("\n").last)
+  end
+
+  before do
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  describe '#call' do
+    context 'when the job passess successfully' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        job_logger.call(item_data, 'queue') do
+          # something
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 6,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+        }
+
+        aggregate_failures do
+          expect(json_line).to include(expected_body)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+
+    context 'when the job fails' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        failed_job = lambda do
+          job_logger.call(item_data, 'queue') do
+            raise StandardError
+          end
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 4,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+          '_exception' => 'StandardError',
+        }
+
+        aggregate_failures do
+          expect(&failed_job).to raise_error(StandardError)
+          expect(json_line).to include(expected_body)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+  end
+end

data/spec/loga/sidekiq_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe Loga::Sidekiq do
+  describe '.configure_logging' do
+    context 'when sidekiq version is 5.1' do
+      it 'gets invoked on Loga.configure' do
+        allow(described_class).to receive(:configure_logging)
+
+        Loga.reset
+
+        Loga.configure(
+          service_name: 'hello_world_app',
+          service_version: '1.0',
+          device: StringIO.new,
+          format: :gelf,
+        )
+
+        expect(described_class).to have_received(:configure_logging)
+      end
+
+      it 'assigns our custom sidekiq job logger' do
+        Loga.reset
+
+        Loga.configure(
+          service_name: 'hello_world_app',
+          service_version: '1.0',
+          device: StringIO.new,
+          format: :gelf,
+        )
+
+        expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq::JobLogger)
+      end
+    end
+
+    shared_examples 'a blank change' do
+      it 'does nothing' do
+        expect(described_class.configure_logging).to be_nil
+      end
+    end
+
+    context 'when sidekiq is not defined' do
+      before { hide_const('Sidekiq') }
+
+      it_behaves_like 'a blank change'
+    end
+
+    context 'when sidekiq version is 4.2' do
+      before { stub_const('::Sidekiq::VERSION', '4.2') }
+
+      it_behaves_like 'a blank change'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ require 'simplecov'
 
 SimpleCov.start do
   command_name "ruby-#{RUBY_VERSION}-#{File.basename(ENV['BUNDLE_GEMFILE'], '.gemfile')}"
+
+  # Exclude specs from showing up in the code coverage report.
+  add_filter 'spec/'
 end
 
 case ENV['BUNDLE_GEMFILE']
@@ -26,6 +29,18 @@ when /sinatra/
 when /unit/
   rspec_pattern = 'unit/**/*_spec.rb'
   require 'loga'
+when /sidekiq/
+  sidekiq_specs = [
+    'integration/sidekiq_spec.rb',
+    'spec/loga/sidekiq/**/*_spec.rb',
+    'spec/loga/sidekiq_spec.rb',
+  ]
+
+  rspec_pattern = sidekiq_specs.join(',')
+
+  require 'sidekiq'
+  require 'sidekiq/cli'
+  require 'loga'
 else
   raise 'BUNDLE_GEMFILE is unknown. Ensure the appraisal is present in Appraisals'
 end
@@ -35,4 +50,10 @@ RSpec.configure do |config|
   config.include Rack::Test::Methods
 
   config.pattern = rspec_pattern
+
+  config.mock_with :rspec do |mocks|
+    mocks.allow_message_expectations_on_nil = false
+    mocks.transfer_nested_constants = true
+    mocks.verify_doubled_constant_names = true
+  end
 end

data/spec/support/helpers.rb

@@ -7,6 +7,13 @@ module Helpers
   end
 
   def time_anchor_unix
-    BigDecimal.new('1450150205.123')
+    BigDecimal('1450150205.123')
+  end
+
+  def stub_loga
+    loga = class_double(Loga).as_stubbed_const
+    logger = instance_double(Logger)
+    allow(loga).to receive(:logger).and_return(logger)
+    loga
   end
 end

data/spec/support/request_spec.rb

@@ -1,5 +1,5 @@
 RSpec.shared_examples 'request logger' do
-  context 'get request' do
+  describe 'get request' do
     it 'logs the request' do
       get '/ok',
           { username: 'yoshi' },
@@ -27,7 +27,7 @@ RSpec.shared_examples 'request logger' do
     end
   end
 
-  context 'post request' do
+  describe 'post request' do
     let(:json_response) { JSON.parse(last_response.body) }
 
     it 'logs the request' do
@@ -63,7 +63,7 @@ RSpec.shared_examples 'request logger' do
     end
   end
 
-  context 'request with redirect' do
+  describe 'request with redirect' do
     it 'specifies the original path' do
       get '/new', {}, 'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
@@ -182,7 +182,7 @@ RSpec.shared_examples 'request logger' do
     end
   end
 
-  describe 'when the request uploads a binary file', focus: true do
+  describe 'when the request uploads a binary file' do
     it 'logs the request' do
       post '/users?username=yoshi',
            bob_file: Rack::Test::UploadedFile.new('spec/fixtures/random_bin')

data/spec/support/timecop_shared.rb

@@ -3,5 +3,6 @@ require 'timecop'
 shared_context 'timecop', timecop: true do
   # Allows fixed timestamps
   before(:all) { Timecop.freeze(time_anchor) }
+
   after(:all)  { Timecop.return }
 end

data/spec/unit/loga/configuration_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe Loga::Configuration do
+  subject { described_class.new(options) }
+
   let(:options) do
     { service_name: 'hello_world_app' }
   end
 
-  subject { described_class.new(options) }
-
   describe 'initialize' do
     let(:framework_exceptions) do
       %w[
@@ -75,6 +75,7 @@ describe Loga::Configuration do
           expect(subject.service_version).to eq('unknown.sha')
         end
       end
+
       context 'when initialized via user options' do
         let(:options) { super().merge(service_version: 'v3.0.1') }
 
@@ -105,6 +106,7 @@ describe Loga::Configuration do
 
       context 'when initialized via framework options' do
         subject { described_class.new(options, framework_options) }
+
         let(:framework_options) { { format: :gelf } }
 
         it 'sets the format' do
@@ -126,6 +128,7 @@ describe Loga::Configuration do
 
       context 'when initialized with ENV and framework options' do
         subject { described_class.new(options, framework_options) }
+
         let(:framework_options) { { format: :gelf } }
 
         before do
@@ -200,13 +203,13 @@ describe Loga::Configuration do
       context 'when format is :simple' do
         let(:options) { super().merge(format: :simple) }
 
-        specify { expect(subject.structured?).to eql(false) }
+        specify { expect(subject.structured?).to be(false) }
       end
 
       context 'when format is :gelf' do
         let(:options) { super().merge(format: :gelf) }
 
-        specify { expect(subject.structured?).to eql(true) }
+        specify { expect(subject.structured?).to be(true) }
       end
     end
   end

data/spec/unit/loga/event_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 RSpec.describe Loga::Event, timecop: true do
   describe 'initialize' do
-    context 'no message is passed' do
+    context 'when no message is passed' do
       it 'sets message to an empty string' do
         expect(subject.message).to eq ''
       end
     end
 
-    context 'message is passed' do
+    context 'when message is passed' do
       let(:message) { "stuff \xC2".force_encoding 'ASCII-8BIT' }
       let(:subject) { described_class.new message: message }
 

data/spec/unit/loga/formatters/gelf_formatter_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Loga::Formatters::GELFFormatter do
+  subject { described_class.new(params) }
+
   let(:service_name)    { 'loga' }
   let(:service_version) { '725e032a' }
   let(:host)            { 'www.example.com' }
@@ -12,8 +14,6 @@ describe Loga::Formatters::GELFFormatter do
     }
   end
 
-  subject { described_class.new(params) }
-
   shared_examples 'valid GELF message' do
     it 'includes the required fields' do
       expect(json).to include('version'       => '1.1',
@@ -51,6 +51,7 @@ describe Loga::Formatters::GELFFormatter do
 
     context 'when the message parameter is a nil' do
       let(:message) { nil }
+
       it 'the short_message is empty' do
         expect(json['short_message']).to eq('')
       end
@@ -90,7 +91,7 @@ describe Loga::Formatters::GELFFormatter do
 
       context 'when the Event has a timestamp' do
         let(:time)         { Time.new(2010, 12, 15, 9, 30, 5.323, '+02:00') }
-        let(:time_in_unix) { BigDecimal.new('1292398205.323') }
+        let(:time_in_unix) { BigDecimal('1292398205.323') }
         let(:options)      { { timestamp: time } }
 
         it 'uses the Event timestamp' do
@@ -105,7 +106,7 @@ describe Loga::Formatters::GELFFormatter do
       end
 
       context 'when the Event no type' do
-        specify { expect(json).to_not include('_type') }
+        specify { expect(json).not_to include('_type') }
       end
 
       context 'when the Event has an exception' do
@@ -121,6 +122,7 @@ describe Loga::Formatters::GELFFormatter do
 
         context 'when the backtrace is larger than 10 lines' do
           let(:backtrace) { ('a'..'z').to_a }
+
           it 'truncates the backtrace' do
             expect(json['_exception.backtrace']).to eq("a\nb\nc\nd\ne\nf\ng\nh\ni\nj")
           end
@@ -128,7 +130,7 @@ describe Loga::Formatters::GELFFormatter do
       end
 
       context 'when the Event has no exception' do
-        specify { expect(json).to_not include(/_exception.+/) }
+        specify { expect(json).not_to include(/_exception.+/) }
       end
 
       context 'when the Event has data' do