File: test_reset_db.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 (272 lines) | stat: -rw-r--r-- 9,460 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
# -*- coding: utf-8 -*-
import importlib.util
import os
from io import StringIO

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

from unittest import mock


class ResetDbExceptionsTests(TestCase):
    """Tests if reset_db command raises exceptions."""

    def test_should_raise_CommandError_when_database_does_not_exist(self):
        with self.assertRaisesRegex(
            CommandError, "Unknown database non-existing_database"
        ):
            call_command("reset_db", "--database=non-existing_database")

    @override_settings(
        DATABASES={
            "default": {
                "ENGINE": "django.db.backends.UNKNOWN",
                "NAME": "test.db",
            }
        }
    )
    def test_should_raise_CommandError_when_unknown_database_engine(self):
        with self.assertRaisesRegex(
            CommandError, "Unknown database engine django.db.backends.UNKNOWN"
        ):
            call_command("reset_db", "--noinput")

    @override_settings(
        DATABASES={
            "default": {
                "ENGINE": "django.db.backends.sqlite3",
            }
        }
    )
    def test_should_raise_CommandError_when_no_db_name_provided(self):
        with self.assertRaisesRegex(
            CommandError,
            "You need to specify DATABASE_NAME in your Django settings file.",
        ):
            call_command("reset_db", "--noinput")


@override_settings(
    DATABASES={
        "default": {
            "ENGINE": "django.db.backends.sqlite3",
            "NAME": "test_db.sqlite3",
        }
    }
)
class ResetDbSqlite3Tests(TestCase):
    """Tests for reset_db command and sqlite3 engine."""

    @mock.patch("sys.stdout", new_callable=StringIO)
    @mock.patch("django_extensions.management.commands.reset_db.input")
    def test_should_cancel_reset_db_if_input_is_different_than_yes(
        self, m_input, m_stdout
    ):
        m_input.return_value = "no"
        call_command("reset_db")
        self.assertEqual("Reset cancelled.\n", m_stdout.getvalue())

    @mock.patch("sys.stdout", new_callable=StringIO)
    @mock.patch.object(os, "unlink")
    def test_should_unlink_database_and_print_success_message(self, m_unlink, m_stdout):
        call_command("reset_db", "--noinput", verbosity=2)

        self.assertEqual("Reset successful.\n", m_stdout.getvalue())
        m_unlink.assert_called_once_with("test_db.sqlite3")

    @mock.patch("sys.stdout", new_callable=StringIO)
    @mock.patch.object(
        os,
        "unlink",
        side_effect=[
            OSError,
        ],
    )
    def test_should_print_successful_message_even_if_unlink_failed(
        self, m_unlink, m_stdout
    ):
        call_command("reset_db", "--noinput", verbosity=2)

        self.assertEqual("Reset successful.\n", m_stdout.getvalue())
        m_unlink.assert_called_once_with("test_db.sqlite3")


@override_settings(
    DATABASES={
        "default": {
            "ENGINE": "django.db.backends.mysql",
            "NAME": "test_db",
            "USER": "foo",
            "PASSWORD": "bar",
            "HOST": "127.0.0.1",
            "PORT": "",
        }
    }
)
class ResetDbMysqlTests(TestCase):
    """Tests for reset_db command and mysql engine."""

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

        call_command("reset_db")

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

    @mock.patch("sys.stdout", new_callable=StringIO)
    def test_should_drop_and_create_database_with_characterset_utf8_and_print_success_messsage(
        self, m_stdout
    ):
        m_database = mock.MagicMock()
        m_database.__spec__ = mock.Mock()
        m_connection = mock.Mock()
        m_database.connect.return_value = m_connection
        expected_calls = [
            mock.call("DROP DATABASE IF EXISTS `test_db`"),
            mock.call("CREATE DATABASE `test_db` CHARACTER SET utf8"),
        ]

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

        m_database.connect.assert_called_once_with(
            host="127.0.0.1", passwd="bar", user="foo"
        )
        m_connection.query.assert_has_calls(expected_calls, any_order=False)
        self.assertEqual("Reset successful.\n", m_stdout.getvalue())

    @override_settings(
        DATABASES={
            "default": {
                "ENGINE": "django.db.backends.mysql",
                "NAME": "test_db",
                "USER": "foo",
                "PASSWORD": "bar",
                "HOST": "/var/run/mysqld/mysql.sock",
                "PORT": "3306",
            },
        }
    )
    @mock.patch("sys.stdout", new_callable=StringIO)
    def test_should_drop_and_create_database_without_characterset_and_print_success_messsage(
        self, m_stdout
    ):
        m_database = mock.MagicMock()
        m_database.__spec__ = mock.Mock()
        m_connection = mock.Mock()
        m_database.connect.return_value = m_connection
        expected_calls = [
            mock.call("DROP DATABASE IF EXISTS `test_db`"),
            mock.call("CREATE DATABASE `test_db`"),
        ]

        with mock.patch.dict("sys.modules", MySQLdb=m_database):
            call_command("reset_db", "--noinput", "--no-utf8", verbosity=2)

        m_database.connect.assert_called_once_with(
            passwd="bar",
            port=3306,
            unix_socket="/var/run/mysqld/mysql.sock",
            user="foo",
        )
        m_connection.query.assert_has_calls(expected_calls, any_order=False)
        self.assertEqual("Reset successful.\n", m_stdout.getvalue())


