/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 breezy/merge_directive.py

  • Committer: Jelmer Vernooij
  • Date: 2019-12-28 14:10:36 UTC
  • mto: This revision was merged to the branch mainline in revision 7431.
  • Revision ID: jelmer@jelmer.uk-20191228141036-hsqitjor9m5fsri1
Python3 compatibility.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/merge_directive.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
17
18
 
18
 
from StringIO import StringIO
 
19
import base64
19
20
import re
20
21
 
21
 
from bzrlib import (
 
22
from . import lazy_import
 
23
lazy_import.lazy_import(globals(), """
 
24
from breezy import (
22
25
    branch as _mod_branch,
 
26
    cleanup,
23
27
    diff,
 
28
    email_message,
24
29
    errors,
25
30
    gpg,
26
31
    hooks,
27
32
    registry,
28
33
    revision as _mod_revision,
29
34
    rio,
30
 
    testament,
31
35
    timestamp,
32
36
    trace,
33
37
    )
34
 
from bzrlib.bundle import (
 
38
from breezy.bzr import (
 
39
    testament,
 
40
    )
 
41
from breezy.bzr.bundle import (
35
42
    serializer as bundle_serializer,
36
43
    )
37
 
from bzrlib.email_message import EmailMessage
 
44
""")
 
45
from .sixish import (
 
46
    BytesIO,
 
47
    )
38
48
 
39
49
 
40
50
class MergeRequestBodyParams(object):
56
66
    """Hooks for MergeDirective classes."""
57
67
 
58
68
    def __init__(self):
59
 
        hooks.Hooks.__init__(self)
60
 
        self.create_hook(hooks.HookPoint('merge_request_body',
 
69
        hooks.Hooks.__init__(self, "breezy.merge_directive",
 
70
                             "BaseMergeDirective.hooks")
 
71
        self.add_hook(
 
72
            'merge_request_body',
61
73
            "Called with a MergeRequestBodyParams when a body is needed for"
62
74
            " a merge request.  Callbacks must return a body.  If more"
63
75
            " than one callback is registered, the output of one callback is"
64
 
            " provided to the next.", (1, 15, 0), False))
 
76
            " provided to the next.", (1, 15, 0))
65
77
 
66
78
 
67
79
class BaseMergeDirective(object):
68
80
    """A request to perform a merge into a branch.
69
81
 
70
 
    This is the base class that all merge directive implementations 
 
82
    This is the base class that all merge directive implementations
71
83
    should derive from.
72
84
 
73
 
    :cvar multiple_output_files: Whether or not this merge directive 
 
85
    :cvar multiple_output_files: Whether or not this merge directive
74
86
        stores a set of revisions in more than one file
75
87
    """
76
88
 
79
91
    multiple_output_files = False
80
92
 
81
93
    def __init__(self, revision_id, testament_sha1, time, timezone,
82
 
                 target_branch, patch=None, source_branch=None, message=None,
83
 
                 bundle=None):
 
94
                 target_branch, patch=None, source_branch=None,
 
95
                 message=None, bundle=None):
84
96
        """Constructor.
85
97
 
86
98
        :param revision_id: The revision to merge
88
100
            merge.
89
101
        :param time: The current POSIX timestamp time
90
102
        :param timezone: The timezone offset
91
 
        :param target_branch: The branch to apply the merge to
 
103
        :param target_branch: Location of branch to apply the merge to
92
104
        :param patch: The text of a diff or bundle
93
105
        :param source_branch: A public location to merge the revision from
94
106
        :param message: The message to use when committing this merge
137
149
                stanza.add(key, self.__dict__[key])
138
150
        if base_revision:
139
151
            stanza.add('base_revision_id', self.base_revision_id)
140
 
        lines = ['# ' + self._format_string + '\n']
 
152
        lines = [b'# ' + self._format_string + b'\n']
141
153
        lines.extend(rio.to_patch_lines(stanza))
142
 
        lines.append('# \n')
 
154
        lines.append(b'# \n')
143
155
        return lines
144
156
 
145
157
    def write_to_directory(self, path):
151
163
 
152
164
    @classmethod
153
165
    def from_objects(klass, repository, revision_id, time, timezone,
154
 
                 target_branch, patch_type='bundle',
155
 
                 local_target_branch=None, public_branch=None, message=None):
 
166
                     target_branch, patch_type='bundle',
 
167
                     local_target_branch=None, public_branch=None, message=None):
156
168
        """Generate a merge directive from various objects
