【软件工具】shell 脚本中自动化地处理交互式命令工具：expect简介及示例

一、expect简介

Expect 是一个 Unix 和 Unix-like 系统上的自动化工具，用于自动化控制交互式应用程序。它是一个扩展的 Tcl 解释器，专为脚本化 CLI（命令行界面）应用程序设计。Expect 使用自动对话控制技术，使用户可以预设一系列命令或系统响应，然后让脚本根据这些预设自动运行。

Expect 的主要特点和功能包括：

1. 自动化脚本执行：自动执行一系列命令，而无需人工干预。
2. 交互式应用程序控制：可以控制任何基于文本的交互式应用程序。
3. 模式匹配：等待特定的文本出现在输出中，然后根据匹配到的文本做出响应。
4. 自动化测试：常用于自动化测试脚本，尤其是在测试命令行工具和脚本时。
5. 网络脚本：可以用于自动化网络任务，如自动登录到远程服务器并执行任务。

Expect 是用于自动化命令行任务的强大工具，特别适用于那些需要交互式响应的场景。

Expect 脚本的基本语法和使用方法可以概括为以下几个方面：

1. 基本语法

Expect 脚本以 #!/usr/bin/expect 开头，这告诉系统使用 Expect 解释器来执行脚本。其余部分主要是 Tcl 语言的扩展，所以它包含了 Tcl 的所有基本语法，加上 Expect 特有的命令。

2. 核心命令

Expect 的核心功能是等待特定的文本出现在交互式程序的输出中，并根据匹配的内容执行相应的动作。其核心命令包括：

• spawn：启动新的进程。
• expect：等待特定的输出。
• send：向进程发送字符串。
• interact：允许用户交互。

3. 示例脚本

以下是一个简单的 Expect 脚本示例，用于自动登录 SSH：

#!/usr/bin/expect

# 设置超时时间
set timeout 20

# 启动 ssh 进程并登录到远程服务器
spawn ssh [lindex $argv 0]@[lindex $argv 1]

# 等待密码提示
expect "password:"

# 提供密码
send "[lindex $argv 2]\r"

# 交互模式
interact

这个脚本使用 spawn 命令启动 ssh 进程，然后 expect 命令等待密码提示出现。一旦出现，它使用 send 命令发送密码。最后，interact 命令允许用户接管控制权。

4. 变量和参数

Expect 脚本可以使用 Tcl 的变量和参数。在上面的示例中，$argv 是一个数组，包含传递给脚本的命令行参数。

5. 超时和分支

您可以设置脚本在等待特定输出时的超时时间，并根据不同的输出或超时情况执行不同的操作。例如：

expect {
    "password:" {
        send "my_password\r"
    }
    timeout {
        send_user "Connection timed out\n"
        exit
    }
}

6. 使用技巧

• 调试：Expect 提供了调试工具，可以帮助您理解脚本的行为。使用 exp_internal 1 来启用详细的调试输出，这对于理解脚本如何响应不同的输入非常有帮助。

• 模式匹配：Expect 使用 glob 风格的模式匹配。您可以使用通配符（如 * 和 ?）来匹配不确定的输出。

• 强健性：在脚本中考虑各种可能的输出和错误情况，使脚本能够更可靠地处理意外情况。

• 安全性：在处理敏感信息（如密码）时要小心。避免在脚本中硬编码密码，而是通过安全的方式传递（如使用环境变量）。

• 超时处理：合理设置 expect 命令的超时时间。这是防止脚本在等待永远不会出现的输出时无限期挂起的关键。

• 自动化交互：Expect 不仅限于自动化登录脚本。它可以用于任何需要自动化交互的场景，例如自动化测试、网络设备配置等。

• 循环和条件：由于 Expect 是基于 Tcl，您可以使用 Tcl 的循环和条件语句来增加脚本的逻辑复杂度。

• 子过程处理：在处理子过程时（例如使用 spawn 命令），确保正确管理和控制这些过程，包括合适的时机结束它们。

• 文档和注释：为脚本添加充分的文档和注释，尤其是在复杂的逻辑或特定的行为需要清晰解释时。

Expect 脚本的强大之处在于其灵活性和对交互式程序自动化的能力。通过熟练使用其特性和技巧，可以大大提高日常任务的效率和可靠性。

二、expect如何安装

要检查服务器上是否安装了 expect，你可以通过在服务器的命令行界面执行一个简单的命令来实现。这个过程取决于服务器使用的操作系统。以下是针对不同操作系统的基本步骤：

对于 Linux 和 macOS

1. 打开终端或连接到你的服务器（例如，使用 SSH）。

