-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathexecute.tcl
295 lines (256 loc) · 10.5 KB
/
execute.tcl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# Copyright (C) 2011-2014 Richard Alpe <[email protected]>
#
# This file is part of 9pm.
#
# 9pm is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# 9pm is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
package provide 9pm::execute 1.0
# Wee need Expect TODO: Check if it exists (gracefull error-out)
package require Expect
namespace eval ::9pm::cmd {
# Datastructe looks like:
# data(<shell>) cmd {{cmd cmd1 checksum 1234} {cmd cmd2 checksum 4321}}
namespace eval int {
set ABORT_RESET_ATTEMPTS 3
set ABORT_GRACE_MS 10
set ABORT_RESET_GRACE_MS 100
proc gen_checksum {} {
return "[::9pm::misc::get::rand_str 10][::9pm::misc::get::rand_int 1000]"
}
proc unreg_exp_after {} {
if {![info exists ::9pm::shell::active]} {
return
}
# Unregister any existing expect_after clause for the current shell (spawn)
expect_after
}
proc reg_exp_after {} {
if {![cmd::is_running]} {
return
}
set checksum [dict get [cmd::get_last] "checksum"]
# Register expect after handler that will match the end checksum and break any expect
# block upon command completion (after first handling the users expect blocks hence,
# "after"). This is what a users expect code might look like:
#
# start "command"
# expect {
# "foo*" { lappend out $expect_out(0,string) }
# default { ::9pm::output::fail "Got eof or timeout" }
# }
# output::info "Got $out before command completion"
# finish
expect_after {
# It's important to note that we are in the caller scope here, so we need to be
# careful not to corrupt or pollute. This also means we need to use variables that
# are globally accessible.
-notransfer -re "$checksum (\[0-9]+)\r\n" {
::9pm::output::debug "Got $expect_out(1,string) as return code for\
[dict get [::9pm::cmd::int::cmd::get_last] "cmd"]"
}
}
}
namespace eval cmd {
proc is_running {} {
return [dict exists $::9pm::shell::data($::9pm::shell::active) "cmd"]
}
proc get_last {} {
return [lindex [dict get $::9pm::shell::data($::9pm::shell::active) "cmd"] end]
}
proc cnt {} {
return [llength [dict get $::9pm::shell::data($::9pm::shell::active) "cmd"]]
}
proc push {cmd checksum} {
dict lappend ::9pm::shell::data($::9pm::shell::active) "cmd" \
[dict create "cmd" $cmd "checksum" $checksum]
}
proc pop {} {
if {[cnt] == 1} {
dict unset ::9pm::shell::data($::9pm::shell::active) "cmd"
} else {
dict set ::9pm::shell::data($::9pm::shell::active) "cmd"\
[lrange [dict get $::9pm::shell::data($::9pm::shell::active) "cmd"] 0 end-1]
}
}
}
}
proc start {cmd args} {
set opts [9pm::misc::getopts $args "timeout" 10]
if {![info exists ::9pm::shell::active]} {
::9pm::fatal ::9pm::output::user_error "You need a spawn to start \"$cmd\""
}
set checksum(start) [int::gen_checksum]
set checksum(end) [int::gen_checksum]
int::cmd::push $cmd $checksum(end)
if {[int::cmd::cnt] == 1} {
::9pm::output::debug "Starting command \"$cmd\""
} else {
::9pm::output::debug "Starting nested command \"$cmd\""
}
expect *
set sendcmd "echo $checksum(start) \$\$; $cmd; echo $checksum(end) \$?\n"
if {[dict exists $opts "send_slow"]} {
set send_slow [dict get $opts "send_slow"]
send -s $sendcmd
} else {
send $sendcmd
}
expect {
-timeout [dict get $opts "timeout"]
-re "$checksum(start) (\[0-9]+)\r\n" {
::9pm::output::debug2 "\"$cmd\" started"
::9pm::output::debug2 "\"$cmd\" start checksum $checksum(start)"
::9pm::output::debug2 "\"$cmd\" end checksum $checksum(end)"
}
timeout {
::9pm::fatal ::9pm::output::fail "Timeout starting \"$cmd\""
}
eof {
::9pm::fatal ::9pm::output::fail "Got EOF while starting \"$cmd\""
}
}
int::reg_exp_after
}
proc capture {args} {
set opts [::9pm::misc::getopts $args "timeout" 10]
set out [list]
if {![info exists ::9pm::shell::active]} {
::9pm::fatal ::9pm::output::user_error "You need a spawn to capture output"
}
if {![int::cmd::is_running]} {
::9pm::fatal ::9pm::output::user_error "Can't capture output, nothing running on this shell"
}
set cmd_data [lindex [dict get $::9pm::shell::data($::9pm::shell::active) "cmd"] end]
set cmd [dict get $cmd_data "cmd"]
set checksum [dict get $cmd_data "checksum"]
::9pm::output::debug2 "\"$cmd\" capturing output unitl checksum $checksum"
expect {
-timeout [dict get $opts "timeout"]
# We use notransfer so that we leave the checksum for "finish"
-notransfer -re {([^\r\n]+)\r\n} {
set line $expect_out(0,string)
set content $expect_out(1,string)
if [regexp "$checksum (\[0-9]+)\r\n" $line unused code] {
::9pm::output::debug2 "Capture hit end checksum for \"$cmd\""
return $out
}
# Now that we know it's not the checksum, we flush it from the buffer
expect {
-re {[^\r\n]+\r\n} { }
default {
::9pm::fatal ::9pm::output::error\
"Something went wrong when flushing output from the exp buffer"
}
}
lappend out $content
::9pm::output::debug "Got: \"$content\""
exp_continue -continue_timer
}
timeout {
::9pm::fatal ::9pm::output::fail "Timeout while capturing output for \"$cmd\""
}
eof {
::9pm::fatal ::9pm::output::fail "Got EOF while waiting on return code for \"$cmd\""
}
}
}
proc finish {} {
if {![info exists ::9pm::shell::active]} {
::9pm::fatal ::9pm::output::user_error "Can't finish, no active spawn"
}
if {![int::cmd::is_running]} {
::9pm::fatal ::9pm::output::user_error "Can't finish, nothing running on this shell"
}
set last [int::cmd::get_last]
set cmd [dict get $last "cmd"]
set checksum [dict get $last "checksum"]
expect {
-re "$checksum (\[0-9]+)\r\n" {
set code $expect_out(1,string)
}
timeout {
::9pm::fatal ::9pm::output::fail "Timeout waiting for return code for \"$cmd\""
}
eof {
::9pm::fatal ::9pm::output::fail "Got eof while wating for return code for \"$cmd\""
}
}
int::cmd::pop
return $code
}
# Discard a running command, usefull when for example rebooting
proc discard {} {
set last [int::cmd::get_last]
set cmd [dict get $last "cmd"]
set checksum [dict get $last "checksum"]
::9pm::output::debug "Discarding start of \"$cmd\" ($checksum)"
int::cmd::pop
}
# Abort a running command by sending a ctrl key "key" and expecting a termination string "out"
proc abort {{key "\003"} {out {\^C}}} {
set grace $int::ABORT_GRACE_MS
if {![info exists ::9pm::shell::active]} {
::9pm::fatal ::9pm::output::user_error "Can't abort, no active spawn"
}
if {![int::cmd::is_running]} {
::9pm::fatal ::9pm::output::user_error "Can't abort, nothing running on this shell"
}
set last [int::cmd::get_last]
set cmd [dict get $last "cmd"]
set checksum [dict get $last "checksum"]
::9pm::output::debug "Aborting \"$cmd\" (discarding $checksum)"
set reset FALSE
for {set i 0} {$i < $int::ABORT_RESET_ATTEMPTS} {incr i} {
send $key
expect {
$out {
::9pm::output::debug "Successfully aborted \"$cmd\" (got \"$out\")"
}
default {
::9pm::fatal ::9pm::output::fail \
"Unable to abort \"$cmd\", didn't see \"$out\""
}
}
::9pm::misc::msleep $grace
send "echo ABORT-RESET$i\n"
expect {
-timeout 1
"\r\nABORT-RESET$i" {
set reset TRUE
break
}
default {
::9pm::output::warning "Console unresponsive after abort, trying again ($i:$grace)"
incr grace $int::ABORT_RESET_GRACE_MS
}
}
}
if {!$reset} {
::9pm::fatal ::9pm::output::fail "Unable to abort \"$cmd\", unable to reset"
}
int::cmd::pop
}
proc execute {cmd args} {
upvar ? "code"
::9pm::output::debug "Executing \"$cmd\" $args"
start $cmd
set out [capture]
set code [finish]
::9pm::output::debug "Execution of \"$cmd\" returned $code with [llength $out] lines of output"
if {([llength $args] > 0) && ([lsearch -exact $args $code] < 0)} {
::9pm::fatal ::9pm::output::fail "Got non-expected return code $code for \"$cmd\""
}
return $out
}
}