loga 2.1.2 → 2.2.0

data/spec/fixtures/rails50.rb

@@ -0,0 +1,80 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups)
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.eager_load = true
+  config.filter_parameters += [:password]
+  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
+  config.session_store :cookie_store, key: '_rails50_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery with: :null_session
+
+  def ok
+    render plain: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver_now
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!

data/spec/fixtures/rails52.rb

@@ -0,0 +1,80 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups)
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.eager_load = true
+  config.filter_parameters += [:password]
+  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
+  config.session_store :cookie_store, key: '_rails52_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery with: :null_session
+
+  def ok
+    render plain: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver_now
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!

data/spec/integration/rails/action_mailer_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+RSpec.describe Loga::LogSubscribers::ActionMailer, if: Rails.env.production? do
+  let(:log_entries) do
+    entries = []
+    STREAM.tap do |s|
+      s.rewind
+      entries = s.read.split("\n").map { |line| JSON.parse(line) }
+      s.close
+      s.reopen
+    end
+    entries
+  end
+
+  let(:last_log_entry) { log_entries.last }
+
+  context 'when an email is being sent' do
+    it 'delivers an email' do
+      send_mail = -> { FakeMailer.send_email }
+
+      expect(&send_mail).to change { FakeMailer.deliveries.size }.by(1)
+    end
+
+    if Gem::Version.new(Rails.version) >= Gem::Version.new('5.0.0')
+      it 'has the proper payload for message processing' do
+        configuration = Loga::Configuration.new(
+          format: :gelf,
+          service_name: 'loga_test',
+          device: STREAM,
+          level: :debug,
+        )
+
+        allow(Loga).to receive(:logger).and_return(configuration.logger)
+
+        FakeMailer.send_email
+
+        message_pattern = /^FakeMailer#basic_mail: Processed outbound mail in\(*/
+        short_message   = log_entries.last(2).first['short_message']
+
+        expect(short_message).to match message_pattern
+      end
+    end
+
+    it 'has the proper payload for message delivery' do
+      FakeMailer.send_email
+
+      message_pattern = /^FakeMailer: Sent mail to user@example.com in \(*/
+      expect(last_log_entry['short_message']).to match(message_pattern)
+    end
+
+    it 'has the additional key "_mailer"' do
+      FakeMailer.send_email
+
+      expect(last_log_entry).to have_key('_mailer')
+    end
+
+    it 'has the additional key "_unique_id"' do
+      FakeMailer.send_email
+
+      expect(last_log_entry).to have_key('_unique_id')
+    end
+  end
+end

data/spec/integration/rails/railtie_spec.rb

@@ -52,6 +52,7 @@ RSpec.describe Loga::Railtie do
       let(:listeners)   do
         ActiveSupport::Notifications.notifier.listeners_for(notification)
       end
+
       let(:subscribers) do
         listeners.map { |l| l.instance_variable_get(:@delegate).class }
       end
@@ -94,6 +95,20 @@ RSpec.describe Loga::Railtie do
           end
         end
       end
+
+      context 'ActionMailer' do
+        [
+          'receive.action_mailer',
+          'deliver.action_mailer',
+          'process.action_mailer',
+        ].each do |notification|
+          let(:notification) { notification }
+
+          it 'removes ActionMailer::LogSubscriber' do
+            expect(subscribers).to_not include(ActionMailer::LogSubscriber)
+          end
+        end
+      end
     end
   end
 end

data/spec/integration/sinatra_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class MySinatraApp < Sinatra::Base
-  set :logging, :false
+  set :logging, false
 
   get '/ok' do
     'Hello Sinatra'
@@ -21,7 +21,7 @@ class MySinatraApp < Sinatra::Base
   end
 end
 
-RSpec.describe 'Structured logging with Sinatra', timecop: true do
+RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
   let(:io) { StringIO.new }
   let(:format) {}
   before do

data/spec/spec_helper.rb

@@ -1,16 +1,14 @@
+require 'byebug'
 require 'pry'
+require 'support/gethostname_shared'
 require 'support/helpers'
-require 'support/timecop_shared'
 require 'support/request_spec'
+require 'support/timecop_shared'
 require 'rack/test'
 require 'simplecov'
 
-SimpleCov.start
-
-class Socket
-  def self.gethostname
-    'bird.example.com'
-  end
+SimpleCov.start do
+  command_name "ruby-#{RUBY_VERSION}-#{File.basename(ENV['BUNDLE_GEMFILE'], '.gemfile')}"
 end
 
 case ENV['BUNDLE_GEMFILE']
@@ -18,7 +16,8 @@ when /rails/
   rspec_pattern = 'integration/rails/**/*_spec.rb'
   /(?<appraisal>rails\d{2})\.gemfile/ =~ ENV['BUNDLE_GEMFILE']
   require 'rails'
-  require File.expand_path("../fixtures/#{appraisal}/config/environment.rb",  __FILE__)
+  require 'action_mailer'
+  require File.expand_path("../fixtures/#{appraisal}.rb",  __FILE__)
 when /sinatra/
   rspec_pattern = 'integration/sinatra_spec.rb'
   require 'json'

data/spec/support/gethostname_shared.rb

@@ -0,0 +1,7 @@
+shared_context 'gethostname', with_hostname: true do
+  let(:hostname) { 'bird.example.com' }
+
+  before do
+    allow(Socket).to receive(:gethostname).and_return(hostname)
+  end
+end

data/spec/support/helpers.rb

@@ -9,8 +9,4 @@ module Helpers
   def time_anchor_unix
     BigDecimal.new('1450150205.123')
   end
-
-  def hostname_anchor
-    'bird.example.com'
-  end
 end

data/spec/unit/loga/configuration_spec.rb

@@ -9,23 +9,23 @@ describe Loga::Configuration do
 
   describe 'initialize' do
     let(:framework_exceptions) do
-      %w(
+      %w[
         ActionController::RoutingError
         ActiveRecord::RecordNotFound
         Sinatra::NotFound
-      )
+      ]
     end
 
     before do
       allow(Loga::ServiceVersionStrategies).to receive(:call).and_return('unknown.sha')
     end
 
-    context 'defaults' do
+    context 'defaults', with_hostname: true do
       specify { expect(subject.device).to eq(STDOUT) }
       specify { expect(subject.filter_exceptions).to eq(framework_exceptions) }
       specify { expect(subject.filter_parameters).to eq([]) }
       specify { expect(subject.format).to eq(:simple) }
-      specify { expect(subject.host).to eq(hostname_anchor) }
+      specify { expect(subject.host).to eq(hostname) }
       specify { expect(subject.level).to eq(:info) }
       specify { expect(subject.service_name).to eq('hello_world_app') }
       specify { expect(subject.service_version).to eq('unknown.sha') }

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

@@ -109,7 +109,7 @@ describe Loga::Formatters::GELFFormatter do
       end
 
       context 'when the Event has an exception' do
-        let(:backtrace) { %w(a b) }
+        let(:backtrace) { %w[a b] }
         let(:exception) do
           StandardError.new('Foo Error').tap { |e| e.set_backtrace backtrace }
         end

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

@@ -54,7 +54,7 @@ describe Loga::Formatters::SimpleFormatter do
       end
 
       context 'when the Event has an exception' do
-        let(:backtrace) { %w(a b) }
+        let(:backtrace) { %w[a b] }
         let(:exception) do
           StandardError.new('Foo Error').tap { |e| e.set_backtrace backtrace }
         end
@@ -97,7 +97,7 @@ describe Loga::Formatters::SimpleFormatter do
     end
 
     context 'when tags are available' do
-      let(:tags) { %w(USER_54321 EmailWorker) }
+      let(:tags) { %w[USER_54321 EmailWorker] }
 
       before do
         allow_any_instance_of(described_class).to receive(:current_tags).and_return(tags)

data/spec/unit/loga/log_subscribers/action_mailer_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'active_support'
+require 'loga/log_subscribers/action_mailer'
+
+RSpec.describe Loga::LogSubscribers::ActionMailer do
+  subject(:mailer) { described_class.new }
+
+  let(:event) do
+    double('event', payload: payload, duration: 0.0001, time: Time.now)
+  end
+
+  before do
+    Loga.reset
+
+    Loga.configure(service_name: 'hello_world_app')
+  end
+
+  describe '#deliver' do
+    context 'when an email is sent' do
+      let(:payload) do
+        {
+          mailer: 'FakeMailer',
+          to:     ['user@example.com'],
+        }
+      end
+
+      it 'logs an info message' do
+        expect(Loga.logger).to receive(:info).with(kind_of(Loga::Event))
+
+        mailer.deliver(event)
+      end
+    end
+  end
+
+  describe '#process' do
+    context 'when an email is sent' do
+      let(:payload) do
+        {
+          mailer: 'FakeMailer',
+          action: 'hello_world',
+        }
+      end
+
+      it 'logs an info message' do
+        expect(Loga.logger).to receive(:debug).with(kind_of(Loga::Event))
+
+        mailer.process(event)
+      end
+    end
+  end
+
+  describe '#receive' do
+    context 'when an email is sent' do
+      let(:payload) do
+        {
+          mailer:  'FakeMailer',
+          from:    'loremipsum@example.com',
+          subject: 'Lorem ipsum',
+        }
+      end
+
+      it 'logs an info message' do
+        expect(Loga.logger).to receive(:info).with(kind_of(Loga::Event))
+
+        mailer.receive(event)
+      end
+    end
+  end
+end