/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: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

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