Summary

Move the assertQueries comparison code into a dedicated module.

Review Request #13396 — Created Nov. 2, 2023 and submitted Nov. 14, 2023, 12:31 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

Blocks

13402

Reviewers

Groups

djblets

People

Description

This introduces djblets.db.query_comparator, which contains the query
comparison code from assertQueries(). This was moved out in order to
help make the code more maintainable, as it will soon need to grow in
size in order to handle ORM sub-expressions, and it was already pretty
large to begin with.

Since we're starting fresh, some renames were made. Instead of
"failures", we now describe results in terms of "mismatches", to help
differentiate from a query that fails to execute.

The inner functions have been made outer functions, avoiding the need to
redefine them when asserting.

Otherwise, nothing has really changed about the assertion logic. This
merely lays the groundwork for upcoming work on comparisons.

assertQueries() has been updated to use this, and has reduced in size
considerably.

Given some of the renames, this does break typing compatibility with
newer code, but not with anything that has been released. The affected
code will be updated to use the new type imports.

Testing Done

Unit tests pass.

Commits

Summary	ID
Move the assertQueries comparison code into a dedicated module. This introduces `djblets.db.query_comparator`, which contains the query comparison code from `assertQueries()`. This was moved out in order to help make the code more maintainable, as it will soon need to grow in size in order to handle ORM sub-expressions, and it was already pretty large to begin with. Since we're starting fresh, some renames were made. Instead of "failures", we now describe results in terms of "mismatches", to help differentiate from a query that fails to execute. The inner functions have been made outer functions, avoiding the need to redefine them when asserting. Otherwise, nothing has really changed about the assertion login. This merely lays the groundwork for upcoming work on comparisons. `assertQueries()` has been updated to use this, and has reduced in size considerably.	d964531a39a993ac75aa55bf8fcf44a10f73b93f

Summary

Move the assertQueries comparison code into a dedicated module.

This introduces `djblets.db.query_comparator`, which contains the query comparison code from `assertQueries()`. This was moved out in order to help make the code more maintainable, as it will soon need to grow in size in order to handle ORM sub-expressions, and it was already pretty large to begin with. Since we're starting fresh, some renames were made. Instead of "failures", we now describe results in terms of "mismatches", to help differentiate from a query that fails to execute. The inner functions have been made outer functions, avoiding the need to redefine them when asserting. Otherwise, nothing has really changed about the assertion login. This merely lays the groundwork for upcoming work on comparisons. `assertQueries()` has been updated to use this, and has reduced in size considerably.

d964531a39a993ac75aa55bf8fcf44a10f73b93f

Issues

Description	From	Last Updated
Typo in description: "login" -> "logic"	maubin	Nov. 6, 2023, midnight

flake8 passed.

JSHint passed.

Change Summary:

Renamed some variables to fit the new naming and fixed some keys.

Commits:

	Summary	ID
	Move the assertQueries comparison code into a dedicated module. This introduces `djblets.db.query_comparator`, which contains the query comparison code from `assertQueries()`. This was moved out in order to help make the code more maintainable, as it will soon need to grow in size in order to handle ORM sub-expressions, and it was already pretty large to begin with. Since we're starting fresh, some renames were made. Instead of "failures", we now describe results in terms of "mismatches", to help differentiate from a query that fails to execute. The inner functions have been made outer functions, avoiding the need to redefine them when asserting. Otherwise, nothing has really changed about the assertion login. This merely lays the groundwork for upcoming work on comparisons. `assertQueries()` has been updated to use this, and has reduced in size considerably.	e9ce2f1f9ee0b9fd680834d325df5ca201db8c4a
	Move the assertQueries comparison code into a dedicated module. This introduces `djblets.db.query_comparator`, which contains the query comparison code from `assertQueries()`. This was moved out in order to help make the code more maintainable, as it will soon need to grow in size in order to handle ORM sub-expressions, and it was already pretty large to begin with. Since we're starting fresh, some renames were made. Instead of "failures", we now describe results in terms of "mismatches", to help differentiate from a query that fails to execute. The inner functions have been made outer functions, avoiding the need to redefine them when asserting. Otherwise, nothing has really changed about the assertion login. This merely lays the groundwork for upcoming work on comparisons. `assertQueries()` has been updated to use this, and has reduced in size considerably.	d964531a39a993ac75aa55bf8fcf44a10f73b93f

Diff:

Revision 2 (+1744 -1234)

Show changes

	djblets/db/query_comparator.py
	djblets/testing/testcases.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

The issue has been resolved. Show all issues
```
Typo in description: "login" -> "logic"
```

Description:

		This introduces `djblets.db.query_comparator`, which contains the query
		comparison code from `assertQueries()`. This was moved out in order to
		help make the code more maintainable, as it will soon need to grow in
		size in order to handle ORM sub-expressions, and it was already pretty
		large to begin with.

		Since we're starting fresh, some renames were made. Instead of
		"failures", we now describe results in terms of "mismatches", to help
		differentiate from a query that fails to execute.

		The inner functions have been made outer functions, avoiding the need to
		redefine them when asserting.

~		Otherwise, nothing has really changed about the assertion login. This
	~	Otherwise, nothing has really changed about the assertion logic. This
		merely lays the groundwork for upcoming work on comparisons.

		`assertQueries()` has been updated to use this, and has reduced in size
		considerably.

		Given some of the renames, this does break typing compatibility with
		newer code, but not with anything that has been released. The affected
		code will be updated to use the new type imports.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (84a8bd2)