1
# Copyright (C) 2009-2012 Canonical Ltd
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.
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.
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
17
"""Tools for dealing with the Launchpad API."""
19
from __future__ import absolute_import
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.
30
from urllib.parse import (
34
except ImportError: # python < 3
35
from urlparse import (
48
from ...i18n import gettext
49
from .lp_registration import (
50
InvalidLaunchpadInstance,
55
except ImportError as e:
56
raise errors.DependencyNotPresent('launchpadlib', e)
58
from launchpadlib.launchpad import (
62
from launchpadlib import uris
64
# Declare the minimum version of launchpadlib that we need in order to work.
65
# 1.6.0 is the version of launchpadlib packaged in Ubuntu 10.04, the most
66
# recent Ubuntu LTS release supported on the desktop at the time of writing.
67
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 0)
70
def get_cache_directory():
71
"""Return the directory to cache launchpadlib objects in."""
72
return osutils.pathjoin(config.config_dir(), 'launchpad')
75
def parse_launchpadlib_version(version_number):
76
"""Parse a version number of the style used by launchpadlib."""
77
return tuple(map(int, version_number.split('.')))
80
def check_launchpadlib_compatibility():
81
"""Raise an error if launchpadlib has the wrong version number."""
82
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
83
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
84
raise errors.DependencyNotPresent(
86
'At least launchpadlib %s is required, but installed version is %s'
87
% (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
90
def lookup_service_root(service_root):
92
return uris.lookup_service_root(service_root)
94
if service_root != 'qastaging':
96
staging_root = uris.lookup_service_root('staging')
97
return staging_root.replace('staging', 'qastaging')
100
def _get_api_url(service):
101
"""Return the root URL of the Launchpad API.
103
e.g. For the 'staging' Launchpad service, this function returns
104
launchpadlib.launchpad.STAGING_SERVICE_ROOT.
106
:param service: A `LaunchpadService` object.
107
:return: A URL as a string.
109
if service._lp_instance is None:
110
lp_instance = service.DEFAULT_INSTANCE
112
lp_instance = service._lp_instance
114
return lookup_service_root(lp_instance)
116
raise InvalidLaunchpadInstance(lp_instance)
119
class NoLaunchpadBranch(errors.BzrError):
120
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
122
def __init__(self, branch):
123
errors.BzrError.__init__(self, branch=branch, url=branch.base)
126
def login(service, timeout=None, proxy_info=None,
127
version=Launchpad.DEFAULT_VERSION):
128
"""Log in to the Launchpad API.
130
:return: The root `Launchpad` object from launchpadlib.
132
if proxy_info is None:
133
proxy_info = httplib2.proxy_info_from_environment('https')
134
cache_directory = get_cache_directory()
135
launchpad = Launchpad.login_with(
136
'bzr', _get_api_url(service), cache_directory, timeout=timeout,
137
proxy_info=proxy_info, version=version)
138
# XXX: Work-around a minor security bug in launchpadlib < 1.6.3, which
139
# would create this directory with default umask.
140
osutils.chmod_if_possible(cache_directory, 0o700)
144
class LaunchpadBranch(object):
145
"""Provide bzr and lp API access to a Launchpad branch."""
147
def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
150
:param lp_branch: The Launchpad branch.
151
:param bzr_url: The URL of the Bazaar branch.
152
:param bzr_branch: An instance of the Bazaar branch.
154
self.bzr_url = bzr_url
155
self._bzr = bzr_branch
156
self._push_bzr = None
157
self._check_update = check_update
162
"""Return the bzr branch for this branch."""
163
if self._bzr is None:
164
self._bzr = branch.Branch.open(self.bzr_url)
169
"""Return the push branch for this branch."""
170
if self._push_bzr is None:
171
self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
172
return self._push_bzr
175
def plausible_launchpad_url(url):
176
"""Is 'url' something that could conceivably be pushed to LP?
178
:param url: A URL that may refer to a Launchpad branch.
183
if url.startswith('lp:'):
185
regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
186
'://bazaar.*.launchpad.net')
187
return bool(regex.match(url))
190
def candidate_urls(bzr_branch):
191
"""Iterate through related URLs that might be Launchpad URLs.
193
:param bzr_branch: A Bazaar branch to find URLs from.
194
:return: a generator of URL strings.
196
url = bzr_branch.get_public_branch()
199
url = bzr_branch.get_push_location()
202
url = bzr_branch.get_parent()
205
yield bzr_branch.base
208
def tweak_url(url, launchpad):
209
"""Adjust a URL to work with staging, if needed."""
210
if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
211
return url.replace('bazaar.launchpad.net',
212
'bazaar.staging.launchpad.net')
213
elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
214
return url.replace('bazaar.launchpad.net',
215
'bazaar.qastaging.launchpad.net')
219
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
220
"""Find a Launchpad branch from a bzr branch."""
222
for url in cls.candidate_urls(bzr_branch):
223
url = cls.tweak_url(url, launchpad)
224
if not cls.plausible_launchpad_url(url):
226
lp_branch = launchpad.branches.getByUrl(url=url)
227
if lp_branch is not None:
230
if not create_missing:
231
raise NoLaunchpadBranch(bzr_branch)
232
lp_branch = cls.create_now(launchpad, bzr_branch)
234
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
237
def create_now(cls, launchpad, bzr_branch):
238
"""Create a Bazaar branch on Launchpad for the supplied branch."""
239
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
240
if not cls.plausible_launchpad_url(url):
241
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
243
bzr_branch.create_clone_on_transport(transport.get_transport(url))
244
lp_branch = launchpad.branches.getByUrl(url=url)
245
if lp_branch is None:
246
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
250
def get_target(self):
251
"""Return the 'LaunchpadBranch' for the target of this one."""
253
if lp_branch.project is not None:
254
dev_focus = lp_branch.project.development_focus
255
if dev_focus is None:
256
raise errors.BzrError(gettext('%s has no development focus.') %
257
lp_branch.bzr_identity)
258
target = dev_focus.branch
260
raise errors.BzrError(gettext(
261
'development focus %s has no branch.') % dev_focus)
262
elif lp_branch.sourcepackage is not None:
263
target = lp_branch.sourcepackage.getBranch(pocket="Release")
265
raise errors.BzrError(gettext(
266
'source package %s has no branch.') %
267
lp_branch.sourcepackage)
269
raise errors.BzrError(gettext(
270
'%s has no associated product or source package.') %
271
lp_branch.bzr_identity)
272
return LaunchpadBranch(target, target.bzr_identity)
275
"""Update the Launchpad copy of this branch."""
276
if not self._check_update:
278
with self.bzr.lock_read():
279
if self.lp.last_scanned_id is not None:
280
if self.bzr.last_revision() == self.lp.last_scanned_id:
281
trace.note(gettext('%s is already up-to-date.') %
282
self.lp.bzr_identity)
284
graph = self.bzr.repository.get_graph()
285
if not graph.is_ancestor(self.lp.last_scanned_id,
286
self.bzr.last_revision()):
287
raise errors.DivergedBranches(self.bzr, self.push_bzr)
288
trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
289
self.bzr.push(self.push_bzr)
291
def find_lca_tree(self, other):
292
"""Find the revision tree for the LCA of this branch and other.
294
:param other: Another LaunchpadBranch
295
:return: The RevisionTree of the LCA of this branch and other.
297
graph = self.bzr.repository.get_graph(other.bzr.repository)
298
lca = graph.find_unique_lca(self.bzr.last_revision(),
299
other.bzr.last_revision())
300
return self.bzr.repository.revision_tree(lca)
303
def canonical_url(object):
304
"""Return the canonical URL for a branch."""
305
scheme, netloc, path, params, query, fragment = urlparse(
306
str(object.self_link))
307
path = '/'.join(path.split('/')[2:])
308
netloc = netloc.replace('api.', 'code.')
309
return urlunparse((scheme, netloc, path, params, query, fragment))
added
removed
breezy/plugins/launchpad/lp_api.py
