/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_remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-09 23:35:55 UTC
  • mfrom: (3316.2.15 api-cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20080409233555-n26cmi0y1hb98tf6
(robertc) Many VersionedFile api cleanups and deprecations. Some
        incompatible changes included (see NEWS). (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Tests for remote bzrdir/branch/repo/etc
 
18
 
 
19
These are proxy objects which act on remote objects by sending messages
 
20
through a smart client.  The proxies are to be created when attempting to open
 
21
the object given a transport that supports smartserver rpc operations. 
 
22
 
 
23
These tests correspond to tests.test_smart, which exercises the server side.
 
24
"""
 
25
 
 
26
import bz2
 
27
from cStringIO import StringIO
 
28
 
 
29
from bzrlib import (
 
30
    errors,
 
31
    graph,
 
32
    pack,
 
33
    remote,
 
34
    repository,
 
35
    tests,
 
36
    )
 
37
from bzrlib.branch import Branch
 
38
from bzrlib.bzrdir import BzrDir, BzrDirFormat
 
39
from bzrlib.remote import (
 
40
    RemoteBranch,
 
41
    RemoteBzrDir,
 
42
    RemoteBzrDirFormat,
 
43
    RemoteRepository,
 
44
    )
 
45
from bzrlib.revision import NULL_REVISION
 
46
from bzrlib.smart import server, medium
 
47
from bzrlib.smart.client import _SmartClient
 
48
from bzrlib.symbol_versioning import one_four
 
49
from bzrlib.transport import get_transport
 
50
from bzrlib.transport.memory import MemoryTransport
 
51
from bzrlib.transport.remote import RemoteTransport
 
52
 
 
53
 
 
54
class BasicRemoteObjectTests(tests.TestCaseWithTransport):
 
55
 
 
56
    def setUp(self):
 
57
        self.transport_server = server.SmartTCPServer_for_testing
 
58
        super(BasicRemoteObjectTests, self).setUp()
 
59
        self.transport = self.get_transport()
 
60
        # make a branch that can be opened over the smart transport
 
61
        self.local_wt = BzrDir.create_standalone_workingtree('.')
 
62
 
 
63
    def tearDown(self):
 
64
        self.transport.disconnect()
 
65
        tests.TestCaseWithTransport.tearDown(self)
 
66
 
 
67
    def test_create_remote_bzrdir(self):
 
68
        b = remote.RemoteBzrDir(self.transport)
 
69
        self.assertIsInstance(b, BzrDir)
 
70
 
 
71
    def test_open_remote_branch(self):
 
72
        # open a standalone branch in the working directory
 
73
        b = remote.RemoteBzrDir(self.transport)
 
74
        branch = b.open_branch()
 
75
        self.assertIsInstance(branch, Branch)
 
76
 
 
77
    def test_remote_repository(self):
 
78
        b = BzrDir.open_from_transport(self.transport)
 
79
        repo = b.open_repository()
 
80
        revid = u'\xc823123123'.encode('utf8')
 
81
        self.assertFalse(repo.has_revision(revid))
 
82
        self.local_wt.commit(message='test commit', rev_id=revid)
 
83
        self.assertTrue(repo.has_revision(revid))
 
84
 
 
85
    def test_remote_branch_revision_history(self):
 
86
        b = BzrDir.open_from_transport(self.transport).open_branch()
 
87
        self.assertEqual([], b.revision_history())
 
88
        r1 = self.local_wt.commit('1st commit')
 
89
        r2 = self.local_wt.commit('1st commit', rev_id=u'\xc8'.encode('utf8'))
 
90
        self.assertEqual([r1, r2], b.revision_history())
 
91
 
 
92
    def test_find_correct_format(self):
 
93
        """Should open a RemoteBzrDir over a RemoteTransport"""
 
94
        fmt = BzrDirFormat.find_format(self.transport)
 
95
        self.assertTrue(RemoteBzrDirFormat
 
96
                        in BzrDirFormat._control_server_formats)
 
97
        self.assertIsInstance(fmt, remote.RemoteBzrDirFormat)
 
98
 
 
99
    def test_open_detected_smart_format(self):
 
100
        fmt = BzrDirFormat.find_format(self.transport)
 
101
        d = fmt.open(self.transport)
 
102
        self.assertIsInstance(d, BzrDir)
 
103
 
 
104
    def test_remote_branch_repr(self):
 
105
        b = BzrDir.open_from_transport(self.transport).open_branch()
 
106
        self.assertStartsWith(str(b), 'RemoteBranch(')
 
107
 
 
108
 
 
109
class FakeProtocol(object):
 
110
    """Lookalike SmartClientRequestProtocolOne allowing body reading tests."""
 
111
 
 
112
    def __init__(self, body, fake_client):
 
113
        self.body = body
 
114
        self._body_buffer = None
 
115
        self._fake_client = fake_client
 
116
 
 
117
    def read_body_bytes(self, count=-1):
 
118
        if self._body_buffer is None:
 
119
            self._body_buffer = StringIO(self.body)
 
120
        bytes = self._body_buffer.read(count)
 
121
        if self._body_buffer.tell() == len(self._body_buffer.getvalue()):
 
122
            self._fake_client.expecting_body = False
 
123
        return bytes
 
124
 
 
125
    def cancel_read_body(self):
 
126
        self._fake_client.expecting_body = False
 
127
 
 
128
    def read_streamed_body(self):
 
129
        return self.body
 
130
 
 
131
 
 
132
class FakeClient(_SmartClient):
 
133
    """Lookalike for _SmartClient allowing testing."""
 
134
    
 
135
    def __init__(self, responses, fake_medium_base='fake base'):
 
136
        """Create a FakeClient.
 
137
 
 
138
        :param responses: A list of response-tuple, body-data pairs to be sent
 
139
            back to callers.  A special case is if the response-tuple is
 
140
            'unknown verb', then a UnknownSmartMethod will be raised for that
 
141
            call, using the second element of the tuple as the verb in the
 
142
            exception.
 
143
        """
 
144
        self.responses = responses
 
145
        self._calls = []
 
146
        self.expecting_body = False
 
147
        _SmartClient.__init__(self, FakeMedium(self._calls), fake_medium_base)
 
148
 
 
149
    def _get_next_response(self):
 
150
        response_tuple = self.responses.pop(0)
 
151
        if response_tuple[0][0] == 'unknown verb':
 
152
            raise errors.UnknownSmartMethod(response_tuple[0][1])
 
153
        return response_tuple
 
154
 
 
155
    def call(self, method, *args):
 
156
        self._calls.append(('call', method, args))
 
157
        return self._get_next_response()[0]
 
158
 
 
159
    def call_expecting_body(self, method, *args):
 
160
        self._calls.append(('call_expecting_body', method, args))
 
161
        result = self._get_next_response()
 
162
        self.expecting_body = True
 
163
        return result[0], FakeProtocol(result[1], self)
 
164
 
 
165
    def call_with_body_bytes_expecting_body(self, method, args, body):
 
166
        self._calls.append(('call_with_body_bytes_expecting_body', method,
 
167
            args, body))
 
168
        result = self._get_next_response()
 
169
        self.expecting_body = True
 
170
        return result[0], FakeProtocol(result[1], self)
 
171
 
 
172
 
 
173
class FakeMedium(object):
 
174
 
 
175
    def __init__(self, client_calls):
 
176
        self._remote_is_at_least_1_2 = True
 
177
        self._client_calls = client_calls
 
178
 
 
179
    def disconnect(self):
 
180
        self._client_calls.append(('disconnect medium',))
 
181
 
 
182
 
 
183
class TestVfsHas(tests.TestCase):
 
184
 
 
185
    def test_unicode_path(self):
 
186
        client = FakeClient([(('yes',), )], '/')
 
187
        transport = RemoteTransport('bzr://localhost/', _client=client)
 
188
        filename = u'/hell\u00d8'.encode('utf8')
 
189
        result = transport.has(filename)
 
190
        self.assertEqual(
 
191
            [('call', 'has', (filename,))],
 
192
            client._calls)
 
193
        self.assertTrue(result)
 
194
 
 
195
 
 
196
class Test_SmartClient_remote_path_from_transport(tests.TestCase):
 
197
    """Tests for the behaviour of _SmartClient.remote_path_from_transport."""
 
198
 
 
199
    def assertRemotePath(self, expected, client_base, transport_base):
 
200
        """Assert that the result of _SmartClient.remote_path_from_transport
 
201
        is the expected value for a given client_base and transport_base.
 
202
        """
 
203
        dummy_medium = 'dummy medium'
 
204
        client = _SmartClient(dummy_medium, client_base)
 
205
        transport = get_transport(transport_base)
 
206
        result = client.remote_path_from_transport(transport)
 
207
        self.assertEqual(expected, result)
 
208
        
 
209
    def test_remote_path_from_transport(self):
 
210
        """_SmartClient.remote_path_from_transport calculates a URL for the
 
211
        given transport relative to the root of the client base URL.
 
212
        """
 
213
        self.assertRemotePath('xyz/', 'bzr://host/path', 'bzr://host/xyz')
 
214
        self.assertRemotePath(
 
215
            'path/xyz/', 'bzr://host/path', 'bzr://host/path/xyz')
 
216
 
 
217
    def test_remote_path_from_transport_http(self):
 
218
        """Remote paths for HTTP transports are calculated differently to other
 
219
        transports.  They are just relative to the client base, not the root
 
220
        directory of the host.
 
221
        """
 
222
        for scheme in ['http:', 'https:', 'bzr+http:', 'bzr+https:']:
 
223
            self.assertRemotePath(
 
224
                '../xyz/', scheme + '//host/path', scheme + '//host/xyz')
 
225
            self.assertRemotePath(
 
226
                'xyz/', scheme + '//host/path', scheme + '//host/path/xyz')
 
227
 
 
228
 
 
229
class TestBzrDirOpenBranch(tests.TestCase):
 
230
 
 
231
    def test_branch_present(self):
 
232
        transport = MemoryTransport()
 
233
        transport.mkdir('quack')
 
234
        transport = transport.clone('quack')
 
235
        client = FakeClient([(('ok', ''), ), (('ok', '', 'no', 'no', 'no'), )],
 
236
                            transport.base)
 
237
        bzrdir = RemoteBzrDir(transport, _client=client)
 
238
        result = bzrdir.open_branch()
 
239
        self.assertEqual(
 
240
            [('call', 'BzrDir.open_branch', ('quack/',)),
 
241
             ('call', 'BzrDir.find_repositoryV2', ('quack/',))],
 
242
            client._calls)
 
243
        self.assertIsInstance(result, RemoteBranch)
 
244
        self.assertEqual(bzrdir, result.bzrdir)
 
245
 
 
246
    def test_branch_missing(self):
 
247
        transport = MemoryTransport()
 
248
        transport.mkdir('quack')
 
249
        transport = transport.clone('quack')
 
250
        client = FakeClient([(('nobranch',), )], transport.base)
 
251
        bzrdir = RemoteBzrDir(transport, _client=client)
 
252
        self.assertRaises(errors.NotBranchError, bzrdir.open_branch)
 
253
        self.assertEqual(
 
254
            [('call', 'BzrDir.open_branch', ('quack/',))],
 
255
            client._calls)
 
256
 
 
257
    def test__get_tree_branch(self):
 
258
        # _get_tree_branch is a form of open_branch, but it should only ask for
 
259
        # branch opening, not any other network requests.
 
260
        calls = []
 
261
        def open_branch():
 
262
            calls.append("Called")
 
263
            return "a-branch"
 
264
        transport = MemoryTransport()
 
265
        # no requests on the network - catches other api calls being made.
 
266
        client = FakeClient([], transport.base)
 
267
        bzrdir = RemoteBzrDir(transport, _client=client)
 
268
        # patch the open_branch call to record that it was called.
 
269
        bzrdir.open_branch = open_branch
 
270
        self.assertEqual((None, "a-branch"), bzrdir._get_tree_branch())
 
271
        self.assertEqual(["Called"], calls)
 
272
        self.assertEqual([], client._calls)
 
273
 
 
274
    def test_url_quoting_of_path(self):
 
275
        # Relpaths on the wire should not be URL-escaped.  So "~" should be
 
276
        # transmitted as "~", not "%7E".
 
277
        transport = RemoteTransport('bzr://localhost/~hello/')
 
278
        client = FakeClient([(('ok', ''), ), (('ok', '', 'no', 'no', 'no'), )],
 
279
                            transport.base)
 
280
        bzrdir = RemoteBzrDir(transport, _client=client)
 
281
        result = bzrdir.open_branch()
 
282
        self.assertEqual(
 
283
            [('call', 'BzrDir.open_branch', ('~hello/',)),
 
284
             ('call', 'BzrDir.find_repositoryV2', ('~hello/',))],
 
285
            client._calls)
 
286
 
 
287
    def check_open_repository(self, rich_root, subtrees, external_lookup='no'):
 
288
        transport = MemoryTransport()
 
289
        transport.mkdir('quack')
 
290
        transport = transport.clone('quack')
 
291
        if rich_root:
 
292
            rich_response = 'yes'
 
293
        else:
 
294
            rich_response = 'no'
 
295
        if subtrees:
 
296
            subtree_response = 'yes'
 
297
        else:
 
298
            subtree_response = 'no'
 
299
        client = FakeClient(
 
300
            [(('ok', '', rich_response, subtree_response, external_lookup), ),],
 
301
            transport.base)
 
302
        bzrdir = RemoteBzrDir(transport, _client=client)
 
303
        result = bzrdir.open_repository()
 
304
        self.assertEqual(
 
305
            [('call', 'BzrDir.find_repositoryV2', ('quack/',))],
 
306
            client._calls)
 
307
        self.assertIsInstance(result, RemoteRepository)
 
308
        self.assertEqual(bzrdir, result.bzrdir)
 
309
        self.assertEqual(rich_root, result._format.rich_root_data)
 
310
        self.assertEqual(subtrees, result._format.supports_tree_reference)
 
311
 
 
312
    def test_open_repository_sets_format_attributes(self):
 
313
        self.check_open_repository(True, True)
 
314
        self.check_open_repository(False, True)
 
315
        self.check_open_repository(True, False)
 
316
        self.check_open_repository(False, False)
 
317
        self.check_open_repository(False, False, 'yes')
 
318
 
 
319
    def test_old_server(self):
 
320
        """RemoteBzrDirFormat should fail to probe if the server version is too
 
321
        old.
 
322
        """
 
323
        self.assertRaises(errors.NotBranchError,
 
324
            RemoteBzrDirFormat.probe_transport, OldServerTransport())
 
325
 
 
326
 
 
327
class TestBzrDirOpenRepository(tests.TestCase):
 
328
 
 
329
    def test_backwards_compat_1_2(self):
 
330
        transport = MemoryTransport()
 
331
        transport.mkdir('quack')
 
332
        transport = transport.clone('quack')
 
333
        client = FakeClient([
 
334
            (('unknown verb', 'RemoteRepository.find_repositoryV2'), ''),
 
335
            (('ok', '', 'no', 'no'), ''),],
 
336
            transport.base)
 
337
        bzrdir = RemoteBzrDir(transport, _client=client)
 
338
        repo = bzrdir.open_repository()
 
339
        self.assertEqual(
 
340
            [('call', 'BzrDir.find_repositoryV2', ('quack/',)),
 
341
             ('call', 'BzrDir.find_repository', ('quack/',))],
 
342
            client._calls)
 
343
 
 
344
 
 
345
class OldSmartClient(object):
 
346
    """A fake smart client for test_old_version that just returns a version one
 
347
    response to the 'hello' (query version) command.
 
348
    """
 
349
 
 
350
    def get_request(self):
 
351
        input_file = StringIO('ok\x011\n')
 
352
        output_file = StringIO()
 
353
        client_medium = medium.SmartSimplePipesClientMedium(
 
354
            input_file, output_file)
 
355
        return medium.SmartClientStreamMediumRequest(client_medium)
 
356
 
 
357
    def protocol_version(self):
 
358
        return 1
 
359
 
 
360
 
 
361
class OldServerTransport(object):
 
362
    """A fake transport for test_old_server that reports it's smart server
 
363
    protocol version as version one.
 
364
    """
 
365
 
 
366
    def __init__(self):
 
367
        self.base = 'fake:'
 
368
 
 
369
    def get_smart_client(self):
 
370
        return OldSmartClient()
 
371
 
 
372
 
 
373
class TestBranchLastRevisionInfo(tests.TestCase):
 
374
 
 
375
    def test_empty_branch(self):
 
376
        # in an empty branch we decode the response properly
 
377
        transport = MemoryTransport()
 
378
        client = FakeClient([(('ok', '0', 'null:'), )], transport.base)
 
379
        transport.mkdir('quack')
 
380
        transport = transport.clone('quack')
 
381
        # we do not want bzrdir to make any remote calls
 
382
        bzrdir = RemoteBzrDir(transport, _client=False)
 
383
        branch = RemoteBranch(bzrdir, None, _client=client)
 
384
        result = branch.last_revision_info()
 
385
 
 
386
        self.assertEqual(
 
387
            [('call', 'Branch.last_revision_info', ('quack/',))],
 
388
            client._calls)
 
389
        self.assertEqual((0, NULL_REVISION), result)
 
390
 
 
391
    def test_non_empty_branch(self):
 
392
        # in a non-empty branch we also decode the response properly
 
393
        revid = u'\xc8'.encode('utf8')
 
394
        transport = MemoryTransport()
 
395
        client = FakeClient([(('ok', '2', revid), )], transport.base)
 
396
        transport.mkdir('kwaak')
 
397
        transport = transport.clone('kwaak')
 
398
        # we do not want bzrdir to make any remote calls
 
399
        bzrdir = RemoteBzrDir(transport, _client=False)
 
400
        branch = RemoteBranch(bzrdir, None, _client=client)
 
401
        result = branch.last_revision_info()
 
402
 
 
403
        self.assertEqual(
 
404
            [('call', 'Branch.last_revision_info', ('kwaak/',))],
 
405
            client._calls)
 
406
        self.assertEqual((2, revid), result)
 
407
 
 
408
 
 
409
class TestBranchSetLastRevision(tests.TestCase):
 
410
 
 
411
    def test_set_empty(self):
 
412
        # set_revision_history([]) is translated to calling
 
413
        # Branch.set_last_revision(path, '') on the wire.
 
414
        transport = MemoryTransport()
 
415
        transport.mkdir('branch')
 
416
        transport = transport.clone('branch')
 
417
 
 
418
        client = FakeClient([
 
419
            # lock_write
 
420
            (('ok', 'branch token', 'repo token'), ),
 
421
            # set_last_revision
 
422
            (('ok',), ),
 
423
            # unlock
 
424
            (('ok',), )],
 
425
            transport.base)
 
426
        bzrdir = RemoteBzrDir(transport, _client=False)
 
427
        branch = RemoteBranch(bzrdir, None, _client=client)
 
428
        # This is a hack to work around the problem that RemoteBranch currently
 
429
        # unnecessarily invokes _ensure_real upon a call to lock_write.
 
430
        branch._ensure_real = lambda: None
 
431
        branch.lock_write()
 
432
        client._calls = []
 
433
        result = branch.set_revision_history([])
 
434
        self.assertEqual(
 
435
            [('call', 'Branch.set_last_revision',
 
436
                ('branch/', 'branch token', 'repo token', 'null:'))],
 
437
            client._calls)
 
438
        branch.unlock()
 
439
        self.assertEqual(None, result)
 
440
 
 
441
    def test_set_nonempty(self):
 
442
        # set_revision_history([rev-id1, ..., rev-idN]) is translated to calling
 
443
        # Branch.set_last_revision(path, rev-idN) on the wire.
 
444
        transport = MemoryTransport()
 
445
        transport.mkdir('branch')
 
446
        transport = transport.clone('branch')
 
447
 
 
448
        client = FakeClient([
 
449
            # lock_write
 
450
            (('ok', 'branch token', 'repo token'), ),
 
451
            # set_last_revision
 
452
            (('ok',), ),
 
453
            # unlock
 
454
            (('ok',), )],
 
455
            transport.base)
 
456
        bzrdir = RemoteBzrDir(transport, _client=False)
 
457
        branch = RemoteBranch(bzrdir, None, _client=client)
 
458
        # This is a hack to work around the problem that RemoteBranch currently
 
459
        # unnecessarily invokes _ensure_real upon a call to lock_write.
 
460
        branch._ensure_real = lambda: None
 
461
        # Lock the branch, reset the record of remote calls.
 
462
        branch.lock_write()
 
463
        client._calls = []
 
464
 
 
465
        result = branch.set_revision_history(['rev-id1', 'rev-id2'])
 
466
        self.assertEqual(
 
467
            [('call', 'Branch.set_last_revision',
 
468
                ('branch/', 'branch token', 'repo token', 'rev-id2'))],
 
469
            client._calls)
 
470
        branch.unlock()
 
471
        self.assertEqual(None, result)
 
472
 
 
473
    def test_no_such_revision(self):
 
474
        # A response of 'NoSuchRevision' is translated into an exception.
 
475
        client = FakeClient([
 
476
            # lock_write
 
477
            (('ok', 'branch token', 'repo token'), ),
 
478
            # set_last_revision
 
479
            (('NoSuchRevision', 'rev-id'), ),
 
480
            # unlock
 
481
            (('ok',), )])
 
482
        transport = MemoryTransport()
 
483
        transport.mkdir('branch')
 
484
        transport = transport.clone('branch')
 
485
 
 
486
        bzrdir = RemoteBzrDir(transport, _client=False)
 
487
        branch = RemoteBranch(bzrdir, None, _client=client)
 
488
        branch._ensure_real = lambda: None
 
489
        branch.lock_write()
 
490
        client._calls = []
 
491
 
 
492
        self.assertRaises(
 
493
            errors.NoSuchRevision, branch.set_revision_history, ['rev-id'])
 
494
        branch.unlock()
 
495
 
 
496
 
 
497
class TestBranchControlGetBranchConf(tests.TestCaseWithMemoryTransport):
 
498
    """Test branch.control_files api munging...
 
499
 
 
500
    We special case RemoteBranch.control_files.get('branch.conf') to
 
501
    call a specific API so that RemoteBranch's can intercept configuration
 
502
    file reading, allowing them to signal to the client about things like
 
503
    'email is configured for commits'.
 
504
    """
 
505
 
 
506
    def test_get_branch_conf(self):
 
507
        # in an empty branch we decode the response properly
 
508
        client = FakeClient([(('ok', ), 'config file body')], self.get_url())
 
509
        # we need to make a real branch because the remote_branch.control_files
 
510
        # will trigger _ensure_real.
 
511
        branch = self.make_branch('quack')
 
512
        transport = branch.bzrdir.root_transport
 
513
        # we do not want bzrdir to make any remote calls
 
514
        bzrdir = RemoteBzrDir(transport, _client=False)
 
515
        branch = RemoteBranch(bzrdir, None, _client=client)
 
516
        result = branch.control_files.get('branch.conf')
 
517
        self.assertEqual(
 
518
            [('call_expecting_body', 'Branch.get_config_file', ('quack/',))],
 
519
            client._calls)
 
520
        self.assertEqual('config file body', result.read())
 
521
 
 
522
 
 
523
class TestBranchLockWrite(tests.TestCase):
 
524
 
 
525
    def test_lock_write_unlockable(self):
 
526
        transport = MemoryTransport()
 
527
        client = FakeClient([(('UnlockableTransport', ), '')], transport.base)
 
528
        transport.mkdir('quack')
 
529
        transport = transport.clone('quack')
 
530
        # we do not want bzrdir to make any remote calls
 
531
        bzrdir = RemoteBzrDir(transport, _client=False)
 
532
        branch = RemoteBranch(bzrdir, None, _client=client)
 
533
        self.assertRaises(errors.UnlockableTransport, branch.lock_write)
 
534
        self.assertEqual(
 
535
            [('call', 'Branch.lock_write', ('quack/', '', ''))],
 
536
            client._calls)
 
537
 
 
538
 
 
539
class TestTransportIsReadonly(tests.TestCase):
 
540
 
 
541
    def test_true(self):
 
542
        client = FakeClient([(('yes',), '')])
 
543
        transport = RemoteTransport('bzr://example.com/', medium=False,
 
544
                                    _client=client)
 
545
        self.assertEqual(True, transport.is_readonly())
 
546
        self.assertEqual(
 
547
            [('call', 'Transport.is_readonly', ())],
 
548
            client._calls)
 
549
 
 
550
    def test_false(self):
 
551
        client = FakeClient([(('no',), '')])
 
552
        transport = RemoteTransport('bzr://example.com/', medium=False,
 
553
                                    _client=client)
 
554
        self.assertEqual(False, transport.is_readonly())
 
555
        self.assertEqual(
 
556
            [('call', 'Transport.is_readonly', ())],
 
557
            client._calls)
 
558
 
 
559
    def test_error_from_old_server(self):
 
560
        """bzr 0.15 and earlier servers don't recognise the is_readonly verb.
 
561
        
 
562
        Clients should treat it as a "no" response, because is_readonly is only
 
563
        advisory anyway (a transport could be read-write, but then the
 
564
        underlying filesystem could be readonly anyway).
 
565
        """
 
566
        client = FakeClient([(('unknown verb', 'Transport.is_readonly'), '')])
 
567
        transport = RemoteTransport('bzr://example.com/', medium=False,
 
568
                                    _client=client)
 
569
        self.assertEqual(False, transport.is_readonly())
 
570
        self.assertEqual(
 
571
            [('call', 'Transport.is_readonly', ())],
 
572
            client._calls)
 
573
 
 
574
 
 
575
class TestRemoteRepository(tests.TestCase):
 
576
    """Base for testing RemoteRepository protocol usage.
 
577
    
 
578
    These tests contain frozen requests and responses.  We want any changes to 
 
579
    what is sent or expected to be require a thoughtful update to these tests
 
580
    because they might break compatibility with different-versioned servers.
 
581
    """
 
582
 
 
583
    def setup_fake_client_and_repository(self, responses, transport_path):
 
584
        """Create the fake client and repository for testing with.
 
585
        
 
586
        There's no real server here; we just have canned responses sent
 
587
        back one by one.
 
588
        
 
589
        :param transport_path: Path below the root of the MemoryTransport
 
590
            where the repository will be created.
 
591
        """
 
592
        transport = MemoryTransport()
 
593
        transport.mkdir(transport_path)
 
594
        client = FakeClient(responses, transport.base)
 
595
        transport = transport.clone(transport_path)
 
596
        # we do not want bzrdir to make any remote calls
 
597
        bzrdir = RemoteBzrDir(transport, _client=False)
 
598
        repo = RemoteRepository(bzrdir, None, _client=client)
 
599
        return repo, client
 
600
 
 
601
 
 
602
class TestRepositoryGatherStats(TestRemoteRepository):
 
603
 
 
604
    def test_revid_none(self):
 
605
        # ('ok',), body with revisions and size
 
606
        responses = [(('ok', ), 'revisions: 2\nsize: 18\n')]
 
607
        transport_path = 'quack'
 
608
        repo, client = self.setup_fake_client_and_repository(
 
609
            responses, transport_path)
 
610
        result = repo.gather_stats(None)
 
611
        self.assertEqual(
 
612
            [('call_expecting_body', 'Repository.gather_stats',
 
613
             ('quack/','','no'))],
 
614
            client._calls)
 
615
        self.assertEqual({'revisions': 2, 'size': 18}, result)
 
616
 
 
617
    def test_revid_no_committers(self):
 
618
        # ('ok',), body without committers
 
619
        responses = [(('ok', ),
 
620
                      'firstrev: 123456.300 3600\n'
 
621
                      'latestrev: 654231.400 0\n'
 
622
                      'revisions: 2\n'
 
623
                      'size: 18\n')]
 
624
        transport_path = 'quick'
 
625
        revid = u'\xc8'.encode('utf8')
 
626
        repo, client = self.setup_fake_client_and_repository(
 
627
            responses, transport_path)
 
628
        result = repo.gather_stats(revid)
 
629
        self.assertEqual(
 
630
            [('call_expecting_body', 'Repository.gather_stats',
 
631
              ('quick/', revid, 'no'))],
 
632
            client._calls)
 
633
        self.assertEqual({'revisions': 2, 'size': 18,
 
634
                          'firstrev': (123456.300, 3600),
 
635
                          'latestrev': (654231.400, 0),},
 
636
                         result)
 
637
 
 
638
    def test_revid_with_committers(self):
 
639
        # ('ok',), body with committers
 
640
        responses = [(('ok', ),
 
641
                      'committers: 128\n'
 
642
                      'firstrev: 123456.300 3600\n'
 
643
                      'latestrev: 654231.400 0\n'
 
644
                      'revisions: 2\n'
 
645
                      'size: 18\n')]
 
646
        transport_path = 'buick'
 
647
        revid = u'\xc8'.encode('utf8')
 
648
        repo, client = self.setup_fake_client_and_repository(
 
649
            responses, transport_path)
 
650
        result = repo.gather_stats(revid, True)
 
651
        self.assertEqual(
 
652
            [('call_expecting_body', 'Repository.gather_stats',
 
653
              ('buick/', revid, 'yes'))],
 
654
            client._calls)
 
655
        self.assertEqual({'revisions': 2, 'size': 18,
 
656
                          'committers': 128,
 
657
                          'firstrev': (123456.300, 3600),
 
658
                          'latestrev': (654231.400, 0),},
 
659
                         result)
 
660
 
 
661
 
 
662
class TestRepositoryGetGraph(TestRemoteRepository):
 
663
 
 
664
    def test_get_graph(self):
 
665
        # get_graph returns a graph with the repository as the
 
666
        # parents_provider.
 
667
        responses = []
 
668
        transport_path = 'quack'
 
669
        repo, client = self.setup_fake_client_and_repository(
 
670
            responses, transport_path)
 
671
        graph = repo.get_graph()
 
672
        self.assertEqual(graph._parents_provider, repo)
 
673
 
 
674
 
 
675
class TestRepositoryGetParentMap(TestRemoteRepository):
 
676
 
 
677
    def test_get_parent_map_caching(self):
 
678
        # get_parent_map returns from cache until unlock()
 
679
        # setup a reponse with two revisions
 
680
        r1 = u'\u0e33'.encode('utf8')
 
681
        r2 = u'\u0dab'.encode('utf8')
 
682
        lines = [' '.join([r2, r1]), r1]
 
683
        encoded_body = bz2.compress('\n'.join(lines))
 
684
        responses = [(('ok', ), encoded_body), (('ok', ), encoded_body)]
 
685
 
 
686
        transport_path = 'quack'
 
687
        repo, client = self.setup_fake_client_and_repository(
 
688
            responses, transport_path)
 
689
        repo.lock_read()
 
690
        graph = repo.get_graph()
 
691
        parents = graph.get_parent_map([r2])
 
692
        self.assertEqual({r2: (r1,)}, parents)
 
693
        # locking and unlocking deeper should not reset
 
694
        repo.lock_read()
 
695
        repo.unlock()
 
696
        parents = graph.get_parent_map([r1])
 
697
        self.assertEqual({r1: (NULL_REVISION,)}, parents)
 
698
        self.assertEqual(
 
699
            [('call_with_body_bytes_expecting_body',
 
700
              'Repository.get_parent_map', ('quack/', r2), '\n\n0')],
 
701
            client._calls)
 
702
        repo.unlock()
 
703
        # now we call again, and it should use the second response.
 
704
        repo.lock_read()
 
705
        graph = repo.get_graph()
 
706
        parents = graph.get_parent_map([r1])
 
707
        self.assertEqual({r1: (NULL_REVISION,)}, parents)
 
708
        self.assertEqual(
 
709
            [('call_with_body_bytes_expecting_body',
 
710
              'Repository.get_parent_map', ('quack/', r2), '\n\n0'),
 
711
             ('call_with_body_bytes_expecting_body',
 
712
              'Repository.get_parent_map', ('quack/', r1), '\n\n0'),
 
713
            ],
 
714
            client._calls)
 
715
        repo.unlock()
 
716
 
 
717
    def test_get_parent_map_reconnects_if_unknown_method(self):
 
718
        responses = [
 
719
            (('unknown verb', 'Repository.get_parent_map'), ''),
 
720
            (('ok',), '')]
 
721
        transport_path = 'quack'
 
722
        repo, client = self.setup_fake_client_and_repository(
 
723
            responses, transport_path)
 
724
        rev_id = 'revision-id'
 
725
        expected_deprecations = [
 
726
            'bzrlib.remote.RemoteRepository.get_revision_graph was deprecated '
 
727
            'in version 1.4.']
 
728
        parents = self.callDeprecated(
 
729
            expected_deprecations, repo.get_parent_map, [rev_id])
 
730
        self.assertEqual(
 
731
            [('call_with_body_bytes_expecting_body',
 
732
              'Repository.get_parent_map', ('quack/', rev_id), '\n\n0'),
 
733
             ('disconnect medium',),
 
734
             ('call_expecting_body', 'Repository.get_revision_graph',
 
735
              ('quack/', ''))],
 
736
            client._calls)
 
737
 
 
738
    def test_get_parent_map_unexpected_response(self):
 
739
        responses = [
 
740
            (('something unexpected!',), '')]
 
741
        repo, client = self.setup_fake_client_and_repository(responses, 'path')
 
742
        self.assertRaises(
 
743
            errors.UnexpectedSmartServerResponse,
 
744
            repo.get_parent_map, ['a-revision-id'])
 
745
 
 
746
 
 
747
class TestRepositoryGetRevisionGraph(TestRemoteRepository):
 
748
    
 
749
    def test_null_revision(self):
 
750
        # a null revision has the predictable result {}, we should have no wire
 
751
        # traffic when calling it with this argument
 
752
        responses = [(('notused', ), '')]
 
753
        transport_path = 'empty'
 
754
        repo, client = self.setup_fake_client_and_repository(
 
755
            responses, transport_path)
 
756
        result = self.applyDeprecated(one_four, repo.get_revision_graph,
 
757
            NULL_REVISION)
 
758
        self.assertEqual([], client._calls)
 
759
        self.assertEqual({}, result)
 
760
 
 
761
    def test_none_revision(self):
 
762
        # with none we want the entire graph
 
763
        r1 = u'\u0e33'.encode('utf8')
 
764
        r2 = u'\u0dab'.encode('utf8')
 
765
        lines = [' '.join([r2, r1]), r1]
 
766
        encoded_body = '\n'.join(lines)
 
767
 
 
768
        responses = [(('ok', ), encoded_body)]
 
769
        transport_path = 'sinhala'
 
770
        repo, client = self.setup_fake_client_and_repository(
 
771
            responses, transport_path)
 
772
        result = self.applyDeprecated(one_four, repo.get_revision_graph)
 
773
        self.assertEqual(
 
774
            [('call_expecting_body', 'Repository.get_revision_graph',
 
775
             ('sinhala/', ''))],
 
776
            client._calls)
 
777
        self.assertEqual({r1: (), r2: (r1, )}, result)
 
778
 
 
779
    def test_specific_revision(self):
 
780
        # with a specific revision we want the graph for that
 
781
        # with none we want the entire graph
 
782
        r11 = u'\u0e33'.encode('utf8')
 
783
        r12 = u'\xc9'.encode('utf8')
 
784
        r2 = u'\u0dab'.encode('utf8')
 
785
        lines = [' '.join([r2, r11, r12]), r11, r12]
 
786
        encoded_body = '\n'.join(lines)
 
787
 
 
788
        responses = [(('ok', ), encoded_body)]
 
789
        transport_path = 'sinhala'
 
790
        repo, client = self.setup_fake_client_and_repository(
 
791
            responses, transport_path)
 
792
        result = self.applyDeprecated(one_four, repo.get_revision_graph, r2)
 
793
        self.assertEqual(
 
794
            [('call_expecting_body', 'Repository.get_revision_graph',
 
795
             ('sinhala/', r2))],
 
796
            client._calls)
 
797
        self.assertEqual({r11: (), r12: (), r2: (r11, r12), }, result)
 
798
 
 
799
    def test_no_such_revision(self):
 
800
        revid = '123'
 
801
        responses = [(('nosuchrevision', revid), '')]
 
802
        transport_path = 'sinhala'
 
803
        repo, client = self.setup_fake_client_and_repository(
 
804
            responses, transport_path)
 
805
        # also check that the right revision is reported in the error
 
806
        self.assertRaises(errors.NoSuchRevision,
 
807
            self.applyDeprecated, one_four, repo.get_revision_graph, revid)
 
808
        self.assertEqual(
 
809
            [('call_expecting_body', 'Repository.get_revision_graph',
 
810
             ('sinhala/', revid))],
 
811
            client._calls)
 
812
 
 
813
        
 
814
class TestRepositoryIsShared(TestRemoteRepository):
 
815
 
 
816
    def test_is_shared(self):
 
817
        # ('yes', ) for Repository.is_shared -> 'True'.
 
818
        responses = [(('yes', ), )]
 
819
        transport_path = 'quack'
 
820
        repo, client = self.setup_fake_client_and_repository(
 
821
            responses, transport_path)
 
822
        result = repo.is_shared()
 
823
        self.assertEqual(
 
824
            [('call', 'Repository.is_shared', ('quack/',))],
 
825
            client._calls)
 
826
        self.assertEqual(True, result)
 
827
 
 
828
    def test_is_not_shared(self):
 
829
        # ('no', ) for Repository.is_shared -> 'False'.
 
830
        responses = [(('no', ), )]
 
831
        transport_path = 'qwack'
 
832
        repo, client = self.setup_fake_client_and_repository(
 
833
            responses, transport_path)
 
834
        result = repo.is_shared()
 
835
        self.assertEqual(
 
836
            [('call', 'Repository.is_shared', ('qwack/',))],
 
837
            client._calls)
 
838
        self.assertEqual(False, result)
 
839
 
 
840
 
 
841
class TestRepositoryLockWrite(TestRemoteRepository):
 
842
 
 
843
    def test_lock_write(self):
 
844
        responses = [(('ok', 'a token'), '')]
 
845
        transport_path = 'quack'
 
846
        repo, client = self.setup_fake_client_and_repository(
 
847
            responses, transport_path)
 
848
        result = repo.lock_write()
 
849
        self.assertEqual(
 
850
            [('call', 'Repository.lock_write', ('quack/', ''))],
 
851
            client._calls)
 
852
        self.assertEqual('a token', result)
 
853
 
 
854
    def test_lock_write_already_locked(self):
 
855
        responses = [(('LockContention', ), '')]
 
856
        transport_path = 'quack'
 
857
        repo, client = self.setup_fake_client_and_repository(
 
858
            responses, transport_path)
 
859
        self.assertRaises(errors.LockContention, repo.lock_write)
 
860
        self.assertEqual(
 
861
            [('call', 'Repository.lock_write', ('quack/', ''))],
 
862
            client._calls)
 
863
 
 
864
    def test_lock_write_unlockable(self):
 
865
        responses = [(('UnlockableTransport', ), '')]
 
866
        transport_path = 'quack'
 
867
        repo, client = self.setup_fake_client_and_repository(
 
868
            responses, transport_path)
 
869
        self.assertRaises(errors.UnlockableTransport, repo.lock_write)
 
870
        self.assertEqual(
 
871
            [('call', 'Repository.lock_write', ('quack/', ''))],
 
872
            client._calls)
 
873
 
 
874
 
 
875
class TestRepositoryUnlock(TestRemoteRepository):
 
876
 
 
877
    def test_unlock(self):
 
878
        responses = [(('ok', 'a token'), ''),
 
879
                     (('ok',), '')]
 
880
        transport_path = 'quack'
 
881
        repo, client = self.setup_fake_client_and_repository(
 
882
            responses, transport_path)
 
883
        repo.lock_write()
 
884
        repo.unlock()
 
885
        self.assertEqual(
 
886
            [('call', 'Repository.lock_write', ('quack/', '')),
 
887
             ('call', 'Repository.unlock', ('quack/', 'a token'))],
 
888
            client._calls)
 
889
 
 
890
    def test_unlock_wrong_token(self):
 
891
        # If somehow the token is wrong, unlock will raise TokenMismatch.
 
892
        responses = [(('ok', 'a token'), ''),
 
893
                     (('TokenMismatch',), '')]
 
894
        transport_path = 'quack'
 
895
        repo, client = self.setup_fake_client_and_repository(
 
896
            responses, transport_path)
 
897
        repo.lock_write()
 
898
        self.assertRaises(errors.TokenMismatch, repo.unlock)
 
899
 
 
900
 
 
901
class TestRepositoryHasRevision(TestRemoteRepository):
 
902
 
 
903
    def test_none(self):
 
904
        # repo.has_revision(None) should not cause any traffic.
 
905
        transport_path = 'quack'
 
906
        responses = None
 
907
        repo, client = self.setup_fake_client_and_repository(
 
908
            responses, transport_path)
 
909
 
 
910
        # The null revision is always there, so has_revision(None) == True.
 
911
        self.assertEqual(True, repo.has_revision(NULL_REVISION))
 
912
 
 
913
        # The remote repo shouldn't be accessed.
 
914
        self.assertEqual([], client._calls)
 
915
 
 
916
 
 
917
class TestRepositoryTarball(TestRemoteRepository):
 
918
 
 
919
    # This is a canned tarball reponse we can validate against
 
920
    tarball_content = (
 
921
        'QlpoOTFBWSZTWdGkj3wAAWF/k8aQACBIB//A9+8cIX/v33AACEAYABAECEACNz'
 
922
        'JqsgJJFPTSnk1A3qh6mTQAAAANPUHkagkSTEkaA09QaNAAAGgAAAcwCYCZGAEY'
 
923
        'mJhMJghpiaYBUkKammSHqNMZQ0NABkNAeo0AGneAevnlwQoGzEzNVzaYxp/1Uk'
 
924
        'xXzA1CQX0BJMZZLcPBrluJir5SQyijWHYZ6ZUtVqqlYDdB2QoCwa9GyWwGYDMA'
 
925
        'OQYhkpLt/OKFnnlT8E0PmO8+ZNSo2WWqeCzGB5fBXZ3IvV7uNJVE7DYnWj6qwB'
 
926
        'k5DJDIrQ5OQHHIjkS9KqwG3mc3t+F1+iujb89ufyBNIKCgeZBWrl5cXxbMGoMs'
 
927
        'c9JuUkg5YsiVcaZJurc6KLi6yKOkgCUOlIlOpOoXyrTJjK8ZgbklReDdwGmFgt'
 
928
        'dkVsAIslSVCd4AtACSLbyhLHryfb14PKegrVDba+U8OL6KQtzdM5HLjAc8/p6n'
 
929
        '0lgaWU8skgO7xupPTkyuwheSckejFLK5T4ZOo0Gda9viaIhpD1Qn7JqqlKAJqC'
 
930
        'QplPKp2nqBWAfwBGaOwVrz3y1T+UZZNismXHsb2Jq18T+VaD9k4P8DqE3g70qV'
 
931
        'JLurpnDI6VS5oqDDPVbtVjMxMxMg4rzQVipn2Bv1fVNK0iq3Gl0hhnnHKm/egy'
 
932
        'nWQ7QH/F3JFOFCQ0aSPfA='
 
933
        ).decode('base64')
 
934
 
 
935
    def test_repository_tarball(self):
 
936
        # Test that Repository.tarball generates the right operations
 
937
        transport_path = 'repo'
 
938
        expected_responses = [(('ok',), self.tarball_content),
 
939
            ]
 
940
        expected_calls = [('call_expecting_body', 'Repository.tarball',
 
941
                           ('repo/', 'bz2',),),
 
942
            ]
 
943
        remote_repo, client = self.setup_fake_client_and_repository(
 
944
            expected_responses, transport_path)
 
945
        # Now actually ask for the tarball
 
946
        tarball_file = remote_repo._get_tarball('bz2')
 
947
        try:
 
948
            self.assertEqual(expected_calls, client._calls)
 
949
            self.assertEqual(self.tarball_content, tarball_file.read())
 
950
        finally:
 
951
            tarball_file.close()
 
952
 
 
953
 
 
954
class TestRemoteRepositoryCopyContent(tests.TestCaseWithTransport):
 
955
    """RemoteRepository.copy_content_into optimizations"""
 
956
 
 
957
    def test_copy_content_remote_to_local(self):
 
958
        self.transport_server = server.SmartTCPServer_for_testing
 
959
        src_repo = self.make_repository('repo1')
 
960
        src_repo = repository.Repository.open(self.get_url('repo1'))
 
961
        # At the moment the tarball-based copy_content_into can't write back
 
962
        # into a smart server.  It would be good if it could upload the
 
963
        # tarball; once that works we'd have to create repositories of
 
964
        # different formats. -- mbp 20070410
 
965
        dest_url = self.get_vfs_only_url('repo2')
 
966
        dest_bzrdir = BzrDir.create(dest_url)
 
967
        dest_repo = dest_bzrdir.create_repository()
 
968
        self.assertFalse(isinstance(dest_repo, RemoteRepository))
 
969
        self.assertTrue(isinstance(src_repo, RemoteRepository))
 
970
        src_repo.copy_content_into(dest_repo)
 
971
 
 
972
 
 
973
class TestRepositoryStreamKnitData(TestRemoteRepository):
 
974
 
 
975
    def make_pack_file(self, records):
 
976
        pack_file = StringIO()
 
977
        pack_writer = pack.ContainerWriter(pack_file.write)
 
978
        pack_writer.begin()
 
979
        for bytes, names in records:
 
980
            pack_writer.add_bytes_record(bytes, names)
 
981
        pack_writer.end()
 
982
        pack_file.seek(0)
 
983
        return pack_file
 
984
 
 
985
    def make_pack_stream(self, records):
 
986
        pack_serialiser = pack.ContainerSerialiser()
 
987
        yield pack_serialiser.begin()
 
988
        for bytes, names in records:
 
989
            yield pack_serialiser.bytes_record(bytes, names)
 
990
        yield pack_serialiser.end()
 
991
 
 
992
    def test_bad_pack_from_server(self):
 
993
        """A response with invalid data (e.g. it has a record with multiple
 
994
        names) triggers an exception.
 
995
        
 
996
        Not all possible errors will be caught at this stage, but obviously
 
997
        malformed data should be.
 
998
        """
 
999
        record = ('bytes', [('name1',), ('name2',)])
 
1000
        pack_stream = self.make_pack_stream([record])
 
1001
        responses = [(('ok',), pack_stream), ]
 
1002
        transport_path = 'quack'
 
1003
        repo, client = self.setup_fake_client_and_repository(
 
1004
            responses, transport_path)
 
1005
        search = graph.SearchResult(set(['revid']), set(), 1, set(['revid']))
 
1006
        stream = repo.get_data_stream_for_search(search)
 
1007
        self.assertRaises(errors.SmartProtocolError, list, stream)
 
1008
    
 
1009
    def test_backwards_compatibility(self):
 
1010
        """If the server doesn't recognise this request, fallback to VFS."""
 
1011
        responses = [
 
1012
            (('unknown verb', 'Repository.stream_revisions_chunked'), '')]
 
1013
        repo, client = self.setup_fake_client_and_repository(
 
1014
            responses, 'path')
 
1015
        self.mock_called = False
 
1016
        repo._real_repository = MockRealRepository(self)
 
1017
        search = graph.SearchResult(set(['revid']), set(), 1, set(['revid']))
 
1018
        repo.get_data_stream_for_search(search)
 
1019
        self.assertTrue(self.mock_called)
 
1020
        self.failIf(client.expecting_body,
 
1021
            "The protocol has been left in an unclean state that will cause "
 
1022
            "TooManyConcurrentRequests errors.")
 
1023
 
 
1024
 
 
1025
class MockRealRepository(object):
 
1026
    """Helper class for TestRepositoryStreamKnitData.test_unknown_method."""
 
1027
 
 
1028
    def __init__(self, test):
 
1029
        self.test = test
 
1030
 
 
1031
    def get_data_stream_for_search(self, search):
 
1032
        self.test.assertEqual(set(['revid']), search.get_keys())
 
1033
        self.test.mock_called = True
 
1034
 
 
1035