我想在 Bash 脚本中引发错误，并显示消息"测试用例失败!!"。如何在 Bash 中执行此操作？

例如：

if [ condition ]; then
raise error "Test cases failed !!!"
fi

这取决于您希望将错误消息存储在何处。

您可以执行以下操作：

echo "Error!" > logfile.log
exit 125

或以下：

echo "Error!" 1>&2
exit 64

引发异常时，将停止程序的执行。

您还可以使用类似exit xxx其中xxx是您可能希望返回到操作系统的错误代码(从 0 到 255)。在这里，125和64只是您可以退出的随机代码。当您需要向操作系统指示程序异常停止(例如发生错误)时，您需要将非零退出代码传递给exit。

正如@chepner指出的，您可以执行exit 1，这将意味着一个未指定的错误。

基本错误处理

如果您的测试用例运行器为失败的测试返回非零代码，您只需编写：

test_handler test_case_x; test_result=$?
if ((test_result != 0)); then
printf '%sn' "Test case x failed" >&2  # write error message to stderr
exit 1                                  # or exit $test_result
fi

甚至更短：

if ! test_handler test_case_x; then
printf '%sn' "Test case x failed" >&2
exit 1
fi

或最短的：

test_handler test_case_x || { printf '%sn' "Test case x failed" >&2; exit 1; }

要使用test_handler的退出代码退出：

test_handler test_case_x || { ec=$?; printf '%sn' "Test case x failed" >&2; exit $ec; }

高级错误处理

如果要采用更全面的方法，可以使用错误处理程序：

exit_if_error() {
local exit_code=$1
shift
[[ $exit_code ]] &&               # do nothing if no error code passed
((exit_code != 0)) && {         # do nothing if error code is 0
printf 'ERROR: %sn' "$@" >&2 # we can use better logging here
exit "$exit_code"             # we could also check to make sure
# error code is numeric when passed
}
}

然后在运行测试用例后调用它：

run_test_case test_case_x
exit_if_error $? "Test case x failed"

或

run_test_case test_case_x || exit_if_error $? "Test case x failed"

拥有像exit_if_error这样的错误处理程序的优点是：

我们可以在一个地方标准化所有错误处理逻辑，例如日志记录、打印堆栈跟踪、通知、执行清理等
处理程序获取错误代码作为参数，我们可以使调用者免于测试错误退出代码的if块的混乱
如果我们有一个信号处理程序(使用 trap)，我们可以从那里调用错误处理程序

错误处理和日志记录库

以下是错误处理和日志记录的完整实现：

https://github.com/codeforester/base/blob/master/lib/stdlib.sh

Bash 中的错误处理
Bash Hackers Wiki上的"caller"内置命令
Linux 中是否有任何标准的退出状态代码？
BashFAQ/105 - 为什么设置 -e(或设置 -o errexit，或陷阱 ERR)不做我期望的？
相当于__FILE__，__LINE__在Bash中
Bash 中有 TRY CATCH 命令吗
要将堆栈跟踪添加到错误处理程序，您可能需要查看这篇文章：由 Bash 脚本调用的已执行程序的跟踪
忽略 shell 脚本中的特定错误
捕获壳体管道中的错误代码
如何在 shell 脚本中管理日志详细程度？
如何在 Bash 中记录函数名称和行号？
在 Bash 中，双方括号 [[ ]] 是否比单方括号 [ ] 更可取？

还有几种方法可以解决此问题。假设您的要求之一是运行包含几个 shell 命令的 shell 脚本/函数，并检查脚本是否成功运行并在失败时抛出错误。

中的 shell 命令通常依赖于返回的退出代码，让 shell 知道它是由于某些意外事件而成功还是失败。

所以你想做的属于这两个类别

出错时退出
出错时退出和清理

根据您要执行的操作，可以使用 shell 选项。对于第一种情况，shell 提供了一个带有set -e的选项，对于第二种情况，您可以对EXIT执行trap

我应该在我的脚本/函数中使用`exit`吗？

使用exit通常会增强可读性在某些例程中，一旦知道答案，您希望立即退出调用例程。如果例程的定义方式在检测到错误后不需要任何进一步的清理，则不立即退出意味着必须编写更多代码。

