1
# Copyright (C) 2007 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
26
OUTPUT1 = """# Bazaar merge directive format 1
27
# revision_id: example:
28
# target_branch: http://example.com
30
# timestamp: 1970-01-01 00:09:33 +0002
34
OUTPUT1_2 = """# Bazaar merge directive format 2 (Bazaar 0.19)
35
# revision_id: example:
36
# target_branch: http://example.com
38
# timestamp: 1970-01-01 00:09:33 +0002
39
# base_revision_id: null:
44
OUTPUT2 = """# Bazaar merge directive format 1
45
# revision_id: example:
46
# target_branch: http://example.com
48
# timestamp: 1970-01-01 00:09:33 +0002
49
# source_branch: http://example.org
54
OUTPUT2_2 = """# Bazaar merge directive format 2 (Bazaar 0.19)
55
# revision_id: example:
56
# target_branch: http://example.com
58
# timestamp: 1970-01-01 00:09:33 +0002
59
# source_branch: http://example.org
61
# base_revision_id: null:
67
I was thinking today about creating a merge directive.
73
(I've pasted it in the body of this message)
77
# Bazaar merge directive format 1\r
78
# revision_id: example:
79
# target_branch: http://example.com
81
# timestamp: 1970-01-01 00:09:33 +0002
82
# source_branch: http://example.org
85
booga""".splitlines(True)
89
I was thinking today about creating a merge directive.
95
(I've pasted it in the body of this message)
99
# Bazaar merge directive format 2 (Bazaar 0.19)\r
100
# revision_id: example:
101
# target_branch: http://example.com
102
# testament_sha1: sha
103
# timestamp: 1970-01-01 00:09:33 +0002
104
# source_branch: http://example.org
105
# base_revision_id: null:
109
booga""".splitlines(True)
112
class TestMergeDirective(object):
114
def test_merge_source(self):
117
self.assertRaises(errors.NoMergeSource, self.make_merge_directive,
118
'example:', 'sha', time, timezone, 'http://example.com')
119
self.assertRaises(errors.NoMergeSource, self.make_merge_directive,
120
'example:', 'sha', time, timezone, 'http://example.com',
122
self.make_merge_directive('example:', 'sha', time, timezone,
123
'http://example.com', source_branch='http://example.org')
124
md = self.make_merge_directive('null:', 'sha', time, timezone,
125
'http://example.com', patch='blah', patch_type='bundle')
126
self.assertIs(None, md.source_branch)
127
md2 = self.make_merge_directive('null:', 'sha', time, timezone,
128
'http://example.com', patch='blah', patch_type='bundle',
130
self.assertEqual('bar', md2.source_branch)
132
def test_serialization(self):
135
md = self.make_merge_directive('example:', 'sha', time, timezone,
136
'http://example.com', patch='booga', patch_type='bundle')
137
self.assertEqualDiff(self.OUTPUT1, ''.join(md.to_lines()))
138
md = self.make_merge_directive('example:', 'sha', time, timezone,
139
'http://example.com', source_branch="http://example.org",
140
patch='booga', patch_type='diff', message="Hi mom!")
141
self.assertEqualDiff(self.OUTPUT2, ''.join(md.to_lines()))
143
def test_deserialize_junk(self):
145
self.assertRaises(errors.NotAMergeDirective,
146
merge_directive.MergeDirective.from_lines, 'lala')
148
def test_deserialize_empty(self):
149
self.assertRaises(errors.NotAMergeDirective,
150
merge_directive.MergeDirective.from_lines, [])
152
def test_deserialize_leading_junk(self):
153
md = merge_directive.MergeDirective.from_lines(self.INPUT1)
154
self.assertEqual('example:', md.revision_id)
155
self.assertEqual('sha', md.testament_sha1)
156
self.assertEqual('http://example.com', md.target_branch)
157
self.assertEqual('http://example.org', md.source_branch)
158
self.assertEqual(453, md.time)
159
self.assertEqual(120, md.timezone)
160
self.assertEqual('booga', md.patch)
161
self.assertEqual('diff', md.patch_type)
162
self.assertEqual('Hi mom!', md.message)
164
def test_roundtrip(self):
166
timezone = 7.5 * 3600
167
md = self.make_merge_directive('example:', 'sha', time, timezone,
168
'http://example.com', source_branch="http://example.org",
169
patch='booga', patch_type='diff')
170
md2 = merge_directive.MergeDirective.from_lines(md.to_lines())
171
self.assertEqual('example:', md2.revision_id)
172
self.assertIsInstance(md2.revision_id, str)
173
self.assertEqual('sha', md2.testament_sha1)
174
self.assertEqual('http://example.com', md2.target_branch)
175
self.assertEqual('http://example.org', md2.source_branch)
176
self.assertEqual(time, md2.time)
177
self.assertEqual(timezone, md2.timezone)
178
self.assertEqual('diff', md2.patch_type)
179
self.assertEqual('booga', md2.patch)
180
self.assertEqual(None, md2.message)
181
self.set_bundle(md, "# Bazaar revision bundle v0.9\n#\n")
182
md.message = "Hi mom!"
183
lines = md.to_lines()
184
md3 = merge_directive.MergeDirective.from_lines(lines)
185
self.assertEqual("# Bazaar revision bundle v0.9\n#\n", md3.bundle)
186
self.assertEqual("bundle", md3.patch_type)
187
self.assertContainsRe(md3.to_lines()[0],
188
'^# Bazaar merge directive format ')
189
self.assertEqual("Hi mom!", md3.message)
191
self.assertIs(None, md3.get_raw_bundle())
192
md4 = merge_directive.MergeDirective.from_lines(md3.to_lines())
193
self.assertIs(None, md4.patch_type)
196
class TestMergeDirective1(tests.TestCase, TestMergeDirective):
197
"""Test merge directive format 1"""
205
def make_merge_directive(self, revision_id, testament_sha1, time, timezone,
206
target_branch, patch=None, patch_type=None,
207
source_branch=None, message=None):
208
return merge_directive.MergeDirective(revision_id, testament_sha1,
209
time, timezone, target_branch, patch, patch_type,
210
source_branch, message)
213
def set_bundle(md, value):
216
def test_require_patch(self):
219
self.assertRaises(errors.PatchMissing, merge_directive.MergeDirective,
220
'example:', 'sha', time, timezone, 'http://example.com',
222
md = merge_directive.MergeDirective('example:', 'sha1', time, timezone,
223
'http://example.com', source_branch="http://example.org",
224
patch='', patch_type='diff')
225
self.assertEqual(md.patch, '')
228
class TestMergeDirective2(tests.TestCase, TestMergeDirective):
229
"""Test merge directive format 2"""
237
def make_merge_directive(self, revision_id, testament_sha1, time, timezone,
238
target_branch, patch=None, patch_type=None,
239
source_branch=None, message=None, base_revision_id='null:'):
240
if patch_type == 'bundle':
245
return merge_directive.MergeDirective2(revision_id, testament_sha1,
246
time, timezone, target_branch, patch, source_branch, message,
247
bundle, base_revision_id)
250
def set_bundle(md, value):
254
EMAIL1 = """To: pqm@example.com
255
From: J. Random Hacker <jrandom@example.com>
256
Subject: Commit of rev2a
258
# Bazaar merge directive format 1
260
# target_branch: (.|\n)*
262
# timestamp: 1970-01-01 00:08:56 \\+0001
263
# source_branch: (.|\n)*
267
EMAIL1_2 = """To: pqm@example.com
268
From: J. Random Hacker <jrandom@example.com>
269
Subject: Commit of rev2a
271
# Bazaar merge directive format 2 \\(Bazaar 0.19\\)
273
# target_branch: (.|\n)*
275
# timestamp: 1970-01-01 00:08:56 \\+0001
276
# source_branch: (.|\n)*
280
EMAIL2 = """To: pqm@example.com
281
From: J. Random Hacker <jrandom@example.com>
282
Subject: Commit of rev2a with special message
284
# Bazaar merge directive format 1
286
# target_branch: (.|\n)*
288
# timestamp: 1970-01-01 00:08:56 \\+0001
289
# source_branch: (.|\n)*
290
# message: Commit of rev2a with special message
293
EMAIL2_2 = """To: pqm@example.com
294
From: J. Random Hacker <jrandom@example.com>
295
Subject: Commit of rev2a with special message
297
# Bazaar merge directive format 2 \\(Bazaar 0.19\\)
299
# target_branch: (.|\n)*
301
# timestamp: 1970-01-01 00:08:56 \\+0001
302
# source_branch: (.|\n)*
303
# message: Commit of rev2a with special message
306
class TestMergeDirectiveBranch(object):
308
def make_trees(self):
309
tree_a = self.make_branch_and_tree('tree_a')
310
tree_a.branch.get_config().set_user_option('email',
311
'J. Random Hacker <jrandom@example.com>')
312
self.build_tree_contents([('tree_a/file', 'content_a\ncontent_b\n')])
314
tree_a.commit('message', rev_id='rev1')
315
tree_b = tree_a.bzrdir.sprout('tree_b').open_workingtree()
316
branch_c = tree_a.bzrdir.sprout('branch_c').open_branch()
317
tree_b.commit('message', rev_id='rev2b')
318
self.build_tree_contents([('tree_a/file', 'content_a\ncontent_c \n')])
319
tree_a.commit('Commit of rev2a', rev_id='rev2a')
320
return tree_a, tree_b, branch_c
322
def test_empty_target(self):
323
tree_a, tree_b, branch_c = self.make_trees()
324
tree_d = self.make_branch_and_tree('tree_d')
325
md2 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 120,
326
tree_d.branch.base, patch_type='diff',
327
public_branch=tree_a.branch.base)
329
def test_generate_patch(self):
330
tree_a, tree_b, branch_c = self.make_trees()
331
md2 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 120,
332
tree_b.branch.base, patch_type='diff',
333
public_branch=tree_a.branch.base)
334
self.assertNotContainsRe(md2.patch, 'Bazaar revision bundle')
335
self.assertContainsRe(md2.patch, '\\+content_c')
336
self.assertNotContainsRe(md2.patch, '\\+\\+\\+ b/')
337
self.assertContainsRe(md2.patch, '\\+\\+\\+ file')
339
def test_public_branch(self):
340
tree_a, tree_b, branch_c = self.make_trees()
341
self.assertRaises(errors.PublicBranchOutOfDate,
342
self.from_objects, tree_a.branch.repository, 'rev2a', 500, 144,
343
tree_b.branch.base, public_branch=branch_c.base, patch_type='diff')
344
self.assertRaises(errors.PublicBranchOutOfDate,
345
self.from_objects, tree_a.branch.repository, 'rev2a', 500, 144,
346
tree_b.branch.base, public_branch=branch_c.base, patch_type=None)
347
# public branch is not checked if patch format is bundle.
348
md1 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 144,
349
tree_b.branch.base, public_branch=branch_c.base)
350
# public branch is provided with a bundle, despite possibly being out
351
# of date, because it's not required if a bundle is present.
352
self.assertEqual(md1.source_branch, branch_c.base)
353
# Once we update the public branch, we can generate a diff.
354
branch_c.pull(tree_a.branch)
355
md3 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 144,
356
tree_b.branch.base, patch_type=None, public_branch=branch_c.base)
358
def test_use_public_submit_branch(self):
359
tree_a, tree_b, branch_c = self.make_trees()
360
branch_c.pull(tree_a.branch)
361
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 144,
362
tree_b.branch.base, patch_type=None, public_branch=branch_c.base)
363
self.assertEqual(md.target_branch, tree_b.branch.base)
364
tree_b.branch.set_public_branch('http://example.com')
365
md2 = self.from_objects(
366
tree_a.branch.repository, 'rev2a', 500, 144, tree_b.branch.base,
367
patch_type=None, public_branch=branch_c.base)
368
self.assertEqual(md2.target_branch, 'http://example.com')
370
def test_message(self):
371
tree_a, tree_b, branch_c = self.make_trees()
372
md3 = self.from_objects(tree_a.branch.repository, 'rev1', 500, 120,
373
tree_b.branch.base, patch_type=None, public_branch=branch_c.base,
374
message='Merge message')
376
self.assertIs(None, md3.patch)
377
self.assertEqual('Merge message', md3.message)
379
def test_generate_bundle(self):
380
tree_a, tree_b, branch_c = self.make_trees()
381
md1 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 120,
382
tree_b.branch.base, public_branch=branch_c.base)
384
self.assertContainsRe(md1.get_raw_bundle(), 'Bazaar revision bundle')
385
self.assertContainsRe(md1.patch, '\\+content_c')
386
self.assertNotContainsRe(md1.patch, '\\+content_a')
387
self.assertContainsRe(md1.patch, '\\+content_c')
388
self.assertNotContainsRe(md1.patch, '\\+content_a')
390
def test_broken_bundle(self):
391
tree_a, tree_b, branch_c = self.make_trees()
392
md1 = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 120,
393
tree_b.branch.base, public_branch=branch_c.base)
394
lines = md1.to_lines()
395
lines = [l.replace('\n', '\r\n') for l in lines]
396
md2 = merge_directive.MergeDirective.from_lines(lines)
397
self.assertEqual('rev2a', md2.revision_id)
399
def test_signing(self):
402
class FakeBranch(object):
403
def get_config(self):
405
def gpg_signing_command(self):
407
md = self.make_merge_directive('example:', 'sha', time, timezone,
408
'http://example.com', source_branch="http://example.org",
409
patch='booga', patch_type='diff')
410
old_strategy = gpg.GPGStrategy
411
gpg.GPGStrategy = gpg.LoopbackGPGStrategy
413
signed = md.to_signed(FakeBranch())
415
gpg.GPGStrategy = old_strategy
416
self.assertContainsRe(signed, '^-----BEGIN PSEUDO-SIGNED CONTENT')
417
self.assertContainsRe(signed, 'example.org')
418
self.assertContainsRe(signed, 'booga')
420
def test_email(self):
421
tree_a, tree_b, branch_c = self.make_trees()
422
md = self.from_objects(tree_a.branch.repository, 'rev2a', 476, 60,
423
tree_b.branch.base, patch_type=None,
424
public_branch=tree_a.branch.base)
425
message = md.to_email('pqm@example.com', tree_a.branch)
426
self.assertContainsRe(message.as_string(), self.EMAIL1)
427
md.message = 'Commit of rev2a with special message'
428
message = md.to_email('pqm@example.com', tree_a.branch)
429
self.assertContainsRe(message.as_string(), self.EMAIL2)
431
def test_install_revisions_branch(self):
432
tree_a, tree_b, branch_c = self.make_trees()
433
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 36,
434
tree_b.branch.base, patch_type=None,
435
public_branch=tree_a.branch.base)
436
self.assertFalse(tree_b.branch.repository.has_revision('rev2a'))
437
revision = md.install_revisions(tree_b.branch.repository)
438
self.assertEqual('rev2a', revision)
439
self.assertTrue(tree_b.branch.repository.has_revision('rev2a'))
441
def test_get_merge_request(self):
442
tree_a, tree_b, branch_c = self.make_trees()
443
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 36,
444
tree_b.branch.base, patch_type='bundle',
445
public_branch=tree_a.branch.base)
446
self.assertFalse(tree_b.branch.repository.has_revision('rev2a'))
447
md.install_revisions(tree_b.branch.repository)
448
base, revision, verified = md.get_merge_request(
449
tree_b.branch.repository)
450
if isinstance(md, merge_directive.MergeDirective):
451
self.assertIs(None, base)
452
self.assertEqual('inapplicable', verified)
454
self.assertEqual('rev1', base)
455
self.assertEqual('verified', verified)
456
self.assertEqual('rev2a', revision)
457
self.assertTrue(tree_b.branch.repository.has_revision('rev2a'))
458
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 36,
459
tree_b.branch.base, patch_type=None,
460
public_branch=tree_a.branch.base)
461
base, revision, verified = md.get_merge_request(
462
tree_b.branch.repository)
463
if isinstance(md, merge_directive.MergeDirective):
464
self.assertIs(None, base)
465
self.assertEqual('inapplicable', verified)
467
self.assertEqual('rev1', base)
468
self.assertEqual('inapplicable', verified)
469
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 36,
470
tree_b.branch.base, patch_type='diff',
471
public_branch=tree_a.branch.base)
472
base, revision, verified = md.get_merge_request(
473
tree_b.branch.repository)
474
if isinstance(md, merge_directive.MergeDirective):
475
self.assertIs(None, base)
476
self.assertEqual('inapplicable', verified)
478
self.assertEqual('rev1', base)
479
self.assertEqual('verified', verified)
481
base, revision, verified = md.get_merge_request(
482
tree_b.branch.repository)
483
if isinstance(md, merge_directive.MergeDirective):
484
self.assertIs(None, base)
485
self.assertEqual('inapplicable', verified)
487
self.assertEqual('rev1', base)
488
self.assertEqual('failed', verified)
490
def test_install_revisions_bundle(self):
491
tree_a, tree_b, branch_c = self.make_trees()
492
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 36,
493
tree_b.branch.base, patch_type='bundle',
494
public_branch=tree_a.branch.base)
495
self.assertFalse(tree_b.branch.repository.has_revision('rev2a'))
496
revision = md.install_revisions(tree_b.branch.repository)
497
self.assertEqual('rev2a', revision)
498
self.assertTrue(tree_b.branch.repository.has_revision('rev2a'))
500
def test_get_target_revision_nofetch(self):
501
tree_a, tree_b, branch_c = self.make_trees()
502
tree_b.branch.fetch(tree_a.branch)
503
md = self.from_objects( tree_a.branch.repository, 'rev2a', 500, 36,
504
tree_b.branch.base, patch_type=None,
505
public_branch=tree_a.branch.base)
506
md.source_branch = '/dev/null'
507
revision = md.install_revisions(tree_b.branch.repository)
508
self.assertEqual('rev2a', revision)
511
class TestMergeDirective1Branch(tests.TestCaseWithTransport,
512
TestMergeDirectiveBranch):
513
"""Test merge directive format 1 with a branch"""
519
def from_objects(self, repository, revision_id, time, timezone,
520
target_branch, patch_type='bundle', local_target_branch=None,
521
public_branch=None, message=None):
522
return merge_directive.MergeDirective.from_objects(
523
repository, revision_id, time, timezone, target_branch,
524
patch_type, local_target_branch, public_branch, message)
526
def make_merge_directive(self, revision_id, testament_sha1, time, timezone,
527
target_branch, patch=None, patch_type=None,
528
source_branch=None, message=None):
529
return merge_directive.MergeDirective(revision_id, testament_sha1,
530
time, timezone, target_branch, patch, patch_type,
531
source_branch, message)
534
class TestMergeDirective2Branch(tests.TestCaseWithTransport,
535
TestMergeDirectiveBranch):
536
"""Test merge directive format 2 with a branch"""
542
def from_objects(self, repository, revision_id, time, timezone,
543
target_branch, patch_type='bundle', local_target_branch=None,
544
public_branch=None, message=None, base_revision_id=None):
545
include_patch = (patch_type in ('bundle', 'diff'))
546
include_bundle = (patch_type == 'bundle')
547
assert patch_type in ('bundle', 'diff', None)
548
return merge_directive.MergeDirective2.from_objects(
549
repository, revision_id, time, timezone, target_branch,
550
include_patch, include_bundle, local_target_branch, public_branch,
551
message, base_revision_id)
553
def make_merge_directive(self, revision_id, testament_sha1, time, timezone,
554
target_branch, patch=None, patch_type=None,
555
source_branch=None, message=None, base_revision_id='null:'):
556
if patch_type == 'bundle':
561
return merge_directive.MergeDirective2(revision_id, testament_sha1,
562
time, timezone, target_branch, patch, source_branch, message,
563
bundle, base_revision_id)
565
def test_base_revision(self):
566
tree_a, tree_b, branch_c = self.make_trees()
567
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 60,
568
tree_b.branch.base, patch_type='bundle',
569
public_branch=tree_a.branch.base, base_revision_id=None)
570
self.assertEqual('rev1', md.base_revision_id)
571
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 60,
572
tree_b.branch.base, patch_type='bundle',
573
public_branch=tree_a.branch.base, base_revision_id='null:')
574
self.assertEqual('null:', md.base_revision_id)
575
lines = md.to_lines()
576
md2 = merge_directive.MergeDirective.from_lines(lines)
577
self.assertEqual(md2.base_revision_id, md.base_revision_id)
579
def test_patch_verification(self):
580
tree_a, tree_b, branch_c = self.make_trees()
581
md = self.from_objects(tree_a.branch.repository, 'rev2a', 500, 60,
582
tree_b.branch.base, patch_type='bundle',
583
public_branch=tree_a.branch.base)
584
lines = md.to_lines()
585
md2 = merge_directive.MergeDirective.from_lines(lines)
586
md2._verify_patch(tree_a.branch.repository)
587
# Stript trailing whitespace
588
md2.patch = md2.patch.replace(' \n', '\n')
589
md2._verify_patch(tree_a.branch.repository)
590
# Convert to Mac line-endings
591
md2.patch = md2.patch.replace('\n', '\r')
592
self.assertTrue(md2._verify_patch(tree_a.branch.repository))
593
# Convert to DOS line-endings
594
md2.patch = md2.patch.replace('\r', '\r\n')
595
self.assertTrue(md2._verify_patch(tree_a.branch.repository))
596
md2.patch = md2.patch.replace('content_c', 'content_d')
597
self.assertFalse(md2._verify_patch(tree_a.branch.repository))