@override_settings(
    DATABASES={
        "default": {
            "ENGINE": "django.db.backends.postgresql_psycopg2",
            "NAME": "test_db",
            "USER": "foo",
            "PASSWORD": "bar",
            "HOST": "127.0.0.1",
            "PORT": "5432",
        }
    }
)
class ResetDbPostgresqlTests(TestCase):
    """Tests for reset_db command and sqlite3 engine."""

    @mock.patch("sys.stdout", new_callable=StringIO)
    @mock.patch("django_extensions.management.commands.reset_db.input")
    def test_should_cancel_reset_db_if_input_is_different_than_yes(
        self, m_input, m_stdout
    ):
        m_input.return_value = "no"
        call_command("reset_db")
        self.assertEqual("Reset cancelled.\n", m_stdout.getvalue())

    @mock.patch("sys.stdout", new_callable=StringIO)
    def test_should_drop_and_create_database_and_print_success_messsage(self, m_stdout):
        m_database = mock.MagicMock()
        m_database.__spec__ = mock.Mock()
        m_cursor = mock.Mock()
        m_database.connect.return_value.cursor.return_value = m_cursor
        expected_calls = [
            mock.call('DROP DATABASE "test_db";'),
            mock.call(
                'CREATE DATABASE "test_db" WITH OWNER = "foo"  ENCODING = \'UTF8\';'
            ),
        ]

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

        m_database.connect.assert_called_once_with(
            dbname="template1",
            host="127.0.0.1",
            password="bar",
            port="5432",
            user="foo",
        )

        m_cursor.execute.assert_has_calls(expected_calls, any_order=False)
        self.assertEqual("Reset successful.\n", m_stdout.getvalue())

    @override_settings(DEFAULT_TABLESPACE="TEST_TABLESPACE")
    @mock.patch("sys.stdout", new_callable=StringIO)
    def test_should_drop_create_database_close_sessions_and_print_success_messsage(
        self, m_stdout
    ):
        m_database = mock.MagicMock()
        m_database.__spec__ = mock.Mock()
        m_cursor = mock.Mock()
        m_database.connect.return_value.cursor.return_value = m_cursor
        expected_calls = [
            mock.call(
                "\n                    SELECT pg_terminate_backend(pg_stat_activity.pid)\n                    FROM pg_stat_activity\n                    WHERE pg_stat_activity.datname = 'test_db';\n                "
            ),
            mock.call('DROP DATABASE "test_db";'),
            mock.call(
                'CREATE DATABASE "test_db" WITH OWNER = "foo"  ENCODING = \'UTF8\' TABLESPACE = TEST_TABLESPACE;'
            ),
        ]

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

        m_database.connect.assert_called_once_with(
            dbname="template1",
            host="127.0.0.1",
            password="bar",
            port="5432",
            user="foo",
        )

        m_cursor.execute.assert_has_calls(expected_calls, any_order=False)
        self.assertEqual("Reset successful.\n", m_stdout.getvalue())