1
# Copyright (C) 2006-2012, 2016 Canonical Ltd
2
# Authors: Aaron Bentley
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27
from ...controldir import ControlDir
28
from ...bzr.bundle import serializer
29
from ...transport import memory
33
from ..matchers import ContainsNoVfsCalls
36
load_tests = scenarios.load_tests_apply_scenarios
39
class TestSendMixin(object):
41
_default_command = ['send', '-o-']
42
_default_wd = 'branch'
44
def run_send(self, args, cmd=None, rc=0, wd=None, err_re=None):
46
cmd = self._default_command
51
return self.run_bzr(cmd + args, retcode=rc,
55
def get_MD(self, args, cmd=None, wd='branch'):
56
md = self.run_send(args, cmd=cmd, wd=wd)[0]
57
out = BytesIO(md.encode('utf-8'))
58
return merge_directive.MergeDirective.from_lines(out)
60
def assertBundleContains(self, revs, args, cmd=None, wd='branch'):
61
md = self.get_MD(args, cmd=cmd, wd=wd)
62
br = serializer.read_bundle(BytesIO(md.get_raw_bundle()))
63
self.assertEqual(set(revs), set(r.revision_id for r in br.revisions))
66
class TestSend(tests.TestCaseWithTransport, TestSendMixin):
69
super(TestSend, self).setUp()
70
grandparent_tree = ControlDir.create_standalone_workingtree(
72
self.build_tree_contents([('grandparent/file1', b'grandparent')])
73
grandparent_tree.add('file1')
74
grandparent_tree.commit('initial commit', rev_id=b'rev1')
76
parent_bzrdir = grandparent_tree.controldir.sprout('parent')
77
parent_tree = parent_bzrdir.open_workingtree()
78
parent_tree.commit('next commit', rev_id=b'rev2')
80
branch_tree = parent_tree.controldir.sprout(
81
'branch').open_workingtree()
82
self.build_tree_contents([('branch/file1', b'branch')])
83
branch_tree.commit('last commit', rev_id=b'rev3')
85
def assertFormatIs(self, fmt_string, md):
86
self.assertEqual(fmt_string, md.get_raw_bundle().splitlines()[0])
88
def test_uses_parent(self):
89
"""Parent location is used as a basis by default"""
90
errmsg = self.run_send([], rc=3, wd='grandparent')[1]
91
self.assertContainsRe(errmsg, 'No submit branch known or specified')
92
stdout, stderr = self.run_send([])
93
self.assertEqual(stderr.count('Using saved parent location'), 1)
94
self.assertBundleContains([b'rev3'], [])
96
def test_bundle(self):
97
"""Bundle works like send, except -o is not required"""
98
errmsg = self.run_send([], cmd=['bundle'], rc=3, wd='grandparent')[1]
99
self.assertContainsRe(errmsg, 'No submit branch known or specified')
100
stdout, stderr = self.run_send([], cmd=['bundle'])
101
self.assertEqual(stderr.count('Using saved parent location'), 1)
102
self.assertBundleContains([b'rev3'], [], cmd=['bundle'])
104
def test_uses_submit(self):
105
"""Submit location can be used and set"""
106
self.assertBundleContains([b'rev3'], [])
107
self.assertBundleContains([b'rev3', b'rev2'], ['../grandparent'])
108
# submit location should be auto-remembered
109
self.assertBundleContains([b'rev3', b'rev2'], [])
111
self.run_send(['../parent'])
112
# We still point to ../grandparent
113
self.assertBundleContains([b'rev3', b'rev2'], [])
114
# Remember parent now
115
self.run_send(['../parent', '--remember'])
116
# Now we point to parent
117
self.assertBundleContains([b'rev3'], [])
119
err = self.run_send(['--remember'], rc=3)[1]
120
self.assertContainsRe(err,
121
'--remember requires a branch to be specified.')
123
def test_revision_branch_interaction(self):
124
self.assertBundleContains([b'rev3', b'rev2'], ['../grandparent'])
125
self.assertBundleContains([b'rev2'], ['../grandparent', '-r-2'])
126
self.assertBundleContains([b'rev3', b'rev2'],
127
['../grandparent', '-r-2..-1'])
128
md = self.get_MD(['-r-2..-1'])
129
self.assertEqual(b'rev2', md.base_revision_id)
130
self.assertEqual(b'rev3', md.revision_id)
132
def test_output(self):
133
# check output for consistency
134
# win32 stdout converts LF to CRLF,
135
# which would break patch-based bundles
136
self.assertBundleContains([b'rev3'], [])
138
def test_no_common_ancestor(self):
139
foo = self.make_branch_and_tree('foo')
141
bar = self.make_branch_and_tree('bar')
143
self.run_send(['--from', 'foo', '../bar'], wd='foo')
145
def test_content_options(self):
146
"""--no-patch and --no-bundle should work and be independant"""
148
self.assertIsNot(None, md.bundle)
149
self.assertIsNot(None, md.patch)
151
md = self.get_MD(['--format=0.9'])
152
self.assertIsNot(None, md.bundle)
153
self.assertIsNot(None, md.patch)
155
md = self.get_MD(['--no-patch'])
156
self.assertIsNot(None, md.bundle)
157
self.assertIs(None, md.patch)
158
self.run_bzr_error(['Format 0.9 does not permit bundle with no patch'],
159
['send', '--no-patch', '--format=0.9', '-o-'],
160
working_dir='branch')
161
md = self.get_MD(['--no-bundle', '.', '.'])
162
self.assertIs(None, md.bundle)
163
self.assertIsNot(None, md.patch)
165
md = self.get_MD(['--no-bundle', '--format=0.9', '../parent',
167
self.assertIs(None, md.bundle)
168
self.assertIsNot(None, md.patch)
170
md = self.get_MD(['--no-bundle', '--no-patch', '.', '.'])
171
self.assertIs(None, md.bundle)
172
self.assertIs(None, md.patch)
174
md = self.get_MD(['--no-bundle', '--no-patch', '--format=0.9',
176
self.assertIs(None, md.bundle)
177
self.assertIs(None, md.patch)
179
def test_from_option(self):
180
self.run_bzr('send', retcode=3)
181
md = self.get_MD(['--from', 'branch'])
182
self.assertEqual(b'rev3', md.revision_id)
183
md = self.get_MD(['-f', 'branch'])
184
self.assertEqual(b'rev3', md.revision_id)
186
def test_output_option(self):
187
stdout = self.run_bzr('send -f branch --output file1')[0]
188
self.assertEqual('', stdout)
189
md_file = open('file1', 'rb')
190
self.addCleanup(md_file.close)
191
self.assertContainsRe(md_file.read(), b'rev3')
192
stdout = self.run_bzr('send -f branch --output -')[0]
193
self.assertContainsRe(stdout, 'rev3')
195
def test_note_revisions(self):
196
stderr = self.run_send([])[1]
197
self.assertEndsWith(stderr, '\nBundling 1 revision.\n')
199
def test_mailto_option(self):
200
b = branch.Branch.open('branch')
201
b.get_config_stack().set('mail_client', 'editor')
203
('No mail-to address \\(--mail-to\\) or output \\(-o\\) specified',
205
b.get_config_stack().set('mail_client', 'bogus')
207
self.run_bzr_error(('Bad value "bogus" for option "mail_client"',),
208
'send -f branch --mail-to jrandom@example.org')
209
b.get_config_stack().set('submit_to', 'jrandom@example.org')
210
self.run_bzr_error(('Bad value "bogus" for option "mail_client"',),
213
def test_mailto_child_option(self):
214
"""Make sure that child_submit_to is used."""
215
b = branch.Branch.open('branch')
216
b.get_config_stack().set('mail_client', 'bogus')
217
parent = branch.Branch.open('parent')
218
parent.get_config_stack().set('child_submit_to', 'somebody@example.org')
219
self.run_bzr_error(('Bad value "bogus" for option "mail_client"',),
222
def test_format(self):
223
md = self.get_MD(['--format=4'])
224
self.assertIs(merge_directive.MergeDirective2, md.__class__)
225
self.assertFormatIs(b'# Bazaar revision bundle v4', md)
227
md = self.get_MD(['--format=0.9'])
228
self.assertFormatIs(b'# Bazaar revision bundle v0.9', md)
230
md = self.get_MD(['--format=0.9'], cmd=['bundle'])
231
self.assertFormatIs(b'# Bazaar revision bundle v0.9', md)
232
self.assertIs(merge_directive.MergeDirective, md.__class__)
234
self.run_bzr_error(['Bad value .* for option .format.'],
235
'send -f branch -o- --format=0.999')[0]
237
def test_format_child_option(self):
238
br = branch.Branch.open('parent')
239
conf = br.get_config_stack()
240
conf.set('child_submit_format', '4')
242
self.assertIs(merge_directive.MergeDirective2, md.__class__)
244
conf.set('child_submit_format', '0.9')
246
self.assertFormatIs(b'# Bazaar revision bundle v0.9', md)
248
md = self.get_MD([], cmd=['bundle'])
249
self.assertFormatIs(b'# Bazaar revision bundle v0.9', md)
250
self.assertIs(merge_directive.MergeDirective, md.__class__)
252
conf.set('child_submit_format', '0.999')
253
self.run_bzr_error(["No such send format '0.999'"],
254
'send -f branch -o-')[0]
256
def test_message_option(self):
257
self.run_bzr('send', retcode=3)
259
self.assertIs(None, md.message)
260
md = self.get_MD(['-m', 'my message'])
261
self.assertEqual('my message', md.message)
263
def test_omitted_revision(self):
264
md = self.get_MD(['-r-2..'])
265
self.assertEqual(b'rev2', md.base_revision_id)
266
self.assertEqual(b'rev3', md.revision_id)
267
md = self.get_MD(['-r..3', '--from', 'branch', 'grandparent'], wd='.')
268
self.assertEqual(b'rev1', md.base_revision_id)
269
self.assertEqual(b'rev3', md.revision_id)
271
def test_nonexistant_branch(self):
272
self.vfs_transport_factory = memory.MemoryServer
273
location = self.get_url('absentdir/')
274
out, err = self.run_bzr(["send", "--from", location], retcode=3)
275
self.assertEqual(out, '')
276
self.assertEqual(err, 'brz: ERROR: Not a branch: "%s".\n' % location)
279
class TestSendStrictMixin(TestSendMixin):
281
def make_parent_and_local_branches(self):
282
# Create a 'parent' branch as the base
283
self.parent_tree = ControlDir.create_standalone_workingtree('parent')
284
self.build_tree_contents([('parent/file', b'parent')])
285
self.parent_tree.add('file')
286
self.parent_tree.commit('first commit', rev_id=b'parent')
287
# Branch 'local' from parent and do a change
288
local_bzrdir = self.parent_tree.controldir.sprout('local')
289
self.local_tree = local_bzrdir.open_workingtree()
290
self.build_tree_contents([('local/file', b'local')])
291
self.local_tree.commit('second commit', rev_id=b'local')
293
_default_command = ['send', '-o-', '../parent']
294
_default_wd = 'local'
295
_default_sent_revs = [b'local']
296
_default_errors = ['Working tree ".*/local/" has uncommitted '
297
'changes \\(See brz status\\)\\.', ]
298
_default_additional_error = 'Use --no-strict to force the send.\n'
299
_default_additional_warning = 'Uncommitted changes will not be sent.'
301
def set_config_send_strict(self, value):
302
br = branch.Branch.open('local')
303
br.get_config_stack().set('send_strict', value)
305
def assertSendFails(self, args):
306
out, err = self.run_send(args, rc=3, err_re=self._default_errors)
307
self.assertContainsRe(err, self._default_additional_error)
309
def assertSendSucceeds(self, args, revs=None, with_warning=False):
311
err_re = self._default_errors
315
revs = self._default_sent_revs
316
out, err = self.run_send(args, err_re=err_re)
318
bundling_revs = 'Bundling %d revision.\n' % len(revs)
320
bundling_revs = 'Bundling %d revisions.\n' % len(revs)
322
self.assertContainsRe(err, self._default_additional_warning)
323
self.assertEndsWith(err, bundling_revs)
325
self.assertEqual(bundling_revs, err)
326
md = merge_directive.MergeDirective.from_lines(
327
BytesIO(out.encode('utf-8')))
328
self.assertEqual(b'parent', md.base_revision_id)
329
br = serializer.read_bundle(BytesIO(md.get_raw_bundle()))
330
self.assertEqual(set(revs), set(r.revision_id for r in br.revisions))
333
class TestSendStrictWithoutChanges(tests.TestCaseWithTransport,
334
TestSendStrictMixin):
337
super(TestSendStrictWithoutChanges, self).setUp()
338
self.make_parent_and_local_branches()
340
def test_send_without_workingtree(self):
341
ControlDir.open("local").destroy_workingtree()
342
self.assertSendSucceeds([])
344
def test_send_default(self):
345
self.assertSendSucceeds([])
347
def test_send_strict(self):
348
self.assertSendSucceeds(['--strict'])
350
def test_send_no_strict(self):
351
self.assertSendSucceeds(['--no-strict'])
353
def test_send_config_var_strict(self):
354
self.set_config_send_strict('true')
355
self.assertSendSucceeds([])
357
def test_send_config_var_no_strict(self):
358
self.set_config_send_strict('false')
359
self.assertSendSucceeds([])
362
class TestSendStrictWithChanges(tests.TestCaseWithTransport,
363
TestSendStrictMixin):
365
# These are textually the same as test_push.strict_push_change_scenarios,
366
# but since the functions are reimplemented here, the definitions are left
370
dict(_changes_type='_uncommitted_changes')),
372
dict(_changes_type='_pending_merges')),
373
('out-of-sync-trees',
374
dict(_changes_type='_out_of_sync_trees')),
377
_changes_type = None # Set by load_tests
380
super(TestSendStrictWithChanges, self).setUp()
381
# load tests set _changes_types to the name of the method we want to
383
do_changes_func = getattr(self, self._changes_type)
386
def _uncommitted_changes(self):
387
self.make_parent_and_local_branches()
388
# Make a change without committing it
389
self.build_tree_contents([('local/file', b'modified')])
391
def _pending_merges(self):
392
self.make_parent_and_local_branches()
393
# Create 'other' branch containing a new file
394
other_bzrdir = self.parent_tree.controldir.sprout('other')
395
other_tree = other_bzrdir.open_workingtree()
396
self.build_tree_contents([('other/other-file', b'other')])
397
other_tree.add('other-file')
398
other_tree.commit('other commit', rev_id=b'other')
399
# Merge and revert, leaving a pending merge
400
self.local_tree.merge_from_branch(other_tree.branch)
401
self.local_tree.revert(filenames=['other-file'], backups=False)
403
def _out_of_sync_trees(self):
404
self.make_parent_and_local_branches()
405
self.run_bzr(['checkout', '--lightweight', 'local', 'checkout'])
406
# Make a change and commit it
407
self.build_tree_contents([('local/file', b'modified in local')])
408
self.local_tree.commit('modify file', rev_id=b'modified-in-local')
409
# Exercise commands from the checkout directory
410
self._default_wd = 'checkout'
411
self._default_errors = ["Working tree is out of date, please run"
412
" 'brz update'\\.", ]
413
self._default_sent_revs = [b'modified-in-local', b'local']
415
def test_send_default(self):
416
self.assertSendSucceeds([], with_warning=True)
418
def test_send_with_revision(self):
419
self.assertSendSucceeds(['-r', 'revid:local'], revs=[b'local'])
421
def test_send_no_strict(self):
422
self.assertSendSucceeds(['--no-strict'])
424
def test_send_strict_with_changes(self):
425
self.assertSendFails(['--strict'])
427
def test_send_respect_config_var_strict(self):
428
self.set_config_send_strict('true')
429
self.assertSendFails([])
430
self.assertSendSucceeds(['--no-strict'])
432
def test_send_bogus_config_var_ignored(self):
433
self.set_config_send_strict("I'm unsure")
434
self.assertSendSucceeds([], with_warning=True)
436
def test_send_no_strict_command_line_override_config(self):
437
self.set_config_send_strict('true')
438
self.assertSendFails([])
439
self.assertSendSucceeds(['--no-strict'])
441
def test_send_strict_command_line_override_config(self):
442
self.set_config_send_strict('false')
443
self.assertSendSucceeds([])
444
self.assertSendFails(['--strict'])
447
class TestBundleStrictWithoutChanges(TestSendStrictWithoutChanges):
449
_default_command = ['bundle-revisions', '../parent']
452
class TestSmartServerSend(tests.TestCaseWithTransport):
455
self.setup_smart_server_with_call_log()
456
t = self.make_branch_and_tree('branch')
457
self.build_tree_contents([('branch/foo', b'thecontents')])
460
local = t.controldir.sprout('local-branch').open_workingtree()
461
self.build_tree_contents([('branch/foo', b'thenewcontents')])
462
local.commit("anothermessage")
463
self.reset_smart_call_log()
464
out, err = self.run_bzr(
465
['send', '-o', 'x.diff', self.get_url('branch')], working_dir='local-branch')
466
# This figure represent the amount of work to perform this use case. It
467
# is entirely ok to reduce this number if a test fails due to rpc_count
468
# being too low. If rpc_count increases, more network roundtrips have
469
# become necessary for this use case. Please do not adjust this number
470
# upwards without agreement from bzr's network support maintainers.
471
self.assertLength(7, self.hpss_calls)
472
self.assertLength(1, self.hpss_connections)
473
self.assertThat(self.hpss_calls, ContainsNoVfsCalls)