/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 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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())
 
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'])
329
244
 
330
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')
344
259
        subtree.commit('a subtree file')
345
260
        subsubtree.commit('a subsubtree file')
346
261
        tree.branch.create_checkout('target', lightweight=lightweight)
347
 
        self.assertPathExists('target')
348
 
        self.assertPathExists('target/subtree')
349
 
        self.assertPathExists('target/subtree/file')
350
 
        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')
351
266
        subbranch = _mod_branch.Branch.open('target/subtree/subsubtree')
352
267
        if lightweight:
353
268
            self.assertEndsWith(subbranch.base, 'source/subtree/subsubtree/')
360
275
    def test_light_checkout_with_references(self):
361
276
        self.do_checkout_test(lightweight=True)
362
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
 
363
294
 
364
295
class TestBranch6(TestBranch67, tests.TestCaseWithTransport):
365
296
 
366
297
    def get_class(self):
367
 
        return _mod_bzrbranch.BzrBranch6
 
298
        return _mod_branch.BzrBranch6
368
299
 
369
300
    def get_format_name(self):
370
301
        return "dirstate-tags"
374
305
 
375
306
    def test_set_stacked_on_url_errors(self):
376
307
        branch = self.make_branch('a', format=self.get_format_name())
377
 
        self.assertRaises(_mod_branch.UnstackableBranchFormat,
378
 
                          branch.set_stacked_on_url, None)
 
308
        self.assertRaises(errors.UnstackableBranchFormat,
 
309
            branch.set_stacked_on_url, None)
379
310
 
380
311
    def test_default_stacked_location(self):
381
312
        branch = self.make_branch('a', format=self.get_format_name())
382
 
        self.assertRaises(_mod_branch.UnstackableBranchFormat,
383
 
                          branch.get_stacked_on_url)
 
313
        self.assertRaises(errors.UnstackableBranchFormat, branch.get_stacked_on_url)
384
314
 
385
315
 
386
316
class TestBranch7(TestBranch67, tests.TestCaseWithTransport):
387
317
 
388
318
    def get_class(self):
389
 
        return _mod_bzrbranch.BzrBranch7
 
319
        return _mod_branch.BzrBranch7
390
320
 
391
321
    def get_format_name(self):
392
322
        return "1.9"
396
326
 
397
327
    def test_set_stacked_on_url_unstackable_repo(self):
398
328
        repo = self.make_repository('a', format='dirstate-tags')
399
 
        control = repo.controldir
400
 
        branch = _mod_bzrbranch.BzrBranchFormat7().initialize(control)
 
329
        control = repo.bzrdir
 
330
        branch = _mod_branch.BzrBranchFormat7().initialize(control)
401
331
        target = self.make_branch('b')
402
332
        self.assertRaises(errors.UnstackableRepositoryFormat,
403
 
                          branch.set_stacked_on_url, target.base)
 
333
            branch.set_stacked_on_url, target.base)
404
334
 
405
335
    def test_clone_stacked_on_unstackable_repo(self):
406
336
        repo = self.make_repository('a', format='dirstate-tags')
407
 
        control = repo.controldir
408
 
        branch = _mod_bzrbranch.BzrBranchFormat7().initialize(control)
 
337
        control = repo.bzrdir
 
338
        branch = _mod_branch.BzrBranchFormat7().initialize(control)
409
339
        # Calling clone should not raise UnstackableRepositoryFormat.
410
340
        cloned_bzrdir = control.clone('cloned')
411
341
 
428
358
        branch = self.make_branch('a', format=self.get_format_name())
429
359
        target = self.make_branch_and_tree('b', format=self.get_format_name())
430
360
        branch.set_stacked_on_url(target.branch.base)
431
 
        branch = branch.controldir.open_branch()
 
361
        branch = branch.bzrdir.open_branch()
432
362
        revid = target.commit('foo')
433
363
        self.assertTrue(branch.repository.has_revision(revid))
434
364
 
437
367
 
438
368
    def make_branch(self, location, format=None):
439
369
        if format is None:
440
 
            format = controldir.format_registry.make_controldir('1.9')
441
 
            format.set_branch_format(_mod_bzrbranch.BzrBranchFormat8())
 
370
            format = bzrdir.format_registry.make_bzrdir('1.9')
 
371
            format.set_branch_format(_mod_branch.BzrBranchFormat8())
442
372
        return tests.TestCaseWithTransport.make_branch(
443
373
            self, location, format=format)
444
374
 
445
375
    def create_branch_with_reference(self):
446
376
        branch = self.make_branch('branch')
447
 
        branch._set_all_reference_info({'path': ('location', b'file-id')})
 
