/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: 2019-10-20 15:03:13 UTC
  • mto: This revision was merged to the branch mainline in revision 7407.
  • Revision ID: jelmer@jelmer.uk-20191020150313-q06o6pncwr6ndu3t
Fix send with git.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_api.py
 
1
# Copyright (C) 2009-2012 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tools for dealing with the Launchpad API."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
# Importing this module will be expensive, since it imports launchpadlib and
 
22
# its dependencies. However, our plan is to only load this module when it is
 
23
# needed by a command that uses it.
 
24
 
 
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
        )
 
37
 
 
38
from ... import (
 
39
    branch,
 
40
    bedding,
 
41
    errors,
 
42
    osutils,
 
43
    trace,
 
44
    transport,
 
45
    )
 
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)
 
57
 
 
58
try:
 
59
    import launchpadlib
 
60
except ImportError as e:
 
61
    raise LaunchpadlibMissing(e)
 
62
 
 
63
from launchpadlib.launchpad import (
 
64
    Launchpad,
 
65
    )
 
66
from launchpadlib import uris
 
67
 
 
68
# Declare the minimum version of launchpadlib that we need in order to work.
 
69
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
 
70
 
 
71
 
 
72
# We use production as the default because edge has been deprecated circa
 
73
# 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
 
74
DEFAULT_INSTANCE = 'production'
 
75
 
 
76
LAUNCHPAD_DOMAINS = {
 
77
    'production': 'launchpad.net',
 
78
    'staging': 'staging.launchpad.net',
 
79
    'qastaging': 'qastaging.launchpad.net',
 
80
    'demo': 'demo.launchpad.net',
 
81
    'dev': 'launchpad.test',
 
82
    }
 
83
 
 
84
LAUNCHPAD_BAZAAR_DOMAINS = [
 
85
    'bazaar.%s' % domain
 
86
    for domain in LAUNCHPAD_DOMAINS.values()]
 
87
 
 
88
 
 
89
def get_cache_directory():
 
90
    """Return the directory to cache launchpadlib objects in."""
 
91
    return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
 
92
 
 
93
 
 
94
def parse_launchpadlib_version(version_number):
 
95
    """Parse a version number of the style used by launchpadlib."""
 
96
    return tuple(map(int, version_number.split('.')))
 
97
 
 
98
 
 
99
def check_launchpadlib_compatibility():
 
100
    """Raise an error if launchpadlib has the wrong version number."""
 
101
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
 
102
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
 
103
        raise errors.DependencyNotPresent(
 
104
            'launchpadlib',
 
105
            'At least launchpadlib %s is required, but installed version is %s'
 
106
            % (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
 
107
 
 
108
 
 
109
def lookup_service_root(service_root):
 
110
    try:
 
111
        return uris.lookup_service_root(service_root)
 
112
    except ValueError:
 
113
        if service_root != 'qastaging':
 
114
            raise
 
115
        staging_root = uris.lookup_service_root('staging')
 
116
        return staging_root.replace('staging', 'qastaging')
 
117
 
 
118
 
 
119
class NoLaunchpadBranch(errors.BzrError):
 
120
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
 
121
 
 
122
    def __init__(self, branch):
 
123
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
 
124
 
 
125
 
 
126
def connect_launchpad(base_url, timeout=None, proxy_info=None,
 
127
                      version=Launchpad.DEFAULT_VERSION):
 
128
    """Log in to the Launchpad API.
 
129
 
 
130
    :return: The root `Launchpad` object from launchpadlib.
 
131
    """
 
132
    if proxy_info is None:
 
133
        import httplib2
 
134
        proxy_info = httplib2.proxy_info_from_environment('https')
 
135
    try:
 
136
        cache_directory = get_cache_directory()
 
137
    except EnvironmentError:
 
138
        cache_directory = None
 
139
    return Launchpad.login_with(
 
140
        'breezy', base_url, cache_directory, timeout=timeout,
 
141
        proxy_info=proxy_info, version=version)
 
142
 
 
143
 
 
144
 
 
145
class LaunchpadBranch(object):
 
146
    """Provide bzr and lp API access to a Launchpad branch."""
 
147
 
 
148
    def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
 
149
        """Constructor.
 
150
 
 
151
        :param lp_branch: The Launchpad branch.
 
152
        :param bzr_url: The URL of the Bazaar branch.
 
153
        :param bzr_branch: An instance of the Bazaar branch.
 
154
        """
 
155
        self.bzr_url = bzr_url
 
156
        self._bzr = bzr_branch
 
157
        self._push_bzr = None
 
158
        self._check_update = check_update
 
159
        self.lp = lp_branch
 
160
 
 
161
    @property
 
162
    def bzr(self):
 
163
        """Return the bzr branch for this branch."""
 
164
        if self._bzr is None:
 
165
            self._bzr = branch.Branch.open(self.bzr_url)
 
166
        return self._bzr
 
167
 
 
168
    @property
 
169
    def push_bzr(self):
 
170
        """Return the push branch for this branch."""
 
171
        if self._push_bzr is None:
 
172
            self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
 
173
        return self._push_bzr
 
174
 
 
175
    @staticmethod
 
176
    def plausible_launchpad_url(url):
 
177
        """Is 'url' something that could conceivably be pushed to LP?
 
178
 
 
179
        :param url: A URL that may refer to a Launchpad branch.
 
180
        :return: A boolean.
 
181
        """
 
182
        if url is None:
 
183
            return False
 
184
        if url.startswith('lp:'):
 
185
            return True
 
186
        regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
 
187
                           '://bazaar.*.launchpad.net')
 
188
        return bool(regex.match(url))
 
189
 
 
190
    @staticmethod
 
191
    def candidate_urls(bzr_branch):
 
192
        """Iterate through related URLs that might be Launchpad URLs.
 
193
 
 
194
        :param bzr_branch: A Bazaar branch to find URLs from.
 
195
        :return: a generator of URL strings.
 
196
        """
 
197
        url = bzr_branch.get_public_branch()
 
198
        if url is not None:
 
199
            yield url
 
200
        url = bzr_branch.get_push_location()
 
201
        if url is not None:
 
202
            yield url
 
203
        url = bzr_branch.get_parent()
 
204
        if url is not None:
 
205
            yield url
 
206
        yield bzr_branch.base
 
207
 
 
208
    @staticmethod
 
209
    def tweak_url(url, launchpad):
 
210
        """Adjust a URL to work with staging, if needed."""
 
211
        if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
 
212
            return url.replace('bazaar.launchpad.net',
 
213
                               'bazaar.staging.launchpad.net')
 
214
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
 
215
            return url.replace('bazaar.launchpad.net',
 
216
                               'bazaar.qastaging.launchpad.net')
 
217
        return url
 
218
 
 
219
    @classmethod
 
220
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
221
        """Find a Launchpad branch from a bzr branch."""
 
222
        check_update = True
 
223
        for url in cls.candidate_urls(bzr_branch):
 
224
            url = cls.tweak_url(url, launchpad)
 
225
            if not cls.plausible_launchpad_url(url):
 
226
                continue
 
227
            lp_branch = launchpad.branches.getByUrl(url=url)
 
228
            if lp_branch is not None:
 
229
                break
 
230
        else:
 
231
            if not create_missing:
 
232
                raise NoLaunchpadBranch(bzr_branch)
 
233
            lp_branch = cls.create_now(launchpad, bzr_branch)
 
234
            check_update = False
 
235
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
 
236
 
 
237
    @classmethod
 
238
    def create_now(cls, launchpad, bzr_branch):
 
239
        """Create a Bazaar branch on Launchpad for the supplied branch."""
 
240
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
 
241
        if not cls.plausible_launchpad_url(url):
 
242
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
243
                                  bzr_branch.base)
 
