Expect 学习笔记

http://www.chinaunix.net 作者:very_99   发表于：2006-12-11 15:06:11

[u]Expect 学习笔记  [/u]   　　接触Expect是迫不得已。系统管理员在工作中经常会遇到这样的问题，需要实现一个自动交互的工具，这个工具可以自动Telnet或者Ftp到指定的服务器上，成功login之后自动执行一些命令来完成所需的工作。 　　当然，有很多编程语言可以去解决此类问题，比如用C、Perl、或者Expect。 　　显然，尽管C是无所不能的，但是解决此类问题还是比较困难，除非你熟悉Telnet或者Ftp协议。 　　曾经见过别人用C实现了一个简单的Telnet客户端协议的程序，可以在这个程序加入自己的代码来捕获服务端的输出，根据这些输出来发送适当的指令来进行远程控制。 　　使用Perl一样可以实现这样的功能，然而，Expect做的更出色，而且除支持Unix/Linux平台外，它还支持Windows平台，它就是为系统管理和软件测试方面的自动交互类需求而产生的：                  　　Expect是一个免费的编程工具语言，用来实现自动和交互式任务进行通信，而无需人的干预。 　　Expect的作者Don Libes在1990年开始编写Expect时对Expect做有如下定义：          　　Expect是一个用来实现自动交互功能的软件套件(Expect [is a] software suite for automating interactive tools)。 引用：　　Expect语言是基于Tcl的， 作为一种脚本语言，Tcl具有简单的语法：                          cmd arg arg arg                   一条Tcl命令由空格分割的单词组成. 其中, 第一个单词是命令名称, 其余的是命令参数 .                   $foo                   $符号代表变量的值. 在本例中, 变量名称是foo.                   [cmd arg]                   方括号执行了一个嵌套命令. 例如, 如果你想传递一个命令的结果作为另外一个命令的参数, 那么你使用这个符号 .                  "some stuff"                   双引号把词组标记为命令的一个参数. "$"符号和方括号在双引号内仍被解释 .                   {some stuff}                   大括号也把词组标记为命令的一个参数. 但是, 其他符号在大括号内不被解释.                                    反斜线符号() 是用来引用特殊符号. 例如：n 代表换行. 反斜线符号也被用来关闭"$"符号 , 引号,方括号和大括号的特殊含义 .       　　最好的学习方法就是边干边学，对于已经熟悉一种编程语言的人来说，用另一种新的语言来写程序解决问题，是很容易的事。所以大概了解一下基本语法后，就一边动手解决问题，一边查手册吧。 　　关于Tcl和Expect的语法，请参考Unix/Linux 平台任务的自动化相关部分。 引用：　　例1：下面是一个telnet到指定的远程机器上自动执行命令的Expect脚本，该脚本运行时的输出如下: # /usr/bin/expect sample_login.exp root 111111 spawn telnet 10.13.32.30 7001  Trying 10.13.32.30... Connected to 10.13.32.30. Escape character is '^]'. accho console login: root Password:  Last login: Sat Nov 13 17:01:37 on console Sun Microsystems Inc.   SunOS 5.9  May 2004 #  Login Successfully... # uname -p sparc # ifconfig -a lo0: flags=2001000849<UP,LOOPBACK,RUNNING,MULTICAST,IPv4,VIRTUAL> mtu 8232 index 1         inet 127.0.0.1 netmask ff000000  eri0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2         inet 10.13.22.23 netmask ffffff00 broadcast 10.13.22.255         ether 0:3:ba:4e:4a:aa  # exit accho console login:  Finished... 引用：　　下面是该脚本的源代码: # vi sample_login.exp: proc do_console_login {login pass} {         set timeout 5         set done 1         set timeout_case 0         while ($done) {                 expect {                         "console login:" { send "$loginn" }                         "Password:" { send "$passn" }                         "#" {                                 set done 0                                 send_user "nnLogin Successfully...nn"                         }                         timeout {                                 switch -- $timeout_case {                                         0 { send "n" }                                         1 {                                                 send_user "Send a return...n"                                                 send "n"                                         }                                         2 {                                                 puts stderr "Login time out...n"                                                 exit 1                                         }                                 }                                 incr timeout_case                         }                 }         } } proc do_exec_cmd {} {         set timeout 5         send "n"         expect "#"         send "uname -pn"         expect "#"         send "ifconfig -an"         expect "#"         send "exitn"         expect "login:"         send_user "nnFinished...nn" } if {$argc<2} {         puts stderr "Usage: $argv0 login passwaord.n "         exit 1 } set LOGIN   [lindex $argv 0] set PASS    [lindex $argv 1] spawn telnet 10.13.32.30  7001 do_console_login $LOGIN $PASS do_exec_cmd close exit 0 　　上面的脚本只是一个示例，实际工作中，只需要重新实现do_exec_cmd函数就可以解决类似问题了。 引用：　　在例1中，还可以学习到以下Tcl的语法：         1. 命令行参数                         $argc，$argv 0，$argv 1 ... $argv n             if {$argc<2} {                     puts stderr "Usage: $argv0 login passwaord.n "                     exit 1             }               2. 输入输出                           puts stderr "Usage: $argv0 login passwaord.n "         3. 嵌套命令             set LOGIN   [lindex $argv 0]             set PASS    [lindex $argv 1]         4. 命令调用                               spawn telnet 10.13.32.30  7001          5. 函数定义和调用              proc do_console_login {login pass} {                      ..............                           }         6. 变量赋值              set done 1                   7. 循环              while ($done) {                    ................              }         8. 条件分支Switch              switch -- $timeout_case {                     0 {                        ...............                     }                     1 {                        ...............                                    }                     2 {                        ...............                                }               }         9. 运算                   incr timeout_case         此外，还可以看到 Expect的以下命令：         send         expect         send_user         可以通过-d参数调试Expect脚本：         # /usr/bin/expect -d sample_login.exp root 111111 [ 本帖最后由 mocou 于 2005-12-31 10:55 编辑  ]  very_99 回复于：2005-11-02 09:30:18 EXPECT 交互式程序可编程对话，第5版 expect [ -dDinN ] [ -c cmds ] [ -[f|b] ] cmdfile ] [  args  ]'F} 简介 Expect是一种能利用脚本和其它交互式程序进行对话的程序。通过脚本，expect能够获知一个程序应该有怎样的响应和怎样是正确的响应。它 采用翻译式语言来控制流结构和高层结构使对话进行下去。而且，还允许用户在想要控制的时候能够直接控制程序，然后再将控制交回给脚本。 Expectk是expect和tk的混合体，它可以象expect和tk那样使用。同样，expect也能够被C和C++直接调用(没有Tcl存在的情况下)。可以参看libexpect(3)。 Expect这个名字来源于广泛使用的uucp, Kermit和其它的modem控制程序等的send/expect序列的思想，但是它并不象 uucp那样，expect对环境没有很特殊的要求，因此可以作为用户级的命令和任何程序交互，而且expect实际上可以同时和多个程序交互。 举例来说，expect可以做这些事情： 使你的计算机可以回拨，这样你就不必为你的上网而支付电话费啦。 一遍遍的开始一个游戏程序(如rogue)，直到那个随机产生的装备设置达到最好，然后把控制交给你来玩游戏。 运行fsck，对它的提问按预先设置的标准给出响应“yes”，“no”或者将控制交给你。 连到另外一个网络或BBS(如MCI Mail, CompuServe)，自动收下你的信件，就好象原来发到你的本地系统一样。 携带rlogin, telnet, tip, su, chgrp等需要的环境变量，当前目录或其它信息 用普通脚本来执行一个任务存在着很多种理由使得是不可行的，(如果你试试就知道了)但用expect就都成为可能了。 总地说来，expect在运行那些需要在程序和用户之间进行交互的程序时是很有用的。交互一旦被程序化地指定了，运行起来会很方便。如果需要，Expect也可以将控制交还给用户(不停止正在运行的程序)。类似的，用户也可以在任何时间把控制交还给脚本。| 注：老外可真够罗嗦的，就这么简单的意思，让我翻译这么半天，还是我来简单说说吧?：expect是个脚本解释程序，就好象/bin/sh, /bin/ksh一样。所完成的功能呢，最简单的就是自动对需要人工交互和程序进行自动交互，比如一个程序需要你不断地输入yes继续，你懒得做，干脆用 写个expect脚本自动输入yes就行了。当然，expect可以做的事情远不止这些，它实际上是 tcl(Tool Command Language)的一个变种，格式和tcl程序也类似，写expect脚本对懂tcl的人应该不难。用过 secureCRT的人应该知道有个自动登录的设置，那就是利用expect实现的。好了，我不罗嗦了，继续干活。 引用：用法 expect从cmdfile中读取命令列表来执行，同样它也可以在有执行权限的脚本的第一行中加上#!标识来隐式地执行，如： #!/usr/local/bin/expect -f 当然，路径应该准确地描述expect的位置，/usr/local/bin只是一个例子。 -c参数指示其后的命令在脚本的最先开始执行，命令应该用引号引起来以不被shell打散。这个选项可被多次使用。多个命令如果用一个-c指示，则应用分号分隔。命令将按其书写顺序执行。(使用expectk时，这个参数用作-command) -d参数允许一些诊断输出，报告主要的expect和交互命令行为。在expect脚本开始用exp_internal 1也可以起到一样的作 用，-d会多打出expect的版本。(strace命令在跟踪状态时很有用，trace命令在跟踪变量时很有用)(expectk中此参数为 -diag)。 　 -D参数打开交互debugger，后跟一个整数。如果这个整数是非零，或者^C被按下(或者碰到一个设置的断点，或者脚本中设置的其它合适的 debugger命令)Debugger会在下一个tcl过程之前控制程序。关于debugger的信息参看README或 SEE ALSO。(expectk中此参数为-Debug) -f参数指定从哪个文件中读取命令。当被用在#!指示(见上)中时此参数是可选的，所以其它参数可在命令行中提供。(expectk中为-file)。 -b参数。缺省地，命令文件被整个地读到内存中执行，但是有时需要一行行地读取，比如，标准输入stdin就是这样。为了强制特定的文件被这样读 入，可以使用-b参数。(expectk中为-buffer)。如果文件名是“-”，则表示从标准输入stdin读入。(用“./-”来表示一个叫作“- ”的文件) -i参数使expect交互地提示输入命令，而不是从文件中读命令。命令提示行通过exit命令或一个eof字符结束。参看interpreter(见下)。-i假设既没有命令文件，又没有使用-c参数。(expectk中为-interactive)。 --用来对选项参数结束的划界。在你想传递一个象选项参数样的参数给你的脚本时，这个选项是很有用的，它使得expect不对其进行翻译。也可以放在#!行来阻止expect对任何选项参数格式的参数的翻译。比如，下面例子将保留原始参数(包括脚本名)到argv中： #!/usr/local/bin/expect 注意加参数到#!行时应该遵守getopt(3)和execve(2)的惯例。 -N选项。 $exp_library/expect.rc文件如果存在的话将被自动的启用，除非-N选项被使用。(expectk中为 -NORC)这样的话就会自动找~/.expect.rc，除非加了-n参数。如果定义了环境变量DOTDIR，那就会从那里 找.expect.rc。(expectk中为-norc)。expect.rc的使用只在执行完-c参数指定的命令后。 -v打印expect的版本号并退出。(expectk中为-version) 可选的args被结构化成一个列表存在argv中，argc被初始化成argv的长度。 Argv0被定义为脚本的名字。下面例子打印出脚本名和前三个参数： send_user "$argv0 [lrange $argv 0 2] [ 本帖最后由 mocou 于 2005-12-31 10:57 编辑  ]  very_99 回复于：2005-11-02 09:32:48 % set i 1  1  字符串应该用引号括起来：  % set str "test"  'test'  要输出一个标量的内容，使用put语句：  % puts $str  test  $用来说明str是一个变量。puts函数在标准输出显示变量的内容。  数组也可以用set语句定义，实际上，tcl中建立数组只是单个建立数组的元素。例如  ，  % set arr(1) 0  0  % set arr(2) 1  1  这样就建立了一个两个元素的数组arr。在TCL中，不存在相当于数组边界这样的东西  ，例如  % set arr(100) to  to  这时数组中实际只存在arr(1)，arr(2)和arr(100)，这是和C语言不同的地方。用arr  ay size命令可以返回数组的大小：  % array size arr  3  访问数组的方法和访问标两实际是一样的，例如：  % puts $arr(100)  to  可以用同样的方法创建多维数组。  要使用数组中的所有元素，需要使用一种特殊的便利方式。首先要启动startsearsh:  % array startsearch arr  s-1-arr  这里返回了一个搜索id，你可以把它传递给某个变量，因为以后还要使用它进行进一  步的搜索：  % set my_id [array startsearch arr]  s-1-arr  现在my_id的内容是s-1-arr，然后，就可以搜索arr的内容了：  % array nextelement arr $my_id  whi  这里的array nextelement返回的是什么？可能有点出乎你的意料，是arr数组的下标  ，再执行一次array nextelement命令又会找出另外一个下标：  % array nextelement arr $my_id  4  这样遍历下去，可以找出arr数组的所有下标，而知道下标之后，就可以用$arr(4)之  类的方式访问arr的内容了。当遍历完成之后，array nextelement命令将简单地返回：  % array nextelement arr $my_id  %  这时就可以停止遍历过程了，如果你想确认遍历是否完成，可以使用array anymore命  令：  % array anymore arr $my_id  0  返回0说明遍历已经完成。  串处理  TCL中可以进行一般的串处理过程，这可以使用string命令和append命令，append命令  将某个字符串加到另外一个字符串的后面：  % set str1 "test "  test  % set str2 "cook it"  cook it  % append str1 $str2 " and other"  test cook it and other  string命令可以执行字符串的比较，删除和查询，其格式是 string [参数] string1  [string2]  参数可以是下面的命令之一：  compare 按照字典顺序对字符串进行比较，根据相对关系返回-1，0或者+1。  first 返回string2中第一次出现string1的位置，如果失败，返回-1。  last 返回string2中最后一次出现string1的位置，如果失败，返回-1  trim 从string1中删除开头和结尾的出现在string2中的字符  trimleft 从string1中删除开头的出现在string2中的字符。  trimright 从string1中删除结尾的出现在string2中的字符  下面几个用在string中的参数不需要string2变量：  length 返回tring1的长度  tolower 返回将string1全部小写化的串  toupper 返回将string1全部大写化的串  运算  TCL的运算方式比较别扭，它使用expr命令作为计算符号，其用法类似C语言的+=和/=  ，例如，  % set j [expr $i/5]  1  注意TCL会自动选择整数或者浮点计算：  % set l [ expr $i /4.0]  1.25  % set l [ expr $i /4]  1  在TCL里面可以使用+ - * /和%作为基本运算符，另外通常还包括一些数学函数，如a  bs，sin，cos，exp和power(乘方)等等。  另外，还有一个起运算符作用的命令incr，它用来对变量加一：  % set i 1  1  % incr i  2  流程控制  tcl支持分支和循环。分支语句可以使用if和switch实现。if语句的和C语言类似，如  if { $ x < 0 } {  set y 10;  }  注意判断子句也需要使用花括号。  与C语言一样，tcl的if语句也可以使用else和elseif。  switch语句的用法有点类似这样：  switch $x {  0 { set y 10;}  10 { set y 100;}  20 { set y 400;}  }  与C的switch语句不同，每次只有符合分支值的子句才被执行。  循环命令主要由for，foreach和while构成，而且每一个都可以使用break和continue  子句。  for语句的格式有点类似这样：  for { set i 0} {$i < 10} { incr i} {puts $i}  将会输出从1到9的整数。  如果用while循环，这个句子可以写成  while {$i < 10 } {  puts $i;  incr i;  }  foreach是对于集合中的每一个元素执行一次命令，大致的命令格式是  foreach [变量] { 集合 } {  语句；  }  例如  % foreach j { 1 3 5} {  put $j;  }  1  3  5  函数  如同在一般的编程语言里面一样，在tcl里面也可以定义函数，这是通过proc命令实现  的：  proc my_proc {i}{  puts $i;  }  这样就定义了一个名字叫proc的函数，它只是在终端显示输入变元的内容。  要使用这个函数，简单地输入它的名字：  % my_proc { 5 }  5  如果变元的数目是0，只要使用空的变元列表，例如 proc my_proc {} {语句；}  尽管tcl还可以处理更复杂的过程，但是我们不再介绍了，例如文件的读写以及tk图形  语言，因为我们处理tcl的主要目标就是理解expect，对于更复杂的编程工作，我们建议  你使用perl。  11.1.2 expect  expect是建立在tcl基础上的一个工具，它用来让一些需要交互的任务自动化地完成。  我们首先从一个简单的例子开始，如同在这一节一开始就提到的，我们想设置一个自动  的文件下载程序。  我们看一看这样的一个例子脚本：  #! /usr/bin/expect  spawn ftp 202.199.248.11  expect "Name"  send "ftpr"  expect "Password:"  send "nothingr"  expect "apply"  send "cd /pub/UNIX/Linux/remoteXr"  expect "successful."  send "binr"  expect "set to I"  send "get exceed5.zipr"  expect "complete."  send "quitr"  这个是什么意思？呵呵，就是个自动下载程序。第一行说明这个程序应该调用/usr/b  in/expect去执行，然后的就是expect命令。  察看expect的手册页面(man expect)可以得到一个很长的expect说明，可惜其中关于  expect的语法仍然介绍的不够。一般来说，expect主要用在需要自动执行人机交互的过  程中，例如fsck程序，这个程序会不断地提问"yes/no"，像这样的命令就可以用expect  来完成。  spawn语句在expect脚本中用于启动一个新的进程，在我们的程序中，spawn ftp 202  .199.248.11就是去执行ftp程序，接下来，就是expect和send的指令对了。  每一对expect和send指令代表一个信息/回应。如果这样说不好理解的话，那么可以看  一看ftp的具体执行过程：  ftp 202.199.248.11  Connected to 202.199.248.11.  220 mail.asnc.edu.cn FTP server (BeroFTPD 1.3.3(3) Sun Feb 20 15:52:49 CST  2000.  Name (202.199.248.11:wanghy):  显然，一旦连接成功，服务器会返回一个Name(202.199.248.11:wanghy):的字符串来  要求客户给出用户名。expect语句简单地在返回信息中查询你给出的字符串，一旦成功  就执行下面的命令，现在，expect " Name"已经成功地找到了Name字符串，接下来可以  执行send命令了。  send命令比expect命令更简单，它简单地向标准输入提交你设定的字符串，现在设置  为send "ftpr"表示等到登录信息之后就给出一个输入ftp回车，也就是标准的登录过  程。  下面的行与这些行完全一样，只是机械地等待服务器的回应，并且提交自己的输入。  要使用这个expect脚本，你只需要将它设置为可执行的属性，然后执行它，expect就  会执行你需要的服务。  由于expect是tcl的扩展，所以你在expect文件中可以象tcl脚本一样设置变量和程序  流程。  现在我们看一看我们还能够如何改进我们的expect脚本。ftp命令可能会失败，比如远  端的机器可能会无法提供服务，或者在启动ftp命令时本地机器发生问题。为了处理这一  类的问题，我们可以使用expect的timeout选项来设置超时的话expect脚本自动退出：  #! /usr/bin/expect  spawn ftp 202.199.248.11  expect {  timeout exit  Connect  }  ………………  注意这里面使用的花括号。它的含义是使用一组并列表达式。使用并列表达式的主要  原因是这样：如果使用下面的指令对：  expect timeout  exit  那么由于expect脚本是顺序执行的，那么当程序执行到这个expect的时候就会阻塞，  所以程序会一直等待到timeout然后退出。并列表达式则是相当于switch的行为，只要列  出的几项内容有一项得到满足，expect命令就得到满足，于是程序可以正常执行。上面  的脚本表示，如果连接ftp的时候发生了超时，那么就退出，否则，一旦发现Connect应  答，说明服务器已经正常了，那么就可以继续运行了。  我们可以看看用tcl能够对我们的expect脚本提供什么帮助。我们可以设置让expect脚  本不断地连接远端服务器的服务，直到正常建立连接开始，为此，我们可以把建立连接  的命令放在一个循环里面，并且根据回应的不同自动选择重新输入命令还是继续执行：  spawn ftp  while {1} {  expect "ftp>"  send "o 202.199.248.11r"  expect {  "Connected" break  "refused" { sleep 10} ;  }  }  这里使用了我们在tcl语言中讲到的while和break命令，熟悉C的读者应该很容易看出  它的行为：不断地等待ftp>提示符，在提示符下面发送连接远端服务器的命令，如果服  务器回应是refused（连接失败），就等待10秒钟，然后开始下一次循环；如果是Conne  cted，那么就跳出循环执行下面的命令。sleep是expect的一个标准命令，表示暂停若干  秒钟。  expect还支持许多更复杂的进程控制方式，如fork，disconnect等等，你可以从手册  页面中得到详细的信息。另外，各种tcl运算符和流程控制命令，包括tcl函数也可以使  用。  有些读者可能会问，如果expect执行的话是否控制台输入不能使用了，答案是否定的  。expect命令运行时，如果某个等待的信息没有得到，那么程序会阻塞在相应的expect  语句处，这时，你在键盘上输入的东西仍然可以正常地传递到程序中去，其实对于那些  expect处理的信息，原则上你输入的内容仍然有效，只是expect的反映太快，总是抢在  你的前面“输入”就是了。知道了这一点之后，你就可能写一个expect脚本，让expect  自动处理来自fscki的那些恶心的yes/no选项（我们介绍过，这些yes/no其实完全是多余  的，正常情况下你除了选择yes之外什么也干不了）。  缺省下，expect在标准输出（你的终端上）输出所有来自应用程序的回应信息，你可  以用下面的两个命令重定向这些信息：  log_file [文件名]  这个命令让expect在你设置的文件中记录输出信息。必须注意，这个选项并不影响控  制台输出信息，不过如果你通过crond设置expect脚本在半夜运行的话，你就确实可能需  要这个命令来记录各种信息了。例如：  log_file expect.log  log_user 0/1  这个选项设置是否显示输出信息，设置为1时是缺省值，为0 的话，expect将不产生任  何输出信息，或者说简单地过滤掉控制台输出。必须记住，如果你用log_user 0关闭了  控制台输出，那么你同时也就关闭了对记录文件的输出。  这一点很让人困扰，如果你确实想要记录expect的输出却不想让它在控制台上制造垃  圾的话，你可以简单地把expect的输出重定向到/dev/null：  ./test.exp > /dev/null  你可以象下面这样使用一对fork和disconnect命令。expect的disconnect命令将使得  相应的进程到后台执行，输入和输出被重定向到/dev/null：  if [fork]!=0 exit  disconnect  fork命令会产生出一个子进程，而且它产生返回值，如果返回的是0，说明这是一个子  进程，如果不为0，那么是父进程。因此，执行了fork命令之后，父进程死亡而子进程被  disconnect命令放到后台执行。注意disconnect命令只能对子进程使用。