~hydrazine-core/hydrazine/trunk

#! /usr/bin/python3

# vi: expandtab:sts=4

# Copyright (C) 2010 Martin Pool

"""Take approved merge proposals and ask pqm to merge them.

"""

# TODO: comment on an mp

#

# TODO: open in browser

#

# TODO: show all comments

#

# TODO: some way to persistently say "not for me" and not be asked again

import optparse

import sys

from breezy import initialize as breezy_initialize

import atexit

def breezy_setup():

    """Call breezy.initialize and register cleanup to be run on exit"""

    context = breezy_initialize()

    if context is not None:

        atexit.register(context.__enter__().__exit__, None, None, None)

from breezy.email_message import EmailMessage

from breezy import (

    config as _mod_config,

    gpg,

    version_info as breezy_version,

    )

from breezy.smtp_connection import SMTPConnection

import hydrazine

PQM_ADDRESS = 'pqm@bazaar-vcs.org'

# PQM_ADDRESS = 'mbp@sourcefrog.net'

def read_choice():

    print('What now?', end='')

    return raw_input()

def show_help():

    print("""\

feed-pqm looks for approved merge proposals and sends them to pqm.

commands:

    h       help

    m       set the proposed commit message for this proposal

    n       skip this, go to the next

    p       previous

    q       quit

    e       send in an approved merge via email. Requires GPG and email setup

            appropriately in bazaar.conf, and your key in the PQM keyring.

Please send feedback to mbp@canonical.com

""")

    #does not currently do anything useful

    """\

    s       submit approved merges to the queue (PQM reads from the launchpad

            queue) for already queued merges this toggles in and out of queued,

            setting a new queuer and putting it at the back of the queue.

            Requires membership in the review team for the target branch.

"""

def show_datetime(label, dt):

    print("  %12s: %s"  % (label, dt) )

        # TODO: show relative time

        #  (datetime.datetime.utcnow() - dt).days)

def show_mp(mp):

    print(mp.web_link)

    # nb: .url is empty (except on mirrored branches?)

    print('  %12s: %s' % ('message', mp.commit_message))

    print('  %12s: %s' % ('source', mp.source_branch.bzr_identity))

    print('  %12s: %s' % ('target', mp.target_branch.bzr_identity))

    prereq_branch = mp.prerequisite_branch

    if prereq_branch is not None:

        print('  %12s: %s' % ('prereq', prereq_branch.bzr_identity))

    print('  %12s: %s' % ('status', mp.queue_status))

    show_datetime('created', mp.date_created)

    show_datetime('reviewed', mp.date_reviewed)

    print('  %12s: %s' % ('registrant', mp.registrant.name))

    for vote in mp.votes_collection:

        # XXX: would like to show the date but see bug 530475

        print("  %12s: %30s %-12s" % ('vote', vote.reviewer.name, 

            (vote.comment and vote.comment.vote or 'Requested'),

            ))

    # The last comment is usually enough to get a sense for things. Change if

    # desired.

    print("Recent comments:")

    comments = list(mp.all_comments) #XXX: See bug lp:583761

    for comment in comments[-1:]:

        val = "%s: %s" % (comment.author.name, comment.message_body)

        try:

            print(val)

        except UnicodeError:

            val = val.encode('ascii', 'replace')

            print(val)

def set_message(mp):

    print("old commit message: %s" % (mp.commit_message,))

    print("new message> ", end='')

    message = raw_input()

    if len(message) < 2:

        print("Too short to be a commit message?")

        return

    mp.commit_message = message

    mp.lp_save()

def queue_mp(launchpad, mp):

    if not mp.commit_message:

        print("No message set?  Use 'm'.")

        return

    if mp.queue_status == 'Queued':

        mp.setStatus(status='Approved')

    mp.setStatus(status='Queued', revid=mp.reviewed_revid)

