← 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-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_api.py
1
 
# Copyright (C) 2009-2012 Canonical Ltd
 
1
# Copyright (C) 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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.
24
22
 
25
23
 
26
 
import httplib2
27
24
import os
28
25
import re
29
 
import urlparse
30
26
 
31
27
from bzrlib import (
32
28
    branch,
36
32
    trace,
37
33
    transport,
38
34
    )
39
 
from bzrlib.i18n import gettext
40
35
from bzrlib.plugins.launchpad.lp_registration import (
41
36
    InvalidLaunchpadInstance,
 
37
    NotLaunchpadBranch,
42
38
    )
43
39
 
44
40
try:
47
43
    raise errors.DependencyNotPresent('launchpadlib', e)
48
44
 
49
45
from launchpadlib.launchpad import (
 
46
    EDGE_SERVICE_ROOT,
50
47
    STAGING_SERVICE_ROOT,
51
48
    Launchpad,
52
49
    )
53
 
from launchpadlib import uris
 
50
 
54
51
 
55
52
# 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)
 
53
# 1.5.1 is the version of launchpadlib packaged in Ubuntu 9.10, the most
 
54
# recent Ubuntu release at the time of writing.
 
55
MINIMUM_LAUNCHPADLIB_VERSION = (1, 5, 1)
59
56
 
60
57
 
61
58
def get_cache_directory():
77
74
            installed_version, installed_version)
78
75
 
79
76
 
80
 
def lookup_service_root(service_root):
81
 
    try:
82
 
        return uris.lookup_service_root(service_root)
83
 
    except ValueError:
84
 
        if service_root != 'qastaging':
85
 
            raise
86
 
        staging_root = uris.lookup_service_root('staging')
87
 
        return staging_root.replace('staging', 'qastaging')
 
77
LAUNCHPAD_API_URLS = {
 
78
    'production': 'https://api.launchpad.net/beta/',
 
79
    'edge': EDGE_SERVICE_ROOT,
 
80
    'staging': STAGING_SERVICE_ROOT,
 
81
    'dev': 'https://api.launchpad.dev/beta/',
 
82
    }
88
83
 
89
84
 
90
85
def _get_api_url(service):
91
86
    """Return the root URL of the Launchpad API.
92
87
 
93
 
    e.g. For the 'staging' Launchpad service, this function returns
94
 
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
 
88
    e.g. For the 'edge' Launchpad service, this function returns
 
89
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
95
90
 
96
91
    :param service: A `LaunchpadService` object.
97
92
    :return: A URL as a string.
101
96
    else:
102
97
        lp_instance = service._lp_instance
103
98
    try:
104
 
        return lookup_service_root(lp_instance)
105
 
    except ValueError:
 
99
        return LAUNCHPAD_API_URLS[lp_instance]
 
100
    except KeyError:
106
101
        raise InvalidLaunchpadInstance(lp_instance)
107
102
 
108
103
 
109
 
class NoLaunchpadBranch(errors.BzrError):
110
 
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
111
 
 
112
 
    def __init__(self, branch):
113
 
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
114
 
 
115
 
 
116
 
def login(service, timeout=None, proxy_info=None,
117
 
          version=Launchpad.DEFAULT_VERSION):
 
104
def login(service, timeout=None, proxy_info=None):
118
105
    """Log in to the Launchpad API.
119
106
 
120
107
    :return: The root `Launchpad` object from launchpadlib.
