介绍

expect 是由Don Libes基于Tcl(Tool Command Language )语言开发的,主要应用于自动化交互式操作的场景,借助Expect处理交互的命令,可以将交互过程如:ssh登录,ftp登录等写在一个脚本上,使之自动化完成。尤其适用于需要对多台服务器执行相同操作的环境中,可以大大提高系统管理人员的工作效率

常用指令

命令速查

  • spawn:交互程序开始后面跟命令或者指定程序(在壳内启动这个进程)
  • expect:获取匹配信息匹配成功则执行expect后面的程序动作(检测由壳内进程发出的特定交互指令反馈字符串后向下执行)
  • send:用于向进程发送字符串(从壳外向壳内进程发送一条字符串,换行符为确认结束)
  • interact:允许用户交互
  • exp_continue:在expect中多次匹配就需要用到
  • send_user:用来打印输出 相当于shell中的echo
  • exit:退出expect脚本
  • eof:expect执行结束 退出
  • set:定义变量
  • puts:输出变量
  • set timeout:设置超时时间

实例

1.简单地例子

看一个简单地例子,该例子就是自动登录到主机上

#!/usr/bin/expect
spawn ssh root@127.0.0.1
expect "*password:"
send "111111\r"

expect "#"
send "exit \r"

expect eof

如下执行:

expect test.ctl
  • <

输出如下:

spawn ssh root@127.0.0.1
root@127.0.0.1's password: 
Last login: Sat Jul 16 02:44:48 2022 from 127.0.0.1
[root@zxy ~]# exit 
logout
Connection to 127.0.0.1 closed.

1. send命令

send命令接收一个字符串参数,并将该参数发送到进程(这个指令的前提是先使用spawn开启的进程)。

基础实例中,我们看到有2处使用了send。

......
send "111111\r"
......
send "exit \r"

其实就是spawn打开了一次ssh连接以后,会要求我们输入登陆密码,第一个send就是将密码发送到spawn的进程中。第二个send就是退出ssh的意思。

如果没有开启一个进程,会怎么样?我们试一下:

#!/usr/bin/expect
send "date \n"

执行后的结果为:

date

好像直接把文字远样输出出来了!!!其实和平时我们写shell脚本一样,我们习惯的会在第一行#!/bin/bash,其实是在告诉程序,后面的代码要用bash来解释。所以我们平时在bash的脚本里面,date会被解释成一条有意义的命令。但是#!/usr/bin/expect的时候,date是没有这个意义的,所以远样输出了。

2. expect

expect命令和send命令正好相反,expect通常是用来等待一个进程的反馈。expect可以接收一个字符串参数,也可以接收正则表达式参数。比如root登陆的之后,界面会输出一个#,那么expect此时匹配的是这个#。ssh登陆后,一般shell会返回一个xxxpassword:的输出,那么此时可以匹配password的字符。

而如果我们没有通过spawn开启一个ssh或者类似的ssh进程,而是直接在expect程序里面expect一个字符串的时候,会怎么样?

#!/usr/bin/expect
expect "hello" { send "hello world\n"}

这个例子,我们改变了send的写法,放在了expect后面使用花挎号夸起来了。这时候,当你执行脚本的时候,你会发现,除非你再键盘上输出hello,然后确认,才会输出“hello world”。

这里做个对比,上述写法和下面的对比一下:

#!/usr/bin/expect
expect "hello"

send "hello world\n"

我们会发现,第二种写法,不管我们在不在键盘上输入hello,或者输入什么,都会一段时间后,输出【hello world】。

原因其实是:expect是方法是tcl语言的模式-动作。正常的用法是类似第一种,匹配到指定的字符时,执行指定的动作。匹配有2中匹配方式:

2.1 单一分支匹配

类似于上述例子里面的:

expect "hello" { send "hello world\n"}

单一匹配就是只有一种匹配情况。有点类似于普通编程语言的if语句,只有一个条件的情况。

2.2 多分支匹配模式

