如何从 Rake 任务中提早返回？

Question

我有一个 rake 任务，我在开始时进行一些检查，如果其中一项检查失败，我想尽早从 rake 任务返回，我不想执行任何剩余的代码。

我认为解决方案是将返回放在我想从代码返回的位置，但出现以下错误

unexpected return

Answer 1

Rake 任务基本上是一个块。除 lambda 之外的块不支持 return，但您可以使用 next 跳到下一条语句，这在 rake 任务中与在方法中使用 return 具有相同的效果。

task :foo do
  puts "printed"
  next
  puts "never printed"
end

或者您可以将代码移动到方法中并在方法中使用 return 。

task :foo do
  do_something
end

def do_something
  puts "startd"
  return
  puts "end"
end

我更喜欢第二个选择。

Answer 2

您可以在任务内部使用 abort(message) 来通过消息中止该任务。

Answer 3

返回错误 ❌

如果您返回错误（即退出代码为1），您将需要使用abort，它还采用一个可选的字符串参数，该参数将在退出时输出：

task :check do
  
  # If any of your checks fail, you can exit early like this.
  abort( "One of the checks has failed!" ) if check_failed?

end

在命令行上：

$ rake check && echo "All good"
#=> One of the checks has failed!

---

成功返回✅

如果您没有返回错误（即退出代码 0），您需要使用 exit，但不一个字符串参数。

task :check do
  
  # If any of your checks fail, you can exit early like this.
  exit if check_failed?
  
end

在命令行上：

$ rake check && echo "All good"
#=> All good

如果您在 cron 作业中使用它，或者需要在之后根据 rake 任务是否成功执行某些操作，那么这一点很重要。

---

奖励：从没有堆栈跟踪的 rescue 块中返回错误。

默认情况下，如果您在 rescue 块内使用 abort，它将输出整个堆栈跟踪，即使您只使用 abort 而不重新执行- 引发错误。

为了解决这个问题，您可以向 exit 命令提供非零退出代码，例如：

task :check do

  begin
    do_the_thing_that_raises_an_exception
  rescue => error
    puts error.message
 
    exit( 1 )
  end

end

Answer 4

我倾向于使用 abort 在这种情况下这是一个更好的选择，例如：

task :foo do
  something = false
  abort 'Failed to proceed' unless something
end

Answer 5

如果您需要突破多个块级别，可以使用fail 。

例如

task :something do
  [1,2,3].each do |i|
    ...
    fail "some error" if ...
  end
end

（请参阅https://stackoverflow.com/a/3753955/11543。）

Answer 6

如果您的意思是退出 rake 任务而不导致“rake 中止！”要打印消息，那么您可以使用“abort”或“exit”。但是，当在救援块中使用“abort”时，会终止任务并打印整个错误（即使不使用 --trace）。所以我用的是“退出”。

Answer 7

我使用了 Simone Carletti 建议的 next 方法，因为在测试 rake 任务时，abort（实际上只是 exit 的包装器）不是期望的行为。

例子：

task auto_invoice: :environment do
  if Application.feature_disabled?(:auto_invoice)
    $stderr.puts 'Feature is disabled, aborting.'
  next
end