因此，如果需要对脚本执行清理操作以使脚本的终止干净，最好不要使用exit。

我应该使用`set -e`在退出时出错吗？

不！

set -e尝试向shell添加"自动错误检测"。它的目标是在发生错误时使 shell 中止，但它有很多潜在的陷阱，例如，

作为 if 测试一部分的命令是免疫的。在示例中，如果您希望它在test检查不存在的目录时中断，则不会，它会进入 else 条件
```
set -e
f() { test -d nosuchdir && echo no dir; }
f
echo survived
```
管道中除上一个命令外的命令是免疫的。在下面的示例中，因为最近执行(最右边)命令的退出代码被认为是 (cat) 并且它成功了。这可以通过set -o pipefail选项进行设置来避免，但它仍然是一个警告。
```
set -e
somecommand that fails | cat -
echo survived 
```

建议使用 - 退出时`trap`

结论是，如果您希望能够处理错误而不是盲目退出，而不是使用set -e，请在伪信号上使用ERRtrap。

ERR陷阱不是在 shell 本身以非零错误代码退出时运行代码，而是当该 shell 运行的任何不属于条件的命令(如 ifcmd或cmd ||)以非零退出状态退出时。

一般的做法是，我们定义一个陷阱处理程序，以提供有关哪一行以及导致退出的原因的其他调试信息。请记住，导致ERR信号的最后一个命令的退出代码此时仍然可用。

cleanup() {
exitcode=$?
printf 'error condition hitn' 1>&2
printf 'exit code returned: %sn' "$exitcode"
printf 'the command executing at the time of the error was: %sn' "$BASH_COMMAND"
printf 'command present on line: %d' "${BASH_LINENO[0]}"
# Some more clean up code can be added here before exiting
exit $exitcode
}

我们只是在失败的脚本之上使用此处理程序，如下所示

trap cleanup ERR

将其放在一个简单的脚本中，其中包含第 15 行的false，您将获得的信息为

error condition hit
exit code returned: 1
the command executing at the time of the error was: false
command present on line: 15

该trap还提供了选项，无论错误如何，都可以在 shell 完成时运行清理(例如，您的 shell 脚本退出)，在信号EXIT时运行清理。您也可以同时捕获多个信号。可以在 trap 上找到要捕获的支持信号列表.1p - Linux 手册页

要注意的另一件事是要了解，如果您正在处理子shell，则提供的方法都不起作用，在这种情况下，您可能需要添加自己的错误处理。

在带有set -e的子外壳上不起作用。false仅限于子外壳，永远不会传播到父外壳。若要在此处执行错误处理，请添加自己的逻辑来执行(false) || false
```
set -e
(false)
echo survived
```
同样的情况也发生在trap身上。由于上述原因，下面的逻辑不起作用。
```
trap 'echo error' ERR
(false)
```

下面是一个简单的陷阱，它打印任何失败的 STDERR 的最后一个参数，报告它失败的行，并以行号作为退出代码退出脚本。请注意，这些并不总是好主意，但这展示了您可以构建的一些创造性应用程序。

trap 'echo >&2 "$_ at $LINENO"; exit $LINENO;' ERR

我把它放在一个带有循环的脚本中来测试它。我只是检查一些随机数的命中率;您可以使用实际测试。如果我需要保释，我会调用 false(这会触发陷阱)并发送我要抛出的消息。

对于详细的功能，让陷阱调用处理函数。如果您需要进行更多清理等，您可以随时在 arg ($_) 上使用案例语句。分配给一个 var 以获得一点语法糖 -

trap 'echo >&2 "$_ at $LINENO"; exit $LINENO;' ERR
throw=false
raise=false
while :
do x=$(( $RANDOM % 10 ))
case "$x" in
0) $throw "DIVISION BY ZERO" ;;
3) $raise "MAGIC NUMBER"     ;;
*) echo got $x               ;;
esac
done

示例输出：

# bash tst
got 2
got 8
DIVISION BY ZERO at 6
# echo $?
6

显然，你可以

runTest1 "Test1 fails" # message not used if it succeeds

设计改进的空间很大。

