File: test_drop_test_database.py

package info (click to toggle)
python-django-extensions 4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,820 kB
  • sloc: python: 18,601; javascript: 7,354; makefile: 108; xml: 17
file content (368 lines) | stat: -rw-r--r-- 13,670 bytes parent folder | download
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
# -*- coding: utf-8 -*-
import importlib.util
from io import StringIO
from unittest.mock import MagicMock, Mock, PropertyMock, call, patch

from django.core.management import CommandError, call_command
from django.test import TestCase
from django.test.utils import override_settings


# Database testing configurations

UNKOWN_ENGINE = {
    "default": {
        "ENGINE": "django.db.backends.unknown",
        "NAME": "unknown",
    }
}

NO_TEST_NAME = {
    "default": {
        "ENGINE": "django.db.backends.mysql",
        "NAME": "test",
        "TEST": {
            "NAME": "",
        },
    }
}

SQLITE = {
    "default": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": "db.sqlite3",
    }
}

MYSQL_HOST_PORT = {
    "default": {
        "ENGINE": "django.db.backends.mysql",
        "NAME": "test",
        "USER": "test",
        "PASSWORD": "test",
        "HOST": "localhost",
        "PORT": "3306",
    },
}

MYSQL_SOCKET = {
    "default": {
        "ENGINE": "django.db.backends.mysql",
        "NAME": "test",
        "USER": "test",
        "PASSWORD": "test",
        "HOST": "/var/run/mysqld/mysql.sock",
    },
}

POSTGRES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql_psycopg2",
        "NAME": "test",
        "USER": "test",
        "PASSWORD": "test",
        "PORT": "5432",
        "HOST": "localhost",
    },
}


class DropTestDatabaseExceptionsTests(TestCase):
    """Test for drop_test_database command."""

    def test_should_raise_CommandError_if_database_is_unknown(self):
        with self.assertRaisesRegex(CommandError, "Unknown database unknown"):
            call_command("drop_test_database", "--database=unknown")

    @override_settings(DATABASES=UNKOWN_ENGINE)
    @patch("django_extensions.management.commands.drop_test_database.input")
    def test_should_raise_CommandError_if_unknown_database_engine(self, m_input):
        m_input.return_value = "yes"
        with self.assertRaisesRegex(
            CommandError, "Unknown database engine django.db.backends.unknown"
        ):
            call_command("drop_test_database")

    @override_settings(DATABASES=NO_TEST_NAME)
    def test_should_raise_CommandError_if_test_database_name_is_empty(self):
        with self.assertRaisesRegex(
            CommandError,
            "You need to specify DATABASE_NAME in your Django settings file.",
        ):
            call_command("drop_test_database")


