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.
27
from urllib.parse import (
40
from ...i18n import gettext
43
class LaunchpadlibMissing(errors.DependencyNotPresent):
45
_fmt = ("launchpadlib is required for Launchpad API access. "
46
"Please install the launchpadlib package.")
48
def __init__(self, e):
49
super(LaunchpadlibMissing, self).__init__(
54
except ImportError as e:
55
raise LaunchpadlibMissing(e)
57
from launchpadlib.launchpad import (
60
from launchpadlib import uris
62
# Declare the minimum version of launchpadlib that we need in order to work.
63
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
66
def get_cache_directory():
67
"""Return the directory to cache launchpadlib objects in."""
68
return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
71
def parse_launchpadlib_version(version_number):
72
"""Parse a version number of the style used by launchpadlib."""
73
return tuple(map(int, version_number.split('.')))
76
def check_launchpadlib_compatibility():
77
"""Raise an error if launchpadlib has the wrong version number."""
78
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
79
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
80
raise errors.DependencyNotPresent(
82
'At least launchpadlib %s is required, but installed version is %s'
83
% (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
86
def lookup_service_root(service_root):
88
return uris.lookup_service_root(service_root)
90
if service_root != 'qastaging':
92
staging_root = uris.lookup_service_root('staging')
93
return staging_root.replace('staging', 'qastaging')
96
class NoLaunchpadBranch(errors.BzrError):
97
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
99
def __init__(self, branch):
100
errors.BzrError.__init__(self, branch=branch, url=branch.base)
103
def connect_launchpad(base_url, timeout=None, proxy_info=None,
104
version=Launchpad.DEFAULT_VERSION):
105
"""Log in to the Launchpad API.
107
:return: The root `Launchpad` object from launchpadlib.
109
if proxy_info is None:
111
proxy_info = httplib2.proxy_info_from_environment('https')
113
cache_directory = get_cache_directory()
114
except EnvironmentError:
115
cache_directory = None
116
return Launchpad.login_with(
117
'breezy', base_url, cache_directory, timeout=timeout,
118
proxy_info=proxy_info, version=version)
122
class LaunchpadBranch(object):
123
"""Provide bzr and lp API access to a Launchpad branch."""
125
def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
128
:param lp_branch: The Launchpad branch.
129
:param bzr_url: The URL of the Bazaar branch.
130
:param bzr_branch: An instance of the Bazaar branch.
132
self.bzr_url = bzr_url
133
self._bzr = bzr_branch
134
self._push_bzr = None
135
self._check_update = check_update
140
"""Return the bzr branch for this branch."""
141
if self._bzr is None:
142
self._bzr = branch.Branch.open(self.bzr_url)
147
"""Return the push branch for this branch."""
148
if self._push_bzr is None:
149
self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
150
return self._push_bzr
153
def plausible_launchpad_url(url):
154
"""Is 'url' something that could conceivably be pushed to LP?
156
:param url: A URL that may refer to a Launchpad branch.
161
if url.startswith('lp:'):
163
regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
164
'://bazaar.*.launchpad.net')
165
return bool(regex.match(url))
168
def candidate_urls(bzr_branch):
169
"""Iterate through related URLs that might be Launchpad URLs.
171
:param bzr_branch: A Bazaar branch to find URLs from.
172
:return: a generator of URL strings.
174
url = bzr_branch.get_public_branch()
177
url = bzr_branch.get_push_location()
180
url = bzr_branch.get_parent()
183
yield bzr_branch.base
186
def tweak_url(url, launchpad):
187
"""Adjust a URL to work with staging, if needed."""
188
if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
189
return url.replace('bazaar.launchpad.net',
190
'bazaar.staging.launchpad.net')
191
elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
192
return url.replace('bazaar.launchpad.net',
193
'bazaar.qastaging.launchpad.net')
197
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
198
"""Find a Launchpad branch from a bzr branch."""
200
for url in cls.candidate_urls(bzr_branch):
201
url = cls.tweak_url(url, launchpad)
202
if not cls.plausible_launchpad_url(url):
204
lp_branch = launchpad.branches.getByUrl(url=url)
205
if lp_branch is not None:
208
if not create_missing:
209
raise NoLaunchpadBranch(bzr_branch)
210
lp_branch = cls.create_now(launchpad, bzr_branch)
212
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
215
def create_now(cls, launchpad, bzr_branch):
216
"""Create a Bazaar branch on Launchpad for the supplied branch."""
217
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
218
if not cls.plausible_launchpad_url(url):
219
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
221
bzr_branch.create_clone_on_transport(transport.get_transport(url))
222
lp_branch = launchpad.branches.getByUrl(url=url)
223
if lp_branch is None:
224
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
228
def get_target(self):
229
"""Return the 'LaunchpadBranch' for the target of this one."""
231
if lp_branch.project is not None:
232
dev_focus = lp_branch.project.development_focus
233
if dev_focus is None:
234
raise errors.BzrError(gettext('%s has no development focus.') %
235
lp_branch.bzr_identity)
236
target = dev_focus.branch
238
raise errors.BzrError(gettext(
239
'development focus %s has no branch.') % dev_focus)
240
elif lp_branch.sourcepackage is not None:
241
target = lp_branch.sourcepackage.getBranch(pocket="Release")
243
raise errors.BzrError(gettext(
244
'source package %s has no branch.') %
245
lp_branch.sourcepackage)
247
raise errors.BzrError(gettext(
248
'%s has no associated product or source package.') %
249
lp_branch.bzr_identity)
250
return LaunchpadBranch(target, target.bzr_identity)
253
"""Update the Launchpad copy of this branch."""
254
if not self._check_update:
256
with self.bzr.lock_read():
257
if self.lp.last_scanned_id is not None:
258
if self.bzr.last_revision() == self.lp.last_scanned_id:
259
trace.note(gettext('%s is already up-to-date.') %
260
self.lp.bzr_identity)
262
graph = self.bzr.repository.get_graph()
263
if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
264
self.bzr.last_revision()):
265
raise errors.DivergedBranches(self.bzr, self.push_bzr)
266
trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
267
self.bzr.push(self.push_bzr)
269
def find_lca_tree(self, other):
270
"""Find the revision tree for the LCA of this branch and other.
272
:param other: Another LaunchpadBranch
273
:return: The RevisionTree of the LCA of this branch and other.
275
graph = self.bzr.repository.get_graph(other.bzr.repository)
276
lca = graph.find_unique_lca(self.bzr.last_revision(),
277
other.bzr.last_revision())
278
return self.bzr.repository.revision_tree(lca)
281
def canonical_url(object):
282
"""Return the canonical URL for a branch."""
283
scheme, netloc, path, params, query, fragment = urlparse(
284
str(object.self_link))
285
path = '/'.join(path.split('/')[2:])
286
netloc = netloc.replace('api.', 'code.')
287
return urlunparse((scheme, netloc, path, params, query, fragment))
added
removed
breezy/plugins/launchpad/lp_api.py
