1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
# Copyright (C) 2006-2012, 2016 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import base64
from StringIO import StringIO
import urlparse
import xmlrpclib
from bzrlib import (
config,
tests,
ui,
)
from bzrlib.tests import TestCaseWithTransport
# local import
from bzrlib.plugins.launchpad.lp_registration import (
BaseRequest,
BranchBugLinkRequest,
BranchRegistrationRequest,
ResolveLaunchpadPathRequest,
LaunchpadService,
)
# TODO: Test that the command-line client, making sure that it'll pass the
# request through to a dummy transport, and that the transport will validate
# the results passed in. Not sure how to get the transport object back out to
# validate that its OK - may not be necessary.
# TODO: Add test for (and implement) other command-line options to set
# project, author_email, description.
# TODO: project_id is not properly handled -- must be passed in rpc or path.
class InstrumentedXMLRPCConnection(object):
"""Stands in place of an http connection for the purposes of testing"""
def __init__(self, testcase):
self.testcase = testcase
def getreply(self):
"""Fake the http reply.
:returns: (errcode, errmsg, headers)
"""
return (200, 'OK', [])
def getresponse(self, buffering=True):
"""Fake the http reply.
This is used when running on Python 2.7, where xmlrpclib uses
httplib.HTTPConnection in a different way than before.
"""
class FakeHttpResponse(object):
def __init__(self, status, reason, body):
self.status = status
self.reason = reason
self.body = body
def read(self, size=-1):
return self.body.read(size)
def getheader(self, name, default):
# We don't have headers
return default
return FakeHttpResponse(200, 'OK', self.getfile())
def getfile(self):
"""Return a fake file containing the response content."""
return StringIO('''\
<?xml version="1.0" ?>
<methodResponse>
<params>
<param>
<value>
<string>victoria dock</string>
</value>
</param>
</params>
</methodResponse>''')
class InstrumentedXMLRPCTransport(xmlrpclib.Transport):
# Python 2.5's xmlrpclib looks for this.
_use_datetime = False
def __init__(self, testcase, expect_auth):
self.testcase = testcase
self.expect_auth = expect_auth
self._connection = (None, None)
def make_connection(self, host):
host, http_headers, x509 = self.get_host_info(host)
test = self.testcase
self.connected_host = host
if self.expect_auth:
auth_hdrs = [v for k,v in http_headers if k == 'Authorization']
if len(auth_hdrs) != 1:
raise AssertionError("multiple auth headers: %r"
% (auth_hdrs,))
authinfo = auth_hdrs[0]
expected_auth = 'testuser@launchpad.net:testpassword'
test.assertEqual(authinfo,
'Basic ' + base64.encodestring(expected_auth).strip())
elif http_headers:
raise AssertionError()
return InstrumentedXMLRPCConnection(test)
def send_request(self, connection, handler_path, request_body):
test = self.testcase
self.got_request = True
def send_host(self, conn, host):
pass
def send_user_agent(self, conn):
# TODO: send special user agent string, including bzrlib version
# number
pass
def send_content(self, conn, request_body):
unpacked, method = xmlrpclib.loads(request_body)
if None in unpacked:
raise AssertionError(
"xmlrpc result %r shouldn't contain None" % (unpacked,))
self.sent_params = unpacked
class MockLaunchpadService(LaunchpadService):
def send_request(self, method_name, method_params, authenticated):
"""Stash away the method details rather than sending them to a real server"""
self.called_method_name = method_name
self.called_method_params = method_params
self.called_authenticated = authenticated
class TestBranchRegistration(TestCaseWithTransport):
def setUp(self):
super(TestBranchRegistration, self).setUp()
# make sure we have a reproducible standard environment
self.overrideEnv('BZR_LP_XMLRPC_URL', None)
def test_register_help(self):
"""register-branch accepts --help"""
out, err = self.run_bzr(['register-branch', '--help'])
self.assertContainsRe(out, r'Register a branch')
def test_register_no_url_no_branch(self):
"""register-branch command requires parameters"""
self.make_repository('.')
self.run_bzr_error(
['register-branch requires a public branch url - '
'see bzr help register-branch'],
'register-branch')
def test_register_no_url_in_published_branch_no_error(self):
b = self.make_branch('.')
b.set_public_branch('http://test-server.com/bzr/branch')
out, err = self.run_bzr(['register-branch', '--dry-run'])
self.assertEqual('Branch registered.\n', out)
self.assertEqual('', err)
def test_register_no_url_in_unpublished_branch_errors(self):
b = self.make_branch('.')
out, err = self.run_bzr_error(['no public branch'],
['register-branch', '--dry-run'])
self.assertEqual('', out)
def test_register_dry_run(self):
out, err = self.run_bzr(['register-branch',
'http://test-server.com/bzr/branch',
'--dry-run'])
self.assertEqual(out, 'Branch registered.\n')
def test_onto_transport(self):
"""How the request is sent by transmitting across a mock Transport"""
# use a real transport, but intercept at the http/xml layer
transport = InstrumentedXMLRPCTransport(self, expect_auth=True)
service = LaunchpadService(transport)
service.registrant_email = 'testuser@launchpad.net'
service.registrant_password = 'testpassword'
rego = BranchRegistrationRequest('http://test-server.com/bzr/branch',
'branch-id',
'my test branch',
'description',
'author@launchpad.net',
'product')
rego.submit(service)
self.assertEqual(transport.connected_host, 'xmlrpc.launchpad.net')
self.assertEqual(len(transport.sent_params), 6)
self.assertEqual(transport.sent_params,
('http://test-server.com/bzr/branch', # branch_url
'branch-id', # branch_name
'my test branch', # branch_title
'description',
'author@launchpad.net',
'product'))
self.assertTrue(transport.got_request)
def test_onto_transport_unauthenticated(self):
"""An unauthenticated request is transmitted across a mock Transport"""
transport = InstrumentedXMLRPCTransport(self, expect_auth=False)
service = LaunchpadService(transport)
resolve = ResolveLaunchpadPathRequest('bzr')
resolve.submit(service)
self.assertEqual(transport.connected_host, 'xmlrpc.launchpad.net')
self.assertEqual(len(transport.sent_params), 1)
self.assertEqual(transport.sent_params, ('bzr', ))
self.assertTrue(transport.got_request)
def test_subclass_request(self):
"""Define a new type of xmlrpc request"""
class DummyRequest(BaseRequest):
_methodname = 'dummy_request'
def _request_params(self):
return (42,)
service = MockLaunchpadService()
service.registrant_email = 'test@launchpad.net'
service.registrant_password = ''
request = DummyRequest()
request.submit(service)
self.assertEqual(service.called_method_name, 'dummy_request')
self.assertEqual(service.called_method_params, (42,))
def test_mock_server_registration(self):
"""Send registration to mock server"""
test_case = self
class MockRegistrationService(MockLaunchpadService):
def send_request(self, method_name, method_params, authenticated):
test_case.assertEqual(method_name, "register_branch")
test_case.assertEqual(list(method_params),
['url', 'name', 'title', 'description', 'email', 'name'])
test_case.assertEqual(authenticated, True)
return 'result'
service = MockRegistrationService()
rego = BranchRegistrationRequest('url', 'name', 'title',
'description', 'email', 'name')
result = rego.submit(service)
self.assertEqual(result, 'result')
def test_mock_server_registration_with_defaults(self):
"""Send registration to mock server"""
test_case = self
class MockRegistrationService(MockLaunchpadService):
def send_request(self, method_name, method_params, authenticated):
test_case.assertEqual(method_name, "register_branch")
test_case.assertEqual(list(method_params),
['http://server/branch', 'branch', '', '', '', ''])
test_case.assertEqual(authenticated, True)
return 'result'
service = MockRegistrationService()
rego = BranchRegistrationRequest('http://server/branch')
result = rego.submit(service)
self.assertEqual(result, 'result')
def test_mock_bug_branch_link(self):
"""Send bug-branch link to mock server"""
test_case = self
class MockService(MockLaunchpadService):
def send_request(self, method_name, method_params, authenticated):
test_case.assertEqual(method_name, "link_branch_to_bug")
test_case.assertEqual(list(method_params),
['http://server/branch', 1234, ''])
test_case.assertEqual(authenticated, True)
return 'http://launchpad.net/bug/1234'
service = MockService()
rego = BranchBugLinkRequest('http://server/branch', 1234)
result = rego.submit(service)
self.assertEqual(result, 'http://launchpad.net/bug/1234')
def test_mock_resolve_lp_url(self):
test_case = self
class MockService(MockLaunchpadService):
def send_request(self, method_name, method_params, authenticated):
test_case.assertEqual(method_name, "resolve_lp_path")
test_case.assertEqual(list(method_params), ['bzr'])
test_case.assertEqual(authenticated, False)
return dict(urls=[
'bzr+ssh://bazaar.launchpad.net~bzr/bzr/trunk',
'sftp://bazaar.launchpad.net~bzr/bzr/trunk',
'bzr+http://bazaar.launchpad.net~bzr/bzr/trunk',
'http://bazaar.launchpad.net~bzr/bzr/trunk'])
service = MockService()
resolve = ResolveLaunchpadPathRequest('bzr')
result = resolve.submit(service)
self.assertTrue('urls' in result)
self.assertEqual(result['urls'], [
'bzr+ssh://bazaar.launchpad.net~bzr/bzr/trunk',
'sftp://bazaar.launchpad.net~bzr/bzr/trunk',
'bzr+http://bazaar.launchpad.net~bzr/bzr/trunk',
'http://bazaar.launchpad.net~bzr/bzr/trunk'])
class TestGatherUserCredentials(tests.TestCaseInTempDir):
def setUp(self):
super(TestGatherUserCredentials, self).setUp()
# make sure we have a reproducible standard environment
self.overrideEnv('BZR_LP_XMLRPC_URL', None)
def test_gather_user_credentials_has_password(self):
service = LaunchpadService()
service.registrant_password = 'mypassword'
# This should be a basic no-op, since we already have the password
service.gather_user_credentials()
self.assertEqual('mypassword', service.registrant_password)
def test_gather_user_credentials_from_auth_conf(self):
auth_path = config.authentication_config_filename()
service = LaunchpadService()
g_conf = config.GlobalStack()
g_conf.set('email', 'Test User <test@user.com>')
g_conf.store.save()
# FIXME: auth_path base dir exists only because bazaar.conf has just
# been saved, brittle... -- vila 20120731
f = open(auth_path, 'wb')
try:
scheme, hostinfo = urlparse.urlsplit(service.service_url)[:2]
f.write('[section]\n'
'scheme=%s\n'
'host=%s\n'
'user=test@user.com\n'
'password=testpass\n'
% (scheme, hostinfo))
finally:
f.close()
self.assertIs(None, service.registrant_password)
service.gather_user_credentials()
self.assertEqual('test@user.com', service.registrant_email)
self.assertEqual('testpass', service.registrant_password)
def test_gather_user_credentials_prompts(self):
service = LaunchpadService()
self.assertIs(None, service.registrant_password)
g_conf = config.GlobalStack()
g_conf.set('email', 'Test User <test@user.com>')
g_conf.store.save()
stdout = tests.StringIOWrapper()
stderr = tests.StringIOWrapper()
ui.ui_factory = tests.TestUIFactory(stdin='userpass\n',
stdout=stdout, stderr=stderr)
self.assertIs(None, service.registrant_password)
service.gather_user_credentials()
self.assertEqual('test@user.com', service.registrant_email)
self.assertEqual('userpass', service.registrant_password)
self.assertEqual('', stdout.getvalue())
self.assertContainsRe(stderr.getvalue(),
'launchpad.net password for test@user\\.com')
|