1
# Copyright (C) 2005, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""UI tests for the test framework."""
28
from bzrlib.errors import ParamikoNotPresent
29
from bzrlib.tests import (
32
TestCaseWithMemoryTransport,
33
TestCaseWithTransport,
37
from bzrlib.symbol_versioning import (
40
from bzrlib.tests.blackbox import ExternalBase
43
class TestOptions(TestCase):
47
def test_transport_set_to_sftp(self):
48
# test the --transport option has taken effect from within the
51
import bzrlib.transport.sftp
52
except ParamikoNotPresent:
53
raise TestSkipped("Paramiko not present")
54
if TestOptions.current_test != "test_transport_set_to_sftp":
56
self.assertEqual(bzrlib.transport.sftp.SFTPAbsoluteServer,
57
bzrlib.tests.default_transport)
59
def test_transport_set_to_memory(self):
60
# test the --transport option has taken effect from within the
62
import bzrlib.transport.memory
63
if TestOptions.current_test != "test_transport_set_to_memory":
65
self.assertEqual(bzrlib.transport.memory.MemoryServer,
66
bzrlib.tests.default_transport)
68
def test_transport(self):
69
# test that --transport=sftp works
71
import bzrlib.transport.sftp
72
except ParamikoNotPresent:
73
raise TestSkipped("Paramiko not present")
74
old_transport = bzrlib.tests.default_transport
75
old_root = TestCaseWithMemoryTransport.TEST_ROOT
76
TestCaseWithMemoryTransport.TEST_ROOT = None
78
TestOptions.current_test = "test_transport_set_to_sftp"
79
stdout = self.run_bzr(
80
'selftest --transport=sftp test_transport_set_to_sftp')[0]
81
self.assertContainsRe(stdout, 'Ran 1 test')
82
self.assertEqual(old_transport, bzrlib.tests.default_transport)
84
TestOptions.current_test = "test_transport_set_to_memory"
85
stdout = self.run_bzr(
86
'selftest --transport=memory test_transport_set_to_memory')[0]
87
self.assertContainsRe(stdout, 'Ran 1 test')
88
self.assertEqual(old_transport, bzrlib.tests.default_transport)
90
bzrlib.tests.default_transport = old_transport
91
TestOptions.current_test = None
92
TestCaseWithMemoryTransport.TEST_ROOT = old_root
95
class TestRunBzr(ExternalBase):
97
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
99
"""Override _run_bzr_core to test how it is invoked by run_bzr.
101
Attempts to run bzr from inside this class don't actually run it.
103
We test how run_bzr actually invokes bzr in another location.
104
Here we only need to test that it is run_bzr passes the right
105
parameters to run_bzr.
107
self.argv = list(argv)
108
self.retcode = retcode
109
self.encoding = encoding
111
self.working_dir = working_dir
115
"""Test that run_bzr passes args correctly to _run_bzr_core"""
117
['passing varargs to run_bzr was deprecated in version 0.18.'],
119
'arg1', 'arg2', 'arg3', retcode=1)
120
self.assertEqual(['arg1', 'arg2', 'arg3'], self.argv)
122
def test_encoding(self):
123
"""Test that run_bzr passes encoding to _run_bzr_core"""
124
self.run_bzr('foo bar')
125
self.assertEqual(None, self.encoding)
126
self.assertEqual(['foo', 'bar'], self.argv)
128
self.run_bzr('foo bar', encoding='baz')
129
self.assertEqual('baz', self.encoding)
130
self.assertEqual(['foo', 'bar'], self.argv)
132
def test_retcode(self):
133
"""Test that run_bzr passes retcode to _run_bzr_core"""
134
# Default is retcode == 0
135
self.run_bzr('foo bar')
136
self.assertEqual(0, self.retcode)
137
self.assertEqual(['foo', 'bar'], self.argv)
139
self.run_bzr('foo bar', retcode=1)
140
self.assertEqual(1, self.retcode)
141
self.assertEqual(['foo', 'bar'], self.argv)
143
self.run_bzr('foo bar', retcode=None)
144
self.assertEqual(None, self.retcode)
145
self.assertEqual(['foo', 'bar'], self.argv)
147
self.run_bzr(['foo', 'bar'], retcode=3)
148
self.assertEqual(3, self.retcode)
149
self.assertEqual(['foo', 'bar'], self.argv)
151
def test_stdin(self):
152
# test that the stdin keyword to run_bzr is passed through to
153
# _run_bzr_core as-is. We do this by overriding
154
# _run_bzr_core in this class, and then calling run_bzr,
155
# which is a convenience function for _run_bzr_core, so
157
self.run_bzr('foo bar', stdin='gam')
158
self.assertEqual('gam', self.stdin)
159
self.assertEqual(['foo', 'bar'], self.argv)
161
self.run_bzr('foo bar', stdin='zippy')
162
self.assertEqual('zippy', self.stdin)
163
self.assertEqual(['foo', 'bar'], self.argv)
165
def test_working_dir(self):
166
"""Test that run_bzr passes working_dir to _run_bzr_core"""
167
self.run_bzr('foo bar')
168
self.assertEqual(None, self.working_dir)
169
self.assertEqual(['foo', 'bar'], self.argv)
171
self.run_bzr('foo bar', working_dir='baz')
172
self.assertEqual('baz', self.working_dir)
173
self.assertEqual(['foo', 'bar'], self.argv)
175
def test_reject_extra_keyword_arguments(self):
176
self.assertRaises(TypeError, self.run_bzr, "foo bar",
177
error_regex=['error message'])
180
class TestBenchmarkTests(TestCaseWithTransport):
182
def test_benchmark_runs_benchmark_tests(self):
183
"""bzr selftest --benchmark should not run the default test suite."""
184
# We test this by passing a regression test name to --benchmark, which
185
# should result in 0 rests run.
186
old_root = TestCaseWithMemoryTransport.TEST_ROOT
188
TestCaseWithMemoryTransport.TEST_ROOT = None
189
out, err = self.run_bzr('selftest --benchmark'
190
' workingtree_implementations')
192
TestCaseWithMemoryTransport.TEST_ROOT = old_root
193
self.assertContainsRe(out, 'Ran 0 tests.*\n\nOK')
197
benchfile = open(".perf_history", "rt")
199
lines = benchfile.readlines()
202
self.assertEqual(1, len(lines))
203
self.assertContainsRe(lines[0], "--date [0-9.]+")
206
class TestRunBzrCaptured(ExternalBase):
208
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
209
a_callable=None, *args, **kwargs):
211
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
212
self.factory = bzrlib.ui.ui_factory
213
self.working_dir = osutils.getcwd()
214
stdout.write('foo\n')
215
stderr.write('bar\n')
218
def test_stdin(self):
219
# test that the stdin keyword to _run_bzr_core is passed through to
220
# apply_redirected as a StringIO. We do this by overriding
221
# apply_redirected in this class, and then calling _run_bzr_core,
222
# which calls apply_redirected.
223
self.run_bzr(['foo', 'bar'], stdin='gam')
224
self.assertEqual('gam', self.stdin.read())
225
self.assertTrue(self.stdin is self.factory_stdin)
226
self.run_bzr(['foo', 'bar'], stdin='zippy')
227
self.assertEqual('zippy', self.stdin.read())
228
self.assertTrue(self.stdin is self.factory_stdin)
230
def test_ui_factory(self):
231
# each invocation of self.run_bzr should get its
232
# own UI factory, which is an instance of TestUIFactory,
233
# with stdin, stdout and stderr attached to the stdin,
234
# stdout and stderr of the invoked run_bzr
235
current_factory = bzrlib.ui.ui_factory
236
self.run_bzr(['foo'])
237
self.failIf(current_factory is self.factory)
238
self.assertNotEqual(sys.stdout, self.factory.stdout)
239
self.assertNotEqual(sys.stderr, self.factory.stderr)
240
self.assertEqual('foo\n', self.factory.stdout.getvalue())
241
self.assertEqual('bar\n', self.factory.stderr.getvalue())
242
self.assertIsInstance(self.factory, TestUIFactory)
244
def test_working_dir(self):
245
self.build_tree(['one/', 'two/'])
246
cwd = osutils.getcwd()
248
# Default is to work in the current directory
249
self.run_bzr(['foo', 'bar'])
250
self.assertEqual(cwd, self.working_dir)
252
self.run_bzr(['foo', 'bar'], working_dir=None)
253
self.assertEqual(cwd, self.working_dir)
255
# The function should be run in the alternative directory
256
# but afterwards the current working dir shouldn't be changed
257
self.run_bzr(['foo', 'bar'], working_dir='one')
258
self.assertNotEqual(cwd, self.working_dir)
259
self.assertEndsWith(self.working_dir, 'one')
260
self.assertEqual(cwd, osutils.getcwd())
262
self.run_bzr(['foo', 'bar'], working_dir='two')
263
self.assertNotEqual(cwd, self.working_dir)
264
self.assertEndsWith(self.working_dir, 'two')
265
self.assertEqual(cwd, osutils.getcwd())
268
class TestRunBzrSubprocess(TestCaseWithTransport):
270
def test_run_bzr_subprocess(self):
271
"""The run_bzr_helper_external comand behaves nicely."""
272
result = self.run_bzr_subprocess('--version')
273
result = self.run_bzr_subprocess('--version', retcode=None)
274
self.assertContainsRe(result[0], 'is free software')
275
self.assertRaises(AssertionError, self.run_bzr_subprocess,
277
result = self.run_bzr_subprocess('--versionn', retcode=3)
278
result = self.run_bzr_subprocess('--versionn', retcode=None)
279
self.assertContainsRe(result[1], 'unknown command')
280
err = self.run_bzr_subprocess('merge', '--merge-type', 'magic merge',
282
self.assertContainsRe(err, 'Bad value "magic merge" for option'
285
def test_run_bzr_subprocess_env(self):
286
"""run_bzr_subprocess can set environment variables in the child only.
288
These changes should not change the running process, only the child.
290
# The test suite should unset this variable
291
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
292
out, err = self.run_bzr_subprocess('whoami', env_changes={
293
'BZR_EMAIL':'Joe Foo <joe@foo.com>'
294
}, universal_newlines=True)
295
self.assertEqual('', err)
296
self.assertEqual('Joe Foo <joe@foo.com>\n', out)
297
# And it should not be modified
298
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
300
# Do it again with a different address, just to make sure
301
# it is actually changing
302
out, err = self.run_bzr_subprocess('whoami', env_changes={
303
'BZR_EMAIL':'Barry <bar@foo.com>'
304
}, universal_newlines=True)
305
self.assertEqual('', err)
306
self.assertEqual('Barry <bar@foo.com>\n', out)
307
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
309
def test_run_bzr_subprocess_env_del(self):
310
"""run_bzr_subprocess can remove environment variables too."""
311
# Create a random email, so we are sure this won't collide
312
rand_bzr_email = 'John Doe <jdoe@%s.com>' % (osutils.rand_chars(20),)
313
rand_email = 'Jane Doe <jdoe@%s.com>' % (osutils.rand_chars(20),)
314
os.environ['BZR_EMAIL'] = rand_bzr_email
315
os.environ['EMAIL'] = rand_email
317
# By default, the child will inherit the current env setting
318
out, err = self.run_bzr_subprocess('whoami', universal_newlines=True)
319
self.assertEqual('', err)
320
self.assertEqual(rand_bzr_email + '\n', out)
322
# Now that BZR_EMAIL is not set, it should fall back to EMAIL
323
out, err = self.run_bzr_subprocess('whoami',
324
env_changes={'BZR_EMAIL':None},
325
universal_newlines=True)
326
self.assertEqual('', err)
327
self.assertEqual(rand_email + '\n', out)
329
# This switches back to the default email guessing logic
330
# Which shouldn't match either of the above addresses
331
out, err = self.run_bzr_subprocess('whoami',
332
env_changes={'BZR_EMAIL':None, 'EMAIL':None},
333
universal_newlines=True)
335
self.assertEqual('', err)
336
self.assertNotEqual(rand_bzr_email + '\n', out)
337
self.assertNotEqual(rand_email + '\n', out)
339
# TestCase cleans up BZR_EMAIL, and EMAIL at startup
340
del os.environ['BZR_EMAIL']
341
del os.environ['EMAIL']
343
def test_run_bzr_subprocess_env_del_missing(self):
344
"""run_bzr_subprocess won't fail if deleting a nonexistant env var"""
345
self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
346
out, err = self.run_bzr_subprocess('rocks',
347
env_changes={'NON_EXISTANT_ENV_VAR':None},
348
universal_newlines=True)
349
self.assertEqual('It sure does!\n', out)
350
self.assertEqual('', err)
352
def test_run_bzr_subprocess_working_dir(self):
353
"""Test that we can specify the working dir for the child"""
354
cwd = osutils.getcwd()
356
self.make_branch_and_tree('.')
357
self.make_branch_and_tree('one')
358
self.make_branch_and_tree('two')
360
def get_root(**kwargs):
361
"""Spawn a process to get the 'root' of the tree.
363
You can pass in arbitrary new arguments. This just makes
364
sure that the returned path doesn't have trailing whitespace.
366
return self.run_bzr_subprocess('root', **kwargs)[0].rstrip()
368
self.assertEqual(cwd, get_root())
369
self.assertEqual(cwd, get_root(working_dir=None))
370
# Has our path changed?
371
self.assertEqual(cwd, osutils.getcwd())
373
dir1 = get_root(working_dir='one')
374
self.assertEndsWith(dir1, 'one')
375
self.assertEqual(cwd, osutils.getcwd())
377
dir2 = get_root(working_dir='two')
378
self.assertEndsWith(dir2, 'two')
379
self.assertEqual(cwd, osutils.getcwd())
382
class _DontSpawnProcess(Exception):
383
"""A simple exception which just allows us to skip unnecessary steps"""
386
class TestRunBzrSubprocessCommands(TestCaseWithTransport):
388
def _popen(self, *args, **kwargs):
389
"""Record the command that is run, so that we can ensure it is correct"""
390
self._popen_args = args
391
self._popen_kwargs = kwargs
392
raise _DontSpawnProcess()
394
def test_run_bzr_subprocess_no_plugins(self):
395
self.assertRaises(_DontSpawnProcess, self.run_bzr_subprocess)
396
command = self._popen_args[0]
397
self.assertEqual(sys.executable, command[0])
398
self.assertEqual(self.get_bzr_path(), command[1])
399
self.assertEqual(['--no-plugins'], command[2:])
401
def test_allow_plugins(self):
402
self.assertRaises(_DontSpawnProcess,
403
self.run_bzr_subprocess, allow_plugins=True)
404
command = self._popen_args[0]
405
self.assertEqual([], command[2:])
408
class TestBzrSubprocess(TestCaseWithTransport):
410
def test_start_and_stop_bzr_subprocess(self):
411
"""We can start and perform other test actions while that process is
414
process = self.start_bzr_subprocess(['--version'])
415
result = self.finish_bzr_subprocess(process)
416
self.assertContainsRe(result[0], 'is free software')
417
self.assertEqual('', result[1])
419
def test_start_and_stop_bzr_subprocess_with_error(self):
420
"""finish_bzr_subprocess allows specification of the desired exit code.
422
process = self.start_bzr_subprocess(['--versionn'])
423
result = self.finish_bzr_subprocess(process, retcode=3)
424
self.assertEqual('', result[0])
425
self.assertContainsRe(result[1], 'unknown command')
427
def test_start_and_stop_bzr_subprocess_ignoring_retcode(self):
428
"""finish_bzr_subprocess allows the exit code to be ignored."""
429
process = self.start_bzr_subprocess(['--versionn'])
430
result = self.finish_bzr_subprocess(process, retcode=None)
431
self.assertEqual('', result[0])
432
self.assertContainsRe(result[1], 'unknown command')
434
def test_start_and_stop_bzr_subprocess_with_unexpected_retcode(self):
435
"""finish_bzr_subprocess raises self.failureException if the retcode is
436
not the expected one.
438
process = self.start_bzr_subprocess(['--versionn'])
439
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
442
def test_start_and_stop_bzr_subprocess_send_signal(self):
443
"""finish_bzr_subprocess raises self.failureException if the retcode is
444
not the expected one.
446
process = self.start_bzr_subprocess(['wait-until-signalled'],
447
skip_if_plan_to_signal=True)
448
self.assertEqual('running\n', process.stdout.readline())
449
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
451
self.assertEqual('', result[0])
452
self.assertEqual('bzr: interrupted\n', result[1])
454
def test_start_and_stop_working_dir(self):
455
cwd = osutils.getcwd()
457
self.make_branch_and_tree('one')
459
process = self.start_bzr_subprocess(['root'], working_dir='one')
460
result = self.finish_bzr_subprocess(process, universal_newlines=True)
461
self.assertEndsWith(result[0], 'one\n')
462
self.assertEqual('', result[1])
465
class TestRunBzrError(ExternalBase):
467
def test_run_bzr_error(self):
468
# retcode=0 is specially needed here because run_bzr_error expects
469
# an error (oddly enough) but we want to test the case of not
470
# actually getting one
471
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=0)
472
self.assertEqual(out, 'It sure does!\n')
473
# now test actually getting an error
474
out, err = self.run_bzr_error(
475
["bzr: ERROR: foobarbaz is not versioned"],
476
['file-id', 'foobarbaz'])
479
class TestSelftestListOnly(TestCase):
482
def _parse_test_list(lines, newlines_in_header=1):
483
"Parse a list of lines into a tuple of 3 lists (header,body,footer)."
490
header_newlines_found = 0
494
header_newlines_found += 1
495
if header_newlines_found >= newlines_in_header:
500
if line.startswith('-------'):
506
# If the last body line is blank, drop it off the list
507
if len(body) > 0 and body[-1] == '':
509
return (header,body,footer)
511
def test_list_only(self):
512
# check that bzr selftest --list-only works correctly
513
out,err = self.run_bzr('selftest selftest --list-only')
514
self.assertEndsWith(err, 'tests passed\n')
515
(header,body,footer) = self._parse_test_list(out.splitlines())
516
num_tests = len(body)
517
self.assertContainsRe(footer[0], 'Listed %s tests in' % num_tests)
519
def test_list_only_filtered(self):
520
# check that a filtered --list-only works, both include and exclude
521
out_all,err_all = self.run_bzr('selftest --list-only')
522
tests_all = self._parse_test_list(out_all.splitlines())[1]
523
out_incl,err_incl = self.run_bzr('selftest --list-only selftest')
524
tests_incl = self._parse_test_list(out_incl.splitlines())[1]
525
self.assertSubset(tests_incl, tests_all)
526
out_excl,err_excl = self.run_bzr(['selftest', '--list-only',
527
'--exclude', 'selftest'])
528
tests_excl = self._parse_test_list(out_excl.splitlines())[1]
529
self.assertSubset(tests_excl, tests_all)
530
set_incl = set(tests_incl)
531
set_excl = set(tests_excl)
532
intersection = set_incl.intersection(set_excl)
533
self.assertEquals(0, len(intersection))
534
self.assertEquals(len(tests_all), len(tests_incl) + len(tests_excl))
536
def test_list_only_random(self):
537
# check that --randomize works correctly
538
out_all,err_all = self.run_bzr('selftest --list-only selftest')
539
tests_all = self._parse_test_list(out_all.splitlines())[1]
540
# XXX: It looks like there are some orders for generating tests that
541
# fail as of 20070504 - maybe because of import order dependencies.
542
# So unfortunately this will rarely intermittently fail at the moment.
544
out_rand,err_rand = self.run_bzr(['selftest', '--list-only',
545
'selftest', '--randomize', 'now'])
546
(header_rand,tests_rand,dummy) = self._parse_test_list(
547
out_rand.splitlines(), 2)
548
self.assertNotEqual(tests_all, tests_rand)
549
self.assertEqual(sorted(tests_all), sorted(tests_rand))
550
# Check that the seed can be reused to get the exact same order
551
seed_re = re.compile('Randomizing test order using seed (\w+)')
552
match_obj = seed_re.search(header_rand[-1])
553
seed = match_obj.group(1)
554
out_rand2,err_rand2 = self.run_bzr(['selftest', '--list-only',
555
'selftest', '--randomize', seed])
556
(header_rand2,tests_rand2,dummy) = self._parse_test_list(
557
out_rand2.splitlines(), 2)
558
self.assertEqual(tests_rand, tests_rand2)
added
removed
bzrlib/tests/blackbox/test_selftest.py
