Module: Lumberjack::CaptureDevice::RSpec

Defined in:
lib/lumberjack/capture_device/rspec.rb

Overview

RSpec helper methods for working with CaptureDevice.

Instance Method Summary collapse

Instance Method Details

#capture_logger(logger, write_to_original: true) {|device| ... } ⇒ Lumberjack::CaptureDevice

Capture log entries from a logger within a block. This method temporarily replaces the logger's device with a CaptureDevice and sets the log level to debug. The logger's formatters remain active, so captured entries contain the same formatted values that would have been logged.

Examples:

logs = capture_logger(Rails.logger) do
  Rails.logger.info("Test message")
end
expect(logs).to include_log_entry(severity: :info, message: "Test message")

Parameters:

  • logger (Lumberjack::Logger) —

    The logger to capture entries from.

Yields:

  • (device) —

    The block to execute while capturing log entries.

Yield Parameters:

Returns:



39
40
41
 
# File 'lib/lumberjack/capture_device/rspec.rb', line 39

def capture_logger(logger, write_to_original: true, &block)
  Lumberjack::CaptureDevice.capture(logger, write_to_original: write_to_original, &block)
end

#capture_logger_around_example(logger, example) ⇒ Object

RSpec around hook to automatically capture logs for each example. The captured logs are only written to the original logger if the example fails. This helps keep the logs more usable for debugging test failures since it removes all the noise from passing tests.

This is designed for CI environments where you can save the logs as artifacts of the test run.

Examples:

Capture logs for a Rails application

# In your spec_helper.rb or rails_helper.rb
RSpec.configure do |config|
  config.around do |example|
    capture_logger_around_example(Rails.logger, example)
  end
end

Parameters:

  • logger (Lumberjack::Logger) —

    The logger to capture entries for.

  • example (RSpec::Core::Example) —

    The current RSpec example.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/lumberjack/capture_device/rspec.rb', line 59

def capture_logger_around_example(logger, example)
  capture_logger(logger, write_to_original: false) do |captured_device|
    example.run

    if example.exception
      rspec_attributes = {rspec: {location: example.location, description: example.metadata[:description]}}
      captured_device.write_to_underlying_device(attributes: rspec_attributes)
    end
  end
end

#include_log_entry(expected_hash) ⇒ Lumberjack::CaptureDevice::IncludeLogEntryMatcher

Create a matcher for checking if a log entry is included in the captured logs. This matcher provides better error messages than using the include? method directly.

Examples:

expect(logs).to include_log_entry(severity: :info, message: "User logged in")
expect(logs).to include_log_entry(message: /error/i, attributes: {user_id: 123})

Parameters:

  • expected_hash (Hash) —

    The expected log entry attributes to match.

Options Hash (expected_hash):

  • :severity (String, Symbol, Integer) —

    The expected log severity.

  • :message (String, Regexp) —

    The expected message content.

  • :attributes (Hash) —

    Expected log entry attributes.

  • :progname (String) —

    Expected program name.

Returns:



21
22
23
 
# File 'lib/lumberjack/capture_device/rspec.rb', line 21

def include_log_entry(expected_hash)
  Lumberjack::CaptureDevice::IncludeLogEntryMatcher.new(expected_hash)
end