/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

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
21
21
# needed by a command that uses it.
22
22
 
23
23
 
24
 
import os
25
24
import re
 
25
from urllib.parse import (
 
26
    urlparse,
 
27
    urlunparse,
 
28
    )
26
29
 
27
 
from bzrlib import (
 
30
from ... import (
28
31
    branch,
29
 
    config,
 
32
    bedding,
30
33
    errors,
31
34
    osutils,
32
35
    trace,
33
36
    transport,
34
37
    )
35
 
from bzrlib.plugins.launchpad.lp_registration import (
36
 
    InvalidLaunchpadInstance,
37
 
    NotLaunchpadBranch,
38
 
    )
 
38
from ...i18n import gettext
 
39
 
 
40
 
 
41
class LaunchpadlibMissing(errors.DependencyNotPresent):
 
42
 
 
43
    _fmt = ("launchpadlib is required for Launchpad API access. "
 
44
            "Please install the launchpadlib package.")
 
45
 
 
46
    def __init__(self, e):
 
47
        super(LaunchpadlibMissing, self).__init__(
 
48
            'launchpadlib', e)
39
49
 
40
50
try:
41
51
    import launchpadlib
42
 
except ImportError, e:
43
 
    raise errors.DependencyNotPresent('launchpadlib', e)
 
52
except ImportError as e:
 
53
    raise LaunchpadlibMissing(e)
44
54
 
 
55
from launchpadlib.credentials import RequestTokenAuthorizationEngine
45
56
from launchpadlib.launchpad import (
46
 
    EDGE_SERVICE_ROOT,
47
 
    STAGING_SERVICE_ROOT,
48
57
    Launchpad,
49
58
    )
50
 
 
 
59
from launchpadlib import uris
51
60
 
52
61
# 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)
 
62
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
56
63
 
57
64
 
58
65
def get_cache_directory():
59
66
    """Return the directory to cache launchpadlib objects in."""
60
 
    return osutils.pathjoin(config.config_dir(), 'launchpad')
 
67
    return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
61
68
 
62
69
 
63
70
def parse_launchpadlib_version(version_number):
69
76
    """Raise an error if launchpadlib has the wrong version number."""
70
77
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
71
78
    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
 
    }
83
 
 
84
 
 
85
 
def _get_api_url(service):
86
 
    """Return the root URL of the Launchpad API.
87
 
 
88
 
    e.g. For the 'edge' Launchpad service, this function returns
89
 
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
90
 
 
91
 
    :param service: A `LaunchpadService` object.
92
 
    :return: A URL as a string.
93
 
    """
94
 
    if service._lp_instance is None:
95
 
        lp_instance = service.DEFAULT_INSTANCE
96
 
    else:
97
 
        lp_instance = service._lp_instance
 
