Summary

Add TestCase.assertQueries(), for advanced query checks.

Review Request #12345 — Created June 8, 2022 and submitted June 10, 2022, 7:06 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This introduces TestCase.assertQueries(), a new unit test function
that can assert not just the number of queries performed by also the
complexity of those queries.

This takes in a list of queries built by Django and executed, checking
them for the lists of fields selected, tables joined, filter
conditions, annotations, ordering, and more.

This can offer a lot of advantages when writing tests, helping ensure
that queries are as performant as possible, or at least don't contain
unexpected complexity.

Testing Done

Made use of this in a bunch of unit tests in Review Board. Tested all
the major types of operations that can be performed when querying.

Commits

Summary	ID
Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	5d12cc2d9e4d1b9fc1d61c79b4e494d4756dea7e

Summary

Add TestCase.assertQueries(), for advanced query checks.

This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.

5d12cc2d9e4d1b9fc1d61c79b4e494d4756dea7e

Issues

Description	From	Last Updated
too many blank lines (2) Column: 9 Error code: E303	reviewbot	June 8, 2022, 11:57 p.m.
expected 1 blank line before a nested definition, found 0 Column: 9 Error code: E306	reviewbot	June 8, 2022, 11:57 p.m.
redefinition of unused '_execute_sql' from line 429 Column: 9 Error code: F811	reviewbot	June 8, 2022, 11:57 p.m.
redefinition of unused '_execute_sql' from line 441 Column: 9 Error code: F811	reviewbot	June 8, 2022, 11:57 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/testing/testcases.py (Diff revision 1)
The issue has been resolved. Show all issues
```
too many blank lines (2)

Column: 9
Error code: E303
```

djblets/testing/testcases.py (Diff revision 1)

The issue has been resolved. Show all issues

expected 1 blank line before a nested definition, found 0

Column: 9
Error code: E306

djblets/testing/testcases.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused '_execute_sql' from line 429

Column: 9
Error code: F811
```
djblets/testing/testcases.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused '_execute_sql' from line 441

Column: 9
Error code: F811
```

Change Summary:


Removed an unwanted blank line.
Changed the function names for the spies to be unique.

Commits:

	Summary	ID
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	5680f25b55c0668827cb1a47e8ffce236028ff24
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	a36eb981eb45b503461b1eeffd823852692b41ba

Diff:

Revision 2 (+670 -2)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed a typo in a comment.

Commits:

	Summary	ID
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	a36eb981eb45b503461b1eeffd823852692b41ba
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	05f77e0d4b91f5f5dd6fd74427f1b7f4a26263a6

Diff:

Revision 3 (+668 -2)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Changed the Query.chain spy to Query.clone, which is more comprehensive.

Commits:

	Summary	ID
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	05f77e0d4b91f5f5dd6fd74427f1b7f4a26263a6
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	93f4695119235b393c85f71ab60bfd076958f9b0

Diff:

Revision 4 (+668 -2)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Forced Django's fast-deletion to be disabled during query collection, ensuring stable query counts/information during deletes.
Added generated SQL to any failed query information, to aid with debugging of failed tests.
Improved error reporting when the number of expected and executed queries don't match. Now we still compare all executed queries.
Fixed a default value when comparing tables when there's a non-JOINed query.

Commits:

	Summary	ID
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	93f4695119235b393c85f71ab60bfd076958f9b0
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	30dba59525421a643aaee15af796d6476e4462b5

Diff:

Revision 5 (+736 -2)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Fixed JOIN count and table tracking to only consider tables with a JOIN refcount > 0.
Fixed a double-recording for UPDATE operations.
Worked around a bug in Django with SQL generation for SQLite INSERT OR IGNORE calls.

Commits:

	Summary	ID
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	30dba59525421a643aaee15af796d6476e4462b5
	Add TestCase.assertQueries(), for advanced query checks. This introduces `TestCase.assertQueries()`, a new unit test function that can assert not just the number of queries performed by also the complexity of those queries. This takes in a list of queries built by Django and executed, checking them for the lists of fields selected, tables joined, filter conditions, annotations, ordering, and more. This can offer a lot of advantages when writing tests, helping ensure that queries are as performant as possible, or at least don't contain unexpected complexity.	5d12cc2d9e4d1b9fc1d61c79b4e494d4756dea7e

Diff:

Revision 6 (+770 -2)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (685c48c)