/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-21 13:20:17 UTC
  • mfrom: (6733.1.1 move-errors-config)
  • Revision ID: jelmer@jelmer.uk-20170721132017-oratmmxasovq4r1q
Merge lp:~jelmer/brz/move-errors-config.

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 httplib2
 
27
import os
 
28
import re
 
29
import urlparse
 
30
 
 
31
from ... import (
 
32
    branch,
 
33
    config,
 
34
    errors,
 
35
    osutils,
 
36
    trace,
 
37
    transport,
 
38
    )
 
39
from ...i18n import gettext
 
40
from .lp_registration import (
 
41
    InvalidLaunchpadInstance,
 
42
    )
 
43
 
 
44
try:
 
45
    import launchpadlib
 
46
except ImportError as e:
 
47
    raise errors.DependencyNotPresent('launchpadlib', e)
 
48
 
 
49
from launchpadlib.launchpad import (
 
50
    STAGING_SERVICE_ROOT,
 
51
    Launchpad,
 
52
    )
 
53
from launchpadlib import uris
 
54
 
 
55
# Declare the minimum version of launchpadlib that we need in order to work.
 
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)
 
59
 
 
60
 
 
61
def get_cache_directory():
 
62
    """Return the directory to cache launchpadlib objects in."""
 
63
    return osutils.pathjoin(config.config_dir(), 'launchpad')
 
64
 
 
65
 
 
66
def parse_launchpadlib_version(version_number):
 
67
    """Parse a version number of the style used by launchpadlib."""
 
68
    return tuple(map(int, version_number.split('.')))
 
69
 
 
70
 
 
71
def check_launchpadlib_compatibility():
 
72
    """Raise an error if launchpadlib has the wrong version number."""
 
73
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
 
74
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
 
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')
 
89
 
 
90
 
 
91
def _get_api_url(service):
 
92
    """Return the root URL of the Launchpad API.
 
93
 
 
94
    e.g. For the 'staging' Launchpad service, this function returns
 
95
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
 
96
 
 
97
    :param service: A `LaunchpadService` object.
 
98
    :return: A URL as a string.
 
99
    """
 
100
    if service._lp_instance is None:
 
101
        lp_instance = service.DEFAULT_INSTANCE
 
102
    else:
 
103
        lp_instance = service._lp_instance
 
104
    try:
 
105
        return lookup_service_root(lp_instance)
 
106
    except ValueError:
 
107
        raise InvalidLaunchpadInstance(lp_instance)
 
108
 
 
109
 
 
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):
 
119
    """Log in to the Launchpad API.
 
120
 
 
121
    :return: The root `Launchpad` object from launchpadlib.
 
122
    """
 
123
    if proxy_info is None:
 
124
        proxy_info = httplib2.proxy_info_from_environment('https')
 
125
    cache_directory = get_cache_directory()
 
126
    launchpad = Launchpad.login_with(
 
127
        'bzr', _get_api_url(service), cache_directory, timeout=timeout,
 
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)
 
132
    return launchpad
 
133
 
 
134
 
 
135
class LaunchpadBranch(object):
 
136
    """Provide bzr and lp API access to a Launchpad branch."""
 
137
 
 
138
    def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
 
139
        """Constructor.
 
140
 
 
141
        :param lp_branch: The Launchpad branch.
 
142
        :param bzr_url: The URL of the Bazaar branch.
 
143
        :param bzr_branch: An instance of the Bazaar branch.
 
144
        """
 
145
        self.bzr_url = bzr_url
 
146
        self._bzr = bzr_branch
 
147
        self._push_bzr = None
 
148
        self._check_update = check_update
 
149
        self.lp = lp_branch
 
150
 
 
151
    @property
 
152
    def bzr(self):
 
153
        """Return the bzr branch for this branch."""
 
154
        if self._bzr is None:
 
155
            self._bzr = branch.Branch.open(self.bzr_url)
 
156
        return self._bzr
 
157
 
 
158
    @property
 
159
    def push_bzr(self):
 
160
        """Return the push branch for this branch."""
 
161
        if self._push_bzr is None:
 
162
            self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
 
163
        return self._push_bzr
 
164
 
 
165
    @staticmethod
 
