← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/lp_api.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 06:14:37 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013061437-2e2m9gro1eusnbb8
Tweaks to the sphinx build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_api.py
16
16
 
17
17
"""Tools for dealing with the Launchpad API."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
# Importing this module will be expensive, since it imports launchpadlib and
22
20
# its dependencies. However, our plan is to only load this module when it is
23
21
# needed by a command that uses it.
25
23
 
26
24
import os
27
25
import re
28
 
import urlparse
29
26
 
30
27
from bzrlib import (
31
28
    branch,
35
32
    trace,
36
33
    transport,
37
34
    )
38
 
from bzrlib.i18n import gettext
39
35
from bzrlib.plugins.launchpad.lp_registration import (
40
36
    InvalidLaunchpadInstance,
 
37
    NotLaunchpadBranch,
41
38
    )
42
39
 
43
40
try:
46
43
    raise errors.DependencyNotPresent('launchpadlib', e)
47
44
 
48
45
from launchpadlib.launchpad import (
 
46
    EDGE_SERVICE_ROOT,
49
47
    STAGING_SERVICE_ROOT,
50
48
    Launchpad,
51
49
    )
76
74
            installed_version, installed_version)
77
75
 
78
76
 
79
 
# The older versions of launchpadlib only provided service root constants for
80
 
# edge and staging, whilst newer versions drop edge. Therefore service root
81
 
# URIs for which we do not always have constants are derived from the staging
82
 
# one, which does always exist.
83
 
#
84
 
# It is necessary to derive, rather than use hardcoded URIs because
85
 
# launchpadlib <= 1.5.4 requires service root URIs that end in a path of
86
 
# /beta/, whilst launchpadlib >= 1.5.5 requires service root URIs with no path
87
 
# info.
88
 
#
89
 
# Once we have a hard dependency on launchpadlib >= 1.5.4 we can replace all of
90
 
# bzr's local knowledge of individual Launchpad instances with use of the
91
 
# launchpadlib.uris module.
92
77
LAUNCHPAD_API_URLS = {
93
 
    'production': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
94
 
        'api.launchpad.net'),
95
 
    'qastaging': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
96
 
        'api.qastaging.launchpad.net'),
 
78
    'production': 'https://api.launchpad.net/beta/',
 
79
    'edge': EDGE_SERVICE_ROOT,
97
80
    'staging': STAGING_SERVICE_ROOT,
98
 
    'dev': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
99
 
        'api.launchpad.dev'),
 
81
    'dev': 'https://api.launchpad.dev/beta/',
100
82
    }
101
83
 
102
84
 
103
85
def _get_api_url(service):
104
86
    """Return the root URL of the Launchpad API.
105
87
 
106
 
    e.g. For the 'staging' Launchpad service, this function returns
107
 
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
 
88
    e.g. For the 'edge' Launchpad service, this function returns
 
89
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
108
90
 
109
91
    :param service: A `LaunchpadService` object.
110
92
    :return: A URL as a string.
119
101
        raise InvalidLaunchpadInstance(lp_instance)
120
102
 
121
103
 
122
 
class NoLaunchpadBranch(errors.BzrError):
123
 
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
124
 
 
125
 
    def __init__(self, branch):
126
 
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
127
 
 
128
 
 
129
104
def login(service, timeout=None, proxy_info=None):
130
105
    """Log in to the Launchpad API.
131
106
 
137
112
        proxy_info=proxy_info)
138
113
    # XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
139
114
    # create this directory with default umask.
140
 
    osutils.chmod_if_possible(cache_directory, 0700)
 
115
    os.chmod(cache_directory, 0700)
141
116
    return launchpad
142
117
 
143
118
 
199
174
        url = bzr_branch.get_push_location()
200
175
        if url is not None:
201
176
            yield url
202
 
        url = bzr_branch.get_parent()
203
 
        if url is not None:
204
 
            yield url
205
177
        yield bzr_branch.base
206
178
 
207
179
    @staticmethod
208
180
    def tweak_url(url, launchpad):
209
181
        """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) == LAUNCHPAD_API_URLS['qastaging']:
214
 
            return url.replace('bazaar.launchpad.net',
215
 
                               'bazaar.qastaging.launchpad.net')
216
 
        return url
 
182
        if str(launchpad._root_uri) != STAGING_SERVICE_ROOT:
 
183
            return url
 
184
        if url is None:
 
185
            return None
 
186
        return url.replace('bazaar.launchpad.net',
 
187
                           'bazaar.staging.launchpad.net')
217
188
 
218
189
    @classmethod
