Newer
Older
from unittest import TestCase
from requests_mock import Mocker
default_session = functools.partial(postgrestutils.Session, base_uri='http://example.com/', token=TOKEN)
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
DEFAULT_HEADERS = {
'Authorization': 'Bearer {}'.format(TOKEN),
'Accept': 'application/json'
}
SUPERHERO_TEST_DATA = [
{
'id': 68,
'name': 'Batman',
'gender': 'Male',
'eye_color': 'blue',
'race': 'Human',
'hair_color': 'black',
'height': 188,
'publisher': 'DC Comics',
'skin_color': None,
'alignment': 'good',
'weight': 95
}, {
'id': 212,
'name': 'Deadpool',
'gender': 'Male',
'eye_color': 'brown',
'race': 'Mutant',
'hair_color': 'No Hair',
'height': 188,
'publisher': 'Marvel Comics',
'skin_color': None,
'alignment': 'neutral',
'weight': 95
}, {
'id': 345,
'name': 'Iron Man',
'gender': 'Male',
'eye_color': 'blue',
'race': 'Human',
'hair_color': 'Black',
'height': 198,
'publisher': 'Marvel Comics',
'skin_color': None,
'alignment': 'good',
'weight': 191
}, {
'id': 369,
'name': 'Joker',
'gender': 'Male',
'eye_color': 'green',
'race': 'Human',
'hair_color': 'Green',
'height': 196,
'publisher': 'DC Comics',
'skin_color': 'white',
'alignment': 'bad',
'weight': 86
}, {
'id': 423,
'name': 'Magneto',
'gender': 'Male',
'eye_color': 'grey',
'race': 'Mutant',
'hair_color': 'White',
'height': 188,
'publisher': 'Marvel Comics',
'skin_color': None,
'alignment': 'bad',
'weight': 86
}
]
@Mocker()
class TestPgrestClientGet(TestCase):
def setUp(self):
super().setUp()
self.data = SUPERHERO_TEST_DATA[0]
def test_single_object_returned(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero?id=eq.1000000000',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=200,
reason='OK',
json=self.data
)
with default_session() as s:
params = {'id': 'eq.1000000000'}
res = s.get('superhero', params=params)
self.assertTrue(mock.called_once)
def test_object_does_not_exist(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero?id=eq.1337',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=406,
reason='Not Acceptable',
text="""{"details":"Results contain 0 rows, application/vnd.pgrst.object+json requires 1 row","message":"""
""""JSON object requested, multiple (or no) rows returned"}"""
)
with default_session() as s, self.assertRaises(postgrestutils.ObjectDoesNotExist):
params = {'id': 'eq.1337'}
s.get('superhero', params=params)
self.assertTrue(mock.called_once)
def test_multiple_objects_returned(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=406,
reason='Not Acceptable',
text="""{"details":"Results contain 5 rows, application/vnd.pgrst.object+json requires 1 row","message":"""
""""JSON object requested, multiple (or no) rows returned"}"""
)
with default_session() as s, self.assertRaises(postgrestutils.MultipleObjectsReturned):
s.get('superhero')
self.assertTrue(mock.called_once)
def test_datetime_parser(self, mock):
expected = {
'id': 1337,
'random': datetime.datetime(2020, 5, 20, 8, 35, 6, 659425, tzinfo=datetime.timezone.utc)
}
mock.register_uri(
'GET',
'http://example.com/random_datetime',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=200,
reason='OK',
json={'id': 1337, 'random': "2020-05-20T08:35:06.659425+00:00"}
)
with default_session() as s:
params = {'id': 'eq.1337'}
res = s.get('random_datetime', params=params)
self.assertTrue(mock.called_once)
def test_without_datetime_parser(self, mock):
test_json = {'id': 1337, 'random': "2020-05-20T08:35:06.659425+00:00"}
mock.register_uri(
'GET',
'http://example.com/random_datetime',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=200,
reason='OK',
json=test_json
)
with default_session() as s:
params = {'select': 'id,random', 'id': 'eq.1337'}
res = s.get('random_datetime', params=params, parse_dt=False)
self.assertTrue(mock.called_once)
@Mocker()
class TestPgrestClientFilterStrategyNone(TestCase):
def setUp(self):
super().setUp()
self.data = SUPERHERO_TEST_DATA
def test_fetch_all_first(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
with default_session() as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(list(res), self.data) # fetch data
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._result_cache, self.data) # fetched data should be cached
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should be cached
self.assertEqual(list(res), self.data) # should utilize cache
self.assertEqual(res[:1], self.data[:1]) # should utilize cache
self.assertEqual(res[:0], self.data[:0]) # should return empty list
self.assertEqual(res[4:2], self.data[4:2]) # should return empty list
self.assertEqual(res[2:], self.data[2:]) # should utilize cache
self.assertEqual(res[0], self.data[0]) # should utilize cache
self.assertTrue(mock.called_once) # should not have been called again
def test_fetch_len_first(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
with default_session() as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(len(res), len(self.data)) # should fetch len
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should be cached
self.assertEqual(res._result_cache, self.data) # results should be cached (counting strategy none)
self.assertEqual(res[:1], self.data[:1]) # should utilize cache
self.assertEqual(res[:0], self.data[:0]) # should return empty list
self.assertEqual(res[4:2], self.data[4:2]) # should return empty list
self.assertEqual(res[2:], self.data[2:]) # should utilize cache
self.assertEqual(res[0], self.data[0]) # should utilize cache
self.assertEqual(list(res), self.data) # should utilize cache
self.assertTrue(mock.called_once) # should not have been called again
def test_cache_fetching_unbounded_slice(self, mock):
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
with default_session() as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(res[:], self.data) # fetch data
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._result_cache, self.data) # fetched data should be cached
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should be cached
self.assertEqual(res[:], self.data) # should utilize cache
self.assertEqual(res[:0], self.data[:0]) # should return empty list
self.assertEqual(res[4:2], self.data[4:2]) # should return empty list
self.assertEqual(res[2:], self.data[2:]) # should utilize cache
self.assertEqual(res[0], self.data[0]) # should utilize cache
self.assertTrue(mock.called_once) # should not have been called again
@Mocker()
class TestPgrestClientFilterStrategyExact(TestCase):
def setUp(self):
super().setUp()
self.data = SUPERHERO_TEST_DATA
def test_fetch_all_first(self, mock):
# in order to fetch all
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
with default_session(count=postgrestutils.Count.EXACT) as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(list(res), self.data) # fetch data
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._result_cache, self.data) # fetched data should be cached
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should also be cached
self.assertEqual(list(res), self.data) # should utilize cache
self.assertEqual(res[:1], self.data[:1]) # should utilize cache
self.assertEqual(res[:0], self.data[:0]) # should return empty list
self.assertEqual(res[4:2], self.data[4:2]) # should return empty list
self.assertEqual(res[2:], self.data[2:]) # should utilize cache
self.assertEqual(res[0], self.data[0]) # should utilize cache
self.assertTrue(mock.called_once) # should not have been called again
def test_fetch_len_first(self, mock):
# in order to fetch all
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
# in order to fetch first
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Range-Unit': 'items', 'Range': '0-0'}},
status_code=200,
reason='OK',
headers={'Content-Range': '0-0/*'},
)
# in order to fetch range since index 2
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Range-Unit': 'items', 'Range': '2-'}},
status_code=200,
reason='OK',
headers={'Content-Range': '2-4/*'},
json=self.data[2:]
)
# in order to fetch length
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Range-Unit': 'items', 'Range': '0-0', 'Prefer': 'count=exact'}},
status_code=206,
reason='Partial Content',
headers={'Content-Range': '0-0/5'},
json=self.data[0]
)
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
with default_session(count=postgrestutils.Count.EXACT) as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(len(res), len(self.data)) # should fetch len
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should be cached
self.assertEqual(res[:1], self.data[:1]) # should fetch first element as range
self.assertEqual(res[:0], self.data[:0]) # should return empty list
self.assertEqual(res[4:2], self.data[4:2]) # should return empty list
self.assertEqual(res[2:], self.data[2:]) # should fetch range starting at index 2
self.assertEqual(res[0], self.data[0]) # should fetch first element as range but return dict
self.assertEqual(list(res), self.data) # should fetch all elements
self.assertEqual(res._result_cache, self.data) # should cache all elements
self.assertTrue(mock.called) # should have been called at least once
self.assertEqual(mock.call_count, 5) # should have been called 5 times (fetch len, range, first and all)
@Mocker()
class TestPgrestClientSessionDefaults(TestCase):
def setUp(self):
super().setUp()
self.data = SUPERHERO_TEST_DATA
def test_override_parse_dt_session_option(self, mock):
test_json = {'id': 1337, 'random': "2020-05-20T08:35:06.659425+00:00"}
mock.register_uri(
'GET',
'http://example.com/random_datetime',
request_headers={**DEFAULT_HEADERS, **{'Accept': 'application/vnd.pgrst.object+json'}},
status_code=200,
reason='OK',
json=test_json
)
with default_session(parse_dt=False) as s:
params = {'select': 'id,random', 'id': 'eq.1337'}
res = s.get('random_datetime', params=params)
self.assertEqual(res, test_json)
self.assertTrue(mock.called_once)
mock.reset()
res2 = s.get('random_datetime', params=params, parse_dt=True)
expected = {
'id': 1337,
'random': datetime.datetime(2020, 5, 20, 8, 35, 6, 659425, tzinfo=datetime.timezone.utc)
}
self.assertEqual(res2, expected)
self.assertTrue(mock.called_once)
def test_override_count_session_option(self, mock):
# in order to fetch all
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
# in order to fetch length
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Range-Unit': 'items', 'Range': '0-0', 'Prefer': 'count=exact'}},
status_code=206,
reason='Partial Content',
headers={'Content-Range': '0-0/5'},
json=self.data[0]
)
with default_session(count=postgrestutils.Count.EXACT) as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(len(res), len(self.data)) # should fetch len
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._len_cache, len(self.data)) # len of fetched data should be cached
self.assertNotEqual(res._result_cache, self.data) # should not have cached all elements
mock.reset() # reset mock
# override the count session option in this specific request
res2 = s.filter('superhero', count=postgrestutils.Count.NONE)
self.assertIsInstance(res2, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(len(res2), len(self.data)) # should fetch all elements to get len
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res2._len_cache, len(self.data)) # len of fetched data should be cached
self.assertEqual(res2._result_cache, self.data) # should have cached all elements
def test_override_schema_session_option(self, mock):
# in order to fetch all
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers=DEFAULT_HEADERS,
status_code=200,
reason='OK',
json=self.data
)
# in order to fetch all (other schema)
mock.register_uri(
'GET',
'http://example.com/superhero',
request_headers={**DEFAULT_HEADERS, **{'Accept-Profile': 'other_schema'}},
status_code=200,
reason='OK',
json=self.data
)
with default_session(schema='other_schema') as s:
res = s.filter('superhero')
self.assertIsInstance(res, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request should have been made yet
self.assertEqual(list(res), self.data) # should fetch all elements
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res._result_cache, self.data) # should have cached all elements
self.assertEqual(res._len_cache, len(self.data)) # should have cached the length
mock.reset()
res2 = s.filter('superhero', schema=postgrestutils.DEFAULT_SCHEMA)
self.assertIsInstance(res2, postgrestutils.JsonResultSet) # should return lazy object
self.assertFalse(mock.called) # no request.should have been made yet
self.assertEqual(list(res2), self.data) # should fetch all elements
self.assertTrue(mock.called_once) # should have been called once
self.assertEqual(res2._result_cache, self.data) # should have cached all elements
self.assertEqual(res2._len_cache, len(self.data)) # should have cached the length