缺点包括false不漂亮(因此糖)，以及其他使陷阱绊倒的东西可能看起来有点愚蠢。不过，我喜欢这种方法。

您有 2 个选项：将脚本的输出重定向到文件，在脚本中引入日志文件，以及

将输出重定向到文件：

在这里，您假设脚本输出所有必要的信息，包括警告和错误消息。然后，您可以将输出重定向到您选择的文件。

./runTests &> output.log

上述命令将标准输出和错误输出重定向到日志文件。

使用此方法，您不必在脚本中引入日志文件，因此逻辑稍微容易一些。

日志文件引入脚本：

在脚本中添加日志文件，方法是对其进行硬编码：

logFile='./path/to/log/file.log'

或通过参数传递它：

logFile="${1}"  # This assumes the first parameter to the script is the log file

最好将执行时的时间戳添加到脚本顶部的日志文件中：

date '+%Y%-m%d-%H%M%S' >> "${logFile}"

然后，您可以将错误消息重定向到日志文件

if [ condition ]; then
echo "Test cases failed!!" >> "${logFile}"; 
fi

这会将错误追加到日志文件并继续执行。如果要在发生严重错误时停止执行，可以exit脚本：

if [ condition ]; then
echo "Test cases failed!!" >> "${logFile}"; 
# Clean up if needed
exit 1;
fi

请注意，exit 1表示程序由于未指定的错误而停止执行。如果您愿意，可以自定义此设置。

使用此方法，您可以自定义日志，并为脚本的每个组件提供不同的日志文件。

如果你有一个相对较小的脚本，或者想执行别人的脚本而不将其修改为第一种方法更合适。

如果始终希望日志文件位于同一位置，则这是 2 的更好选择。此外，如果您创建了一个包含多个组件的大脚本，那么您可能希望以不同的方式记录每个部分，第二种方法是您唯一的选择。

我经常发现编写一个函数来处理错误消息很有用，这样代码整体上更干净。

# Usage: die [exit_code] [error message]
die() {
local code=$? now=$(date +%T.%N)
if [ "$1" -ge 0 ] 2>/dev/null; then  # assume $1 is an error code if numeric
code="$1"
shift
fi
echo "$0: ERROR at ${now%???}${1:+: $*}" >&2
exit $code
}

这将从上一个命令中获取错误代码，并在退出整个脚本时将其用作默认错误代码。它还记录了时间，支持微秒(GNU 日期的%N是纳秒，我们稍后将其截断为微秒)。

如果第一个选项为零或正整数，则它将成为退出代码，我们将其从选项列表中删除。然后，我们将消息报告给标准错误，包括脚本的名称、单词"ERROR"和时间(我们使用参数扩展将纳秒截断为微秒，或者对于非 GNU 时间，例如截断12:34:56.%N到12:34:56)。在单词 ERROR 之后添加冒号和空格，但仅当提供错误消息时。最后，我们使用先前确定的退出代码退出脚本，正常触发任何陷阱。

一些示例(假设代码存在于script.sh)：

if [ condition ]; then die 123 "condition not met"; fi
# exit code 123, message "script.sh: ERROR at 14:58:01.234564: condition not met"
$command |grep -q condition || die 1 "'$command' lacked 'condition'"
# exit code 1, "script.sh: ERROR at 14:58:55.825626: 'foo' lacked 'condition'"
$command || die
# exit code comes from command's, message "script.sh: ERROR at 14:59:15.575089"

在 Bash 脚本中引发错误

基本错误处理

高级错误处理

错误处理和日志记录库

相关文章

我应该在我的脚本/函数中使用`exit`吗？

我应该使用`set -e`在退出时出错吗？

建议使用 - 退出时`trap`

相关内容

最新更新

热门标签：

在 Bash 脚本中引发错误

基本错误处理

高级错误处理

错误处理和日志记录库

相关文章

我应该在我的脚本/函数中使用exit吗？

我应该使用set -e在退出时出错吗？

建议使用 - 退出时trap

相关内容

最新更新

热门标签：

我应该在我的脚本/函数中使用`exit`吗？

我应该使用`set -e`在退出时出错吗？

建议使用 - 退出时`trap`