219
 
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
190
    def from_bzr(cls, launchpad, bzr_branch):
220
191
        """Find a Launchpad branch from a bzr branch."""
221
192
        check_update = True
222
193
        for url in cls.candidate_urls(bzr_branch):
227
198
            if lp_branch is not None:
228
199
                break
229
200
        else:
230
 
            if not create_missing:
231
 
                raise NoLaunchpadBranch(bzr_branch)
232
201
            lp_branch = cls.create_now(launchpad, bzr_branch)
233
202
            check_update = False
234
203
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
238
207
        """Create a Bazaar branch on Launchpad for the supplied branch."""
239
208
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
240
209
        if not cls.plausible_launchpad_url(url):
241
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
210
            raise errors.BzrError('%s is not registered on Launchpad' %
242
211
                                  bzr_branch.base)
243
212
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
244
213
        lp_branch = launchpad.branches.getByUrl(url=url)
245
214
        if lp_branch is None:
246
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
247
 
                                                                            url)
 
215
            raise errors.BzrError('%s is not registered on Launchpad' % url)
248
216
        return lp_branch
249
217
 
250
 
    def get_target(self):
251
 
        """Return the 'LaunchpadBranch' for the target of this one."""
 
218
    def get_dev_focus(self):
 
219
        """Return the 'LaunchpadBranch' for the dev focus of this one."""
252
220
        lp_branch = self.lp
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
259
 
            if target is None:
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")
264
 
            if target is None:
265
 
                raise errors.BzrError(gettext(
266
 
                                      'source package %s has no branch.') %
267
 
                                      lp_branch.sourcepackage)
268
 
        else:
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)
 
221
        if lp_branch.project is None:
 
222
            raise errors.BzrError('%s has no product.' %
 
223
                                  lp_branch.bzr_identity)
 
224
        dev_focus = lp_branch.project.development_focus.branch
 
225
        if dev_focus is None:
 
226
            raise errors.BzrError('%s has no development focus.' %
 
227
                                  lp_branch.bzr_identity)
 
228
        return LaunchpadBranch(dev_focus, dev_focus.bzr_identity)
273
229
 
274
230
    def update_lp(self):
275
231
        """Update the Launchpad copy of this branch."""
279
235
        try:
280
236
            if self.lp.last_scanned_id is not None:
281
237
                if self.bzr.last_revision() == self.lp.last_scanned_id:
282
 
                    trace.note(gettext('%s is already up-to-date.') %
 
238
                    trace.note('%s is already up-to-date.' %
283
239
                               self.lp.bzr_identity)
284
240
                    return
285
241
                graph = self.bzr.repository.get_graph()
286
242
                if not graph.is_ancestor(self.lp.last_scanned_id,
287
243
                                         self.bzr.last_revision()):
288
244
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
289
 
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
245
                trace.note('Pushing to %s' % self.lp.bzr_identity)
290
246
            self.bzr.push(self.push_bzr)
291
247
        finally:
292
248
            self.bzr.unlock()
303
259
        return self.bzr.repository.revision_tree(lca)
304
260
 
305
261
 
306
 
def canonical_url(object):
307
 
    """Return the canonical URL for a branch."""
308
 
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
309
 
        str(object.self_link))
310
 
    path = '/'.join(path.split('/')[2:])
311
 
    netloc = netloc.replace('api.', 'code.')
312
 
    return urlparse.urlunparse((scheme, netloc, path, params, query,
313
 
                                fragment))
 
262
def load_branch(launchpad, branch):
 
263
    """Return the launchpadlib Branch object corresponding to 'branch'.
 
264
 
 
265
    :param launchpad: The root `Launchpad` object from launchpadlib.
 
266
    :param branch: A `bzrlib.branch.Branch`.
 
267
    :raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
 
268
        `branch`.
 
269
    :return: A launchpadlib Branch object.
 
270
    """
 
271
    # XXX: This duplicates the "What are possible URLs for the branch that
 
272
    # Launchpad might recognize" logic found in cmd_lp_open.
 
273
 
 
274
    # XXX: This makes multiple roundtrips to Launchpad for what is
 
275
    # conceptually a single operation -- get me the branches that match these
 
276
    # URLs. Unfortunately, Launchpad's support for such operations is poor, so
 
277
    # we have to allow multiple roundtrips.
 
278
    for url in branch.get_public_branch(), branch.get_push_location():
 
279
        lp_branch = launchpad.branches.getByUrl(url=url)
 
280
        if lp_branch:
 
281
            return lp_branch
 
282
    raise NotLaunchpadBranch(url)