Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refs #35448 -- Modified SQL formatting correctly for test --debug-sql #18166

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions django/test/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import os
import pickle
import random
import re
import sys
import textwrap
import unittest
Expand Down Expand Up @@ -96,9 +97,32 @@ 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")
)
parsed_sql_logs = self._parse_sql_logs(sql_debug.splitlines())
self.stream.writeln(self._format_sql_logs(parsed_sql_logs))

def _parse_sql_logs(self, log_lines):
log_pattern = re.compile(
r"\((\d+\.\d{3})\) (.*?); args=(.*?); alias=(.*?)(?:,|\s*$)"
)
return [
{
"duration": match.group(1),
"sql": match.group(2),
"params": match.group(3),
"alias": match.group(4),
}
for log in log_lines
if (match := log_pattern.match(log))
]

def _format_sql_logs(self, log_entries):
return "".join(
f"\n({log['duration']})\n"
f"{sqlparse.format(log['sql'], reindent=True, keyword_case='upper')};\n\n"
f"args={log['params']};\n\n"
f"alias={log['alias']}\n"
for log in log_entries
)


class PDBDebugResult(unittest.TextTestResult):
Expand Down
54 changes: 53 additions & 1 deletion tests/test_runner/test_debug_sql.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

from django.db import connection
from django.test import TestCase
from django.test.runner import DiscoverRunner
from django.test.runner import DebugSQLTextTestResult, DiscoverRunner
from django.utils.version import PY311

from .models import Person
Expand Down Expand Up @@ -151,3 +151,55 @@ def test_setupclass_exception(self):
"(test_runner.test_debug_sql.TestDebugSQL.ErrorSetUpTestDataTest)",
output,
)

def test_parse_sql_logs(self):
result = DebugSQLTextTestResult(
stream=StringIO(), descriptions=False, verbosity=0
)
log_lines = [
"(0.001) SELECT * FROM test_runner_person WHERE id = %s; "
"args=(1,); alias=default",
"(0.002) UPDATE test_runner_person SET name = %s WHERE id = %s; "
"args=('runner', 1); alias=default",
]
expected_output = [
{
"duration": "0.001",
"sql": "SELECT * FROM test_runner_person WHERE id = %s",
"params": "(1,)",
"alias": "default",
},
{
"duration": "0.002",
"sql": "UPDATE test_runner_person SET name = %s WHERE id = %s",
"params": "('runner', 1)",
"alias": "default",
},
]
self.assertEqual(result._parse_sql_logs(log_lines), expected_output)

def test_format_sql_logs(self):
result = DebugSQLTextTestResult(
stream=StringIO(), descriptions=False, verbosity=0
)
log_entries = [
{
"duration": "0.001",
"sql": "SELECT * FROM test_runner_person WHERE id = %s",
"params": "(1,)",
"alias": "default",
},
{
"duration": "0.002",
"sql": "UPDATE test_runner_person SET name = %s WHERE id = %s",
"params": "('runner', 1)",
"alias": "default",
},
]
expected_output = (
"\n(0.001)\nSELECT *\nFROM test_runner_person\nWHERE id = %s;\n\n"
"args=(1,);\n\nalias=default\n\n"
"(0.002)\nUPDATE test_runner_person\nSET name = %s\nWHERE id = %s;\n\n"
"args=('runner', 1);\n\nalias=default\n"
)
self.assertEqual(result._format_sql_logs(log_entries), expected_output)