377
        branch._set_all_reference_info({'file-id': ('path', 'location')})
448
378
        return branch
449
379
 
450
380
    @staticmethod
451
381
    def instrument_branch(branch, gets):
452
382
        old_get = branch._transport.get
453
 
 
454
383
        def get(*args, **kwargs):
455
384
            gets.append((args, kwargs))
456
385
            return old_get(*args, **kwargs)
462
391
        branch.lock_read()
463
392
        self.addCleanup(branch.unlock)
464
393
        self.instrument_branch(branch, gets)
465
 
        branch.get_reference_info('path')
466
 
        branch.get_reference_info('path')
 
394
        branch.get_reference_info('file-id')
 
395
        branch.get_reference_info('file-id')
467
396
        self.assertEqual(1, len(gets))
468
397
 
469
398
    def test_reference_info_caching_read_unlocked(self):
470
399
        gets = []
471
400
        branch = self.create_branch_with_reference()
472
401
        self.instrument_branch(branch, gets)
473
 
        branch.get_reference_info('path')
474
 
        branch.get_reference_info('path')
 
402
        branch.get_reference_info('file-id')
 
403
        branch.get_reference_info('file-id')
475
404
        self.assertEqual(2, len(gets))
476
405
 
477
406
    def test_reference_info_caching_write_locked(self):
480
409
        branch.lock_write()
481
410
        self.instrument_branch(branch, gets)
482
411
        self.addCleanup(branch.unlock)
483
 
        branch._set_all_reference_info({'path2': ('location2', b'file-id')})
484
 
        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')
485
414
        self.assertEqual(0, len(gets))
486
 
        self.assertEqual(b'file-id', file_id)
 
415
        self.assertEqual('path2', path)
487
416
        self.assertEqual('location2', location)
488
417
 
489
418
    def test_reference_info_caches_cleared(self):
490
419
        branch = self.make_branch('branch')
491
 
        with branch.lock_write():
492
 
            branch.set_reference_info('path2', 'location2', b'file-id')
 
420
        branch.lock_write()
 
421
        branch.set_reference_info('file-id', 'path2', 'location2')
 
422
        branch.unlock()
493
423
        doppelganger = _mod_branch.Branch.open('branch')
494
 
        doppelganger.set_reference_info('path3', 'location3', b'file-id')
495
 
        self.assertEqual(('location3', b'file-id'),
496
 
                         branch.get_reference_info('path3'))
497
 
 
498
 
    def _recordParentMapCalls(self, repo):
499
 
        self._parent_map_calls = []
500
 
        orig_get_parent_map = repo.revisions.get_parent_map
501
 
 
502
 
        def get_parent_map(q):
503
 
            q = list(q)
504
 
            self._parent_map_calls.extend([e[0] for e in q])
505
 
            return orig_get_parent_map(q)
506
 
        repo.revisions.get_parent_map = get_parent_map
507
 
 
 
424
        doppelganger.set_reference_info('file-id', 'path3', 'location3')
 
425
        self.assertEqual(('path3', 'location3'),
 
426
                         branch.get_reference_info('file-id'))
508
427
 
509
428
class TestBranchReference(tests.TestCaseWithTransport):
510
429
    """Tests for the branch reference facility."""
511
430
 
512
431
    def test_create_open_reference(self):
513
432
        bzrdirformat = bzrdir.BzrDirMetaFormat1()
514
 
        t = self.get_transport()
 
433
        t = transport.get_transport(self.get_url('.'))
515
434
        t.mkdir('repo')
516
435
        dir = bzrdirformat.initialize(self.get_url('repo'))
517
436
        dir.create_repository()
518
437
        target_branch = dir.create_branch()
519
438
        t.mkdir('branch')
520
439
        branch_dir = bzrdirformat.initialize(self.get_url('branch'))
521
 
        made_branch = _mod_bzrbranch.BranchReferenceFormat().initialize(
 
440
        made_branch = _mod_branch.BranchReferenceFormat().initialize(
522
441
            branch_dir, target_branch=target_branch)
523
442
        self.assertEqual(made_branch.base, target_branch.base)
524
443
        opened_branch = branch_dir.open_branch()
525
444
        self.assertEqual(opened_branch.base, target_branch.base)
526
445
 
527
446
    def test_get_reference(self):
528
 
        """For a BranchReference, get_reference should return the location."""
 
447
        """For a BranchReference, get_reference should reutrn the location."""
529
448
        branch = self.make_branch('target')
530
449
        checkout = branch.create_checkout('checkout', lightweight=True)
531
 
        reference_url = branch.controldir.root_transport.abspath('') + '/'
 
450
        reference_url = branch.bzrdir.root_transport.abspath('') + '/'
532
451
        # if the api for create_checkout changes to return different checkout types
533
452
        # then this file read will fail.
534
 
        self.assertFileEqual(reference_url.encode('utf-8'),
535
 
                             'checkout/.bzr/branch/location')
 
453
        self.assertFileEqual(reference_url, 'checkout/.bzr/branch/location')
536
454
        self.assertEqual(reference_url,
537
 
                         _mod_bzrbranch.BranchReferenceFormat().get_reference(checkout.controldir))
 
455
            _mod_branch.BranchReferenceFormat().get_reference(checkout.bzrdir))
