Summary

Add expected query utilities for common tests, accounts and Local Sites.

Review Request #13411 — Created Nov. 9, 2023 and submitted Dec. 7, 2023, 1:33 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This introduces some new utility functions for generating common
expected queries:

reviewboard.accounts.testing.queries:
- get_user_by_pk_equeries()
- get_user_local_site_profile_equeries()
- get_user_profile_equeries()
reviewboard.site.testing.queries:
- get_local_site_by_name_equeries()
- get_local_site_is_accessible_by_equeries()
- get_local_site_is_mutable_by_equeries()
- get_check_local_site_access_equeries()
reviewboard.testing.queries.http:
- get_http_request_user_equeries()
- get_http_request_start_equeries()

Most of these perform simple checks used at the start of most view
handling. They'll be used for some in-progress test updates, and will
likely be expanded as the equery library grows.

It also introduces a common type for functions that return
Q-expressions: reviewboard.testing.queries.base.ExpectedQResult. This
helps ensure consistent results and typing for these sorts of functions.

Testing Done

In-progress unit tests pass.

Commits

Summary	ID
Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	61b9fea1e81def2ea936758495ece621d0bb61e4

Summary

Add expected query utilities for common tests, accounts and Local Sites.

This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.

61b9fea1e81def2ea936758495ece621d0bb61e4

Issues

Description	From	Last Updated
'django.db.models.Q' imported but unused Column: 1 Error code: F401	reviewbot	Nov. 9, 2023, 2:35 a.m.
Missing documentation for note.	maubin	Dec. 2, 2023, 5:25 p.m.
Missing documentation for note.	maubin	Dec. 2, 2023, 5:25 p.m.
Typo: "uesd" -> "used"	maubin	Dec. 2, 2023, 5:25 p.m.
Copy paste oopsie "Group.objects.accessible()".	maubin	Dec. 2, 2023, 5:26 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/testing/queries.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'django.db.models.Q' imported but unused

Column: 1
Error code: F401
```

Change Summary:


Made reviewboard.testing.queries a parent module.
Moved the HTTP equery helpers into a .http sub-module.
Added a helpful ExpectedQResult type.

Summary:

-	Add expected query utilities for accounts and Local Sites.
+	Add expected query utilities for common tests, accounts and Local Sites.

Description:

		This introduces some new utility functions for generating common
		expected queries:

		`reviewboard.accounts.testing.queries`: `get_user_by_pk_equeries()` `get_user_local_site_profile_equeries()` `get_user_profile_equeries()`
		`reviewboard.site.testing.queries`: `get_local_site_by_name_equeries()` `get_local_site_is_accessible_by_equeries()` `get_local_site_is_mutable_by_equeries()` `get_check_local_site_access_equeries()`
~		`reviewboard.testing.queries`: `get_http_request_user_equeries()` `get_http_request_start_equeries()`
	~	`reviewboard.testing.queries.http`: `get_http_request_user_equeries()` `get_http_request_start_equeries()`

		Most of these perform simple checks used at the start of most view
		handling. They'll be used for some in-progress test updates, and will
		likely be expanded as the equery library grows.
	+
	+	It also introduces a common type for functions that return
	+	Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This
	+	helps ensure consistent results and typing for these sorts of functions.

Commits:

	Summary	ID
	Add expected query utilities for accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows.	0b5dbc21b39cc3c5a9b60041bb828129aeb0fa7a
	Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	2c871643e16d716fee8fd10d59c6656895d9aefa

Diff:

Revision 2 (+868 -6)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/accounts/testing/__init__.py
	reviewboard/accounts/testing/queries.py
	reviewboard/site/testing/__init__.py
	reviewboard/site/testing/queries.py
	reviewboard/testing/queries/__init__.py
	reviewboard/testing/queries/base.py
	reviewboard/testing/queries/http.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Change Summary:


Fixed up get_local_site_is_accessible_by_equeries() and get_local_site_is_mutable_by_equeries() to return the right results for anonymous users.

Commits:

	Summary	ID
	Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	2c871643e16d716fee8fd10d59c6656895d9aefa
	Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	612531ef5833125d19442fdff5e11cb43833d08b

Diff:

Revision 3 (+868 -6)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/accounts/testing/__init__.py
	reviewboard/accounts/testing/queries.py
	reviewboard/site/testing/__init__.py
	reviewboard/site/testing/queries.py
	reviewboard/testing/queries/__init__.py
	reviewboard/testing/queries/base.py
	reviewboard/testing/queries/http.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

reviewboard/accounts/testing/queries.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing documentation for note.
```
reviewboard/site/testing/queries.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing documentation for note.
```
reviewboard/testing/queries/base.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Typo: "uesd" -> "used"
```
reviewboard/testing/queries/http.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Copy paste oopsie "Group.objects.accessible()".
```

Change Summary:


Fixed some doc typos.
Added missing note docs.

Commits:

	Summary	ID
	Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	612531ef5833125d19442fdff5e11cb43833d08b
	Add expected query utilities for common tests, accounts and Local Sites. This introduces some new utility functions for generating common expected queries: * `reviewboard.accounts.testing.queries`: * `get_user_by_pk_equeries()` * `get_user_local_site_profile_equeries()` * `get_user_profile_equeries()` * `reviewboard.site.testing.queries`: * `get_local_site_by_name_equeries()` * `get_local_site_is_accessible_by_equeries()` * `get_local_site_is_mutable_by_equeries()` * `get_check_local_site_access_equeries()` * `reviewboard.testing.queries.http`: * `get_http_request_user_equeries()` * `get_http_request_start_equeries()` Most of these perform simple checks used at the start of most view handling. They'll be used for some in-progress test updates, and will likely be expanded as the equery library grows. It also introduces a common type for functions that return Q-expressions: `reviewboard.testing.queries.base.ExpectedQResult`. This helps ensure consistent results and typing for these sorts of functions.	61b9fea1e81def2ea936758495ece621d0bb61e4

Diff:

Revision 4 (+886 -6)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/accounts/testing/__init__.py
	reviewboard/accounts/testing/queries.py
	reviewboard/site/testing/__init__.py
	reviewboard/site/testing/queries.py
	reviewboard/testing/queries/__init__.py
	reviewboard/testing/queries/base.py
	reviewboard/testing/queries/http.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-5.0.x (e7084f3)