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
| # -*- coding: utf-8 -*-
#
# Copyright 2011 Canonical Ltd.
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
"""Test the squid test case."""
import base64
from twisted.application import internet, service
from twisted.internet import defer, reactor
from twisted.web import client, error, http, resource, server
from ubuntuone.devtools.testcases.squid import SquidTestCase
SAMPLE_RESOURCE = "<p>Hello World!</p>"
SIMPLERESOURCE = "simpleresource"
THROWERROR = "throwerror"
UNAUTHORIZED = "unauthorized"
# ignore common twisted lint errors
# pylint: disable=C0103, W0212
class ProxyClientFactory(client.HTTPClientFactory):
"""Factory that supports proxy."""
def __init__(self, proxy_url, proxy_port, url, headers=None):
# we set the proxy details before the init because the parent __init__
# calls setURL
self.proxy_url = proxy_url
self.proxy_port = proxy_port
self.disconnected_d = defer.Deferred()
client.HTTPClientFactory.__init__(self, url, headers=headers)
def setURL(self, url):
self.host = self.proxy_url
self.port = self.proxy_port
self.url = url
self.path = url
def clientConnectionLost(self, connector, reason, reconnecting=0):
"""Connection lost."""
self.disconnected_d.callback(self)
class ProxyWebClient(object):
"""Provide useful web methods with proxy."""
def __init__(self, proxy_url=None, proxy_port=None, username=None,
password=None):
"""Create a new instance with the proxy settings."""
self.proxy_url = proxy_url
self.proxy_port = proxy_port
self.username = username
self.password = password
self.factory = None
self.connectors = []
def _connect(self, url, contextFactory):
"""Perform the connection."""
scheme, _, _, _ = client._parse(url)
# pylint: disable=E1101
if scheme == 'https':
from twisted.internet import ssl
if contextFactory is None:
contextFactory = ssl.ClientContextFactory()
self.connectors.append(reactor.connectSSL(self.proxy_url,
self.proxy_port,
self.factory,
contextFactory))
else:
self.connectors.append(reactor.connectTCP(self.proxy_url,
self.proxy_port,
self.factory))
# pylint: enable=E1101
def _process_auth_error(self, failure, url, contextFactory):
"""Process an auth failure."""
failure.trap(error.Error)
if failure.value.status == str(http.PROXY_AUTH_REQUIRED):
# we try to get the page using the basic auth
auth = base64.b64encode('%s:%s' % (self.username, self.password))
auth_header = 'Basic ' + auth.strip()
self.factory = ProxyClientFactory(self.proxy_url, self.proxy_port,
url, headers={'Proxy-Authorization': auth_header})
self._connect(url, contextFactory)
return self.factory.deferred
else:
return failure
def get_page(self, url, contextFactory=None, *args, **kwargs):
"""Download a webpage as a string.
This method relies on the twisted.web.client.getPage but adds and extra
step. If there is an auth error the method will perform a second try
so that the username and password are used.
"""
self.factory = ProxyClientFactory(self.proxy_url, self.proxy_port, url,
headers={'Connection': 'close'})
self._connect(url, contextFactory)
self.factory.deferred.addErrback(self._process_auth_error, url,
contextFactory)
return self.factory.deferred
@defer.inlineCallbacks
def shutdown(self):
"""Clean all connectors."""
for connector in self.connectors:
yield connector.disconnect()
defer.returnValue(True)
class SimpleResource(resource.Resource):
"""A simple web resource."""
def render_GET(self, request):
"""Make a bit of html out of these resource's
content."""
return SAMPLE_RESOURCE
class SaveHTTPChannel(http.HTTPChannel):
"""A save protocol to be used in tests."""
protocolInstance = None
def connectionMade(self):
"""Keep track of the given protocol."""
SaveHTTPChannel.protocolInstance = self
http.HTTPChannel.connectionMade(self)
class SaveSite(server.Site):
"""A site that let us know when it closed."""
protocol = SaveHTTPChannel
def __init__(self, *args, **kwargs):
"""Create a new instance."""
server.Site.__init__(self, *args, **kwargs)
# we disable the timeout in the tests, we will deal with it manually.
self.timeOut = None
class MockWebServer(object):
"""A mock webserver for testing"""
def __init__(self):
"""Start up this instance."""
root = resource.Resource()
root.putChild(SIMPLERESOURCE, SimpleResource())
root.putChild(THROWERROR, resource.NoResource())
unauthorized_resource = resource.ErrorPage(resource.http.UNAUTHORIZED,
"Unauthorized", "Unauthorized")
root.putChild(UNAUTHORIZED, unauthorized_resource)
self.site = SaveSite(root)
application = service.Application('web')
self.service_collection = service.IServiceCollection(application)
#pylint: disable=E1101
self.tcpserver = internet.TCPServer(0, self.site)
self.tcpserver.setServiceParent(self.service_collection)
self.service_collection.startService()
def get_url(self):
"""Build the url for this mock server."""
#pylint: disable=W0212
port_num = self.tcpserver._port.getHost().port
return "http://localhost:%d/" % port_num
@defer.inlineCallbacks
def stop(self):
"""Shut it down."""
#pylint: disable=E1101
# make the connection time out so that is works with squid3 when
# the connection is kept alive.
if self.site.protocol.protocolInstance:
self.site.protocol.protocolInstance.timeoutConnection()
yield self.service_collection.stopService()
class ProxyTestCase(SquidTestCase):
"""A squid test with no auth proxy."""
@defer.inlineCallbacks
def setUp(self):
"""Set the tests."""
yield super(ProxyTestCase, self).setUp()
self.ws = MockWebServer()
self.proxy_client = None
self.addCleanup(self.teardown_client_server)
self.url = self.ws.get_url() + SIMPLERESOURCE
def teardown_client_server(self):
"""Clean resources."""
if self.proxy_client is not None:
self.proxy_client.shutdown()
return defer.gatherResults([self.ws.stop(),
self.proxy_client.shutdown(),
self.proxy_client.factory.disconnected_d])
else:
return self.ws.stop()
def access_noauth_url(self, address, port):
"""Access a url throught the proxy."""
self.proxy_client = ProxyWebClient(proxy_url=address, proxy_port=port)
return self.proxy_client.get_page(self.url)
def access_auth_url(self, address, port, username, password):
"""Access a url throught the proxy."""
self.proxy_client = ProxyWebClient(proxy_url=address, proxy_port=port,
username=username, password=password)
return self.proxy_client.get_page(self.url)
@defer.inlineCallbacks
def test_noauth_url_access(self):
"""Test accessing to the url."""
settings = self.get_nonauth_proxy_settings()
# if there is an exception we fail.
data = yield self.access_noauth_url(settings['host'],
settings['port'])
self.assertEqual(SAMPLE_RESOURCE, data)
@defer.inlineCallbacks
def test_auth_url_access(self):
"""Test accessing to the url."""
settings = self.get_auth_proxy_settings()
# if there is an exception we fail.
data = yield self.access_auth_url(settings['host'],
settings['port'],
settings['username'],
settings['password'])
self.assertEqual(SAMPLE_RESOURCE, data)
def test_auth_url_401(self):
"""Test failing accessing the url."""
settings = self.get_auth_proxy_settings()
# swap password for username to fail
d = self.failUnlessFailure(self.access_auth_url(settings['host'],
settings['port'], settings['password'],
settings['username']), error.Error)
return d
def test_auth_url_407(self):
"""Test failing accessing the url."""
settings = self.get_auth_proxy_settings()
d = self.failUnlessFailure(self.access_noauth_url(settings['host'],
settings['port']), error.Error)
return d |
Last week
After a long and interesting journey, today we've released 
Latest Official Posts
