← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 05:06:57 UTC
  • mfrom: (6603.4.1 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20160421050657-ygnzfybewvudf1j9
(richard-wilbur) Use initial_comment as commit_message for lp_propose.(Shawn
 Wang) (Shawn Wang)

Show diffs side-by-side

added added

removed removed

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