Summary

Add subquery checks in assertQueries(), and improve output formatting.

Review Request #13372 — Created Oct. 23, 2023 and submitted Oct. 27, 2023, 3:18 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

~~13371~~

Blocks

13373

Reviewers

Groups

djblets

People

Description

This updates assertQueries() to check for and compare subquery
information. This takes in an inner_query attribute that matches the
query comparison dictionary and checks against it.

This wasn't supported before, and because of that, this support must be
optional or we'll break existing tests. Currently, consumers can pass in
check_subqueries=True to enable this. That will be the default in
Djblets 5. For now, if a subquery is found and no explicit
check_subqueries value is provided, a deprecation warning will be
emitted.

Formatting has also improved, in part to help output subquery comparison
details. All values are now passed through pprint.pformat(), and if
the results span multiple lines, it will be formatted with proper
indentation and alignment to help with reading the output.

Testing Done

All Djblets and Review Board unit tests pass.

Commits

Summary	ID
Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	f422f1f0521da2cf74d835120cbf9642b18662d1

Summary

Add subquery checks in assertQueries(), and improve output formatting.

This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.

f422f1f0521da2cf74d835120cbf9642b18662d1

Issues

Description	From	Last Updated
'djblets.db.query_catcher.ExecutedQueryInfo' imported but unused Column: 1 Error code: F401	reviewbot	Oct. 23, 2023, 6:08 p.m.
Should list check_subqueries here.	david	Oct. 25, 2023, 9:21 p.m.
Instead of "update your query expectations to begin migrating to these new checks", how about "update your query expectations to …	david	Oct. 25, 2023, 9:22 p.m.
Wording is off here.	maubin	Oct. 25, 2023, 9:22 p.m.

flake8 failed.

JSHint passed.

flake8

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

The issue has been resolved. Show all issues

'djblets.db.query_catcher.ExecutedQueryInfo' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	410a1b1b6c9d1209165ce35acc7f0bedd1c18d56
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	9a9a862db0afc865ee2cc5dc402a7c9d2716f2c4

Diff:

Revision 2 (+294 -64)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Description:: This updates assertQueries() to check for and compare subquery
information. This takes in an inner_query attribute that matches the
query comparison dictionary and checks against it.

This wasn't supported before, and because of that, this support must be
optional or we'll break existing tests. Currently, consumers can pass in
check_subqueries=True to enable this. That will be the default in
~ Djblets 5.
~ Djblets 5. For now, if a subquery is found and no explicit
+ check_subqueries value is provided, a deprecation warning will be
+ emitted.

Formatting has also improved, in part to help output subquery comparison
details. All values are now passed through pprint.pformat(), and if
the results span multiple lines, it will be formatted with proper
indentation and alignment to help with reading the output.

Change Summary:

Fixed a bug causing inner query matching to factor in outer query expectations.

Commits:

	Summary	ID
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	9a9a862db0afc865ee2cc5dc402a7c9d2716f2c4
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	1ae87b3353227cfe617c039a17efa6b522c49a09

Diff:

Revision 3 (+326 -86)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/testing/testcases.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Should list check_subqueries here.
```

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

The issue has been resolved. Show all issues

Instead of "update your query expectations to begin migrating to these new checks", how about "update your query expectations to include the subquery"?

djblets/testing/testcases.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Wording is off here.
```

Change Summary:


Added check_subqueries to the list of changes for assertQueries().
Improved the warning message when a subquery is found when check_subqueries isn't on.
Improved a comment to help it make more sense.

Commits:

	Summary	ID
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	1ae87b3353227cfe617c039a17efa6b522c49a09
	Add subquery checks in assertQueries(), and improve output formatting. This updates `assertQueries()` to check for and compare subquery information. This takes in an `inner_query` attribute that matches the query comparison dictionary and checks against it. This wasn't supported before, and because of that, this support must be optional or we'll break existing tests. Currently, consumers can pass in `check_subqueries=True` to enable this. That will be the default in Djblets 5. Formatting has also improved, in part to help output subquery comparison details. All values are now passed through `pprint.pformat()`, and if the results span multiple lines, it will be formatted with proper indentation and alignment to help with reading the output.	f422f1f0521da2cf74d835120cbf9642b18662d1

Diff:

Revision 4 (+326 -86)

Show changes

djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

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

		This updates `assertQueries()` to check for and compare subquery
		information. This takes in an `inner_query` attribute that matches the
		query comparison dictionary and checks against it.

		This wasn't supported before, and because of that, this support must be
		optional or we'll break existing tests. Currently, consumers can pass in
		`check_subqueries=True` to enable this. That will be the default in
~		Djblets 5.
	~	Djblets 5. For now, if a subquery is found and no explicit
	+	`check_subqueries` value is provided, a deprecation warning will be
	+	emitted.

		Formatting has also improved, in part to help output subquery comparison
		details. All values are now passed through `pprint.pformat()`, and if
		the results span multiple lines, it will be formatted with proper
		indentation and alignment to help with reading the output.