/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 bzrlib/plugins/launchpad/__init__.py

  • Committer: Robert Collins
  • Date: 2008-08-20 02:07:36 UTC
  • mfrom: (3640 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3682.
  • Revision ID: robertc@robertcollins.net-20080820020736-g2xe4921zzxtymle
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/__init__.py
1
 
# Copyright (C) 2006 by Canonical Ltd
 
1
# Copyright (C) 2006 - 2008 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Launchpad.net branch registration plugin for bzr
18
 
 
19
 
This adds commands that tell launchpad about newly-created branches, etc.
20
 
 
21
 
To install this file, put the 'bzr_lp' directory, or a symlink to it,
22
 
in your ~/.bazaar/plugins/ directory.
23
 
"""
 
17
"""Launchpad.net integration plugin for Bazaar."""
24
18
 
25
19
# The XMLRPC server address can be overridden by setting the environment
26
20
# variable $BZR_LP_XMLRPL_URL
27
21
 
28
22
# see http://bazaar-vcs.org/Specs/BranchRegistrationTool
29
23
 
 
24
from bzrlib.branch import Branch
30
25
from bzrlib.commands import Command, Option, register_command
31
 
 
 
26
from bzrlib.directory_service import directories
 
27
from bzrlib.errors import BzrCommandError, NoPublicBranch, NotBranchError
 
28
from bzrlib.help_topics import topic_registry
32
29
 
33
30
 
34
31
class cmd_register_branch(Command):
35
32
    """Register a branch with launchpad.net.
36
33
 
37
34
    This command lists a bzr branch in the directory of branches on
38
 
    launchpad.net.  Registration allows the bug to be associated with
 
35
    launchpad.net.  Registration allows the branch to be associated with
39
36
    bugs or specifications.
40
37
    
41
38
    Before using this command you must register the product to which the
42
39
    branch belongs, and create an account for yourself on launchpad.net.
43
40
 
44
41
    arguments:
45
 
        branch_url: The publicly visible url for the branch.
46
 
                    This must be an http or https url, not a local file
47
 
                    path.
 
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
 
48
                    otherwise error.
48
49
 
49
50
    example:
50
51
        bzr register-branch http://foo.com/bzr/fooproduct.mine \\
51
52
                --product fooproduct
52
53
    """
53
 
    takes_args = ['branch_url']
54
 
    takes_options = \
55
 
        [Option('product', 
56
 
                'launchpad product short name to associate with the branch',
 
54
    takes_args = ['public_url?']
 
55
    takes_options = [
 
56
         Option('product',
 
57
                'Launchpad product short name to associate with the branch.',
57
58
                unicode),
58
59
         Option('branch-name',
59
 
                'short name for the branch; '
60
 
                'by default taken from the last component of the url',
 
60
                'Short name for the branch; '
 
61
                'by default taken from the last component of the url.',
61
62
                unicode),
62
63
         Option('branch-title',
63
 
                'one-sentence description of the branch',
 
64
                'One-sentence description of the branch.',
64
65
                unicode),
65
66
         Option('branch-description',
66
 
                'longer description of the purpose or contents of the branch',
 
67
                'Longer description of the purpose or contents of the branch.',
67
68
                unicode),
68
 
         Option('author', 
69
 
                'email of the branch\'s author, if not yourself',
 
69
         Option('author',
 
70
                "Branch author's email address, if not yourself.",
70
71
                unicode),
71
72
         Option('link-bug',
72
 
                'the bug this branch fixes',
 
73
                'The bug this branch fixes.',
73
74
                int),
74
75
         Option('dry-run',
75
 
                'prepare the request but don\'t actually send it')
 
76
                'Prepare the request but don\'t actually send it.')
76
77
        ]
77
78
 
78
79
 
79
 
    def run(self, 
80
 
            branch_url, 
 
80
    def run(self,
 
81
            public_url=None,
81
82
            product='',
82
83
            branch_name='',
83
84
            branch_title='',
85
86
            author='',
86
87
            link_bug=None,
87
88
            dry_run=False):
88
 
        from lp_registration import (
 
89
        from bzrlib.plugins.launchpad.lp_registration import (
89
90
            LaunchpadService, BranchRegistrationRequest, BranchBugLinkRequest,
90
91
            DryRunLaunchpadService)
91
 
        rego = BranchRegistrationRequest(branch_url=branch_url,
 
92
        if public_url is None:
 
93
            try:
 
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)
 
101
 
 
102
        rego = BranchRegistrationRequest(branch_url=public_url,
92
103
                                         branch_name=branch_name,
93
104
                                         branch_title=branch_title,
94
105
                                         branch_description=branch_description,
95
106
                                         product_name=product,
96
107
                                         author_email=author,
97
108
                                         )
98
 
        linko = BranchBugLinkRequest(branch_url=branch_url,
 
109
        linko = BranchBugLinkRequest(branch_url=public_url,
99
110
                                     bug_id=link_bug)
100
111
        if not dry_run:
101
112
            service = LaunchpadService()
115
126
 
116
127
register_command(cmd_register_branch)
117
128
 
 
129
 
 
130
class cmd_launchpad_login(Command):
 
131
    """Show or set the Launchpad user ID.
 
132
 
 
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.
 
136
 
 
137
    :Examples:
 
138
      Show the Launchpad ID of the current user::
 
139
 
 
140
          bzr launchpad-login
 
141
 
 
142
      Set the Launchpad ID of the current user to 'bob'::
 
143
 
 
144
          bzr launchpad-login bob
 
145
    """
 
146
    aliases = ['lp-login']
 
147
    takes_args = ['name?']
 
148
    takes_options = [
 
149
        Option('no-check',
 
150
               "Don't check that the user name is valid."),
 
151
        ]
 
152
 
 
153
    def run(self, name=None, no_check=False):
 
154
        from bzrlib.plugins.launchpad import account
 
155
        check_account = not no_check
 
156
 
 
157
        if name is None:
 
158
            username = account.get_lp_login()
 
159
            if username:
 
160
                if check_account:
 
161
                    account.check_lp_login(username)
 
162
                self.outf.write(username + '\n')
 
163
            else:
 
164
                self.outf.write('No Launchpad user ID configured.\n')
 
165
                return 1
 
166
        else:
 
167
            if check_account:
 
168
                account.check_lp_login(name)
 
169
            account.set_lp_login(name)
 
170
 
 
171
register_command(cmd_launchpad_login)
 
172
 
 
173
 
 
174
def _register_directory():
 
175
    directories.register_lazy('lp:', 'bzrlib.plugins.launchpad.lp_directory',
 
176
                              'LaunchpadDirectory',
 
177
                              'Launchpad-based directory service',)
 
178
_register_directory()
 
179
 
 
180
 
118
181
def test_suite():
119
182
    """Called by bzrlib to fetch tests for this plugin"""
120
183
    from unittest import TestSuite, TestLoader
121
 
    import test_register
122
 
    return TestLoader().loadTestsFromModule(test_register)
 
184
    from bzrlib.plugins.launchpad import (
 
185
         test_account, test_lp_directory, test_lp_service, test_register,
 
186
         )
 
187
 
 
188
    loader = TestLoader()
 
189
    suite = TestSuite()
 
190
    for module in [
 
191
        test_account,
 
192
        test_register,
 
193
        test_lp_directory,
 
194
        test_lp_service,
 
195
        ]:
 
196
        suite.addTests(loader.loadTestsFromModule(module))
 
197
    return suite
 
198
 
 
199
_launchpad_help = """Integration with Launchpad.net
 
200
 
 
201
Launchpad.net provides free Bazaar branch hosting with integrated bug and
 
202
specification tracking.
 
203
 
 
204
The bzr client (through the plugin called 'launchpad') has special
 
205
features to communicate with Launchpad:
 
206
 
 
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
 
209
      bzr+ssh://.
 
210
 
 
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
 
214
      objects.
 
215
 
 
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.
 
220
 
 
221
For more information see http://help.launchpad.net/
 
222
"""
 
223
topic_registry.register('launchpad',
 
224
    _launchpad_help,
 
225
    'Using Bazaar with Launchpad.net')