如何在 Shell 脚本中跟踪调试命令的执行

Posted Linux开源社区

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何在 Shell 脚本中跟踪调试命令的执行相关的知识，希望对你有一定的参考价值。

本文将解释第三种 shell 脚本调试模式，即 shell 跟踪，并查看一些示例来演示它如何工作以及如何使用它。
-- Aaron Kili

编译自： http://www.tecmint.com/trace-shell-script-execution-in-linux/ 
作者： Aaron Kili
译者： geekpi


在 shell 脚本调试系列[1] 中，本文将解释第三种 shell 脚本调试模式，即 shell 跟踪，并查看一些示例来演示它如何工作以及如何使用它。

本系列的前面部分清晰地阐明了另外两种 shell 脚本调试模式：详细模式和语法检查模式，并用易于理解的例子展示了如何在这些模式下启用 shell 脚本调试。

  1. 如何在 Linux 中启用 Shell 脚本的调试模式[2]

  2. 如何在 Shell 脚本中执行语法检查调试模式[3]

shell 跟踪简单的来说就是跟踪 shell 脚本中的命令的执行。要打开 shell 跟踪，请使用 -x 调试选项。

这会让 shell 在终端上显示所有执行的命令及其参数。

我们将使用下面的 sys_info.sh shell 脚本，它会简要地打印出你的系统日期和时间、登录的用户数和系统的运行时间。不过，脚本中包含我们需要查找和更正的语法错误。

 
   
   
 
    
  
    
    
  
  1. #!/bin/bash
    2. 
  
    
    
  
  2. # script to print brief system info
    3. 
  
    
    
  
  3. ROOT_ID="0"
    4. 
  
    
    
  
  4. DATE=`date`
    5. 
  
    
    
  
  5. NO_USERS=`who | wc -l`
    6. 
  
    
    
  
  6. UPTIME=`uptime`
    7. 
  
    
    
  
  7. check_root(){
    8. 
  
    
    
  
  8.   if [ "$UID" -ne "$ROOT_ID" ]; then
    9. 
  
    
    
  
  9.     echo "You are not allowed to execute this program!"
    10. 
  
    
    
  
  10.     exit 1;    
    11. 
  
    
    
  
  11. }
    12. 
  
    
    
  
  12. print_sys_info(){
    13. 
  
    
    
  
  13.   echo "System Time    : $DATE"
    14. 
  
    
    
  
  14.   echo "Number of users: $NO_USERS"
    15. 
  
    
    
  
  15.   echo "System Uptime  : $UPTIME
    16. 
  
    
    
  
  16. }
    17. 
  
    
    
  
  17. check_root
    18. 
  
    
    
  
  18. print_sys_info
    19. 
  
    
    
  
  19. exit 0
    20.

保存文件并执行脚本。脚本只能用 root 用户运行，因此如下使用 sudo 命令[4]运行：

 
   
   
 
    
  
    
    
  
  1. $ chmod +x sys_info.sh
    2. 
  
    
    
  
  2. $ sudo bash -x sys_info.sh
    3.

如何在 Shell 脚本中跟踪调试命令的执行

shell 跟踪 - 显示脚本中的错误

从上面的输出我们可以观察到，首先执行命令，然后其输出做为一个变量的值。

例如，先执行 date，其输出做为变量 DATE 的值。

我们可以执行语法检查来只显示其中的语法错误，如下所示：

 
   
   
 
    
  
    
    
  
  1. $ sudo bash -n sys_info.sh 
    2.

如何在 Shell 脚本中跟踪调试命令的执行

脚本中语法检查

如果我们审视这个 shell 脚本，我们就会发现 if 语句缺少了封闭条件的 fi 关键字。因此，让我们加上它，新的脚本应该看起来像这样：

 
   
   
 
    
  
    
    
  
  1. #!/bin/bash
    2. 
  
    
    
  
  2. #script to print brief system info
    3. 
  
    
    
  
  3. ROOT_ID="0"
    4. 
  
    
    
  
  4. DATE=`date`
    5. 
  
    
    
  
  5. NO_USERS=`who | wc -l`
    6. 
  
    
    
  
  6. UPTIME=`uptime`
    7. 
  
    
    
  
  7. check_root(){
    8. 
  
    
    
  
  8.   if [ "$UID" -ne "$ROOT_ID" ]; then
    9. 
  
    
    
  
  9.     echo "You are not allowed to execute this program!"
    10. 
  
    
    
  
  10.     exit 1;
    11. 
  
    
    
  
  11.   fi    
    12. 
  
    
    
  
  12. }
    13. 
  
    
    
  
  13. print_sys_info(){
    14. 
  
    
    
  
  14.   echo "System Time    : $DATE" 
    15. 
  
    
    
  
  15.   echo "Number of users: $NO_USERS"
    16. 
  
    
    
  
  16.   echo "System Uptime  : $UPTIME
    17. 
  
    
    
  
  17. }
    18. 
  
    
    
  
  18. check_root
    19. 
  
    
    
  
  19. print_sys_info
    20. 
  
    
    
  
  20. exit 0
    21.

