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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
import time
import email
import unittest
try:
from unittest.mock import Mock, patch, call
except ImportError:
from mock import Mock, patch, call
import pyzor.client
import pyzor.account
class TestBase(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
self.thread = 33715
self.timeout = None
self.time = str(int(time.time()))
patch("pyzor.account.sign_msg", return_value="TestSig").start()
patch("pyzor.account.hash_key").start()
# the response the mock socket will send
self.response = {
"Code": "200",
"Diag": "OK",
"PV": "2.1",
"Thread": "33715",
"Time": self.time,
}
self.mresponse = None
self.mock_socket = None
# the expected request that the client should send
self.expected = {
"Thread": str(self.thread),
"PV": str(pyzor.proto_version),
"User": "anonymous",
"Time": self.time,
"Sig": "TestSig",
}
def tearDown(self):
unittest.TestCase.tearDown(self)
patch.stopall()
def get_requests(self):
for mock_call in self.mock_socket.mock_calls:
name, args, kwargs = mock_call
if name == "socket().sendto":
yield args, kwargs
def check_request(self):
"""Check if the request sent by the client is equal
to the expected one.
"""
req = {}
for args, _ in self.get_requests():
self.assertEqual(args[2], ("127.0.0.1", 24441))
req = dict(email.message_from_string(args[0].decode()))
self.assertEqual(req, self.expected)
def patch_all(self, conf=None):
if conf is None:
conf = {}
patch("pyzor.message.ThreadId.generate", return_value=self.thread).start()
if self.response:
response = (
"\n".join(
"%s: %s" % (key, value) for key, value in self.response.items()
)
+ "\n\n"
)
self.mresponse = response.encode(), ("127.0.0.1", 24441)
else:
self.mresponse = None
addrinfo = [(2, 2, 17, "", ("127.0.0.1", 24441))]
config = {
"socket.return_value": Mock(),
"socket.return_value.recvfrom.return_value": self.mresponse,
"getaddrinfo.return_value": addrinfo,
}
config.update(conf)
self.mock_socket = patch("pyzor.client.socket", **config).start()
def check_client(self, accounts, method, *args, **kwargs):
"""Tests if the request and response are sent
and read correctly by the client.
"""
client = pyzor.client.Client(accounts=accounts, timeout=self.timeout)
got_response = getattr(client, method)(*args, **kwargs)
self.assertEqual(str(got_response), self.mresponse[0].decode())
if self.expected is not None:
self.check_request()
return client
class ClientTest(TestBase):
def test_ping(self):
"""Test the client ping request"""
self.expected["Op"] = "ping"
self.patch_all()
self.check_client(None, "ping")
def test_pong(self):
"""Test the client pong request"""
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op"] = "pong"
self.expected["Op-Digest"] = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
self.check_client(None, "pong", digest)
def test_check(self):
"""Test the client check request"""
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op"] = "check"
self.expected["Op-Digest"] = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
self.check_client(None, "check", digest)
def test_info(self):
"""Test the client info request"""
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op"] = "info"
self.expected["Op-Digest"] = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
self.check_client(None, "info", digest)
def test_report(self):
"""Test the client report request"""
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op"] = "report"
self.expected["Op-Digest"] = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op-Spec"] = "20,3,60,3"
self.patch_all()
self.check_client(None, "report", digest)
def test_whitelist(self):
"""Test the client whitelist request"""
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op"] = "whitelist"
self.expected["Op-Digest"] = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.expected["Op-Spec"] = "20,3,60,3"
self.patch_all()
self.check_client(None, "whitelist", digest)
def test_handle_account(self):
"""Test client handling accounts"""
test_account = pyzor.account.Account("TestUser", "TestKey", "TestSalt")
self.expected["Op"] = "ping"
self.expected["User"] = "TestUser"
self.patch_all()
self.check_client({("public.pyzor.org", 24441): test_account}, "ping")
def test_handle_invalid_thread(self):
"""Test invalid thread id"""
self.thread += 20
self.expected["Op"] = "ping"
self.patch_all()
self.assertRaises(pyzor.ProtocolError, self.check_client, None, "ping")
def test_set_timeout(self):
self.expected = None
self.patch_all()
self.timeout = 10
self.check_client(None, "ping")
calls = [
call.socket().settimeout(10),
]
self.mock_socket.assert_has_calls(calls)
class BatchClientTest(TestBase):
def test_report(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(10):
client.report(digest)
args, kwargs = list(self.get_requests())[0]
msg = email.message_from_string(args[0].decode())
self.assertEqual(len(msg.get_all("Op-Digest")), 10)
def test_report_to_few(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.report(digest)
self.assertEqual(list(self.get_requests()), [])
def test_whitelist(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(10):
client.whitelist(digest)
args, kwargs = list(self.get_requests())[0]
msg = email.message_from_string(args[0].decode())
self.assertEqual(len(msg.get_all("Op-Digest")), 10)
def test_whitelist_to_few(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.whitelist(digest)
self.assertEqual(list(self.get_requests()), [])
def test_force_report(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.report(digest)
client.force()
args, kwargs = list(self.get_requests())[0]
msg = email.message_from_string(args[0].decode())
self.assertEqual(len(msg.get_all("Op-Digest")), 9)
def test_force_whitelist(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.whitelist(digest)
client.force()
args, kwargs = list(self.get_requests())[0]
msg = email.message_from_string(args[0].decode())
self.assertEqual(len(msg.get_all("Op-Digest")), 9)
def test_flush_report(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.report(digest)
client.flush()
client.report(digest)
self.assertEqual(list(self.get_requests()), [])
def test_flush_whitelist(self):
digest = "2aedaac999d71421c9ee49b9d81f627a7bc570aa"
self.patch_all()
client = pyzor.client.BatchClient()
for i in range(9):
client.whitelist(digest)
client.flush()
client.whitelist(digest)
self.assertEqual(list(self.get_requests()), [])
class ClientRunnerTest(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
self.server = "test.example.com", 24441
def tearDown(self):
unittest.TestCase.tearDown(self)
def check_runner(self, test_class, response, results, kwargs=None):
if kwargs is None:
kwargs = {}
kwargs["return_value"] = response
mock_routine = Mock(**kwargs)
runner = test_class(mock_routine)
runner.run(self.server, ())
self.assertEqual(runner.results, results)
return runner
def test_normal(self):
response = pyzor.message.Response()
response["Diag"] = "OK"
response["Code"] = "200"
server = "%s:%s\t" % self.server
results = [
"%s%s\n" % (server, response.head_tuple()),
]
self.check_runner(pyzor.client.ClientRunner, response, results)
def test_check(self):
response = pyzor.message.Response()
response["Diag"] = "OK"
response["Code"] = "200"
response["Count"] = "2"
response["WL-Count"] = "1"
server = "%s:%s\t" % self.server
results = ["%s%s\t%s\t%s\n" % (server, response.head_tuple(), "2", "1")]
self.check_runner(pyzor.client.CheckClientRunner, response, results)
def test_info(self):
response = """Code: 200
Diag: OK
PV: 2.1
Thread: 8521
Entered: 1400221786
Updated: 1400221794
WL-Entered: 0
WL-Updated: 0
Count: 4
WL-Count: 0
"""
response = email.message_from_string(response, _class=pyzor.message.Response)
server = "%s:%s" % self.server
result = (
"%s\t(200, 'OK')\n"
"\tCount: 4\n"
"\tEntered: %s\n"
"\tUpdated: %s\n"
"\tWL-Count: 0\n"
"\tWL-Entered: %s\n"
"\tWL-Updated: %s\n\n"
% (
server,
time.ctime(1400221786),
time.ctime(1400221794),
time.ctime(0),
time.ctime(0),
)
)
self.maxDiff = None
self.check_runner(pyzor.client.InfoClientRunner, response, [result])
def test_info_never(self):
response = """Code: 200
Diag: OK
PV: 2.1
Thread: 8521
Entered: 1400221786
Updated: 1400221794
WL-Entered: -1
WL-Updated: -1
Count: 4
WL-Count: 0
"""
response = email.message_from_string(response, _class=pyzor.message.Response)
server = "%s:%s" % self.server
result = (
"%s\t(200, 'OK')\n"
"\tCount: 4\n"
"\tEntered: %s\n"
"\tUpdated: %s\n"
"\tWL-Count: 0\n"
"\tWL-Entered: Never\n"
"\tWL-Updated: Never\n\n"
% (server, time.ctime(1400221786), time.ctime(1400221794))
)
self.maxDiff = None
self.check_runner(pyzor.client.InfoClientRunner, response, [result])
def suite():
"""Gather all the tests from this module in a test suite."""
test_suite = unittest.TestSuite()
test_suite.addTest(unittest.makeSuite(ClientTest))
test_suite.addTest(unittest.makeSuite(BatchClientTest))
test_suite.addTest(unittest.makeSuite(ClientRunnerTest))
return test_suite
if __name__ == "__main__":
unittest.main()
|