157
169
 
158
170
        :param repository: The repository containing the revision
162
174
        :param target_branch: The url of the branch to merge into
163
175
        :param patch_type: 'bundle', 'diff' or None, depending on the type of
164
176
            patch desired.
165
 
        :param local_target_branch: a local copy of the target branch
166
 
        :param public_branch: location of a public branch containing the target
167
 
            revision.
 
177
        :param local_target_branch: the submit branch, either itself or a local copy
 
178
        :param public_branch: location of a public branch containing
 
179
            the target revision.
168
180
        :param message: Message to use when committing the merge
169
181
        :return: The merge directive
170
182
 
178
190
        if revision_id == _mod_revision.NULL_REVISION:
179
191
            t_revision_id = None
180
192
        t = testament.StrictTestament3.from_revision(repository, t_revision_id)
181
 
        submit_branch = _mod_branch.Branch.open(target_branch)
 
193
        if local_target_branch is None:
 
194
            submit_branch = _mod_branch.Branch.open(target_branch)
 
195
        else:
 
196
            submit_branch = local_target_branch
182
197
        if submit_branch.get_public_branch() is not None:
183
198
            target_branch = submit_branch.get_public_branch()
184
199
        if patch_type is None:
192
207
                                                submit_revision_id)
193
208
            type_handler = {'bundle': klass._generate_bundle,
194
209
                            'diff': klass._generate_diff,
195
 
                            None: lambda x, y, z: None }
 
210
                            None: lambda x, y, z: None}
196
211
            patch = type_handler[patch_type](repository, revision_id,
197
212
                                             ancestor_id)
198
213
 
203
218
                                                   revision_id)
204
219
 
205
220
        return klass(revision_id, t.as_sha1(), time, timezone, target_branch,
206
 
            patch, patch_type, public_branch, message)
 
221
                     patch, patch_type, public_branch, message)
207
222
 
208
223
    def get_disk_name(self, branch):
209
224
        """Generate a suitable basename for storing this directive on disk
215
230
        if self.revision_id == revision_id:
216
231
            revno = [revno]
217
232
        else:
218
 
            revno = branch.get_revision_id_to_revno_map().get(self.revision_id,
219
 
                ['merge'])
220
 
        nick = re.sub('(\W+)', '-', branch.nick).strip('-')
 
233
            try:
 
234
                revno = branch.revision_id_to_dotted_revno(self.revision_id)
 
235
            except errors.NoSuchRevision:
 
236
                revno = ['merge']
 
237
        nick = re.sub('(\\W+)', '-', branch.nick).strip('-')
221
238
        return '%s-%s' % (nick, '.'.join(str(n) for n in revno))
222
239
 
223
240
    @staticmethod
224
241
    def _generate_diff(repository, revision_id, ancestor_id):
225
242
        tree_1 = repository.revision_tree(ancestor_id)
226
243
        tree_2 = repository.revision_tree(revision_id)
227
 
        s = StringIO()
 
244
        s = BytesIO()
228
245
        diff.show_diff_trees(tree_1, tree_2, s, old_label='', new_label='')
229
246
        return s.getvalue()
230
247
 
231
248
    @staticmethod
232
249
    def _generate_bundle(repository, revision_id, ancestor_id):
233
 
        s = StringIO()
 
250
        s = BytesIO()
234
251
        bundle_serializer.write_bundle(repository, revision_id,
235
252
                                       ancestor_id, s)
236
253
        return s.getvalue()
241
258
        :param branch: The source branch, to get the signing strategy
242
259
        :return: a string
243
260
        """
244
 
        my_gpg = gpg.GPGStrategy(branch.get_config())
245
 
        return my_gpg.sign(''.join(self.to_lines()))
 
261
        my_gpg = gpg.GPGStrategy(branch.get_config_stack())
 
262
        return my_gpg.sign(b''.join(self.to_lines()), gpg.MODE_CLEAR)
246
263
 
247
264
    def to_email(self, mail_to, branch, sign=False):
248
265
        """Serialize as an email message.
253
270
        :param sign: If True, gpg-sign the email
254
271
        :return: an email message
255
272
        """
256
 
        mail_from = branch.get_config().username()
 
273
        mail_from = branch.get_config_stack().get('email')
257
274
        if self.message is not None:
258
275
            subject = self.message
259
276
        else:
262
279
        if sign:
263
280
            body = self.to_signed(branch)