244
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
 
245
        lp_branch = launchpad.branches.getByUrl(url=url)
 
246
        if lp_branch is None:
 
247
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
248
                                  url)
 
249
        return lp_branch
 
250
 
 
251
    def get_target(self):
 
252
        """Return the 'LaunchpadBranch' for the target of this one."""
 
253
        lp_branch = self.lp
 
254
        if lp_branch.project is not None:
 
255
            dev_focus = lp_branch.project.development_focus
 
256
            if dev_focus is None:
 
257
                raise errors.BzrError(gettext('%s has no development focus.') %
 
258
                                      lp_branch.bzr_identity)
 
259
            target = dev_focus.branch
 
260
            if target is None:
 
261
                raise errors.BzrError(gettext(
 
262
                    'development focus %s has no branch.') % dev_focus)
 
263
        elif lp_branch.sourcepackage is not None:
 
264
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
 
265
            if target is None:
 
266
                raise errors.BzrError(gettext(
 
267
                                      'source package %s has no branch.') %
 
268
                                      lp_branch.sourcepackage)
 
269
        else:
 
270
            raise errors.BzrError(gettext(
 
271
                '%s has no associated product or source package.') %
 
272
                lp_branch.bzr_identity)
 
273
        return LaunchpadBranch(target, target.bzr_identity)
 
274
 
 
275
    def update_lp(self):
 
276
        """Update the Launchpad copy of this branch."""
 
277
        if not self._check_update:
 
278
            return
 
279
        with self.bzr.lock_read():
 
280
            if self.lp.last_scanned_id is not None:
 
281
                if self.bzr.last_revision() == self.lp.last_scanned_id:
 
282
                    trace.note(gettext('%s is already up-to-date.') %
 
283
                               self.lp.bzr_identity)
 
284
                    return
 
285
                graph = self.bzr.repository.get_graph()
 
286
                if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
 
287
                                         self.bzr.last_revision()):
 
288
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
 
289
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
290
            self.bzr.push(self.push_bzr)
 
291
 
 
292
    def find_lca_tree(self, other):
 
293
        """Find the revision tree for the LCA of this branch and other.
 
294
 
 
295
        :param other: Another LaunchpadBranch
 
296
        :return: The RevisionTree of the LCA of this branch and other.
 
297
        """
 
298
        graph = self.bzr.repository.get_graph(other.bzr.repository)
 
299
        lca = graph.find_unique_lca(self.bzr.last_revision(),
 
300
                                    other.bzr.last_revision())
 
301
        return self.bzr.repository.revision_tree(lca)
 
302
 
 
303
 
 
304
def canonical_url(object):
 
305
    """Return the canonical URL for a branch."""
 
306
    scheme, netloc, path, params, query, fragment = urlparse(
 
307
        str(object.self_link))
 
308
    path = '/'.join(path.split('/')[2:])
 
309
    netloc = netloc.replace('api.', 'code.')
 
310
    return urlunparse((scheme, netloc, path, params, query, fragment))