121
108
    """
122
 
    if proxy_info is None:
123
 
        proxy_info = httplib2.proxy_info_from_environment('https')
124
109
    cache_directory = get_cache_directory()
125
110
    launchpad = Launchpad.login_with(
126
111
        'bzr', _get_api_url(service), cache_directory, timeout=timeout,
127
 
        proxy_info=proxy_info, version=version)
128
 
    # XXX: Work-around a minor security bug in launchpadlib < 1.6.3, which
129
 
    # would create this directory with default umask.
130
 
    osutils.chmod_if_possible(cache_directory, 0700)
 
112
        proxy_info=proxy_info)
 
113
    # XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
 
114
    # create this directory with default umask.
 
115
    os.chmod(cache_directory, 0700)
131
116
    return launchpad
132
117
 
133
118
 
189
174
        url = bzr_branch.get_push_location()
190
175
        if url is not None:
191
176
            yield url
192
 
        url = bzr_branch.get_parent()
193
 
        if url is not None:
194
 
            yield url
195
177
        yield bzr_branch.base
196
178
 
197
179
    @staticmethod
198
180
    def tweak_url(url, launchpad):
199
181
        """Adjust a URL to work with staging, if needed."""
200
 
        if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
201
 
            return url.replace('bazaar.launchpad.net',
202
 
                               'bazaar.staging.launchpad.net')
203
 
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
204
 
            return url.replace('bazaar.launchpad.net',
205
 
                               'bazaar.qastaging.launchpad.net')
206
 
        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')
207
188
 
208
189
    @classmethod
209
 
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
190
    def from_bzr(cls, launchpad, bzr_branch):
210
191
        """Find a Launchpad branch from a bzr branch."""
211
192
        check_update = True
212
193
        for url in cls.candidate_urls(bzr_branch):
217
198
            if lp_branch is not None:
218
199
                break
219
200
        else:
220
 
            if not create_missing:
221
 
                raise NoLaunchpadBranch(bzr_branch)
222
201
            lp_branch = cls.create_now(launchpad, bzr_branch)
223
202
            check_update = False
224
203
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
228
207
        """Create a Bazaar branch on Launchpad for the supplied branch."""
229
208
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
230
209
        if not cls.plausible_launchpad_url(url):
231
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
210
            raise errors.BzrError('%s is not registered on Launchpad' %
232
211
                                  bzr_branch.base)
233
212
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
234
213
        lp_branch = launchpad.branches.getByUrl(url=url)
235
214
        if lp_branch is None:
236
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
237
 
                                                                            url)
 
215
            raise errors.BzrError('%s is not registered on Launchpad' % url)
238
216
        return lp_branch
239
217
 
240
 
    def get_target(self):
241
 
        """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."""
242
220
        lp_branch = self.lp
243
 
        if lp_branch.project is not None:
244
 
            dev_focus = lp_branch.project.development_focus
245
 
            if dev_focus is None:
246
 
                raise errors.BzrError(gettext('%s has no development focus.') %
247
 
                                  lp_branch.bzr_identity)
248
 
            target = dev_focus.branch
249
 
            if target is None:
250
 
                raise errors.BzrError(gettext(
251
 
                        'development focus %s has no branch.') % dev_focus)
252
 
        elif lp_branch.sourcepackage is not None:
253
 
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
254
 
            if target is None:
255
 
                raise errors.BzrError(gettext(
256
 
                                      'source package %s has no branch.') %
257
 
                                      lp_branch.sourcepackage)
258
 
        else:
259
 
            raise errors.BzrError(gettext(
260
 
                        '%s has no associated product or source package.') %
261
 
                                  lp_branch.bzr_identity)
262
 
        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)
263
229
 
264
230
    def update_lp(self):
265
231
        """Update the Launchpad copy of this branch."""
269
235
        try:
270
236
            if self.lp.last_scanned_id is not None:
271
237
                if self.bzr.last_revision() == self.lp.last_scanned_id:
272
 
                    trace.note(gettext('%s is already up-to-date.') %
 
238
                    trace.note('%s is already up-to-date.' %
273
239
                               self.lp.bzr_identity)
274
240
                    return
275
241
                graph = self.bzr.repository.get_graph()
276
242
                if not graph.is_ancestor(self.lp.last_scanned_id,
277
243
                                         self.bzr.last_revision()):
278
244
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
279
 
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
245
                trace.note('Pushing to %s' % self.lp.bzr_identity)
280
246
            self.bzr.push(self.push_bzr)
281
247
        finally:
282
248
            self.bzr.unlock()
293
259
        return self.bzr.repository.revision_tree(lca)
294
260
 
295
261
 
296
 
def canonical_url(object):
297
 
    """Return the canonical URL for a branch."""
298
 
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
299
 
        str(object.self_link))
300
 
    path = '/'.join(path.split('/')[2:])
301
 
    netloc = netloc.replace('api.', 'code.')
302
 
    return urlparse.urlunparse((scheme, netloc, path, params, query,
303
 
                                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)