在 Rails 中测试 Rake：在测试中消除了多个错误引发

Question

我有一个 rake 任务，可以根据环境防范危险的 Rails rake rasks。它工作正常。当我在 RSpec 中测试每个单独的危险方法时，测试通过了。当我连续测试多个环境时，对于多个环境，测试在第一个之后失败。即使我为同一个危险动作多次运行测试，例如rake db:setup，它也只会通过第一次。如果我将测试作为单独的 it 语句运行，每个危险动作一个，只有前两个会通过（有 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

你有没有尝试传入具体的错误？：

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

Answer 2

看起来两个任务不能指向 enhancement 的同一个任务，所以可能在运行时存在冲突。所以试试block的方法来处理。

class InvalidTaskError < StandardError; end
%w[ db:setup db:reset ].each do |task|
  Rake::Task[task].enhance do
    unless Rails.env == 'development'
      raise InvalidTaskError
    end
  end
end

在规范文件中，以下修改将创建两个示例以正确跟踪规范。

# require 'rails_helper'
require 'spec_helper'
require 'rake'
load 'Rakefile'

describe 'dangerous_tasks' do
  context 'given a production environment' do
    %w[ db:setup db:reset ].each do |task_name|
      it "prevents dangerous tasks #{task_name}" do
        allow(Rails).to receive(:env).and_return('production')
        expect { Rake::Task[task_name].invoke }.to raise_error(InvalidTaskError)
      end
    end
  end
end

Answer 3

我可以考虑两种解决方案。

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

问题的根源

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

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' 的文档，它指出：

如果需要，则调用该任务。

一旦任务被执行，它就不能被再次调用（除非我们重新启用它）。

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

我们在任务数组中的所有任务之前运行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 作为一个动作进行扩展，每次父任务运行时都会执行该动作。

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

%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 时，动作会自动重新启用。

注意你可以在这里找到这个项目的工作示例：https://github.com/dimakura/stackoverflow-projects/tree/master/31821220-testing-rake