我們通過Shell可以實現簡單的控制流功能,如:循環、判斷等。但是對於需要交互的場合則必須通過人工來干預,有時候我們可能會需要實現和交互程序如telnet服務器等進行交互的功能。而EXPect就使用來實現這種功能的工具。
Expect是一個免費的編程工具語言,用來實現自動和交互式任務進行通信,而無需人的干預。Expect的作者Don Libes在1990年開始編寫Expect時對Expect做有如下定義:Expect是一個用來實現自動交互功能的軟件套件(Expect [is a] software suite for automating interactive tools)。使用它系統管理員的可以創建腳本用來實現對命令或程序提供輸入,而這些命令和程序是期望從終端(terminal)得到輸入,一般來說這些輸入都需要手工輸入進行的。Expect則可以根據程序的提示模擬標准輸入提供給程序需要的輸入來實現交互程序執行。甚至可以實現實現簡單的BBS聊天機器人。 :)
Expect是不斷發展的,隨著時間的流逝,其功能越來越強大,已經成為系統管理員的的一個強大助手。Expect需要Tcl編程語言的支持,要在系統上運行Expect必須首先安裝Tcl。
Expect工作原理
從最簡單的層次來說,Expect的工作方式象一個通用化的Chat腳本工具。Chat腳本最早用於UUCP網絡內,以用來實現計算機之間需要建立連接時進行特定的登錄會話的自動化。
Chat腳本由一系列expect-send對組成:expect等待輸出中輸出特定的字符,通常是一個提示符,然後發送特定的響應。例如下面的Chat腳本實現等待標准輸出出現Login:字符串,然後發送somebody作為用戶名;然後等待PassWord:提示符,並發出響應sillyme。
Login: somebody Password: sillyme
這個腳本用來實現一個登錄過程,並用特定的用戶名和密碼實現登錄。
Expect最簡單的腳本操作模式本質上和Chat腳本工作模式是一樣的。下面我們分析一個響應chsh命令的腳本。我們首先回顧一下這個交互命令的格式。假設我們為用戶chavez改變登錄腳本,命令交互過程如下:
# chsh chavez
Changing the login shell for chavez
Enter the new value, or press return for the default
Login Shell [/bin/bash]: /bin/tcsh
#
可以看到該命令首先輸出若干行提示信息並且提示輸入用戶新的登錄shell。我們必須在提示信息後面輸入用戶的登錄shell或者直接回車不修改登錄shell。
下面是一個能用來實現自動執行該命令的Expect腳本:
#!/usr/bin/expect
# Change a login shell to tcsh
set user [lindex $argv 0]
spawn chsh $user
expect "]:"
send "/bin/tcsh "
expect eof
exit
這個簡單的腳本可以解釋很多Expect程序的特性。和其他腳本一樣首行指定用來執行該腳本的命令程序,這裡是/usr/bin/expect。程序第一行用來獲得腳本的執行參數(其保存在數組$argv中,從0號開始是參數),並將其保存到變量user中。
第二個參數使用Expect的spawn命令來啟動腳本和命令的會話,這裡啟動的是chsh命令,實際上命令是以衍生子進程的方式來運行的。
隨後的expect和send命令用來實現交互過程。腳本首先等待輸出中出現]:字符串,一旦在輸出中出現chsh輸出到的特征字符串(一般特征字符串往往是等待輸入的最後的提示符的特征信息)。對於其他不匹配的信息則會完全忽略。當腳本得到特征字符串時,expect將發送/bin/tcsh和一個回車符給chsh命令。最後腳本等待命令退出(chsh結束),一旦接收到標識子進程已經結束的eof字符,expect腳本也就退出結束。
決定如何響應
管理員往往有這樣的需求,希望根據當前的具體情況來以不同的方式對一個命令進行響應。我們可以通過後面的例子看到expect可以實現非常復雜的條件響應,而僅僅通過簡單的修改預處理腳本就可以實現。下面的例子是一個更復雜的expect-send例子:
expect -re "\[(.*)]:"
if {$expect_out(1,string)!="/bin/tcsh"} {
send "/bin/tcsh" }
send " "
expect eof
在這個例子中,第一個expect命令現在使用了-re參數,這個參數表示指定的的字符串是一個正則表達式,而不是一個普通的字符串。對於上面這個例子裡是查找一個左方括號字符(其必須進行三次逃逸(escape),因此有三個符號,因為它對於expect和正則表達時來說都是特殊字符)後面跟有零個或多個字符,最後是一個右方括號字符。這裡.*表示表示一個或多個任意字符,將其存放在()中是因為將匹配結果存放在一個變量中以實現隨後的對匹配結果的訪問。
當發現一個匹配則檢查包含在[]中的字符串,查看是否為/bin/tcsh。如果不是則發送/bin/tcsh給chsh命令作為輸入,如果是則僅僅發送一個回車符。這個簡單的針對具體情況發出不同相響應的小例子說明了expect的強大功能。
在一個正則表達時中,可以在()中包含若干個部分並通過expect_out數組訪問它們。各個部分在表達式中從左到右進行編碼,從1開始(0包含有整個匹配輸出)。()可能會出現嵌套情況,這這種情況下編碼從最內層到最外層來進行的。
使用超時
下一個expect例子中將闡述具有超時功能的提示符函數。這個腳本提示用戶輸入,如果在給定的時間內沒有輸入,則會超時並返回一個默認的響應。這個腳本接收三個參數:提示符字串,默認響應和超時時間(秒)。
#!/usr/bin/expect
# Prompt function with timeout and default.
set prompt [lindex $argv 0]
set def [lindex $argv 1]
set response $def
set tout [lindex $argv 2]
腳本的第一部分首先是得到運行參數並將其保存到內部變量中。
send_tty "$prompt: "
set timeout $tout
expect " " {
set raw $expect_out(buffer)
# remove final carriage return
set response [string trimright "$raw" " "]
}
if {"$response" == "} {set response $def}
send "$response "
# Prompt function with timeout and default.
set prompt [lindex $argv 0]
set def [lindex $argv 1]
set response $def
set tout [lindex $argv 2]
這是腳本其余的內容。可以看到send_tty命令用來實現在終端上顯示提示符字串和一個冒號及空格。set timeout命令設置後面所有的expect命令的等待響應的超時時間為$tout(-l參數用來關閉任何超時設置)。
然後expect命令就等待輸出中出現回車字符。如果在超時之前得到回車符,那麼set命令就會將用戶輸入的內容賦值給變臉raw。隨後的命令將用戶輸入內容最後的回車符號去除以後賦值給變量response。
然後,如果response中內容為空則將response值置為默認值(如果用戶在超時以後沒有輸入或者用戶僅僅輸入了回車符)。最後send命令將response變量的值加上回車符發送給標准輸出。
一個有趣的事情是該腳本沒有使用spawn命令。 該expect腳本會與任何調用該腳本的進程交互。
如果該腳本名為prompt,那麼它可以用在任何C風格的shell中。
% set a='prompt "Enter an answer" silence 10'
Enter an answer: test
% echo Answer was "$a"
Answer was test
prompt設定的超時為10秒。如果超時或者用戶僅僅輸入了回車符號,echo命令將輸出
Answer was "silence"
一個更復雜的例子
下面我們將討論一個更加復雜的expect腳本例子,這個腳本使用了一些更復雜的控制結構和很多復雜的交互過程。這個例子用來實現發送write命令給任意的用戶,發送的消息來自於一個文件或者來自於鍵盤輸入。
#!/usr/bin/expect
# Write to multiple users from a prepared file
# or a message input interactively
if {$argc<2} {
send_user "usage: $argv0 file user1 user2 ... "
exit
}
send_user命令用來顯示使用幫助信息到父進程(一般為用戶的shell)的標准輸出。
set nofile 0
# get filename via the Tcl lindex function
set file [lindex $argv 0]
if {$file=="i"} {
set nofile 1
} else {
# make sure message file exists
if {[file isfile $file]!=1} {
send_user "$argv0: file $file not found. "
exit }}
這部分實現處理腳本啟動參數,其必須是一個儲存要發送的消息的文件名或表示使用交互輸入得到發送消的內容的"i"命令。
變量file被設置為腳本的第一個參數的值,是通過一個Tcl函數lindex來實現的,該函數從列表/數組得到一個特定的元素。[]用來實現將函數lindex的返回值作為set命令的參數。
如果腳本的第一個參數是小寫的"i",那麼變量nofile被設置為1,否則通過調用Tcl的函數isfile來驗證參數指定的文件存在,如果不存在就報錯退出。
可以看到這裡使用了if命令來實現邏輯判斷功能。該命令後面直接跟判斷條件,並且執行在判斷條件後的{}內的命令。if條件為false時則運行else後的程序塊。
set procs {}
# start write processes
for {set i 1} {$i<$argc}
{incr i} {
set nofile 1
} else {
# make sure message file exists
if {[file isfile $file]!=1} {
send_user "$argv0: file $file not found. "
exit }}
這部分實現處理腳本啟動參數,其必須是一個儲存要發送的消息的文件名或表示使用交互輸入得到發送消的內容的"i"命令。
變量file被設置為腳本的第一個參數的值,是通過一個Tcl函數lindex來實現的,該函數從列表/數組得到一個特定的元素。[]用來實現將函數lindex的返回值作為set命令的參數。
如果腳本的第一個參數是小寫的"i",那麼變量nofile被設置為1,否則通過調用Tcl的函數isfile來驗證參數指定的文件存在,如果不存在就報錯退出。
可以看到這裡使用了if命令來實現邏輯判斷功能。該命令後面直接跟判斷條件,並且執行在判斷條件後的{}內的命令。if條件為false時則運行else後的程序塊。
set procs {}
# start write processes
for {set i 1} {$i<$argc}
{incr i} {