class DropTestDatabaseTests(TestCase):
    """Test for drop_test_database command."""

    @patch("sys.stdout", new_callable=StringIO)
    @patch("django_extensions.management.commands.drop_test_database.input")
    def test_should_raise_CommandError_if_database_is_unknown(self, m_input, m_stdout):
        m_input.return_value = "no"

        call_command("drop_test_database")

        self.assertEqual("Reset cancelled.\n", m_stdout.getvalue())

    @override_settings(DATABASES=SQLITE)
    @patch("sys.stdout", new_callable=StringIO)
    @patch("os.path.isfile")
    @patch("os.unlink")
    def test_sqlite3_should_unlink_primary_test_database(
        self, m_unlink, m_isfile, m_stdout
    ):
        # Indicate that no clone databases exist
        m_isfile.side_effect = (True, False)
        call_command("drop_test_database", "--noinput", verbosity=2)

        with self.subTest("Should check for test database names until failure"):
            self.assertListEqual(
                m_isfile.call_args_list,
                # See production code comments regarding double dots
                [call("test_db.sqlite3"), call("test_db_1..sqlite3")],
            )

        with self.subTest("Should unlink only primary test database"):
            self.assertListEqual(
                m_unlink.call_args_list,
                [call("test_db.sqlite3")],
            )

        with self.subTest("Should report successful message"):
            self.assertIn("Reset successful.", m_stdout.getvalue())

    @override_settings(DATABASES=SQLITE)
    @patch("os.path.isfile")
    @patch("os.unlink")
    def test_sqlite3_should_unlink_all_existing_clone_databases(
        self, m_unlink, m_isfile
    ):
        """Test cloned test databases created via 'manage.py test --parallel'."""
        # Indicate that clone databases exist up to test_db_2.sqlite3
        m_isfile.side_effect = (True, True, True, False)
        call_command("drop_test_database", "--noinput")

        with self.subTest("Should check for test database names until failure"):
            self.assertListEqual(
                m_isfile.call_args_list,
                [
                    call("test_db.sqlite3"),
                    # See production code comments regarding double dots
                    call("test_db_1..sqlite3"),
                    call("test_db_2..sqlite3"),
                    call("test_db_3..sqlite3"),
                ],
            )

        with self.subTest("Should unlink all existing test databases"):
            self.assertListEqual(
                m_unlink.call_args_list,
                [
                    call("test_db.sqlite3"),
                    # See production code comments regarding double dots
                    call("test_db_1..sqlite3"),
                    call("test_db_2..sqlite3"),
                ],
            )

    @override_settings(DATABASES=SQLITE)
    @patch("sys.stdout", new_callable=StringIO)
    @patch("os.path.isfile")
    @patch("os.unlink")
    def test_sqlite3_should_not_print_Reset_successful_when_OSError_exception(
        self, m_unlink, m_isfile, m_stdout
    ):
        m_isfile.return_value = True
        m_unlink.side_effect = OSError
        call_command("drop_test_database", "--noinput", verbosity=2)

        self.assertNotIn("Reset successful.", m_stdout.getvalue())

    @override_settings(DATABASES=MYSQL_HOST_PORT)
    @patch("sys.stdout", new_callable=StringIO)
    def test_mysql_should_drop_database_with_host_and_port(self, m_stdout):
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        # Indicate that no clone databases exist
        # DROP queries return None while SELECT queries return a row count
        m_database.connect.return_value.cursor.return_value.execute.side_effect = (
            1,
            None,
            0,
        )

        with patch.dict("sys.modules", MySQLdb=m_database):
            call_command("drop_test_database", "--noinput", verbosity=2)

        with self.subTest(
            "Should check for and remove test database names until failure"
        ):
            exists_query = (
                "SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME="
            )
            self.assertListEqual(
                m_database.connect.return_value.cursor.return_value.execute.call_args_list,
                [
                    call(exists_query + "'test_test';"),
                    call("DROP DATABASE IF EXISTS `test_test`"),
                    call(exists_query + "'test_test_1';"),
                ],
            )

        with self.subTest("Should report successful message"):
            self.assertIn("Reset successful.", m_stdout.getvalue())

    @override_settings(DATABASES=MYSQL_SOCKET)
    @patch("sys.stdout", new_callable=StringIO)
    def test_mysql_should_drop_database_with_unix_socket(self, m_stdout):
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        # Indicate that no clone databases exist
        # DROP queries return None while SELECT queries return a row count
        m_database.connect.return_value.cursor.return_value.execute.side_effect = (
            1,
            None,
            0,
        )

        with patch.dict("sys.modules", MySQLdb=m_database):
            call_command("drop_test_database", "--noinput", verbosity=2)

        with self.subTest(
            "Should check for and remove test database names until failure"
        ):
            exists_query = (
                "SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME="
            )
            self.assertListEqual(
                m_database.connect.return_value.cursor.return_value.execute.call_args_list,
                [
                    call(exists_query + "'test_test';"),
                    call("DROP DATABASE IF EXISTS `test_test`"),
                    call(exists_query + "'test_test_1';"),
                ],
            )

        with self.subTest("Should report successful message"):
            self.assertIn("Reset successful.", m_stdout.getvalue())

    @override_settings(DATABASES=MYSQL_HOST_PORT)
    def test_mysql_should_drop_all_existing_clone_databases(self):
        """Test cloned test databases created via 'manage.py test --parallel'."""
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        # Indicate that clone databases exist up to test_test_2
        # DROP queries return None while SELECT queries return a row count
        m_database.connect.return_value.cursor.return_value.execute.side_effect = (
            1,
            None,
            1,
            None,
            1,
            None,
            0,
        )

        with patch.dict("sys.modules", MySQLdb=m_database):
            call_command("drop_test_database", "--noinput")

        exists_query = (
            "SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME="
        )
        self.assertListEqual(
            m_database.connect.return_value.cursor.return_value.execute.call_args_list,
            [
                call(exists_query + "'test_test';"),
                call("DROP DATABASE IF EXISTS `test_test`"),
                call(exists_query + "'test_test_1';"),
                call("DROP DATABASE IF EXISTS `test_test_1`"),
                call(exists_query + "'test_test_2';"),
                call("DROP DATABASE IF EXISTS `test_test_2`"),
                call(exists_query + "'test_test_3';"),
            ],
        )

    @override_settings(DATABASES=POSTGRES)
    @patch("sys.stdout", new_callable=StringIO)
    def test_postgresql_should_drop_database(self, m_stdout):
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        m_cursor = Mock()
        m_database.connect.return_value.cursor.return_value = m_cursor
        # Indicate that no clone databases exist
        type(m_cursor).rowcount = PropertyMock(side_effect=(1, 0))

        mock_kwargs = {"psycopg2": m_database}
        has_psycopg3 = importlib.util.find_spec("psycopg") is not None
        if has_psycopg3:
            mock_kwargs = {"psycopg": m_database}
        with patch.dict("sys.modules", **mock_kwargs):
            call_command("drop_test_database", "--noinput", verbosity=2)

        with self.subTest(
            "Should check for and remove test database names until failure"
        ):
            exists_query = "SELECT datname FROM pg_catalog.pg_database WHERE datname="
            self.assertListEqual(
                m_cursor.execute.call_args_list,
                [
                    call(exists_query + "'test_test';"),
                    call('DROP DATABASE IF EXISTS "test_test";'),
                    call(exists_query + "'test_test_1';"),
                ],
            )

        with self.subTest("Should report successful message"):
            self.assertIn("Reset successful.", m_stdout.getvalue())

    @override_settings(DATABASES=POSTGRES)
    def test_postgresql_should_drop_all_existing_cloned_databases(self):
        """Test cloned test databases created via 'manage.py test --parallel'."""
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        m_cursor = Mock()
        m_database.connect.return_value.cursor.return_value = m_cursor
        # Indicate that clone databases exist up to test_test_2
        type(m_cursor).rowcount = PropertyMock(side_effect=(1, 1, 1, 0))

        mock_kwargs = {"psycopg2": m_database}
        has_psycopg3 = importlib.util.find_spec("psycopg") is not None
        if has_psycopg3:
            mock_kwargs = {"psycopg": m_database}
        with patch.dict("sys.modules", **mock_kwargs):
            call_command("drop_test_database", "--noinput")

        exists_query = "SELECT datname FROM pg_catalog.pg_database WHERE datname="
        self.assertListEqual(
            m_cursor.execute.call_args_list,
            [
                call(exists_query + "'test_test';"),
                call('DROP DATABASE IF EXISTS "test_test";'),
                call(exists_query + "'test_test_1';"),
                call('DROP DATABASE IF EXISTS "test_test_1";'),
                call(exists_query + "'test_test_2';"),
                call('DROP DATABASE IF EXISTS "test_test_2";'),
                call(exists_query + "'test_test_3';"),
            ],
        )

    @override_settings(DATABASES=POSTGRES)
    @patch("sys.stdout", new_callable=StringIO)
    def test_postgresql_should_not_print_Reset_successful_when_exception_occured(
        self, m_stdout
    ):
        m_database = MagicMock()
        m_database.__spec__ = Mock()
        m_database.ProgrammingError = Exception
        m_cursor = Mock()
        m_cursor.execute.side_effect = m_database.ProgrammingError
        m_database.connect.return_value.cursor.return_value = m_cursor

        mock_kwargs = {"psycopg2": m_database}
        has_psycopg3 = importlib.util.find_spec("psycopg") is not None
        if has_psycopg3:
            mock_kwargs = {"psycopg": m_database}
        with patch.dict("sys.modules", **mock_kwargs):
            call_command("drop_test_database", "--noinput", verbosity=2)

        self.assertNotIn("Reset successful.", m_stdout.getvalue())