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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
# Copyright (C) 2009 Canonical Ltd
#
# This program 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.
#
# This program 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
"""Shell-like test scripts.
See developers/testing.html for more explanations.
"""
import doctest
import errno
import glob
import os
import shlex
from cStringIO import StringIO
from bzrlib import (
osutils,
tests,
)
def split(s):
"""Split a command line respecting quotes."""
scanner = shlex.shlex(s)
scanner.quotes = '\'"`'
scanner.whitespace_split = True
for t in list(scanner):
yield t
def _script_to_commands(text, file_name=None):
"""Turn a script into a list of commands with their associated IOs.
Each command appears on a line by itself starting with '$ '. It can be
associated with an input that will feed it and an expected output.
Comments starts with '#' until the end of line.
Empty lines are ignored.
Input and output are full lines terminated by a '\n'.
Input lines start with '<'.
Output lines start with nothing.
Error lines start with '2>'.
"""
commands = []
def add_command(cmd, input, output, error):
if cmd is not None:
if input is not None:
input = ''.join(input)
if output is not None:
output = ''.join(output)
if error is not None:
error = ''.join(error)
commands.append((cmd, input, output, error))
cmd_cur = None
cmd_line = 1
lineno = 0
input, output, error = None, None, None
for line in text.split('\n'):
lineno += 1
# Keep a copy for error reporting
orig = line
comment = line.find('#')
if comment >= 0:
# Delete comments
line = line[0:comment]
line = line.rstrip()
if line == '':
# Ignore empty lines
continue
if line.startswith('$'):
# Time to output the current command
add_command(cmd_cur, input, output, error)
# And start a new one
cmd_cur = list(split(line[1:]))
cmd_line = lineno
input, output, error = None, None, None
elif line.startswith('<'):
if input is None:
if cmd_cur is None:
raise SyntaxError('No command for that input',
(file_name, lineno, 1, orig))
input = []
input.append(line[1:] + '\n')
elif line.startswith('2>'):
if error is None:
if cmd_cur is None:
raise SyntaxError('No command for that error',
(file_name, lineno, 1, orig))
error = []
error.append(line[2:] + '\n')
else:
if output is None:
if cmd_cur is None:
raise SyntaxError('No command for that output',
(file_name, lineno, 1, orig))
output = []
output.append(line + '\n')
# Add the last seen command
add_command(cmd_cur, input, output, error)
return commands
def _scan_redirection_options(args):
"""Recognize and process input and output redirections.
:param args: The command line arguments
:return: A tuple containing:
- The file name redirected from or None
- The file name redirected to or None
- The mode to open the output file or None
- The reamining arguments
"""
def redirected_file_name(direction, name, args):
if name == '':
try:
name = args.pop(0)
except IndexError:
# We leave the error handling to higher levels, an empty name
# can't be legal.
name = ''
return name
remaining = []
in_name = None
out_name, out_mode = None, None
while args:
arg = args.pop(0)
if arg.startswith('<'):
in_name = redirected_file_name('<', arg[1:], args)
elif arg.startswith('>>'):
out_name = redirected_file_name('>>', arg[2:], args)
out_mode = 'ab+'
elif arg.startswith('>',):
out_name = redirected_file_name('>', arg[1:], args)
out_mode = 'wb+'
else:
remaining.append(arg)
return in_name, out_name, out_mode, remaining
class ScriptRunner(object):
"""Run a shell-like script from a test.
Can be used as:
from bzrlib.tests import script
...
def test_bug_nnnnn(self):
sr = script.ScriptRunner()
sr.run_script(self, '''
$ bzr init
$ bzr do-this
# Boom, error
''')
"""
def __init__(self):
self.output_checker = doctest.OutputChecker()
self.check_options = doctest.ELLIPSIS
def run_script(self, test_case, text):
"""Run a shell-like script as a test.
:param test_case: A TestCase instance that should provide the fail(),
assertEqualDiff and _run_bzr_core() methods as well as a 'test_dir'
attribute used as a jail root.
:param text: A shell-like script (see _script_to_commands for syntax).
"""
for cmd, input, output, error in _script_to_commands(text):
self.run_command(test_case, cmd, input, output, error)
def run_command(self, test_case, cmd, input, output, error):
mname = 'do_' + cmd[0]
method = getattr(self, mname, None)
if method is None:
raise SyntaxError('Command not found "%s"' % (cmd[0],),
None, 1, ' '.join(cmd))
if input is None:
str_input = ''
else:
str_input = ''.join(input)
args = list(self._pre_process_args(cmd[1:]))
retcode, actual_output, actual_error = method(test_case,
str_input, args)
self._check_output(output, actual_output, test_case)
self._check_output(error, actual_error, test_case)
if retcode and not error and actual_error:
test_case.fail('In \n\t%s\nUnexpected error: %s'
% (' '.join(cmd), actual_error))
return retcode, actual_output, actual_error
def _check_output(self, expected, actual, test_case):
if expected is None:
# Specifying None means: any output is accepted
return
if actual is None:
test_case.fail('Unexpected: %s' % actual)
matching = self.output_checker.check_output(
expected, actual, self.check_options)
if not matching:
# Note that we can't use output_checker.output_difference() here
# because... the API is broken ('expected' must be a doctest
# specific object of which a 'want' attribute will be our
# 'expected' parameter. So we just fallback to our good old
# assertEqualDiff since we know there *are* differences and the
# output should be decently readable.
test_case.assertEqualDiff(expected, actual)
def _pre_process_args(self, args):
new_args = []
for arg in args:
# Strip the simple and double quotes since we don't care about
# them. We leave the backquotes in place though since they have a
# different semantic.
if arg[0] in ('"', "'") and arg[0] == arg[-1]:
yield arg[1:-1]
else:
if glob.has_magic(arg):
matches = glob.glob(arg)
if matches:
# We care more about order stability than performance
# here
matches.sort()
for m in matches:
yield m
else:
yield arg
def _read_input(self, input, in_name):
if in_name is not None:
infile = open(in_name, 'rb')
try:
# Command redirection takes precedence over provided input
input = infile.read()
finally:
infile.close()
return input
def _write_output(self, output, out_name, out_mode):
if out_name is not None:
outfile = open(out_name, out_mode)
try:
outfile.write(output)
finally:
outfile.close()
output = None
return output
def do_bzr(self, test_case, input, args):
retcode, out, err = test_case._run_bzr_core(
args, retcode=None, encoding=None, stdin=input, working_dir=None)
return retcode, out, err
def do_cat(self, test_case, input, args):
(in_name, out_name, out_mode, args) = _scan_redirection_options(args)
if args and in_name is not None:
raise SyntaxError('Specify a file OR use redirection')
inputs = []
if input:
inputs.append(input)
input_names = args
if in_name:
args.append(in_name)
for in_name in input_names:
try:
inputs.append(self._read_input(None, in_name))
except IOError, e:
if e.errno == errno.ENOENT:
return (1, None,
'%s: No such file or directory\n' % (in_name,))
# Basically cat copy input to output
output = ''.join(inputs)
# Handle output redirections
try:
output = self._write_output(output, out_name, out_mode)
except IOError, e:
if e.errno == errno.ENOENT:
return 1, None, '%s: No such file or directory\n' % (out_name,)
return 0, output, None
def do_echo(self, test_case, input, args):
(in_name, out_name, out_mode, args) = _scan_redirection_options(args)
if input and args:
raise SyntaxError('Specify parameters OR use redirection')
if args:
input = ' '.join(args)
try:
input = self._read_input(input, in_name)
except IOError, e:
if e.errno == errno.ENOENT:
return 1, None, '%s: No such file or directory\n' % (in_name,)
# Always append a \n'
input += '\n'
# Process output
output = input
# Handle output redirections
try:
output = self._write_output(output, out_name, out_mode)
except IOError, e:
if e.errno == errno.ENOENT:
return 1, None, '%s: No such file or directory\n' % (out_name,)
return 0, output, None
def _get_jail_root(self, test_case):
return test_case.test_dir
def _ensure_in_jail(self, test_case, path):
jail_root = self._get_jail_root(test_case)
if not osutils.is_inside(jail_root, osutils.normalizepath(path)):
raise ValueError('%s is not inside %s' % (path, jail_root))
def do_cd(self, test_case, input, args):
if len(args) > 1:
raise SyntaxError('Usage: cd [dir]')
if len(args) == 1:
d = args[0]
self._ensure_in_jail(test_case, d)
else:
# The test "home" directory is the root of its jail
d = self._get_jail_root(test_case)
os.chdir(d)
return 0, None, None
def do_mkdir(self, test_case, input, args):
if not args or len(args) != 1:
raise SyntaxError('Usage: mkdir dir')
d = args[0]
self._ensure_in_jail(test_case, d)
os.mkdir(d)
return 0, None, None
def do_rm(self, test_case, input, args):
err = None
def error(msg, path):
return "rm: cannot remove '%s': %s\n" % (path, msg)
force, recursive = False, False
opts = None
if args and args[0][0] == '-':
opts = args.pop(0)[1:]
if 'f' in opts:
force = True
opts = opts.replace('f', '', 1)
if 'r' in opts:
recursive = True
opts = opts.replace('r', '', 1)
if not args or opts:
raise SyntaxError('Usage: rm [-fr] path+')
for p in args:
self._ensure_in_jail(test_case, p)
# FIXME: Should we put that in osutils ?
try:
os.remove(p)
except OSError, e:
# Various OSes raises different exceptions (linux: EISDIR,
# win32: EACCES, OSX: EPERM) when invoked on a directory
if e.errno in (errno.EISDIR, errno.EPERM, errno.EACCES):
if recursive:
osutils.rmtree(p)
else:
err = error('Is a directory', p)
break
elif e.errno == errno.ENOENT:
if not force:
err = error('No such file or directory', p)
break
else:
raise
if err:
retcode = 1
else:
retcode = 0
return retcode, None, err
class TestCaseWithMemoryTransportAndScript(tests.TestCaseWithMemoryTransport):
"""Helper class to experiment shell-like test and memory fs.
This not intended to be used outside of experiments in implementing memoy
based file systems and evolving bzr so that test can use only memory based
resources.
"""
def setUp(self):
super(TestCaseWithMemoryTransportAndScript, self).setUp()
self.script_runner = ScriptRunner()
def run_script(self, script):
return self.script_runner.run_script(self, script)
def run_command(self, cmd, input, output, error):
return self.script_runner.run_command(self, cmd, input, output, error)
class TestCaseWithTransportAndScript(tests.TestCaseWithTransport):
"""Helper class to quickly define shell-like tests.
Can be used as:
from bzrlib.tests import script
class TestBug(script.TestCaseWithTransportAndScript):
def test_bug_nnnnn(self):
self.run_script('''
$ bzr init
$ bzr do-this
# Boom, error
''')
"""
def setUp(self):
super(TestCaseWithTransportAndScript, self).setUp()
self.script_runner = ScriptRunner()
def run_script(self, script):
return self.script_runner.run_script(self, script)
def run_command(self, cmd, input, output, error):
return self.script_runner.run_command(self, cmd, input, output, error)
|