Debian Codegraph @

tests/dbshell/test_postgresql.py

raw
1 import os
2 import signal
3 import subprocess
4 import sys
5 from pathlib import Path
6 from unittest import mock, skipUnless
7
8 from django.db import connection
9 from django.db.backends.postgresql.client import DatabaseClient
10 from django.test import SimpleTestCase
11
12
13 class PostgreSqlDbshellCommandTestCase(SimpleTestCase):
14 def settings_to_cmd_args_env(self, settings_dict, parameters=None):
15 if parameters is None:
16 parameters = []
17 settings_dict.setdefault("OPTIONS", {})
18 return DatabaseClient.settings_to_cmd_args_env(settings_dict, parameters)
19
20 def test_basic(self):
21 self.assertEqual(
22 self.settings_to_cmd_args_env(
23 {
24 "NAME": "dbname",
25 "USER": "someuser",
26 "PASSWORD": "somepassword",
27 "HOST": "somehost",
28 "PORT": "444",
29 }
30 ),
31 (
32 ["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
33 {"PGPASSWORD": "somepassword"},
34 ),
35 )
36
37 def test_nopass(self):
38 self.assertEqual(
39 self.settings_to_cmd_args_env(
40 {
41 "NAME": "dbname",
42 "USER": "someuser",
43 "HOST": "somehost",
44 "PORT": "444",
45 }
46 ),
47 (
48 ["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
49 None,
50 ),
51 )
52
53 def test_ssl_certificate(self):
54 self.assertEqual(
55 self.settings_to_cmd_args_env(
56 {
57 "NAME": "dbname",
58 "USER": "someuser",
59 "HOST": "somehost",
60 "PORT": "444",
61 "OPTIONS": {
62 "sslmode": "verify-ca",
63 "sslrootcert": "root.crt",
64 "sslcert": "client.crt",
65 "sslkey": "client.key",
66 },
67 }
68 ),
69 (
70 ["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
71 {
72 "PGSSLCERT": "client.crt",
73 "PGSSLKEY": "client.key",
74 "PGSSLMODE": "verify-ca",
75 "PGSSLROOTCERT": "root.crt",
76 },
77 ),
78 )
79
80 def test_service(self):
81 self.assertEqual(
82 self.settings_to_cmd_args_env({"OPTIONS": {"service": "django_test"}}),
83 (["psql"], {"PGSERVICE": "django_test"}),
84 )
85
86 def test_passfile(self):
87 self.assertEqual(
88 self.settings_to_cmd_args_env(
89 {
90 "NAME": "dbname",
91 "USER": "someuser",
92 "HOST": "somehost",
93 "PORT": "444",
94 "OPTIONS": {
95 "passfile": "~/.custompgpass",
96 },
97 }
98 ),
99 (
100 ["psql", "-U", "someuser", "-h", "somehost", "-p", "444", "dbname"],
101 {"PGPASSFILE": "~/.custompgpass"},
102 ),
103 )
104 self.assertEqual(
105 self.settings_to_cmd_args_env(
106 {
107 "OPTIONS": {
108 "service": "django_test",
109 "passfile": "~/.custompgpass",
110 },
111 }
112 ),
113 (
114 ["psql"],
115 {"PGSERVICE": "django_test", "PGPASSFILE": "~/.custompgpass"},
116 ),
117 )
118
119 def test_column(self):
120 self.assertEqual(
121 self.settings_to_cmd_args_env(
122 {
123 "NAME": "dbname",
124 "USER": "some:user",
125 "PASSWORD": "some:password",
126 "HOST": "::1",
127 "PORT": "444",
128 }
129 ),
130 (
131 ["psql", "-U", "some:user", "-h", "::1", "-p", "444", "dbname"],
132 {"PGPASSWORD": "some:password"},
133 ),
134 )
135
136 def test_accent(self):
137 username = "rôle"
138 password = "sésame"
139 self.assertEqual(
140 self.settings_to_cmd_args_env(
141 {
142 "NAME": "dbname",
143 "USER": username,
144 "PASSWORD": password,
145 "HOST": "somehost",
146 "PORT": "444",
147 }
148 ),
149 (
150 ["psql", "-U", username, "-h", "somehost", "-p", "444", "dbname"],
151 {"PGPASSWORD": password},
152 ),
153 )
154
155 def test_parameters(self):
156 self.assertEqual(
157 self.settings_to_cmd_args_env({"NAME": "dbname"}, ["--help"]),
158 (["psql", "--help", "dbname"], None),
159 )
160
161 @skipUnless(connection.vendor == "postgresql", "Requires a PostgreSQL connection")
162 def test_sigint_handler(self):
163 """SIGINT is ignored in Python and passed to psql to abort queries."""
164
165 def _mock_subprocess_run(*args, **kwargs):
166 handler = signal.getsignal(signal.SIGINT)
167 self.assertEqual(handler, signal.SIG_IGN)
168
169 sigint_handler = signal.getsignal(signal.SIGINT)
170 # The default handler isn't SIG_IGN.
171 self.assertNotEqual(sigint_handler, signal.SIG_IGN)
172 with mock.patch("subprocess.run", new=_mock_subprocess_run):
173 connection.client.runshell([])
174 # dbshell restores the original handler.
175 self.assertEqual(sigint_handler, signal.getsignal(signal.SIGINT))
176
177 def test_crash_password_does_not_leak(self):
178 # The password doesn't leak in an exception that results from a client
179 # crash.
180 args, env = self.settings_to_cmd_args_env({"PASSWORD": "somepassword"}, [])
181 if env:
182 env = {**os.environ, **env}
183 fake_client = Path(__file__).with_name("fake_client.py")
184 args[0:1] = [sys.executable, str(fake_client)]
185 with self.assertRaises(subprocess.CalledProcessError) as ctx:
186 subprocess.run(args, check=True, env=env)
187 self.assertNotIn("somepassword", str(ctx.exception))