/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/plugins/launchpad/lp_api.py

  • Committer: Jelmer Vernooij
  • Date: 2017-07-20 00:00:04 UTC
  • mfrom: (6690.5.2 bundle-guess)
  • Revision ID: jelmer@jelmer.uk-20170720000004-wlknc5gthdk3tokn
Merge lp:~jelmer/brz/bundle-guess.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_api.py
1
 
# Copyright (C) 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2009-2012 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
16
16
 
17
17
"""Tools for dealing with the Launchpad API."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
# Importing this module will be expensive, since it imports launchpadlib and
20
22
# its dependencies. However, our plan is to only load this module when it is
21
23
# needed by a command that uses it.
22
24
 
23
25
 
 
26
import httplib2
24
27
import os
25
28
import re
 
29
import urlparse
26
30
 
27
 
from bzrlib import (
 
31
from ... import (
28
32
    branch,
29
33
    config,
30
34
    errors,
32
36
    trace,
33
37
    transport,
34
38
    )
35
 
from bzrlib.plugins.launchpad.lp_registration import (
 
39
from ...i18n import gettext
 
40
from .lp_registration import (
36
41
    InvalidLaunchpadInstance,
37
 
    NotLaunchpadBranch,
38
42
    )
39
43
 
40
44
try:
41
45
    import launchpadlib
42
 
except ImportError, e:
 
46
except ImportError as e:
43
47
    raise errors.DependencyNotPresent('launchpadlib', e)
44
48
 
45
49
from launchpadlib.launchpad import (
46
 
    EDGE_SERVICE_ROOT,
47
50
    STAGING_SERVICE_ROOT,
48
51
    Launchpad,
49
52
    )
50
 
 
 
53
from launchpadlib import uris
51
54
 
52
55
# Declare the minimum version of launchpadlib that we need in order to work.
53
 
# 1.5.1 is the version of launchpadlib packaged in Ubuntu 9.10, the most
54
 
# recent Ubuntu release at the time of writing.
55
 
MINIMUM_LAUNCHPADLIB_VERSION = (1, 5, 1)
 
56
# 1.6.0 is the version of launchpadlib packaged in Ubuntu 10.04, the most
 
57
# recent Ubuntu LTS release supported on the desktop at the time of writing.
 
58
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 0)
56
59
 
57
60
 
58
61
def get_cache_directory():
69
72
    """Raise an error if launchpadlib has the wrong version number."""
70
73
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
71
74
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
72
 
        raise errors.IncompatibleAPI(
73
 
            'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
74
 
            installed_version, installed_version)
75
 
 
76
 
 
77
 
LAUNCHPAD_API_URLS = {
78
 
    'production': 'https://api.launchpad.net/beta/',
79
 
    'edge': EDGE_SERVICE_ROOT,
80
 
    'staging': STAGING_SERVICE_ROOT,
81
 
    'dev': 'https://api.launchpad.dev/beta/',
82
 
    }
 
75
        raise errors.DependencyNotPresent(
 
76
            'launchpadlib',
 
77
            'At least launchpadlib %s is required, but installed version is %s'
 
78
            % (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
 
79
 
 
80
 
 
81
def lookup_service_root(service_root):
 
82
    try:
 
83
        return uris.lookup_service_root(service_root)
 
84
    except ValueError:
 
85
        if service_root != 'qastaging':
 
86
            raise
 
87
        staging_root = uris.lookup_service_root('staging')
 
88
        return staging_root.replace('staging', 'qastaging')
83
89
 
84
90
 
85
91
def _get_api_url(service):
86
92
    """Return the root URL of the Launchpad API.
87
93
 
88
 
    e.g. For the 'edge' Launchpad service, this function returns
89
 
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
 
94
    e.g. For the 'staging' Launchpad service, this function returns
 
95
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
90
96
 
91
97
    :param service: A `LaunchpadService` object.
92
98
    :return: A URL as a string.
96
102
    else:
97
103
        lp_instance = service._lp_instance
