~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: Martin Packman
  • Date: 2011-11-17 13:45:49 UTC
  • mto: This revision was merged to the branch mainline in revision 6271.
  • Revision ID: martin.packman@canonical.com-20111117134549-080e1fhtrzoicexg
Only assert FileExists path in test_transform directory clash tests to avoid stringification fallout

Show diffs side-by-side

added added

removed removed

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