path: root/libbe/command/merge.py

# Copyright (C) 2008-2012 Chris Ball <cjb@laptop.org>
#                         Gianluca Montecchi <gian@grys.it>
#                         W. Trevor King <wking@tremily.us>
#
# This file is part of Bugs Everywhere.
#
# Bugs Everywhere is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 2 of the License, or (at your option) any
# later version.
#
# Bugs Everywhere is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.

import copy

import libbe
import libbe.command
import libbe.command.util


class Merge (libbe.command.Command):
    """Merge duplicate bugs

    >>> import sys
    >>> import libbe.bugdir
    >>> import libbe.comment
    >>> bd = libbe.bugdir.SimpleBugDir(memory=False)
    >>> io = libbe.command.StringInputOutput()
    >>> io.stdout = sys.stdout
    >>> ui = libbe.command.UserInterface(io=io)
    >>> ui.storage_callbacks.set_storage(bd.storage)
    >>> cmd = Merge(ui=ui)

    >>> a = bd.bug_from_uuid('a')
    >>> a.comment_root.time = 0
    >>> dummy = a.new_comment('Testing')
    >>> dummy.time = 1
    >>> dummy = dummy.new_reply('Testing...')
    >>> dummy.time = 2
    >>> b = bd.bug_from_uuid('b')
    >>> b.status = 'open'
    >>> b.comment_root.time = 0
    >>> dummy = b.new_comment('1 2')
    >>> dummy.time = 1
    >>> dummy = dummy.new_reply('1 2 3 4')
    >>> dummy.time = 2

    >>> ret = ui.run(cmd, args=['/a', '/b'])
    Merged bugs #abc/a# and #abc/b#
    >>> bd.flush_reload()
    >>> a = bd.bug_from_uuid('a')
    >>> a.load_comments()
    >>> a_comments = sorted([c for c in a.comments()],
    ...                     cmp=libbe.comment.cmp_time)
    >>> mergeA = a_comments[0]
    >>> mergeA.time = 3
    >>> print(a.string(show_comments=True))
    ... # doctest: +ELLIPSIS, +REPORT_UDIFF
              ID : a
      Short name : abc/a
        Severity : minor
          Status : open
        Assigned :
        Reporter :
         Creator : John Doe <jdoe@example.com>
         Created : ...
    Bug A
    --------- Comment ---------
    Name: abc/a/...
    From: ...
    Date: ...
    <BLANKLINE>
    Testing
      --------- Comment ---------
      Name: abc/a/...
      From: ...
      Date: ...
    <BLANKLINE>
      Testing...
    --------- Comment ---------
    Name: abc/a/...
    From: ...
    Date: ...
    <BLANKLINE>
    Merged from bug #abc/b#
      --------- Comment ---------
      Name: abc/a/...
      From: ...
      Date: ...
    <BLANKLINE>
      1 2
        --------- Comment ---------
        Name: abc/a/...
        From: ...
        Date: ...
    <BLANKLINE>
        1 2 3 4
    >>> b = bd.bug_from_uuid('b')
    >>> b.load_comments()
    >>> b_comments = sorted([c for c in b.comments()],
    ...                     libbe.comment.cmp_time)
    >>> mergeB = b_comments[0]
    >>> mergeB.time = 3
    >>> print(b.string(show_comments=True))
    ... # doctest: +ELLIPSIS, +REPORT_UDIFF
              ID : b
      Short name : abc/b
        Severity : minor
          Status : closed
        Assigned :
        Reporter :
         Creator : Jane Doe <jdoe@example.com>
         Created : ...
    Bug B
    --------- Comment ---------
    Name: abc/b/...
    From: ...
    Date: ...
    <BLANKLINE>
    1 2
      --------- Comment ---------
      Name: abc/b/...
      From: ...
      Date: ...
    <BLANKLINE>
      1 2 3 4
    --------- Comment ---------
    Name: abc/b/...
    From: ...
    Date: ...
    <BLANKLINE>
    Merged into bug #abc/a#
    >>> print(b.status)
    closed
    >>> ui.cleanup()
    >>> bd.cleanup()
    """
    name = 'merge'

    def __init__(self, *args, **kwargs):
        libbe.command.Command.__init__(self, *args, **kwargs)
        self.args.extend([
                libbe.command.Argument(
                    name='bug-id', metavar='BUG-ID', default=None,
                    completion_callback=libbe.command.util.complete_bug_id),
                libbe.command.Argument(
                    name='bug-id-to-merge', metavar='BUG-ID', default=None,
                    completion_callback=libbe.command.util.complete_bug_id),
                ])

    def _run(self, **params):
        storage = self._get_storage()
        bugdirs = self._get_bugdirs()
        bugdirA,bugA,comment = (
            libbe.command.util.bugdir_bug_comment_from_user_id(
                bugdirs, params['bug-id']))
        bugA.load_comments()
        bugdirB,bugB,dummy_comment = (
            libbe.command.util.bugdir_bug_comment_from_user_id(
                bugdirs, params['bug-id-to-merge']))
        bugB.load_comments()
        mergeA = bugA.new_comment('Merged from bug #%s#' % bugB.id.long_user())
        newCommTree = copy.deepcopy(bugB.comment_root)
        for comment in newCommTree.traverse(): # all descendant comments
            comment.bug = bugA
            # uuids must be unique in storage
            if comment.alt_id == None:
                comment.storage = None
                comment.alt_id = comment.uuid
                comment.storage = storage
            comment.uuid = libbe.util.id.uuid_gen()
            comment.save() # force onto disk under bugA

        for comment in newCommTree: # just the child comments
            mergeA.add_reply(comment, allow_time_inversion=True)
        bugB.new_comment('Merged into bug #%s#' % bugA.id.long_user())
        bugB.status = 'closed'
        print('Merged bugs #%s# and #%s#' \
            % (bugA.id.user(), bugB.id.user()), file=self.stdout)
        return 0

    def _long_help(self):
        return """
The second bug (B) is merged into the first (A).  This adds merge
comments to both bugs, closes B, and appends B's comment tree to A's
merge comment.
"""