264
281
        else:
265
 
            body = ''.join(self.to_lines())
266
 
        message = EmailMessage(mail_from, mail_to, subject, body)
 
282
            body = b''.join(self.to_lines())
 
283
        message = email_message.EmailMessage(mail_from, mail_to, subject,
 
284
                                             body)
267
285
        return message
268
286
 
269
287
    def install_revisions(self, target_repo):
271
289
        if not target_repo.has_revision(self.revision_id):
272
290
            if self.patch_type == 'bundle':
273
291
                info = bundle_serializer.read_bundle(
274
 
                    StringIO(self.get_raw_bundle()))
 
292
                    BytesIO(self.get_raw_bundle()))
275
293
                # We don't use the bundle's target revision, because
276
294
                # MergeDirective.revision_id is authoritative.
277
295
                try:
289
307
                                           info.real_revisions)
290
308
                    for revision in info.real_revisions:
291
309
                        for parent_id in revision.parent_ids:
292
 
                            if (parent_id not in bundle_revisions and
293
 
                                not target_repo.has_revision(parent_id)):
 
310
                            if (parent_id not in bundle_revisions
 
311
                                    and not target_repo.has_revision(parent_id)):
294
312
                                missing_revisions.append(parent_id)
295
313
                    # reverse missing revisions to try to get heads first
296
314
                    unique_missing = []
335
353
        elif len(self.hooks['merge_request_body']) > 0:
336
354
            trace.warning('Cannot run merge_request_body hooks because mail'
337
355
                          ' client %s does not support message bodies.',
338
 
                        mail_client.__class__.__name__)
 
356
                          mail_client.__class__.__name__)
339
357
        mail_client.compose_merge_request(to, subject,
340
 
                                          ''.join(self.to_lines()),
 
358
                                          b''.join(self.to_lines()),
341
359
                                          basename, body)
342
360
 
343
361
 
357
375
    directly using the standard patch program.
358
376
    """
359
377
 
360
 
    _format_string = 'Bazaar merge directive format 1'
 
378
    _format_string = b'Bazaar merge directive format 1'
361
379
 
362
380
    def __init__(self, revision_id, testament_sha1, time, timezone,
363
381
                 target_branch, patch=None, patch_type=None,
369
387
            merge.
370
388
        :param time: The current POSIX timestamp time
371
389
        :param timezone: The timezone offset
372
 
        :param target_branch: The branch to apply the merge to
 
390
        :param target_branch: Location of the branch to apply the merge to
373
391
        :param patch: The text of a diff or bundle
374
392
        :param patch_type: None, "diff" or "bundle", depending on the contents
375
393
            of patch
377
395
        :param message: The message to use when committing this merge
378
396
        """
379
397
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
380
 
            timezone, target_branch, patch, source_branch, message)
 
398
                                    timezone, target_branch, patch, source_branch, message)
381
399
        if patch_type not in (None, 'diff', 'bundle'):
382
400
            raise ValueError(patch_type)
383
401
        if patch_type != 'bundle' and source_branch is None:
409
427
        :return: a MergeRequest