类似于普通变成语言的多个if条件的情况。这种情况有2种写法:

expect "hello" {send "hello world\n"} "hi" {send "hi world"} "bye" {send "bye world"}

第二种写法:

#!/usr/bin/expect
set timeout 5
expect {

"hello" {send "hello world\n"}

"hi" {send "hi world"}

"bye" {send "bye world"}

}

第二种写法形式上会更简洁易读。我们会发现,expect语言的都是用{}来做代码分割和代码块分割的。

spawn

最开始的ssh案例里面,我们使用spawn开启了一个ssh进程,然后使用send输入了密码。我们再多加一个命令,查看登陆的机器的hostname看看:

#!/usr/bin/expect
spawn ssh root@127.0.0.1
expect "*password:"
send "111111\r"

expect "#"
send "hostname \r"

expect "#"
send "exit \r"

expect eof

spawn开启一个ssh以后,会进入到一个linux的shell环境下,这时候向进程发送一个hostname这样的字符串,shell就能够识别出这是一个有意义的指令,并返回指令的结果。

spawn ssh root@127.0.0.1
root@127.0.0.1's password: 
Last login: Sat Jul 16 22:19:58 2022 from 127.0.0.1
[root@zxy ~]# hostname 
zxy
[root@zxy ~]# exit 
logout
Connection to 127.0.0.1 closed.

interact

上述举的例子都是自动完了一些动作。有时候,我们可能会发生,停留在界面,等待人工操作的情况。这时候,我们可以用interact指令,来等待人工干预。

#!/usr/bin/expect
spawn ssh root@127.0.0.1
expect "*password:"
send "111111\r"

expect "#"
send "hostname \r"

expect "#"

interact

该例子执行完hostname以后,会停留在expect打开的ssh界面,等待人工操作。

set

该指令是用来设置变量值。比如,我们改造一下刚开始的基础示例中的脚本:

#!/usr/bin/expect
set uname root
set pwd 111111
spawn ssh ${uname}@127.0.0.1
expect "*password:"
send "${pwd}\r"

expect "#"
send "exit \r"

expect eof

传参

很多场景下,我们写一个脚本都是要传递参数的。expect也不例外。expect 有2个内置变量:

a
   
   
    r
   
   
    g
   
   
    c
   
   
    和
   
  
  
   argc和
  
 
</span><span class="katex-html"><span class="base"><span class="strut" style="height: 0.8778em; vertical-align: -0.1944em;"></span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right: 0.0278em;">r</span><span class="mord mathnormal" style="margin-right: 0.0359em;">g</span><span class="mord mathnormal">c</span><span class="mord cjk_fallback">和</span></span></span></span></span>argv。<span ><span class="katex"><span class="katex-mathml">

 
  
   
    a
   
   
    r
   
   
    g
   
   
    c
   
   
    表示参数的数量。类似于普通
   
   
    s
   
   
    h
   
   
    e
   
   
    l
   
   
    l
   
   
    脚本的
   
  
  
   argc表示参数的数量。类似于普通shell脚本的
  
 
</span><span class="katex-html"><span class="base"><span class="strut" style="height: 0.8889em; vertical-align: -0.1944em;"></span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right: 0.0278em;">r</span><span class="mord mathnormal" style="margin-right: 0.0359em;">g</span><span class="mord mathnormal">c</span><span class="mord cjk_fallback">表示参数的数量。类似于普通</span><span class="mord mathnormal">s</span><span class="mord mathnormal">h</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right: 0.0197em;">ll</span><span class="mord cjk_fallback">脚本的</span></span></span></span></span>#。而$argv则可以给自身传递一个整数,取出指定位置的参数。例如:</p>
#!/usr/bin/expect
set uname [lindex $argv 0]
set pwd [lindex $argv 1]
puts "$argc"
spawn ssh ${uname}@127.0.0.1
expect "*password:"

send "${pwd}\r"
expect "#"

send "exit \r"
expect eof

我们入戏执行

expect test.ctl root 111111
  • 1

结果为:

