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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""UI tests for the test framework."""
19
from cStringIO import StringIO
30
from bzrlib.errors import ParamikoNotPresent
31
from bzrlib.tests import (
35
TestCaseWithMemoryTransport,
36
TestCaseWithTransport,
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
94
def test_subunit(self):
95
"""Passing --subunit results in subunit output."""
96
self.requireFeature(SubUnitFeature)
97
from subunit import ProtocolTestCase
98
stdout = self.run_bzr(
99
'selftest --subunit --no-plugins '
100
'tests.test_selftest.SelftestTests.test_import_tests')[0]
101
stream = StringIO(str(stdout))
102
test = ProtocolTestCase(stream)
103
result = unittest.TestResult()
105
self.assertEqual(1, result.testsRun)
108
class TestRunBzr(ExternalBase):
110
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
112
"""Override _run_bzr_core to test how it is invoked by run_bzr.
114
Attempts to run bzr from inside this class don't actually run it.
116
We test how run_bzr actually invokes bzr in another location.
117
Here we only need to test that it is run_bzr passes the right
118
parameters to run_bzr.
120
self.argv = list(argv)
121
self.retcode = retcode
122
self.encoding = encoding
124
self.working_dir = working_dir
127
def test_encoding(self):
128
"""Test that run_bzr passes encoding to _run_bzr_core"""
129
self.run_bzr('foo bar')
130
self.assertEqual(None, self.encoding)
131
self.assertEqual(['foo', 'bar'], self.argv)
133
self.run_bzr('foo bar', encoding='baz')
134
self.assertEqual('baz', self.encoding)
135
self.assertEqual(['foo', 'bar'], self.argv)
137
def test_retcode(self):
138
"""Test that run_bzr passes retcode to _run_bzr_core"""
139
# Default is retcode == 0
140
self.run_bzr('foo bar')
141
self.assertEqual(0, self.retcode)
142
self.assertEqual(['foo', 'bar'], self.argv)
144
self.run_bzr('foo bar', retcode=1)
145
self.assertEqual(1, self.retcode)
146
self.assertEqual(['foo', 'bar'], self.argv)
148
self.run_bzr('foo bar', retcode=None)
149
self.assertEqual(None, self.retcode)
150
self.assertEqual(['foo', 'bar'], self.argv)
152
self.run_bzr(['foo', 'bar'], retcode=3)
153
self.assertEqual(3, self.retcode)
154
self.assertEqual(['foo', 'bar'], self.argv)
156
def test_stdin(self):
157
# test that the stdin keyword to run_bzr is passed through to
158
# _run_bzr_core as-is. We do this by overriding
159
# _run_bzr_core in this class, and then calling run_bzr,
160
# which is a convenience function for _run_bzr_core, so
162
self.run_bzr('foo bar', stdin='gam')
163
self.assertEqual('gam', self.stdin)
164
self.assertEqual(['foo', 'bar'], self.argv)
166
self.run_bzr('foo bar', stdin='zippy')
167
self.assertEqual('zippy', self.stdin)
168
self.assertEqual(['foo', 'bar'], self.argv)
170
def test_working_dir(self):
171
"""Test that run_bzr passes working_dir to _run_bzr_core"""
172
self.run_bzr('foo bar')
173
self.assertEqual(None, self.working_dir)
174
self.assertEqual(['foo', 'bar'], self.argv)
176
self.run_bzr('foo bar', working_dir='baz')
177
self.assertEqual('baz', self.working_dir)
178
self.assertEqual(['foo', 'bar'], self.argv)
180
def test_reject_extra_keyword_arguments(self):
181
self.assertRaises(TypeError, self.run_bzr, "foo bar",
182
error_regex=['error message'])
185
class TestBenchmarkTests(TestCaseWithTransport):
187
def test_benchmark_runs_benchmark_tests(self):
188
"""bzr selftest --benchmark should not run the default test suite."""
189
# We test this by passing a regression test name to --benchmark, which
190
# should result in 0 tests run.
191
old_root = TestCaseWithMemoryTransport.TEST_ROOT
193
TestCaseWithMemoryTransport.TEST_ROOT = None
194
out, err = self.run_bzr('selftest --benchmark'
195
' workingtree_implementations')
197
TestCaseWithMemoryTransport.TEST_ROOT = old_root
198
self.assertContainsRe(out, 'Ran 0 tests.*\n\nOK')
199
self.assertContainsRe(out, 'tests passed\n')
200
benchfile = open(".perf_history", "rt")
202
lines = benchfile.readlines()
205
self.assertEqual(1, len(lines))
206
self.assertContainsRe(lines[0], "--date [0-9.]+")
209
class TestRunBzrCaptured(ExternalBase):
211
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
212
a_callable=None, *args, **kwargs):
214
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
215
self.factory = bzrlib.ui.ui_factory
216
self.working_dir = osutils.getcwd()
217
stdout.write('foo\n')
218
stderr.write('bar\n')
221
def test_stdin(self):
222
# test that the stdin keyword to _run_bzr_core is passed through to
223
# apply_redirected as a StringIO. We do this by overriding
224
# apply_redirected in this class, and then calling _run_bzr_core,
225
# which calls apply_redirected.
226
self.run_bzr(['foo', 'bar'], stdin='gam')
227
self.assertEqual('gam', self.stdin.read())
228
self.assertTrue(self.stdin is self.factory_stdin)
229
self.run_bzr(['foo', 'bar'], stdin='zippy')
230
self.assertEqual('zippy', self.stdin.read())
231
self.assertTrue(self.stdin is self.factory_stdin)
233
def test_ui_factory(self):
234
# each invocation of self.run_bzr should get its
235
# own UI factory, which is an instance of TestUIFactory,
236
# with stdin, stdout and stderr attached to the stdin,
237
# stdout and stderr of the invoked run_bzr
238
current_factory = bzrlib.ui.ui_factory
239
self.run_bzr(['foo'])
240
self.failIf(current_factory is self.factory)
241
self.assertNotEqual(sys.stdout, self.factory.stdout)
242
self.assertNotEqual(sys.stderr, self.factory.stderr)
243
self.assertEqual('foo\n', self.factory.stdout.getvalue())
244
self.assertEqual('bar\n', self.factory.stderr.getvalue())
245
self.assertIsInstance(self.factory, TestUIFactory)
247
def test_working_dir(self):
248
self.build_tree(['one/', 'two/'])
249
cwd = osutils.getcwd()
251
# Default is to work in the current directory
252
self.run_bzr(['foo', 'bar'])
253
self.assertEqual(cwd, self.working_dir)
255
self.run_bzr(['foo', 'bar'], working_dir=None)
256
self.assertEqual(cwd, self.working_dir)
258
# The function should be run in the alternative directory
259
# but afterwards the current working dir shouldn't be changed
260
self.run_bzr(['foo', 'bar'], working_dir='one')
261
self.assertNotEqual(cwd, self.working_dir)
262
self.assertEndsWith(self.working_dir, 'one')
263
self.assertEqual(cwd, osutils.getcwd())
265
self.run_bzr(['foo', 'bar'], working_dir='two')
266
self.assertNotEqual(cwd, self.working_dir)
267
self.assertEndsWith(self.working_dir, 'two')
268
self.assertEqual(cwd, osutils.getcwd())
271
class TestRunBzrSubprocess(TestCaseWithTransport):
273
def test_run_bzr_subprocess(self):
274
"""The run_bzr_helper_external command behaves nicely."""
275
result = self.run_bzr_subprocess('--version')
276
result = self.run_bzr_subprocess(['--version'])
277
result = self.run_bzr_subprocess('--version', retcode=None)
278
self.assertContainsRe(result[0], 'is free software')
279
self.assertRaises(AssertionError, self.run_bzr_subprocess,
281
result = self.run_bzr_subprocess('--versionn', retcode=3)
282
result = self.run_bzr_subprocess('--versionn', retcode=None)
283
self.assertContainsRe(result[1], 'unknown command')
284
err = self.run_bzr_subprocess(['merge', '--merge-type',
285
'magic merge'], retcode=3)[1]
286
self.assertContainsRe(err, 'Bad value "magic merge" for option'
289
def test_run_bzr_subprocess_env(self):
290
"""run_bzr_subprocess can set environment variables in the child only.
292
These changes should not change the running process, only the child.
294
# The test suite should unset this variable
295
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
296
out, err = self.run_bzr_subprocess('whoami', env_changes={
297
'BZR_EMAIL':'Joe Foo <joe@foo.com>'
298
}, universal_newlines=True)
299
self.assertEqual('', err)
300
self.assertEqual('Joe Foo <joe@foo.com>\n', out)
301
# And it should not be modified
302
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
304
# Do it again with a different address, just to make sure
305
# it is actually changing
306
out, err = self.run_bzr_subprocess('whoami', env_changes={
307
'BZR_EMAIL':'Barry <bar@foo.com>'
308
}, universal_newlines=True)
309
self.assertEqual('', err)
310
self.assertEqual('Barry <bar@foo.com>\n', out)
311
self.assertEqual(None, os.environ.get('BZR_EMAIL'))
313
def test_run_bzr_subprocess_env_del(self):
314
"""run_bzr_subprocess can remove environment variables too."""
315
# Create a random email, so we are sure this won't collide
316
rand_bzr_email = 'John Doe <jdoe@%s.com>' % (osutils.rand_chars(20),)
317
rand_email = 'Jane Doe <jdoe@%s.com>' % (osutils.rand_chars(20),)
318
os.environ['BZR_EMAIL'] = rand_bzr_email
319
os.environ['EMAIL'] = rand_email
321
# By default, the child will inherit the current env setting
322
out, err = self.run_bzr_subprocess('whoami', universal_newlines=True)
323
self.assertEqual('', err)
324
self.assertEqual(rand_bzr_email + '\n', out)
326
# Now that BZR_EMAIL is not set, it should fall back to EMAIL
327
out, err = self.run_bzr_subprocess('whoami',
328
env_changes={'BZR_EMAIL':None},
329
universal_newlines=True)
330
self.assertEqual('', err)
331
self.assertEqual(rand_email + '\n', out)
333
# This switches back to the default email guessing logic
334
# Which shouldn't match either of the above addresses
335
out, err = self.run_bzr_subprocess('whoami',
336
env_changes={'BZR_EMAIL':None, 'EMAIL':None},
337
universal_newlines=True)
339
self.assertEqual('', err)
340
self.assertNotEqual(rand_bzr_email + '\n', out)
341
self.assertNotEqual(rand_email + '\n', out)
343
# TestCase cleans up BZR_EMAIL, and EMAIL at startup
344
del os.environ['BZR_EMAIL']
345
del os.environ['EMAIL']
347
def test_run_bzr_subprocess_env_del_missing(self):
348
"""run_bzr_subprocess won't fail if deleting a nonexistant env var"""
349
self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
350
out, err = self.run_bzr_subprocess('rocks',
351
env_changes={'NON_EXISTANT_ENV_VAR':None},
352
universal_newlines=True)
353
self.assertEqual('It sure does!\n', out)
354
self.assertEqual('', err)
356
def test_run_bzr_subprocess_working_dir(self):
357
"""Test that we can specify the working dir for the child"""
358
cwd = osutils.getcwd()
360
self.make_branch_and_tree('.')
361
self.make_branch_and_tree('one')
362
self.make_branch_and_tree('two')
364
def get_root(**kwargs):
365
"""Spawn a process to get the 'root' of the tree.
367
You can pass in arbitrary new arguments. This just makes
368
sure that the returned path doesn't have trailing whitespace.
370
return self.run_bzr_subprocess('root', **kwargs)[0].rstrip()
372
self.assertEqual(cwd, get_root())
373
self.assertEqual(cwd, get_root(working_dir=None))
374
# Has our path changed?
375
self.assertEqual(cwd, osutils.getcwd())
377
dir1 = get_root(working_dir='one')
378
self.assertEndsWith(dir1, 'one')
379
self.assertEqual(cwd, osutils.getcwd())
381
dir2 = get_root(working_dir='two')
382
self.assertEndsWith(dir2, 'two')
383
self.assertEqual(cwd, osutils.getcwd())
386
class _DontSpawnProcess(Exception):
387
"""A simple exception which just allows us to skip unnecessary steps"""
390
class TestRunBzrSubprocessCommands(TestCaseWithTransport):
392
def _popen(self, *args, **kwargs):
393
"""Record the command that is run, so that we can ensure it is correct"""
394
self._popen_args = args
395
self._popen_kwargs = kwargs
396
raise _DontSpawnProcess()
398
def test_run_bzr_subprocess_no_plugins(self):
399
self.assertRaises(_DontSpawnProcess, self.run_bzr_subprocess, '')
400
command = self._popen_args[0]
401
self.assertEqual(sys.executable, command[0])
402
self.assertEqual(self.get_bzr_path(), command[1])
403
self.assertEqual(['--no-plugins'], command[2:])
405
def test_allow_plugins(self):
406
self.assertRaises(_DontSpawnProcess,
407
self.run_bzr_subprocess, '', allow_plugins=True)
408
command = self._popen_args[0]
409
self.assertEqual([], command[2:])
412
class TestBzrSubprocess(TestCaseWithTransport):
414
def test_start_and_stop_bzr_subprocess(self):
415
"""We can start and perform other test actions while that process is
418
process = self.start_bzr_subprocess(['--version'])
419
result = self.finish_bzr_subprocess(process)
420
self.assertContainsRe(result[0], 'is free software')
421
self.assertEqual('', result[1])
423
def test_start_and_stop_bzr_subprocess_with_error(self):
424
"""finish_bzr_subprocess allows specification of the desired exit code.
426
process = self.start_bzr_subprocess(['--versionn'])
427
result = self.finish_bzr_subprocess(process, retcode=3)
428
self.assertEqual('', result[0])
429
self.assertContainsRe(result[1], 'unknown command')
431
def test_start_and_stop_bzr_subprocess_ignoring_retcode(self):
432
"""finish_bzr_subprocess allows the exit code to be ignored."""
433
process = self.start_bzr_subprocess(['--versionn'])
434
result = self.finish_bzr_subprocess(process, retcode=None)
435
self.assertEqual('', result[0])
436
self.assertContainsRe(result[1], 'unknown command')
438
def test_start_and_stop_bzr_subprocess_with_unexpected_retcode(self):
439
"""finish_bzr_subprocess raises self.failureException if the retcode is
440
not the expected one.
442
process = self.start_bzr_subprocess(['--versionn'])
443
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
446
def test_start_and_stop_bzr_subprocess_send_signal(self):
447
"""finish_bzr_subprocess raises self.failureException if the retcode is
448
not the expected one.
450
process = self.start_bzr_subprocess(['wait-until-signalled'],
451
skip_if_plan_to_signal=True)
452
self.assertEqual('running\n', process.stdout.readline())
453
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
455
self.assertEqual('', result[0])
456
self.assertEqual('bzr: interrupted\n', result[1])
458
def test_start_and_stop_working_dir(self):
459
cwd = osutils.getcwd()
461
self.make_branch_and_tree('one')
463
process = self.start_bzr_subprocess(['root'], working_dir='one')
464
result = self.finish_bzr_subprocess(process, universal_newlines=True)
465
self.assertEndsWith(result[0], 'one\n')
466
self.assertEqual('', result[1])
469
class TestRunBzrError(ExternalBase):
471
def test_run_bzr_error(self):
472
# retcode=0 is specially needed here because run_bzr_error expects
473
# an error (oddly enough) but we want to test the case of not
474
# actually getting one
475
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=0)
476
self.assertEqual(out, 'It sure does!\n')
477
# now test actually getting an error
478
out, err = self.run_bzr_error(
479
["bzr: ERROR: foobarbaz is not versioned"],
480
['file-id', 'foobarbaz'])
483
class TestSelftestListOnly(TestCase):
486
def _parse_test_list(lines, newlines_in_header=0):
487
"Parse a list of lines into a tuple of 3 lists (header,body,footer)."
488
in_header = newlines_in_header != 0
493
header_newlines_found = 0
497
header_newlines_found += 1
498
if header_newlines_found >= newlines_in_header:
503
if line.startswith('-------'):
509
# If the last body line is blank, drop it off the list
510
if len(body) > 0 and body[-1] == '':
512
return (header,body,footer)
514
def test_list_only(self):
515
# check that bzr selftest --list-only works correctly
516
out,err = self.run_bzr('selftest selftest --list-only')
517
(header,body,footer) = self._parse_test_list(out.splitlines())
518
num_tests = len(body)
519
self.assertLength(0, header)
520
self.assertLength(0, footer)
521
self.assertEqual('', err)
523
def test_list_only_filtered(self):
524
# check that a filtered --list-only works, both include and exclude
525
out_all,err_all = self.run_bzr('selftest --list-only')
526
tests_all = self._parse_test_list(out_all.splitlines())[1]
527
out_incl,err_incl = self.run_bzr('selftest --list-only selftest')
528
tests_incl = self._parse_test_list(out_incl.splitlines())[1]
529
self.assertSubset(tests_incl, tests_all)
530
out_excl,err_excl = self.run_bzr(['selftest', '--list-only',
531
'--exclude', 'selftest'])
532
tests_excl = self._parse_test_list(out_excl.splitlines())[1]
533
self.assertSubset(tests_excl, tests_all)
534
set_incl = set(tests_incl)
535
set_excl = set(tests_excl)
536
intersection = set_incl.intersection(set_excl)
537
self.assertEquals(0, len(intersection))
538
self.assertEquals(len(tests_all), len(tests_incl) + len(tests_excl))
540
def test_list_only_random(self):
541
# check that --randomize works correctly
542
out_all,err_all = self.run_bzr('selftest --list-only selftest')
543
tests_all = self._parse_test_list(out_all.splitlines())[1]
544
# XXX: It looks like there are some orders for generating tests that
545
# fail as of 20070504 - maybe because of import order dependencies.
546
# So unfortunately this will rarely intermittently fail at the moment.
548
out_rand,err_rand = self.run_bzr(['selftest', '--list-only',
549
'selftest', '--randomize', 'now'])
550
(header_rand,tests_rand,dummy) = self._parse_test_list(
551
out_rand.splitlines(), 1)
552
# XXX: The following line asserts that the randomized order is not the
553
# same as the default order. It is just possible that they'll get
554
# randomized into the same order and this will falsely fail, but
555
# that's very unlikely in practice because there are thousands of
557
self.assertNotEqual(tests_all, tests_rand)
558
self.assertEqual(sorted(tests_all), sorted(tests_rand))
559
# Check that the seed can be reused to get the exact same order
560
seed_re = re.compile('Randomizing test order using seed (\w+)')
561
match_obj = seed_re.search(header_rand[-1])
562
seed = match_obj.group(1)
563
out_rand2,err_rand2 = self.run_bzr(['selftest', '--list-only',
564
'selftest', '--randomize', seed])
565
(header_rand2,tests_rand2,dummy) = self._parse_test_list(
566
out_rand2.splitlines(), 1)
567
self.assertEqual(tests_rand, tests_rand2)
570
class TestSelftestWithIdList(TestCaseInTempDir):
572
def test_load_list(self):
573
# We don't want to call selftest for the whole suite, so we start with
575
test_list_fname = 'test.list'
576
fl = open(test_list_fname, 'wt')
577
fl.write('%s\n' % self.id())
579
out, err = self.run_bzr(
580
['selftest', '--load-list', test_list_fname, '--list'])
581
self.assertContainsRe(out, "TestSelftestWithIdList")
582
self.assertLength(1, out.splitlines())
584
def test_load_unknown(self):
585
out, err = self.run_bzr('selftest --load-list I_do_not_exist ',
589
class TestSelftestStartingWith(TestCase):
591
def test_starting_with_single_argument(self):
592
out, err = self.run_bzr(
593
['selftest', '--starting-with', self.id(), '--list'])
594
self.assertContainsRe(out, self.id())
596
def test_starting_with_multiple_argument(self):
597
out, err = self.run_bzr(
599
'--starting-with', self.id(),
600
'--starting-with', 'bzrlib.tests.test_sampler',
602
self.assertContainsRe(out, self.id())
603
self.assertContainsRe(out, 'bzrlib.tests.test_sampler')
added
removed
bzrlib/tests/blackbox/test_selftest.py