410
428
        """
411
429
        line_iter = iter(lines)
412
 
        firstline = ""
 
430
        firstline = b""
413
431
        for line in line_iter:
414
 
            if line.startswith('# Bazaar merge directive format '):
 
432
            if line.startswith(b'# Bazaar merge directive format '):
415
433
                return _format_registry.get(line[2:].rstrip())._from_lines(
416
434
                    line_iter)
417
435
            firstline = firstline or line.strip()
425
443
            patch = None
426
444
            patch_type = None
427
445
        else:
428
 
            patch = ''.join(patch_lines)
 
446
            patch = b''.join(patch_lines)
429
447
            try:
430
 
                bundle_serializer.read_bundle(StringIO(patch))
 
448
                bundle_serializer.read_bundle(BytesIO(patch))
431
449
            except (errors.NotABundle, errors.BundleNotSupported,
432
450
                    errors.BadBundle):
433
451
                patch_type = 'diff'
442
460
            except KeyError:
443
461
                pass
444
462
        kwargs['revision_id'] = kwargs['revision_id'].encode('utf-8')
 
463
        if 'testament_sha1' in kwargs:
 
464
            kwargs['testament_sha1'] = kwargs['testament_sha1'].encode('ascii')
445
465
        return MergeDirective(time=time, timezone=timezone,
446
466
                              patch_type=patch_type, patch=patch, **kwargs)
447
467
 
453
473
 
454
474
    @staticmethod
455
475
    def _generate_bundle(repository, revision_id, ancestor_id):
456
 
        s = StringIO()
 
476
        s = BytesIO()
457
477
        bundle_serializer.write_bundle(repository, revision_id,
458
478
                                       ancestor_id, s, '0.9')
459
479
        return s.getvalue()
468
488
 
469
489
class MergeDirective2(BaseMergeDirective):
470
490
 
471
 
    _format_string = 'Bazaar merge directive format 2 (Bazaar 0.90)'
 
491
    _format_string = b'Bazaar merge directive format 2 (Bazaar 0.90)'
472
492
 
473
493
    def __init__(self, revision_id, testament_sha1, time, timezone,
474
494
                 target_branch, patch=None, source_branch=None, message=None,
476
496
        if source_branch is None and bundle is None:
477
497
            raise errors.NoMergeSource()
478
498
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
479
 
            timezone, target_branch, patch, source_branch, message)
 
499
                                    timezone, target_branch, patch, source_branch, message)
480
500
        self.bundle = bundle
481
501
        self.base_revision_id = base_revision_id
482
502
 
498
518
        if self.bundle is None:
499
519
            return None
500
520
        else:
501
 
            return self.bundle.decode('base-64')
 
521
            return base64.b64decode(self.bundle)
502
522
 
503
523
    @classmethod
504
524
    def _from_lines(klass, line_iter):
506
526
        patch = None
507
527
        bundle = None
508
528
        try:
509
 
            start = line_iter.next()
 
529
            start = next(line_iter)
510
530
        except StopIteration:
511
531
            pass
512
532
        else:
513
 
            if start.startswith('# Begin patch'):
 
533
            if start.startswith(b'# Begin patch'):
514
534
                patch_lines = []
515
535
                for line in line_iter:
516
 
                    if line.startswith('# Begin bundle'):
 
536
                    if line.startswith(b'# Begin bundle'):
517
537
                        start = line
518
538
                        break
519
539
                    patch_lines.append(line)
520
540
                else:
521
541
                    start = None
522
 
                patch = ''.join(patch_lines)
 
542
                patch = b''.join(patch_lines)
523
543
            if start is not None:
524
 
                if start.startswith('# Begin bundle'):
525
 
                    bundle = ''.join(line_iter)
 
544
                if start.startswith(b'# Begin bundle'):
 
545
                    bundle = b''.join(line_iter)
526
546
                else:
527
547
                    raise errors.IllegalMergeDirectivePayload(start)
528
548
        time, timezone = timestamp.parse_patch_date(stanza.get('timestamp'))
536
556
        kwargs['revision_id'] = kwargs['revision_id'].encode('utf-8')
537
557
        kwargs['base_revision_id'] =\
538
558
            kwargs['base_revision_id'].encode('utf-8')
 
559
        if 'testament_sha1' in kwargs:
 
560
            kwargs['testament_sha1'] = kwargs['testament_sha1'].encode('ascii')
539
561
        return klass(time=time, timezone=timezone, patch=patch, bundle=bundle,
540
562
                     **kwargs)
541
563
 
542
564
    def to_lines(self):
543
565
        lines = self._to_lines(base_revision=True)
544
566
        if self.patch is not None:
545
 
            lines.append('# Begin patch\n')
 
567
            lines.append(b'# Begin patch\n')
546
568
            lines.extend(self.patch.splitlines(True))
547
569
        if self.bundle is not None:
548
 
            lines.append('# Begin bundle\n')
 
570
            lines.append(b'# Begin bundle\n')
549
571
            lines.extend(self.bundle.splitlines(True))
550
572
        return lines
551
573
 
552
574
    @classmethod
553
575
    def from_objects(klass, repository, revision_id, time, timezone,
554
 
                 target_branch, include_patch=True, include_bundle=True,
555
 
                 local_target_branch=None, public_branch=None, message=None,
556
 
                 base_revision_id=None):
 
576
                     target_branch, include_patch=True, include_bundle=True,
 
577
                     local_target_branch=None, public_branch=None, message=None,
 
578
                     base_revision_id=None):
557
579
        """Generate a merge directive from various objects
558
580
 
559
581
        :param repository: The repository containing the revision
563
585
        :param target_branch: The url of the branch to merge into
564
586
        :param include_patch: If true, include a preview patch
565
587
        :param include_bundle: If true, include a bundle
