/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_api.py
 
1
# Copyright (C) 2009-2012 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Tools for dealing with the Launchpad API."""
 
18
 
 
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.
 
22
 
 
23
 
 
24
import re
 
25
from urllib.parse import (
 
26
    urlparse,
 
27
    urlunparse,
 
28
    )
 
29
 
 
30
from ... import (
 
31
    branch,
 
32
    bedding,
 
33
    errors,
 
34
    osutils,
 
35
    trace,
 
36
    transport,
 
37
    )
 
38
from ...i18n import gettext
 
39
 
 
40
 
 
41
class LaunchpadlibMissing(errors.DependencyNotPresent):
 
42
 
 
43
    _fmt = ("launchpadlib is required for Launchpad API access. "
 
44
            "Please install the launchpadlib package.")
 
45
 
 
46
    def __init__(self, e):
 
47
        super(LaunchpadlibMissing, self).__init__(
 
48
            'launchpadlib', e)
 
49
 
 
50
try:
 
51
    import launchpadlib
 
52
except ImportError as e:
 
53
    raise LaunchpadlibMissing(e)
 
54
 
 
55
from launchpadlib.credentials import RequestTokenAuthorizationEngine
 
56
from launchpadlib.launchpad import (
 
57
    Launchpad,
 
58
    )
 
59
from launchpadlib import uris
 
60
 
 
61
# Declare the minimum version of launchpadlib that we need in order to work.
 
62
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
 
63
 
 
64
 
 
65
def get_cache_directory():
 
66
    """Return the directory to cache launchpadlib objects in."""
 
67
    return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
 
68
 
 
69
 
 
70
def parse_launchpadlib_version(version_number):
 
71
    """Parse a version number of the style used by launchpadlib."""
 
72
    return tuple(map(int, version_number.split('.')))
 
73
 
 
74
 
 
75
def check_launchpadlib_compatibility():
 
76
    """Raise an error if launchpadlib has the wrong version number."""
 
77
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
 
78
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
 
79
        raise errors.DependencyNotPresent(
 
80
            'launchpadlib',
 
81
            'At least launchpadlib %s is required, but installed version is %s'
 
82
            % (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
 
83
 
 
84
 
 
85
def lookup_service_root(service_root):
 
86
    try:
 
87
        return uris.lookup_service_root(service_root)
 
88
    except ValueError:
 
89
        if service_root != 'qastaging':
 
90
            raise
 
91
        staging_root = uris.lookup_service_root('staging')
 
92
        return staging_root.replace('staging', 'qastaging')
 
93
 
 
94
 
 
95
class NoLaunchpadBranch(errors.BzrError):
 
96
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
 
97
 
 
98
    def __init__(self, branch):
 
99
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
 
100
 
 
101
 
 
102
def get_auth_engine(base_url):
 
103
    return Launchpad.authorization_engine_factory(base_url, 'breezy')
 
104
 
 
105
 
 
106
def get_credential_store():
 
107
    return Launchpad.credential_store_factory(None)
 
108
 
 
109
 
 
110
def connect_launchpad(base_url, timeout=None, proxy_info=None,
 
111
                      version=Launchpad.DEFAULT_VERSION):
 
112
    """Log in to the Launchpad API.
 
113
 
 
114
    :return: The root `Launchpad` object from launchpadlib.
 
115
    """
 
116
    if proxy_info is None:
 
117
        import httplib2
 
118
        proxy_info = httplib2.proxy_info_from_environment('https')
 
119
    try:
 
120
        cache_directory = get_cache_directory()
 
121
    except EnvironmentError:
 
122
        cache_directory = None
 
123
    credential_store = get_credential_store()
 
124
    authorization_engine = get_auth_engine(base_url)
 
125
    return Launchpad.login_with(
 
126
        'breezy', base_url, cache_directory, timeout=timeout,
 
127
        credential_store=credential_store,
 
128
        authorization_engine=authorization_engine,
 
129
        proxy_info=proxy_info, version=version)
 
130
 
 
131
 
 
132
 
 
133
class LaunchpadBranch(object):
 
134
    """Provide bzr and lp API access to a Launchpad branch."""
 
135
 
 
136
    def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
 
137
        """Constructor.
 
138
 
 
139
        :param lp_branch: The Launchpad branch.
 
140
        :param bzr_url: The URL of the Bazaar branch.
 
141
        :param bzr_branch: An instance of the Bazaar branch.
 
142
        """
 
143
        self.bzr_url = bzr_url
 
144
        self._bzr = bzr_branch
 
145
        self._push_bzr = None
 
146
        self._check_update = check_update
 
147
        self.lp = lp_branch
 
148
 
 
149
    @property
 
150
    def bzr(self):
 
151
        """Return the bzr branch for this branch."""
 
152
        if self._bzr is None:
 
153
            self._bzr = branch.Branch.open(self.bzr_url)
 
154
        return self._bzr
 
155
 
 
156
    @property
 
157
    def push_bzr(self):
 
158
        """Return the push branch for this branch."""
 
159
        if self._push_bzr is None:
 
160
            self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
 
161
        return self._push_bzr
 
162
 
 
163
    @staticmethod
 
164
    def plausible_launchpad_url(url):
 
165
        """Is 'url' something that could conceivably be pushed to LP?
 
166
 
 
167
        :param url: A URL that may refer to a Launchpad branch.
 
168
        :return: A boolean.
 
169
        """
 
170
        if url is None:
 
171
            return False
 
172
        if url.startswith('lp:'):
 
173
            return True
 
174
        regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
 
175
                           '://bazaar.*.launchpad.net')
 
176
        return bool(regex.match(url))
 
177
 
 
178
    @staticmethod
 
179
    def candidate_urls(bzr_branch):
 
180
        """Iterate through related URLs that might be Launchpad URLs.
 
181
 
 
182
        :param bzr_branch: A Bazaar branch to find URLs from.
 
183
        :return: a generator of URL strings.
 
184
        """
 
185
        url = bzr_branch.get_public_branch()
 
186
        if url is not None:
 
187
            yield url
 
188
        url = bzr_branch.get_push_location()
 
189
        if url is not None:
 
190
            yield url
 
191
        url = bzr_branch.get_parent()
 
192
        if url is not None:
 
193
            yield url
 
194
        yield bzr_branch.base
 
195
 
 
196
    @staticmethod
 
197
    def tweak_url(url, launchpad):
 
198
        """Adjust a URL to work with staging, if needed."""
 
199
        if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
 
200
            return url.replace('bazaar.launchpad.net',
 
201
                               'bazaar.staging.launchpad.net')
 
202
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
 
203
            return url.replace('bazaar.launchpad.net',
 
204
                               'bazaar.qastaging.launchpad.net')
 
205
        return url
 
206
 
 
207
    @classmethod
 
208
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
209
        """Find a Launchpad branch from a bzr branch."""
 
210
        check_update = True
 
211
        for url in cls.candidate_urls(bzr_branch):
 
212
            url = cls.tweak_url(url, launchpad)
 
213
            if not cls.plausible_launchpad_url(url):
 
214
                continue
 
215
            lp_branch = launchpad.branches.getByUrl(url=url)
 
216
            if lp_branch is not None:
 
217
                break
 
218
        else:
 
219
            if not create_missing:
 
220
                raise NoLaunchpadBranch(bzr_branch)
 
221
            lp_branch = cls.create_now(launchpad, bzr_branch)
 
222
            check_update = False
 
223
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
 
224
 
 
225
    @classmethod
 
226
    def create_now(cls, launchpad, bzr_branch):
 
227
        """Create a Bazaar branch on Launchpad for the supplied branch."""
 
228
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
 
229
        if not cls.plausible_launchpad_url(url):
 
230
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
231
                                  bzr_branch.base)
 
