/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_branch.py

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006-2012, 2016 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Tests for the Branch facility that are not interface  tests.
 
18
 
 
19
For interface tests see `tests/per_branch/*.py`.
 
20
 
 
21
For concrete class tests see this file, and for meta-branch tests
 
22
also see this file.
 
23
"""
 
24
 
 
25
from io import StringIO
 
26
 
 
27
from .. import (
 
28
    bedding,
 
29
    branch as _mod_branch,
 
30
    config,
 
31
    controldir,
 
32
    errors,
 
33
    tests,
 
34
    trace,
 
35
    urlutils,
 
36
    )
 
37
from ..bzr import (
 
38
    branch as _mod_bzrbranch,
 
39
    bzrdir,
 
40
    )
 
41
from ..bzr.fullhistory import (
 
42
    BzrBranch5,
 
43
    BzrBranchFormat5,
 
44
    )
 
45
 
 
46
 
 
47
class TestErrors(tests.TestCase):
 
48
 
 
49
    def test_unstackable_branch_format(self):
 
50
        format = u'foo'
 
51
        url = "/foo"
 
52
        error = _mod_branch.UnstackableBranchFormat(format, url)
 
53
        self.assertEqualDiff(
 
54
            "The branch '/foo'(foo) is not a stackable format. "
 
55
            "You will need to upgrade the branch to permit branch stacking.",
 
56
            str(error))
 
57
 
 
58
 
 
59
class TestDefaultFormat(tests.TestCase):
 
60
 
 
61
    def test_default_format(self):
 
62
        # update this if you change the default branch format
 
63
        self.assertIsInstance(_mod_branch.format_registry.get_default(),
 
64
                              _mod_bzrbranch.BzrBranchFormat7)
 
65
 
 
66
    def test_default_format_is_same_as_bzrdir_default(self):
 
67
        # XXX: it might be nice if there was only one place the default was
 
68
        # set, but at the moment that's not true -- mbp 20070814 --
 
69
        # https://bugs.launchpad.net/bzr/+bug/132376
 
70
        self.assertEqual(
 
71
            _mod_branch.format_registry.get_default(),
 
72
            bzrdir.BzrDirFormat.get_default_format().get_branch_format())
 
73
 
 
74
    def test_get_set_default_format(self):
 
75
        # set the format and then set it back again
 
76
        old_format = _mod_branch.format_registry.get_default()
 
77
        _mod_branch.format_registry.set_default(
 
78
            SampleBranchFormat())
 
79
        try:
 
80
            # the default branch format is used by the meta dir format
 
81
            # which is not the default bzrdir format at this point
 
82
            dir = bzrdir.BzrDirMetaFormat1().initialize('memory:///')
 
83
            result = dir.create_branch()
 
84
            self.assertEqual(result, 'A branch')
 
85
        finally:
 
86
            _mod_branch.format_registry.set_default(old_format)
 
87
        self.assertEqual(old_format,
 
88
                         _mod_branch.format_registry.get_default())
 
89
 
 
90
 
 
91
class TestBranchFormat5(tests.TestCaseWithTransport):
 
92
    """Tests specific to branch format 5"""
 
93
 
 
94
    def test_branch_format_5_uses_lockdir(self):
 
95
        url = self.get_url()
 
96
        bdir = bzrdir.BzrDirMetaFormat1().initialize(url)
 
97
        bdir.create_repository()
 
98
        branch = BzrBranchFormat5().initialize(bdir)
 
99
        t = self.get_transport()
 
100
        self.log("branch instance is %r" % branch)
 
101
        self.assertTrue(isinstance(branch, BzrBranch5))
 
102
        self.assertIsDirectory('.', t)
 
103
        self.assertIsDirectory('.bzr/branch', t)
 
104
        self.assertIsDirectory('.bzr/branch/lock', t)
 
105
        branch.lock_write()
 
106
        self.addCleanup(branch.unlock)
 
107
        self.assertIsDirectory('.bzr/branch/lock/held', t)
 
108
 
 
109
    def test_set_push_location(self):
 
110
        conf = config.LocationConfig.from_string('# comment\n', '.', save=True)
 
111
 
 
112
        branch = self.make_branch('.', format='knit')
 
113
        branch.set_push_location('foo')
 
114
        local_path = urlutils.local_path_from_url(branch.base[:-1])
 
115
        self.assertFileEqual(b"# comment\n"
 
116
                             b"[%s]\n"
 
117
                             b"push_location = foo\n"
 
118
                             b"push_location:policy = norecurse\n" % local_path.encode(
 
119
                                 'utf-8'),
 
120
                             bedding.locations_config_path())
 
121
 
 
122
    # TODO RBC 20051029 test getting a push location from a branch in a
 
123
    # recursive section - that is, it appends the branch name.
 
124
 
 
125
 
 
126
class SampleBranchFormat(_mod_bzrbranch.BranchFormatMetadir):
 
127
    """A sample format
 
