longMessage attribute is ignored in unittest.TestCase.assertRegexpMatches etc

[Dhara]

BPO	20362
Nosy	@rbtcollins, @ezio-melotti, @voidspace, @wiggin15, @berkerpeksag
Files	issue20362.diff 20362_py27.patch: 2.7 patch 20362_py35.patch: 3.5 patch 20362_py35_v2.patch: 3.5 patch v2

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/berkerpeksag'
closed_at = <Date 2015-08-19.23:24:52.018>
created_at = <Date 2014-01-23.09:39:37.307>
labels = ['easy', 'type-bug', 'library']
title = 'longMessage attribute is ignored in unittest.TestCase.assertRegexpMatches etc'
updated_at = <Date 2015-08-19.23:24:52.016>
user = 'https://bugs.python.org/Dhara'

bugs.python.org fields:

activity = <Date 2015-08-19.23:24:52.016>
actor = 'rbcollins'
assignee = 'berker.peksag'
closed = True
closed_date = <Date 2015-08-19.23:24:52.018>
closer = 'rbcollins'
components = ['Library (Lib)']
creation = <Date 2014-01-23.09:39:37.307>
creator = 'Dhara'
dependencies = []
files = ['35274', '38958', '38960', '40115']
hgrepos = []
issue_num = 20362
keywords = ['patch', 'easy']
message_count = 15.0
messages = ['208899', '218733', '240737', '240740', '240745', '240836', '241635', '242880', '247888', '247920', '247922', '247932', '248422', '248862', '248865']
nosy_count = 9.0
nosy_names = ['bronger', 'rbcollins', 'ezio.melotti', 'michael.foord', 'wiggin15', 'python-dev', 'berker.peksag', 'Dhara', 'copper-head']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue20362'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

[Dhara]

Various assert methods added in version 2.7 ignore the longMessage attribute:
http://docs.python.org/2.7/library/unittest.html#unittest.TestCase.longMessage

For example when matching regular expressions using unittest.TestCase.assertRegexpMatches, the following error is generated:

AssertionError: <custom short message>: '<regexp>' not found in '<text>'

Since longMessage is ignored, and the text to be matched can be pages long, the error messages are impossibly long.

[See also: http://stackoverflow.com/questions/21157905/suppress-supplementary-error-message-from-unit-test]

[berkerpeksag]

I've added missing self._formatMessage() functions to assertRegex and assertNotRegex asserts.

[copper-head]

This fix has been retested with 2.7, I'm uploading the relevant patch files.

[copper-head]

Modified to work with 3.5. Attaching patch file.

[berkerpeksag]

Thanks for the patches, Ilia. The one for 2.7 looks good.

Reviewing 20362_py35.patch:

• Looks almost identical to bpo-20362.diff except style changes and the two comments below, right?

• •        self.assertIn("'kot'", e.args[0])
    

  Why did you remove this line?

• • assertNotRegexpMatches = _deprecate(assertNotRegex)

  This looks like an unrelated change, but I think it can be committed. Thanks for the catch!

• The tests should be updated to use assertRegex and assertNotRegex

[copper-head]

Thanks for the quick response, Berker! Let me address your comments in the order you made them.

#1: removing checking for "kot" in the exception args.
This line was causing the tests to fail, which is how I noticed it. The reason it fails (I think) is caused by the changes made in the patch. Namely, the fact that we're strictly sticking to longMessage=False means the custom message passed by the user (in this particular case that's "Message") is be the *only* thing sent to AssertionError. Thus checking for the presence of "kot" in this error's args doesn't seem to make much sense and will simply keep breaking our tests.
Now it goes without saying that I may have missed something, please let me know if that's the case.

#2
For some reason I got the impression that the tests should be using the newer method names, but since using the old ones didn't break them on my machine, I've updated the patch file accordingly. I'll upload it pending your feedback regarding #1.

Glad to help!
Ilia.

[copper-head]

Hi Berker!

I hope all's well on your end. Let me know if you have questions about the reasoning behind my changes.

[copper-head]

Hi there!

I was wondering if anyone had a chance to take a look at this :)

[copper-head]

I notice folks have been subscribing to this. Any chance we could review it and merge? :)

[wiggin15]

• The removal of the 'kot' test is ok. That's what the fix is about. With longMessage set to False, we should only see the custom message, 'Message', and not the message about the regex that contains 'kot'.
• Please update the patch for 3.5 to use assertRegex and assertNotRegex in the assertMessages call. These are the new names. With the current patch, the tests throw deprecation warnings.

Other than that the patch looks good (I am not a committer, though, so I can't help further).

[berkerpeksag]

Sorry for my late response, Ilia. Your reply to my first question looks correct to me. Please send your updated patch and I'll apply.

[copper-head]

Thanks for the feedback, folks. Adding the updated patch.

[copper-head]

Bump :)

Let's close this one, guys!

[python-dev]

New changeset 738de9a9a3ea by Robert Collins in branch '3.5':
Issue bpo-20362: Honour TestCase.longMessage correctly in assertRegex.
https://hg.python.org/cpython/rev/738de9a9a3ea

New changeset 977e60f597de by Robert Collins in branch 'default':
Issue bpo-20362: Honour TestCase.longMessage correctly in assertRegex.
https://hg.python.org/cpython/rev/977e60f597de

[rbtcollins]

Thanks for the patch, applied to 3.5 and 3.6.