-
Notifications
You must be signed in to change notification settings - Fork 111
/
shutit_sendspec.py
263 lines (246 loc) · 14.8 KB
/
shutit_sendspec.py
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
from __future__ import print_function
import logging
class ShutItSendSpec(object):
"""Specification for arguments to send to shutit functions.
"""
def __init__(self,
shutit_pexpect_child,
send=None,
send_dict=None,
expect=None,
timeout=None,
check_exit=None,
fail_on_empty_before=True,
record_command=True,
exit_values=None,
echo=None,
escape=False,
check_sudo=True,
retry=3,
note=None,
assume_gnu=True,
follow_on_commands=None,
searchwindowsize=None,
maxread=None,
delaybeforesend=None,
secret=False,
nonewline=False,
user=None,
password=None,
is_ssh=None,
go_home=True,
prompt_prefix=None,
remove_on_match=None,
fail_on_fail=True,
ignore_background=False,
run_in_background=False,
block_other_commands=True,
wait_cadence=2,
loglevel=logging.INFO):
"""Specification for arguments to send to shutit functions.
@param send: String to send, ie the command being issued. If set to
None, we consume up to the expect string, which is useful if we
just matched output that came before a standard command that
returns to the prompt.
@param send_dict: dict of sends and expects, eg:
{'interim prompt:',['some input',False],'input password:':['mypassword',True]}
Note that the boolean indicates whether the match results in the removal of the send dict expects from the interaction and assumes a prompt follows.
@param expect: String that we expect to see in the output. Usually a
prompt. Defaults to currently-set expect string (see
set_default_shutit_pexpect_session_expect)
@param shutit_pexpect_child: pexpect child to issue command to.
@param timeout: Timeout on response
@param check_exit: Whether to check the shell exit code of the passed-in
command. If the exit value was non-zero an error is thrown.
(default=None, which takes the currently-configured check_exit
value) See also fail_on_empty_before.
@param fail_on_empty_before: If debug is set, fail on empty match output
string (default=True) If this is set to False, then we don't
check the exit value of the command.
@param record_command: Whether to record the command for output at end.
As a safety measure, if the command matches any 'password's then
we don't record it.
@param exit_values: Array of acceptable exit values as strings
@param echo: Whether to suppress any logging output from pexpect to the
terminal or not. We don't record the command if this is set to
False unless record_command is explicitly passed in as True.
@param escape: Whether to escape the characters in a bash-friendly way, eg $'\\Uxxxxxx'
@param check_sudo: Check whether we have sudo available and if we already have sudo rights
cached.
@param retry: Number of times to retry the command if the first attempt
doesn't work. Useful if going to the network
@param note: If a note is passed in, and we are in walkthrough mode,
pause with the note printed
@param assume_gnu: Assume the gnu version of commands, which are not in
@param follow_on_commands: A dictionary of the form: {match_string: command, match_string2: command2}
which runs commands based on whether the output matched.
Follow-on commands are always foregrounded and always ignore backgrounded processes.
@param searchwindowsize: Passed into pexpect session
@param maxread: Passed into pexpect session
@param delaybeforesend: Passed into pexpect session
@param secret: Whether what is being sent is a secret
@param nonewline: Whether to omit the newline from the send
@param user: If logging in, user to use. Default is 'root'.
@param password: If logging in, password to use. Default is 'root'.
@param is_ssh: Indicates whether the login is an ssh one if it is not an ssh command
@param go_home: On logging in, whether to go to the home dir. Default is True.
@param prompt_prefix: Override of random prompt prefix created by prompt setup.
@param remove_on_match: If the item matches, remove the send_dict from future expects (eg if
it's a password). This makes the 'am I logged in yet?' checking more robust.
@param ignore_background: Whether to block if there are background tasks
running in this session that are blocking, or ignore ALL
background tasks and run anyway. Default is False.
@param run_in_background: Whether to run in the background
@param block_other_commands: Whether to block other commands from running
(unless ignore_background is set on those other commands).
Default is True.
@param wait_cadence: If blocked and waiting on a background tasks, wait this
number of seconds before re-checking. Default is 2.
@param loglevel: Log level at which to operate.
Background Commands
===================
+------------------+-------------------+----------------------+------------------------------------------+
|run_in_background | ignore_background | block_other_commands | Outcome |
+------------------+-------------------+----------------------+------------------------------------------+
|T | T | T | 'Just run in background and queue others'|
| | | | Runs the command in the background, |
| | | | ignoring all blocking background tasks |
| | | | even if they are blocking, and blocking |
| | | | new background tasks (if they don't |
| | | | ignore blocking background tasks). |
+------------------+-------------------+----------------------+------------------------------------------+
|T | F | T | 'Run in background if not blocked, and |
| | | | queue others' |
| | | | Runs the command in the background, |
| | | | but will block if there are blocking |
| | | | background tasks running. It will block |
| | | | new background tasks (if they don't |
| | | | ignore blocking background tasks). |
+------------------+-------------------+----------------------+------------------------------------------+
|T | F | F | 'Run in background if not blocked, and |
| | | | let others run' |
+------------------+-------------------+----------------------+------------------------------------------+
|F | T | N/A | 'Run in foreground, ignoring any |
| | | | background commands and block any new |
| | | | background commands.' |
+------------------+-------------------+----------------------+------------------------------------------+
|F | F | N/A | 'Run in foreground, blocking if there are|
| | | | any background tasks running, and |
| | | | blocking any new background commands.' |
+------------------+-------------------+----------------------+------------------------------------------+
Example
=======
Scenario is that we want to:
update the file database with 'updatedb'
then find a file that we expect to be in that database with 'locate file_to_find'
and then add a line to that file with 'echo line >> file_to_find'
Statement: I want to run this command in the background in this ShutIt session.
I want to stop other background commands from running.
I don't care if other background commands are running which block this.
Example send: updatedb
Args: run_in_background=True, ignore_background=True, block_other_commands=True
Statement: I want to run this command in the background in this ShutIt session.
I want to stop other background commands from running.
I don't want to run if other blocking background commands are running.
Example send: locate file_to_find
Args: run_in_background=True, ignore_background=False, block_other_commands=True
Statement: I just want to run this command in the background in the ShutIt session and forget about it.
I don't care if there are other background tasks running which block this.
I don't want to block other commands, nothing will depend on this completing.
Example send: echo 'Add line to file' >> /path/to/file_to_find
Args: run_in_background=True, ignore_background=True, block_other_commands=False
"""
self.send = send
self.original_send = send
self.send_dict = send_dict
self.expect = expect
self.shutit_pexpect_child = shutit_pexpect_child
self.timeout = timeout
self.check_exit = check_exit
self.fail_on_empty_before = fail_on_empty_before
self.record_command = record_command
self.exit_values = exit_values
self.echo = echo
self.escape = escape
self.check_sudo = check_sudo
self.retry = retry
self.note = note
self.assume_gnu = assume_gnu
self.follow_on_commands = follow_on_commands
self.searchwindowsize = searchwindowsize
self.maxread = maxread
self.delaybeforesend = delaybeforesend
self.secret = secret
self.nonewline = nonewline
self.loglevel = loglevel
self.user = user
self.password = password
self.is_ssh = is_ssh
self.go_home = go_home
self.prompt_prefix = prompt_prefix
self.remove_on_match = remove_on_match
self.fail_on_fail = fail_on_fail
self.ignore_background = ignore_background
self.run_in_background = run_in_background
self.block_other_commands = block_other_commands
self.wait_cadence = wait_cadence
# BEGIN Setup/checking
self.started = False
if self.check_exit and self.run_in_background:
self.check_exit = False
#if send_dict and run_in_background:
#assert False, shutit_util.print_debug()
# END Setup/checking
# send_dict can come in with items that are: val:string, or val:[string,boolean]
# ensure they end up as the latter, defaulting to false.
if self.send_dict is not None:
assert isinstance(self.send_dict, dict), shutit_util.print_debug()
for key in self.send_dict:
val = self.send_dict[key]
assert isinstance(val,(str,list)), shutit_util.print_debug()
if isinstance(val,str):
self.send_dict.update({key:[val,False]})
elif isinstance(val,list):
assert len(val) == 2, shutit_util.print_debug()
else:
assert False, shutit_util.print_debug(msg='send_dict check should not get here')
if self.exit_values is None:
self.exit_values = ['0',]
def __str__(self):
string = '\n---- Sendspec object BEGIN ----'
string += '| assume_gnu = ' + str(self.assume_gnu)
string += '| block_other_commands = ' + str(self.block_other_commands)
string += '| check_exit = ' + str(self.check_exit)
string += '| check_sudo = ' + str(self.check_sudo)
string += '| delaybeforesend = ' + str(self.delaybeforesend)
string += '| echo = ' + str(self.echo)
string += '| escape = ' + str(self.escape)
string += '| exit_values = ' + str(self.exit_values)
string += '| expect = ' + str(self.expect)
string += '| fail_on_empty_before = ' + str(self.fail_on_empty_before)
string += '| fail_on_fail = ' + str(self.fail_on_fail)
string += '| follow_on_commands = ' + str(self.follow_on_commands)
string += '| go_home = ' + str(self.go_home)
string += '| ignore_background = ' + str(self.ignore_background)
string += '| is_ssh = ' + str(self.is_ssh)
string += '| loglevel = ' + str(self.loglevel)
string += '| maxread = ' + str(self.maxread)
string += '| nonewline = ' + str(self.nonewline)
string += '| note = ' + str(self.note)
string += '| original_send = ' + str(self.original_send)
string += '| password = ' + str(self.password)
string += '| prompt_prefix = ' + str(self.prompt_prefix)
string += '| record_command = ' + str(self.record_command)
string += '| remove_on_match = ' + str(self.remove_on_match)
string += '| retry = ' + str(self.retry)
string += '| run_in_background = ' + str(self.run_in_background)
string += '| searchwindowsize = ' + str(self.searchwindowsize)
string += '| secret = ' + str(self.secret)
string += '| send = ' + str(self.send)
string += '| send_dict = ' + str(self.send_dict)
string += '| started = ' + str(self.started)
string += '| timeout = ' + str(self.timeout)
string += '| user = ' + str(self.user)
string += '| wait_cadence = ' + str(self.wait_cadence)
string += '|---- Sendspec object ENDS ----'
return string