在Rails中测试Rake:在测试中出现多个错误

Question

我有一个rake任务,根据环境防范危险的R​​ails rake rasks.它工作正常.当我在RSpec中测试每个单独的危险方法时,测试通过.当我连续测试多个时,对于多个环境,测试在第一个测试后失败.例如,即使我为同一危险动作多次运行测试rake db:setup,它也只会在第一次通过.如果我将测试作为单独的it语句运行,每个危险操作一个,只有前两个将通过(有4个).

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

耙子任务

# 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'文档,它会说:

如果需要,调用任务.

执行任务后,无法再次调用该任务(除非我们重新启用它).

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

我们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)

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

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

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