53
57
RemoteRepositoryFormat,
55
from bzrlib.repofmt import groupcompress_repo, pack_repo
59
from bzrlib.repofmt import groupcompress_repo, knitpack_repo
56
60
from bzrlib.revision import NULL_REVISION
57
from bzrlib.smart import medium
61
from bzrlib.smart import medium, request
58
62
from bzrlib.smart.client import _SmartClient
59
from bzrlib.smart.repository import SmartServerRepositoryGetParentMap
63
from bzrlib.smart.repository import (
64
SmartServerRepositoryGetParentMap,
65
SmartServerRepositoryGetStream_1_19,
60
67
from bzrlib.tests import (
62
split_suite_by_condition,
66
from bzrlib.transport import get_transport
70
from bzrlib.tests.scenarios import load_tests_apply_scenarios
67
71
from bzrlib.transport.memory import MemoryTransport
68
72
from bzrlib.transport.remote import (
70
74
RemoteSSHTransport,
71
75
RemoteTCPTransport,
74
def load_tests(standard_tests, module, loader):
75
to_adapt, result = split_suite_by_condition(
76
standard_tests, condition_isinstance(BasicRemoteObjectTests))
77
smart_server_version_scenarios = [
79
load_tests = load_tests_apply_scenarios
82
class BasicRemoteObjectTests(tests.TestCaseWithTransport):
79
{'transport_server': test_server.SmartTCPServer_for_testing_v2_only}),
86
{'transport_server': test_server.SmartTCPServer_for_testing_v2_only}),
81
{'transport_server': test_server.SmartTCPServer_for_testing})]
82
return multiply_tests(to_adapt, smart_server_version_scenarios, result)
85
class BasicRemoteObjectTests(tests.TestCaseWithTransport):
88
{'transport_server': test_server.SmartTCPServer_for_testing})]
88
92
super(BasicRemoteObjectTests, self).setUp()
89
93
self.transport = self.get_transport()
90
94
# make a branch that can be opened over the smart transport
91
95
self.local_wt = BzrDir.create_standalone_workingtree('.')
94
self.transport.disconnect()
95
tests.TestCaseWithTransport.tearDown(self)
96
self.addCleanup(self.transport.disconnect)
97
98
def test_create_remote_bzrdir(self):
98
b = remote.RemoteBzrDir(self.transport, remote.RemoteBzrDirFormat())
99
b = remote.RemoteBzrDir(self.transport, RemoteBzrDirFormat())
99
100
self.assertIsInstance(b, BzrDir)
101
102
def test_open_remote_branch(self):
102
103
# open a standalone branch in the working directory
103
b = remote.RemoteBzrDir(self.transport, remote.RemoteBzrDirFormat())
104
b = remote.RemoteBzrDir(self.transport, RemoteBzrDirFormat())
104
105
branch = b.open_branch()
105
106
self.assertIsInstance(branch, Branch)
469
470
client.add_expected_call(
470
471
'BzrDir.cloning_metadir', ('quack/', 'False'),
471
472
'success', (control_name, '', ('branch', ''))),
472
a_bzrdir = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
473
a_bzrdir = RemoteBzrDir(transport, RemoteBzrDirFormat(),
474
475
result = a_bzrdir.cloning_metadir()
475
476
# We should have got a reference control dir with default branch and
495
496
client.add_expected_call(
496
497
'BzrDir.open_2.1', ('quack/',), 'success', ('no',))
497
498
self.assertRaises(errors.NotBranchError, RemoteBzrDir, transport,
498
remote.RemoteBzrDirFormat(), _client=client, _force_probe=True)
499
RemoteBzrDirFormat(), _client=client, _force_probe=True)
499
500
self.assertFinished(client)
501
502
def test_present_without_workingtree(self):
502
503
client, transport = self.make_fake_client_and_transport()
503
504
client.add_expected_call(
504
505
'BzrDir.open_2.1', ('quack/',), 'success', ('yes', 'no'))
505
bd = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
506
bd = RemoteBzrDir(transport, RemoteBzrDirFormat(),
506
507
_client=client, _force_probe=True)
507
508
self.assertIsInstance(bd, RemoteBzrDir)
508
509
self.assertFalse(bd.has_workingtree())
513
514
client, transport = self.make_fake_client_and_transport()
514
515
client.add_expected_call(
515
516
'BzrDir.open_2.1', ('quack/',), 'success', ('yes', 'yes'))
516
bd = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
517
bd = RemoteBzrDir(transport, RemoteBzrDirFormat(),
517
518
_client=client, _force_probe=True)
518
519
self.assertIsInstance(bd, RemoteBzrDir)
519
520
self.assertTrue(bd.has_workingtree())
526
527
'BzrDir.open_2.1', ('quack/',), 'unknown', ('BzrDir.open_2.1',))
527
528
client.add_expected_call(
528
529
'BzrDir.open', ('quack/',), 'success', ('yes',))
529
bd = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
530
bd = RemoteBzrDir(transport, RemoteBzrDirFormat(),
530
531
_client=client, _force_probe=True)
531
532
self.assertIsInstance(bd, RemoteBzrDir)
532
533
self.assertFinished(client)
548
549
'BzrDir.open_2.1', ('quack/',), 'unknown', ('BzrDir.open_2.1',))
549
550
client.add_expected_call(
550
551
'BzrDir.open', ('quack/',), 'success', ('yes',))
551
bd = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
552
bd = RemoteBzrDir(transport, RemoteBzrDirFormat(),
552
553
_client=client, _force_probe=True)
553
554
self.assertIsInstance(bd, RemoteBzrDir)
554
555
self.assertFinished(client)
609
610
# _get_tree_branch is a form of open_branch, but it should only ask for
610
611
# branch opening, not any other network requests.
613
def open_branch(name=None):
613
614
calls.append("Called")
614
615
return "a-branch"
615
616
transport = MemoryTransport()
616
617
# no requests on the network - catches other api calls being made.
617
618
client = FakeClient(transport.base)
618
bzrdir = RemoteBzrDir(transport, remote.RemoteBzrDirFormat(),
619
bzrdir = RemoteBzrDir(transport, RemoteBzrDirFormat(),
620
621
# patch the open_branch call to record that it was called.
621
622
bzrdir.open_branch = open_branch
724
725
format = branch._format
725
726
self.assertEqual(network_name, format.network_name())
728
def test_already_open_repo_and_reused_medium(self):
729
"""Bug 726584: create_branch(..., repository=repo) should work
730
regardless of what the smart medium's base URL is.
732
self.transport_server = test_server.SmartTCPServer_for_testing
733
transport = self.get_transport('.')
734
repo = self.make_repository('quack')
735
# Client's medium rooted a transport root (not at the bzrdir)
736
client = FakeClient(transport.base)
737
transport = transport.clone('quack')
738
reference_bzrdir_format = bzrdir.format_registry.get('default')()
739
reference_format = reference_bzrdir_format.get_branch_format()
740
network_name = reference_format.network_name()
741
reference_repo_fmt = reference_bzrdir_format.repository_format
742
reference_repo_name = reference_repo_fmt.network_name()
743
client.add_expected_call(
744
'BzrDir.create_branch', ('extra/quack/', network_name),
745
'success', ('ok', network_name, '', 'no', 'no', 'yes',
746
reference_repo_name))
747
a_bzrdir = RemoteBzrDir(transport, RemoteBzrDirFormat(),
749
branch = a_bzrdir.create_branch(repository=repo)
750
# We should have got a remote branch
751
self.assertIsInstance(branch, remote.RemoteBranch)
752
# its format should have the settings from the response
753
format = branch._format
754
self.assertEqual(network_name, format.network_name())
728
757
class TestBzrDirCreateRepository(TestRemote):
1143
1172
[('set_tags_bytes', 'tags bytes')] * 2, real_branch.calls)
1175
class TestBranchHeadsToFetch(RemoteBranchTestCase):
1177
def test_uses_last_revision_info_and_tags_by_default(self):
1178
transport = MemoryTransport()
1179
client = FakeClient(transport.base)
1180
client.add_expected_call(
1181
'Branch.get_stacked_on_url', ('quack/',),
1182
'error', ('NotStacked',))
1183
client.add_expected_call(
1184
'Branch.last_revision_info', ('quack/',),
1185
'success', ('ok', '1', 'rev-tip'))
1186
# XXX: this will break if the default format's serialization of tags
1187
# changes, or if the RPC for fetching tags changes from get_tags_bytes.
1188
client.add_expected_call(
1189
'Branch.get_tags_bytes', ('quack/',),
1190
'success', ('d5:tag-17:rev-foo5:tag-27:rev-bare',))
1191
transport.mkdir('quack')
1192
transport = transport.clone('quack')
1193
branch = self.make_remote_branch(transport, client)
1194
result = branch.heads_to_fetch()
1195
self.assertFinished(client)
1197
(set(['rev-tip']), set(['rev-foo', 'rev-bar'])), result)
1199
def test_uses_rpc_for_formats_with_non_default_heads_to_fetch(self):
1200
transport = MemoryTransport()
1201
client = FakeClient(transport.base)
1202
client.add_expected_call(
1203
'Branch.get_stacked_on_url', ('quack/',),
1204
'error', ('NotStacked',))
1205
client.add_expected_call(
1206
'Branch.heads_to_fetch', ('quack/',),
1207
'success', (['tip'], ['tagged-1', 'tagged-2']))
1208
transport.mkdir('quack')
1209
transport = transport.clone('quack')
1210
branch = self.make_remote_branch(transport, client)
1211
branch._format._use_default_local_heads_to_fetch = lambda: False
1212
result = branch.heads_to_fetch()
1213
self.assertFinished(client)
1214
self.assertEqual((set(['tip']), set(['tagged-1', 'tagged-2'])), result)
1216
def test_backwards_compatible(self):
1217
self.setup_smart_server_with_call_log()
1218
# Make a branch with a single revision.
1219
builder = self.make_branch_builder('foo')
1220
builder.start_series()
1221
builder.build_snapshot('tip', None, [
1222
('add', ('', 'root-id', 'directory', ''))])
1223
builder.finish_series()
1224
branch = builder.get_branch()
1225
# Add two tags to that branch
1226
branch.tags.set_tag('tag-1', 'rev-1')
1227
branch.tags.set_tag('tag-2', 'rev-2')
1228
self.addCleanup(branch.lock_read().unlock)
1229
# Disable the heads_to_fetch verb
1230
verb = 'Branch.heads_to_fetch'
1231
self.disable_verb(verb)
1232
self.reset_smart_call_log()
1233
result = branch.heads_to_fetch()
1234
self.assertEqual((set(['tip']), set(['rev-1', 'rev-2'])), result)
1236
['Branch.last_revision_info', 'Branch.get_tags_bytes'],
1237
[call.call.method for call in self.hpss_calls])
1146
1240
class TestBranchLastRevisionInfo(RemoteBranchTestCase):
1148
1242
def test_empty_branch(self):
1311
1405
# unnecessarily invokes _ensure_real upon a call to lock_write.
1312
1406
branch._ensure_real = lambda: None
1313
1407
branch.lock_write()
1314
result = branch.set_revision_history([])
1408
result = branch._set_last_revision(NULL_REVISION)
1315
1409
branch.unlock()
1316
1410
self.assertEqual(None, result)
1317
1411
self.assertFinished(client)
1319
1413
def test_set_nonempty(self):
1320
# set_revision_history([rev-id1, ..., rev-idN]) is translated to calling
1414
# set_last_revision_info(N, rev-idN) is translated to calling
1321
1415
# Branch.set_last_revision(path, rev-idN) on the wire.
1322
1416
transport = MemoryTransport()
1323
1417
transport.mkdir('branch')
1652
1747
branch.unlock()
1653
1748
self.assertFinished(client)
1750
def test_set_option_with_dict(self):
1751
client = FakeClient()
1752
client.add_expected_call(
1753
'Branch.get_stacked_on_url', ('memory:///',),
1754
'error', ('NotStacked',),)
1755
client.add_expected_call(
1756
'Branch.lock_write', ('memory:///', '', ''),
1757
'success', ('ok', 'branch token', 'repo token'))
1758
encoded_dict_value = 'd5:ascii1:a11:unicode \xe2\x8c\x9a3:\xe2\x80\xbde'
1759
client.add_expected_call(
1760
'Branch.set_config_option_dict', ('memory:///', 'branch token',
1761
'repo token', encoded_dict_value, 'foo', ''),
1763
client.add_expected_call(
1764
'Branch.unlock', ('memory:///', 'branch token', 'repo token'),
1766
transport = MemoryTransport()
1767
branch = self.make_remote_branch(transport, client)
1769
config = branch._get_config()
1771
{'ascii': 'a', u'unicode \N{WATCH}': u'\N{INTERROBANG}'},
1774
self.assertFinished(client)
1655
1776
def test_backwards_compat_set_option(self):
1656
1777
self.setup_smart_server_with_call_log()
1657
1778
branch = self.make_branch('.')
1664
1785
self.assertLength(10, self.hpss_calls)
1665
1786
self.assertEqual('value', branch._get_config().get_option('name'))
1788
def test_backwards_compat_set_option_with_dict(self):
1789
self.setup_smart_server_with_call_log()
1790
branch = self.make_branch('.')
1791
verb = 'Branch.set_config_option_dict'
1792
self.disable_verb(verb)
1794
self.addCleanup(branch.unlock)
1795
self.reset_smart_call_log()
1796
config = branch._get_config()
1797
value_dict = {'ascii': 'a', u'unicode \N{WATCH}': u'\N{INTERROBANG}'}
1798
config.set_option(value_dict, 'name')
1799
self.assertLength(10, self.hpss_calls)
1800
self.assertEqual(value_dict, branch._get_config().get_option('name'))
1668
1803
class TestBranchLockWrite(RemoteBranchTestCase):
1828
1963
class TestRepositoryFormat(TestRemoteRepository):
1830
1965
def test_fast_delta(self):
1831
true_name = groupcompress_repo.RepositoryFormatCHK1().network_name()
1966
true_name = groupcompress_repo.RepositoryFormat2a().network_name()
1832
1967
true_format = RemoteRepositoryFormat()
1833
1968
true_format._network_name = true_name
1834
1969
self.assertEqual(True, true_format.fast_deltas)
1835
false_name = pack_repo.RepositoryFormatKnitPack1().network_name()
1970
false_name = knitpack_repo.RepositoryFormatKnitPack1().network_name()
1836
1971
false_format = RemoteRepositoryFormat()
1837
1972
false_format._network_name = false_name
1838
1973
self.assertEqual(False, false_format.fast_deltas)
1840
1975
def test_get_format_description(self):
1841
1976
remote_repo_format = RemoteRepositoryFormat()
1842
real_format = repository.RepositoryFormat.get_default_format()
1977
real_format = repository.format_registry.get_default()
1843
1978
remote_repo_format._network_name = real_format.network_name()
1844
1979
self.assertEqual(remoted_description(real_format),
1845
1980
remote_repo_format.get_format_description())
2734
2870
('pack collection autopack',)],
2873
def test_oom_error_reporting(self):
2874
"""An out-of-memory condition on the server is reported clearly"""
2875
transport_path = 'quack'
2876
repo, client = self.setup_fake_client_and_repository(transport_path)
2877
client.add_expected_call(
2878
'PackRepository.autopack', ('quack/',),
2879
'error', ('MemoryError',))
2880
err = self.assertRaises(errors.BzrError, repo.autopack)
2881
self.assertContainsRe(str(err), "^remote server out of mem")
2738
2884
class TestErrorTranslationBase(tests.TestCaseWithMemoryTransport):
2739
2885
"""Base class for unit tests for bzrlib.remote._translate_error."""
2845
2998
expected_error = errors.DivergedBranches(branch, other_branch)
2846
2999
self.assertEqual(expected_error, translated_error)
3001
def test_NotStacked(self):
3002
branch = self.make_branch('')
3003
translated_error = self.translateTuple(('NotStacked',), branch=branch)
3004
expected_error = errors.NotStacked(branch)
3005
self.assertEqual(expected_error, translated_error)
2848
3007
def test_ReadError_no_args(self):
2849
3008
path = 'a path'
2850
3009
translated_error = self.translateTuple(('ReadError',), path=path)
2895
3055
expected_error = errors.PermissionDenied(path, extra)
2896
3056
self.assertEqual(expected_error, translated_error)
3058
# GZ 2011-03-02: TODO test for PermissionDenied with non-ascii 'extra'
3060
def test_NoSuchFile_context_path(self):
3061
local_path = "local path"
3062
translated_error = self.translateTuple(('ReadError', "remote path"),
3064
expected_error = errors.ReadError(local_path)
3065
self.assertEqual(expected_error, translated_error)
3067
def test_NoSuchFile_without_context(self):
3068
remote_path = "remote path"
3069
translated_error = self.translateTuple(('ReadError', remote_path))
3070
expected_error = errors.ReadError(remote_path)
3071
self.assertEqual(expected_error, translated_error)
3073
def test_ReadOnlyError(self):
3074
translated_error = self.translateTuple(('ReadOnlyError',))
3075
expected_error = errors.TransportNotPossible("readonly transport")
3076
self.assertEqual(expected_error, translated_error)
3078
def test_MemoryError(self):
3079
translated_error = self.translateTuple(('MemoryError',))
3080
self.assertStartsWith(str(translated_error),
3081
"remote server out of memory")
3083
def test_generic_IndexError_no_classname(self):
3084
err = errors.ErrorFromSmartServer(('error', "list index out of range"))
3085
translated_error = self.translateErrorFromSmartServer(err)
3086
expected_error = errors.UnknownErrorFromSmartServer(err)
3087
self.assertEqual(expected_error, translated_error)
3089
# GZ 2011-03-02: TODO test generic non-ascii error string
3091
def test_generic_KeyError(self):
3092
err = errors.ErrorFromSmartServer(('error', 'KeyError', "1"))
3093
translated_error = self.translateErrorFromSmartServer(err)
3094
expected_error = errors.UnknownErrorFromSmartServer(err)
3095
self.assertEqual(expected_error, translated_error)
2899
3098
class TestErrorTranslationRobustness(TestErrorTranslationBase):
2900
3099
"""Unit tests for bzrlib.remote._translate_error's robustness.
3045
3244
_, stacked = branch_factory()
3046
3245
source = stacked.repository._get_source(target_repository_format)
3047
3246
tip = stacked.last_revision()
3048
revs = stacked.repository.get_ancestry(tip)
3049
search = graph.PendingAncestryResult([tip], stacked.repository)
3247
stacked.repository._ensure_real()
3248
graph = stacked.repository.get_graph()
3249
revs = [r for (r,ps) in graph.iter_ancestry([tip])
3250
if r != NULL_REVISION]
3252
search = _mod_graph.PendingAncestryResult([tip], stacked.repository)
3050
3253
self.reset_smart_call_log()
3051
3254
stream = source.get_stream(search)
3054
3255
# We trust that if a revision is in the stream the rest of the new
3055
3256
# content for it is too, as per our main fetch tests; here we are
3056
3257
# checking that the revisions are actually included at all, and their
3143
3344
def test_copy_content_into_avoids_revision_history(self):
3144
3345
local = self.make_branch('local')
3145
remote_backing_tree = self.make_branch_and_tree('remote')
3146
remote_backing_tree.commit("Commit.")
3346
builder = self.make_branch_builder('remote')
3347
builder.build_commit(message="Commit.")
3147
3348
remote_branch_url = self.smart_server.get_url() + 'remote'
3148
3349
remote_branch = bzrdir.BzrDir.open(remote_branch_url).open_branch()
3149
3350
local.repository.fetch(remote_branch.repository)
3150
3351
self.hpss_calls = []
3151
3352
remote_branch.copy_content_into(local)
3152
3353
self.assertFalse('Branch.revision_history' in self.hpss_calls)
3355
def test_fetch_everything_needs_just_one_call(self):
3356
local = self.make_branch('local')
3357
builder = self.make_branch_builder('remote')
3358
builder.build_commit(message="Commit.")
3359
remote_branch_url = self.smart_server.get_url() + 'remote'
3360
remote_branch = bzrdir.BzrDir.open(remote_branch_url).open_branch()
3361
self.hpss_calls = []
3362
local.repository.fetch(remote_branch.repository,
3363
fetch_spec=_mod_graph.EverythingResult(remote_branch.repository))
3364
self.assertEqual(['Repository.get_stream_1.19'], self.hpss_calls)
3366
def override_verb(self, verb_name, verb):
3367
request_handlers = request.request_handlers
3368
orig_verb = request_handlers.get(verb_name)
3369
request_handlers.register(verb_name, verb, override_existing=True)
3370
self.addCleanup(request_handlers.register, verb_name, orig_verb,
3371
override_existing=True)
3373
def test_fetch_everything_backwards_compat(self):
3374
"""Can fetch with EverythingResult even with pre 2.4 servers.
3376
Pre-2.4 do not support 'everything' searches with the
3377
Repository.get_stream_1.19 verb.
3380
class OldGetStreamVerb(SmartServerRepositoryGetStream_1_19):
3381
"""A version of the Repository.get_stream_1.19 verb patched to
3382
reject 'everything' searches the way 2.3 and earlier do.
3384
def recreate_search(self, repository, search_bytes, discard_excess=False):
3385
verb_log.append(search_bytes.split('\n', 1)[0])
3386
if search_bytes == 'everything':
3387
return (None, request.FailedSmartServerResponse(('BadSearch',)))
3388
return super(OldGetStreamVerb,
3389
self).recreate_search(repository, search_bytes,
3390
discard_excess=discard_excess)
3391
self.override_verb('Repository.get_stream_1.19', OldGetStreamVerb)
3392
local = self.make_branch('local')
3393
builder = self.make_branch_builder('remote')
3394
builder.build_commit(message="Commit.")
3395
remote_branch_url = self.smart_server.get_url() + 'remote'
3396
remote_branch = bzrdir.BzrDir.open(remote_branch_url).open_branch()
3397
self.hpss_calls = []
3398
local.repository.fetch(remote_branch.repository,
3399
fetch_spec=_mod_graph.EverythingResult(remote_branch.repository))
3400
# make sure the overridden verb was used
3401
self.assertLength(1, verb_log)
3402
# more than one HPSS call is needed, but because it's a VFS callback
3403
# its hard to predict exactly how many.
3404
self.assertTrue(len(self.hpss_calls) > 1)