/brz/remove-bazaar

# Copyright (C) 2006-2017 Canonical Ltd

#

# This program 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.

#

# This program 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 this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Launchpad.net integration plugin for Bazaar.

This plugin provides facilities for working with Bazaar branches that are

hosted on Launchpad (http://launchpad.net).  It provides a directory service

for referring to Launchpad branches using the "lp:" prefix.  For example,

lp:bzr refers to the Bazaar's main development branch and

lp:~username/project/branch-name can be used to refer to a specific branch.

This plugin provides a bug tracker so that "bzr commit --fixes lp:1234" will

record that revision as fixing Launchpad's bug 1234.

The plugin also provides the following commands:

    launchpad-login: Show or set the Launchpad user ID

    launchpad-open: Open a Launchpad branch page in your web browser

    launchpad-mirror: Ask Launchpad to mirror a branch now

As well as the following deprecated command:

    lp-propose-merge: Propose merging a branch on Launchpad

         (deprecated in favour of the more generic 'brz propose-merge')

"""

from __future__ import absolute_import

# The XMLRPC server address can be overridden by setting the environment

# variable $BRZ_LP_XMLRPC_URL

# see http://wiki.bazaar.canonical.com/Specs/BranchRegistrationTool

from ... import (

    branch as _mod_branch,

    config as _mod_config,

    lazy_regex,

    # Since we are a built-in plugin we share the breezy version

    trace,

    version_info,  # noqa: F401

    )

from ...commands import (

    plugin_cmds,

    )

from ...directory_service import directories

from ...help_topics import topic_registry

for klsname, aliases in [

    ("cmd_launchpad_open", ["lp-open"]),

    ("cmd_launchpad_login", ["lp-login"]),

    ("cmd_launchpad_logout", ["lp-logout"]),

    ("cmd_lp_propose_merge", ["lp-submit", "lp-propose"]),

        ("cmd_lp_find_proposal", [])]:

    plugin_cmds.register_lazy(klsname, aliases,

                              "breezy.plugins.launchpad.cmds")

def _register_directory():

    directories.register_lazy('lp:', 'breezy.plugins.launchpad.lp_directory',

                              'LaunchpadDirectory',

                              'Launchpad-based directory service',)

    directories.register_lazy(

        'debianlp:', 'breezy.plugins.launchpad.lp_directory',

        'LaunchpadDirectory',

        'debianlp: shortcut')

    directories.register_lazy(

        'ubuntu:', 'breezy.plugins.launchpad.lp_directory',

        'LaunchpadDirectory',

        'ubuntu: shortcut')

_register_directory()

# This is kept in __init__ so that we don't load lp_api_lite unless the branch

# actually matches. That way we can avoid importing extra dependencies like

# json.

_package_branch = lazy_regex.lazy_compile(

    r'bazaar.launchpad.net.*?/'

    r'(?P<user>~[^/]+/)?(?P<archive>ubuntu|debian)/(?P<series>[^/]+/)?'

    r'(?P<project>[^/]+)(?P<branch>/[^/]+)?'

    )

def _get_package_branch_info(url):

    """Determine the packaging information for this URL.

    :return: If this isn't a packaging branch, return None. If it is, return

        (archive, series, project)

    """

    if url is None:

        return None

    m = _package_branch.search(url)

    if m is None:

        return None

    archive, series, project, user = m.group('archive', 'series',

                                             'project', 'user')

    if series is not None:

        # series is optional, so the regex includes the extra '/', we don't

        # want to send that on (it causes Internal Server Errors.)

        series = series.strip('/')

    if user is not None:

        user = user.strip('~/')

        if user != 'ubuntu-branches':

            return None

    return archive, series, project

def _check_is_up_to_date(the_branch):

    info = _get_package_branch_info(the_branch.base)

    if info is None:

        return

    c = the_branch.get_config_stack()

    verbosity = c.get('launchpad.packaging_verbosity')

    if not verbosity:

        trace.mutter('not checking %s because verbosity is turned off'

                     % (the_branch.base,))

        return

    archive, series, project = info

    from . import lp_api_lite

    latest_pub = lp_api_lite.LatestPublication(archive, series, project)

    lp_api_lite.report_freshness(the_branch, verbosity, latest_pub)

def _register_hooks():

    _mod_branch.Branch.hooks.install_named_hook('open',

                                                _check_is_up_to_date, 'package-branch-up-to-date')

_register_hooks()

def load_tests(loader, basic_tests, pattern):

    testmod_names = [

        'test_account',

        'test_register',

        'test_lp_api',

        'test_lp_api_lite',

        'test_lp_directory',

        'test_lp_login',

        'test_lp_open',

        'test_lp_service',

        ]

    basic_tests.addTest(loader.loadTestsFromModuleNames(

        ["%s.%s" % (__name__, tmn) for tmn in testmod_names]))

    return basic_tests

_launchpad_help = """Integration with Launchpad.net

Launchpad.net provides free Bazaar branch hosting with integrated bug and

specification tracking.

The bzr client (through the plugin called 'launchpad') has special

features to communicate with Launchpad:

    * The launchpad-login command tells Bazaar your Launchpad user name. This

      is then used by the 'lp:' transport to download your branches using

      bzr+ssh://.

    * The 'lp:' transport uses Launchpad as a directory service: for example

      'lp:bzr' and 'lp:python' refer to the main branches of the relevant

      projects and may be branched, logged, etc. You can also use the 'lp:'

      transport to refer to specific branches, e.g. lp:~bzr/bzr/trunk.

    * The 'lp:' bug tracker alias can expand launchpad bug numbers to their

      URLs for use with 'bzr commit --fixes', e.g. 'bzr commit --fixes lp:12345'

      will record a revision property that marks that revision as fixing

      Launchpad bug 12345. When you push that branch to Launchpad it will

      automatically be linked to the bug report.

For more information see http://help.launchpad.net/

"""

topic_registry.register('launchpad',

                        _launchpad_help,

                        'Using Bazaar with Launchpad.net')

_mod_config.option_registry.register(

    _mod_config.Option('launchpad.packaging_verbosity', default=True,

                       from_unicode=_mod_config.bool_from_store,

                       help="""\

Whether to warn if a UDD package import branch is accessed that is out of date.

Setting this option to 'off' will disable verbosity.

"""))

_mod_config.option_registry.register(

    _mod_config.Option('launchpad_username', default=None,

                       help="The username to login with when conneting to Launchpad."))