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
|
import httplib
import StringIO
import time
import webob
from nova import test
import nova.api.openstack.ratelimiting as ratelimiting
class LimiterTest(test.TestCase):
def setUp(self):
super(LimiterTest, self).setUp()
self.limits = {
'a': (5, ratelimiting.PER_SECOND),
'b': (5, ratelimiting.PER_MINUTE),
'c': (5, ratelimiting.PER_HOUR),
'd': (1, ratelimiting.PER_SECOND),
'e': (100, ratelimiting.PER_SECOND)}
self.rl = ratelimiting.Limiter(self.limits)
def exhaust(self, action, times_until_exhausted, **kwargs):
for i in range(times_until_exhausted):
when = self.rl.perform(action, **kwargs)
self.assertEqual(when, None)
num, period = self.limits[action]
delay = period * 1.0 / num
# Verify that we are now thoroughly delayed
for i in range(10):
when = self.rl.perform(action, **kwargs)
self.assertAlmostEqual(when, delay, 2)
def test_second(self):
self.exhaust('a', 5)
time.sleep(0.2)
self.exhaust('a', 1)
time.sleep(1)
self.exhaust('a', 5)
def test_minute(self):
self.exhaust('b', 5)
def test_one_per_period(self):
def allow_once_and_deny_once():
when = self.rl.perform('d')
self.assertEqual(when, None)
when = self.rl.perform('d')
self.assertAlmostEqual(when, 1, 2)
return when
time.sleep(allow_once_and_deny_once())
time.sleep(allow_once_and_deny_once())
allow_once_and_deny_once()
def test_we_can_go_indefinitely_if_we_spread_out_requests(self):
for i in range(200):
when = self.rl.perform('e')
self.assertEqual(when, None)
time.sleep(0.01)
def test_users_get_separate_buckets(self):
self.exhaust('c', 5, username='alice')
self.exhaust('c', 5, username='bob')
self.exhaust('c', 5, username='chuck')
self.exhaust('c', 0, username='chuck')
self.exhaust('c', 0, username='bob')
self.exhaust('c', 0, username='alice')
class FakeLimiter(object):
"""Fake Limiter class that you can tell how to behave."""
def __init__(self, test):
self._action = self._username = self._delay = None
self.test = test
def mock(self, action, username, delay):
self._action = action
self._username = username
self._delay = delay
def perform(self, action, username):
self.test.assertEqual(action, self._action)
self.test.assertEqual(username, self._username)
return self._delay
class WSGIAppTest(test.TestCase):
def setUp(self):
super(WSGIAppTest, self).setUp()
self.limiter = FakeLimiter(self)
self.app = ratelimiting.WSGIApp(self.limiter)
def test_invalid_methods(self):
requests = []
for method in ['GET', 'PUT', 'DELETE']:
req = webob.Request.blank('/limits/michael/breakdance',
dict(REQUEST_METHOD=method))
requests.append(req)
for req in requests:
self.assertEqual(req.get_response(self.app).status_int, 405)
def test_invalid_urls(self):
requests = []
for prefix in ['limit', '', 'limiter2', 'limiter/limits', 'limiter/1']:
req = webob.Request.blank('/%s/michael/breakdance' % prefix,
dict(REQUEST_METHOD='POST'))
requests.append(req)
for req in requests:
self.assertEqual(req.get_response(self.app).status_int, 404)
def verify(self, url, username, action, delay=None):
"""Make sure that POSTing to the given url causes the given username
to perform the given action. Make the internal rate limiter return
delay and make sure that the WSGI app returns the correct response.
"""
req = webob.Request.blank(url, dict(REQUEST_METHOD='POST'))
self.limiter.mock(action, username, delay)
resp = req.get_response(self.app)
if not delay:
self.assertEqual(resp.status_int, 200)
else:
self.assertEqual(resp.status_int, 403)
self.assertEqual(resp.headers['X-Wait-Seconds'], "%.2f" % delay)
def test_good_urls(self):
self.verify('/limiter/michael/hoot', 'michael', 'hoot')
def test_escaping(self):
self.verify('/limiter/michael/jump%20up', 'michael', 'jump up')
def test_response_to_delays(self):
self.verify('/limiter/michael/hoot', 'michael', 'hoot', 1)
self.verify('/limiter/michael/hoot', 'michael', 'hoot', 1.56)
self.verify('/limiter/michael/hoot', 'michael', 'hoot', 1000)
class FakeHttplibSocket(object):
"""a fake socket implementation for httplib.HTTPResponse, trivial"""
def __init__(self, response_string):
self._buffer = StringIO.StringIO(response_string)
def makefile(self, _mode, _other):
"""Returns the socket's internal buffer"""
return self._buffer
class FakeHttplibConnection(object):
"""A fake httplib.HTTPConnection
Requests made via this connection actually get translated and routed into
our WSGI app, we then wait for the response and turn it back into
an httplib.HTTPResponse.
"""
def __init__(self, app, host, is_secure=False):
self.app = app
self.host = host
def request(self, method, path, data='', headers={}):
req = webob.Request.blank(path)
req.method = method
req.body = data
req.headers = headers
req.host = self.host
# Call the WSGI app, get the HTTP response
resp = str(req.get_response(self.app))
# For some reason, the response doesn't have "HTTP/1.0 " prepended; I
# guess that's a function the web server usually provides.
resp = "HTTP/1.0 %s" % resp
sock = FakeHttplibSocket(resp)
self.http_response = httplib.HTTPResponse(sock)
self.http_response.begin()
def getresponse(self):
return self.http_response
def wire_HTTPConnection_to_WSGI(host, app):
"""Monkeypatches HTTPConnection so that if you try to connect to host, you
are instead routed straight to the given WSGI app.
After calling this method, when any code calls
httplib.HTTPConnection(host)
the connection object will be a fake. Its requests will be sent directly
to the given WSGI app rather than through a socket.
Code connecting to hosts other than host will not be affected.
This method may be called multiple times to map different hosts to
different apps.
"""
class HTTPConnectionDecorator(object):
"""Wraps the real HTTPConnection class so that when you instantiate
the class you might instead get a fake instance."""
def __init__(self, wrapped):
self.wrapped = wrapped
def __call__(self, connection_host, *args, **kwargs):
if connection_host == host:
return FakeHttplibConnection(app, host)
else:
return self.wrapped(connection_host, *args, **kwargs)
httplib.HTTPConnection = HTTPConnectionDecorator(httplib.HTTPConnection)
class WSGIAppProxyTest(test.TestCase):
def setUp(self):
"""Our WSGIAppProxy is going to call across an HTTPConnection to a
WSGIApp running a limiter. The proxy will send input, and the proxy
should receive that same input, pass it to the limiter who gives a
result, and send the expected result back.
The HTTPConnection isn't real -- it's monkeypatched to point straight
at the WSGIApp. And the limiter isn't real -- it's a fake that
behaves the way we tell it to.
"""
super(WSGIAppProxyTest, self).setUp()
self.limiter = FakeLimiter(self)
app = ratelimiting.WSGIApp(self.limiter)
wire_HTTPConnection_to_WSGI('100.100.100.100:80', app)
self.proxy = ratelimiting.WSGIAppProxy('100.100.100.100:80')
def test_200(self):
self.limiter.mock('conquer', 'caesar', None)
when = self.proxy.perform('conquer', 'caesar')
self.assertEqual(when, None)
def test_403(self):
self.limiter.mock('grumble', 'proletariat', 1.5)
when = self.proxy.perform('grumble', 'proletariat')
self.assertEqual(when, 1.5)
def test_failure(self):
def shouldRaise():
self.limiter.mock('murder', 'brutus', None)
self.proxy.perform('stab', 'brutus')
self.assertRaises(AssertionError, shouldRaise)
|
