Expect学习笔记

作者: Badcoffee
Email: blog.oliver@gmail.com
2004年11月

原文出处: http://blog.youkuaiyun.com/yayong
版权所有: 转载时请务必以超链接形式标明文章原始出处、作者信息及本声明

        接触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的语法，请参考 aspx">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 "$login/n" }
                        "Password:" { send "$pass/n" }
                        "#" {
                                set done 0
                                send_user "/n/nLogin Successfully.../n/n"
                        }
                        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 -p/n"
        expect "#"
        send "ifconfig -a/n"
        expect "#"
        send "exit/n"
        expect "login:"

        send_user "/n/nFinished.../n/n"

}

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

        ......调试输出和程序输出.......