/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/tests/test_branch.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-15 17:41:17 UTC
  • mto: (7290.1.2 work)
  • mto: This revision was merged to the branch mainline in revision 7295.
  • Revision ID: jelmer@jelmer.uk-20190215174117-o9w1am2z88mg9g1q
Update references to home location.

~/.config/breezy rather than ~/.bazaar.

Show diffs side-by-side

added added

removed removed

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