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

Also adds DatabaseOperations.format_debug_sql() hook for backends
(e.g. NoSQL) to customize formatting.

Author: timgraham

django/db/backends/base/operations.py

@@ -785,3 +785,7 @@ def prepare_join_on_clause(self, lhs_table, lhs_field, rhs_table, rhs_field):
         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")

django/db/backends/utils.py

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

django/test/runner.py

@@ -18,8 +18,6 @@
 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 @@ def printErrorList(self, flavour, errors):
             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):

tests/backends/tests.py

@@ -77,7 +77,12 @@ def test_last_executed_query_without_previous_query(self):
             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)

tests/test_runner/test_debug_sql.py

@@ -91,22 +91,26 @@ def test_output_verbose(self):
         (
             """SELECT COUNT(*) AS "__count"\n"""
             """FROM "test_runner_person"\n"""
-            """WHERE "test_runner_person"."first_name" = 'error';"""
+            """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';"""
+            """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';"""
+            """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';"""
+            """WHERE "test_runner_person"."first_name" = 'subtest-fail'; """
+            """args=('subtest-fail',); alias=default"""
         ),
     ]
 
@@ -122,14 +126,16 @@ def test_output_verbose(self):
         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 """
-            """"test_runner_person"."first_name" = 'pass';"""
+            """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 """
-            """"test_runner_person"."first_name" = 'subtest-pass';"""
+            """SELECT COUNT(*) AS "__count"\n"""
+            """FROM "test_runner_person"\nWHERE """
+            """"test_runner_person"."first_name" = 'subtest-pass'; """
+            """args=('subtest-pass',); alias=default"""
         ),
     ]