mirror of
				https://github.com/django/django.git
				synced 2025-10-31 09:41:08 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			129 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			129 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
| import os
 | |
| import signal
 | |
| import subprocess
 | |
| from unittest import mock
 | |
| 
 | |
| from django.db.backends.postgresql.client import DatabaseClient
 | |
| from django.test import SimpleTestCase
 | |
| 
 | |
| 
 | |
| class PostgreSqlDbshellCommandTestCase(SimpleTestCase):
 | |
| 
 | |
|     def _run_it(self, dbinfo, parameters=None):
 | |
|         """
 | |
|         That function invokes the runshell command, while mocking
 | |
|         subprocess.run(). It returns a 2-tuple with:
 | |
|         - The command line list
 | |
|         - The dictionary of PG* environment variables, or {}.
 | |
|         """
 | |
|         def _mock_subprocess_run(*args, env=os.environ, **kwargs):
 | |
|             self.subprocess_args = list(*args)
 | |
|             # PostgreSQL environment variables.
 | |
|             self.pg_env = {key: env[key] for key in env if key.startswith('PG')}
 | |
|             return subprocess.CompletedProcess(self.subprocess_args, 0)
 | |
| 
 | |
|         if parameters is None:
 | |
|             parameters = []
 | |
|         with mock.patch('subprocess.run', new=_mock_subprocess_run):
 | |
|             DatabaseClient.runshell_db(dbinfo, parameters)
 | |
|         return self.subprocess_args, self.pg_env
 | |
| 
 | |
|     def test_basic(self):
 | |
|         self.assertEqual(
 | |
|             self._run_it({
 | |
|                 'database': '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._run_it({
 | |
|                 'database': 'dbname',
 | |
|                 'user': 'someuser',
 | |
|                 'host': 'somehost',
 | |
|                 'port': '444',
 | |
|             }), (
 | |
|                 ['psql', '-U', 'someuser', '-h', 'somehost', '-p', '444', 'dbname'],
 | |
|                 {},
 | |
|             )
 | |
|         )
 | |
| 
 | |
|     def test_ssl_certificate(self):
 | |
|         self.assertEqual(
 | |
|             self._run_it({
 | |
|                 'database': 'dbname',
 | |
|                 'user': 'someuser',
 | |
|                 'host': 'somehost',
 | |
|                 'port': '444',
 | |
|                 '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_column(self):
 | |
|         self.assertEqual(
 | |
|             self._run_it({
 | |
|                 'database': '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._run_it({
 | |
|                 'database': '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._run_it({'database': 'dbname'}, ['--help']),
 | |
|             (['psql', 'dbname', '--help'], {}),
 | |
|         )
 | |
| 
 | |
|     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):
 | |
|             DatabaseClient.runshell_db({}, [])
 | |
|         # dbshell restores the original handler.
 | |
|         self.assertEqual(sigint_handler, signal.getsignal(signal.SIGINT))
 |