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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
|
import asyncio
import datetime
import os
import unittest
from unittest.mock import call, patch
import django
from asgiref.sync import sync_to_async
from django.contrib.auth.models import User
from django.db import connection, transaction
from django.db.backends.utils import CursorDebugWrapper, CursorWrapper
from django.db.models import Count
from django.db.utils import DatabaseError
from django.shortcuts import render
from django.test.utils import override_settings
import debug_toolbar.panels.sql.tracking as sql_tracking
from debug_toolbar.panels.sql import SQLPanel
try:
import psycopg
except ImportError:
psycopg = None
from ..base import BaseMultiDBTestCase, BaseTestCase
from ..models import Binary, PostgresJSON
def sql_call(*, use_iterator=False):
qs = User.objects.all()
if use_iterator:
qs = qs.iterator()
return list(qs)
async def async_sql_call(*, use_iterator=False):
qs = User.objects.all()
if use_iterator:
qs = qs.iterator()
return await sync_to_async(list)(qs)
async def concurrent_async_sql_call(*, use_iterator=False):
qs = User.objects.all()
if use_iterator:
qs = qs.iterator()
return await asyncio.gather(sync_to_async(list)(qs), User.objects.acount())
class SQLPanelTestCase(BaseTestCase):
panel_id = SQLPanel.panel_id
def test_disabled(self):
config = {"DISABLE_PANELS": {"debug_toolbar.panels.sql.SQLPanel"}}
self.assertTrue(self.panel.enabled)
with self.settings(DEBUG_TOOLBAR_CONFIG=config):
self.assertFalse(self.panel.enabled)
def test_recording(self):
self.assertEqual(len(self.panel._queries), 0)
sql_call()
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertTrue("duration" in query)
self.assertTrue("stacktrace" in query)
# ensure the stacktrace is populated
self.assertTrue(len(query["stacktrace"]) > 0)
async def test_recording_async(self):
self.assertEqual(len(self.panel._queries), 0)
await async_sql_call()
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertTrue("duration" in query)
self.assertTrue("stacktrace" in query)
# ensure the stacktrace is populated
self.assertTrue(len(query["stacktrace"]) > 0)
async def test_recording_concurrent_async(self):
self.assertEqual(len(self.panel._queries), 0)
await concurrent_async_sql_call()
# ensure query was logged
self.assertEqual(len(self.panel._queries), 2)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertTrue("duration" in query)
self.assertTrue("stacktrace" in query)
# ensure the stacktrace is populated
self.assertTrue(len(query["stacktrace"]) > 0)
@unittest.skipUnless(
connection.vendor == "postgresql", "Test valid only on PostgreSQL"
)
def test_recording_chunked_cursor(self):
self.assertEqual(len(self.panel._queries), 0)
sql_call(use_iterator=True)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
@patch(
"debug_toolbar.panels.sql.tracking.patch_cursor_wrapper_with_mixin",
wraps=sql_tracking.patch_cursor_wrapper_with_mixin,
)
def test_cursor_wrapper_singleton(self, mock_patch_cursor_wrapper):
sql_call()
# ensure that cursor wrapping is applied only once
self.assertIn(
mock_patch_cursor_wrapper.mock_calls,
[
[call(CursorWrapper, sql_tracking.NormalCursorMixin)],
# CursorDebugWrapper is used if the test is called with `--debug-sql`
[call(CursorDebugWrapper, sql_tracking.NormalCursorMixin)],
],
)
@patch(
"debug_toolbar.panels.sql.tracking.patch_cursor_wrapper_with_mixin",
wraps=sql_tracking.patch_cursor_wrapper_with_mixin,
)
def test_chunked_cursor_wrapper_singleton(self, mock_patch_cursor_wrapper):
sql_call(use_iterator=True)
# ensure that cursor wrapping is applied only once
self.assertIn(
mock_patch_cursor_wrapper.mock_calls,
[
[call(CursorWrapper, sql_tracking.NormalCursorMixin)],
# CursorDebugWrapper is used if the test is called with `--debug-sql`
[call(CursorDebugWrapper, sql_tracking.NormalCursorMixin)],
],
)
@patch(
"debug_toolbar.panels.sql.tracking.patch_cursor_wrapper_with_mixin",
wraps=sql_tracking.patch_cursor_wrapper_with_mixin,
)
async def test_cursor_wrapper_async(self, mock_patch_cursor_wrapper):
await sync_to_async(sql_call)()
self.assertIn(
mock_patch_cursor_wrapper.mock_calls,
[
[call(CursorWrapper, sql_tracking.NormalCursorMixin)],
# CursorDebugWrapper is used if the test is called with `--debug-sql`
[call(CursorDebugWrapper, sql_tracking.NormalCursorMixin)],
],
)
@patch(
"debug_toolbar.panels.sql.tracking.patch_cursor_wrapper_with_mixin",
wraps=sql_tracking.patch_cursor_wrapper_with_mixin,
)
async def test_cursor_wrapper_asyncio_ctx(self, mock_patch_cursor_wrapper):
self.assertTrue(sql_tracking.allow_sql.get())
await sync_to_async(sql_call)()
async def task():
sql_tracking.allow_sql.set(False)
# By disabling sql_tracking.allow_sql, we are indicating that any
# future SQL queries should be stopped. If SQL query occurs,
# it raises an exception.
with self.assertRaises(sql_tracking.SQLQueryTriggered):
await sync_to_async(sql_call)()
# Ensure this is called in another context
await asyncio.create_task(task())
# Because it was called in another context, it should not have affected ours
self.assertTrue(sql_tracking.allow_sql.get())
self.assertIn(
mock_patch_cursor_wrapper.mock_calls,
[
[
call(CursorWrapper, sql_tracking.NormalCursorMixin),
call(CursorWrapper, sql_tracking.ExceptionCursorMixin),
],
# CursorDebugWrapper is used if the test is called with `--debug-sql`
[
call(CursorDebugWrapper, sql_tracking.NormalCursorMixin),
call(CursorDebugWrapper, sql_tracking.ExceptionCursorMixin),
],
],
)
def test_generate_server_timing(self):
self.assertEqual(len(self.panel._queries), 0)
sql_call()
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.panel.generate_server_timing(self.request, response)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
expected_data = {
"sql_time": {"title": "SQL 1 queries", "value": query["duration"]}
}
self.assertEqual(self.panel.get_server_timing_stats(), expected_data)
def test_non_ascii_query(self):
self.assertEqual(len(self.panel._queries), 0)
# non-ASCII text query
list(User.objects.extra(where=["username = 'apéro'"]))
self.assertEqual(len(self.panel._queries), 1)
# non-ASCII text parameters
list(User.objects.filter(username="thé"))
self.assertEqual(len(self.panel._queries), 2)
# non-ASCII bytes parameters
list(Binary.objects.filter(field__in=["café".encode()]))
self.assertEqual(len(self.panel._queries), 3)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure the panel renders correctly
self.assertIn("café", self.panel.content)
@unittest.skipUnless(
connection.vendor == "postgresql", "Test valid only on PostgreSQL"
)
def test_bytes_query(self):
self.assertEqual(len(self.panel._queries), 0)
with connection.cursor() as cursor:
cursor.execute(b"SELECT 1")
self.assertEqual(len(self.panel._queries), 1)
def test_param_conversion(self):
self.assertEqual(len(self.panel._queries), 0)
list(
User.objects.filter(first_name="Foo")
.filter(is_staff=True)
.filter(is_superuser=False)
)
list(
User.objects.annotate(group_count=Count("groups__id"))
.filter(group_count__lt=10)
.filter(group_count__gt=1)
)
list(
User.objects.filter(
date_joined=datetime.datetime(
2017, 12, 22, 16, 7, 1, tzinfo=datetime.timezone.utc
)
)
)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 3)
if connection.vendor == "mysql" and django.VERSION >= (4, 1):
# Django 4.1 started passing true/false back for boolean
# comparisons in MySQL.
expected_bools = '["Foo", true, false]'
else:
expected_bools = '["Foo"]'
if connection.vendor == "postgresql":
# PostgreSQL always includes timezone
expected_datetime = '["2017-12-22 16:07:01+00:00"]'
else:
expected_datetime = '["2017-12-22 16:07:01"]'
self.assertEqual(
tuple(query["params"] for query in self.panel._queries),
(
expected_bools,
"[10, 1]",
expected_datetime,
),
)
@unittest.skipUnless(
connection.vendor == "postgresql", "Test valid only on PostgreSQL"
)
def test_json_param_conversion(self):
self.assertEqual(len(self.panel._queries), 0)
list(PostgresJSON.objects.filter(field__contains={"foo": "bar"}))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
self.assertEqual(
self.panel._queries[0]["params"],
'["{\\"foo\\": \\"bar\\"}"]',
)
@unittest.skipUnless(
connection.vendor == "postgresql" and psycopg is None,
"Test valid only on PostgreSQL with psycopg2",
)
def test_tuple_param_conversion(self):
"""
Regression test for tuple parameter conversion.
"""
self.assertEqual(len(self.panel._queries), 0)
list(
PostgresJSON.objects.raw(
"SELECT * FROM tests_postgresjson WHERE field ->> 'key' IN %s",
[("a", "b'")],
)
)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
self.assertEqual(self.panel._queries[0]["params"], '[["a", "b\'"]]')
def test_binary_param_force_text(self):
self.assertEqual(len(self.panel._queries), 0)
with connection.cursor() as cursor:
cursor.execute(
"SELECT * FROM tests_binary WHERE field = %s",
[connection.Database.Binary(b"\xff")],
)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.assertEqual(len(self.panel._queries), 1)
self.assertIn(
"<strong>SELECT</strong> * <strong>FROM</strong>"
" tests_binary <strong>WHERE</strong> field =",
self.panel.content,
)
@unittest.skipUnless(connection.vendor != "sqlite", "Test invalid for SQLite")
def test_raw_query_param_conversion(self):
self.assertEqual(len(self.panel._queries), 0)
list(
User.objects.raw(
" ".join(
[
"SELECT *",
"FROM auth_user",
"WHERE first_name = %s",
"AND is_staff = %s",
"AND is_superuser = %s",
"AND date_joined = %s",
]
),
params=["Foo", True, False, datetime.datetime(2017, 12, 22, 16, 7, 1)],
)
)
list(
User.objects.raw(
" ".join(
[
"SELECT *",
"FROM auth_user",
"WHERE first_name = %(first_name)s",
"AND is_staff = %(is_staff)s",
"AND is_superuser = %(is_superuser)s",
"AND date_joined = %(date_joined)s",
]
),
params={
"first_name": "Foo",
"is_staff": True,
"is_superuser": False,
"date_joined": datetime.datetime(2017, 12, 22, 16, 7, 1),
},
)
)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure query was logged
self.assertEqual(len(self.panel._queries), 2)
self.assertEqual(
tuple(query["params"] for query in self.panel._queries),
(
'["Foo", true, false, "2017-12-22 16:07:01"]',
" ".join(
[
'{"first_name": "Foo",',
'"is_staff": true,',
'"is_superuser": false,',
'"date_joined": "2017-12-22 16:07:01"}',
]
),
),
)
def test_insert_content(self):
"""
Test that the panel only inserts content after generate_stats and
not the process_request.
"""
list(User.objects.filter(username="café"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# ensure the panel renders correctly.
content = self.panel.content
self.assertIn("café", content)
self.assertValidHTML(content)
@override_settings(DEBUG_TOOLBAR_CONFIG={"ENABLE_STACKTRACES_LOCALS": True})
def test_insert_locals(self):
"""
Test that the panel inserts locals() content.
"""
local_var = "<script>alert('test');</script>" # noqa: F841
list(User.objects.filter(username="café"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.assertIn("local_var", self.panel.content)
# Verify the escape logic works
content = self.panel.content
self.assertNotIn("<script>alert", content)
self.assertIn("<script>alert", content)
self.assertIn("djdt-locals", content)
def test_not_insert_locals(self):
"""
Test that the panel does not insert locals() content.
"""
list(User.objects.filter(username="café"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.assertNotIn("djdt-locals", self.panel.content)
@unittest.skipUnless(
connection.vendor == "postgresql", "Test valid only on PostgreSQL"
)
def test_erroneous_query(self):
"""
Test that an error in the query isn't swallowed by the middleware.
"""
try:
connection.cursor().execute("erroneous query")
except DatabaseError as e:
self.assertTrue("erroneous query" in str(e))
@unittest.skipUnless(
connection.vendor == "postgresql", "Test valid only on PostgreSQL"
)
def test_execute_with_psycopg_composed_sql(self):
"""
Test command executed using a Composed psycopg object is logged.
Ref: https://www.psycopg.org/psycopg3/docs/api/sql.html
"""
try:
from psycopg import sql
except ImportError:
from psycopg2 import sql
self.assertEqual(len(self.panel._queries), 0)
with connection.cursor() as cursor:
command = sql.SQL("select {field} from {table}").format(
field=sql.Identifier("username"), table=sql.Identifier("auth_user")
)
cursor.execute(command)
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertEqual(query["sql"], 'select "username" from "auth_user"')
def test_disable_stacktraces(self):
self.assertEqual(len(self.panel._queries), 0)
with self.settings(DEBUG_TOOLBAR_CONFIG={"ENABLE_STACKTRACES": False}):
sql_call()
# ensure query was logged
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertTrue("duration" in query)
self.assertTrue("stacktrace" in query)
# ensure the stacktrace is empty
self.assertEqual([], query["stacktrace"])
@override_settings(
DEBUG=True,
TEMPLATES=[
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"OPTIONS": {"debug": True, "loaders": ["tests.loaders.LoaderWithSQL"]},
}
],
)
def test_regression_infinite_recursion(self):
"""
Test case for when the template loader runs a SQL query that causes
an infinite recursion in the SQL panel.
"""
self.assertEqual(len(self.panel._queries), 0)
render(self.request, "basic.html", {})
# Two queries are logged because the loader runs SQL every time a
# template is loaded and basic.html extends base.html.
self.assertEqual(len(self.panel._queries), 2)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertTrue("sql" in query)
self.assertTrue("duration" in query)
self.assertTrue("stacktrace" in query)
# ensure the stacktrace is populated
self.assertTrue(len(query["stacktrace"]) > 0)
def test_prettify_sql(self):
"""
Test case to validate that the PRETTIFY_SQL setting changes the output
of the sql when it's toggled. It does not validate what it does
though.
"""
with override_settings(DEBUG_TOOLBAR_CONFIG={"PRETTIFY_SQL": True}):
list(User.objects.filter(username__istartswith="spam"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# The content formats the sql and prettifies it
self.assertTrue(self.panel.content)
pretty_sql = self.panel._queries[-1]["sql"]
self.assertEqual(len(self.panel._queries), 1)
# Recreate the panel to reset the queries. Content being a cached_property
# which doesn't have a way to reset it.
self.panel.disable_instrumentation()
self.panel = SQLPanel(self.panel.toolbar, self.panel.get_response)
self.panel.enable_instrumentation()
# Run it again, but with prettify off. Verify that it's different.
with override_settings(DEBUG_TOOLBAR_CONFIG={"PRETTIFY_SQL": False}):
list(User.objects.filter(username__istartswith="spam"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# The content formats the sql and prettifies it
self.assertTrue(self.panel.content)
self.assertEqual(len(self.panel._queries), 1)
self.assertNotIn(pretty_sql, self.panel.content)
self.panel.disable_instrumentation()
self.panel = SQLPanel(self.panel.toolbar, self.panel.get_response)
self.panel.enable_instrumentation()
# Run it again, but with prettify back on.
# This is so we don't have to check what PRETTIFY_SQL does exactly,
# but we know it's doing something.
with override_settings(DEBUG_TOOLBAR_CONFIG={"PRETTIFY_SQL": True}):
list(User.objects.filter(username__istartswith="spam"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# The content formats the sql and prettifies it
self.assertTrue(self.panel.content)
self.assertEqual(len(self.panel._queries), 1)
self.assertIn(pretty_sql, self.panel.content)
def test_simplification(self):
"""
Test case to validate that select lists for .count() and .exist() queries do not
get elided, but other select lists do.
"""
User.objects.count()
User.objects.exists()
list(User.objects.values_list("id"))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# The content formats the sql which injects the ellipsis character
self.assertTrue(self.panel.content)
self.assertEqual(len(self.panel._queries), 3)
self.assertNotIn("\u2022", self.panel._queries[0]["sql"])
self.assertNotIn("\u2022", self.panel._queries[1]["sql"])
self.assertIn("\u2022", self.panel._queries[2]["sql"])
def test_top_level_simplification(self):
"""
Test case to validate that top-level select lists get elided, but other select
lists for subselects do not.
"""
list(User.objects.filter(id__in=User.objects.filter(is_staff=True)))
list(User.objects.filter(id__lt=20).union(User.objects.filter(id__gt=10)))
if connection.vendor != "mysql":
list(
User.objects.filter(id__lt=20).intersection(
User.objects.filter(id__gt=10)
)
)
list(
User.objects.filter(id__lt=20).difference(
User.objects.filter(id__gt=10)
)
)
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
# The content formats the sql which injects the ellipsis character
self.assertTrue(self.panel.content)
if connection.vendor != "mysql":
self.assertEqual(len(self.panel._queries), 4)
else:
self.assertEqual(len(self.panel._queries), 2)
# WHERE ... IN SELECT ... queries should have only one elided select list
self.assertEqual(self.panel._queries[0]["sql"].count("SELECT"), 4)
self.assertEqual(self.panel._queries[0]["sql"].count("\u2022"), 3)
# UNION queries should have two elidid select lists
self.assertEqual(self.panel._queries[1]["sql"].count("SELECT"), 4)
self.assertEqual(self.panel._queries[1]["sql"].count("\u2022"), 6)
if connection.vendor != "mysql":
# INTERSECT queries should have two elidid select lists
self.assertEqual(self.panel._queries[2]["sql"].count("SELECT"), 4)
self.assertEqual(self.panel._queries[2]["sql"].count("\u2022"), 6)
# EXCEPT queries should have two elidid select lists
self.assertEqual(self.panel._queries[3]["sql"].count("SELECT"), 4)
self.assertEqual(self.panel._queries[3]["sql"].count("\u2022"), 6)
@override_settings(
DEBUG=True,
)
def test_flat_template_information(self):
"""
Test case for when the query is used in a flat template hierarchy
(without included templates).
"""
self.assertEqual(len(self.panel._queries), 0)
users = User.objects.all()
render(self.request, "sql/flat.html", {"users": users})
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
template_info = query["template_info"]
template_name = os.path.basename(template_info["name"])
self.assertEqual(template_name, "flat.html")
self.assertEqual(template_info["context"][3]["content"].strip(), "{{ users }}")
self.assertEqual(template_info["context"][3]["highlight"], True)
@override_settings(
DEBUG=True,
)
def test_nested_template_information(self):
"""
Test case for when the query is used in a nested template
hierarchy (with included templates).
"""
self.assertEqual(len(self.panel._queries), 0)
users = User.objects.all()
render(self.request, "sql/nested.html", {"users": users})
self.assertEqual(len(self.panel._queries), 1)
query = self.panel._queries[0]
template_info = query["template_info"]
template_name = os.path.basename(template_info["name"])
self.assertEqual(template_name, "included.html")
self.assertEqual(template_info["context"][0]["content"].strip(), "{{ users }}")
self.assertEqual(template_info["context"][0]["highlight"], True)
def test_similar_and_duplicate_grouping(self):
self.assertEqual(len(self.panel._queries), 0)
User.objects.filter(id=1).count()
User.objects.filter(id=1).count()
User.objects.filter(id=2).count()
User.objects.filter(id__lt=10).count()
User.objects.filter(id__lt=20).count()
User.objects.filter(id__gt=10, id__lt=20).count()
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.assertEqual(len(self.panel._queries), 6)
queries = self.panel._queries
query = queries[0]
self.assertEqual(query["similar_count"], 3)
self.assertEqual(query["duplicate_count"], 2)
query = queries[1]
self.assertEqual(query["similar_count"], 3)
self.assertEqual(query["duplicate_count"], 2)
query = queries[2]
self.assertEqual(query["similar_count"], 3)
self.assertTrue("duplicate_count" not in query)
query = queries[3]
self.assertEqual(query["similar_count"], 2)
self.assertTrue("duplicate_count" not in query)
query = queries[4]
self.assertEqual(query["similar_count"], 2)
self.assertTrue("duplicate_count" not in query)
query = queries[5]
self.assertTrue("similar_count" not in query)
self.assertTrue("duplicate_count" not in query)
self.assertEqual(queries[0]["similar_color"], queries[1]["similar_color"])
self.assertEqual(queries[0]["similar_color"], queries[2]["similar_color"])
self.assertEqual(queries[0]["duplicate_color"], queries[1]["duplicate_color"])
self.assertNotEqual(queries[0]["similar_color"], queries[0]["duplicate_color"])
self.assertEqual(queries[3]["similar_color"], queries[4]["similar_color"])
self.assertNotEqual(queries[0]["similar_color"], queries[3]["similar_color"])
self.assertNotEqual(queries[0]["duplicate_color"], queries[3]["similar_color"])
def test_explain_with_union(self):
list(User.objects.filter(id__lt=20).union(User.objects.filter(id__gt=10)))
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
query = self.panel._queries[0]
self.assertTrue(query["is_select"])
class SQLPanelMultiDBTestCase(BaseMultiDBTestCase):
panel_id = SQLPanel.panel_id
def test_aliases(self):
self.assertFalse(self.panel._queries)
list(User.objects.all())
list(User.objects.using("replica").all())
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
self.assertTrue(self.panel._queries)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
query = self.panel._queries[-1]
self.assertEqual(query["alias"], "replica")
def test_transaction_status(self):
"""
Test case for tracking the transaction status is properly associated with
queries on PostgreSQL, and that transactions aren't broken on other database
engines.
"""
self.assertEqual(len(self.panel._queries), 0)
with transaction.atomic():
list(User.objects.all())
list(User.objects.using("replica").all())
with transaction.atomic(using="replica"):
list(User.objects.all())
list(User.objects.using("replica").all())
with transaction.atomic():
list(User.objects.all())
list(User.objects.using("replica").all())
response = self.panel.process_request(self.request)
self.panel.generate_stats(self.request, response)
if connection.vendor == "postgresql":
# Connection tracking is currently only implemented for PostgreSQL.
self.assertEqual(len(self.panel._queries), 6)
query = self.panel._queries[0]
self.assertEqual(query["alias"], "default")
self.assertIsNotNone(query["trans_id"])
self.assertTrue(query["starts_trans"])
self.assertTrue(query["in_trans"])
self.assertFalse("end_trans" in query)
query = self.panel._queries[-1]
self.assertEqual(query["alias"], "replica")
self.assertIsNone(query["trans_id"])
self.assertFalse("starts_trans" in query)
self.assertFalse("in_trans" in query)
self.assertFalse("end_trans" in query)
query = self.panel._queries[2]
self.assertEqual(query["alias"], "default")
self.assertIsNotNone(query["trans_id"])
self.assertEqual(query["trans_id"], self.panel._queries[0]["trans_id"])
self.assertFalse("starts_trans" in query)
self.assertTrue(query["in_trans"])
self.assertTrue(query["ends_trans"])
query = self.panel._queries[3]
self.assertEqual(query["alias"], "replica")
self.assertIsNotNone(query["trans_id"])
self.assertNotEqual(query["trans_id"], self.panel._queries[0]["trans_id"])
self.assertTrue(query["starts_trans"])
self.assertTrue(query["in_trans"])
self.assertTrue(query["ends_trans"])
query = self.panel._queries[4]
self.assertEqual(query["alias"], "default")
self.assertIsNotNone(query["trans_id"])
self.assertNotEqual(query["trans_id"], self.panel._queries[0]["trans_id"])
self.assertNotEqual(query["trans_id"], self.panel._queries[3]["trans_id"])
self.assertTrue(query["starts_trans"])
self.assertTrue(query["in_trans"])
self.assertTrue(query["ends_trans"])
query = self.panel._queries[5]
self.assertEqual(query["alias"], "replica")
self.assertIsNone(query["trans_id"])
self.assertFalse("starts_trans" in query)
self.assertFalse("in_trans" in query)
self.assertFalse("end_trans" in query)
else:
# Ensure that nothing was recorded for other database engines.
self.assertTrue(self.panel._queries)
for query in self.panel._queries:
self.assertFalse("trans_id" in query)
self.assertFalse("starts_trans" in query)
self.assertFalse("in_trans" in query)
self.assertFalse("end_trans" in query)
|