~greatmay12/+junk/test1

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_branch.py

  • Committer: thitipong at ndrsolution
  • Date: 2011-11-14 06:31:02 UTC
  • Revision ID: thitipong@ndrsolution.com-20111114063102-9obte3yfi2azku7d
ndr redirect version

Show diffs side-by-side

added added

removed removed

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