166
    def plausible_launchpad_url(url):
 
167
        """Is 'url' something that could conceivably be pushed to LP?
 
168
 
 
169
        :param url: A URL that may refer to a Launchpad branch.
 
170
        :return: A boolean.
 
171
        """
 
172
        if url is None:
 
173
            return False
 
174
        if url.startswith('lp:'):
 
175
            return True
 
176
        regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
 
177
                           '://bazaar.*.launchpad.net')
 
178
        return bool(regex.match(url))
 
179
 
 
180
    @staticmethod
 
181
    def candidate_urls(bzr_branch):
 
182
        """Iterate through related URLs that might be Launchpad URLs.
 
183
 
 
184
        :param bzr_branch: A Bazaar branch to find URLs from.
 
185
        :return: a generator of URL strings.
 
186
        """
 
187
        url = bzr_branch.get_public_branch()
 
188
        if url is not None:
 
189
            yield url
 
190
        url = bzr_branch.get_push_location()
 
191
        if url is not None:
 
192
            yield url
 
193
        url = bzr_branch.get_parent()
 
194
        if url is not None:
 
195
            yield url
 
196
        yield bzr_branch.base
 
197
 
 
198
    @staticmethod
 
199
    def tweak_url(url, launchpad):
 
200
        """Adjust a URL to work with staging, if needed."""
 
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
 
208
 
 
209
    @classmethod
 
210
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
211
        """Find a Launchpad branch from a bzr branch."""
 
212
        check_update = True
 
213
        for url in cls.candidate_urls(bzr_branch):
 
214
            url = cls.tweak_url(url, launchpad)
 
215
            if not cls.plausible_launchpad_url(url):
 
216
                continue
 
217
            lp_branch = launchpad.branches.getByUrl(url=url)
 
218
            if lp_branch is not None:
 
219
                break
 
220
        else:
 
221
            if not create_missing:
 
222
                raise NoLaunchpadBranch(bzr_branch)
 
223
            lp_branch = cls.create_now(launchpad, bzr_branch)
 
224
            check_update = False
 
225
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
 
226
 
 
227
    @classmethod
 
228
    def create_now(cls, launchpad, bzr_branch):
 
229
        """Create a Bazaar branch on Launchpad for the supplied branch."""
 
230
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
 
231
        if not cls.plausible_launchpad_url(url):
 
232
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
233
                                  bzr_branch.base)
 
234
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
 
235
        lp_branch = launchpad.branches.getByUrl(url=url)
 
236
        if lp_branch is None:
 
237
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
238
                                                                            url)
 
239
        return lp_branch
 
240
 
 
241
    def get_target(self):
 
242
        """Return the 'LaunchpadBranch' for the target of this one."""
 
243
        lp_branch = self.lp
 
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)
 
264
 
 
265
    def update_lp(self):
 
266
        """Update the Launchpad copy of this branch."""
 
267
        if not self._check_update:
 
268
            return
 
269
        self.bzr.lock_read()
 
270
        try:
 
271
            if self.lp.last_scanned_id is not None:
 
272
                if self.bzr.last_revision() == self.lp.last_scanned_id:
 
273
                    trace.note(gettext('%s is already up-to-date.') %
 
274
                               self.lp.bzr_identity)
 
275
                    return
 
276
                graph = self.bzr.repository.get_graph()
 
277
                if not graph.is_ancestor(self.lp.last_scanned_id,
 
278
                                         self.bzr.last_revision()):
 
279
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
 
280
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
281
            self.bzr.push(self.push_bzr)
 
282
        finally:
 
283
            self.bzr.unlock()
 
284
 
 
285
    def find_lca_tree(self, other):
 
286
        """Find the revision tree for the LCA of this branch and other.
 
287
 
 
288
        :param other: Another LaunchpadBranch
 
289
        :return: The RevisionTree of the LCA of this branch and other.
 
290
        """
 
291
        graph = self.bzr.repository.get_graph(other.bzr.repository)
 
292
        lca = graph.find_unique_lca(self.bzr.last_revision(),
 
293
                                    other.bzr.last_revision())
 
294
        return self.bzr.repository.revision_tree(lca)
 
295
 
 
296
 
 
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))