566
 
        :param local_target_branch: a local copy of the target branch
567
 
        :param public_branch: location of a public branch containing the target
568
 
            revision.
 
588
        :param local_target_branch: the target branch, either itself or a local copy
 
589
        :param public_branch: location of a public branch containing
 
590
            the target revision.
569
591
        :param message: Message to use when committing the merge
570
592
        :return: The merge directive
571
593
 
575
597
        If the message is not supplied, the message from revision_id will be
576
598
        used for the commit.
577
599
        """
578
 
        locked = []
579
 
        try:
580
 
            repository.lock_write()
581
 
            locked.append(repository)
 
600
        with cleanup.ExitStack() as exit_stack:
 
601
            exit_stack.enter_context(repository.lock_write())
582
602
            t_revision_id = revision_id
583
 
            if revision_id == 'null:':
 
603
            if revision_id == b'null:':
584
604
                t_revision_id = None
585
605
            t = testament.StrictTestament3.from_revision(repository,
586
 
                t_revision_id)
587
 
            submit_branch = _mod_branch.Branch.open(target_branch)
588
 
            submit_branch.lock_read()
589
 
            locked.append(submit_branch)
 
606
                                                         t_revision_id)
 
607
            if local_target_branch is None:
 
608
                submit_branch = _mod_branch.Branch.open(target_branch)
 
609
            else:
 
610
                submit_branch = local_target_branch
 
611
            exit_stack.enter_context(submit_branch.lock_read())
590
612
            if submit_branch.get_public_branch() is not None:
591
613
                target_branch = submit_branch.get_public_branch()
592
614
            submit_revision_id = submit_branch.last_revision()
605
627
                patch = None
606
628
 
607
629
            if include_bundle:
608
 
                bundle = klass._generate_bundle(repository, revision_id,
609
 
                    ancestor_id).encode('base-64')
 
630
                bundle = base64.b64encode(klass._generate_bundle(repository, revision_id,
 
631
                                                                 ancestor_id))
610
632
            else:
611
633
                bundle = None
612
634
 
613
635
            if public_branch is not None and not include_bundle:
614
636
                public_branch_obj = _mod_branch.Branch.open(public_branch)
615
 
                public_branch_obj.lock_read()
616
 
                locked.append(public_branch_obj)
 
637
                exit_stack.enter_context(public_branch_obj.lock_read())
617
638
                if not public_branch_obj.repository.has_revision(
618
 
                    revision_id):
 
639
                        revision_id):
619
640
                    raise errors.PublicBranchOutOfDate(public_branch,
620
641
                                                       revision_id)
621
642
            testament_sha1 = t.as_sha1()
622
 
        finally:
623
 
            for entry in reversed(locked):
624
 
                entry.unlock()
625
643
        return klass(revision_id, testament_sha1, time, timezone,
626
 
            target_branch, patch, public_branch, message, bundle,
627
 
            base_revision_id)
 
644
                     target_branch, patch, public_branch, message, bundle,
 
645
                     base_revision_id)
628
646
 
629
647
    def _verify_patch(self, repository):
630
648
        calculated_patch = self._generate_diff(repository, self.revision_id,
631
649
                                               self.base_revision_id)
632
650
        # Convert line-endings to UNIX
633
 
        stored_patch = re.sub('\r\n?', '\n', self.patch)
634
 
        calculated_patch = re.sub('\r\n?', '\n', calculated_patch)
 
651
        stored_patch = re.sub(b'\r\n?', b'\n', self.patch)
 
652
        calculated_patch = re.sub(b'\r\n?', b'\n', calculated_patch)
635
653
        # Strip trailing whitespace
636
 
        calculated_patch = re.sub(' *\n', '\n', calculated_patch)
637
 
        stored_patch = re.sub(' *\n', '\n', stored_patch)
 
654
        calculated_patch = re.sub(b' *\n', b'\n', calculated_patch)
 
655
        stored_patch = re.sub(b' *\n', b'\n', stored_patch)
638
656
        return (calculated_patch == stored_patch)
639
657
 
640
658
    def get_merge_request(self, repository):
670
688
# already merge directives in the wild that used 0.19. Registering with the old
671
689
# format string to retain compatibility with those merge directives.
672
690
_format_registry.register(MergeDirective2,
673
 
                          'Bazaar merge directive format 2 (Bazaar 0.19)')
 
691
                          b'Bazaar merge directive format 2 (Bazaar 0.19)')