再次保存文件并以 root 执行，同时做语法检查：

 
   
   
 
    
  
    
    
  
  1. $ sudo bash -n sys_info.sh
    2.

如何在 Shell 脚本中跟踪调试命令的执行

在 shell 脚本中执行语法检查

上面的语法检查操作的结果仍然显示在脚本的第 21 行还有一个错误。所以，我们仍然要纠正一些语法。

再一次分析脚本，会发现第 21 行的错误是由于在 print_sys_info 函数内最后一个 echo 命令[5]中没有闭合双引号 "。

我们将在 echo 命令中添加闭合双引号并保存文件。修改过的脚本如下：

 
   
   
 
    
  
    
    
  
  1. #!/bin/bash
    2. 
  
    
    
  
  2. #script to print brief system info
    3. 
  
    
    
  
  3. ROOT_ID="0"
    4. 
  
    
    
  
  4. DATE=`date`
    5. 
  
    
    
  
  5. NO_USERS=`who | wc -l`
    6. 
  
    
    
  
  6. UPTIME=`uptime`
    7. 
  
    
    
  
  7. check_root(){
    8. 
  
    
    
  
  8.   if [ "$UID" -ne "$ROOT_ID" ]; then
    9. 
  
    
    
  
  9.     echo "You are not allowed to execute this program!"
    10. 
  
    
    
  
  10.     exit 1;
    11. 
  
    
    
  
  11.   fi
    12. 
  
    
    
  
  12. }
    13. 
  
    
    
  
  13. print_sys_info(){
    14. 
  
    
    
  
  14.   echo "System Time    : $DATE"
    15. 
  
    
    
  
  15.   echo "Number of users: $NO_USERS"
    16. 
  
    
    
  
  16.   echo "System Uptime  : $UPTIME"
    17. 
  
    
    
  
  17. }
    18. 
  
    
    
  
  18. check_root
    19. 
  
    
    
  
  19. print_sys_info
    20. 
  
    
    
  
  20. exit 0
    21.

现在再一次检查语法。

 
   
   
 
    
  
    
    
  
  1. $ sudo bash -n sys_info.sh
    2.

上面的命令不会产生任何输出，因为我们的脚本语法上正确。我们也可以再次跟踪脚本执行，它应该工作得很好：

 
   
   
 
    
  
    
    
  
  1. $ sudo bash -x sys_info.sh
    2.

如何在 Shell 脚本中跟踪调试命令的执行

跟踪 shell 脚本执行

现在运行脚本。

 
   
   
 
    
  
    
    
  
  1. $ sudo ./sys_info.sh
    2.

如何在 Shell 脚本中跟踪调试命令的执行

用 shell 脚本显示日期、时间和运行时间

shell 跟踪执行的重要性

shell 脚本跟踪可以帮助我们识别语法错误，更重要的是识别逻辑错误。例如，在 sys_info.sh shell 脚本中的 check_root 函数，它用于确定用户是否为 root，因为脚本只允许由超级用户执行。

 
   
   
 
    
  
    
    
  
  1. check_root(){
    2. 
  
    
    
  
  2.   if [ "$UID" -ne "$ROOT_ID" ]; then
    3. 
  
    
    
  
  3.     echo "You are not allowed to execute this program!"
    4. 
  
    
    
  
  4.     exit 1;
    5. 
  
    
    
  
  5.   fi
    6. 
  
    
    
  
  6. }
    7.

这里的魔法是由 if 语句表达式 ["$ UID" -ne "$ ROOT_ID"] 控制的，一旦我们不使用合适的数字运算符（示例中为 -ne，这意味着不相等），我们最终可能会出一个逻辑错误。

