| 1 |
import unittest |
| 2 |
from contextlib import contextmanager |
| 3 |
from io import StringIO |
| 4 |
from unittest import mock |
| 5 |
|
| 6 |
from django.core.exceptions import ImproperlyConfigured |
| 7 |
from django.db import DatabaseError, connection |
| 8 |
from django.db.backends.base.creation import BaseDatabaseCreation |
| 9 |
from django.test import SimpleTestCase |
| 10 |
|
| 11 |
try: |
| 12 |
from django.db.backends.postgresql.psycopg_any import errors |
| 13 |
except ImportError: |
| 14 |
pass |
| 15 |
else: |
| 16 |
from django.db.backends.postgresql.creation import DatabaseCreation |
| 17 |
|
| 18 |
|
| 19 |
@unittest.skipUnless(connection.vendor == "postgresql", "PostgreSQL tests") |
| 20 |
class DatabaseCreationTests(SimpleTestCase): |
| 21 |
@contextmanager |
| 22 |
def changed_test_settings(self, **kwargs): |
| 23 |
settings = connection.settings_dict["TEST"] |
| 24 |
saved_values = {} |
| 25 |
for name in kwargs: |
| 26 |
if name in settings: |
| 27 |
saved_values[name] = settings[name] |
| 28 |
|
| 29 |
for name, value in kwargs.items(): |
| 30 |
settings[name] = value |
| 31 |
try: |
| 32 |
yield |
| 33 |
finally: |
| 34 |
for name in kwargs: |
| 35 |
if name in saved_values: |
| 36 |
settings[name] = saved_values[name] |
| 37 |
else: |
| 38 |
del settings[name] |
| 39 |
|
| 40 |
def check_sql_table_creation_suffix(self, settings, expected): |
| 41 |
with self.changed_test_settings(**settings): |
| 42 |
creation = DatabaseCreation(connection) |
| 43 |
suffix = creation.sql_table_creation_suffix() |
| 44 |
self.assertEqual(suffix, expected) |
| 45 |
|
| 46 |
def test_sql_table_creation_suffix_with_none_settings(self): |
| 47 |
settings = {"CHARSET": None, "TEMPLATE": None} |
| 48 |
self.check_sql_table_creation_suffix(settings, "") |
| 49 |
|
| 50 |
def test_sql_table_creation_suffix_with_encoding(self): |
| 51 |
settings = {"CHARSET": "UTF8"} |
| 52 |
self.check_sql_table_creation_suffix(settings, "WITH ENCODING 'UTF8'") |
| 53 |
|
| 54 |
def test_sql_table_creation_suffix_with_template(self): |
| 55 |
settings = {"TEMPLATE": "template0"} |
| 56 |
self.check_sql_table_creation_suffix(settings, 'WITH TEMPLATE "template0"') |
| 57 |
|
| 58 |
def test_sql_table_creation_suffix_with_encoding_and_template(self): |
| 59 |
settings = {"CHARSET": "UTF8", "TEMPLATE": "template0"} |
| 60 |
self.check_sql_table_creation_suffix( |
| 61 |
settings, '''WITH ENCODING 'UTF8' TEMPLATE "template0"''' |
| 62 |
) |
| 63 |
|
| 64 |
def test_sql_table_creation_raises_with_collation(self): |
| 65 |
settings = {"COLLATION": "test"} |
| 66 |
msg = ( |
| 67 |
"PostgreSQL does not support collation setting at database " |
| 68 |
"creation time." |
| 69 |
) |
| 70 |
with self.assertRaisesMessage(ImproperlyConfigured, msg): |
| 71 |
self.check_sql_table_creation_suffix(settings, None) |
| 72 |
|
| 73 |
def _execute_raise_database_already_exists(self, cursor, parameters, keepdb=False): |
| 74 |
error = errors.DuplicateDatabase( |
| 75 |
"database %s already exists" % parameters["dbname"] |
| 76 |
) |
| 77 |
raise DatabaseError() from error |
| 78 |
|
| 79 |
def _execute_raise_permission_denied(self, cursor, parameters, keepdb=False): |
| 80 |
error = errors.InsufficientPrivilege("permission denied to create database") |
| 81 |
raise DatabaseError() from error |
| 82 |
|
| 83 |
def patch_test_db_creation(self, execute_create_test_db): |
| 84 |
return mock.patch.object( |
| 85 |
BaseDatabaseCreation, "_execute_create_test_db", execute_create_test_db |
| 86 |
) |
| 87 |
|
| 88 |
@mock.patch("sys.stdout", new_callable=StringIO) |
| 89 |
@mock.patch("sys.stderr", new_callable=StringIO) |
| 90 |
def test_create_test_db(self, *mocked_objects): |
| 91 |
creation = DatabaseCreation(connection) |
| 92 |
# Simulate test database creation raising "database already exists" |
| 93 |
with self.patch_test_db_creation(self._execute_raise_database_already_exists): |
| 94 |
with mock.patch("builtins.input", return_value="no"): |
| 95 |
with self.assertRaises(SystemExit): |
| 96 |
# SystemExit is raised if the user answers "no" to the |
| 97 |
# prompt asking if it's okay to delete the test database. |
| 98 |
creation._create_test_db( |
| 99 |
verbosity=0, autoclobber=False, keepdb=False |
| 100 |
) |
| 101 |
# "Database already exists" error is ignored when keepdb is on |
| 102 |
creation._create_test_db(verbosity=0, autoclobber=False, keepdb=True) |
| 103 |
# Simulate test database creation raising unexpected error |
| 104 |
with self.patch_test_db_creation(self._execute_raise_permission_denied): |
| 105 |
with mock.patch.object( |
| 106 |
DatabaseCreation, "_database_exists", return_value=False |
| 107 |
): |
| 108 |
with self.assertRaises(SystemExit): |
| 109 |
creation._create_test_db( |
| 110 |
verbosity=0, autoclobber=False, keepdb=False |
| 111 |
) |
| 112 |
with self.assertRaises(SystemExit): |
| 113 |
creation._create_test_db( |
| 114 |
verbosity=0, autoclobber=False, keepdb=True |
| 115 |
) |
| 116 |
# Simulate test database creation raising "insufficient privileges". |
| 117 |
# An error shouldn't appear when keepdb is on and the database already |
| 118 |
# exists. |
| 119 |
with self.patch_test_db_creation(self._execute_raise_permission_denied): |
| 120 |
with mock.patch.object( |
| 121 |
DatabaseCreation, "_database_exists", return_value=True |
| 122 |
): |
| 123 |
creation._create_test_db(verbosity=0, autoclobber=False, keepdb=True) |