Doc'd writing integration tests for the system check framework. #17406
+66
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcgibbons
force-pushed
the
system-checks-integration-testing
branch
from
5ab09a4
to
b784c04
Compare
marcgibbons
commented
Oct 23, 2023
docs/ref/checks.txt
Outdated
| @@ -894,6 +894,8 @@ fields: | |||
| changed to* ``fields.E010`` *in Django 3.1*. | |||
| * **postgres.W004**: Base field for array has warnings: ... | |||
|
|
|||
| .. _contrib-app-checks-sites: | |||
There was a problem hiding this comment.
Flagging this – wanted to link here, but not sure about the naming.
felixxm
reviewed
Oct 23, 2023
dtleal
approved these changes
Oct 23, 2023
felixxm
changed the title
felixxm
force-pushed
the
system-checks-integration-testing
branch
from
8e13bcd
to
8d9c0e4
Compare
|
@marcgibbons Thanks 👍 I pushed small edits. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From DjangoConUS 2023 sprints 🏃. I didn't create a ticket in the issue tracker for this.
This PR adds additional examples to the system checks framework testing section of the documentation to demonstrate how one can test the integration of a system check within a project.
Non-model field system checks must be registered/imported in
apps.pyor__init__.pyin order to function. Testing check functions directly as unit tests doesn't capture this, whereas usingcall_commanddoes.I added an example of how to assert against checks which raise a
SystemCheckErroras well as one which outputs to stderr, and how to capture the message usingStringIO.Thanks @evildmp for the crash course on Sphinx links 😄