2
spawn ssh root@127.0.0.1
root@127.0.0.1's password: 
Last login: Sun Jul 17 02:18:56 2022 from 127.0.0.1
[root@zxy ~]# exit 
logout
Connection to 127.0.0.1 closed.

expect还有一个非常重要的内置变量,也是和参数有关系的:

a
   
   
    r
   
   
    g
   
   
    v
   
   
    0
   
   
    。上面我们说过,
   
  
  
   argv0。上面我们说过,
  
 
</span><span class="katex-html"><span class="base"><span class="strut" style="height: 0.8778em; vertical-align: -0.1944em;"></span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right: 0.0278em;">r</span><span class="mord mathnormal" style="margin-right: 0.0359em;">gv</span><span class="mord">0</span><span class="mord cjk_fallback">。上面我们说过,</span></span></span></span></span>argv是存储了所有传递进来的参数的变量。而$argv0则是脚本的名称。这个和shell脚本的$0一个意思。</p>
puts "------argv0--------"
puts "$argv0"

输出如下:

------argv0--------
test1.ctl

脚本里面,出现了一个put指令,这个指令是向标准输出输出内容

从结果看,我们传递了2个参数,puts指令将$argc输出到了屏幕,值是2,表示有2个参数。同事,我们通通lindex $argv [int],获取到指定位置的参数值。

incr

增量。该质量一般用在数学计算的时候可以用到,语法位为:incr [arg] {step},arg是要增加的参数名,step是增量值,可以不指定,不指定为1。如下:

puts "------incr-------"
set x 10
puts "$x"
incr x 5
puts "$x"

结果如下:

------incr-------
10
15

其实这里的【incr x 5】也就相当于【set x [expr $x + 5]】

puts "--------计算---------"
set x 5
set x [expr $x + 5]
puts $x

运行结果如下:

--------计算---------
10

运算[]

不确【运算】定这种描述是否准确,因为没有查到相关的资料,所以暂且这么认为吧。在shell中,我们会使用``或者

(
   
   
    )
   
   
    将可执行的命令行包裹起来,这样包裹起来的部分,在执行的时候,
   
   
    s
   
   
    h
   
   
    e
   
   
    l
   
   
    l
   
   
    会把它当成要执行的部分来执行。我们可以把
   
   
    [
   
   
    ]
   
   
    理解为类似
   
   
    s
   
   
    h
   
   
    e
   
   
    l
   
   
    l
   
   
    中
   
   
    ‘
   
   
    ‘
   
   
    或者
   
  
  
   ()将可执行的命令行包裹起来,这样包裹起来的部分,在执行的时候,shell会把它当成要执行的部分来执行。我们可以把[]理解为类似shell中``或者
  
 
</span><span class="katex-html"><span class="base"><span class="strut" style="height: 1em; vertical-align: -0.25em;"></span><span class="mopen">(</span><span class="mclose">)</span><span class="mord cjk_fallback">将可执行的命令行包裹起来,这样包裹起来的部分,在执行的时候,</span><span class="mord mathnormal">s</span><span class="mord mathnormal">h</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right: 0.0197em;">ll</span><span class="mord cjk_fallback">会把它当成要执行的部分来执行。我们可以把</span><span class="mopen">[</span><span class="mclose">]</span><span class="mord cjk_fallback">理解为类似</span><span class="mord mathnormal">s</span><span class="mord mathnormal">h</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right: 0.0197em;">ll</span><span class="mord cjk_fallback">中</span><span class="mord">‘‘</span><span class="mord cjk_fallback">或者</span></span></span></span></span>()的功能。</p>

例如:

访问数组

puts [lindex $argv 1]

数学计算的时候

puts [expr $x + 5]

分割字符串的时候

set ss "aa,bb,cc,dd"
puts [split $ss ","]

为了说明,[]这玩意的确类似shell的``和$(),我们这么干:上面我们举了个数学计算的例子。我们把puts去掉会怎么样?

#!/usr/bin/expect
set timeout 5
[expr 3 + 5]

