1
# Copyright (C) 2006 - 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Launchpad.net integration plugin for Bazaar."""
19
# The XMLRPC server address can be overridden by setting the environment
20
# variable $BZR_LP_XMLRPL_URL
22
# see http://bazaar-vcs.org/Specs/BranchRegistrationTool
24
from bzrlib.branch import Branch
25
from bzrlib.commands import Command, Option, register_command
26
from bzrlib.directory_service import directories
27
from bzrlib.errors import BzrCommandError, NoPublicBranch, NotBranchError
28
from bzrlib.help_topics import topic_registry
31
class cmd_register_branch(Command):
32
"""Register a branch with launchpad.net.
34
This command lists a bzr branch in the directory of branches on
35
launchpad.net. Registration allows the branch to be associated with
36
bugs or specifications.
38
Before using this command you must register the product to which the
39
branch belongs, and create an account for yourself on launchpad.net.
42
public_url: The publicly visible url for the branch to register.
43
This must be an http or https url (which Launchpad can read
44
from to access the branch). Local file urls, SFTP urls, and
45
bzr+ssh urls will not work.
46
If no public_url is provided, bzr will use the configured
47
public_url if there is one for the current branch, and
51
bzr register-branch http://foo.com/bzr/fooproduct.mine \\
54
takes_args = ['public_url?']
57
'Launchpad product short name to associate with the branch.',
60
'Short name for the branch; '
61
'by default taken from the last component of the url.',
63
Option('branch-title',
64
'One-sentence description of the branch.',
66
Option('branch-description',
67
'Longer description of the purpose or contents of the branch.',
70
"Branch author's email address, if not yourself.",
73
'The bug this branch fixes.',
76
'Prepare the request but don\'t actually send it.')
85
branch_description='',
89
from bzrlib.plugins.launchpad.lp_registration import (
90
LaunchpadService, BranchRegistrationRequest, BranchBugLinkRequest,
91
DryRunLaunchpadService)
92
if public_url is None:
94
b = Branch.open_containing('.')[0]
95
except NotBranchError:
96
raise BzrCommandError('register-branch requires a public '
97
'branch url - see bzr help register-branch.')
98
public_url = b.get_public_branch()
99
if public_url is None:
100
raise NoPublicBranch(b)
102
rego = BranchRegistrationRequest(branch_url=public_url,
103
branch_name=branch_name,
104
branch_title=branch_title,
105
branch_description=branch_description,
106
product_name=product,
109
linko = BranchBugLinkRequest(branch_url=public_url,
112
service = LaunchpadService()
113
# This gives back the xmlrpc url that can be used for future
114
# operations on the branch. It's not so useful to print to the
115
# user since they can't do anything with it from a web browser; it
116
# might be nice for the server to tell us about an html url as
119
# Run on service entirely in memory
120
service = DryRunLaunchpadService()
121
service.gather_user_credentials()
122
branch_object_url = rego.submit(service)
124
link_bug_url = linko.submit(service)
125
print 'Branch registered.'
127
register_command(cmd_register_branch)
130
class cmd_launchpad_login(Command):
131
"""Show or set the Launchpad user ID.
133
When communicating with Launchpad, some commands need to know your
134
Launchpad user ID. This command can be used to set or show the
135
user ID that Bazaar will use for such communication.
138
Show the Launchpad ID of the current user::
142
Set the Launchpad ID of the current user to 'bob'::
144
bzr launchpad-login bob
146
aliases = ['lp-login']
147
takes_args = ['name?']
150
"Don't check that the user name is valid."),
153
def run(self, name=None, no_check=False):
154
from bzrlib.plugins.launchpad import account
155
check_account = not no_check
158
username = account.get_lp_login()
161
account.check_lp_login(username)
162
self.outf.write(username + '\n')
164
self.outf.write('No Launchpad user ID configured.\n')
168
account.check_lp_login(name)
169
account.set_lp_login(name)
171
register_command(cmd_launchpad_login)
174
def _register_directory():
175
directories.register_lazy('lp:', 'bzrlib.plugins.launchpad.lp_directory',
176
'LaunchpadDirectory',
177
'Launchpad-based directory service',)
178
_register_directory()
182
"""Called by bzrlib to fetch tests for this plugin"""
183
from unittest import TestSuite, TestLoader
184
from bzrlib.plugins.launchpad import (
185
test_account, test_lp_directory, test_lp_service, test_register,
188
loader = TestLoader()
196
suite.addTests(loader.loadTestsFromModule(module))
199
_launchpad_help = """Integration with Launchpad.net
201
Launchpad.net provides free Bazaar branch hosting with integrated bug and
202
specification tracking.
204
The bzr client (through the plugin called 'launchpad') has special
205
features to communicate with Launchpad:
207
* The launchpad-login command tells Bazaar your Launchpad user name. This
208
is then used by the 'lp:' transport to download your branches using
211
* The register-branch command tells Launchpad about the url of a
212
public branch. Launchpad will then mirror the branch, display
213
its contents and allow it to be attached to bugs and other
216
* The 'lp:' transport uses Launchpad as a directory service: for example
217
'lp:bzr' and 'lp:python' refer to the main branches of the relevant
218
projects and may be branched, logged, etc. You can also use the 'lp:'
219
transport to refer to specific branches, e.g. lp:///~bzr/bzr/trunk.
221
For more information see http://help.launchpad.net/
223
topic_registry.register('launchpad',
225
'Using Bazaar with Launchpad.net')
added
removed
bzrlib/plugins/launchpad/__init__.py
