expect [ -dDinN ] [ -c cmds ] [ -[f|b] ] cmdfile ] [ args ]
Expectk は Expect と Tk の混合物である。 Expect であり、かつ、 Tk's wish であるかのように振舞う。 Expect は、C あるいは C++ (つまり、Tcl 以外)から、直接使うこともできる。 libexpect(3)を参照。
"Expect"という名前は、uucpで有名になった send/expect の概念に由来する。 (kermitや他のモデム制御プログラムでも、この概念は使われている) しかし、uucp とは違って Expect は一般化されているので、想像されるどんなプログラムやタスクに対しても マクロコマンド(user-level command)として機能できる。 Expect は、同時に複数のプログラムと会話することができる。
Expect にできることの例をいくつか挙げておく:
これらの処理をシェルが行なえない理由はたくさんある (やってみればわかるだろう)。全部 Expect ならできる。
一般に Expect は、プログラムとユーザーのやりとりが必要なプログラムを走らせるときに 役に立つ。大事なことは、このやりとりがプログラムの性格を持っていると いうことである。 Expect は、必要ならユーザーに制御を返すこともできる(しかも、プログラムは 中断されない)。同様に、ユーザーは制御をいつでもスクリプトに返すことができる。
#!/usr/local/bin/expect -f
と書いておいて実行させることもできる。 もちろん、パスは正確に Expect のある場所を指示していなければならない。 /usr/local/bin は、一例である。
-c フラグで、スクリプトを実行する前に、実行するコマンドを指示する。 コマンドはシェルに壊されないようにクオートしておくべきである。 このオプションは何回出てきても構わない。 複数コマンドを指示した場合は、セミコロンで連結されたコマンドのように 扱われる。 コマンドは現れた順に実行される。(Expectk では、 -command と書く)
-d フラグで、デバッグ情報出力を有効にする。基本的に 内部のコマンド(例えば expect や interact) の振舞いを報告する。 このフラグは"exp_internal 1"とスクリプトの先頭に書くのと同じことだが、 さらに Expect のバージョン番号も出力される。 ( strace コマンドは、命令をトレースするのに便利である。 trace コマンドは、変数値をトレースするのに便利である。) (Expectk を使う時は、このオプションは -diag と書く。)
-D フラグで対話型デバッガを有効にする。整数値が続かなければならない。 値が 0 でないか、C が押されると、次の Tcl 処理の前でデバッガに制御が移る。 ブレークポイントにかかった時や他のデバッグ命令を実行した時も、同じである。 デバッガについての情報がもっと欲しければ、 README や下記の関連項目を読むこと。 (Expectk を使っている時は、このオプションは -Debug)
-f フラグで、コマンドを読んでくるファイルを指示する。このフラグは あってもなくても良いのだが、#! 表記と一緒に使うと 引数からプログラム名を除けるから、その場合意味がある。 (Expectk では -file)
デフォルトでは、コマンドファイルがメモリに一度に読み込まれ、そこで実行される。 一行ずつコマンドファイルを読んだ方が望ましい場合もある。例えば、 標準入力はこのように扱った方が良い。強制的にこのモードを指定するには、 -b フラグを指定する。 (Expectkでは、 -buffer) stdio のバッファリングは依然有効であるが、FIFO または 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 が(あれば)自動的に 実行される。 (Expectk では、 -NORC) -n フラグ (Expectk では、 -norc) を用いない限り、 続いて、ファイル ~/.expect.rc が、自動的に実行される。 環境変数 DOTDIR が定義されていれば、そこが .expect.rc のあるディレクトリ として扱われる。
この二つのrcファイルの実行より先に -c フラグで指示されたコマンドが実行される。
-v フラグを指示すると、バージョン番号を表示して終了する。 (Expectkでは、-version)
オプション args は、リストに変換されて、変数 argv に保存される。 argc は、argv のリスト長(要素の数)に設定される。
argv0 は、スクリプト名に設定される(スクリプトを使っていなければ、 バイナリの名前になる)。 例えば、以下のスクリプトを実行すると、スクリプト名と最初の引数3つを表示する:
send_user "$argv0 [lrange $argv 0 2]\n"
コマンドは探しやすいようにアルファベット順に並べてある。 しかし、初めて使う方は、最初に spawn, send, expect, interact の説明をこの順番で読んだ方が分かりやすいだろう。
この言語(Expect と Tcl の両方)へのイントロダクションとしては、 "Exploring Expect"という本(関連項目を参照)がベストである。 このマニュアルページはリファレンスとして書いているので、 含まれている例は非常に限られている。注意すること。
このマニュアルページで、大文字の"E"で"Expect"とあれば、それは、
Expect
プログラムを指し、一方小文字の"e"で"expect"とあれば、それは、
Expect
プログラムに実装されている
expect
コマンドを指す。注意すること。
close [-slave] [-onexec 0|1] [-i spawn_id]
expect と interact は両方とも、カレントプロセスが exit した時点を検出して、明示しなくても close を実行する。 しかし、"exec kill $pid" などのように、あなたがプロセスを kill している なら、明示的に close を呼ぶ必要がある。
-onexec フラグを指示すると、新しい spawn が起きた時またはプロセスが重ねられた時に 前の spawn を閉じるべきかどうかを指示することができる。 前の spawn id で開いたままにしておきたければ、値 0 を用いる。 0 でない整数を指示すると、新しいプロセス中では前の spawn はクローズされる (デフォルト)。
-slave フラグを指示すると、その spawn id の抱えているスレーブの spawn もクローズする。 ("spawn -pty"を参照) コネクションがクローズされると、スレーブはオープン状態であっても クローズされる。
コネクションのクローズが明示されていたか否かに全然関わりなく、 関係するカーネルプロセススロットをクリアしてしまいたければ、 wait を呼ぶこと。 close は、 wait を呼ばない。プロセスへのコネクションをクローズすると、そのプロセスが exit するという保証がないからである。 もっと知りたければ、 wait の項を参照すること。
引数がない場合、デバッガが走っていれば 1 を、そうでなければ 0 を返す。
引数が 1 なら、デバッガが起動される。引数が 0 なら、デバッガが停止する。 引数 1 の前に -now フラグがあれば、デバッガは即座に起動される(つまり、 debug コマンドそのものの途中で)。そうでなければ、デバッガは次の Tcl コマンドから 起動される。
debug コマンドはトラップを変更しない。 -D フラグをつけて起動させた場合とはそこが違う(上記参照)。
デバッガについては、README ファイルと関連項目を参照すること。
if {[fork]!=0} exit
disconnect
. . .
以下のスクリプトは、パスワードを読んで、一時間毎にパスワードを要求する
プログラムを実行する。スクリプトはパスワードを読み込んでいるので、
タイプするのは一回だけで済む。
(パスワードのエコーを避ける方法については、
stty
コマンドを参照)
send_user "password?\ "
expect_user -re "(.*)\n"
for {} 1 {} {
if {[fork]!=0} {sleep 3600;continue}
disconnect
spawn priv_prog
expect Password:
send "$expect_out(1,string)\r"
. . .
exit
}
シェルの非同期実行(&)時に
disconnect
を用いる利点は、
Expect
が disconnect の前に端末情報を保存しておいて、後で新しい pty にそのパラメタを
適用できる点にある。
& を使っていて
Expect
が制御を受けとって disconnect されてしまうと、端末情報を読み込むことはできない。
-onexit フラグは、続く引数を exit ハンドラとして用いる。 引数がなければ、exit ハンドラは何もしない。
-noexit フラグを指定すると Expect は、exit の準備をして OS へ制御を返す直前に停止する。 ユーザーの定義した exit ハンドラは、Expect 自身の内部ハンドラと同じように 実行される。 それ以上 Expect のコマンドが実行されるべきではない。あなたが他の Tcl Extension を Expect につけている場合にこの機能は意味がある。 Expect の exit がもう一度呼び出されると(こういう場合も起こり得る)、ハンドラは処理を 返さない。
exit する際に、全ての spawn されたプロセスへのコネクションはクローズされる。 クローズは EOF 検出によって行なわれる。 exit は、普通の exit(2) が行なう以上のことはしない。 それで、spawn されたプロセスが EOF をチェックしない場合、そのプロセスは 走り続ける。(spawn されたプロセスへ送られたシグナルを判断するといったこと には複数の条件が関わってくる。これらは、システム依存であり、典型的な動作は 各システムの exit(3) のドキュメントに記述されている。)
status (指定がないときは、0 )は、 Expect の、終了ステータスとしてシステムに返される。 exit は、スクリプトの終りに達すると、書いていなくても実行される、
-info フラグは、最後に指定された info フラグでない引数の内容を返す。
-leaveopen フラグは、spawn id をオープンしたままにしておく。 wait が、その spawn id に対して実行されねばならない。
expect {
busy {puts busy\n ; exp_continue}
failed abort
"invalid password" abort
timeout abort
connected
}
4番めのパターンにはスペースが含まれているのでクオートが必要である。
アクションとパターンを分離するセパレータでないことを指示する必要がある。
(3番めと4番めの)ように同じアクションを持つリクエストも並べて書く必要が
ある。これは、正規表現パターンを用いることで回避できる(下記参照)。
グロブスタイルパターンについてもっと情報が欲しければ、Tcl のマニュアルを
読むこと。
expect {
busy {puts busy\n ; exp_continue}
-re "failed|invalid password" abort
timeout abort
connected
}
どちらのパターンのタイプも、"固定されていない"。どういう意味かというと、
文字列全体にマッチする必要はなくて、文字列のどこでもマッチすれば
良いということである。^ が先頭にマッチする。 $ が末尾にマッチする。
文字列の末尾にマッチさせなければ、spawn されたプロセスからエコーされた
文字列の途中で切り上げてレスポンスを返せることに注意すること。
正しく処理が実行されていても、出力は不自然に見える可能性がある。
それで、文字列の終りの文字を正確に記述できるなら、$ を使うことを勧める。
多くのエディタでは、^ と $ は行頭、行末に正確にマッチする。 しかし、expect は行指向ではないので、(行ではなく)データの始まりと終りに マッチする。 ("EXPECTヒント"内の、バッファリングの消化不良に関する部分を参照のこと)
-ex フラグは、"正確に(exact)"指示された文字列にマッチする。 * や ^ などの解釈は行なわれない。(ただし、通常の Tcl 展開は行なわれる)。 Exact パターンは常に固定されている。
patlist に、キーワード null を指定すると、ヌル文字が許可され ( remove_nulls コマンドを通して)、ヌル文字(ASCII 0)にマッチする。 glob や regexp では 0 バイトにマッチすることができない。
パターン(あるいは、eol, full_buffer)にマッチすると、マッチした部分の文字列か、 その前のマッチしなかった文字列が、変数 expect_out(buffer) に保存される。
9 個までのマッチした部分文字列は、変数 expect_out(1,string) から expect_out(9,string) に保存される。 -indices フラグをパターンの前で指定すると、マッチした部分文字列の 開始位置と終了位置が( lrange の引数として使える形で)、変数 expect_out(X,start) と expect_out(X,end) に保存される。 X は数字で 0 〜 9 まで。 0 はパターン全体がマッチした部分を指示する。 例えば、プロセスが"abcdefgh\n"を出力し、以下の形:
expect "cd"
で受けると、以下の文を実行したのと同じ結果となる。
set expect_out(0,string) cd
set expect_out(buffer) abcd
この時、"efgh\n"は出力バッファに残る。
プロセスが"abbbcabkkkka\n"を出力し、以下の形:
expect -indices -re "b(b*).*(k+)"
で受けると、以下の文を実行したのと同じ結果になる。
set expect_out(0,start) 1
set expect_out(0,end) 10
set expect_out(0,string) bbbcabkkkk
set expect_out(1,start) 2
set expect_out(1,end) 3
set expect_out(1,string) bb
set expect_out(2,start) 10
set expect_out(2,end) 10
set expect_out(2,string) k
set expect_out(buffer) abbbcabkkkk
この時、"a\n"は出力バッファに残る。
パターン"*" (と -re ".*")は、プロセスからのデータがさらに来ない限り、
出力バッファをフラッシュしない。
マッチした出力を送ってきたプロセスへの spawn id は、 expect_out(spawn_id) に保存される。
-timeout フラグは、この expect コマンドの中の timeout 時刻を timeout 変数でなく 指示された値に設定する。
デフォルトでは、パターンはカレントプロセスからの出力にマッチさせるのだが、 -i フラグを設定すると、指定された spawn_id リストに対応するプロセス群からの出力に マッチさせることができる。(次の -i での指定があるまで有効である。) spawn_id リストは、スペースで区切った spawn_id のリストか、そのような値を持つ 変数への参照でなくてはならない。
例えば、以下の例はカレントプロセスからの"connected"と $proc2 と言う名前の spawn_id からの"busy","failed","invalid password" を待ち受ける。
expect {
-i $proc2 busy {puts busy\n ; exp_continue}
-re "failed|invalid password" abort
timeout abort
connected
}
大域変数
any_spawn_id
の値は、
今の
expect
コマンド内で
-i
フラグを指示した spawn_id の全てにマッチさせるために使われる。
-i
フラグをパターンなしで指定すると(すなわち、別の
-i
が直後に続くと)、
any_spawn_id
で指定された、同じ
expect
コマンド内の他のパターンに対して、有効になる。
-i フラグには、グローバル変数の名前を指定することもできる。その場合、 その変数は、spawn id のリストである。変数は変わるたびに読み直される。 こうすることで、コマンドが実行されている間に I/O ソースを変更すること ができる。この方法で指定される spawn id を"間接(indirect)" spawn id と呼ぶ。
break や continue などのアクションは、制御構造(すなわち、 for,proc )内で通常通りの振舞いをする。
exp_continue コマンドは、 expect ループから抜けるような状況で実行を続けさせる。
expect {
Password: {
stty -echo
send_user "password (for $user) on $host: "
expect_user -re "(.*)\n"
send_user "\n"
send "$expect_out(1,string)\r"
stty echo
exp_continue
} incorrect {
send_user "invalid password or account\n"
exit
} timeout {
send_user "connection to $host timed out\n"
exit
} eof {
send_user \
"connection to host failed: $expect_out(buffer)"
exit
} -re $prompt
}
例えば、以下の断片は既に自動化されているユーザーガイドへのやりとりを
補助する。
この場合、端末は raw モードになる。
ユーザーが'+'を押すと変数がインクリメントされる。
"p"が押されると、プロセスへ復帰情報が送られる。
おそらくは同じように"i"が押されると、スクリプトから制御を奪い、
ユーザーからの制御が行なえる。
どの場合も
exp_continue
コマンドが、今の
expect
に、処理を行なわせた後再びパターンマッチさせている。
stty raw -echo
expect_after {
-i $user_spawn_id
"p" {send "\r\r\r"; exp_continue}
"+" {incr foo; exp_continue}
"i" {interact; exp_continue}
"quit" exit
}
expect_background アクションが、評価される時、同じ spawn id を持つ バックグラウンドプロセスはブロックされる。 アクションが完了すると、プロセスがアンブロックされる。 バックグラウンドプロセスがブロックされている間は、 (フォアグラウンドの) expect で、同じ spawn id に接続することができる。 逆に、 expect_background がブロックされていない間は expect することができない。 特定の spawn id への expect_background は、同一 spawn id への新しい expect_background を指定すると 削除される。 パターンをつけない expect_background を指定することで、バックグラウンドでパターンマッチさせること をやめさせられる。
パターンが指示されなかった場合、spawn id は どのパターンでもチェックされない。
-i フラグをさらに指定しない限り、 expect_before パターンは、 expect_before が実行された時に定義されたパターンにマッチする。
-info フラグは expect_before から、マッチパターンの現在の状態を復帰させる。 デフォルトでは、現在の spawn id に報告する。オプションの spawn id を 指定することもできる。例えば、
expect_before -info -i $proc
たった一つの spawn id 指定だけが許される。-indirect フラグで、直接
spawn id を抑止し、間接的な指定から得られるidを指示する。
spawn id を指示する代わりに、"-all"フラグを使って、 全ての spawn id に "-info" の報告をさせることができる。
-info フラグを使った時の出力結果は、expect_before への引数として 再利用できる。
set CTRLZ \032
interact {
-reset $CTRLZ {exec kill -STOP [pid]}
\001 {send_user "you typed a control-A\n";
send "\001"
}
$ {send_user "The date is [exec date]."}
\003 exit
foo {send_user "bar"}
~~
}
-re フラグは、正規表現スタイルのパターンとして文字列を解釈する。 この場合、マッチした部分文字列は interact_out に保存される。 expect が、その出力を変数 expect_out に保存するのと似たようなものである。 -indices フラグも同じようにサポートされる。
パターン eof は、end-of-file にマッチした場合にアクションを実行する。 複数に分かれた eof パターンには -output フラグが続いても良い。その場合、出力が書かれている間に eof が検出されると アクションを実行する。 eof のデフォルトアクションは"return"である。 それで、 interact は、EOF を見つけると復帰する。
timeout パターンは、(秒で表現された)タイムアウトにマッチし、アクションを実行する。 timeout パターンは、最後に指示されたプロセスに適用される。タイムアウトには デフォルトの値はない。(expect内で使われる)特殊な変数"timeout"は、 このタイムアウトと関係しない。
例えば、以下の記述は一時間以上タイプしなかったユーザーを自動的にログアウト させる。その前にシステムから頻繁にメッセージを受けとる:
interact -input $user_spawn_id timeout 3600 return -output \
$spawn_id
パターン null と nulls は、( remove_nulls コマンドを通して)、アスキーの 0 にマッチした場合にアクションを実行する。 glob や regexp で 0 バイトにマッチさせることはできない。
このパターンの前に -iwrite フラグをつけると、 変数 interact_out(spawn_id) にパターン(あるいはeof)にマッチした spawn_id が設定される。
break や continue といったアクションは、制御構造 (すなわち、 for や proc )の中で、通常通りに動く。 しかし、 return は、interact を呼出元に復帰させる。一方、 inter_return は、 interact をその呼びだし元内に復帰させる。例えば、"proc foo" は interact を呼ぶ。interact が、さらに、 inter_return を実行すると proc foo が復帰する。(これは、 interact が、 interpreter を呼んで return とタイプすると、そのinteractは継続するが、 inter_return すると、その呼出元に復帰してしまうということである。)
interact {
-echo ~g {getcurdirectory 1}
-echo ~l {getcurdirectory 0}
-echo ~p {putcurdirectory}
}
-nobuffer
フラグは、文字が読まれる度に、その文字をマッチへ送る。
このフラグは、パターンをエコーバックする時に有効である。 例えば、以下は誰かが(ヘイズモデムを)ダイアルするのを監視するのに 使われる。"atd"が見える度にスクリプトが残りのラインをログする。
proc lognumber {} {
interact -nobuffer -re "(.*)\r" return
puts $log "[exec date]: dialed $interact_out(1,string)"
}
interact -nobuffer "atd" lognumber
spawn login
set login $spawn_id
spawn tip modem
# dial back out to user
# connect user to login
interact -u $login
複数のプロセスへの出力を行なうため、
-output
フラグを前につけた各 spawn id のセットがリストされる。
出力 spawn id の組への入力は、
-input
フラグによって決定される。
(
-input
と
-output
フラグは両方とも
expect
コマンドの
-i
フラグと同じ書式である。(
interact
内の any_spawn_id は意味がない点を除く。)
以下のフラグと文字列(あるいはパターン)は全て、別の -input フラグが現れるまで
この入力を適用する。
-input
が現れなかった場合、
-output
は "-input $user_spawn_id -output"
を行なう。
(
-input
を持たないパターンも同様である。)
-input
が一つだけ指示されると、$user_spawn_id はその値で置き換わる。
二つめの
-input
が指示されると、$spawn_id が置き換わる。
以降の
-input
フラグも指定できる。
2つの入力プロセスはデフォルトで $spawn_id と $user_spawn_id に出力される。 もし、 -input フラグが -output フラグなしで指定された場合、プロセスからの文字は捨てられる。
-i フラグは、現在の spawn_id を書き換える。 ただし、 -input または -output フラグが使われていない場合である。-i フラグは -o フラグを含む。
間接 spawn id を使って会話しているプロセスを切替えることが可能である。 (間接 spawn id は、expect コマンドの項で説明した) 間接 spawn id は、-i, -u, -input, -output フラグで指定できる。
ファイル名の代わりに、Tcl ファイル識別子を指定すると、 -open や -leaveopen フラグが使える。 spawn コマンドと同様だ(より詳しくは、 spawn を参照)
-a フラグは、 log_user コマンドによって抑止されたログに出力を強制するものである。
デフォルトでは、 log_file コマンドは古い記録を消して書き直したりせずに 追記 する。 ログオフや複数のログを書く時に都合が良いように。 ファイルを消して書き直す時は -noappend フラグを使う。
-info フラグは、最後にログした内容を返す(最後が-infoフラグ付きだったら、 その前の内容)。
-info フラグは、最後にログした内容を返す(最後が -info フラグ付きだったら、 その前の内容)。
overlay -0 $spawn_id -1 $spawn_id -2 $spawn_id chess
これは、
"interact -u"
とするよりも効果的である。しかし、
Expect
プロセスが制御していないのでプログラム能力が犠牲となる。
ヌルを取り除くかどうかによらず、 Expect は、ログと標準出力にはヌルが記録される。
send "hello world\r"
は、文字 h e l l o <blank> w o r l d <return> を現在のプロセスに
送る。
(Tcl は、printf に似たコマンド (
format
と呼ばれる )を持っていて、複雑な文字列を組み立てることができる。)
-- フラグは、続く引数をフラグと解釈せず文字列として解釈される。 全体としてフラグに見えなくても"--"が前についた文字列はフラグとして 扱われてしまう。このフラグは処理されていない文字列がフラグとして 扱われるのを防ぐ。 ("-"で始まる文字は全て将来のオプションとして予約されている。)
-i フラグは、名前つきの spawn_id に文字列を送ることを宣言する。 その spawn_id が user_spawn_id であれば、端末はraw モードに入り、文字列中の改行が復帰改行シーケンスに 変換される。それで、外からは 端末が cooked モードとなっているように 見える。 -raw フラグは、この変換を抑止する。
-null フラグは、ヌル文字を送る(0 バイト)。デフォルトでは、ヌル文字を 1つ送る。 -null に続く整数はヌル文字をいくつ送るかを指示する。
-break フラグは、ブレーク状態を作る。spawn id が"spawn -open"で指示した tty デバイスを参照する場合のみ意味がある。tip などのプロセスを spawn する場合、tip の都合で ブレーク状態を作るべきである。
-s フラグは、出力を強制的に"遅く"する。結果、コンピュータが打ち込んでいる バッファに人間が打ち込んでしまう状況を避けることができる。この出力は 変数"send_slow"の値で制御される。この変数は二つの要素を持つリストである。 最初の要素は、アトミックに送るバイト数である。2 番めの要素はアトミックに送る 間隔(秒)である。例えば、 "set send_slow {10 .001}" は "send -s" に 10 文字送る毎に1ミリ秒待つように指示する。
-h フラグは、人間の実際の入力に似せて send を行なう。(アルゴリズムは、 Weibull distribution に基づいていて、この特定のアプリケーション Expect? に 合わせるための修正が行なわれている。) この出力は変数"send_human"の値で制御されていて、この変数は 5 つの要素から なるリストで最初の 2 つの要素は文字間の平均インターバル時間(秒)である。 1 つめがデフォルト値で、2 つめが(通常発生する微妙な待ち時間を表現する) 単語の終りの値である。3 つめの要素は変動率である。 可能な値は 0 から 無限大である。最後の 2 つのパラメタは、それぞれ、 インターバル時間の最小値と最大値である。この 2 つの値は最後に使われて、 最終時刻をクリップする。この 2 値が違うと究極の平均は与えられた平均とは、 全く違ったものになる。
例として、続くコマンドが一定の速度で速く打つタイピストを エミュレートする:
set send_human {.1 .3 1 .05 2}
send -h "I'm hungry. Let's do lunch."
ハングさせてしまった後は、以下のようにした方が良いだろう。:
set send_human {.4 .4 .2 .5 100}
send -h "Goodd party lash night!"
send にエラーや修正を埋め込んであっても、
エラーはシミュレートされない点に注意すること。
ブレークを送るためや、ゆっくりした出力を行なったり、人間が出力したように 見せかけるためにヌル文字を送るフラグは相互排他される。 最後に指定されたものだけが使われる。それ以上は、 string の引数が、ヌル文字あるいはブレークを送るフラグとして指定できる。
最初の send より前に expect を置いた方が良い。 expect は、プロセスが始まるのを待てるが、 send は待てない。 特に、最初の send は、プロセスが走り始める前に完了する。あなたのデータが無視される 危険がある。 最初にプロンプトを表示しないような対話的なプログラムでは、 次のように send の前にディレイをつけることができる:
# どのように破るかのヒントをハッカーに与えてしまわないように、
# このシステムでは外部のパスワードに対するプロンプトを提供しない。
# exec が完了するのを 5 秒待て。
spawn telnet very.secure.gov
sleep 5
send password\r
exp_send
は
send
のエイリアスである。あなたが Expectk か、Tk 環境で動く Expect の他の変種を
使っている場合、
send
は、全く異なった目的のために使われている。
exp_send
が、両環境の間での互換性のために提供されている。
似たようなエイリアスが他の Expect の他の send コマンドのために提供されている。
error_spawn_id は、標準エラー出力を参照する識別子の入ったグローバル変数である。 例えば、 spawn_id が、この値に設定された場合、 send は、 send_error のような動きをする。
if {[info vars tty_spawn_id]} {
# /dev/tty exists
} else {
# /dev/tty doesn't exist
# probably in cron, batch, or at script
}
内部的に、 spawn は pty を使い、ユーザーの tty と同じように初期化される。これは、かなり 初期化してしまうので全ての設定が (stty(1)によると) "正常(sane)" になる。 変数 stty_init が定義されていると、stty の引数の形式を解釈できるので、より詳細な設定を 行なえる。例えば、 "set stty_init raw" は、以降 spawn されたプロセスの端末を raw モードで開始する。 -nottycopy は、ユーザーの tty に基づいた初期化を飛ばす。 -nottyinit は、"正常な"初期化を飛ばす。
exec(2)が失敗して program が spawn に成功しなかった場合 (例えば、 program がなかった場合など)、エラーメッセージが次の interact か expect コマンドで復帰する。つまり。 program が、出力としてエラーメッセージを出しているように見せる。 この動作は、 spawn の実装の自然な帰結である。内部で、spawn がフォークされ、その後、 spawn されたプロセスがオリジナルの Expect プロセスとその spawn_id で会話を行なう。
-open フラグは、次の引数を Tcl ファイル識別子として解釈する(つまり、 open を行なって復帰する。 ) spawn id は、spawn された id として使われる。(ファイル識別子は、 もう使うべきではない。) これにより、 pty を除く、raw デバイス、ファイル、パイプラインを使うことができる。 0 が返ってくるのは、関連するプロセスがなかった時である。 spawn されたプロセスへの接続がクローズされると、Tcl ファイル識別子も クローズされる。 -leaveopen フラグは、 -open と似た動きをするが、 spawn id をクローズした後もファイル識別子を開いたままにする点が違う。
-pty フラグは、 pty をオープンするがプロセスをspawnしない。0 が復帰するのは、 関連するプロセスがない場合である。spawn_id は、通常通り設定される。
変数 spawn_out(slave,fd) には、pty スレーブとつながっているファイル識別子が設定される。 "close -slave" で close できる。
-ignore フラグは、spawn されたプロセス中で無視されるシグナルの名前を指示する。 なければ、シグナルはデフォルトの振舞いをする。シグナルの名前は trap コマンドで使う名前と同じである。各シグナルを分離するのにフラグが 必要な点を除いては。
expect -c "strace 4" script.exp
-info フラグを指定すると、strace は最後の info でない指定の内容を復帰する。
デフォルトでは、制御している端末がアクセスされる。他の端末は、 "< /dev/tty..." を追加することでアクセスできる。(引数を一つの引数に まとめるべきではない。)
ステータス要求はコマンドの結果としてステータスを復帰する。 ステータスが要求されずに制御している端末にアクセスする場合、直前の raw と echo の状態を返す。
例えば、引数 raw か -cooked は、端末を raw モードに設定する。 引数 -raw か cooked は、端末を cooked モードに設定する。 引数 echo か -echo は、端末をそれぞれ echo あるいは noecho モードに設定する。
stty -echo
send_user "Password: "
expect_user -re "(.*)\n"
set password $expect_out(1,string)
stty echo
-format フラグは、文字列が続くが、その文字列に POSIX の strftime のルールに従って置換がかかる。 例えば、 %a は曜日(すなわち、Sat)とか。他は以下の通りである。:
%a 略記された曜日の名前
%A 略されない曜日の名前
%b 略記された月の名前
%B 略されない月の名前
%c 次の形式で書かれた時刻: Wed Oct 6 11:45:56 1993
%d 日 (01-31)
%H 時 (00-23)
%I 時 (01-12)
%j 日 (001-366)
%m 月 (01-12)
%M 分 (00-59)
%p am または pm
%S 秒 (00-61)
%u 日 (1-7, 月曜日が週の最初の日)
%U 週 (00-53, 最初の日曜日が第1週の最初の日)
%V 週 (01-53, ISO 8601 スタイル)
%w 日 (0-6)
%W 週 (00-53, 最初の月曜日が第1週の最初の日)
%x date-time as in: Wed Oct 6 1993
%X time as in: 23:59:59
%y year (00-99)
%Y year as in: 1993
%Z timezone (or nothing if not determinable)
%% a bare percent sign
この他の % 指定は定義されていない。他の文字は変更されない。
C ロカールだけがサポートされる。
-seconds フラグは、 タイムスタンプを秒で表す。
-gmt GMT タイムゾーンで出力する。デフォルトはローカルタイムゾーンである。
引数がなければ(または、引数 -number であれば)、 trap は、trapコマンドで横取りされているシグナル番号を復帰する。
-code フラグはコマンドコードを返す。Tcl がコマンドを動かし始めた時に 帰そうとしたコードである。
-interp フラグは、trap が宣言された時でなくコマンドが開始された時にインタプリタに コマンドを評価させる。
-name フラグは、 trap コマンドに trap のかかっているシグナル名を帰す。
-max フラグは、 trap コマンドに設定できる最も大きなシグナル番号を帰す。
例えば、"trap {send_user "Ouch!"} SIGINT" は、 ユーザーが ^C を押す度に "Ouch!" を表示する。
デフォルトでは、SIGINT(通常 ^C を押すと発生する)や SIGTERM は、Expect を exit させてしまう。これは、Expect が起動時に 実行する以下の trap によって起こっている。
trap exit {SIGINT SIGTERM}
-Dフラグを使ってデバッガを起動するなら、SIGINT が再定義されてから対話型
デバッガが起動される。これは以下の trap によって起こる。
trap {exp_debug 1} SIGINT
デバッガのトラップは、環境変数 EXPECT_DEBUG_INIT を設定して、新しく
trap を起動することで変更できる。
もちろん、スクリプトにtrapコマンドを足すだけで例のトラップは両方とも 上書きできる。特に、自作の "trap exit SIGINT" があるなら、これは デバッガのトラップを上書きしてしまう。ユーザーにデバッガを全く 触らせないようにするのに、便利である。
SIGINT のトラップを独自に定義したいけれど、デバッガにも同時に割り込んで もらいたいのであれば、こう書く。:
if ![exp_debug] {trap mystuff SIGINT}
代わりに、別のシグナルを使ってデバッガに割り込みをかけることができる。
trap は、SIGALRM のアクションを上書きしない。 Expect が内部で使用しない。 disconnect コマンドは、SIGALRMを SIG_IGN (ignore)に設定する。 後から発行される spawn コマンドを実行している間、SIGALRM は ディスエーブル中であれば再度イネーブルにできる。
もっと情報が欲しい場合、signal(3) を参照すること。
追加の要素が wait の復帰値に加わっても構わない。オプションの5つめの要素は、情報クラスの 識別子である。今のところ、この要素の唯一可能な値は CHILDKILLED で、 その場合、次の二つの値が C スタイルのシグナル名と短い文書による記述である。
-nowait フラグを指定すると、wait が成功の復帰値で即時復帰する。 (あとで)そのプロセスが exit すると、自動的に後始末が行なわれ、明示的に wait する必要がない。
wait コマンドは、引数に "-i -1" を指定することによって、 fork したプロセスを待つためにも使われる。 spawn したプロセスに用いられる場合と異なり、 このコマンドはいつでも実行できる。 どのプロセスを待つかを制御することは出来ないが、 返り値はプロセス ID としてチェックできる。
exp_library には、アーキテクチャに依存しないファイルが格納される。 exp_exec_library には、アーキテクチャに依存するファイルが格納される。 あなたのシステムによっては、両方のディレクトリが空という場合もあり得る。 ファイル $exp_exec_library/cat-buffers の存在は、あなたのシステムの /bin/cat がデフォルトでバッファリングされているかどうかに左右される。
vgrind -lexpect file
Expect の論文も役に立つ(関連項目参照)。いくつかは、初期バージョンの Expect の 文法を使っているが、それとともにある根本的な考えは、なお有効であり、 このマニュアルページより詳細に書かれている。
Expect は、かなり自由なスコープを持っている。特に、 Expect プログラムで指定したコマンドにより読み込ませる変数は、そのローカルスコープ 内でまず探索され、見つからなければ、グローバルスコープで探索される。 例えば、こうすることで expect を使う全てのプロシジャに "global timeout" を書く必要が なくなる。 逆に、プロシジャ内に書かれた変数は全てローカルスコープ内に設定される。 ("global"コマンドを指定しない限りは)。この動作が引き起こすもっとも共通した 問題は、spawn がプロシジャ内で実行された時である。プロシジャの外では、 spawn_id はスコープのため、もはや存在しないので spawn されたプロセスは単純には アクセス不能となる。そのようなプロセスには、"global spawn_id"を 付け加えねばならない。
multi-spawn 機能が使えない(つまり、あなたのシステムが select (BSD *.*), poll (SVR>2),または、それと等価なもの のいずれも サポートしていない)場合、 Expect は、同時に 1 プロセスしか制御できない。 この場合、 spawn_id を無理に設定したり、spawn されたプロセスが走っている間に exec を使って プロセスを実行したりしてはならない。さらに、複数のプロセス(片方が ユーザーでも)から同時に expect することもできない。
端末制御パラメタは、スクリプトに大きな影響を与える。例えば、 スクリプトがエコーを探すように書かれていれば、エコーをオフにすると 動作がおかしくなる。この理由で、Expect はデフォルトで 正気の 端末パラメタを設定する。不幸なことに、この設定が他のプログラムではまずい 場合がある。例えば、emacs シェルは"通常の"マッピングを変更しようとする。 : newlinesは、carriage-return newlines に変換されず newlines にマップされる。 そして、エコーは行なわれない。こうマップされることで、emacs は入力行を 編集できる。残念ながら、Expect はこのマッピングを検出できない。
Expect が端末パラメタのデフォルト設定を上書きしないように指定することが できるが、そういった環境で動かすスクリプトを書くときは細心の注意が 必要である。emacs の場合、エコーや改行コードのマッピングを回避しなければ ならない。
( expect とその変種、および、 interact といった)1 つのリストにブレースされた引数を受けとるコマンドは、 リストが引数をどれだけ持っているのかを判断するのに、発見的手法を用いる。 その発見的手法はが失敗する唯一の場合は、引数の一つに複数の\nが埋め込まれ、 その間にホワイトスペースがない場合である。これは十分検出不能な状態だが、 引数"-nobrace" で、強制的に一つの引数として扱うことができる。 自動的に生成された Expect コード中で使われるかもしれない。 同様に、-brace は複数のパターン/アクションをひとつの引数として扱うことを 強制する。
シェルが spawn されるとttyにアクセスできないと文句をいって、しかし、動作はする というシステムがある。これは、このシステムがtty制御を得るための機構を 持っているが Expect はそれを知らないという意味である。どういう仕組みか調べて、その情報を私に 知らせてほしい。
Ultrix 4.1 (少なくとも最新バージョンのあたり) では、 1000000 を超えるタイムアウトを 0 とみなしてしまう。
Digital UNIX 4.0A (おそらく他のバージョンも)は SIGCHLD ハンドラを 定義すると、pty の割り付けを拒否する。詳細は grantpt ページを参照のこと。
IRIX 6.0 は、pty へのアクセス制御を正確に扱えない。それで、 Expect は、pty がアロケートできない場合は、他の人が前に使った pty の アロケートを試みる。 IRIX 6.1 にアップグレードすること。
telnet (SunOS 4.1.2 でのみ確認)は、TERM が設定されてないと ハングする。この問題は cron や at や CGI スクリプトで使う時に問題だ (設定しないので)。それで、 明示的に指定しなくてはならない - 本当のタイプは通常関係ない。 何かに設定してないと駄目なのだ! 以下の記述はおそらくほとんどの場合を 満足させるだろう。
set env(TERM) vt100
tipt (BSDI BSD/OS 3.1 i386 でのみ確認)は、SHELL と HOME が設定されてないと ハングする。この問題は cron や at や CGI スクリプトで使う時に問題だ (設定しないので)。それで、 明示的に指定しなくてはならない - 本当のタイプは通常関係ない。 何かに設定してないと駄目なのだ! 以下の記述はおそらくほとんどの場合を 満足させるだろう。
set env(SHELL) /bin/sh
set env(HOME) /usr/local/bin
pty のインプリメントの中には、プロセスがファイル記述子をクローズした後、 読んでない出力を 10 から 15 秒後(この値はインプリメントに依存)に投げてくる ものがある。それゆえ、
spawn date
sleep 20
expect
のような
Expect
プログラムは失敗する。失敗しないように非対話的なプログラムでは
spawn
せずに
exec
すること。こういう状況は考えられるが、実際には私はまだその状態に
陥ったことがない。つまり、この原因で対話プログラムの最後の出力を
取りこぼすという状態になったことがない。
一方、Cray UNICOS の pty は読み込んでいない出力をファイルディスクリプタを プロセスが閉じるとすぐに投げてくる。私は Cray にこの動きについて報告し、 回避するための修正を行なった。
プロンプトと応答の間にディレイが必要な場合がある。tty インターフェースが UART の設定を変えたり、スタート/ストップビットを探してボーレートを合わせて いる時などである。通常、ここで必要とされているものは 1 秒か 2 秒の待ち合わせである。 もっとしっかりしたやり方はハードウェアが入力を受ける準備ができるまで繰り返す ことである。以下の例は、両方の戦略を採用している。:
send "speed 9600\r";
sleep 1
expect {
timeout {send "\r"; exp_continue}
$prompt
}
-code をトラップするのは Tcl のイベントループに依存しているコマンド (sleep など)では動かない。 問題は、イベントループの中では Tcl は非同期イベントハンドラからの 返り値を捨てているからである。 回避方法としては、トラップコードでフラグをセットし、 コマンド(sleep など)の直後でフラグをチェックすることである。
共通の expect の問題は、シェルプロンプトを認識する方法である。 その設定も、それを扱う人も、使うシェルもまちまちなので、実際に出てくる プロンプトを知らずに、汎用的に rlogin を自動化することは困難である。 妥当な線は、ユーザーにプロンプトにマッチする正規表現(特にプロンプトの 終りの部分)を環境変数 EXPECT_PROMPT に保存させることである。 以下のようなコードでできる。 EXPECT_PROMPT がなくても、コードは正しく動く可能性がある。
set prompt "(%|#|\\$) $" ;# default prompt
catch {set prompt $env(EXPECT_PROMPT)}
expect -re $prompt
私としては、見えると思っているものの終りの部分を含んだ
expect
パターンを書くように勧める。そうすれば、全体を見る前に応答を返してしまう
ことを避けることができる。さらに、全体が見える前に答えることもできるが
その文字は質問に混ざって echo される。言い替えれば、会話は正常だが見た目は
混ざって見える。
ほとんどのプロンプトの終りの文字はスペースである。例えば、 ftpからのプロンプトは、'f', 't', 'p', '>' そして <blank> である。 このプロンプトにマッチさせるには、この文字の一つ一つにマッチしなければ ならない。blank を含めないのは、よくある誤りである。明示的に blank を 入れるように。
X* の形のパターンを使うのであれば、* はXから最後に受けとる何かまでの 全てにマッチする。これは一見直観的だが、"最後に受けとる何か"が コンピュータの速度とカーネルとデバイスドライバによるI/O処理によって 変わってしまうので混乱するだろう。
特に、人間はプログラムの出力が巨大なひとまとまりとしてやってくると思いがち だが、実際には、ほとんどのプログラムは一行を一度に送る。 こう仮定すると、直前の段落のパターンにあった * は、行の終りにしか マッチしないかも知れない。たとえ、もっと入力があると思われる場合でも 出力を全て受けとった時点でしかマッチを行なわないのである。
expect は、指定したパターンが教えてくれない限り、出力がさらにやってくるのか どうかわからない。
行指向のバッファリングを行なっている場合ですら、賢いやり方とはいえない。 プログラムはバッファリングのタイプをめったに保証しないだけでなく、その際に 消化不良を起こして出力行を中断し、行末をバッファ中のランダムな位置に 置いてしまう。 それで、パターンを書く時には、プロンプトの最後の何文字かを入れておいた方が 賢いやり方といえるのである。
プログラムの最後の出力にあるパターンを待ち、実際には何がしか他のものが 発行されている場合には timeout キーワードで判定することができない。理由は、 expect が、タイムアウトしない - そのかわりに eof を見つけられる - からである。 代わりになるものを使うこと。もっと良いのは、両方使うことだろう。 行が回り込んだ場合でも、行そのものを編集するべきではない。
tty ドライバによって出力される時に newline は、普通 carriage return, linefeed の組に変換される。 それで、2 ラインにマッチするには、例えば、printf("foo\nbar") に マッチさせるには、"foo\r\nbar" というパターンを使うことになる。
似たような変換は、ユーザーから expect_user を通して入力を読み込む時にも起こる。この場合、ユーザーがリターンを 押すと、それは newline に変換される。その後、 Expect が端末モードを raw モード(telnet のような)を設定すると、問題が発生する 可能性がある。プログラムが本当のリターンを待ってしまうからである。(プログラムの 中には、newline をリターンに変えても大丈夫なものもあるが、ほとんどはだめである。) 残念ながら、プログラムが端末を raw モードにすることを検出する方法がない。
手で newline をリターンに変えるのではなく、"stty raw"を使うのが解決策である。 stty raw は、変換を停止する。しかし、こうすると cooked モードの行編集機能が 使えなくなるということに注意すること。
interact は、端末を raw モードに設定するので、この問題は発生しない。
Expect スクリプトの中でパスワード(や他の機密情報)を保存すると便利なことは よくある。だれかのアクセスを受けるとその影響を受けてしまうコンピュータで そういうことをするのは勧められない。それで、パスワードのプロンプトを スクリプトから出すのが、文字通りパスワードを埋め込むよりは、良い考えと いえる。とはいうものの、そういった埋め込みをするしかない場合もある。
不幸なことに、UNIX のファイルシステムは「実行可能で読めない」スクリプトを 作る直接の方法がない。setgid シェルスクリプトをサポートしたシステムでは、 次のようにすることで間接的にシミュレートできる。
,
Expect
スクリプト(機密情報の入った)を普通に作る。
そのパーミッションを 750 (-rwxr-x---) に設定し、trusted group
つまり、読んでも良いグループ の所有とする。必要なら、この目的のための
新しいグループをつくること。次に、/bin/sh スクリプトを パーミッション
2751 (-rwxr-s--x) で、同じグループの所有で作成する。
こうすると、シェルスクリプトはだれからも実行でき(かつ、読め)る。 実行すると、それは Expect スクリプトを実行する。
Tcl(3),
libexpect(3)
"Exploring Expect: A Tcl-Based Toolkit for Automating Interactive Programs"
by Don Libes, pp. 602, ISBN 1-56592-090-2, O'Reilly and Associates, 1995.
"expect: Curing Those Uncontrollable Fits of Interactivity" by Don Libes,
Proceedings of the Summer 1990 USENIX Conference,
Anaheim, California, June 11-15, 1990.
"Using
expect
to Automate System Administration Tasks" by Don Libes,
Proceedings of the 1990 USENIX Large Installation Systems Administration
Conference, Colorado Springs, Colorado, October 17-19, 1990.
"Tcl: An Embeddable Command Language" by John Ousterhout,
Proceedings of the Winter 1990 USENIX Conference,
Washington, D.C., January 22-26, 1990.
"expect: Scripts for Controlling Interactive Programs" by Don Libes,
Computing Systems, Vol. 4, No. 2, University of California Press Journals,
November 1991.
"Regression Testing and Conformance Testing Interactive Programs", by Don
Libes, Proceedings of the Summer 1992 USENIX Conference, pp. 135-144,
San Antonio, TX, June 12-15, 1992.
"Kibitz - Connecting Multiple Interactive Programs Together", by Don Libes,
Software - Practice & Experience, John Wiley & Sons, West Sussex, England,
Vol. 23, No. 5, May, 1993.
"A Debugger for Tcl Applications", by Don Libes,
Proceedings of the 1993 Tcl/Tk Workshop, Berkeley, CA, June 10-11, 1993.
Don Libes, National Institute of Standards and Technology
HISTORY ファイルに expect の進化の大部分が記述されている。このファイルは面白く読めて、かつ、 あなたのこのソフトウェアへの洞察をより深くするだろう。このファイルに 書かれている、私にバグフィックスを送ってくれた人たちや、他の援助を してくれた人たちに感謝する。
Expect の設計と実装は、部分的にアメリカ政府からその対価をもらっているので、 パブリックドメインである。しかし、このプログラムとドキュメントあるいは その一部が使われたなら、著者と NIST への謝辞を述べてもらいたい。