-
Notifications
You must be signed in to change notification settings - Fork 418
/
Copy pathtest_connect.py
1942 lines (1679 loc) · 67.1 KB
/
test_connect.py
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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (C) 2016-present the asyncpg authors and contributors
# <see AUTHORS file>
#
# This module is part of asyncpg and is released under
# the Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
import asyncio
import contextlib
import ipaddress
import os
import pathlib
import platform
import shutil
import ssl
import stat
import tempfile
import textwrap
import unittest
import unittest.mock
import urllib.parse
import warnings
import weakref
import asyncpg
from asyncpg import _testbase as tb
from asyncpg import connection as pg_connection
from asyncpg import connect_utils
from asyncpg import cluster as pg_cluster
from asyncpg import exceptions
from asyncpg.connect_utils import SSLMode
from asyncpg.serverversion import split_server_version_string
_system = platform.uname().system
CERTS = os.path.join(os.path.dirname(__file__), 'certs')
SSL_CA_CERT_FILE = os.path.join(CERTS, 'ca.cert.pem')
SSL_CA_CRL_FILE = os.path.join(CERTS, 'ca.crl.pem')
SSL_CERT_FILE = os.path.join(CERTS, 'server.cert.pem')
SSL_KEY_FILE = os.path.join(CERTS, 'server.key.pem')
CLIENT_CA_CERT_FILE = os.path.join(CERTS, 'client_ca.cert.pem')
CLIENT_SSL_CERT_FILE = os.path.join(CERTS, 'client.cert.pem')
CLIENT_SSL_KEY_FILE = os.path.join(CERTS, 'client.key.pem')
CLIENT_SSL_PROTECTED_KEY_FILE = os.path.join(CERTS, 'client.key.protected.pem')
@contextlib.contextmanager
def mock_dot_postgresql(*, ca=True, crl=False, client=False, protected=False):
with tempfile.TemporaryDirectory() as temp_dir:
home = pathlib.Path(temp_dir)
pg_home = home / '.postgresql'
pg_home.mkdir()
if ca:
shutil.copyfile(SSL_CA_CERT_FILE, pg_home / 'root.crt')
if crl:
shutil.copyfile(SSL_CA_CRL_FILE, pg_home / 'root.crl')
if client:
shutil.copyfile(CLIENT_SSL_CERT_FILE, pg_home / 'postgresql.crt')
if protected:
shutil.copyfile(
CLIENT_SSL_PROTECTED_KEY_FILE, pg_home / 'postgresql.key'
)
else:
shutil.copyfile(
CLIENT_SSL_KEY_FILE, pg_home / 'postgresql.key'
)
with unittest.mock.patch(
'pathlib.Path.home', unittest.mock.Mock(return_value=home)
):
yield
@contextlib.contextmanager
def mock_no_home_dir():
with unittest.mock.patch(
'pathlib.Path.home', unittest.mock.Mock(side_effect=RuntimeError)
):
yield
@contextlib.contextmanager
def mock_dev_null_home_dir():
with unittest.mock.patch(
'pathlib.Path.home',
unittest.mock.Mock(return_value=pathlib.Path('/dev/null')),
):
yield
class TestSettings(tb.ConnectedTestCase):
async def test_get_settings_01(self):
self.assertEqual(
self.con.get_settings().client_encoding,
'UTF8')
await self.con.execute("set client_encoding to 'sql-ascii'")
self.assertEqual(self.con.get_settings().client_encoding, "SQL_ASCII")
async def test_client_encoding(self):
await self.con.execute("set client_encoding to 'sql-ascii'")
encoding = await self.con.fetchval("show client_encoding")
self.assertEqual(encoding, "SQL_ASCII")
encoding = await self.con.fetchval("select $1::text", encoding)
self.assertEqual(encoding, "SQL_ASCII")
async def test_server_version_01(self):
version = self.con.get_server_version()
version_num = await self.con.fetchval("SELECT current_setting($1)",
'server_version_num', column=0)
ver_maj = int(version_num[:-4])
ver_min = int(version_num[-4:-2])
ver_fix = int(version_num[-2:])
self.assertEqual(version[:3], (ver_maj, ver_min, ver_fix))
def test_server_version_02(self):
versions = [
("9.2", (9, 2, 0, 'final', 0),),
("Postgres-XL 9.2.1", (9, 2, 1, 'final', 0),),
("9.4beta1", (9, 4, 0, 'beta', 1),),
("10devel", (10, 0, 0, 'devel', 0),),
("10beta2", (10, 0, 0, 'beta', 2),),
# For PostgreSQL versions >=10 we always
# set version.minor to 0.
("10.1", (10, 0, 1, 'final', 0),),
("11.1.2", (11, 0, 1, 'final', 0),),
("PostgreSQL 10.1 (Debian 10.1-3)", (10, 0, 1, 'final', 0),),
("PostgreSQL 11.2-YB-2.7.1.1-b0 on x86_64-pc-linux-gnu, "
"compiled by gcc (Homebrew gcc 5.5.0_4) 5.5.0, 64-bit",
(11, 0, 2, "final", 0),),
]
for version, expected in versions:
result = split_server_version_string(version)
self.assertEqual(expected, result)
CORRECT_PASSWORD = 'correct\u1680password'
class TestAuthentication(tb.ConnectedTestCase):
def setUp(self):
super().setUp()
if not self.cluster.is_managed():
self.skipTest('unmanaged cluster')
methods = [
('trust', None),
('reject', None),
('scram-sha-256', CORRECT_PASSWORD),
('md5', CORRECT_PASSWORD),
('password', CORRECT_PASSWORD),
]
self.cluster.reset_hba()
create_script = []
for method, password in methods:
if method == 'scram-sha-256' and self.server_version.major < 10:
continue
username = method.replace('-', '_')
# if this is a SCRAM password, we need to set the encryption method
# to "scram-sha-256" in order to properly hash the password
if method == 'scram-sha-256':
create_script.append(
"SET password_encryption = 'scram-sha-256';"
)
create_script.append(
'CREATE ROLE {}_user WITH LOGIN{};'.format(
username,
f' PASSWORD E{(password or "")!r}'
)
)
# to be courteous to the MD5 test, revert back to MD5 after the
# scram-sha-256 password is set
if method == 'scram-sha-256':
create_script.append(
"SET password_encryption = 'md5';"
)
if _system != 'Windows':
self.cluster.add_hba_entry(
type='local',
database='postgres', user='{}_user'.format(username),
auth_method=method)
self.cluster.add_hba_entry(
type='host', address=ipaddress.ip_network('127.0.0.0/24'),
database='postgres', user='{}_user'.format(username),
auth_method=method)
self.cluster.add_hba_entry(
type='host', address=ipaddress.ip_network('::1/128'),
database='postgres', user='{}_user'.format(username),
auth_method=method)
# Put hba changes into effect
self.cluster.reload()
create_script = '\n'.join(create_script)
self.loop.run_until_complete(self.con.execute(create_script))
def tearDown(self):
# Reset cluster's pg_hba.conf since we've meddled with it
self.cluster.trust_local_connections()
methods = [
'trust',
'reject',
'scram-sha-256',
'md5',
'password',
]
drop_script = []
for method in methods:
if method == 'scram-sha-256' and self.server_version.major < 10:
continue
username = method.replace('-', '_')
drop_script.append('DROP ROLE {}_user;'.format(username))
drop_script = '\n'.join(drop_script)
self.loop.run_until_complete(self.con.execute(drop_script))
super().tearDown()
async def _try_connect(self, **kwargs):
# On Windows the server sometimes just closes
# the connection sooner than we receive the
# actual error.
if _system == 'Windows':
for tried in range(3):
try:
return await self.connect(**kwargs)
except asyncpg.ConnectionDoesNotExistError:
pass
return await self.connect(**kwargs)
async def test_auth_bad_user(self):
with self.assertRaises(
asyncpg.InvalidAuthorizationSpecificationError):
await self._try_connect(user='__nonexistent__')
async def test_auth_trust(self):
conn = await self.connect(user='trust_user')
await conn.close()
async def test_auth_reject(self):
with self.assertRaisesRegex(
asyncpg.InvalidAuthorizationSpecificationError,
'pg_hba.conf rejects connection'):
await self._try_connect(user='reject_user')
async def test_auth_password_cleartext(self):
conn = await self.connect(
user='password_user',
password=CORRECT_PASSWORD)
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "password_user"'):
await self._try_connect(
user='password_user',
password='wrongpassword')
async def test_auth_password_cleartext_callable(self):
def get_correctpassword():
return CORRECT_PASSWORD
def get_wrongpassword():
return 'wrongpassword'
conn = await self.connect(
user='password_user',
password=get_correctpassword)
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "password_user"'):
await self._try_connect(
user='password_user',
password=get_wrongpassword)
async def test_auth_password_cleartext_callable_coroutine(self):
async def get_correctpassword():
return CORRECT_PASSWORD
async def get_wrongpassword():
return 'wrongpassword'
conn = await self.connect(
user='password_user',
password=get_correctpassword)
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "password_user"'):
await self._try_connect(
user='password_user',
password=get_wrongpassword)
async def test_auth_password_cleartext_callable_awaitable(self):
async def get_correctpassword():
return CORRECT_PASSWORD
async def get_wrongpassword():
return 'wrongpassword'
conn = await self.connect(
user='password_user',
password=lambda: get_correctpassword())
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "password_user"'):
await self._try_connect(
user='password_user',
password=lambda: get_wrongpassword())
async def test_auth_password_md5(self):
conn = await self.connect(
user='md5_user', password=CORRECT_PASSWORD)
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "md5_user"'):
await self._try_connect(
user='md5_user', password='wrongpassword')
async def test_auth_password_scram_sha_256(self):
# scram is only supported in PostgreSQL 10 and above
if self.server_version.major < 10:
return
conn = await self.connect(
user='scram_sha_256_user', password=CORRECT_PASSWORD)
await conn.close()
with self.assertRaisesRegex(
asyncpg.InvalidPasswordError,
'password authentication failed for user "scram_sha_256_user"'
):
await self._try_connect(
user='scram_sha_256_user', password='wrongpassword')
# various SASL prep tests
# first ensure that password are being hashed for SCRAM-SHA-256
await self.con.execute("SET password_encryption = 'scram-sha-256';")
alter_password = "ALTER ROLE scram_sha_256_user PASSWORD E{!r};"
passwords = [
'nonascii\u1680space', # C.1.2
'common\u1806nothing', # B.1
'ab\ufb01c', # normalization
'ab\u007fc', # C.2.1
'ab\u206ac', # C.2.2, C.6
'ab\ue000c', # C.3, C.5
'ab\ufdd0c', # C.4
'ab\u2ff0c', # C.7
'ab\u2000c', # C.8
'ab\ue0001', # C.9
]
# ensure the passwords that go through SASLprep work
for password in passwords:
# update the password
await self.con.execute(alter_password.format(password))
# test to see that passwords are properly SASL prepped
conn = await self.connect(
user='scram_sha_256_user', password=password)
await conn.close()
alter_password = \
f"ALTER ROLE scram_sha_256_user PASSWORD E{CORRECT_PASSWORD!r};"
await self.con.execute(alter_password)
await self.con.execute("SET password_encryption = 'md5';")
@unittest.mock.patch('hashlib.md5', side_effect=ValueError("no md5"))
async def test_auth_md5_unsupported(self, _):
with self.assertRaisesRegex(
exceptions.InternalClientError,
".*no md5.*",
):
await self.connect(user='md5_user', password=CORRECT_PASSWORD)
class TestConnectParams(tb.TestCase):
TESTS = [
{
'name': 'all_env_default_ssl',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123'
},
'result': ([('host', 123)], {
'user': 'user',
'password': 'passw',
'database': 'testdb',
'ssl': True,
'sslmode': SSLMode.prefer,
'target_session_attrs': 'any'})
},
{
'name': 'params_override_env',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123'
},
'host': 'host2',
'port': '456',
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'result': ([('host2', 456)], {
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'target_session_attrs': 'any'})
},
{
'name': 'params_override_env_and_dsn',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123',
'PGSSLMODE': 'allow'
},
'dsn': 'postgres://user3:123123@localhost/abcdef',
'host': 'host2',
'port': '456',
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'ssl': False,
'result': ([('host2', 456)], {
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'sslmode': SSLMode.disable,
'ssl': False,
'target_session_attrs': 'any'})
},
{
'name': 'dsn_overrides_env_partially',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123',
'PGSSLMODE': 'allow'
},
'dsn': 'postgres://user3:123123@localhost:5555/abcdef',
'result': ([('localhost', 5555)], {
'user': 'user3',
'password': '123123',
'database': 'abcdef',
'ssl': True,
'sslmode': SSLMode.allow,
'target_session_attrs': 'any'})
},
{
'name': 'params_override_env_and_dsn_ssl_prefer',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123',
'PGSSLMODE': 'prefer'
},
'dsn': 'postgres://user3:123123@localhost/abcdef',
'host': 'host2',
'port': '456',
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'ssl': False,
'result': ([('host2', 456)], {
'user': 'user2',
'password': 'passw2',
'database': 'db2',
'sslmode': SSLMode.disable,
'ssl': False,
'target_session_attrs': 'any'})
},
{
'name': 'dsn_overrides_env_partially_ssl_prefer',
'env': {
'PGUSER': 'user',
'PGDATABASE': 'testdb',
'PGPASSWORD': 'passw',
'PGHOST': 'host',
'PGPORT': '123',
'PGSSLMODE': 'prefer'
},
'dsn': 'postgres://user3:123123@localhost:5555/abcdef',
'result': ([('localhost', 5555)], {
'user': 'user3',
'password': '123123',
'database': 'abcdef',
'ssl': True,
'sslmode': SSLMode.prefer,
'target_session_attrs': 'any'})
},
{
'name': 'dsn_only',
'dsn': 'postgres://user3:123123@localhost:5555/abcdef',
'result': ([('localhost', 5555)], {
'user': 'user3',
'password': '123123',
'database': 'abcdef',
'target_session_attrs': 'any'})
},
{
'name': 'dsn_only_multi_host',
'dsn': 'postgresql://user@host1,host2/db',
'result': ([('host1', 5432), ('host2', 5432)], {
'database': 'db',
'user': 'user',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_only_multi_host_and_port',
'dsn': 'postgresql://user@host1:1111,host2:2222/db',
'result': ([('host1', 1111), ('host2', 2222)], {
'database': 'db',
'user': 'user',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_ipv6_multi_host',
'dsn': 'postgresql://user@[2001:db8::1234%25eth0],[::1]/db',
'result': ([('2001:db8::1234%eth0', 5432), ('::1', 5432)], {
'database': 'db',
'user': 'user',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_ipv6_multi_host_port',
'dsn': 'postgresql://user@[2001:db8::1234]:1111,[::1]:2222/db',
'result': ([('2001:db8::1234', 1111), ('::1', 2222)], {
'database': 'db',
'user': 'user',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_ipv6_multi_host_query_part',
'dsn': 'postgresql:///db?user=user&host=[2001:db8::1234],[::1]',
'result': ([('2001:db8::1234', 5432), ('::1', 5432)], {
'database': 'db',
'user': 'user',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_combines_env_multi_host',
'env': {
'PGHOST': 'host1:1111,host2:2222',
'PGUSER': 'foo',
},
'dsn': 'postgresql:///db',
'result': ([('host1', 1111), ('host2', 2222)], {
'database': 'db',
'user': 'foo',
'target_session_attrs': 'any',
})
},
{
'name': 'dsn_multi_host_combines_env',
'env': {
'PGUSER': 'foo',
},
'dsn': 'postgresql:///db?host=host1:1111,host2:2222',
'result': ([('host1', 1111), ('host2', 2222)], {
'database': 'db',
'user': 'foo',
'target_session_attrs': 'any',
})
},
{
'name': 'params_multi_host_dsn_env_mix',
'env': {
'PGUSER': 'foo',
},
'dsn': 'postgresql:///db',
'host': ['host1', 'host2'],
'result': ([('host1', 5432), ('host2', 5432)], {
'database': 'db',
'user': 'foo',
'target_session_attrs': 'any',
})
},
{
'name': 'params_combine_dsn_settings_override_and_ssl',
'dsn': 'postgresql://user3:123123@localhost:5555/'
'abcdef?param=sss¶m=123&host=testhost&user=testuser'
'&port=2222&database=testdb&sslmode=require',
'host': '127.0.0.1',
'port': '888',
'user': 'me',
'password': 'ask',
'database': 'db',
'result': ([('127.0.0.1', 888)], {
'server_settings': {'param': '123'},
'user': 'me',
'password': 'ask',
'database': 'db',
'ssl': True,
'sslmode': SSLMode.require,
'target_session_attrs': 'any'})
},
{
'name': 'params_settings_and_ssl_override_dsn',
'dsn': 'postgresql://user3:123123@localhost:5555/'
'abcdef?param=sss¶m=123&host=testhost&user=testuser'
'&port=2222&database=testdb&sslmode=disable',
'host': '127.0.0.1',
'port': '888',
'user': 'me',
'password': 'ask',
'database': 'db',
'server_settings': {'aa': 'bb'},
'ssl': True,
'result': ([('127.0.0.1', 888)], {
'server_settings': {'aa': 'bb', 'param': '123'},
'user': 'me',
'password': 'ask',
'database': 'db',
'sslmode': SSLMode.verify_full,
'ssl': True,
'target_session_attrs': 'any'})
},
{
'name': 'dsn_only_unix',
'dsn': 'postgresql:///dbname?host=/unix_sock/test&user=spam',
'result': ([os.path.join('/unix_sock/test', '.s.PGSQL.5432')], {
'user': 'spam',
'database': 'dbname',
'target_session_attrs': 'any'})
},
{
'name': 'dsn_only_quoted',
'dsn': 'postgresql://us%40r:p%40ss@h%40st1,h%40st2:543%33/d%62',
'result': (
[('h@st1', 5432), ('h@st2', 5433)],
{
'user': 'us@r',
'password': 'p@ss',
'database': 'db',
'target_session_attrs': 'any',
}
)
},
{
'name': 'dsn_only_unquoted_host',
'dsn': 'postgresql://user:p@ss@host/db',
'result': (
[('ss@host', 5432)],
{
'user': 'user',
'password': 'p',
'database': 'db',
'target_session_attrs': 'any',
}
)
},
{
'name': 'dsn_only_quoted_params',
'dsn': 'postgresql:///d%62?user=us%40r&host=h%40st&port=543%33',
'result': (
[('h@st', 5433)],
{
'user': 'us@r',
'database': 'db',
'target_session_attrs': 'any',
}
)
},
{
'name': 'dsn_only_illegal_protocol',
'dsn': 'pq:///dbname?host=/unix_sock/test&user=spam',
'error': (ValueError, 'invalid DSN')
},
{
'name': 'dsn_params_ports_mismatch_dsn_multi_hosts',
'dsn': 'postgresql://host1,host2,host3/db',
'port': [111, 222],
'error': (
exceptions.InterfaceError,
'could not match 2 port numbers to 3 hosts'
)
},
{
'name': 'dsn_only_quoted_unix_host_port_in_params',
'dsn': 'postgres://user@?port=56226&host=%2Ftmp',
'result': (
[os.path.join('/tmp', '.s.PGSQL.56226')],
{
'user': 'user',
'database': 'user',
'sslmode': SSLMode.disable,
'ssl': None,
'target_session_attrs': 'any',
}
)
},
{
'name': 'dsn_only_cloudsql',
'dsn': 'postgres:///db?host=/cloudsql/'
'project:region:instance-name&user=spam',
'result': (
[os.path.join(
'/cloudsql/project:region:instance-name',
'.s.PGSQL.5432'
)], {
'user': 'spam',
'database': 'db',
'target_session_attrs': 'any',
}
)
},
{
'name': 'dsn_only_cloudsql_unix_and_tcp',
'dsn': 'postgres:///db?host=127.0.0.1:5432,/cloudsql/'
'project:region:instance-name,localhost:5433&user=spam',
'result': (
[
('127.0.0.1', 5432),
os.path.join(
'/cloudsql/project:region:instance-name',
'.s.PGSQL.5432'
),
('localhost', 5433)
], {
'user': 'spam',
'database': 'db',
'ssl': True,
'sslmode': SSLMode.prefer,
'target_session_attrs': 'any',
}
)
},
]
@contextlib.contextmanager
def environ(self, **kwargs):
old_vals = {}
for key in kwargs:
if key in os.environ:
old_vals[key] = os.environ[key]
for key, val in kwargs.items():
if val is None:
if key in os.environ:
del os.environ[key]
else:
os.environ[key] = val
try:
yield
finally:
for key in kwargs:
if key in os.environ:
del os.environ[key]
for key, val in old_vals.items():
os.environ[key] = val
def run_testcase(self, testcase):
env = testcase.get('env', {})
test_env = {'PGHOST': None, 'PGPORT': None,
'PGUSER': None, 'PGPASSWORD': None,
'PGDATABASE': None, 'PGSSLMODE': None}
test_env.update(env)
dsn = testcase.get('dsn')
user = testcase.get('user')
port = testcase.get('port')
host = testcase.get('host')
password = testcase.get('password')
passfile = testcase.get('passfile')
database = testcase.get('database')
sslmode = testcase.get('ssl')
server_settings = testcase.get('server_settings')
target_session_attrs = testcase.get('target_session_attrs')
expected = testcase.get('result')
expected_error = testcase.get('error')
if expected is None and expected_error is None:
raise RuntimeError(
'invalid test case: either "result" or "error" key '
'has to be specified')
if expected is not None and expected_error is not None:
raise RuntimeError(
'invalid test case: either "result" or "error" key '
'has to be specified, got both')
with contextlib.ExitStack() as es:
es.enter_context(self.subTest(dsn=dsn, env=env))
es.enter_context(self.environ(**test_env))
if expected_error:
es.enter_context(self.assertRaisesRegex(*expected_error))
addrs, params = connect_utils._parse_connect_dsn_and_args(
dsn=dsn, host=host, port=port, user=user, password=password,
passfile=passfile, database=database, ssl=sslmode,
direct_tls=False, connect_timeout=None,
server_settings=server_settings,
target_session_attrs=target_session_attrs)
params = {
k: v for k, v in params._asdict().items()
if v is not None or (expected is not None and k in expected[1])
}
if isinstance(params.get('ssl'), ssl.SSLContext):
params['ssl'] = True
result = (addrs, params)
if expected is not None:
if 'ssl' not in expected[1]:
# Avoid the hassle of specifying the default SSL mode
# unless explicitly tested for.
params.pop('ssl', None)
params.pop('sslmode', None)
if 'direct_tls' not in expected[1]:
# Avoid the hassle of specifying direct_tls
# unless explicitly tested for
params.pop('direct_tls', False)
self.assertEqual(expected, result, 'Testcase: {}'.format(testcase))
def test_test_connect_params_environ(self):
self.assertNotIn('AAAAAAAAAA123', os.environ)
self.assertNotIn('AAAAAAAAAA456', os.environ)
self.assertNotIn('AAAAAAAAAA789', os.environ)
try:
os.environ['AAAAAAAAAA456'] = '123'
os.environ['AAAAAAAAAA789'] = '123'
with self.environ(AAAAAAAAAA123='1',
AAAAAAAAAA456='2',
AAAAAAAAAA789=None):
self.assertEqual(os.environ['AAAAAAAAAA123'], '1')
self.assertEqual(os.environ['AAAAAAAAAA456'], '2')
self.assertNotIn('AAAAAAAAAA789', os.environ)
self.assertNotIn('AAAAAAAAAA123', os.environ)
self.assertEqual(os.environ['AAAAAAAAAA456'], '123')
self.assertEqual(os.environ['AAAAAAAAAA789'], '123')
finally:
for key in {'AAAAAAAAAA123', 'AAAAAAAAAA456', 'AAAAAAAAAA789'}:
if key in os.environ:
del os.environ[key]
def test_test_connect_params_run_testcase(self):
with self.environ(PGPORT='777'):
self.run_testcase({
'env': {
'PGUSER': '__test__'
},
'host': 'abc',
'result': (
[('abc', 5432)],
{'user': '__test__',
'database': '__test__',
'target_session_attrs': 'any'}
)
})
def test_connect_params(self):
for testcase in self.TESTS:
self.run_testcase(testcase)
def test_connect_pgpass_regular(self):
passfile = tempfile.NamedTemporaryFile('w+t', delete=False)
passfile.write(textwrap.dedent(R'''
abc:*:*:user:password from pgpass for user@abc
localhost:*:*:*:password from pgpass for localhost
cde:5433:*:*:password from pgpass for cde:5433
*:*:*:testuser:password from pgpass for testuser
*:*:testdb:*:password from pgpass for testdb
# comment
*:*:test\:db:test\\:password from pgpass with escapes
'''))
passfile.close()
os.chmod(passfile.name, stat.S_IWUSR | stat.S_IRUSR)
try:
# passfile path in env
self.run_testcase({
'env': {
'PGPASSFILE': passfile.name
},
'host': 'abc',
'user': 'user',
'database': 'db',
'result': (
[('abc', 5432)],
{
'password': 'password from pgpass for user@abc',
'user': 'user',
'database': 'db',
'target_session_attrs': 'any',
}
)
})
# passfile path as explicit arg
self.run_testcase({
'host': 'abc',
'user': 'user',
'database': 'db',
'passfile': passfile.name,
'result': (
[('abc', 5432)],
{
'password': 'password from pgpass for user@abc',
'user': 'user',
'database': 'db',
'target_session_attrs': 'any',
}
)
})
# passfile path in dsn
self.run_testcase({
'dsn': 'postgres://user@abc/db?passfile={}'.format(
passfile.name),
'result': (
[('abc', 5432)],
{
'password': 'password from pgpass for user@abc',
'user': 'user',