ruby-on-rails - 在 Rails 中测试 Rake : Multiple Error Raises Silenced In Test

Question

我有一个 rake 任务，可以根据环境防范危险的 Rails rake rasks。它工作正常。当我在 RSpec 中测试每个单独的危险方法时，测试通过了。当我连续测试多个环境时，对于多个环境，测试在第一个之后失败。即使我为同一个危险 Action 多次运行测试，rake db:setup例如，它只会通过第一次。如果我以个人身份运行测试 it语句，每个危险 Action 一个，只有前两个会通过(有 4 个)。

如何让 RSpec 在这里正常运行，并在套件中运行时通过所有测试？

rake 任务

# guard_dangerous_tasks.rake
class InvalidTaskError < StandardError; end
task :guard_dangerous_tasks => :environment do
  unless Rails.env == 'development'
    raise InvalidTaskError
  end
end

%w[ db:setup db:reset ].each do |task|
  Rake::Task[task].enhance ['guard_dangerous_tasks']
end

RSpec 测试

require 'spec_helper'
require 'rake'
load 'Rakefile'

describe 'dangerous_tasks' do
  context 'given a production environment' do
    it 'prevents dangerous tasks' do
      allow(Rails).to receive(:env).and_return('production')

      %w[ db:setup db:reset ].each do |task_name|
        expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
      end
    end
  end

  context 'given a test environment' do
    it 'prevents dangerous tasks' do
      allow(Rails).to receive(:env).and_return('test')

      %w[ db:setup db:reset ].each do |task_name|
        expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
      end
    end
  end
end

RSpec 输出

# we know the guard task did its job,
# because the rake task didn't actually run.
Failure/Error: expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
   expected InvalidTaskError but nothing was raised

Answer 1

我可以考虑两种解决您问题的方法。

但首先我们需要找出问题的根源在哪里。

问题的根源

让我们从您的代码中的一行开始:

Rake::Task[task].enhance ['guard_dangerous_tasks']

与 Rake::Task的源代码对比

# File rake/task.rb, line 96
def enhance(deps=nil, &block)
  @prerequisites |= deps if deps
  @actions << block if block_given?
  self
end

你可以看到， guard_dangerous_tasks应添加到 @prerequisites大批。可以很容易地检查:

p Rake::Task['db:reset'].prerequisites # => ["environment", "load_config", "guard_dangerous_tasks"]

继续你的源代码。

您使用 invoke执行任务。如果我们密切关注 invoke 's' 的文档，它指出:

Invoke the task if it is needed.

一旦执行了任务，就不能再次调用它(除非我们重新启用它)。

但是为什么这会是一个问题呢？我们正在执行不同的任务，不是吗？但实际上我们没有!

我们运行 guard_dangerous_tasks在我们的任务数组中的所有任务之前!它只执行一次。

解决方案＃1不是最好的

一旦我们知道我们的问题在哪里，我们就可以考虑一个(不是最好的解决方案)。

让我们重新启用 guard_dangerous_tasks每次迭代后:

dangerous_task = Rake::Task['guard_dangerous_tasks']
%w[ db:setup db:reset ].each do |task_name|
  expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
  dangerous_task.reenable
end

解决方案 #2 guard_dangerous_tasks不是先决条件

如果我们意识到 guard_dangerous_tasks，我们可以更好地解决我们的问题。不应该是先决条件!先决条件应该是“准备”阶段并且只执行一次。但我们永远不应该对危险视而不见!

这就是为什么我们应该使用 guard_dangerous_tasks 进行扩展。作为一个 Action ，每次父任务运行时都会执行。

根据 Rake::Task的源代码(见上文)如果我们希望将其作为操作添加，我们应该在一个 block 中传递我们的逻辑。

%w[ db:setup db:reset ].each do |task|
  Rake::Task[task].enhance do
    Rake::Task['guard_dangerous_tasks'].execute
  end
end

我们现在可以保持我们的测试不变并且它通过了:

%w[ db:setup db:reset ].each do |task_name|
  expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
end

但离开 invoke是新问题的入场券。最好换成 execute :

%w[ db:setup db:reset ].each do |task_name|
  expect { Rake::Task[task_name].execute }.to raise_error(InvalidTaskError)
end

小心 invoke !

我们在上面说过，使用 invoke是新问题的入场券。什么样的问题？

让我们尝试为 test 测试我们的代码。和 production环境。如果我们将测试包装在这个循环中:

['production','test'].each do |env_name|
  env = ActiveSupport::StringInquirer.new(env_name)
  allow(Rails).to receive(:env).and_return(env)

  %w[ db:setup db:reset ].each do |task_name|
    expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
  end
end

我们的测试将因原始原因而失败。您可以通过更换线路轻松解决此问题

expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)

和

expect { Rake::Task[task_name].execute }.to raise_error(InvalidTaskError)

那么原因是什么？你可能已经猜到了。

在失败的测试中，我们两次调用了相同的两个任务。他们第一次被处决。第二次应该在调用执行之前重新启用它们。当我们使用 execute , Action 会自动重新启用。

备注 您可以在此处找到该项目的工作示例: https://github.com/dimakura/stackoverflow-projects/tree/master/31821220-testing-rake