/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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