/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 bzrlib/tests/test_branch.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-12 19:01:05 UTC
  • mfrom: (6468.6.2 492144-rename-wrapper)
  • Revision ID: pqm@pqm.ubuntu.com-20120312190105-p9dg7dxetifq1k0w
(gz) Implement osutils._rename_wrap_exception for recording both filenames
 in the error (Ross Lagerwall)

Show diffs side-by-side

added added

removed removed

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