538
456
 
539
457
 
540
458
class TestHooks(tests.TestCaseWithTransport):
542
460
    def test_constructor(self):
543
461
        """Check that creating a BranchHooks instance has the right defaults."""
544
462
        hooks = _mod_branch.BranchHooks()
 
463
        self.assertTrue("set_rh" in hooks, "set_rh not in %s" % hooks)
545
464
        self.assertTrue("post_push" in hooks, "post_push not in %s" % hooks)
546
 
        self.assertTrue("post_commit" in hooks,
547
 
                        "post_commit not in %s" % hooks)
 
465
        self.assertTrue("post_commit" in hooks, "post_commit not in %s" % hooks)
548
466
        self.assertTrue("pre_commit" in hooks, "pre_commit not in %s" % hooks)
549
467
        self.assertTrue("post_pull" in hooks, "post_pull not in %s" % hooks)
550
468
        self.assertTrue("post_uncommit" in hooks,
565
483
    def test_post_branch_init_hook(self):
566
484
        calls = []
567
485
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
568
 
                                                    calls.append, None)
 
486
            calls.append, None)
569
487
        self.assertLength(0, calls)
570
488
        branch = self.make_branch('a')
571
489
        self.assertLength(1, calls)
572
490
        params = calls[0]
573
491
        self.assertIsInstance(params, _mod_branch.BranchInitHookParams)
574
 
        self.assertTrue(hasattr(params, 'controldir'))
 
492
        self.assertTrue(hasattr(params, 'bzrdir'))
575
493
        self.assertTrue(hasattr(params, 'branch'))
576
494
 
577
 
    def test_post_branch_init_hook_repr(self):
578
 
        param_reprs = []
579
 
        _mod_branch.Branch.hooks.install_named_hook('post_branch_init',
580
 
                                                    lambda params: param_reprs.append(repr(params)), None)
581
 
        branch = self.make_branch('a')
582
 
        self.assertLength(1, param_reprs)
583
 
        param_repr = param_reprs[0]
584
 
        self.assertStartsWith(param_repr, '<BranchInitHookParams of ')
585
 
 
586
495
    def test_post_switch_hook(self):
587
 
        from .. import switch
 
496
        from bzrlib import switch
588
497
        calls = []
589
498
        _mod_branch.Branch.hooks.install_named_hook('post_switch',
590
 
                                                    calls.append, None)
 
499
            calls.append, None)
591
500
        tree = self.make_branch_and_tree('branch-1')
592
501
        self.build_tree(['branch-1/file-1'])
593
502
        tree.add('file-1')
594
503
        tree.commit('rev1')
595
 
        to_branch = tree.controldir.sprout('branch-2').open_branch()
 
504
        to_branch = tree.bzrdir.sprout('branch-2').open_branch()
596
505
        self.build_tree(['branch-1/file-2'])
597
506
        tree.add('file-2')
598
507
        tree.remove('file-1')
599
508
        tree.commit('rev2')
600
509
        checkout = tree.branch.create_checkout('checkout')
601
510
        self.assertLength(0, calls)
602
 
        switch.switch(checkout.controldir, to_branch)
 
511
        switch.switch(checkout.bzrdir, to_branch)
603
512
        self.assertLength(1, calls)
604
513
        params = calls[0]
605
514
        self.assertIsInstance(params, _mod_branch.SwitchHookParams)
612
521
    def setUp(self):
613
522
        super(TestBranchOptions, self).setUp()
614
523
        self.branch = self.make_branch('.')
615
 
        self.config_stack = self.branch.get_config_stack()
 
524
        self.config = self.branch.get_config()
616
525
 
617
526
    def check_append_revisions_only(self, expected_value, value=None):
618
527
        """Set append_revisions_only in config and check its interpretation."""
619
528
        if value is not None:
620
 
            self.config_stack.set('append_revisions_only', value)
 
529
            self.config.set_user_option('append_revisions_only', value)
