linux 遠程自動化部署
#!/usr/bin/expect -fset timeout 60 set f [open ./ip r] while { [gets $f line ] >=0 } {
set ip [lindex $line 0] #echo "開始啟動$ip的服務" spawn scp push.war panaihua@$ip:/home/panaihua/ expect "assword" send "Mz88651448\r"
spawn ssh panaihua@$ip expect "assword" send "Mz88651448\r" expect "]" send "sudo bash \r" expect "assword" send "Mz88651448\r" expect "]" send "./publish.sh \r" expect "準備啟動"
expect "*"
}
expect eof</pre>
一、概述
我們通過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腳本工作模式是一樣的。
例子:
1、實現功能
下面我們分析一個響應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。
2、下面是一個能用來實現自動執行該命令的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腳本也就退出結束。
3、決定如何響應
管理員往往有這樣的需求,希望根據當前的具體情況來以不同的方式對一個命令進行響應。我們可以通過后面的例子看到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包含有整個匹配輸出)。()可能會出現嵌套情況,這這種情況下編碼從最內層到最外層來進行的。
4、使用超時
下一個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
這是腳本其余的內容。可以看到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"
5、一個更復雜的例子
下面我們將討論一個更加復雜的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} {
spawn -noecho write
[lindex $argv $i]
lappend procs $spawn_id
}
最后一部分使用spawn命令來啟動write進程實現向用戶發送消息。這里使用了for命令來實現循環控制功能,循環變量首先設置為1,然后因 此遞增。循環體是最后的{}的內容。這里我們是用腳本的第二個和隨后的參數來spawn一個write命令,并將每個參數作為發送消息的用戶名。 lappend命令使用保存每個spawn的進程的進程ID號的內部變量$spawn_id在變量procs中構造了一個進程ID號列表。
if {$nofile==0} {
setmesg [open "$file" "r"]
} else {
send_user "enter message,
ending with ^D: " }
最后腳本根據變量nofile的值實現打開消息文件或者提示用戶輸入要發送的消息。
set timeout -1
while 1 {
if {$nofile==0} {
if {[gets $mesg chars] == -1} break
set line "$chars "
} else {
expect_user {
-re " " {}
eof break }
set line $expect_out(buffer) }
foreach spawn_id $procs {
send $line }
sleep 1}
exit
上面這段代碼說明了實際的消息文本是如何通過無限循環while被發送的。while循環中的 if判斷消息是如何得到的。在非交互模式下,下一行內容從消息文件中讀出,當文件內容結束時while循環也就結束了。(break命令實現終止循環) 。
在交互模式下,expect_user命令從用戶接收消息,當用戶輸入ctrl+D時結束輸入,循環同時結束。 兩種情況下變量$line都被用來保存下一行消息內容。當是消息文件時,回車會被附加到消息的尾部。
foreach循環遍歷spawn的所有進程,這些進程的ID號都保存在列表變量$procs中,實現分別和各個進程通信。send命令組成了 foreach的循環體,發送一行消息到當前的write進程。while循環的最后是一個sleep命令,主要是用于處理非交互模式情況下,以確保消息 不會太快的發送給各個write進程。當while循環退出時,expect腳本結束。
expect用法
1. [#!/usr/bin/expect]
這一行告訴操作系統腳本里的代碼使用那一個shell來執行。這里的expect其實和linux下的bash、windows下的cmd是一類東西。
注意:這一行需要在腳本的第一行。
2. [set timeout 30]
基本上認識英文的都知道這是設置超時時間的,現在你只要記住他的計時單位是:秒 。timeout -1 為永不超時
3. [spawn ssh -l username 192.168.1.1]
spawn是進入expect環境后才可以執行的expect內部命令,如果沒有裝expect或者直接在默認的SHELL下執行是找不到spawn命令的。所以不要用 “which spawn“之類的命令去找spawn命令。好比windows里的dir就是一個內部命令,這個命令由shell自帶,你無法找到一個dir.com 或 dir.exe 的可執行文件。
它主要的功能是給ssh運行進程加個殼,用來傳遞交互指令。
4. [expect "password:"]
這里的expect也是expect的一個內部命令,有點暈吧,expect的shell命令和內部命令是一樣的,但不是一個功能,習慣就好了。這個命令的意思是判斷上次輸出結果里是否包含“password:”的字符串,如果有則立即返回,否則就等待一段時間后返回,這里等待時長就是前面設置的30秒
5. [send "ispass\r"]
這里就是執行交互動作,與手工輸入密碼的動作等效。
溫馨提示: 命令字符串結尾別忘記加上“\r”,如果出現異常等待的狀態可以核查一下。
6. [interact]
執行完成后保持交互狀態,把控制權交給控制臺,這個時候就可以手工操作了。如果沒有這一句登錄完成后會退出,而不是留在遠程終端上。如果你只是登錄過去執行
7.$argv 參數數組
expect腳本可以接受從bash傳遞過來的參數.可以使用[lindex $argv n]獲得,n從0開始,分別表示第一個,第二個,第三個....參數
下面的expect腳本的例子
執行這個文件./launch.exp 1 2 3
屏幕上就會分別打印出參數
send_user用來發送內容給用戶。
參數運用方面還有很多技巧
比如$argc 存儲了參數個數,args被結構化成一個列表存在argv。$argv0 被初始化為腳本名字。
除此之外,如果你在第一行(#!那行)使用-d (debug參數),可以在運行的時候輸出一些很有用的信息
比如你會看見
argv[0] = /usr/bin/expect argv[1] = -d argv[2] = ./launch.exp argv[3] = 1 argv[4] = 2 argv[5] = 3
使用這些也可以完成參數傳遞
8.
expect的命令行參數參考了c語言的,與bash shell有點不一樣。其中,$argc為命令行參數的個數,$argv0為腳本名字本身,$argv為命令行參數。[lrange $argv 0 0]表示第1個參數,[lrange $argv 0 4]為第一個到第五個參數。與c語言不一樣的地方在于,$argv不包含腳本名字本身。
9.
exp_continue的用法
#!/usr/bin/expect -f
set ipaddr "localhost"
set passwd "iforgot"
spawn ssh root@$ipaddr #spawn 意思是執行命令,expect內命令,shell中不存在
expect {
"yes/no" { send "yes\r"; exp_continue}
"password:" { send "$passwd\r" }
}
expect "]# "
send "touch a.txt\r" #意思為發送命令
send "exit\r"
expect eof
exit
exp_continue可以繼續執行下面的匹配,簡單了許多。還有一點,讓我認識到匹配不見得要匹配最后幾個字符。