← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2011-02-07 01:39:42 UTC
  • mto: This revision was merged to the branch mainline in revision 5650.
  • Revision ID: mbp@canonical.com-20110207013942-roj88kez6jir13tr
Add brief user documentation of command line splitting

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_propose.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
 
import urlparse
19
 
import webbrowser
20
 
 
21
17
from bzrlib import (
22
18
    errors,
23
19
    hooks,
 
20
    )
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import webbrowser
 
24
 
 
25
from bzrlib import (
24
26
    msgeditor,
25
27
)
26
28
from bzrlib.plugins.launchpad import (
27
29
    lp_api,
28
30
    lp_registration,
29
31
)
30
 
 
31
 
from lazr.restfulclient import errors as restful_errors
 
32
""")
32
33
 
33
34
 
34
35
class ProposeMergeHooks(hooks.Hooks):
55
56
    hooks = ProposeMergeHooks()
56
57
 
57
58
    def __init__(self, tree, source_branch, target_branch, message, reviews,
58
 
                 staging=False):
 
59
                 staging=False, approve=False):
59
60
        """Constructor.
60
61
 
61
62
        :param tree: The working tree for the source branch.
65
66
        :param reviews: A list of tuples of reviewer, review type.
66
67
        :param staging: If True, propose the merge against staging instead of
67
68
            production.
 
69
        :param approve: If True, mark the new proposal as approved immediately.
 
70
            This is useful when a project permits some things to be approved
 
71
            by the submitter (e.g. merges between release and deployment
 
72
            branches).
68
73
        """
69
74
        self.tree = tree
70
75
        if staging:
71
76
            lp_instance = 'staging'
72
77
        else:
73
 
            lp_instance = 'edge'
 
78
            lp_instance = 'production'
74
79
        service = lp_registration.LaunchpadService(lp_instance=lp_instance)
75
80
        self.launchpad = lp_api.login(service)
76
81
        self.source_branch = lp_api.LaunchpadBranch.from_bzr(
77
82
            self.launchpad, source_branch)
78
83
        if target_branch is None:
79
 
            self.target_branch = self.source_branch.get_dev_focus()
 
84
            self.target_branch = self.source_branch.get_target()
80
85
        else:
81
86
            self.target_branch = lp_api.LaunchpadBranch.from_bzr(
82
87
                self.launchpad, target_branch)
83
88
        self.commit_message = message
 
89
        # XXX: this is where bug lp:583638 could be tackled.
84
90
        if reviews == []:
85
 
            target_reviewer = self.target_branch.lp.reviewer
86
 
            if target_reviewer is None:
87
 
                raise errors.BzrCommandError('No reviewer specified')
88
 
            self.reviews = [(target_reviewer, '')]
 
91
            self.reviews = []
89
92
        else:
90
93
            self.reviews = [(self.launchpad.people[reviewer], review_type)
91
94
                            for reviewer, review_type in
92
95
                            reviews]
 
96
        self.approve = approve
93
97
 
94
98
    def get_comment(self, prerequisite_branch):
95
99
        """Determine the initial comment for the merge proposal."""
147
151
            if mp.target_branch.self_link == self.target_branch.lp.self_link:
148
152
                raise errors.BzrCommandError(
149
153
                    'There is already a branch merge proposal: %s' %
150
 
                    canonical_url(mp))
 
154
                    lp_api.canonical_url(mp))
151
155
 
152
156
    def _get_prerequisite_branch(self):
153
157
        hooks = self.hooks['get_prerequisite']
160
164
                 'prerequisite_branch': prerequisite_branch})
161
165
        return prerequisite_branch
162
166
 
 
167
    def call_webservice(self, call, *args, **kwargs):
 
168
        """Make a call to the webservice, wrapping failures.
 
169
        
 
170
        :param call: The call to make.
 
171
        :param *args: *args for the call.
 
172
        :param **kwargs: **kwargs for the call.
 
173
        :return: The result of calling call(*args, *kwargs).
 
174
        """
 
175
        from lazr.restfulclient import errors as restful_errors
 
176
        try:
 
177
            return call(*args, **kwargs)
 
178
        except restful_errors.HTTPError, e:
 
179
            error_lines = []
 
180
            for line in e.content.splitlines():
 
181
                if line.startswith('Traceback (most recent call last):'):
 
182
                    break
 
183
                error_lines.append(line)
 
184
            raise Exception(''.join(error_lines))
 
185
 
163
186
    def create_proposal(self):
164
187
        """Perform the submission."""
165
188
        prerequisite_branch = self._get_prerequisite_branch()
175
198
            review_types.append(review_type)
176
199
            reviewers.append(reviewer.self_link)
177
200
        initial_comment = self.get_comment(prerequisite_branch)
178
 
        try:
179
 
            mp = self.source_branch.lp.createMergeProposal(
180
 
                target_branch=self.target_branch.lp,
181
 
                prerequisite_branch=prereq,
182
 
                initial_comment=initial_comment,
183
 
                commit_message=self.commit_message, reviewers=reviewers,
184
 
                review_types=review_types)
185
 
        except restful_errors.HTTPError, e:
186
 
            error_lines = []
187
 
            for line in e.content.splitlines():
188
 
                if line.startswith('Traceback (most recent call last):'):
189
 
                    break
190
 
                error_lines.append(line)
191
 
            raise Exception(''.join(error_lines))
192
 
        else:
193
 
            webbrowser.open(canonical_url(mp))
 
201
        mp = self.call_webservice(
 
202
            self.source_branch.lp.createMergeProposal,
 
203
            target_branch=self.target_branch.lp,
 
204
            prerequisite_branch=prereq,
 
205
            initial_comment=initial_comment,
 
206
            commit_message=self.commit_message, reviewers=reviewers,
 
207
            review_types=review_types)
 
208
        if self.approve:
 
209
            self.call_webservice(mp.setStatus, status='Approved')
 
210
        webbrowser.open(lp_api.canonical_url(mp))
194
211
 
195
212
 
196
213
def modified_files(old_tree, new_tree):
199
216
        old_tree):
200
217
        if c and k == 'file':
201
218
            yield str(path)
202
 
 
203
 
 
204
 
def canonical_url(object):
205
 
    """Return the canonical URL for a branch."""
206
 
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
207
 
        str(object.self_link))
208
 
    path = '/'.join(path.split('/')[2:])
209
 
    netloc = netloc.replace('api.', 'code.')
210
 
    return urlparse.urlunparse((scheme, netloc, path, params, query,
211
 
                                fragment))