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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
# Copyright (c) 2015 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy
# of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
import json
import ddt
import mock
from oslo_utils import timeutils
from oslo_utils import uuidutils
from zaqar.common import consts
from zaqar.tests.unit.transport.websocket import base
from zaqar.tests.unit.transport.websocket import utils as test_utils
@ddt.ddt
class ClaimsBaseTest(base.V1_1Base):
config_file = "websocket_mongodb.conf"
def setUp(self):
super(ClaimsBaseTest, self).setUp()
self.protocol = self.transport.factory()
self.defaults = self.api.get_defaults()
self.project_id = '7e55e1a7e'
self.headers = {
'Client-ID': uuidutils.generate_uuid(),
'X-Project-ID': self.project_id
}
action = consts.QUEUE_CREATE
body = {"queue_name": "skittle"}
req = test_utils.create_request(action, body, self.headers)
with mock.patch.object(self.protocol, 'sendMessage') as msg_mock:
self.protocol.onMessage(req, False)
resp = json.loads(msg_mock.call_args[0][0].decode())
self.assertIn(resp['headers']['status'], [201, 204])
action = consts.MESSAGE_POST
body = {"queue_name": "skittle",
"messages": [
{'body': 239, 'ttl': 300},
{'body': {'key_1': 'value_1'}, 'ttl': 300},
{'body': [1, 3], 'ttl': 300},
{'body': 439, 'ttl': 300},
{'body': {'key_2': 'value_2'}, 'ttl': 300},
{'body': ['a', 'b'], 'ttl': 300},
{'body': 639, 'ttl': 300},
{'body': {'key_3': 'value_3'}, 'ttl': 300},
{'body': ["aa", "bb"], 'ttl': 300}]
}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertIn(resp['headers']['status'], [201, 204])
def tearDown(self):
super(ClaimsBaseTest, self).tearDown()
action = consts.QUEUE_DELETE
body = {'queue_name': 'skittle'}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
@ddt.data('[', '[]', '.', '"fail"')
def test_bad_claim(self, doc):
action = consts.CLAIM_CREATE
body = doc
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
action = consts.CLAIM_UPDATE
body = doc
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
def test_exceeded_claim(self):
action = consts.CLAIM_CREATE
body = {"queue_name": "skittle",
"ttl": 100,
"grace": 60,
"limit": 21}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
@ddt.data((-1, -1), (59, 60), (60, 59), (60, 43201), (43201, 60))
def test_unacceptable_ttl_or_grace(self, ttl_grace):
ttl, grace = ttl_grace
action = consts.CLAIM_CREATE
body = {"queue_name": "skittle",
"ttl": ttl,
"grace": grace}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
@ddt.data(-1, 59, 43201)
def test_unacceptable_new_ttl(self, ttl):
claim = self._get_a_claim()
action = consts.CLAIM_UPDATE
body = {"queue_name": "skittle",
"claim_id": claim['body']['claim_id'],
"ttl": ttl}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
def test_default_ttl_and_grace(self):
action = consts.CLAIM_CREATE
body = {"queue_name": "skittle"}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(201, resp['headers']['status'])
action = consts.CLAIM_GET
body = {"queue_name": "skittle",
"claim_id": resp['body']['claim_id']}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual(self.defaults.claim_ttl, resp['body']['ttl'])
def test_lifecycle(self):
# First, claim some messages
action = consts.CLAIM_CREATE
body = {"queue_name": "skittle",
"ttl": 100,
"grace": 60}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(201, resp['headers']['status'])
claimed_messages = resp['body']['messages']
claim_id = resp['body']['claim_id']
# No more messages to claim
body = {"queue_name": "skittle",
"ttl": 100,
"grace": 60}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
# Listing messages, by default, won't include claimed, will echo
action = consts.MESSAGE_LIST
body = {"queue_name": "skittle",
"echo": True}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual([], resp['body']['messages'])
# Listing messages, by default, won't include claimed, won't echo
body = {"queue_name": "skittle",
"echo": False}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual([], resp['body']['messages'])
# List messages, include_claimed, but don't echo
body = {"queue_name": "skittle",
"include_claimed": True,
"echo": False}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual(resp['body']['messages'], [])
# List messages with a different client-id and echo=false.
# Should return some messages
body = {"queue_name": "skittle",
"echo": False}
headers = {
'Client-ID': uuidutils.generate_uuid(),
'X-Project-ID': self.project_id
}
req = test_utils.create_request(action, body, headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
# Include claimed messages this time, and echo
body = {"queue_name": "skittle",
"include_claimed": True,
"echo": True}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual(len(claimed_messages), len(resp['body']['messages']))
message_id_1 = resp['body']['messages'][0]['id']
message_id_2 = resp['body']['messages'][1]['id']
# Try to delete the message without submitting a claim_id
action = consts.MESSAGE_DELETE
body = {"queue_name": "skittle",
"message_id": message_id_1}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(403, resp['headers']['status'])
# Delete the message and its associated claim
body = {"queue_name": "skittle",
"message_id": message_id_1,
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
# Try to get it from the wrong project
headers = {
'Client-ID': uuidutils.generate_uuid(),
'X-Project-ID': 'someproject'
}
action = consts.MESSAGE_GET
body = {"queue_name": "skittle",
"message_id": message_id_2}
req = test_utils.create_request(action, body, headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(404, resp['headers']['status'])
# Get the message
action = consts.MESSAGE_GET
body = {"queue_name": "skittle",
"message_id": message_id_2}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
# Update the claim
creation = timeutils.utcnow()
action = consts.CLAIM_UPDATE
body = {"queue_name": "skittle",
"ttl": 60,
"grace": 60,
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
# Get the claimed messages (again)
action = consts.CLAIM_GET
body = {"queue_name": "skittle",
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
query = timeutils.utcnow()
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
self.assertEqual(60, resp['body']['ttl'])
message_id_3 = resp['body']['messages'][0]['id']
estimated_age = timeutils.delta_seconds(creation, query)
# The claim's age should be 0 at this moment. But in some unexpected
# case, such as slow test, the age maybe larger than 0. Just skip
# asserting if so.
if resp['body']['age'] == 0:
self.assertGreater(estimated_age, resp['body']['age'])
# Delete the claim
action = consts.CLAIM_DELETE
body = {"queue_name": "skittle",
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
# Try to delete a message with an invalid claim ID
action = consts.MESSAGE_DELETE
body = {"queue_name": "skittle",
"message_id": message_id_3,
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(400, resp['headers']['status'])
# Make sure it wasn't deleted!
action = consts.MESSAGE_GET
body = {"queue_name": "skittle",
"message_id": message_id_2}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(200, resp['headers']['status'])
# Try to get a claim that doesn't exist
action = consts.CLAIM_GET
body = {"queue_name": "skittle",
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(404, resp['headers']['status'])
# Try to update a claim that doesn't exist
action = consts.CLAIM_UPDATE
body = {"queue_name": "skittle",
"ttl": 60,
"grace": 60,
"claim_id": claim_id}
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(404, resp['headers']['status'])
def test_post_claim_nonexistent_queue(self):
action = consts.CLAIM_CREATE
body = {"queue_name": "nonexistent",
"ttl": 100,
"grace": 60}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(204, resp['headers']['status'])
def test_get_claim_nonexistent_queue(self):
action = consts.CLAIM_GET
body = {"queue_name": "nonexistent",
"claim_id": "aaabbbba"}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(404, resp['headers']['status'])
def _get_a_claim(self):
action = consts.CLAIM_CREATE
body = {"queue_name": "skittle",
"ttl": 100,
"grace": 60}
send_mock = mock.Mock()
self.protocol.sendMessage = send_mock
req = test_utils.create_request(action, body, self.headers)
self.protocol.onMessage(req, False)
resp = json.loads(send_mock.call_args[0][0].decode())
self.assertEqual(201, resp['headers']['status'])
return resp
|