def send_mp(launchpad, mp, send_mail=True):

    if not mp.commit_message:

        print("No message set - %s queued badly? Set a message first." % mp)

        return False

    print("merge command to be signed:")

    raw_message = (

        "star-merge %s %s\n"

        % (mp.source_branch.composePublicURL(scheme='http'),

            mp.target_branch.composePublicURL(scheme='http')))

    print(raw_message)

    config = _mod_config.GlobalStack()

    my_email = config.get('email')

    print("Will send email from address <%s>" % (my_email,))

    signer = gpg.GPGStrategy(config)

    signed_message = signer.sign(raw_message.encode('utf8'))

    # TODO: put in bug numbers as well.

    commit_message = u"(%s) %s (%s)" % (launchpad.me.name, mp.commit_message,

        mp.source_branch.owner.display_name)

    message = EmailMessage(my_email, PQM_ADDRESS, commit_message,

                           signed_message)

    if send_mail:

        SMTPConnection(config).send_email(message)

        print("Sent!")

    else:

        print("Not sending email - disabled.")

    # suggested subject should match the last comment on the mp so that gmail

    # doesn't see it as a separate thread;

    # <https://bugs.edge.launchpad.net/hydrazine/+bug/541586>

    subject = "Re: [Merge] %s into %s" % (mp.source_branch.bzr_identity,

        mp.target_branch.bzr_identity)

    print("Recording that the proposal is submitted to PQM.")

    fed_pqm = "sent to pqm by email\n"

    mp.createComment(content=fed_pqm, subject=subject)

    return True

def iter_mergable_proposals(project, include_queued=False):

    """Iterate over merge proposals for `project` that are ready to be landed

    If `show_queued` is set, proposals using launchpad queue tracking which

    are already due to be landed are also shown. This doesn't matter for merge

    commands sent by email instead.

    Proposals that have unmerged prerequiste branches will not be offered for

    merging to prevent accidentally landing unreviewed code.

    """

    find_status = ['Approved']

    if include_queued:

        find_status.append('Queued')

    print('Looking for %r mps in %s' % (find_status, project))

    for mp in project.getMergeProposals(status=find_status):

        prereq = mp.prerequisite_branch

        if not prereq or prereq.lifecycle_status == 'Merged':

            yield mp

def main(argv):

    parser = optparse.OptionParser('%prog [options] PROJECT\n\n'

        '  PROJECT is the launchpad project to inspect (eg bzr)')

    parser.add_option('--nomail', help="Do not send email commands", action="store_true", default=False)

    parser.add_option('--queued', help="Examine already queued proposals", action="store_true", default=False)

    opts, args = parser.parse_args()

    if len(args) != 1:

        parser.print_usage()

        return 1

    project = args[0]

    breezy_setup()

    launchpad = hydrazine.create_session()

    project = launchpad.projects[project]

    i = 0

    all_mps = list(iter_mergable_proposals(project,

        include_queued=opts.queued))

    while len(all_mps):

        mp = all_mps[i]

        show_mp(mp)

        while True:

            whatnow = read_choice()

            if whatnow == 'q':

                return 0

            elif whatnow in ('h', 'help', '?'):

                show_help()

            elif whatnow == 'n':

                i = (i + 1) % len(all_mps)

                break

            elif whatnow == 'p':

                i -= 1

                if i < 0:

                    i = len(all_mps) - 1

                break

            elif whatnow == 'm':

                set_message(mp)

            elif whatnow == 's':

                print("Sorry, not currently implemented %r" % whatnow)

                """

                queue_mp(launchpad, mp)

                if mp.queue_status not in find_status:

                    del all_mps[i]

                    if i == len(all_mps):

                        i -= 1

                    break

                """

            elif whatnow == 'e':

                if send_mp(launchpad, mp, send_mail=not opts.nomail):

                    del all_mps[i]

                    if i == len(all_mps):

                        i -= 1

                    break

            elif whatnow == '':

                continue

            else:

                print("Sorry, don't understand %r" % whatnow)

    print("No remaining merge proposals ready to be merged.")

    return 0

if __name__ == '__main__':

    sys.exit(main(sys.argv))