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
# Importing this module will be expensive, since it imports launchpadlib and
20
# its dependencies. However, our plan is to only load this module when it is
21
# needed by a command that uses it.
25
from urllib.parse import (
38
from ...i18n import gettext
41
class LaunchpadlibMissing(errors.DependencyNotPresent):
43
_fmt = ("launchpadlib is required for Launchpad API access. "
44
"Please install the launchpadlib package.")
46
def __init__(self, e):
47
super(LaunchpadlibMissing, self).__init__(
52
except ImportError as e:
53
raise LaunchpadlibMissing(e)
55
from launchpadlib.launchpad import (
58
from launchpadlib import uris
60
# Declare the minimum version of launchpadlib that we need in order to work.
61
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
64
def get_cache_directory():
65
"""Return the directory to cache launchpadlib objects in."""
66
return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
69
def parse_launchpadlib_version(version_number):
70
"""Parse a version number of the style used by launchpadlib."""
71
return tuple(map(int, version_number.split('.')))
74
def check_launchpadlib_compatibility():
75
"""Raise an error if launchpadlib has the wrong version number."""
76
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
77
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
78
raise errors.DependencyNotPresent(
80
'At least launchpadlib %s is required, but installed version is %s'
81
% (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
84
def lookup_service_root(service_root):
86
return uris.lookup_service_root(service_root)
88
if service_root != 'qastaging':
90
staging_root = uris.lookup_service_root('staging')
91
return staging_root.replace('staging', 'qastaging')
94
class NoLaunchpadBranch(errors.BzrError):
95
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
97
def __init__(self, branch):
98
errors.BzrError.__init__(self, branch=branch, url=branch.base)
101
def connect_launchpad(base_url, timeout=None, proxy_info=None,
102
version=Launchpad.DEFAULT_VERSION):
103
"""Log in to the Launchpad API.
105
:return: The root `Launchpad` object from launchpadlib.
107
if proxy_info is None:
109
proxy_info = httplib2.proxy_info_from_environment('https')
111
cache_directory = get_cache_directory()
112
except EnvironmentError:
113
cache_directory = None
114
return Launchpad.login_with(
115
'breezy', base_url, cache_directory, timeout=timeout,
116
proxy_info=proxy_info, version=version)
120
class LaunchpadBranch(object):
121
"""Provide bzr and lp API access to a Launchpad branch."""
123
def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
126
:param lp_branch: The Launchpad branch.
127
:param bzr_url: The URL of the Bazaar branch.
128
:param bzr_branch: An instance of the Bazaar branch.
130
self.bzr_url = bzr_url
131
self._bzr = bzr_branch
132
self._push_bzr = None
133
self._check_update = check_update
138
"""Return the bzr branch for this branch."""
139
if self._bzr is None:
140
self._bzr = branch.Branch.open(self.bzr_url)
145
"""Return the push branch for this branch."""
146
if self._push_bzr is None:
147
self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
148
return self._push_bzr
151
def plausible_launchpad_url(url):
152
"""Is 'url' something that could conceivably be pushed to LP?
154
:param url: A URL that may refer to a Launchpad branch.
159
if url.startswith('lp:'):
161
regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
162
'://bazaar.*.launchpad.net')
163
return bool(regex.match(url))
166
def candidate_urls(bzr_branch):
167
"""Iterate through related URLs that might be Launchpad URLs.
169
:param bzr_branch: A Bazaar branch to find URLs from.
170
:return: a generator of URL strings.
172
url = bzr_branch.get_public_branch()
175
url = bzr_branch.get_push_location()
178
url = bzr_branch.get_parent()
181
yield bzr_branch.base
184
def tweak_url(url, launchpad):
185
"""Adjust a URL to work with staging, if needed."""
186
if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
187
return url.replace('bazaar.launchpad.net',
188
'bazaar.staging.launchpad.net')
189
elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
190
return url.replace('bazaar.launchpad.net',
191
'bazaar.qastaging.launchpad.net')
195
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
196
"""Find a Launchpad branch from a bzr branch."""
198
for url in cls.candidate_urls(bzr_branch):
199
url = cls.tweak_url(url, launchpad)
200
if not cls.plausible_launchpad_url(url):
202
lp_branch = launchpad.branches.getByUrl(url=url)
203
if lp_branch is not None:
206
if not create_missing:
207
raise NoLaunchpadBranch(bzr_branch)
208
lp_branch = cls.create_now(launchpad, bzr_branch)
210
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
213
def create_now(cls, launchpad, bzr_branch):
214
"""Create a Bazaar branch on Launchpad for the supplied branch."""
215
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
216
if not cls.plausible_launchpad_url(url):
217
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
219
bzr_branch.create_clone_on_transport(transport.get_transport(url))
220
lp_branch = launchpad.branches.getByUrl(url=url)
221
if lp_branch is None:
222
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
226
def get_target(self):
227
"""Return the 'LaunchpadBranch' for the target of this one."""
229
if lp_branch.project is not None:
230
dev_focus = lp_branch.project.development_focus
231
if dev_focus is None:
232
raise errors.BzrError(gettext('%s has no development focus.') %
233
lp_branch.bzr_identity)
234
target = dev_focus.branch
236
raise errors.BzrError(gettext(
237
'development focus %s has no branch.') % dev_focus)
238
elif lp_branch.sourcepackage is not None:
239
target = lp_branch.sourcepackage.getBranch(pocket="Release")
241
raise errors.BzrError(gettext(
242
'source package %s has no branch.') %
243
lp_branch.sourcepackage)
245
raise errors.BzrError(gettext(
246
'%s has no associated product or source package.') %
247
lp_branch.bzr_identity)
248
return LaunchpadBranch(target, target.bzr_identity)
251
"""Update the Launchpad copy of this branch."""
252
if not self._check_update:
254
with self.bzr.lock_read():
255
if self.lp.last_scanned_id is not None:
256
if self.bzr.last_revision() == self.lp.last_scanned_id:
257
trace.note(gettext('%s is already up-to-date.') %
258
self.lp.bzr_identity)
260
graph = self.bzr.repository.get_graph()
261
if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
262
self.bzr.last_revision()):
263
raise errors.DivergedBranches(self.bzr, self.push_bzr)
264
trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
265
self.bzr.push(self.push_bzr)
267
def find_lca_tree(self, other):
268
"""Find the revision tree for the LCA of this branch and other.
270
:param other: Another LaunchpadBranch
271
:return: The RevisionTree of the LCA of this branch and other.
273
graph = self.bzr.repository.get_graph(other.bzr.repository)
274
lca = graph.find_unique_lca(self.bzr.last_revision(),
275
other.bzr.last_revision())
276
return self.bzr.repository.revision_tree(lca)
279
def canonical_url(object):
280
"""Return the canonical URL for a branch."""
281
scheme, netloc, path, params, query, fragment = urlparse(
282
str(object.self_link))
283
path = '/'.join(path.split('/')[2:])
284
netloc = netloc.replace('api.', 'code.')
285
return urlunparse((scheme, netloc, path, params, query, fragment))
added
removed
breezy/plugins/launchpad/lp_api.py