79
        raise errors.DependencyNotPresent(
 
80
            'launchpadlib',
 
81
            'At least launchpadlib %s is required, but installed version is %s'
 
82
            % (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
 
83
 
 
84
 
 
85
def lookup_service_root(service_root):
98
86
    try:
99
 
        return LAUNCHPAD_API_URLS[lp_instance]
100
 
    except KeyError:
101
 
        raise InvalidLaunchpadInstance(lp_instance)
102
 
 
103
 
 
104
 
def login(service, timeout=None, proxy_info=None):
 
87
        return uris.lookup_service_root(service_root)
 
88
    except ValueError:
 
89
        if service_root != 'qastaging':
 
90
            raise
 
91
        staging_root = uris.lookup_service_root('staging')
 
92
        return staging_root.replace('staging', 'qastaging')
 
93
 
 
94
 
 
95
class NoLaunchpadBranch(errors.BzrError):
 
96
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
 
97
 
 
98
    def __init__(self, branch):
 
99
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
 
100
 
 
101
 
 
102
def get_auth_engine(base_url):
 
103
    return Launchpad.authorization_engine_factory(base_url, 'breezy')
 
104
 
 
105
 
 
106
def get_credential_store():
 
107
    return Launchpad.credential_store_factory(None)
 
108
 
 
109
 
 
110
def connect_launchpad(base_url, timeout=None, proxy_info=None,
 
111
                      version=Launchpad.DEFAULT_VERSION):
105
112
    """Log in to the Launchpad API.
106
113
 
107
114
    :return: The root `Launchpad` object from launchpadlib.
108
115
    """
109
 
    cache_directory = get_cache_directory()
110
 
    launchpad = Launchpad.login_with(
111
 
        '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)
116
 
    return launchpad
 
116
    if proxy_info is None:
 
117
        import httplib2
 
118
        proxy_info = httplib2.proxy_info_from_environment('https')
 
119
    try:
 
120
        cache_directory = get_cache_directory()
 
121
    except EnvironmentError:
 
122
        cache_directory = None
 
123
    credential_store = get_credential_store()
 
124
    authorization_engine = get_auth_engine(base_url)
 
125
    return Launchpad.login_with(
 
126
        'breezy', base_url, cache_directory, timeout=timeout,
 
127
        credential_store=credential_store,
 
128
        authorization_engine=authorization_engine,
 
129
        proxy_info=proxy_info, version=version)
 
130
 
117
131
 
118
132
 
119
133
class LaunchpadBranch(object):
157
171
            return False
158
172
        if url.startswith('lp:'):
159
173
            return True
160
 
        regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
 
174
        regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
161
175
                           '://bazaar.*.launchpad.net')
162
176
        return bool(regex.match(url))
163
177
 
174
188
        url = bzr_branch.get_push_location()
175
189
        if url is not None:
176
190
            yield url
 
191
        url = bzr_branch.get_parent()
 
192
        if url is not None:
 
193
            yield url
177
194
        yield bzr_branch.base
178
195
 
179
196
    @staticmethod
180
197
    def tweak_url(url, launchpad):
181
198
        """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')
 
199
        if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
 
200
            return url.replace('bazaar.launchpad.net',
 
201
                               'bazaar.staging.launchpad.net')
 
202
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
 
203
            return url.replace('bazaar.launchpad.net',
 
204
                               'bazaar.qastaging.launchpad.net')
 
205
        return url
188
206
 
189
207
    @classmethod
190
 
    def from_bzr(cls, launchpad, bzr_branch):
 
208
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
191
209
        """Find a Launchpad branch from a bzr branch."""
192
210
        check_update = True
193
211
        for url in cls.candidate_urls(bzr_branch):
198
216
            if lp_branch is not None:
199
217
                break
200
218
        else:
 
219
            if not create_missing:
 
220
                raise NoLaunchpadBranch(bzr_branch)
201
221
            lp_branch = cls.create_now(launchpad, bzr_branch)
202
222
            check_update = False
203
223
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
207
227
        """Create a Bazaar branch on Launchpad for the supplied branch."""
208
228
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
209
229
        if not cls.plausible_launchpad_url(url):
210
 
            raise errors.BzrError('%s is not registered on Launchpad' %
 
230
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
211
231
                                  bzr_branch.base)
212
232
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
213
233
        lp_branch = launchpad.branches.getByUrl(url=url)
214
234
        if lp_branch is None:
215
 
            raise errors.BzrError('%s is not registered on Launchpad' % url)
 
235
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
236
                                  url)
216
237
        return lp_branch
217
238
 
218
 
    def get_dev_focus(self):
219
 
        """Return the 'LaunchpadBranch' for the dev focus of this one."""
 
239
    def get_target(self):
 
240
        """Return the 'LaunchpadBranch' for the target of this one."""
220
241
        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)
 
242
        if lp_branch.project is not None:
 
243
            dev_focus = lp_branch.project.development_focus
 
244
            if dev_focus is None:
 
245
                raise errors.BzrError(gettext('%s has no development focus.') %
 
246
                                      lp_branch.bzr_identity)
 
247
            target = dev_focus.branch
 
248
            if target is None:
 
249
                raise errors.BzrError(gettext(
 
250
                    'development focus %s has no branch.') % dev_focus)
 
251
        elif lp_branch.sourcepackage is not None:
 
252
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
 
253
            if target is None:
 
254
                raise errors.BzrError(gettext(
 
255
                                      'source package %s has no branch.') %
 
256
                                      lp_branch.sourcepackage)
 
257
        else:
 
258
            raise errors.BzrError(gettext(
 
259
                '%s has no associated product or source package.') %
 
260
                lp_branch.bzr_identity)
 
261
        return LaunchpadBranch(target, target.bzr_identity)
229
262
 
230
263
    def update_lp(self):
231
264
        """Update the Launchpad copy of this branch."""
232
265
        if not self._check_update:
233
266
            return
234
 
        self.bzr.lock_read()
235
 
        try:
 
267
        with self.bzr.lock_read():
236
268
            if self.lp.last_scanned_id is not None:
237
269
                if self.bzr.last_revision() == self.lp.last_scanned_id:
238
 
                    trace.note('%s is already up-to-date.' %
 
270
                    trace.note(gettext('%s is already up-to-date.') %
239
271
                               self.lp.bzr_identity)
240
272
                    return
241
273
                graph = self.bzr.repository.get_graph()
242
 
                if not graph.is_ancestor(self.lp.last_scanned_id,
 
274
                if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
243
275
                                         self.bzr.last_revision()):
244
276
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
245
 
                trace.note('Pushing to %s' % self.lp.bzr_identity)
 
277
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
246
278
            self.bzr.push(self.push_bzr)
247
 
        finally:
248
 
            self.bzr.unlock()
249
279
 
250
280
    def find_lca_tree(self, other):
251
281
        """Find the revision tree for the LCA of this branch and other.
259
289
        return self.bzr.repository.revision_tree(lca)
260
290
 
261
291
 
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)
 
292
def canonical_url(object):
 
293
    """Return the canonical URL for a branch."""
 
294
    scheme, netloc, path, params, query, fragment = urlparse(
 
295
        str(object.self_link))
 
296
    path = '/'.join(path.split('/')[2:])
 
297
    netloc = netloc.replace('api.', 'code.')
 
298
    return urlunparse((scheme, netloc, path, params, query, fragment))