Skip to content

Refs #35728 -- Added standard failure prefixes to assertion message tests. #19588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Refs #35728 -- Added standard failure prefixes to assertion message tests. #19588

wants to merge 3 commits into from
+182 −154

Conversation

cliff688
Copy link
Member

@cliff688 cliff688 commented Jun 24, 2025 •
edited
Loading

Trac ticket number

Two additional commits I added while working on this:

  1. Splitting monolithic test_contains() test into smaller focused tests (10+)
  2. Adding missing tests for assertRedirects when following redirect chains.

ticket-35728

cliff688 added 3 commits June 24, 2025 21:44
@cliff688
Refs #35728 -- Refactored AssertContainsTests into focused methods us…
9ce6419 
…ing assertRaisesMessage.

Also added standard unittest-inherited prefixes (e.g. "1 != 2 : ") to expected
error messages.

Refs #36280.
@cliff688
Refs #35728 -- Added standard failure prefixes to assertion message t…
ec85778 
…ests.
@cliff688
Refs django#4476 -- Added tests for assertRedirects assertions when f…
3acf052 
…ollowing redirect chains.
cliff688
cliff688 commented Jun 24, 2025
View reviewed changes
tests/test_client_regress/tests.py
"(expected 302)",
str(e),

def test_followed_redirect_unexpected_initial_status_code(self):
Copy link
Member Author

@cliff688 cliff688 Jun 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could remove the assertions:

django/django/test/testcases.py

Lines 428 to 437 in b2407e4

self.assertEqual(
response.redirect_chain[0][1],
status_code,
msg_prefix
+ (
"Initial response didn't redirect as expected: Response code was "
"%d (expected %d)"
)
% (response.redirect_chain[0][1], status_code),
)
and

django/django/test/testcases.py

Lines 441 to 450 in b2407e4

self.assertEqual(
response.status_code,
target_status_code,
msg_prefix
+ (
"Response didn't redirect as expected: Final Response code was %d "
"(expected %d)"
)
% (response.status_code, target_status_code),
)
without any test failures.

@cliff688 cliff688 mentioned this pull request Jun 24, 2025
Open
6 tasks
@cliff688 cliff688 marked this pull request as draft June 27, 2025 18:41
@cliff688
Copy link
Member Author

Marking as draft as the unittest assertion messages may be dropped pending discussion in #19402 (review).

As it currently stands, here are the reasons why we may not need to keep (or test) the message prefixes from unittest:

  1. There's no compelling reason to keep the messages as is, since, as Sarah points out, in the linked review) it is unlikely that anyone depends on these messages, and as Simon pointed out, we don't offer any strong guarantees that error messages will remain the same.
  2. Preserving the message prefixes when using self.fail() adds a bit of boilerplate to the assertion messages.
    (3. TIL testing error message too closely may be brittle.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cliff688