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
|
import os
import signal
import subprocess
import sys
from pathlib import Path
from unittest import mock, skipUnless
from django.db import connection
from django.db.backends.postgresql.client import DatabaseClient
from django.test import SimpleTestCase
class PostgreSqlDbshellCommandTestCase(SimpleTestCase):
def settings_to_cmd_args_env(self, settings_dict, parameters=None):
if parameters is None:
parameters = []
settings_dict.setdefault("OPTIONS", {})
return DatabaseClient.settings_to_cmd_args_env(settings_dict, parameters)
def test_basic(self):
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": "someuser",
"PASSWORD": "somepassword",
"HOST": "somehost",
"PORT": "444",
}
),
(
["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
{"PGPASSWORD": "somepassword"},
),
)
def test_nopass(self):
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": "someuser",
"HOST": "somehost",
"PORT": "444",
}
),
(
["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
None,
),
)
def test_ssl_certificate(self):
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": "someuser",
"HOST": "somehost",
"PORT": "444",
"OPTIONS": {
"sslmode": "verify-ca",
"sslrootcert": "root.crt",
"sslcert": "client.crt",
"sslkey": "client.key",
},
}
),
(
["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
{
"PGSSLCERT": "client.crt",
"PGSSLKEY": "client.key",
"PGSSLMODE": "verify-ca",
"PGSSLROOTCERT": "root.crt",
},
),
)
def test_service(self):
self.assertEqual(
self.settings_to_cmd_args_env({"OPTIONS": {"service": "django_test"}}),
(["psql"], {"PGSERVICE": "django_test"}),
)
def test_passfile(self):
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": "someuser",
"HOST": "somehost",
"PORT": "444",
"OPTIONS": {
"passfile": "~/.custompgpass",
},
}
),
(
["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
{"PGPASSFILE": "~/.custompgpass"},
),
)
self.assertEqual(
self.settings_to_cmd_args_env(
{
"OPTIONS": {
"service": "django_test",
"passfile": "~/.custompgpass",
},
}
),
(
["psql"],
{"PGSERVICE": "django_test", "PGPASSFILE": "~/.custompgpass"},
),
)
def test_column(self):
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": "some:user",
"PASSWORD": "some:password",
"HOST": "::1",
"PORT": "444",
}
),
(
["psql", "-U", "some:user", "-h", "::1", "-p", "444", "dbname"],
{"PGPASSWORD": "some:password"},
),
)
def test_accent(self):
username = "rôle"
password = "sésame"
self.assertEqual(
self.settings_to_cmd_args_env(
{
"NAME": "dbname",
"USER": username,
"PASSWORD": password,
"HOST": "somehost",
"PORT": "444",
}
),
(
["psql", "-U", username, "-h", "somehost", "-p", "444", "dbname"],
{"PGPASSWORD": password},
),
)
def test_parameters(self):
self.assertEqual(
self.settings_to_cmd_args_env({"NAME": "dbname"}, ["--help"]),
(["psql", "--help", "dbname"], None),
)
@skipUnless(connection.vendor == "postgresql", "Requires a PostgreSQL connection")
def test_sigint_handler(self):
"""SIGINT is ignored in Python and passed to psql to abort queries."""
def _mock_subprocess_run(*args, **kwargs):
handler = signal.getsignal(signal.SIGINT)
self.assertEqual(handler, signal.SIG_IGN)
sigint_handler = signal.getsignal(signal.SIGINT)
# The default handler isn't SIG_IGN.
self.assertNotEqual(sigint_handler, signal.SIG_IGN)
with mock.patch("subprocess.run", new=_mock_subprocess_run):
connection.client.runshell([])
# dbshell restores the original handler.
self.assertEqual(sigint_handler, signal.getsignal(signal.SIGINT))
def test_crash_password_does_not_leak(self):
# The password doesn't leak in an exception that results from a client
# crash.
args, env = self.settings_to_cmd_args_env({"PASSWORD": "somepassword"}, [])
if env:
env = {**os.environ, **env}
fake_client = Path(__file__).with_name("fake_client.py")
args[0:1] = [sys.executable, str(fake_client)]
with self.assertRaises(subprocess.CalledProcessError) as ctx:
subprocess.run(args, check=True, env=env)
self.assertNotIn("somepassword", str(ctx.exception))
|