98
104
    try:
99
 
        return LAUNCHPAD_API_URLS[lp_instance]
100
 
    except KeyError:
 
105
        return lookup_service_root(lp_instance)
 
106
    except ValueError:
101
107
        raise InvalidLaunchpadInstance(lp_instance)
102
108
 
103
109
 
104
 
def login(service, timeout=None, proxy_info=None):
 
110
class NoLaunchpadBranch(errors.BzrError):
 
111
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
 
112
 
 
113
    def __init__(self, branch):
 
114
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
 
115
 
 
116
 
 
117
def login(service, timeout=None, proxy_info=None,
 
118
          version=Launchpad.DEFAULT_VERSION):
105
119
    """Log in to the Launchpad API.
106
120
 
107
121
    :return: The root `Launchpad` object from launchpadlib.
108
122
    """
 
123
    if proxy_info is None:
 
124
        proxy_info = httplib2.proxy_info_from_environment('https')
109
125
    cache_directory = get_cache_directory()
110
126
    launchpad = Launchpad.login_with(
111
127
        'bzr', _get_api_url(service), cache_directory, timeout=timeout,
112
 
        proxy_info=proxy_info)
113
 
    # XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
114
 
    # create this directory with default umask.
115
 
    os.chmod(cache_directory, 0700)
 
128
        proxy_info=proxy_info, version=version)
 
129
    # XXX: Work-around a minor security bug in launchpadlib < 1.6.3, which
 
130
    # would create this directory with default umask.
 
131
    osutils.chmod_if_possible(cache_directory, 0o700)
116
132
    return launchpad
117
133
 
118
134
 
174
190
        url = bzr_branch.get_push_location()
175
191
        if url is not None:
176
192
            yield url
 
193
        url = bzr_branch.get_parent()
 
194
        if url is not None:
 
195
            yield url
177
196
        yield bzr_branch.base
178
197
 
179
198
    @staticmethod
180
199
    def tweak_url(url, launchpad):
181
200
        """Adjust a URL to work with staging, if needed."""
182
 
        if str(launchpad._root_uri) != STAGING_SERVICE_ROOT:
183
 
            return url
184
 
        if url is None:
185
 
            return None
186
 
        return url.replace('bazaar.launchpad.net',
187
 
                           'bazaar.staging.launchpad.net')
 
201
        if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
 
202
            return url.replace('bazaar.launchpad.net',
 
203
                               'bazaar.staging.launchpad.net')
 
204
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
 
205
            return url.replace('bazaar.launchpad.net',
 
206
                               'bazaar.qastaging.launchpad.net')
 
207
        return url
188
208
 
189
209
    @classmethod
190
 
    def from_bzr(cls, launchpad, bzr_branch):
 
210
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
191
211
        """Find a Launchpad branch from a bzr branch."""
192
212
        check_update = True
193
213
        for url in cls.candidate_urls(bzr_branch):
198
218
            if lp_branch is not None:
199
219
                break
200
220
        else:
 
221
            if not create_missing:
 
222
                raise NoLaunchpadBranch(bzr_branch)
201
223
            lp_branch = cls.create_now(launchpad, bzr_branch)
202
224
            check_update = False
203
225
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
207
229
        """Create a Bazaar branch on Launchpad for the supplied branch."""
208
230
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
209
231
        if not cls.plausible_launchpad_url(url):
210
 
            raise errors.BzrError('%s is not registered on Launchpad' %
 
232
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
211
233
                                  bzr_branch.base)
212
234
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
213
235
        lp_branch = launchpad.branches.getByUrl(url=url)
214
236
        if lp_branch is None:
215
 
            raise errors.BzrError('%s is not registered on Launchpad' % url)
 
237
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
238
                                                                            url)
216
239
        return lp_branch
217
240
 
218
 
    def get_dev_focus(self):
219
 
        """Return the 'LaunchpadBranch' for the dev focus of this one."""
 
241
    def get_target(self):
 
242
        """Return the 'LaunchpadBranch' for the target of this one."""
