/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

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