2. 输入以下命令：

   expect -v
   

   或者

   expect --version
   

   这个命令会输出安装在服务器上的 expect 的版本信息。如果 expect 已安装，你会看到类似于 expect version 5.x.x 的信息。

3. 如果系统显示类似于“命令未找到”的消息，则表示 expect 尚未安装。

对于 Windows 服务器

expect 主要用于 Unix-like 系统，如 Linux 和 macOS。它通常不是 Windows 系统的一部分，但可以通过 Cygwin 或类似的兼容层来安装和运行。对于 Windows，你可以检查 Cygwin 或其他类似系统的安装来确定是否安装了 expect。

安装 expect（如果尚未安装）

如果你发现 expect 未安装，可以通过包管理器轻松安装它：

• 对于基于 Debian 的 Linux 系统（如 Ubuntu）：

  sudo apt-get install expect
  

• 对于基于 RPM 的 Linux 系统（如 CentOS）：

  sudo yum install expect
  

• 对于 macOS，使用 Homebrew：

  brew install expect
  

确保在尝试安装 expect 之前，你具有适当的权限（如使用 sudo）。

三、脚本交互示例

用expect实现在服务器上拉取代码，git clone时需要交互输入账户密码

可以将参数从外部传递给 expect 脚本，类似于在 shell 脚本中那样使用 $1、$2 等来接收命令行参数。在 expect 脚本中，你可以使用 lindex 命令和 $argv 变量来访问这些参数。

以下是一个如何在 expect 脚本中接收和使用外部参数的示例：

#!/usr/bin/expect

# 设置超时
set timeout 30

# 获取传入的参数
set username [lindex $argv 0]
set password [lindex $argv 1]
set git_repo [lindex $argv 2]

# 执行 git clone 命令
spawn git clone $git_repo
expect "Username for 'https://github.com':"
send "$username\r"
expect "Password for 'https://$username@github.com':"
send "$password\r"
expect eof

在这个脚本中，[lindex $argv 0] 获取第一个传入的参数（$1），[lindex $argv 1] 获取第二个参数（$2），以此类推。

使用脚本

保存此脚本为 git_clone_auto.exp，然后运行它时传入相应的参数：

./git_clone_auto.exp your_username your_password https://github.com/username/repo.git

这里，your_username、your_password 和 https://github.com/username/repo.git 将分别作为用户名、密码和 Git 仓库 URL 传递给脚本。

注意事项

• 将敏感信息（如密码）作为命令行参数传递存在安全风险，因为这些信息可能会在命令历史或日志文件中留下痕迹。
• 一种更安全的方法是使用 SSH 密钥认证进行 Git 操作，或者使用其他方式来安全地传递敏感信息。
• 确保在可信的环境中使用此脚本，并严格控制对脚本的访问。

expect 脚本在输入密码那里没有进行自动输入

这可能是因为几个原因造成的。以下是一些可能的原因和相应的解决方案：

1. 匹配字符串不准确

• 确保 -re "Password:" 正确匹配了程序的输出。有时候，程序输出的提示可能包含额外的空格或特殊字符，或者与你预期的文本略有不同。
• 尝试使用更宽泛的正则表达式来匹配，例如：

  -re ".*Password.*:"
  

2. 缓冲区和输出处理

• 有些程序可能在输出密码提示时使用不同的缓冲机制。在这种情况下，expect 可能没有正确地捕获到这个提示。
• 可以尝试在发送用户名后增加一些延迟，以便程序有时间来处理输入并输出密码提示。

3. 交互式 Shell 特性

• 如果目标程序是一个交互式 Shell，它可能会以特殊方式处理标准输入，这可能会干扰 expect 的正常工作。
• 确保目标程序没有这样的特殊输入处理。

4. 调试脚本

• 使用 expect 的调试功能来查看实际发生了什么。在脚本开头加入以下行：

  exp_internal 1
  

  这将显示详细的匹配过程和程序输出，帮助你诊断问题所在。

示例脚本修改

#!/usr/bin/expect

exp_internal 1 # 开启调试
set timeout 30

spawn /path/to/your/interactive/program

expect {
    -re "Enter your (username|login):" {
        send "my_username\r"
        exp_continue
    }
    -re ".*Password.*:" {
        send "my_password\r"
        exp_continue
    }
    -re "Are you sure you want to continue connecting (yes/no)?" {
        send "yes\r"
        exp_continue
    }
    eof {
        # 结束
    }
}

在这个修改后的脚本中，我加入了 exp_internal 1 用于调试，同时使用了 exp_continue 来继续匹配其他模式，直到 eof（文件结束符）。

注意

如果你是在尝试使用 expect 来处理 git clone 命令的用户名和密码输入，建议考虑使用 SSH 密钥或访问令牌，这些方法更安全、更可靠。