mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-12 10:22:37 +00:00
Code Issues 32 Releases Wiki Activity

Fixed #35448 -- Fixed formatting of test --debug-sql output.

Browse Source 
Also adds DatabaseOperations.format_debug_sql() hook for backends
(e.g. NoSQL) to customize formatting.
This commit is contained in:
Tim Graham 2025-01-04 20:27:28 -05:00 committed by Mariusz Felisiak
parent 98767ba2ec
commit d8f093908c
5 changed files with 28 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
django/db/backends/base/operations.py
View File

@ -785,3 +785,7 @@ class BaseDatabaseOperations:
rhs_expr = Col(rhs_table, rhs_field)
return lhs_expr, rhs_expr
def format_debug_sql(self, sql):
# Hook for backends (e.g. NoSQL) to customize formatting.
return sqlparse.format(sql, reindent=True, keyword_case="upper")

2
django/db/backends/utils.py
View File

@ -151,7 +151,7 @@ class CursorDebugWrapper(CursorWrapper):
logger.debug(
"(%.3f) %s; args=%s; alias=%s",
duration,
sql,
self.db.ops.format_debug_sql(sql),
params,
self.db.alias,
extra={

6
django/test/runner.py
View File

@ -18,8 +18,6 @@ from contextlib import contextmanager
from importlib import import_module
from io import StringIO
import sqlparse
import django
from django.core.management import call_command
from django.db import connections
@ -97,9 +95,7 @@ class DebugSQLTextTestResult(unittest.TextTestResult):
self.stream.writeln(self.separator2)
self.stream.writeln(err)
self.stream.writeln(self.separator2)
self.stream.writeln(
sqlparse.format(sql_debug, reindent=True, keyword_case="upper")
)
self.stream.writeln(sql_debug)
class PDBDebugResult(unittest.TextTestResult):

7
tests/backends/tests.py
View File

@ -77,7 +77,12 @@ class LastExecutedQueryTest(TestCase):
connection.ops.last_executed_query(cursor, "", ())
def test_debug_sql(self):
list(Reporter.objects.filter(first_name="test"))
qs = Reporter.objects.filter(first_name="test")
ops = connections[qs.db].ops
with mock.patch.object(ops, "format_debug_sql") as format_debug_sql:
list(qs)
# Queries are formatted with DatabaseOperations.format_debug_sql().
format_debug_sql.assert_called()
sql = connection.queries[-1]["sql"].lower()
self.assertIn("select", sql)
self.assertIn(Reporter._meta.db_table, sql)

14
tests/test_runner/test_debug_sql.py
View File

@ -92,21 +92,25 @@ class TestDebugSQL(unittest.TestCase):
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\n"""
"""WHERE "test_runner_person"."first_name" = 'error'; """
"""args=('error',); alias=default"""
),
(
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\n"""
"""WHERE "test_runner_person"."first_name" = 'fail'; """
"""args=('fail',); alias=default"""
),
(
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\n"""
"""WHERE "test_runner_person"."first_name" = 'subtest-error'; """
"""args=('subtest-error',); alias=default"""
),
(
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\n"""
"""WHERE "test_runner_person"."first_name" = 'subtest-fail'; """
"""args=('subtest-fail',); alias=default"""
),
]
@ -122,14 +126,16 @@ class TestDebugSQL(unittest.TestCase):
f"runTest ({test_class_path}.FailingSubTest{method_name}) ...",
f"runTest ({test_class_path}.ErrorSubTest{method_name}) ...",
(
"""SELECT COUNT(*) AS "__count" """
"""FROM "test_runner_person" WHERE """
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\nWHERE """
""""test_runner_person"."first_name" = 'pass'; """
"""args=('pass',); alias=default"""
),
(
"""SELECT COUNT(*) AS "__count" """
"""FROM "test_runner_person" WHERE """
"""SELECT COUNT(*) AS "__count"\n"""
"""FROM "test_runner_person"\nWHERE """
""""test_runner_person"."first_name" = 'subtest-pass'; """
"""args=('subtest-pass',); alias=default"""
),
]