← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-30 12:52:54 UTC
  • mto: This revision was merged to the branch mainline in revision 6418.
  • Revision ID: jelmer@samba.org-20111230125254-igy1abnixsvulfqd
Simplify code a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_branch.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
16
16
 
17
17
"""Tests for the Branch facility that are not interface  tests.
18
18
 
19
 
For interface tests see tests/per_branch/*.py.
 
19
For interface tests see `tests/per_branch/*.py`.
20
20
 
21
21
For concrete class tests see this file, and for meta-branch tests
22
22
also see this file.
29
29
    bzrdir,
30
30
    config,
31
31
    errors,
 
32
    symbol_versioning,
32
33
    tests,
33
34
    trace,
34
 
    transport,
35
35
    urlutils,
36
36
    )
37
37
 
40
40
 
41
41
    def test_default_format(self):
42
42
        # update this if you change the default branch format
43
 
        self.assertIsInstance(_mod_branch.BranchFormat.get_default_format(),
 
43
        self.assertIsInstance(_mod_branch.format_registry.get_default(),
44
44
                _mod_branch.BzrBranchFormat7)
45
45
 
46
46
    def test_default_format_is_same_as_bzrdir_default(self):
48
48
        # set, but at the moment that's not true -- mbp 20070814 --
49
49
        # https://bugs.launchpad.net/bzr/+bug/132376
50
50
        self.assertEqual(
51
 
            _mod_branch.BranchFormat.get_default_format(),
 
51
            _mod_branch.format_registry.get_default(),
52
52
            bzrdir.BzrDirFormat.get_default_format().get_branch_format())
53
53
 
54
54
    def test_get_set_default_format(self):
55
55
        # set the format and then set it back again
56
 
        old_format = _mod_branch.BranchFormat.get_default_format()
57
 
        _mod_branch.BranchFormat.set_default_format(SampleBranchFormat())
 
56
        old_format = _mod_branch.format_registry.get_default()
 
57
        _mod_branch.format_registry.set_default(SampleBranchFormat())
58
58
        try:
59
59
            # the default branch format is used by the meta dir format
60
60
            # which is not the default bzrdir format at this point
62
62
            result = dir.create_branch()
63
63
            self.assertEqual(result, 'A branch')
64
64
        finally:
65
 
            _mod_branch.BranchFormat.set_default_format(old_format)
 
65
            _mod_branch.format_registry.set_default(old_format)
66
66
        self.assertEqual(old_format,
67
 
                         _mod_branch.BranchFormat.get_default_format())
 
67
                         _mod_branch.format_registry.get_default())
68
68
 
69
69
 
70
70
class TestBranchFormat5(tests.TestCaseWithTransport):
74
74
        url = self.get_url()
75
75
        bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
76
76
        bdir.create_repository()
77
 
        branch = bdir.create_branch()
 
77
        branch = _mod_branch.BzrBranchFormat5().initialize(bdir)
78
78
        t = self.get_transport()
79
79
        self.log("branch instance is %r" % branch)
80
80
        self.assert_(isinstance(branch, _mod_branch.BzrBranch5))
86
86
        self.assertIsDirectory('.bzr/branch/lock/held', t)
87
87
 
88
88
    def test_set_push_location(self):
89
 
        from bzrlib.config import (locations_config_filename,
90
 
                                   ensure_config_dir_exists)
91
 
        ensure_config_dir_exists()
92
 
        fn = locations_config_filename()
93
 
        # write correct newlines to locations.conf
94
 
        # by default ConfigObj uses native line-endings for new files
95
 
        # but uses already existing line-endings if file is not empty
96
 
        f = open(fn, 'wb')
97
 
        try:
98
 
            f.write('# comment\n')
99
 
        finally:
100
 
            f.close()
 
89
        conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
101
90
 
102
91
        branch = self.make_branch('.', format='knit')
103
92
        branch.set_push_location('foo')
106
95
                             "[%s]\n"
107
96
                             "push_location = foo\n"
108
97
                             "push_location:policy = norecurse\n" % local_path,
109
 
                             fn)
 
98
                             config.locations_config_filename())
110
99
 
111
100
    # TODO RBC 20051029 test getting a push location from a branch in a
112
101
    # recursive section - that is, it appends the branch name.
113
102
 
114
103
 
115
 
class SampleBranchFormat(_mod_branch.BranchFormat):
 
104
class SampleBranchFormat(_mod_branch.BranchFormatMetadir):
116
105
    """A sample format