假设我们使用 -eq （意思是等于），这将允许任何系统用户以及 root 用户运行脚本，因此是一个逻辑错误。

 
   
   
 
    
  
    
    
  
  1. check_root(){
    2. 
  
    
    
  
  2.   if [ "$UID" -eq "$ROOT_ID" ]; then
    3. 
  
    
    
  
  3.     echo "You are not allowed to execute this program!"
    4. 
  
    
    
  
  4.     exit 1;
    5. 
  
    
    
  
  5.   fi
    6. 
  
    
    
  
  6. }
    7.

注意：我们在本系列开头介绍过，set 这个 shell 内置命令可以在 shell 脚本的特定部分激活调试。

因此，下面的行将帮助我们通过跟踪脚本的执行在其中找到这个逻辑错误：

具有逻辑错误的脚本：

 
   
   
 
    
  
    
    
  
  1. #!/bin/bash
    2. 
  
    
    
  
  2. #script to print brief system info
    3. 
  
    
    
  
  3. ROOT_ID="0"
    4. 
  
    
    
  
  4. DATE=`date`
    5. 
  
    
    
  
  5. NO_USERS=`who | wc -l`
    6. 
  
    
    
  
  6. UPTIME=`uptime`
    7. 
  
    
    
  
  7. check_root(){
    8. 
  
    
    
  
  8.   if [ "$UID" -eq "$ROOT_ID" ]; then
    9. 
  
    
    
  
  9.     echo "You are not allowed to execute this program!"
    10. 
  
    
    
  
  10.     exit 1;
    11. 
  
    
    
  
  11.   fi
    12. 
  
    
    
  
  12. }
    13. 
  
    
    
  
  13. print_sys_info(){
    14. 
  
    
    
  
  14.   echo "System Time    : $DATE"
    15. 
  
    
    
  
  15.   echo "Number of users: $NO_USERS"
    16. 
  
    
    
  
  16.   echo "System Uptime  : $UPTIME"
    17. 
  
    
    
  
  17. }
    18. 
  
    
    
  
  18. #turning on and off debugging of check_root function
    19. 
  
    
    
  
  19. set -x ; check_root;  set +x ;
    20. 
  
    
    
  
  20. print_sys_info
    21. 
  
    
    
  
  21. exit 0
    22.

保存文件并调用脚本，在输出中，我们可以看到一个普通系统用户可以在未 sudo 的情况下运行脚本。 这是因为 USER_ID 的值为 100，不等于为 0 的 root 的 ROOT_ID 。

 
   
   
 
    
  
    
    
  
  1. $ ./sys_info.sh
    2.

如何在 Shell 脚本中跟踪调试命令的执行

Run Shell Script Without Sudo

未 sudo 的情况下运行 shell 脚本

那么，现在我们已经完成了 shell 脚本调试系列[6]，可以在下面的反馈栏里给我们关于本篇或者本系列提出问题或反馈。

作者简介：

 Aaron Kili 是 Linux 和 F.O.S.S 爱好者，将来的 Linux SysAdmin、web 开 发人员，目前是 TecMint 的内容创作者，他喜欢用电脑工作，并坚信分享知识。

via: http://www.tecmint.com/trace-shell-script-execution-in-linux/

本文由 LCTT[8] 原创编译，Linux中国 荣誉推出


推荐文章

< 左右滑动查看相关文章 >

如何在 Shell 脚本中跟踪调试命令的执行 如何在 Shell 脚本中跟踪调试命令的执行 如何在 Shell 脚本中跟踪调试命令的执行

输入文章 ID 或长按二维码直达


[1]: https://linux.cn/article-8028-1.html
[2]: https://linux.cn/article-8028-1.html
[3]: https://linux.cn/article-8045-1.html
[4]: http://www.tecmint.com/su-vs-sudo-and-how-to-configure-sudo-in-linux/
[5]: http://www.tecmint.com/echo-command-in-linux/
[6]: https://linux.cn/article-8028-1.html
[7]: http://www.tecmint.com/author/aaronkili/
[8]: https://github.com/LCTT/TranslateProject


以上是关于如何在 Shell 脚本中跟踪调试命令的执行的主要内容，如果未能解决你的问题，请参考以下文章

Shell脚本的调试方法

Shell脚本的调试方法

如何在 pycharm 中调试包含可执行命令的 shell 脚本文件？

set -x 调试shell

如何调试LoadRunner脚本

如何调试LoadRunner脚本