RSpec:如何测试Rails记录器的消息期望值? [英] RSpec: how to test Rails logger message expectations?

问题描述

我正在尝试测试Rails记录器是否收到某些规范中的消息.我正在使用记录gem .

I am trying to test that the Rails logger receives messages in some of my specs. I am using the Logging gem.

让我们说我有一个这样的课程:

Let's say that I have a class like this:

class BaseWorker

  def execute
    logger.info 'Starting the worker...'
  end

end

以及类似的规范:

describe BaseWorker do

  it 'should log an info message' do
    base_worker = BaseWorker.new
    logger_mock = double('Logging::Rails').as_null_object
    Logging::Rails.stub_chain(:logger, :info).and_return(logger_mock)

    logger_mock.should_receive(:info).with('Starting the worker...')
    base_worker.execute
    Logging::Rails.unstub(:logger)
  end

end

我收到以下失败消息:

 Failure/Error: logger_mock.should_receive(:info).with('Starting worker...')
   (Double "Logging::Rails").info("Starting worker...")
       expected: 1 time
       received: 0 times

我已经尝试了几种不同的方法来使规范通过.例如:

I've tried out several different approaches to get the spec to pass. This works for example:

class BaseWorker

  attr_accessor :log

  def initialize
    @log = logger
  end

  def execute
    @log.info 'Starting the worker...'
  end

end

describe BaseWorker do
  it 'should log an info message' do
    base_worker = BaseWorker.new
    logger_mock = double('logger')
    base_worker.log = logger_mock

    logger_mock.should_receive(:info).with('Starting the worker...')
    base_worker.execute
  end
end

但是必须设置一个这样的可访问实例变量，好像尾巴在这里摇晃着狗. (实际上，我什至不知道为什么将记录器复制到@log会通过).

But having to setup an accessible instance variable like that seems like the tail is wagging the dog here. (Actually, I'm not even sure why copying logger to @log would make it pass.)

什么是测试日志记录的好的解决方案?

What's a good solution for testing the logging?

推荐答案

虽然我同意您通常不希望测试记录器，但有时它可能会有用.

While I agree you generally don't want to test loggers, there are times it may be useful.

我对Rails.logger抱有期望.

使用RSpec弃用的should语法:

Using RSpec's deprecated should syntax:

Rails.logger.should_receive(:info).with("some message")

使用RSpec的更新的expect语法:

Using RSpec's newer expect syntax:

expect(Rails.logger).to receive(:info).with("some message")

注意:在控制器和型号规格中，您必须在记录消息之前之前放置这行.如果放在后面，您会收到如下错误消息:

Note: In controller and model specs, you have to put this line before the message is logged. If you put it after, you'll get an error message like this:

Failure/Error: expect(Rails.logger).to receive(:info).with("some message")
       (#<ActiveSupport::Logger:0x007f27f72136c8>).info("some message")
           expected: 1 time with arguments: ("some message")
           received: 0 times

这篇关于RSpec:如何测试Rails记录器的消息期望值?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！