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
440
441
442
443
444
445
446
447
448
449
450
451
452
|
#!/usr/bin/python
"""Test the classic PyGreSQL interface.
Sub-tests for large object support.
Contributed by Christoph Zwerschke.
These tests need a database to test against.
"""
import os
import tempfile
import unittest
from contextlib import suppress
from typing import Any
import pg # the module under test
from .config import dbhost, dbname, dbpasswd, dbport, dbuser
windows = os.name == 'nt'
# noinspection PyArgumentList
def connect():
"""Create a basic pg connection to the test database."""
connection = pg.connect(dbname, dbhost, dbport,
user=dbuser, passwd=dbpasswd)
connection.query("set client_min_messages=warning")
return connection
class TestModuleConstants(unittest.TestCase):
"""Test the existence of the documented module constants."""
def test_large_object_int_constants(self):
names = 'INV_READ INV_WRITE SEEK_SET SEEK_CUR SEEK_END'.split()
for name in names:
try:
value = getattr(pg, name)
except AttributeError:
self.fail(f'Module constant {name} is missing')
self.assertIsInstance(value, int)
class TestCreatingLargeObjects(unittest.TestCase):
"""Test creating large objects using a connection."""
def setUp(self):
self.c = connect()
self.c.query('begin')
def tearDown(self):
self.c.query('rollback')
self.c.close()
def assertIsLargeObject(self, obj): # noqa: N802
self.assertIsNotNone(obj)
self.assertTrue(hasattr(obj, 'open'))
self.assertTrue(hasattr(obj, 'close'))
self.assertTrue(hasattr(obj, 'oid'))
self.assertTrue(hasattr(obj, 'pgcnx'))
self.assertTrue(hasattr(obj, 'error'))
self.assertIsInstance(obj.oid, int)
self.assertNotEqual(obj.oid, 0)
self.assertIs(obj.pgcnx, self.c)
self.assertIsInstance(obj.error, str)
self.assertFalse(obj.error)
def test_lo_create(self):
large_object = self.c.locreate(pg.INV_READ | pg.INV_WRITE)
try:
self.assertIsLargeObject(large_object)
finally:
del large_object
def test_get_lo(self):
large_object = self.c.locreate(pg.INV_READ | pg.INV_WRITE)
try:
self.assertIsLargeObject(large_object)
oid = large_object.oid
finally:
del large_object
data = b'some data to be shared'
large_object = self.c.getlo(oid)
try:
self.assertIsLargeObject(large_object)
self.assertEqual(large_object.oid, oid)
large_object.open(pg.INV_WRITE)
large_object.write(data)
large_object.close()
finally:
del large_object
large_object = self.c.getlo(oid)
try:
self.assertIsLargeObject(large_object)
self.assertEqual(large_object.oid, oid)
large_object.open(pg.INV_READ)
r = large_object.read(80)
large_object.close()
large_object.unlink()
finally:
del large_object
self.assertIsInstance(r, bytes)
self.assertEqual(r, data)
def test_lo_import(self):
f : Any
if windows:
# NamedTemporaryFiles don't work well here
fname = 'temp_test_pg_largeobj_import.txt'
f = open(fname, 'wb') # noqa: SIM115
else:
f = tempfile.NamedTemporaryFile() # noqa: SIM115
fname = f.name
data = b'some data to be imported'
f.write(data)
if windows:
f.close()
f = open(fname, 'rb') # noqa: SIM115
else:
f.flush()
f.seek(0)
large_object = self.c.loimport(f.name)
try:
f.close()
if windows:
os.remove(fname)
self.assertIsLargeObject(large_object)
large_object.open(pg.INV_READ)
large_object.seek(0, pg.SEEK_SET)
r = large_object.size()
self.assertIsInstance(r, int)
self.assertEqual(r, len(data))
r = large_object.read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r, data)
large_object.close()
large_object.unlink()
finally:
del large_object
class TestLargeObjects(unittest.TestCase):
"""Test the large object methods."""
def setUp(self):
self.pgcnx = connect()
self.pgcnx.query('begin')
self.obj = self.pgcnx.locreate(pg.INV_READ | pg.INV_WRITE)
def tearDown(self):
if self.obj.oid:
with suppress(SystemError, OSError):
self.obj.close()
with suppress(SystemError, OSError):
self.obj.unlink()
del self.obj
with suppress(SystemError):
self.pgcnx.query('rollback')
self.pgcnx.close()
def test_class_name(self):
self.assertEqual(self.obj.__class__.__name__, 'LargeObject')
def test_module_name(self):
self.assertEqual(self.obj.__class__.__module__, 'pg')
def test_oid(self):
self.assertIsInstance(self.obj.oid, int)
self.assertNotEqual(self.obj.oid, 0)
def test_pgcn(self):
self.assertIs(self.obj.pgcnx, self.pgcnx)
def test_error(self):
self.assertIsInstance(self.obj.error, str)
self.assertEqual(self.obj.error, '')
def test_str(self):
self.obj.open(pg.INV_WRITE)
data = b'some object to be printed'
self.obj.write(data)
oid = self.obj.oid
r = str(self.obj)
self.assertEqual(r, f'Opened large object, oid {oid}')
self.obj.close()
r = str(self.obj)
self.assertEqual(r, f'Closed large object, oid {oid}')
def test_repr(self):
r = repr(self.obj)
self.assertTrue(r.startswith('<pg.LargeObject object'), r)
def test_open(self):
# noinspection PyShadowingBuiltins
open = self.obj.open
# testing with invalid parameters
self.assertRaises(TypeError, open)
self.assertRaises(TypeError, open, pg.INV_READ, pg.INV_WRITE)
open(pg.INV_READ)
# object is already open
self.assertRaises(IOError, open, pg.INV_READ)
def test_close(self):
close = self.obj.close
# testing with invalid parameters
self.assertRaises(TypeError, close, pg.INV_READ)
# object is not yet open
self.assertRaises(IOError, close)
self.obj.open(pg.INV_READ)
close()
self.assertRaises(IOError, close)
def test_read(self):
read = self.obj.read
# testing with invalid parameters
self.assertRaises(TypeError, read)
self.assertRaises(ValueError, read, -1)
self.assertRaises(TypeError, read, 'invalid')
self.assertRaises(TypeError, read, 80, 'invalid')
# reading when object is not yet open
self.assertRaises(IOError, read, 80)
data = b'some data to be read'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
self.obj.close()
self.obj.open(pg.INV_READ)
r = read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r, data)
self.obj.close()
self.obj.open(pg.INV_READ)
r = read(8)
self.assertIsInstance(r, bytes)
self.assertEqual(r, data[:8])
self.obj.close()
def test_write(self):
write = self.obj.write
# testing with invalid parameters
self.assertRaises(TypeError, write)
self.assertRaises(TypeError, write, -1)
self.assertRaises(TypeError, write, '', 'invalid')
# writing when object is not yet open
self.assertRaises(IOError, write, 'invalid')
data = b'some data to be written'
self.obj.open(pg.INV_WRITE)
write(data)
self.obj.close()
self.obj.open(pg.INV_READ)
r = self.obj.read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r, data)
def test_write_latin1_bytes(self):
read = self.obj.read
self.obj.open(pg.INV_WRITE)
self.obj.write('käse'.encode('latin1'))
self.obj.close()
self.obj.open(pg.INV_READ)
r = read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r.decode('latin1'), 'käse')
def test_write_utf8_bytes(self):
read = self.obj.read
self.obj.open(pg.INV_WRITE)
self.obj.write('käse'.encode())
self.obj.close()
self.obj.open(pg.INV_READ)
r = read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r.decode(), 'käse')
def test_write_utf8_string(self):
read = self.obj.read
self.obj.open(pg.INV_WRITE)
self.obj.write('käse')
self.obj.close()
self.obj.open(pg.INV_READ)
r = read(80)
self.assertIsInstance(r, bytes)
self.assertEqual(r.decode(), 'käse')
def test_seek(self):
seek = self.obj.seek
# testing with invalid parameters
self.assertRaises(TypeError, seek)
self.assertRaises(TypeError, seek, 0)
self.assertRaises(TypeError, seek, 0, pg.SEEK_SET, pg.SEEK_END)
self.assertRaises(TypeError, seek, 'invalid', pg.SEEK_SET)
self.assertRaises(TypeError, seek, 0, 'invalid')
# seeking when object is not yet open
self.assertRaises(IOError, seek, 0, pg.SEEK_SET)
data = b'some data to be seeked'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
self.obj.close()
self.obj.open(pg.INV_READ)
seek(0, pg.SEEK_SET)
r = self.obj.read(9)
self.assertIsInstance(r, bytes)
self.assertEqual(r, b'some data')
seek(4, pg.SEEK_CUR)
r = self.obj.read(2)
self.assertIsInstance(r, bytes)
self.assertEqual(r, b'be')
seek(-10, pg.SEEK_CUR)
r = self.obj.read(4)
self.assertIsInstance(r, bytes)
self.assertEqual(r, b'data')
seek(0, pg.SEEK_SET)
r = self.obj.read(4)
self.assertIsInstance(r, bytes)
self.assertEqual(r, b'some')
seek(-6, pg.SEEK_END)
r = self.obj.read(4)
self.assertIsInstance(r, bytes)
self.assertEqual(r, b'seek')
def test_tell(self):
tell = self.obj.tell
# testing with invalid parameters
self.assertRaises(TypeError, tell, 0)
# telling when object is not yet open
self.assertRaises(IOError, tell)
data = b'some story to be told'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
r = tell()
self.assertIsInstance(r, int)
self.assertEqual(r, len(data))
self.obj.close()
self.obj.open(pg.INV_READ)
r = tell()
self.assertIsInstance(r, int)
self.assertEqual(r, 0)
self.obj.seek(5, pg.SEEK_SET)
r = tell()
self.assertIsInstance(r, int)
self.assertEqual(r, 5)
def test_unlink(self):
unlink = self.obj.unlink
# testing with invalid parameters
self.assertRaises(TypeError, unlink, 0)
# unlinking when object is still open
self.obj.open(pg.INV_WRITE)
self.assertIsNotNone(self.obj.oid)
self.assertNotEqual(0, self.obj.oid)
self.assertRaises(IOError, unlink)
data = b'some data to be sold'
self.obj.write(data)
self.obj.close()
# unlinking after object has been closed
unlink()
self.assertIsNone(self.obj.oid)
# unlinking after object has been already unlinked
self.assertRaises(pg.IntegrityError, unlink)
def test_unlink_inexistent(self):
unlink = self.obj.unlink
self.obj.open(pg.INV_WRITE)
self.obj.close()
self.pgcnx.query(f'select lo_unlink({self.obj.oid})')
self.assertRaises(IOError, unlink)
def test_size(self):
size = self.obj.size
# testing with invalid parameters
self.assertRaises(TypeError, size, 0)
# sizing when object is not yet open
self.assertRaises(IOError, size)
# sizing an empty object
self.obj.open(pg.INV_READ)
r = size()
self.obj.close()
self.assertIsInstance(r, int)
self.assertEqual(r, 0)
# sizing after adding some data
data = b'some data to be sized'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
self.obj.close()
# sizing when current position is zero
self.obj.open(pg.INV_READ)
r = size()
self.obj.close()
self.assertIsInstance(r, int)
self.assertEqual(r, len(data))
self.obj.open(pg.INV_READ)
# sizing when current position is not zero
self.obj.seek(5, pg.SEEK_SET)
r = size()
self.obj.close()
self.assertIsInstance(r, int)
self.assertEqual(r, len(data))
# sizing after adding more data
data += b' and more data'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
self.obj.close()
self.obj.open(pg.INV_READ)
r = size()
self.obj.close()
self.assertIsInstance(r, int)
self.assertEqual(r, len(data))
def test_export(self):
export = self.obj.export
# testing with invalid parameters
self.assertRaises(TypeError, export)
self.assertRaises(TypeError, export, 0)
self.assertRaises(TypeError, export, 'invalid', 0)
f: Any
if windows:
# NamedTemporaryFiles don't work well here
fname = 'temp_test_pg_largeobj_export.txt'
f = open(fname, 'wb') # noqa: SIM115
else:
f = tempfile.NamedTemporaryFile() # noqa: SIM115
fname = f.name
data = b'some data to be exported'
self.obj.open(pg.INV_WRITE)
self.obj.write(data)
# exporting when object is not yet closed
self.assertRaises(IOError, export, f.name)
self.obj.close()
export(fname)
if windows:
f.close()
f = open(fname, 'rb') # noqa: SIM115
r = f.read()
f.close()
if windows:
os.remove(fname)
self.assertIsInstance(r, bytes)
self.assertEqual(r, data)
def test_export_in_existent(self):
export = self.obj.export
with tempfile.NamedTemporaryFile() as f:
self.obj.open(pg.INV_WRITE)
self.obj.close()
self.pgcnx.query(f'select lo_unlink({self.obj.oid})')
self.assertRaises(IOError, export, f.name)
if __name__ == '__main__':
unittest.main()
|