220
243
        lp_branch = self.lp
221
 
        if lp_branch.project is None:
222
 
            raise errors.BzrError('%s has no product.' %
223
 
                                  lp_branch.bzr_identity)
224
 
        dev_focus = lp_branch.project.development_focus.branch
225
 
        if dev_focus is None:
226
 
            raise errors.BzrError('%s has no development focus.' %
227
 
                                  lp_branch.bzr_identity)
228
 
        return LaunchpadBranch(dev_focus, dev_focus.bzr_identity)
 
244
        if lp_branch.project is not None:
 
245
            dev_focus = lp_branch.project.development_focus
 
246
            if dev_focus is None:
 
247
                raise errors.BzrError(gettext('%s has no development focus.') %
 
248
                                  lp_branch.bzr_identity)
 
249
            target = dev_focus.branch
 
250
            if target is None:
 
251
                raise errors.BzrError(gettext(
 
252
                        'development focus %s has no branch.') % dev_focus)
 
253
        elif lp_branch.sourcepackage is not None:
 
254
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
 
255
            if target is None:
 
256
                raise errors.BzrError(gettext(
 
257
                                      'source package %s has no branch.') %
 
258
                                      lp_branch.sourcepackage)
 
259
        else:
 
260
            raise errors.BzrError(gettext(
 
261
                        '%s has no associated product or source package.') %
 
262
                                  lp_branch.bzr_identity)
 
263
        return LaunchpadBranch(target, target.bzr_identity)
229
264
 
230
265
    def update_lp(self):
231
266
        """Update the Launchpad copy of this branch."""
235
270
        try:
236
271
            if self.lp.last_scanned_id is not None:
237
272
                if self.bzr.last_revision() == self.lp.last_scanned_id:
238
 
                    trace.note('%s is already up-to-date.' %
 
273
                    trace.note(gettext('%s is already up-to-date.') %
239
274
                               self.lp.bzr_identity)
240
275
                    return
241
276
                graph = self.bzr.repository.get_graph()
242
277
                if not graph.is_ancestor(self.lp.last_scanned_id,
243
278
                                         self.bzr.last_revision()):
244
279
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
245
 
                trace.note('Pushing to %s' % self.lp.bzr_identity)
 
280
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
246
281
            self.bzr.push(self.push_bzr)
247
282
        finally:
248
283
            self.bzr.unlock()
259
294
        return self.bzr.repository.revision_tree(lca)
260
295
 
261
296
 
262
 
def load_branch(launchpad, branch):
263
 
    """Return the launchpadlib Branch object corresponding to 'branch'.
264
 
 
265
 
    :param launchpad: The root `Launchpad` object from launchpadlib.
266
 
    :param branch: A `bzrlib.branch.Branch`.
267
 
    :raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
268
 
        `branch`.
269
 
    :return: A launchpadlib Branch object.
270
 
    """
271
 
    # XXX: This duplicates the "What are possible URLs for the branch that
272
 
    # Launchpad might recognize" logic found in cmd_lp_open.
273
 
 
274
 
    # XXX: This makes multiple roundtrips to Launchpad for what is
275
 
    # conceptually a single operation -- get me the branches that match these
276
 
    # URLs. Unfortunately, Launchpad's support for such operations is poor, so
277
 
    # we have to allow multiple roundtrips.
278
 
    for url in branch.get_public_branch(), branch.get_push_location():
279
 
        lp_branch = launchpad.branches.getByUrl(url=url)
280
 
        if lp_branch:
281
 
            return lp_branch
282
 
    raise NotLaunchpadBranch(url)
 
297
def canonical_url(object):
 
298
    """Return the canonical URL for a branch."""
 
299
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
 
300
        str(object.self_link))
 
301
    path = '/'.join(path.split('/')[2:])
 
302
    netloc = netloc.replace('api.', 'code.')
 
303
    return urlparse.urlunparse((scheme, netloc, path, params, query,
 
304
                                fragment))