1
# Copyright (C) 2006 Canonical Ltd
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.
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.
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
17
"""Tests for the smart wire/domain protococl."""
19
from bzrlib import bzrdir, errors, smart, tests
20
from bzrlib.smart.request import SmartServerResponse
21
import bzrlib.smart.bzrdir
22
import bzrlib.smart.branch
23
import bzrlib.smart.repository
26
class TestCaseWithSmartMedium(tests.TestCaseWithTransport):
29
super(TestCaseWithSmartMedium, self).setUp()
30
# We're allowed to set the transport class here, so that we don't use
31
# the default or a parameterized class, but rather use the
32
# TestCaseWithTransport infrastructure to set up a smart server and
34
self.transport_server = smart.server.SmartTCPServer_for_testing
36
def get_smart_medium(self):
37
"""Get a smart medium to use in tests."""
38
return self.get_transport().get_smart_medium()
41
class TestSmartServerResponse(tests.TestCase):
44
self.assertEqual(SmartServerResponse(('ok', )),
45
SmartServerResponse(('ok', )))
46
self.assertEqual(SmartServerResponse(('ok', ), 'body'),
47
SmartServerResponse(('ok', ), 'body'))
48
self.assertNotEqual(SmartServerResponse(('ok', )),
49
SmartServerResponse(('notok', )))
50
self.assertNotEqual(SmartServerResponse(('ok', ), 'body'),
51
SmartServerResponse(('ok', )))
52
self.assertNotEqual(None,
53
SmartServerResponse(('ok', )))
56
class TestSmartServerRequestFindRepository(tests.TestCaseWithTransport):
58
def test_no_repository(self):
59
"""When there is no repository to be found, ('norepository', ) is returned."""
60
backing = self.get_transport()
61
request = smart.bzrdir.SmartServerRequestFindRepository(backing)
63
self.assertEqual(SmartServerResponse(('norepository', )),
64
request.execute(backing.local_abspath('')))
66
def test_nonshared_repository(self):
67
# nonshared repositorys only allow 'find' to return a handle when the
68
# path the repository is being searched on is the same as that that
69
# the repository is at.
70
backing = self.get_transport()
71
request = smart.bzrdir.SmartServerRequestFindRepository(backing)
72
self.make_repository('.')
73
self.assertEqual(SmartServerResponse(('ok', '')),
74
request.execute(backing.local_abspath('')))
75
self.make_bzrdir('subdir')
76
self.assertEqual(SmartServerResponse(('norepository', )),
77
request.execute(backing.local_abspath('subdir')))
79
def test_shared_repository(self):
80
"""When there is a shared repository, we get 'ok', 'relpath-to-repo'."""
81
backing = self.get_transport()
82
request = smart.bzrdir.SmartServerRequestFindRepository(backing)
83
self.make_repository('.', shared=True)
84
self.assertEqual(SmartServerResponse(('ok', '')),
85
request.execute(backing.local_abspath('')))
86
self.make_bzrdir('subdir')
87
self.assertEqual(SmartServerResponse(('ok', '..')),
88
request.execute(backing.local_abspath('subdir')))
89
self.make_bzrdir('subdir/deeper')
90
self.assertEqual(SmartServerResponse(('ok', '../..')),
91
request.execute(backing.local_abspath('subdir/deeper')))
94
class TestSmartServerRequestInitializeBzrDir(tests.TestCaseWithTransport):
96
def test_empty_dir(self):
97
"""Initializing an empty dir should succeed and do it."""
98
backing = self.get_transport()
99
request = smart.bzrdir.SmartServerRequestInitializeBzrDir(backing)
100
self.assertEqual(SmartServerResponse(('ok', )),
101
request.execute(backing.local_abspath('.')))
102
made_dir = bzrdir.BzrDir.open_from_transport(backing)
103
# no branch, tree or repository is expected with the current
105
self.assertRaises(errors.NoWorkingTree, made_dir.open_workingtree)
106
self.assertRaises(errors.NotBranchError, made_dir.open_branch)
107
self.assertRaises(errors.NoRepositoryPresent, made_dir.open_repository)
109
def test_missing_dir(self):
110
"""Initializing a missing directory should fail like the bzrdir api."""
111
backing = self.get_transport()
112
request = smart.bzrdir.SmartServerRequestInitializeBzrDir(backing)
113
self.assertRaises(errors.NoSuchFile,
114
request.execute, backing.local_abspath('subdir'))
116
def test_initialized_dir(self):
117
"""Initializing an extant bzrdir should fail like the bzrdir api."""
118
backing = self.get_transport()
119
request = smart.bzrdir.SmartServerRequestInitializeBzrDir(backing)
120
self.make_bzrdir('subdir')
121
self.assertRaises(errors.FileExists,
122
request.execute, backing.local_abspath('subdir'))
125
class TestSmartServerRequestOpenBranch(tests.TestCaseWithTransport):
127
def test_no_branch(self):
128
"""When there is no branch, ('nobranch', ) is returned."""
129
backing = self.get_transport()
130
request = smart.bzrdir.SmartServerRequestOpenBranch(backing)
131
self.make_bzrdir('.')
132
self.assertEqual(SmartServerResponse(('nobranch', )),
133
request.execute(backing.local_abspath('')))
135
def test_branch(self):
136
"""When there is a branch, 'ok' is returned."""
137
backing = self.get_transport()
138
request = smart.bzrdir.SmartServerRequestOpenBranch(backing)
139
self.make_branch('.')
140
self.assertEqual(SmartServerResponse(('ok', '')),
141
request.execute(backing.local_abspath('')))
143
def test_branch_reference(self):
144
"""When there is a branch reference, the reference URL is returned."""
145
backing = self.get_transport()
146
request = smart.bzrdir.SmartServerRequestOpenBranch(backing)
147
branch = self.make_branch('branch')
148
checkout = branch.create_checkout('reference',lightweight=True)
149
# TODO: once we have an API to probe for references of any sort, we
151
reference_url = backing.abspath('branch') + '/'
152
self.assertFileEqual(reference_url, 'reference/.bzr/branch/location')
153
self.assertEqual(SmartServerResponse(('ok', reference_url)),
154
request.execute(backing.local_abspath('reference')))
157
class TestSmartServerRequestRevisionHistory(tests.TestCaseWithTransport):
159
def test_empty(self):
160
"""For an empty branch, the body is empty."""
161
backing = self.get_transport()
162
request = smart.branch.SmartServerRequestRevisionHistory(backing)
163
self.make_branch('.')
164
self.assertEqual(SmartServerResponse(('ok', ), ''),
165
request.execute(backing.local_abspath('')))
167
def test_not_empty(self):
168
"""For a non-empty branch, the body is empty."""
169
backing = self.get_transport()
170
request = smart.branch.SmartServerRequestRevisionHistory(backing)
171
tree = self.make_branch_and_memory_tree('.')
174
r1 = tree.commit('1st commit')
175
r2 = tree.commit('2nd commit', rev_id=u'\xc8')
177
self.assertEqual(SmartServerResponse(('ok', ),
178
('\x00'.join([r1, r2])).encode('utf8')),
179
request.execute(backing.local_abspath('')))
182
class TestSmartServerBranchRequest(tests.TestCaseWithTransport):
184
def test_no_branch(self):
185
"""When there is a bzrdir and no branch, NotBranchError is raised."""
186
backing = self.get_transport()
187
request = smart.branch.SmartServerBranchRequest(backing)
188
self.make_bzrdir('.')
189
self.assertRaises(errors.NotBranchError,
190
request.execute, backing.local_abspath(''))
192
def test_branch_reference(self):
193
"""When there is a branch reference, NotBranchError is raised."""
194
backing = self.get_transport()
195
request = smart.branch.SmartServerBranchRequest(backing)
196
branch = self.make_branch('branch')
197
checkout = branch.create_checkout('reference',lightweight=True)
198
self.assertRaises(errors.NotBranchError,
199
request.execute, backing.local_abspath('checkout'))
202
class TestSmartServerBranchRequestLastRevisionInfo(tests.TestCaseWithTransport):
204
def test_empty(self):
205
"""For an empty branch, the result is ('ok', '0', '')."""
206
backing = self.get_transport()
207
request = smart.branch.SmartServerBranchRequestLastRevisionInfo(backing)
208
self.make_branch('.')
209
self.assertEqual(SmartServerResponse(('ok', '0', '')),
210
request.execute(backing.local_abspath('')))
212
def test_not_empty(self):
213
"""For a non-empty branch, the result is ('ok', 'revno', 'revid')."""
214
backing = self.get_transport()
215
request = smart.branch.SmartServerBranchRequestLastRevisionInfo(backing)
216
tree = self.make_branch_and_memory_tree('.')
219
r1 = tree.commit('1st commit')
220
r2 = tree.commit('2nd commit', rev_id=u'\xc8')
223
SmartServerResponse(('ok', '2', u'\xc8'.encode('utf8'))),
224
request.execute(backing.local_abspath('')))
227
class TestSmartServerBranchRequestGetConfigFile(tests.TestCaseWithTransport):
229
def test_default(self):
230
"""With no file, we get empty content."""
231
backing = self.get_transport()
232
request = smart.branch.SmartServerBranchGetConfigFile(backing)
233
branch = self.make_branch('.')
234
# there should be no file by default
236
self.assertEqual(SmartServerResponse(('ok', ), content),
237
request.execute(backing.local_abspath('')))
239
def test_with_content(self):
240
# SmartServerBranchGetConfigFile should return the content from
241
# branch.control_files.get('branch.conf') for now - in the future it may
242
# perform more complex processing.
243
backing = self.get_transport()
244
request = smart.branch.SmartServerBranchGetConfigFile(backing)
245
branch = self.make_branch('.')
246
branch.control_files.put_utf8('branch.conf', 'foo bar baz')
247
self.assertEqual(SmartServerResponse(('ok', ), 'foo bar baz'),
248
request.execute(backing.local_abspath('')))
251
class TestSmartServerBranchRequestSetLastRevision(tests.TestCaseWithTransport):
253
def test_empty(self):
254
backing = self.get_transport()
255
request = smart.branch.SmartServerBranchRequestSetLastRevision(backing)
256
self.make_branch('.')
257
self.assertEqual(SmartServerResponse(('ok',)),
258
request.execute(backing.local_abspath(''), ''))
260
def test_not_present_revision_id(self):
261
backing = self.get_transport()
262
request = smart.branch.SmartServerBranchRequestSetLastRevision(backing)
263
self.make_branch('.')
264
revision_id = 'non-existent revision'
265
self.assertEqual(SmartServerResponse(('NoSuchRevision', revision_id)),
266
request.execute(backing.local_abspath(''), revision_id))
268
def test_revision_id_present(self):
269
backing = self.get_transport()
270
request = smart.branch.SmartServerBranchRequestSetLastRevision(backing)
271
tree = self.make_branch_and_memory_tree('.')
274
r1 = tree.commit('1st commit', rev_id=u'\xc8')
275
r2 = tree.commit('2nd commit')
278
SmartServerResponse(('ok',)),
279
request.execute(backing.local_abspath(''), u'\xc8'.encode('utf8')))
280
self.assertEqual([u'\xc8'], tree.branch.revision_history())
282
def test_revision_id_present2(self):
283
backing = self.get_transport()
284
request = smart.branch.SmartServerBranchRequestSetLastRevision(backing)
285
tree = self.make_branch_and_memory_tree('.')
288
r1 = tree.commit('1st commit', rev_id=u'\xc8')
289
r2 = tree.commit('2nd commit')
291
tree.branch.set_revision_history([])
293
SmartServerResponse(('ok',)),
294
request.execute(backing.local_abspath(''), u'\xc8'.encode('utf8')))
295
self.assertEqual([u'\xc8'], tree.branch.revision_history())
298
class TestSmartServerRepositoryRequest(tests.TestCaseWithTransport):
300
def test_no_repository(self):
301
"""Raise NoRepositoryPresent when there is a bzrdir and no repo."""
302
# we test this using a shared repository above the named path,
303
# thus checking the right search logic is used - that is, that
304
# its the exact path being looked at and the server is not
306
backing = self.get_transport()
307
request = smart.repository.SmartServerRepositoryRequest(backing)
308
self.make_repository('.', shared=True)
309
self.make_bzrdir('subdir')
310
self.assertRaises(errors.NoRepositoryPresent,
311
request.execute, backing.local_abspath('subdir'))
314
class TestSmartServerRepositoryGetRevisionGraph(tests.TestCaseWithTransport):
316
def test_none_argument(self):
317
backing = self.get_transport()
318
request = smart.repository.SmartServerRepositoryGetRevisionGraph(backing)
319
tree = self.make_branch_and_memory_tree('.')
322
r1 = tree.commit('1st commit')
323
r2 = tree.commit('2nd commit', rev_id=u'\xc8')
326
# the lines of revision_id->revision_parent_list has no guaranteed
327
# order coming out of a dict, so sort both our test and response
328
lines = sorted([' '.join([r2, r1]), r1])
329
response = request.execute(backing.local_abspath(''), '')
330
response.body = '\n'.join(sorted(response.body.split('\n')))
332
self.assertEqual(SmartServerResponse(('ok', ),
333
'\n'.join(lines).encode('utf8')),
336
def test_specific_revision_argument(self):
337
backing = self.get_transport()
338
request = smart.repository.SmartServerRepositoryGetRevisionGraph(backing)
339
tree = self.make_branch_and_memory_tree('.')
342
r1 = tree.commit('1st commit', rev_id=u'\xc9')
343
r2 = tree.commit('2nd commit', rev_id=u'\xc8')
346
self.assertEqual(SmartServerResponse(('ok', ),
347
u'\xc9'.encode('utf8')),
348
request.execute(backing.local_abspath(''), u'\xc9'.encode('utf8')))
350
def test_no_such_revision(self):
351
backing = self.get_transport()
352
request = smart.repository.SmartServerRepositoryGetRevisionGraph(backing)
353
tree = self.make_branch_and_memory_tree('.')
356
r1 = tree.commit('1st commit')
359
self.assertEqual(SmartServerResponse(
360
('nosuchrevision', 'missingrevision', )),
361
request.execute(backing.local_abspath(''), 'missingrevision'))
363
class TestSmartServerRequestHasRevision(tests.TestCaseWithTransport):
365
def test_missing_revision(self):
366
"""For a missing revision, ('no', ) is returned."""
367
backing = self.get_transport()
368
request = smart.repository.SmartServerRequestHasRevision(backing)
369
self.make_repository('.')
370
self.assertEqual(SmartServerResponse(('no', )),
371
request.execute(backing.local_abspath(''), 'revid'))
373
def test_present_revision(self):
374
"""For a present revision, ('ok', ) is returned."""
375
backing = self.get_transport()
376
request = smart.repository.SmartServerRequestHasRevision(backing)
377
tree = self.make_branch_and_memory_tree('.')
380
r1 = tree.commit('a commit', rev_id=u'\xc8abc')
382
self.assertTrue(tree.branch.repository.has_revision(u'\xc8abc'))
383
self.assertEqual(SmartServerResponse(('ok', )),
384
request.execute(backing.local_abspath(''),
385
u'\xc8abc'.encode('utf8')))
388
class TestSmartServerRepositoryGatherStats(tests.TestCaseWithTransport):
390
def test_empty_revid(self):
391
"""With an empty revid, we get only size an number and revisions"""
392
backing = self.get_transport()
393
request = smart.repository.SmartServerRepositoryGatherStats(backing)
394
repository = self.make_repository('.')
395
stats = repository.gather_stats()
397
expected_body = 'revisions: 0\nsize: %d\n' % size
398
self.assertEqual(SmartServerResponse(('ok', ), expected_body),
399
request.execute(backing.local_abspath(''), '', 'no'))
401
def test_revid_with_committers(self):
402
"""For a revid we get more infos."""
403
backing = self.get_transport()
405
request = smart.repository.SmartServerRepositoryGatherStats(backing)
406
tree = self.make_branch_and_memory_tree('.')
409
# Let's build a predictable result
410
tree.commit('a commit', timestamp=123456.2, timezone=3600)
411
tree.commit('a commit', timestamp=654321.4, timezone=0, rev_id=rev_id)
414
stats = tree.branch.repository.gather_stats()
416
expected_body = ('firstrev: 123456.200 3600\n'
417
'latestrev: 654321.400 0\n'
420
self.assertEqual(SmartServerResponse(('ok', ), expected_body),
421
request.execute(backing.local_abspath(''),
422
rev_id.encode('utf8'), 'no'))
424
def test_not_empty_repository_with_committers(self):
425
"""For a revid and requesting committers we get the whole thing."""
426
backing = self.get_transport()
428
request = smart.repository.SmartServerRepositoryGatherStats(backing)
429
tree = self.make_branch_and_memory_tree('.')
432
# Let's build a predictable result
433
tree.commit('a commit', timestamp=123456.2, timezone=3600,
435
tree.commit('a commit', timestamp=654321.4, timezone=0,
436
committer='bar', rev_id=rev_id)
438
stats = tree.branch.repository.gather_stats()
441
expected_body = ('committers: 2\n'
442
'firstrev: 123456.200 3600\n'
443
'latestrev: 654321.400 0\n'
446
self.assertEqual(SmartServerResponse(('ok', ), expected_body),
447
request.execute(backing.local_abspath(''),
448
rev_id.encode('utf8'), 'yes'))
451
class TestSmartServerRepositoryIsShared(tests.TestCaseWithTransport):
453
def test_is_shared(self):
454
"""For a shared repository, ('yes', ) is returned."""
455
backing = self.get_transport()
456
request = smart.repository.SmartServerRepositoryIsShared(backing)
457
self.make_repository('.', shared=True)
458
self.assertEqual(SmartServerResponse(('yes', )),
459
request.execute(backing.local_abspath(''), ))
461
def test_is_not_shared(self):
462
"""For a shared repository, ('no', ) is returned."""
463
backing = self.get_transport()
464
request = smart.repository.SmartServerRepositoryIsShared(backing)
465
self.make_repository('.', shared=False)
466
self.assertEqual(SmartServerResponse(('no', )),
467
request.execute(backing.local_abspath(''), ))
470
class TestSmartServerRepositoryLockWrite(tests.TestCaseWithTransport):
473
tests.TestCaseWithTransport.setUp(self)
474
self.reduceLockdirTimeout()
476
def test_lock_write_on_unlocked_repo(self):
477
backing = self.get_transport()
478
request = smart.repository.SmartServerRepositoryLockWrite(backing)
479
repository = self.make_repository('.')
480
response = request.execute(backing.local_abspath(''))
481
nonce = repository.control_files._lock.peek().get('nonce')
482
self.assertEqual(SmartServerResponse(('ok', nonce)), response)
483
# The repository is now locked. Verify that with a new repository
485
new_repo = repository.bzrdir.open_repository()
486
self.assertRaises(errors.LockContention, new_repo.lock_write)
488
def test_lock_write_on_locked_repo(self):
489
backing = self.get_transport()
490
request = smart.repository.SmartServerRepositoryLockWrite(backing)
491
repository = self.make_repository('.')
492
repository.lock_write()
493
repository.leave_lock_in_place()
495
response = request.execute(backing.local_abspath(''))
497
SmartServerResponse(('LockContention',)), response)
500
class TestSmartServerRepositoryUnlock(tests.TestCaseWithTransport):
503
tests.TestCaseWithTransport.setUp(self)
504
self.reduceLockdirTimeout()
506
def test_unlock_on_locked_repo(self):
507
backing = self.get_transport()
508
request = smart.repository.SmartServerRepositoryUnlock(backing)
509
repository = self.make_repository('.')
510
token = repository.lock_write()
511
repository.leave_lock_in_place()
513
response = request.execute(backing.local_abspath(''), token)
515
SmartServerResponse(('ok',)), response)
516
# The repository is now unlocked. Verify that with a new repository
518
new_repo = repository.bzrdir.open_repository()
519
new_repo.lock_write()
522
def test_unlock_on_unlocked_repo(self):
523
backing = self.get_transport()
524
request = smart.repository.SmartServerRepositoryUnlock(backing)
525
repository = self.make_repository('.')
526
response = request.execute(backing.local_abspath(''), 'some token')
528
SmartServerResponse(('TokenMismatch',)), response)
531
class TestHandlers(tests.TestCase):
532
"""Tests for the request.request_handlers object."""
534
def test_registered_methods(self):
535
"""Test that known methods are registered to the correct object."""
537
smart.request.request_handlers.get('Branch.get_config_file'),
538
smart.branch.SmartServerBranchGetConfigFile)
540
smart.request.request_handlers.get('Branch.last_revision_info'),
541
smart.branch.SmartServerBranchRequestLastRevisionInfo)
543
smart.request.request_handlers.get('Branch.revision_history'),
544
smart.branch.SmartServerRequestRevisionHistory)
546
smart.request.request_handlers.get('Branch.set_last_revision'),
547
smart.branch.SmartServerBranchRequestSetLastRevision)
549
smart.request.request_handlers.get('BzrDir.find_repository'),
550
smart.bzrdir.SmartServerRequestFindRepository)
552
smart.request.request_handlers.get('BzrDirFormat.initialize'),
553
smart.bzrdir.SmartServerRequestInitializeBzrDir)
555
smart.request.request_handlers.get('BzrDir.open_branch'),
556
smart.bzrdir.SmartServerRequestOpenBranch)
558
smart.request.request_handlers.get('Repository.gather_stats'),
559
smart.repository.SmartServerRepositoryGatherStats)
561
smart.request.request_handlers.get('Repository.get_revision_graph'),
562
smart.repository.SmartServerRepositoryGetRevisionGraph)
564
smart.request.request_handlers.get('Repository.has_revision'),
565
smart.repository.SmartServerRequestHasRevision)
567
smart.request.request_handlers.get('Repository.is_shared'),
568
smart.repository.SmartServerRepositoryIsShared)
570
smart.request.request_handlers.get('Repository.lock_write'),
571
smart.repository.SmartServerRepositoryLockWrite)
573
smart.request.request_handlers.get('Repository.unlock'),
574
smart.repository.SmartServerRepositoryUnlock)