128
 
 
129
    this format is initializable, unsupported to aid in testing the
 
130
    open and open_downlevel routines.
 
131
    """
 
132
 
 
133
    @classmethod
 
134
    def get_format_string(cls):
 
135
        """See BzrBranchFormat.get_format_string()."""
 
136
        return b"Sample branch format."
 
137
 
 
138
    def initialize(self, a_controldir, name=None, repository=None,
 
139
                   append_revisions_only=None):
 
140
        """Format 4 branches cannot be created."""
 
141
        t = a_controldir.get_branch_transport(self, name=name)
 
142
        t.put_bytes('format', self.get_format_string())
 
143
        return 'A branch'
 
144
 
 
145
    def is_supported(self):
 
146
        return False
 
147
 
 
148
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
149
             possible_transports=None):
 
150
        return "opened branch."
 
151
 
 
152
 
 
153
# Demonstrating how lazy loading is often implemented:
 
154
# A constant string is created.
 
155
SampleSupportedBranchFormatString = b"Sample supported branch format."
 
156
 
 
157
# And the format class can then reference the constant to avoid skew.
 
158
 
 
159
 
 
160
class SampleSupportedBranchFormat(_mod_bzrbranch.BranchFormatMetadir):
 
161
    """A sample supported format."""
 
162
 
 
163
    @classmethod
 
164
    def get_format_string(cls):
 
165
        """See BzrBranchFormat.get_format_string()."""
 
166
        return SampleSupportedBranchFormatString
 
167
 
 
168
    def initialize(self, a_controldir, name=None, append_revisions_only=None):
 
169
        t = a_controldir.get_branch_transport(self, name=name)
 
170
        t.put_bytes('format', self.get_format_string())
 
171
        return 'A branch'
 
172
 
 
173
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
174
             possible_transports=None):
 
175
        return "opened supported branch."
 
176
 
 
177
 
 
178
class SampleExtraBranchFormat(_mod_branch.BranchFormat):
 
179
    """A sample format that is not usable in a metadir."""
 
180
 
 
181
    def get_format_string(self):
 
182
        # This format is not usable in a metadir.
 
183
        return None
 
184
 
 
185
    def network_name(self):
 
186
        # Network name always has to be provided.
 
187
        return "extra"
 
188
 
 
189
    def initialize(self, a_controldir, name=None):
 
190
        raise NotImplementedError(self.initialize)
 
191
 
 
192
    def open(self, transport, name=None, _found=False, ignore_fallbacks=False,
 
193
             possible_transports=None):
 
194
        raise NotImplementedError(self.open)
 
195
 
 
196
 
 
197
class TestBzrBranchFormat(tests.TestCaseWithTransport):
 
198
    """Tests for the BzrBranchFormat facility."""
 
199
 
 
200
    def test_find_format(self):
 
201
        # is the right format object found for a branch?
 
202
        # create a branch with a few known format objects.
 
203
        # this is not quite the same as
 
204
        self.build_tree(["foo/", "bar/"])
 
205
 
 
206
        def check_format(format, url):
 
207
            dir = format._matchingcontroldir.initialize(url)
 
208
            dir.create_repository()
 
209
            format.initialize(dir)
 
210
            found_format = _mod_bzrbranch.BranchFormatMetadir.find_format(dir)
 
211
            self.assertIsInstance(found_format, format.__class__)
 
212
        check_format(BzrBranchFormat5(), "bar")
 
213
 
 
214
    def test_from_string(self):
 
215
        self.assertIsInstance(
 
216
            SampleBranchFormat.from_string(b"Sample branch format."),
 
217
            SampleBranchFormat)
 
218
        self.assertRaises(AssertionError,
 
219
                          SampleBranchFormat.from_string, b"Different branch format.")
 
220
 
 
221
    def test_find_format_not_branch(self):
 
222
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
 
223
        self.assertRaises(errors.NotBranchError,
 
224
                          _mod_bzrbranch.BranchFormatMetadir.find_format,
 
225
                          dir)
 
226
 
 
227
    def test_find_format_unknown_format(self):
 
228
        dir = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
 
229
        SampleBranchFormat().initialize(dir)
 
230
        self.assertRaises(errors.UnknownFormatError,
 
231
                          _mod_bzrbranch.BranchFormatMetadir.find_format,
 
232
                          dir)
 
233
 
 
234
    def test_find_format_with_features(self):
 
235
        tree = self.make_branch_and_tree('.', format='2a')
 
236
        tree.branch.update_feature_flags({b"name": b"optional"})
 
237
        found_format = _mod_bzrbranch.BranchFormatMetadir.find_format(
 
238
            tree.controldir)
 
239
        self.assertIsInstance(found_format, _mod_bzrbranch.BranchFormatMetadir)
 
240
        self.assertEqual(found_format.features.get(b"name"), b"optional")
 
241
        tree.branch.update_feature_flags({b"name": None})
 
242
        branch = _mod_branch.Branch.open('.')
 
243
        self.assertEqual(branch._format.features, {})
 
244
 
 
245
 
 
246
class TestBranchFormatRegistry(tests.TestCase):
 
247
 
 
248
    def setUp(self):
 
249
        super(TestBranchFormatRegistry, self).setUp()
 
250
        self.registry = _mod_branch.BranchFormatRegistry()
 
251
 
 
252
    def test_default(self):
 
253
        self.assertIs(None, self.registry.get_default())
 
254
        format = SampleBranchFormat()
 
255
        self.registry.set_default(format)
 
256
        self.assertEqual(format, self.registry.get_default())
 
257
 
 
258
    def test_register_unregister_format(self):
 
259
        format = SampleBranchFormat()
 
260
        self.registry.register(format)
 
261
        self.assertEqual(format,
 
262
                         self.registry.get(b"Sample branch format."))
 
263
        self.registry.remove(format)
 
264
        self.assertRaises(KeyError, self.registry.get,
 
265
                          b"Sample branch format.")
 
266
 
 
267
    def test_get_all(self):
 
268
        format = SampleBranchFormat()
 
269
        self.assertEqual([], self.registry._get_all())
 
270
        self.registry.register(format)
 
271
        self.assertEqual([format], self.registry._get_all())
 
272
 
 
273
    def test_register_extra(self):
 
274
        format = SampleExtraBranchFormat()
 
275
        self.assertEqual([], self.registry._get_all())
 
276
        self.registry.register_extra(format)
 
277
        self.assertEqual([format], self.registry._get_all())
 
278
 
 
279
    def test_register_extra_lazy(self):
 
280
        self.assertEqual([], self.registry._get_all())
 
281
        self.registry.register_extra_lazy("breezy.tests.test_branch",
 
282
                                          "SampleExtraBranchFormat")
 
283
        formats = self.registry._get_all()
 
284
        self.assertEqual(1, len(formats))
 
285
        self.assertIsInstance(formats[0], SampleExtraBranchFormat)
 
286
 
 
287
 
 
288
class TestBranch67(object):
 
289
    """Common tests for both branch 6 and 7 which are mostly the same."""
 
290
 
 
291
    def get_format_name(self):
 
292
        raise NotImplementedError(self.get_format_name)
 
293
 
 
294
    def get_format_name_subtree(self):
 
295
        raise NotImplementedError(self.get_format_name)
 
296
 
 
297
    def get_class(self):
 
298
        raise NotImplementedError(self.get_class)
 
299
 
 
300
    def test_creation(self):
 
301
        format = bzrdir.BzrDirMetaFormat1()
 
302
        format.set_branch_format(_mod_bzrbranch.BzrBranchFormat6())
 
303
        branch = self.make_branch('a', format=format)
 
304
        self.assertIsInstance(branch, self.get_class())
 
305
        branch = self.make_branch('b', format=self.get_format_name())
 
306
        self.assertIsInstance(branch, self.get_class())
 
307
        branch = _mod_branch.Branch.open('a')
 
308
        self.assertIsInstance(branch, self.get_class())
 
309
 
 
310
    def test_layout(self):
 
311
        branch = self.make_branch('a', format=self.get_format_name())
 
312
        self.assertPathExists('a/.bzr/branch/last-revision')
 
313
        self.assertPathDoesNotExist('a/.bzr/branch/revision-history')
 
314
        self.assertPathDoesNotExist('a/.bzr/branch/references')
 
315
 
 
316
    def test_config(self):
 
317
        """Ensure that all configuration data is stored in the branch"""
 
318
        branch = self.make_branch('a', format=self.get_format_name())
 
319
        branch.set_parent('http://example.com')
 
320
        self.assertPathDoesNotExist('a/.bzr/branch/parent')
 
321
        self.assertEqual('http://example.com', branch.get_parent())
 
322
        branch.set_push_location('sftp://example.com')
 
323
        conf = branch.get_config_stack()
 
324
        self.assertEqual('sftp://example.com', conf.get('push_location'))
 
325
        branch.set_bound_location('ftp://example.com')
 
326
        self.assertPathDoesNotExist('a/.bzr/branch/bound')
 
327
        self.assertEqual('ftp://example.com', branch.get_bound_location())
 
328
 
 
329
    def do_checkout_test(self, lightweight):
 
330
        tree = self.make_branch_and_tree('source',
 
331
                                         format=self.get_format_name_subtree())
 
332
        subtree = self.make_branch_and_tree('source/subtree',
 
333
                                            format=self.get_format_name_subtree())
 
334
        subsubtree = self.make_branch_and_tree('source/subtree/subsubtree',
 
335
                                               format=self.get_format_name_subtree())
 
336
        self.build_tree(['source/subtree/file',
 
337
                         'source/subtree/subsubtree/file'])
 
338
        subsubtree.add('file')
 
339
        subtree.add('file')
 
340
        subtree.add_reference(subsubtree)
 
341
        subtree.set_reference_info('subsubtree', subsubtree.branch.user_url)
 
342
        tree.add_reference(subtree)
 
343
        tree.set_reference_info('subtree', subtree.branch.user_url)
 
344
        tree.commit('a revision')
 
345
        subtree.commit('a subtree file')
 
346
        subsubtree.commit('a subsubtree file')
 
347
        tree.branch.create_checkout('target', lightweight=lightweight)
 
348
        self.assertPathExists('target')
 
349
        self.assertPathExists('target/subtree')
 
350
        self.assertPathExists('target/subtree/file')
 
351
        self.assertPathExists('target/subtree/subsubtree/file')
 
352
        subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
 
353
        if lightweight:
 
354
            self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
 
355
        else:
 
356
            self.assertEndsWith(subbranch.base, 'target/subtree/subsubtree/')
 
357
 
 
358
    def test_checkout_with_references(self):
 
359
        self.do_checkout_test(lightweight=False)
 
360
 
 
361
    def test_light_checkout_with_references(self):
 
362
        self.do_checkout_test(lightweight=True)
 
363
 
 
364
 
 
365
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
 
366
 
 
367
    def get_class(self):
 
368
        return _mod_bzrbranch.BzrBranch6
 
369
 
 
370
    def get_format_name(self):
 
371
        return "dirstate-tags"
 
372
 
 
373
    def get_format_name_subtree(self):
 
374
        return "dirstate-with-subtree"
 
375
 
 
376
    def test_set_stacked_on_url_errors(self):
 
377
        branch = self.make_branch('a', format=self.get_format_name())
 
378
        self.assertRaises(_mod_branch.UnstackableBranchFormat,
 
379
                          branch.set_stacked_on_url, None)
 
380
 
 
381
    def test_default_stacked_location(self):
 
382
        branch = self.make_branch('a', format=self.get_format_name())
 
383
        self.assertRaises(_mod_branch.UnstackableBranchFormat,
 
384
                          branch.get_stacked_on_url)
 
385
 
 
386
 
 
387
class TestBranch7(TestBranch67, tests.TestCaseWithTransport):
 
388
 
 
389
    def get_class(self):
 
390
        return _mod_bzrbranch.BzrBranch7
 
391
 
 
392
    def get_format_name(self):
 
393
        return "1.9"
 
394
 
 
395
    def get_format_name_subtree(self):
 
396
        return "development-subtree"
 
397
 
 
398
    def test_set_stacked_on_url_unstackable_repo(self):
 
399
        repo = self.make_repository('a', format='dirstate-tags')
 
400
        control = repo.controldir
 
401
        branch = _mod_bzrbranch.BzrBranchFormat7().initialize(control)
 
402
        target = self.make_branch('b')
 
403
        self.assertRaises(errors.UnstackableRepositoryFormat,
 
404
                          branch.set_stacked_on_url, target.base)
 
405
 
 
406
    def test_clone_stacked_on_unstackable_repo(self):
 
407
        repo = self.make_repository('a', format='dirstate-tags')
 
408
        control = repo.controldir
 
409
        branch = _mod_bzrbranch.BzrBranchFormat7().initialize(control)
 
410
        # Calling clone should not raise UnstackableRepositoryFormat.
 
411
        cloned_bzrdir = control.clone('cloned')
 
412
 
 
413
    def _test_default_stacked_location(self):
 
414
        branch = self.make_branch('a', format=self.get_format_name())
 
415
        self.assertRaises(errors.NotStacked, branch.get_stacked_on_url)
 
416
 
 
417
    def test_stack_and_unstack(self):
 
418
        branch = self.make_branch('a', format=self.get_format_name())
 
419
        target = self.make_branch_and_tree('b', format=self.get_format_name())
 
420
        branch.set_stacked_on_url(target.branch.base)
 
421
        self.assertEqual(target.branch.base, branch.get_stacked_on_url())
 
422
        revid = target.commit('foo')
 
423
        self.assertTrue(branch.repository.has_revision(revid))
 
424
        branch.set_stacked_on_url(None)
 
425
        self.assertRaises(errors.NotStacked, branch.get_stacked_on_url)
 
426
        self.assertFalse(branch.repository.has_revision(revid))
 
427
 
 
428
    def test_open_opens_stacked_reference(self):
 
429
        branch = self.make_branch('a', format=self.get_format_name())
 
430
        target = self.make_branch_and_tree('b', format=self.get_format_name())
 
431
        branch.set_stacked_on_url(target.branch.base)
 
432
        branch = branch.controldir.open_branch()
 
433
        revid = target.commit('foo')
 
434
        self.assertTrue(branch.repository.has_revision(revid))
 
435
 
 
436
 
 
437
class BzrBranch8(tests.TestCaseWithTransport):
 
438
 
 
439
    def make_branch(self, location, format=None):
 
440
        if format is None:
 
441
            format = controldir.format_registry.make_controldir('1.9')
 
442
            format.set_branch_format(_mod_bzrbranch.BzrBranchFormat8())
 
443
        return tests.TestCaseWithTransport.make_branch(
 
444
            self, location, format=format)
 
445
 
 
446
    def create_branch_with_reference(self):
 
447
        branch = self.make_branch('branch')
 
448
        branch._set_all_reference_info({'path': ('location', b'file-id')})
 
449
        return branch
 
450
 
 
451
    @staticmethod
 
452
    def instrument_branch(branch, gets):
 
453
        old_get = branch._transport.get
 
454
 
 
455
        def get(*args, **kwargs):
 
456
            gets.append((args, kwargs))
 
457
            return old_get(*args, **kwargs)
 
458
        branch._transport.get = get
 
459
 
 
460
    def test_reference_info_caching_read_locked(self):
 
461
        gets = []
 
462
        branch = self.create_branch_with_reference()
 
463
        branch.lock_read()
 
464
        self.addCleanup(branch.unlock)
 
465
        self.instrument_branch(branch, gets)
 
466
        branch.get_reference_info('path')
 
467
        branch.get_reference_info('path')
 
468
        self.assertEqual(1, len(gets))
 
469
 
 
470
    def test_reference_info_caching_read_unlocked(self):
 
471
        gets = []
 
472
        branch = self.create_branch_with_reference()
 
473
        self.instrument_branch(branch, gets)
 
474
        branch.get_reference_info('path')
 
475
        branch.get_reference_info('path')
 
476
        self.assertEqual(2, len(gets))
 
477
 
 
478
    def test_reference_info_caching_write_locked(self):
 
479
        gets = []
 
480
        branch = self.make_branch('branch')
 
481
        branch.lock_write()
 
482
        self.instrument_branch(branch, gets)
 
483
        self.addCleanup(branch.unlock)
 
484
        branch._set_all_reference_info({'path2': ('location2', b'file-id')})
 
485
        location, file_id = branch.get_reference_info('path2')
 
486
        self.assertEqual(0, len(gets))
 
487
        self.assertEqual(b'file-id', file_id)
 
488
        self.assertEqual('location2', location)
 
489
 
 
490
    def test_reference_info_caches_cleared(self):
 
491
        branch = self.make_branch('branch')
 
492
        with branch.lock_write():
 
493
            branch.set_reference_info(b'file-id', 'location2', 'path2')
 
494
        doppelganger = _mod_branch.Branch.open('branch')
 
495
        doppelganger.set_reference_info(b'file-id', 'location3', 'path3')
 
496
        self.assertEqual(('location3', 'path3'),
 
497
                         branch.get_reference_info(b'file-id'))
 
498
 
 
499
    def _recordParentMapCalls(self, repo):
 
500
        self._parent_map_calls = []
 
501
        orig_get_parent_map = repo.revisions.get_parent_map
 
502
 
 
503
        def get_parent_map(q):
 
504
            q = list(q)
 
505
            self._parent_map_calls.extend([e[0] for e in q])
 
506
            return orig_get_parent_map(q)
 
507
        repo.revisions.get_parent_map = get_parent_map
 
508
 
 
509
 
 
510
class TestBranchReference(tests.TestCaseWithTransport):
 
511
    """Tests for the branch reference facility."""
 
512
 
 
513
    def test_create_open_reference(self):
 
514
        bzrdirformat = bzrdir.BzrDirMetaFormat1()
 
515
        t = self.get_transport()
 
516
        t.mkdir('repo')
 
517
        dir = bzrdirformat.initialize(self.get_url('repo'))
 
518
        dir.create_repository()
 
519
        target_branch = dir.create_branch()
 
520
        t.mkdir('branch')
 
521
        branch_dir = bzrdirformat.initialize(self.get_url('branch'))
 
522
        made_branch = _mod_bzrbranch.BranchReferenceFormat().initialize(
 
523
            branch_dir, target_branch=target_branch)
 
524
        self.assertEqual(made_branch.base, target_branch.base)
 
525
        opened_branch = branch_dir.open_branch()
 
526
        self.assertEqual(opened_branch.base, target_branch.base)
 
527
 
 
528
    def test_get_reference(self):
 
529
        """For a BranchReference, get_reference should return the location."""
 
530
        branch = self.make_branch('target')
 
531
        checkout = branch.create_checkout('checkout', lightweight=True)
 
532
        reference_url = branch.controldir.root_transport.abspath('') + '/'
 
533
        # if the api for create_checkout changes to return different checkout types
 
534
        # then this file read will fail.
 
535
        self.assertFileEqual(reference_url.encode('utf-8'),
 
536
                             'checkout/.bzr/branch/location')
 
537
        self.assertEqual(reference_url,
 
538
                         _mod_bzrbranch.BranchReferenceFormat().get_reference(checkout.controldir))
 
539
 
 
540
 
 
541
class TestHooks(tests.TestCaseWithTransport):
 
542
 
 
543
    def test_constructor(self):
 
544
        """Check that creating a BranchHooks instance has the right defaults."""
 
545
        hooks = _mod_branch.BranchHooks()
 
546
        self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
 
547
        self.assertTrue("post_commit" in hooks,
 
548
                        "post_commit not in %s" % hooks)
 
549
        self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
 
550
        self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
 
551
        self.assertTrue("post_uncommit" in hooks,
 
552
                        "post_uncommit not in %s" % hooks)
 
553
        self.assertTrue("post_change_branch_tip" in hooks,
 
554
                        "post_change_branch_tip not in %s" % hooks)
 
555
        self.assertTrue("post_branch_init" in hooks,
 
556
                        "post_branch_init not in %s" % hooks)
 
557
        self.assertTrue("post_switch" in hooks,
 
558
                        "post_switch not in %s" % hooks)
 
559
 
 
560
    def test_installed_hooks_are_BranchHooks(self):
 
561
        """The installed hooks object should be a BranchHooks."""
 
562
        # the installed hooks are saved in self._preserved_hooks.
 
563
        self.assertIsInstance(self._preserved_hooks[_mod_branch.Branch][1],
 
564
                              _mod_branch.BranchHooks)
 
565
 
 
566
    def test_post_branch_init_hook(self):
 
567
        calls = []
 
568
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
 
569
                                                    calls.append, None)
 
570
        self.assertLength(0, calls)
 
571
        branch = self.make_branch('a')
 
572
        self.assertLength(1, calls)
 
573
        params = calls[0]
 
574
        self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
 
575
        self.assertTrue(hasattr(params, 'controldir'))
 
576
        self.assertTrue(hasattr(params, 'branch'))
 
577
 
 
578
    def test_post_branch_init_hook_repr(self):
 
579
        param_reprs = []
 
580
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
 
581
                                                    lambda params: param_reprs.append(repr(params)), None)
 
582
        branch = self.make_branch('a')
 
583
        self.assertLength(1, param_reprs)
 
584
        param_repr = param_reprs[0]
 
585
        self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
 
586
 
 
587
    def test_post_switch_hook(self):
 
588
        from .. import switch
 
589
        calls = []
 
590
        _mod_branch.Branch.hooks.install_named_hook('post_switch',
 
591
                                                    calls.append, None)
 
592
        tree = self.make_branch_and_tree('branch-1')
 
593
        self.build_tree(['branch-1/file-1'])
 
594
        tree.add('file-1')
 
595
        tree.commit('rev1')
 
596
        to_branch = tree.controldir.sprout('branch-2').open_branch()
 
597
        self.build_tree(['branch-1/file-2'])
 
598
        tree.add('file-2')
 
599
        tree.remove('file-1')
 
600
        tree.commit('rev2')
 
601
        checkout = tree.branch.create_checkout('checkout')
 
602
        self.assertLength(0, calls)
 
603
        switch.switch(checkout.controldir, to_branch)
 
604
        self.assertLength(1, calls)
 
605
        params = calls[0]
 
606
        self.assertIsInstance(params, _mod_branch.SwitchHookParams)
 
607
        self.assertTrue(hasattr(params, 'to_branch'))
 
608
        self.assertTrue(hasattr(params, 'revision_id'))
 
609
 
 
610
 
 
611
class TestBranchOptions(tests.TestCaseWithTransport):
 
612
 
 
613
    def setUp(self):
 
614
        super(TestBranchOptions, self).setUp()
 
615
        self.branch = self.make_branch('.')
 
616
        self.config_stack = self.branch.get_config_stack()
 
617
 
 
618
    def check_append_revisions_only(self, expected_value, value=None):
 
619
        """Set append_revisions_only in config and check its interpretation."""
 
620
        if value is not None:
 
621
            self.config_stack.set('append_revisions_only', value)
 
622
        self.assertEqual(expected_value,
 
623
                         self.branch.get_append_revisions_only())
 
624
 
 
625
    def test_valid_append_revisions_only(self):
 
626
        self.assertEqual(None,
 
627
                         self.config_stack.get('append_revisions_only'))
 
628
        self.check_append_revisions_only(None)
 
629
        self.check_append_revisions_only(False, 'False')
 
630
        self.check_append_revisions_only(True, 'True')
 
631
        # The following values will cause compatibility problems on projects
 
632
        # using older bzr versions (<2.2) but are accepted
 
633
        self.check_append_revisions_only(False, 'false')
 
634
        self.check_append_revisions_only(True, 'true')
 
635
 
 
636
    def test_invalid_append_revisions_only(self):
 
637
        """Ensure warning is noted on invalid settings"""
 
638
        self.warnings = []
 
639
 
 
640
        def warning(*args):
 
641
            self.warnings.append(args[0] % args[1:])
 
642
        self.overrideAttr(trace, 'warning', warning)
 
643
        self.check_append_revisions_only(None, 'not-a-bool')
 
644
        self.assertLength(1, self.warnings)
 
645
        self.assertEqual(
 
646
            'Value "not-a-bool" is not valid for "append_revisions_only"',
 
647
            self.warnings[0])
 
648
 
 
649
    def test_use_fresh_values(self):
 
650
        copy = _mod_branch.Branch.open(self.branch.base)
 
651
        copy.lock_write()
 
652
        try:
 
653
            copy.get_config_stack().set('foo', 'bar')
 
654
        finally:
 
655
            copy.unlock()
 
656
        self.assertFalse(self.branch.is_locked())
 
657
        # Since the branch is locked, the option value won't be saved on disk
 
658
        # so trying to access the config of locked branch via another older
 
659
        # non-locked branch object pointing to the same branch is not supported
 
660
        self.assertEqual(None, self.branch.get_config_stack().get('foo'))
 
661
        # Using a newly created branch object works as expected
 
662
        fresh = _mod_branch.Branch.open(self.branch.base)
 
663
        self.assertEqual('bar', fresh.get_config_stack().get('foo'))
 
664
 
 
665
    def test_set_from_config_get_from_config_stack(self):
 
666
        self.branch.lock_write()
 
667
        self.addCleanup(self.branch.unlock)
 
668
        self.branch.get_config().set_user_option('foo', 'bar')
 
669
        result = self.branch.get_config_stack().get('foo')
 
670
        # https://bugs.launchpad.net/bzr/+bug/948344
 
671
        self.expectFailure('BranchStack uses cache after set_user_option',
 
672
                           self.assertEqual, 'bar', result)
 
673
 
 
674
    def test_set_from_config_stack_get_from_config(self):
 
675
        self.branch.lock_write()
 
676
        self.addCleanup(self.branch.unlock)
 
677
        self.branch.get_config_stack().set('foo', 'bar')
 
678
        # Since the branch is locked, the option value won't be saved on disk
 
679
        # so mixing get() and get_user_option() is broken by design.
 
680
        self.assertEqual(None,
 
681
                         self.branch.get_config().get_user_option('foo'))
 
682
 
 
683
    def test_set_delays_write_when_branch_is_locked(self):
 
684
        self.branch.lock_write()
 
685
        self.addCleanup(self.branch.unlock)
 
686
        self.branch.get_config_stack().set('foo', 'bar')
 
687
        copy = _mod_branch.Branch.open(self.branch.base)
 
688
        result = copy.get_config_stack().get('foo')
 
689
        # Accessing from a different branch object is like accessing from a
 
690
        # different process: the option has not been saved yet and the new
 
691
        # value cannot be seen.
 
692
        self.assertIs(None, result)
 
693
 
 
694
 
 
695
class TestPullResult(tests.TestCase):
 
696
 
 
697
    def test_report_changed(self):
 
698
        r = _mod_branch.PullResult()
 
699
        r.old_revid = b"old-revid"
 
700
        r.old_revno = 10
 
701
        r.new_revid = b"new-revid"
 
702
        r.new_revno = 20
 
703
        f = StringIO()
 
704
        r.report(f)
 
705
        self.assertEqual("Now on revision 20.\n", f.getvalue())
 
706
 
 
707
    def test_report_unchanged(self):
 
708
        r = _mod_branch.PullResult()
 
709
        r.old_revid = b"same-revid"
 
710
        r.new_revid = b"same-revid"
 
711
        f = StringIO()
 
712
        r.report(f)
 
713
        self.assertEqual("No revisions or tags to pull.\n", f.getvalue())