117
106
 
118
107
    this format is initializable, unsupported to aid in testing the
119
108
    open and open_downlevel routines.
120
109
    """
121
110
 
122
 
    def get_format_string(self):
 
111
    @classmethod
 
112
    def get_format_string(cls):
123
113
        """See BzrBranchFormat.get_format_string()."""
124
114
        return "Sample branch format."
125
115
 
126
 
    def initialize(self, a_bzrdir):
 
116
    def initialize(self, a_bzrdir, name=None, repository=None,
 
117
                   append_revisions_only=None):
127
118
        """Format 4 branches cannot be created."""
128
 
        t = a_bzrdir.get_branch_transport(self)
 
119
        t = a_bzrdir.get_branch_transport(self, name=name)
129
120
        t.put_bytes('format', self.get_format_string())
130
121
        return 'A branch'
131
122
 
132
123
    def is_supported(self):
133
124
        return False
134
125
 
135
 
    def open(self, transport, _found=False, ignore_fallbacks=False):
 
126
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
127
             possible_transports=None):
136
128
        return "opened branch."
137
129
 
138
130
 
 
131
# Demonstrating how lazy loading is often implemented:
 
132
# A constant string is created.
 
133
SampleSupportedBranchFormatString = "Sample supported branch format."
 
134
 
 
135
# And the format class can then reference the constant to avoid skew.
 
136
class SampleSupportedBranchFormat(_mod_branch.BranchFormatMetadir):
 
137
    """A sample supported format."""
 
138
 
 
139
    @classmethod
 
140
    def get_format_string(cls):
 
141
        """See BzrBranchFormat.get_format_string()."""
 
142
        return SampleSupportedBranchFormatString
 
143
 
 
144
    def initialize(self, a_bzrdir, name=None, append_revisions_only=None):
 
145
        t = a_bzrdir.get_branch_transport(self, name=name)
 
146
        t.put_bytes('format', self.get_format_string())
 
147
        return 'A branch'
 
148
 
 
149
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
150
             possible_transports=None):
 
151
        return "opened supported branch."
 
152
 
 
153
 
 
154
class SampleExtraBranchFormat(_mod_branch.BranchFormat):
 
155
    """A sample format that is not usable in a metadir."""
 
156
 
 
157
    def get_format_string(self):
 
158
        # This format is not usable in a metadir.
 
159
        return None
 
160
 
 
161
    def network_name(self):
 
162
        # Network name always has to be provided.
 
163
        return "extra"
 
164
 
 
165
    def initialize(self, a_bzrdir, name=None):
 
166
        raise NotImplementedError(self.initialize)
 
167
 
 
168
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
169
             possible_transports=None):
 
170
        raise NotImplementedError(self.open)
 
171
 
 
172
 
139
173
class TestBzrBranchFormat(tests.TestCaseWithTransport):
140
174
    """Tests for the BzrBranchFormat facility."""
141
175
 
148
182
            dir = format._matchingbzrdir.initialize(url)
149
183
            dir.create_repository()
150
184
            format.initialize(dir)
151
 
            found_format = _mod_branch.BranchFormat.find_format(dir)
152
 
            self.failUnless(isinstance(found_format, format.__class__))
 
185
            found_format = _mod_branch.BranchFormatMetadir.find_format(dir)
 
186
            self.assertIsInstance(found_format, format.__class__)
153
187
        check_format(_mod_branch.BzrBranchFormat5(), "bar")
154
188
 
 
189
    def test_find_format_factory(self):
 
190
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
 
191
        SampleSupportedBranchFormat().initialize(dir)
 
192
        factory = _mod_branch.MetaDirBranchFormatFactory(
 
193
            SampleSupportedBranchFormatString,
 
194
            "bzrlib.tests.test_branch", "SampleSupportedBranchFormat")
 
195
        _mod_branch.format_registry.register(factory)
 
196
        self.addCleanup(_mod_branch.format_registry.remove, factory)
 
197
        b = _mod_branch.Branch.open(self.get_url())
 
198
        self.assertEqual(b, "opened supported branch.")
 
199
 
 
200
    def test_from_string(self):
 
201
        self.assertIsInstance(
 
202
            SampleBranchFormat.from_string("Sample branch format."),
 
203
            SampleBranchFormat)
 
204
        self.assertRaises(AssertionError,
 
205
            SampleBranchFormat.from_string, "Different branch format.")
 
206
 
155
207
    def test_find_format_not_branch(self):
156
208
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
157
209
        self.assertRaises(errors.NotBranchError,
158
 
                          _mod_branch.BranchFormat.find_format,
 
210
                          _mod_branch.BranchFormatMetadir.find_format,
159
211
                          dir)
160
212
 
161
213
    def test_find_format_unknown_format(self):
162
214
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
163
215
        SampleBranchFormat().initialize(dir)
164
216
        self.assertRaises(errors.UnknownFormatError,
165
 
                          _mod_branch.BranchFormat.find_format,
 
217
                          _mod_branch.BranchFormatMetadir.find_format,
166
218
                          dir)
167
219
 
 
220
    def test_find_format_with_features(self):
 
221
        tree = self.make_branch_and_tree('.', format='2a')
 
222
        tree.branch.control_transport.put_bytes('format',
 
223
            tree.branch._format.get_format_string() +
 
224
            "optional name\n")
 
225
        found_format = _mod_branch.BranchFormatMetadir.find_format(tree.bzrdir)
 
226
        self.assertIsInstance(found_format, _mod_branch.BranchFormatMetadir)
 
227
        self.assertEquals(found_format.features.get("name"), "optional")
 
228
 
168
229
    def test_register_unregister_format(self):
 
230
        # Test the deprecated format registration functions
169
231
        format = SampleBranchFormat()
170
232
        # make a control dir
171
233
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
172
234
        # make a branch
173
235
        format.initialize(dir)
174
236
        # register a format for it.
175
 
        _mod_branch.BranchFormat.register_format(format)
 
237
        self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
 
238
            _mod_branch.BranchFormat.register_format, format)
176
239
        # which branch.Open will refuse (not supported)
177
240
        self.assertRaises(errors.UnsupportedFormatError,
178
241
                          _mod_branch.Branch.open, self.get_url())
182
245
            format.open(dir),
183
246
            bzrdir.BzrDir.open(self.get_url()).open_branch(unsupported=True))
184
247
        # unregister the format
185
 
        _mod_branch.BranchFormat.unregister_format(format)
 
248
        self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
 
249
            _mod_branch.BranchFormat.unregister_format, format)
186
250
        self.make_branch_and_tree('bar')
187
251
 
188
252
 
 
253
class TestBranchFormatRegistry(tests.TestCase):
 
254
 
 
255
    def setUp(self):
 
256
        super(TestBranchFormatRegistry, self).setUp()
 
257
        self.registry = _mod_branch.BranchFormatRegistry()
 
258
 
 
259
    def test_default(self):
 
260
        self.assertIs(None, self.registry.get_default())
 
261
        format = SampleBranchFormat()
 
262
        self.registry.set_default(format)
 
263
        self.assertEquals(format, self.registry.get_default())
 
264
 
 
265
    def test_register_unregister_format(self):
 
266
        format = SampleBranchFormat()
 
267
        self.registry.register(format)
 
268
        self.assertEquals(format,
 
269
            self.registry.get("Sample branch format."))
 
270
        self.registry.remove(format)
 
271
        self.assertRaises(KeyError, self.registry.get,
 
272
            "Sample branch format.")
 
273
 
 
274
    def test_get_all(self):
 
275
        format = SampleBranchFormat()
 
276
        self.assertEquals([], self.registry._get_all())
 
277
        self.registry.register(format)
 
278
        self.assertEquals([format], self.registry._get_all())
 
279
 
 
280
    def test_register_extra(self):
 
281
        format = SampleExtraBranchFormat()
 
282
        self.assertEquals([], self.registry._get_all())
 
283
        self.registry.register_extra(format)
 
284
        self.assertEquals([format], self.registry._get_all())
 
285
 
 
286
    def test_register_extra_lazy(self):
 
287
        self.assertEquals([], self.registry._get_all())
 
288
        self.registry.register_extra_lazy("bzrlib.tests.test_branch",
 
289
            "SampleExtraBranchFormat")
 
290
        formats = self.registry._get_all()
 
291
        self.assertEquals(1, len(formats))
 
292
        self.assertIsInstance(formats[0], SampleExtraBranchFormat)
 
293
 
 
294
 
 
295
#Used by TestMetaDirBranchFormatFactory 
 
296
FakeLazyFormat = None
 
297
 
 
298
 
 
299
class TestMetaDirBranchFormatFactory(tests.TestCase):
 
300
 
 
301
    def test_get_format_string_does_not_load(self):
 
302
        """Formats have a static format string."""
 
303
        factory = _mod_branch.MetaDirBranchFormatFactory("yo", None, None)
 
304
        self.assertEqual("yo", factory.get_format_string())
 
305
 
 
306
    def test_call_loads(self):
 
307
        # __call__ is used by the network_format_registry interface to get a
 
308
        # Format.
 
309
        global FakeLazyFormat
 
310
        del FakeLazyFormat
 
311
        factory = _mod_branch.MetaDirBranchFormatFactory(None,
 
312
            "bzrlib.tests.test_branch", "FakeLazyFormat")
 
313
        self.assertRaises(AttributeError, factory)
 
314
 
 
315
    def test_call_returns_call_of_referenced_object(self):
 
316
        global FakeLazyFormat
 
317
        FakeLazyFormat = lambda:'called'
 
318
        factory = _mod_branch.MetaDirBranchFormatFactory(None,
 
319
            "bzrlib.tests.test_branch", "FakeLazyFormat")
 
320
        self.assertEqual('called', factory())
 
321
 
 
322
 
189
323
class TestBranch67(object):
190
324
    """Common tests for both branch 6 and 7 which are mostly the same."""
191
325
 
210
344
 
211
345
    def test_layout(self):
212
346
        branch = self.make_branch('a', format=self.get_format_name())
213
 
        self.failUnlessExists('a/.bzr/branch/last-revision')
214
 
        self.failIfExists('a/.bzr/branch/revision-history')
215
 
        self.failIfExists('a/.bzr/branch/references')
 
347
        self.assertPathExists('a/.bzr/branch/last-revision')
 
348
        self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
 
349
        self.assertPathDoesNotExist('a/.bzr/branch/references')
216
350
 
217
351
    def test_config(self):
218
352
        """Ensure that all configuration data is stored in the branch"""
219
353
        branch = self.make_branch('a', format=self.get_format_name())
220
 
        branch.set_parent('http://bazaar-vcs.org')
221
 
        self.failIfExists('a/.bzr/branch/parent')
222
 
        self.assertEqual('http://bazaar-vcs.org', branch.get_parent())
223
 
        branch.set_push_location('sftp://bazaar-vcs.org')
 
354
        branch.set_parent('http://example.com')
 
355
        self.assertPathDoesNotExist('a/.bzr/branch/parent')
 
356
        self.assertEqual('http://example.com', branch.get_parent())
 
357
        branch.set_push_location('sftp://example.com')
224
358
        config = branch.get_config()._get_branch_data_config()
225
 
        self.assertEqual('sftp://bazaar-vcs.org',
 
359
        self.assertEqual('sftp://example.com',
226
360
                         config.get_user_option('push_location'))
227
 
        branch.set_bound_location('ftp://bazaar-vcs.org')
228
 
        self.failIfExists('a/.bzr/branch/bound')
229
 
        self.assertEqual('ftp://bazaar-vcs.org', branch.get_bound_location())
 
361
        branch.set_bound_location('ftp://example.com')
 
362
        self.assertPathDoesNotExist('a/.bzr/branch/bound')
 
363
        self.assertEqual('ftp://example.com', branch.get_bound_location())
230
364
 
231
365
    def test_set_revision_history(self):
232
366
        builder = self.make_branch_builder('.', format=self.get_format_name())
237
371
        branch = builder.get_branch()
238
372
        branch.lock_write()
239
373
        self.addCleanup(branch.unlock)
240
 
        branch.set_revision_history(['foo', 'bar'])
241
 
        branch.set_revision_history(['foo'])
 
374
        self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
 
375
            branch.set_revision_history, ['foo', 'bar'])
 
376
        self.applyDeprecated(symbol_versioning.deprecated_in((2, 4, 0)),
 
377
                branch.set_revision_history, ['foo'])
242
378
        self.assertRaises(errors.NotLefthandHistory,
243
 
                          branch.set_revision_history, ['bar'])
 
379
            self.applyDeprecated, symbol_versioning.deprecated_in((2, 4, 0)),
 
380
            branch.set_revision_history, ['bar'])
244
381
 
245
382
    def do_checkout_test(self, lightweight=False):
246
383
        tree = self.make_branch_and_tree('source',
259
396
        subtree.commit('a subtree file')
260
397
        subsubtree.commit('a subsubtree file')
261
398
        tree.branch.create_checkout('target', lightweight=lightweight)
262
 
        self.failUnlessExists('target')
263
 
        self.failUnlessExists('target/subtree')
264
 
        self.failUnlessExists('target/subtree/file')
265
 
        self.failUnlessExists('target/subtree/subsubtree/file')
 
399
        self.assertPathExists('target')
 
400
        self.assertPathExists('target/subtree')
 
401
        self.assertPathExists('target/subtree/file')
 
402
        self.assertPathExists('target/subtree/subsubtree/file')
266
403
        subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
267
404
        if lightweight:
268
405
            self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
275
412
    def test_light_checkout_with_references(self):
276
413
        self.do_checkout_test(lightweight=True)
277
414
 
278
 
    def test_set_push(self):
279
 
        branch = self.make_branch('source', format=self.get_format_name())
280
 
        branch.get_config().set_user_option('push_location', 'old',
281
 
            store=config.STORE_LOCATION)
282
 
        warnings = []
283
 
        def warning(*args):
284
 
            warnings.append(args[0] % args[1:])
285
 
        _warning = trace.warning
286
 
        trace.warning = warning
287
 
        try:
288
 
            branch.set_push_location('new')
289
 
        finally:
290
 
            trace.warning = _warning
291
 
        self.assertEqual(warnings[0], 'Value "new" is masked by "old" from '
292
 
                         'locations.conf')
293
 
 
294
415
 
295
416
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
296
417
 
425
546
        self.assertEqual(('path3', 'location3'),
426
547
                         branch.get_reference_info('file-id'))
427
548
 
 
549
    def _recordParentMapCalls(self, repo):
 
550
        self._parent_map_calls = []
 
551
        orig_get_parent_map = repo.revisions.get_parent_map
 
552
        def get_parent_map(q):
 
553
            q = list(q)
 
554
            self._parent_map_calls.extend([e[0] for e in q])
 
555
            return orig_get_parent_map(q)
 
556
        repo.revisions.get_parent_map = get_parent_map
 
557
 
 
558
 
428
559
class TestBranchReference(tests.TestCaseWithTransport):
429
560
    """Tests for the branch reference facility."""
430
561
 
431
562
    def test_create_open_reference(self):
432
563
        bzrdirformat = bzrdir.BzrDirMetaFormat1()
433
 
        t = transport.get_transport(self.get_url('.'))
 
564
        t = self.get_transport()
434
565
        t.mkdir('repo')
435
566
        dir = bzrdirformat.initialize(self.get_url('repo'))
436
567
        dir.create_repository()
438
569
        t.mkdir('branch')
439
570
        branch_dir = bzrdirformat.initialize(self.get_url('branch'))
440
571
        made_branch = _mod_branch.BranchReferenceFormat().initialize(
441
 
            branch_dir, target_branch)
 
572
            branch_dir, target_branch=target_branch)
442
573
        self.assertEqual(made_branch.base, target_branch.base)
443
574
        opened_branch = branch_dir.open_branch()
444
575
        self.assertEqual(opened_branch.base, target_branch.base)
455
586
            _mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
456
587
 
457
588
 
458
 
class TestHooks(tests.TestCase):
 
589
class TestHooks(tests.TestCaseWithTransport):
459
590
 
460
591
    def test_constructor(self):
461
592
        """Check that creating a BranchHooks instance has the right defaults."""
469
600
                        "post_uncommit not in %s" % hooks)
470
601
        self.assertTrue("post_change_branch_tip" in hooks,
471
602
                        "post_change_branch_tip not in %s" % hooks)
 
603
        self.assertTrue("post_branch_init" in hooks,
 
604
                        "post_branch_init not in %s" % hooks)
 
605
        self.assertTrue("post_switch" in hooks,
 
606
                        "post_switch not in %s" % hooks)
472
607
 
473
608
    def test_installed_hooks_are_BranchHooks(self):
474
609
        """The installed hooks object should be a BranchHooks."""
476
611
        self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
477
612
                              _mod_branch.BranchHooks)
478
613
 
 
614
    def test_post_branch_init_hook(self):
 
615
        calls = []
 
616
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
 
617
            calls.append, None)
 
618
        self.assertLength(0, calls)
 
619
        branch = self.make_branch('a')
 
620
        self.assertLength(1, calls)
 
621
        params = calls[0]
 
622
        self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
 
623
        self.assertTrue(hasattr(params, 'bzrdir'))
 
624
        self.assertTrue(hasattr(params, 'branch'))
 
625
 
 
626
    def test_post_branch_init_hook_repr(self):
 
627
        param_reprs = []
 
628
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
 
629
            lambda params: param_reprs.append(repr(params)), None)
 
630
        branch = self.make_branch('a')
 
631
        self.assertLength(1, param_reprs)
 
632
        param_repr = param_reprs[0]
 
633
        self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
 
634
 
 
635
    def test_post_switch_hook(self):
 
636
        from bzrlib import switch
 
637
        calls = []
 
638
        _mod_branch.Branch.hooks.install_named_hook('post_switch',
 
639
            calls.append, None)
 
640
        tree = self.make_branch_and_tree('branch-1')
 
641
        self.build_tree(['branch-1/file-1'])
 
642
        tree.add('file-1')
 
643
        tree.commit('rev1')
 
644
        to_branch = tree.bzrdir.sprout('branch-2').open_branch()
 
645
        self.build_tree(['branch-1/file-2'])
 
646
        tree.add('file-2')
 
647
        tree.remove('file-1')
 
648
        tree.commit('rev2')
 
649
        checkout = tree.branch.create_checkout('checkout')
 
650
        self.assertLength(0, calls)
 
651
        switch.switch(checkout.bzrdir, to_branch)
 
652
        self.assertLength(1, calls)
 
653
        params = calls[0]
 
654
        self.assertIsInstance(params, _mod_branch.SwitchHookParams)
 
655
        self.assertTrue(hasattr(params, 'to_branch'))
 
656
        self.assertTrue(hasattr(params, 'revision_id'))
 
657
 
 
658
 
 
659
class TestBranchOptions(tests.TestCaseWithTransport):
 
660
 
 
661
    def setUp(self):
 
662
        super(TestBranchOptions, self).setUp()
 
663
        self.branch = self.make_branch('.')
 
664
        self.config_stack = self.branch.get_config_stack()
 
665
 
 
666
    def check_append_revisions_only(self, expected_value, value=None):
 
667
        """Set append_revisions_only in config and check its interpretation."""
 
668
        if value is not None:
 
669
            self.config_stack.set('append_revisions_only', value)
 
670
        self.assertEqual(expected_value,
 
671
                         self.branch.get_append_revisions_only())
 
672
 
 
673
    def test_valid_append_revisions_only(self):
 
674
        self.assertEquals(None,
 
675
                          self.config_stack.get('append_revisions_only'))
 
676
        self.check_append_revisions_only(None)
 
677
        self.check_append_revisions_only(False, 'False')
 
678
        self.check_append_revisions_only(True, 'True')
 
679
        # The following values will cause compatibility problems on projects
 
680
        # using older bzr versions (<2.2) but are accepted
 
681
        self.check_append_revisions_only(False, 'false')
 
682
        self.check_append_revisions_only(True, 'true')
 
683
 
 
684
    def test_invalid_append_revisions_only(self):
 
685
        """Ensure warning is noted on invalid settings"""
 
686
        self.warnings = []
 
687
        def warning(*args):
 
688
            self.warnings.append(args[0] % args[1:])
 
689
        self.overrideAttr(trace, 'warning', warning)
 
690
        self.check_append_revisions_only(None, 'not-a-bool')
 
691
        self.assertLength(1, self.warnings)
 
692
        self.assertEqual(
 
693
            'Value "not-a-bool" is not valid for "append_revisions_only"',
 
694
            self.warnings[0])
 
695
 
479
696
 
480
697
class TestPullResult(tests.TestCase):
481
698
 
487
704
        # this usage of results is not recommended for new code (because it
488
705
        # doesn't describe very well what happened), but for api stability
489
706
        # it's still supported
490
 
        a = "%d revisions pulled" % r
491
 
        self.assertEqual(a, "10 revisions pulled")
 
707
        self.assertEqual(self.applyDeprecated(
 
708
            symbol_versioning.deprecated_in((2, 3, 0)),
 
709
            r.__int__),
 
710
            10)
492
711
 
493
712
    def test_report_changed(self):
494
713
        r = _mod_branch.PullResult()
499
718
        f = StringIO()
500
719
        r.report(f)
501
720
        self.assertEqual("Now on revision 20.\n", f.getvalue())
 
721
        self.assertEqual("Now on revision 20.\n", f.getvalue())
502
722
 
503
723
    def test_report_unchanged(self):
504
724
        r = _mod_branch.PullResult()
506
726
        r.new_revid = "same-revid"
507
727
        f = StringIO()
508
728
        r.report(f)
509
 
        self.assertEqual("No revisions to pull.\n", f.getvalue())
510
 
 
511
 
 
512
 
class _StubLockable(object):
513
 
    """Helper for TestRunWithWriteLockedTarget."""
514
 
 
515
 
    def __init__(self, calls, unlock_exc=None):
516
 
        self.calls = calls
517
 
        self.unlock_exc = unlock_exc
518
 
 
519
 
    def lock_write(self):
520
 
        self.calls.append('lock_write')
521
 
 
522
 
    def unlock(self):
523
 
        self.calls.append('unlock')
524
 
        if self.unlock_exc is not None:
525
 
            raise self.unlock_exc
526
 
 
527
 
 
528
 
class _ErrorFromCallable(Exception):
529
 
    """Helper for TestRunWithWriteLockedTarget."""
530
 
 
531
 
 
532
 
class _ErrorFromUnlock(Exception):
533
 
    """Helper for TestRunWithWriteLockedTarget."""
534
 
 
535
 
 
536
 
class TestRunWithWriteLockedTarget(tests.TestCase):
537
 
    """Tests for _run_with_write_locked_target."""
538
 
 
539
 
    def setUp(self):
540
 
        tests.TestCase.setUp(self)
541
 
        self._calls = []
542
 
 
543
 
    def func_that_returns_ok(self):
544
 
        self._calls.append('func called')
545
 
        return 'ok'
546
 
 
547
 
    def func_that_raises(self):
548
 
        self._calls.append('func called')
549
 
        raise _ErrorFromCallable()
550
 
 
551
 
    def test_success_unlocks(self):
552
 
        lockable = _StubLockable(self._calls)
553
 
        result = _mod_branch._run_with_write_locked_target(
554
 
            lockable, self.func_that_returns_ok)
555
 
        self.assertEqual('ok', result)
556
 
        self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
557
 
 
558
 
    def test_exception_unlocks_and_propagates(self):
559
 
        lockable = _StubLockable(self._calls)
560
 
        self.assertRaises(_ErrorFromCallable,
561
 
                          _mod_branch._run_with_write_locked_target,
562
 
                          lockable, self.func_that_raises)
563
 
        self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
564
 
 
565
 
    def test_callable_succeeds_but_error_during_unlock(self):
566
 
        lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
567
 
        self.assertRaises(_ErrorFromUnlock,
568
 
                          _mod_branch._run_with_write_locked_target,
569
 
                          lockable, self.func_that_returns_ok)
570
 
        self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
571
 
 
572
 
    def test_error_during_unlock_does_not_mask_original_error(self):
573
 
        lockable = _StubLockable(self._calls, unlock_exc=_ErrorFromUnlock())
574
 
        self.assertRaises(_ErrorFromCallable,
575
 
                          _mod_branch._run_with_write_locked_target,
576
 
                          lockable, self.func_that_raises)
577
 
        self.assertEqual(['lock_write', 'func called', 'unlock'], self._calls)
578
 
 
579
 
 
 
729
        self.assertEqual("No revisions or tags to pull.\n", f.getvalue())