621
530
        self.assertEqual(expected_value,
622
 
                         self.branch.get_append_revisions_only())
 
531
                         self.branch._get_append_revisions_only())
623
532
 
624
533
    def test_valid_append_revisions_only(self):
625
 
        self.assertEqual(None,
626
 
                         self.config_stack.get('append_revisions_only'))
 
534
        self.assertEquals(None,
 
535
                          self.config.get_user_option('append_revisions_only'))
627
536
        self.check_append_revisions_only(None)
628
537
        self.check_append_revisions_only(False, 'False')
629
538
        self.check_append_revisions_only(True, 'True')
635
544
    def test_invalid_append_revisions_only(self):
636
545
        """Ensure warning is noted on invalid settings"""
637
546
        self.warnings = []
638
 
 
639
547
        def warning(*args):
640
548
            self.warnings.append(args[0] % args[1:])
641
549
        self.overrideAttr(trace, 'warning', warning)
642
550
        self.check_append_revisions_only(None, 'not-a-bool')
643
551
        self.assertLength(1, self.warnings)
644
552
        self.assertEqual(
645
 
            'Value "not-a-bool" is not valid for "append_revisions_only"',
 
553
            'Value "not-a-bool" is not a boolean for "append_revisions_only"',
646
554
            self.warnings[0])
647
555
 
648
 
    def test_use_fresh_values(self):
649
 
        copy = _mod_branch.Branch.open(self.branch.base)
650
 
        copy.lock_write()
651
 
        try:
652
 
            copy.get_config_stack().set('foo', 'bar')
653
 
        finally:
654
 
            copy.unlock()
655
 
        self.assertFalse(self.branch.is_locked())
656
 
        # Since the branch is locked, the option value won't be saved on disk
657
 
        # so trying to access the config of locked branch via another older
658
 
        # non-locked branch object pointing to the same branch is not supported
659
 
        self.assertEqual(None, self.branch.get_config_stack().get('foo'))
660
 
        # Using a newly created branch object works as expected
661
 
        fresh = _mod_branch.Branch.open(self.branch.base)
662
 
        self.assertEqual('bar', fresh.get_config_stack().get('foo'))
663
 
 
664
 
    def test_set_from_config_get_from_config_stack(self):
665
 
        self.branch.lock_write()
666
 
        self.addCleanup(self.branch.unlock)
667
 
        self.branch.get_config().set_user_option('foo', 'bar')
668
 
        result = self.branch.get_config_stack().get('foo')
669
 
        # https://bugs.launchpad.net/bzr/+bug/948344
670
 
        self.expectFailure('BranchStack uses cache after set_user_option',
671
 
                           self.assertEqual, 'bar', result)
672
 
 
673
 
    def test_set_from_config_stack_get_from_config(self):
674
 
        self.branch.lock_write()
675
 
        self.addCleanup(self.branch.unlock)
676
 
        self.branch.get_config_stack().set('foo', 'bar')
677
 
        # Since the branch is locked, the option value won't be saved on disk
678
 
        # so mixing get() and get_user_option() is broken by design.
679
 
        self.assertEqual(None,
680
 
                         self.branch.get_config().get_user_option('foo'))
681
 
 
682
 
    def test_set_delays_write_when_branch_is_locked(self):
683
 
        self.branch.lock_write()
684
 
        self.addCleanup(self.branch.unlock)
685
 
        self.branch.get_config_stack().set('foo', 'bar')
686
 
        copy = _mod_branch.Branch.open(self.branch.base)
687
 
        result = copy.get_config_stack().get('foo')
688
 
        # Accessing from a different branch object is like accessing from a
689
 
        # different process: the option has not been saved yet and the new
690
 
        # value cannot be seen.
691
 
        self.assertIs(None, result)
692
 
 
693
556
 
694
557
class TestPullResult(tests.TestCase):
695
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
 
696
570
    def test_report_changed(self):
697
571
        r = _mod_branch.PullResult()
698
 
        r.old_revid = b"old-revid"
 
572
        r.old_revid = "old-revid"
699
573
        r.old_revno = 10
700
 
        r.new_revid = b"new-revid"
 
574
        r.new_revid = "new-revid"
701
575
        r.new_revno = 20
702
576
        f = StringIO()
703
577
        r.report(f)
705
579
 
706
580
    def test_report_unchanged(self):
707
581
        r = _mod_branch.PullResult()
708
 
        r.old_revid = b"same-revid"
709
 
        r.new_revid = b"same-revid"
 
582
        r.old_revid = "same-revid"
 
583
        r.new_revid = "same-revid"
710
584
        f = StringIO()
711
585
        r.report(f)
712
 
        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