~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

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