← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

Merge register-branch plugin into default plugins directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/__init__.py
 
1
# Copyright (C) 2006 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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
"""
 
24
 
 
25
# The XMLRPC server address can be overridden by setting the environment
 
26
# variable $BZR_LP_XMLRPL_URL
 
27
 
 
28
# see http://bazaar-vcs.org/Specs/BranchRegistrationTool
 
29
 
 
30
from bzrlib.commands import Command, Option, register_command
 
31
 
 
32
 
 
33
 
 
34
class cmd_register_branch(Command):
 
35
    """Register a branch with launchpad.net.
 
36
 
 
37
    This command lists a bzr branch in the directory of branches on
 
38
    launchpad.net.  Registration allows the bug to be associated with
 
39
    bugs or specifications.
 
40
    
 
41
    Before using this command you must register the product to which the
 
42
    branch belongs, and create an account for yourself on launchpad.net.
 
43
 
 
44
    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.
 
48
 
 
49
    example:
 
50
        bzr register-branch http://foo.com/bzr/fooproduct.mine \\
 
51
                --product fooproduct
 
52
    """
 
53
    takes_args = ['branch_url']
 
54
    takes_options = \
 
55
        [Option('product', 
 
56
                'launchpad product short name to associate with the branch',
 
57
                unicode),
 
58
         Option('branch-name',
 
59
                'short name for the branch; '
 
60
                'by default taken from the last component of the url',
 
61
                unicode),
 
62
         Option('branch-title',
 
63
                'one-sentence description of the branch',
 
64
                unicode),
 
65
         Option('branch-description',
 
66
                'longer description of the purpose or contents of the branch',
 
67
                unicode),
 
68
         Option('author', 
 
69
                'email of the branch\'s author, if not yourself',
 
70
                unicode),
 
71
         Option('link-bug',
 
72
                'the bug this branch fixes',
 
73
                int),
 
74
         Option('dry-run',
 
75
                'prepare the request but don\'t actually send it')
 
76
        ]
 
77
 
 
78
 
 
79
    def run(self, 
 
80
            branch_url, 
 
81
            product='', 
 
82
            branch_name='',
 
83
            branch_title='',
 
84
            branch_description='',
 
85
            author='',
 
86
            link_bug=None,
 
87
            dry_run=False):
 
88
        from lp_registration import (
 
89
            LaunchpadService, BranchRegistrationRequest, BranchBugLinkRequest)
 
90
        rego = BranchRegistrationRequest(branch_url=branch_url, 
 
91
                                         branch_name=branch_name,
 
92
                                         branch_title=branch_title,
 
93
                                         branch_description=branch_description,
 
94
                                         product_name=product,
 
95
                                         author_email=author,
 
96
                                         )
 
97
        linko = BranchBugLinkRequest(branch_url=branch_url,
 
98
                                     bug_id=link_bug)
 
99
        service = LaunchpadService()
 
100
        service.gather_user_credentials()
 
101
        if not dry_run:
 
102
            print rego.submit(service)
 
103
            if link_bug:
 
104
                print linko.submit(service)
 
105
 
 
106
register_command(cmd_register_branch)
 
107
 
 
108
def test_suite():
 
109
    """Called by bzrlib to fetch tests for this plugin"""
 
110
    from unittest import TestSuite, TestLoader
 
111
    import test_register
 
112
    return TestLoader().loadTestsFromModule(test_register)