lograge 0.3.0 → 0.3.1

data/spec/lograge_logsubscriber_spec.rb

@@ -1,261 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-require 'lograge/log_subscriber'
-require 'active_support/notifications'
-require 'active_support/core_ext/string'
-require 'logger'
-
-describe Lograge::RequestLogSubscriber do
-  let(:log_output) {StringIO.new}
-  let(:logger) {
-    Logger.new(log_output).tap {|logger| logger.formatter = ->(_, _, _, msg) { msg } }
-  }
-
-  let(:subscriber) {Lograge::RequestLogSubscriber.new}
-  let(:event) {
-    ActiveSupport::Notifications::Event.new(
-      'process_action.action_controller', Time.now, Time.now, 2, {
-        status: 200, format: 'application/json', method: 'GET', path: '/home?foo=bar', params: {
-          'controller' => 'home', 'action' => 'index', 'foo' => 'bar'
-        }, db_runtime: 0.02, view_runtime: 0.01
-      }
-    )
-  }
-  let(:redirect) {
-    ActiveSupport::Notifications::Event.new(
-      'redirect_to.action_controller', Time.now, Time.now, 1, location: 'http://example.com', status: 302
-    )
-  }
-
-  before { Lograge.logger = logger }
-
-  describe "with custom_options configured for cee output" do
-    before do
-      Lograge::formatter = ->(data) { "My test: #{data}" }
-    end
-
-    it "should combine the hash properly for the output" do
-      Lograge.custom_options = {:data => "value"}
-      subscriber.process_action(event)
-      log_output.string.should =~ /^My test: {.*:data=>"value"/
-    end
-    it "should combine the output of a lambda properly" do
-      Lograge.custom_options = lambda {|event| {:data => "value"}}
-      subscriber.process_action(event)
-      log_output.string.should =~ /^My test: {.*:data=>"value"/
-    end
-    it "should work if the method returns nil" do
-      Lograge.custom_options = lambda {|event| nil}
-      subscriber.process_action(event)
-      log_output.string.should be_present
-    end
-  end
-
-  describe "when processing a redirect" do
-    it "should store the location in a thread local variable" do
-      subscriber.redirect_to(redirect)
-      Thread.current[:lograge_location].should == "http://example.com"
-    end
-  end
-
-  describe "when processing an action with lograge output" do
-    before do
-      Lograge.formatter = Lograge::Formatters::KeyValue.new
-    end
-
-    it "should include the URL in the log output" do
-      subscriber.process_action(event)
-      log_output.string.should include('/home')
-    end
-
-    it "should not include the query string in the url" do
-      subscriber.process_action(event)
-      log_output.string.should_not include('?foo=bar')
-    end
-
-    it "should start the log line with the HTTP method" do
-      subscriber.process_action(event)
-      log_output.string.starts_with?('method=GET ').should == true
-    end
-
-    it "should include the status code" do
-      subscriber.process_action(event)
-      log_output.string.should include('status=200 ')
-    end
-
-    it "should include the controller and action" do
-      subscriber.process_action(event)
-      log_output.string.should include('controller=home action=index')
-    end
-
-    it "should include the duration" do
-      subscriber.process_action(event)
-      log_output.string.should =~ /duration=[\.0-9]{4,4} /
-    end
-
-    it "should include the view rendering time" do
-      subscriber.process_action(event)
-      log_output.string.should =~ /view=0.01 /
-    end
-
-    it "should include the database rendering time" do
-      subscriber.process_action(event)
-      log_output.string.should =~ /db=0.02/
-    end
-
-    it "should add a 500 status when an exception occurred" do
-      event.payload[:status] = nil
-      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
-      subscriber.process_action(event)
-      log_output.string.should =~ /status=500 /
-      log_output.string.should =~ /error='AbstractController::ActionNotFound:Route not found' /
-    end
-
-    it "should return an unknown status when no status or exception is found" do
-      event.payload[:status] = nil
-      event.payload[:exception] = nil
-      subscriber.process_action(event)
-      log_output.string.should =~ /status=0 /
-    end
-
-    describe "with a redirect" do
-      before do
-        Thread.current[:lograge_location] = "http://www.example.com"
-      end
-
-      it "should add the location to the log line" do
-        subscriber.process_action(event)
-        log_output.string.should =~ %r{ location=http://www.example.com}
-      end
-
-      it "should remove the thread local variable" do
-        subscriber.process_action(event)
-        Thread.current[:lograge_location].should == nil
-      end
-    end
-
-    it "should not include a location by default" do
-      subscriber.process_action(event)
-      log_output.string.should_not =~ /location=/
-    end
-  end
-
-  describe "with custom_options configured for lograge output" do
-    before do
-      Lograge.formatter = Lograge::Formatters::KeyValue.new
-    end
-
-    it "should combine the hash properly for the output" do
-      Lograge.custom_options = {:data => "value"}
-      subscriber.process_action(event)
-      log_output.string.should =~ / data=value/
-    end
-    it "should combine the output of a lambda properly" do
-      Lograge.custom_options = lambda {|event| {:data => "value"}}
-      subscriber.process_action(event)
-      log_output.string.should =~ / data=value/
-    end
-    it "should work if the method returns nil" do
-      Lograge.custom_options = lambda {|event| nil}
-      subscriber.process_action(event)
-      log_output.string.should be_present
-    end
-  end
-
-  describe "with before_format configured for lograge output" do
-    before do
-      Lograge.formatter = Lograge::Formatters::KeyValue.new
-      Lograge.before_format = nil
-    end
-
-    it "should output correctly" do
-      Lograge.before_format = lambda { |data, payload|
-        Hash[*data.first].merge(Hash[*payload.first])
-      }
-      subscriber.process_action(event)
-      log_output.string.should include("method=GET")
-      log_output.string.should include("status=200")
-    end
-    it "should work if the method returns nil" do
-      Lograge.before_format = lambda {|data, payload| nil}
-      subscriber.process_action(event)
-      log_output.string.should be_present
-    end
-  end
-
-  describe "with ignore configured" do
-    before do
-      # Lograge::log_format = :lograge
-      Lograge::ignore_nothing # clear the old ignores before each test
-    end
-
-    it "should not log ignored controller actions given a single ignored action" do
-      Lograge.ignore_actions 'home#index'
-      subscriber.process_action(event)
-      log_output.string.should  be_blank
-    end
-
-    it "should not log ignored controller actions given a single ignored action after a custom ignore" do
-      Lograge.ignore(lambda {|event| false})
-      Lograge.ignore_actions 'home#index'
-      subscriber.process_action(event)
-      log_output.string.should be_blank
-    end
-
-    it "should log non-ignored controller actions given a single ignored action" do
-      Lograge.ignore_actions 'foo#bar'
-      subscriber.process_action(event)
-      log_output.string.should_not be_blank
-    end
-
-    it "should not log ignored controller actions given multiple ignored actions" do
-      Lograge.ignore_actions ['foo#bar', 'home#index', 'bar#foo']
-      subscriber.process_action(event)
-      log_output.string.should be_blank
-    end
-
-    it "should log non-ignored controller actions given multiple ignored actions" do
-      Lograge.ignore_actions ['foo#bar', 'bar#foo']
-      subscriber.process_action(event)
-      log_output.string.should_not be_blank
-    end
-
-    it "should not log ignored events" do
-      Lograge.ignore(lambda do |event|
-        'GET' == event.payload[:method]
-      end)
-      subscriber.process_action(event)
-      log_output.string.should be_blank
-    end
-
-    it "should log non-ignored events" do
-      Lograge.ignore(lambda do |event|
-        'foo' == event.payload[:method]
-      end)
-      subscriber.process_action(event)
-      log_output.string.should_not be_blank
-    end
-
-    it "should not choke on nil ignore_actions input" do
-      Lograge.ignore_actions nil
-      subscriber.process_action(event)
-      log_output.string.should_not be_blank
-    end
-
-    it "should not choke on nil ignore input" do
-      Lograge.ignore nil
-      subscriber.process_action(event)
-      log_output.string.should_not be_blank
-    end
-  end
-
-  it "should fallback to ActiveSupport's logger if one isn't configured" do
-    Lograge.formatter = Lograge::Formatters::KeyValue.new
-    Lograge.logger = nil
-    ActiveSupport::LogSubscriber.logger = logger
-
-    subscriber.process_action(event)
-
-    log_output.string.should be_present
-  end
-end

data/spec/lograge_spec.rb

@@ -1,84 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-require 'active_support/notifications'
-require 'active_support/core_ext/string'
-require 'active_support/log_subscriber'
-require 'action_controller/log_subscriber'
-require 'action_view/log_subscriber'
-
-describe Lograge do
-  describe "when removing Rails' log subscribers" do
-    after do
-      ActionController::LogSubscriber.attach_to :action_controller
-      ActionView::LogSubscriber.attach_to :action_view
-    end
-
-    it "should remove subscribers for controller events" do
-      expect {
-        Lograge.remove_existing_log_subscriptions
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
-      }
-    end
-
-    it "should remove subscribers for all events" do
-      expect {
-        Lograge.remove_existing_log_subscriptions
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
-      }
-    end
-
-    it "shouldn't remove subscribers that aren't from Rails" do
-      blk = -> {}
-      ActiveSupport::Notifications.subscribe("process_action.action_controller", &blk)
-      Lograge.remove_existing_log_subscriptions
-      listeners = ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
-      listeners.size.should > 0
-    end
-  end
-
-  describe 'deprecated log_format interpreter' do
-    let(:app_config) do
-      double(config:
-        ActiveSupport::OrderedOptions.new.tap do |config|
-          config.action_dispatch = double(rack_cache: false)
-          config.lograge = ActiveSupport::OrderedOptions.new
-          config.lograge.log_format = format
-        end
-      )
-    end
-    before { ActiveSupport::Deprecation.silence { Lograge.setup(app_config) } }
-    subject { Lograge.formatter }
-
-    context ':cee' do
-      let(:format) { :cee }
-      it { should be_instance_of(Lograge::Formatters::Cee) }
-    end
-
-    context ':raw' do
-      let(:format) { :raw }
-      it { should be_instance_of(Lograge::Formatters::Raw) }
-    end
-
-    context ':logstash' do
-      let(:format) { :logstash }
-      it { should be_instance_of(Lograge::Formatters::Logstash) }
-    end
-
-    context ':graylog2' do
-      let(:format) { :graylog2 }
-      it { should be_instance_of(Lograge::Formatters::Graylog2) }
-    end
-
-    context ':lograge' do
-      let(:format) { :lograge }
-      it { should be_instance_of(Lograge::Formatters::KeyValue) }
-    end
-
-    context 'default' do
-      let(:format) { nil }
-      it { should be_instance_of(Lograge::Formatters::KeyValue) }
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,14 +0,0 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper.rb"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-require 'action_pack'
-require 'support/examples'
-
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-end

data/spec/support/examples.rb

@@ -1,20 +0,0 @@
-
-shared_examples_for "a key value formatter" do
-  let(:payload) do
-    {
-      custom: 'data',
-      status: 200,
-      method: 'GET',
-      path: '/',
-      controller: 'welcome',
-      action: 'index'
-    }
-  end
-
-  subject { described_class.new.call(payload) }
-
-  it { should include('method=GET') }
-  it { should include('path=/') }
-  it { should include('status=200') }
-  it { should include('custom=data') }
-end