执行的时候,报了个错误:

invalid command name "8"
    while executing
"[expr 3 + 5]"
    (file "test1.ctl" line 3)

我们暂且先这么理解吧。如果后面看到了相关的权威解释,再纠正说法吧。

数组

在传参的主题里面,我们提到了所有传递的参数,被存放在

a
   
   
    r
   
   
    g
   
   
    v
   
   
    中。其实
   
  
  
   argv中。其实
  
 
</span><span class="katex-html"><span class="base"><span class="strut" style="height: 0.8778em; vertical-align: -0.1944em;"></span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right: 0.0278em;">r</span><span class="mord mathnormal" style="margin-right: 0.0359em;">gv</span><span class="mord cjk_fallback">中。其实</span></span></span></span></span>argv就是数组。</p>

数组的定义

数组的定义,需要结合set的指令。

set j "a b c d"

数组的所有元素之间,需要用空格隔开。

数组访问

在传参的主题里面,我们使用[lindex $argv 0]的方法,获取了第0个参数。这个正也是数据的访问方法:

#!/usr/bin/expect
set timeout 5
set j "a b c d e"
puts "[lindex $j 2]"

那我们如何遍历数组呢?这里我们可以使用foreach的方法:

set j "a b c d e"
foreach jj $j {
    puts "$jj"
}

循环

和其他普通语言一样,expect也是支持for、whle、foreach这样的循环语言的。用法如下

for循环

expect的for训话,可c语言或者shell的for循环有些类似。只不过不是使用的符号有些不一样。

比如shell,我们是这么写的:

for((i=1;i<=10;i++));do
    echo $i
done

而expect语言则如下写法:

puts "------递增-----"
for {set i 0} { $i < 5 } { incr i } {
    puts "$i"
}
puts "------递减-----"
for {set k 5} { $k > 0 } { incr k -1 } {
    puts "$k"
}

这里要注意【incr k -1】的写法,中间是有一个空格的。意思是k每次增加-1。incr i其实等于incr i 1。

while写法

puts "------while递增-----"
set m 0
while {$m < 5} {
    puts "$m"
    incr m 2
}

foreach写法

foreach可以认为和php的有些类似,php的是为了便利数组用的。expect也是如此。例如,我们想要遍历传递的所有参数:

#!/usr/bin/expect
set timeout 5
puts "------遍历argv--------"
foreach arg $argv {
    puts "$arg"
}

当然遍历所有参数,我们还可以这么遍历:

#!/usr/bin/expect
set timeout 5
for {set y 0 } { $y < $argc} {incr y} {
    puts "arg $y: [lindex $argv $y]"
}

shell调用expect

我们将基础实例的代码稍作修改:

#!/bin/bash
ip="$1"
pawd="$2"
expect << EOF
	set timeout 10
	spawn ssh root@${ip}
	expect {
		"yes/no" {send "yes\n"; exp_continue}
		"password:" {send "${pawd}\n"}
	}
	expect "#" {send "hostname\n"}
	expect "#"
	send "exit\n"
	expect eof
EOF
echo "end!"

然后如下执行:

sh shell.sh 127.0.0.1 111111

这时候,如果是第一次登陆机器,会提示输入yes/no。也能够自动输入。结果如下:

spawn ssh root@127.0.0.1
The authenticity of host '127.0.0.1 (127.0.0.1)' can't be established.
ECDSA key fingerprint is SHA256:zYqdNqHNR510qlQjUaSQj9IYlWhuWDhbi0Sq94nhhV0.
ECDSA key fingerprint is MD5:28:35:80:b8:45:11:b1:85:5c:ad:c8:94:7b:eb:a9:fb.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '127.0.0.1' (ECDSA) to the list of known hosts.
root@127.0.0.1's password: 
Last login: Sun Jul 17 02:26:05 2022 from 127.0.0.1
[root@zxy ~]# hostname
zxy
[root@zxy ~]# exit
logout
Connection to 127.0.0.1 closed.
end!