232
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
 
233
        lp_branch = launchpad.branches.getByUrl(url=url)
 
234
        if lp_branch is None:
 
235
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
236
                                  url)
 
237
        return lp_branch
 
238
 
 
239
    def get_target(self):
 
240
        """Return the 'LaunchpadBranch' for the target of this one."""
 
241
        lp_branch = self.lp
 
242
        if lp_branch.project is not None:
 
243
            dev_focus = lp_branch.project.development_focus
 
244
            if dev_focus is None:
 
245
                raise errors.BzrError(gettext('%s has no development focus.') %
 
246
                                      lp_branch.bzr_identity)
 
247
            target = dev_focus.branch
 
248
            if target is None:
 
249
                raise errors.BzrError(gettext(
 
250
                    'development focus %s has no branch.') % dev_focus)
 
251
        elif lp_branch.sourcepackage is not None:
 
252
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
 
253
            if target is None:
 
254
                raise errors.BzrError(gettext(
 
255
                                      'source package %s has no branch.') %
 
256
                                      lp_branch.sourcepackage)
 
257
        else:
 
258
            raise errors.BzrError(gettext(
 
259
                '%s has no associated product or source package.') %
 
260
                lp_branch.bzr_identity)
 
261
        return LaunchpadBranch(target, target.bzr_identity)
 
262
 
 
263
    def update_lp(self):
 
264
        """Update the Launchpad copy of this branch."""
 
265
        if not self._check_update:
 
266
            return
 
267
        with self.bzr.lock_read():
 
268
            if self.lp.last_scanned_id is not None:
 
269
                if self.bzr.last_revision() == self.lp.last_scanned_id:
 
270
                    trace.note(gettext('%s is already up-to-date.') %
 
271
                               self.lp.bzr_identity)
 
272
                    return
 
273
                graph = self.bzr.repository.get_graph()
 
274
                if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
 
275
                                         self.bzr.last_revision()):
 
276
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
 
277
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
278
            self.bzr.push(self.push_bzr)
 
279
 
 
280
    def find_lca_tree(self, other):
 
281
        """Find the revision tree for the LCA of this branch and other.
 
282
 
 
283
        :param other: Another LaunchpadBranch
 
284
        :return: The RevisionTree of the LCA of this branch and other.
 
285
        """
 
286
        graph = self.bzr.repository.get_graph(other.bzr.repository)
 
287
        lca = graph.find_unique_lca(self.bzr.last_revision(),
 
288
                                    other.bzr.last_revision())
 
289
        return self.bzr.repository.revision_tree(lca)
 
290
 
 
291
 
 
292
def canonical_url(object):
 
293
    """Return the canonical URL for a branch."""
 
294
    scheme, netloc, path, params, query, fragment = urlparse(
 
295
        str(object.self_link))
 
296
    path = '/'.join(path.split('/')[2:])
 
297
    netloc = netloc.replace('api.', 'code.')
 
298
    return urlunparse((scheme, netloc, path, params, query, fragment))