unittest assertEqual difference output foiled by newlines

[cjerdonek]

BPO	24780
Nosy	@tim-one, @loewis, @rbtcollins, @ezio-melotti, @bitdancer, @voidspace, @cjerdonek, @elenaoat, @AnishShah, @tirkarthi, @nanjekyejoannah
PRs	bpo-24780: unittest assertEqual difference output foiled by newlines #11548 bpo-24780: unittest assertEqual difference output foiled by newlines #11548 bpo-24780: unittest assertEqual difference output foiled by newlines #11548
Files	test.py: Test case to reproduce the bug test2.py issue24780.patch fix_24780.patch

^{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 = None
closed_at = None
created_at = <Date 2015-08-02.16:49:29.240>
labels = ['3.7', '3.8', 'type-bug', 'library', 'easy']
title = 'unittest assertEqual difference output foiled by newlines'
updated_at = <Date 2019-01-14.15:30:04.394>
user = 'https://github.com/cjerdonek'

bugs.python.org fields:

activity = <Date 2019-01-14.15:30:04.394>
actor = 'xtreak'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2015-08-02.16:49:29.240>
creator = 'chris.jerdonek'
dependencies = []
files = ['41636', '41639', '41782', '44679']
hgrepos = []
issue_num = 24780
keywords = ['patch', 'easy']
message_count = 14.0
messages = ['247883', '247947', '258132', '258466', '259375', '259403', '261713', '275942', '276633', '333277', '333289', '333295', '333584', '333627']
nosy_count = 13.0
nosy_names = ['tim.peters', 'loewis', 'rbcollins', 'ezio.melotti', 'r.david.murray', 'michael.foord', 'chris.jerdonek', 'Elena.Oat', 'anish.shah', 'pynewbie', 'adchanw', 'xtreak', 'nanjekyejoannah']
pr_nums = ['11548', '11548', '11548']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue24780'
versions = ['Python 2.7', 'Python 3.7', 'Python 3.8']

Linked PRs

• gh-68968: Correcting message display issue with assertEqual #103937

[cjerdonek]

When newlines are present, the error message displayed by unittest's self.assertEqual() to show where strings differ can be nonsensical. For example, the caret symbol can show up in a strange location.

The first example below shows a case where things work correctly. The second shows a newline case with the confusing display.

======================================================================
FAIL: test1
----------------------------------------------------------------------

Traceback (most recent call last):
  File "/Users/chris/***/test.py", line 66, in test1
    self.assertEqual("abc", "abd")
AssertionError: 'abc' != 'abd'
- abc
?   ^
+ abd
?   ^

======================================================================
FAIL: test2
----------------------------------------------------------------------

Traceback (most recent call last):
  File "/Users/chris/***/test.py", line 69, in test2
    self.assertEqual("\nabcx", "\nabdx")
AssertionError: '\nabcx' != '\nabdx'
  
- abcx?   ^
+ abdx?   ^

[bitdancer]

In this particular case the problem is the lack of a trailing newline on the input string. It might be possible to improve the extended display algorithm by making sure there is a new line before the carrot line, but care must be taken to account for the cases where one string ends with newline and the other doesn't. I think this problem only applies to strings that have no trailing newline.

[pynewbie]

There is another case where the error message displayed by self.assertEqual() is weird.

======================================================================
FAIL: test_newline_1 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 9, in test_newline_1
    self.assertEqual("\n abc", "\n abd")
AssertionError: '\n abc' != '\n abd'
  
-  abc?    ^
+  abd?    ^

======================================================================
FAIL: test_newline_2 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 12, in test_newline_2
    self.assertEqual("\nabc", "\nabd")
AssertionError: '\nabc' != '\nabd'
  
- abc+ abd

---

There is a difference in between "\nabc" and "\n abc" and hence the difference between output

[elenaoat]

The issue is not related only to the caret. In fact, as seen in the below output, the issue occurs anytime there's a newline character in the beginning or middle of the string to be compared.

In short, if a newline is present in the string and it's in the beginning or middle, a newline character should be put at the end of the string, too. This will make the output look sensible. If, however, the newline is not present at the end, the output is not really readable (the new line is missing).

As we (me and Manvi B.) understand, the caret appears in the output only when the strings are similar enough, i.e. their similarity ratio is high enough. Otherwise, compare function doesn't show the carets in places of difference. This can also be seen in test case test_trailingnewline_2.

This issue occurs, probably, due to using splitlines method.

FFFFFFFF
======================================================================
FAIL: test_notrailingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 8, in test_notrailingnewline_0
    self.assertEqual("abcDefehiJkl", "abcdefGhijkl")
AssertionError: 'abcDefehiJkl' != 'abcdefGhijkl'
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_notrailingnewline_1 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 14, in test_notrailingnewline_1
    self.assertEqual("a\nbcdf", "a\nbddf")
AssertionError: 'a\nbcdf' != 'a\nbddf'
  a
- bcdf?  ^
+ bddf?  ^

======================================================================
FAIL: test_notrailingnewline_2 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 18, in test_notrailingnewline_2
    self.assertEqual("a\nbcdf", "a\nbddg")
AssertionError: 'a\nbcdf' != 'a\nbddg'
  a
- bcdf+ bddg

======================================================================
FAIL: test_starting_and_ending_newline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 12, in test_starting_and_ending_newline_0
    self.assertEqual("\nabcDefehiJkl\n", "\nabcdefGhijkl\n")
AssertionError: '\nabcDefehiJkl\n' != '\nabcdefGhijkl\n'
  
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_startingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 10, in test_startingnewline_0
    self.assertEqual("\nabcDefehiJkl", "\nabcdefGhijkl")
AssertionError: '\nabcDefehiJkl' != '\nabcdefGhijkl'
  
- abcDefehiJkl?    ^  ^  ^
+ abcdefGhijkl?    ^  ^  ^

======================================================================
FAIL: test_trailingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 6, in test_trailingnewline_0
    self.assertEqual("abcDefehiJkl\n", "abcdefGhijkl\n")
AssertionError: 'abcDefehiJkl\n' != 'abcdefGhijkl\n'
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_trailingnewline_1 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 16, in test_trailingnewline_1
    self.assertEqual("a\nbcdf\n", "a\nbddf\n")
AssertionError: 'a\nbcdf\n' != 'a\nbddf\n'
  a
- bcdf
?  ^
+ bddf
?  ^

======================================================================
FAIL: test_trailingnewline_2 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 20, in test_trailingnewline_2
    self.assertEqual("a\nbcdf\n", "a\nbddg\n")
AssertionError: 'a\nbcdf\n' != 'a\nbddg\n'
  a
- bcdf
+ bddg

---

Ran 8 tests in 0.007s

FAILED (failures=8)

[AnishShah]

I would like to work on this..

[AnishShah]

The problem is in difflib.ndiff function. When the string does not have a trailing newline, we get an unreadable output.
After applying my patch, the following is the output of test2.py (submitted by Elena.Oat).

FFFFFFFF
======================================================================
FAIL: test_notrailingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 8, in test_notrailingnewline_0
    self.assertEqual("abcDefehiJkl", "abcdefGhijkl")
AssertionError: 'abcDefehiJkl' != 'abcdefGhijkl'
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_notrailingnewline_1 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 14, in test_notrailingnewline_1
    self.assertEqual("a\nbcdf", "a\nbddf")
AssertionError: 'a\nbcdf' != 'a\nbddf'
  a
- bcdf
?  ^
+ bddf
?  ^

======================================================================
FAIL: test_notrailingnewline_2 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 18, in test_notrailingnewline_2
    self.assertEqual("a\nbcdf", "a\nbddg")
AssertionError: 'a\nbcdf' != 'a\nbddg'
  a
- bcdf
+ bddg

======================================================================
FAIL: test_starting_and_ending_newline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 12, in test_starting_and_ending_newline_0
    self.assertEqual("\nabcDefehiJkl\n", "\nabcdefGhijkl\n")
AssertionError: '\nabcDefehiJkl\n' != '\nabcdefGhijkl\n'
  
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_startingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 10, in test_startingnewline_0
    self.assertEqual("\nabcDefehiJkl", "\nabcdefGhijkl")
AssertionError: '\nabcDefehiJkl' != '\nabcdefGhijkl'
  
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_trailingnewline_0 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 6, in test_trailingnewline_0
    self.assertEqual("abcDefehiJkl\n", "abcdefGhijkl\n")
AssertionError: 'abcDefehiJkl\n' != 'abcdefGhijkl\n'
- abcDefehiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^

======================================================================
FAIL: test_trailingnewline_1 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 16, in test_trailingnewline_1
    self.assertEqual("a\nbcdf\n", "a\nbddf\n")
AssertionError: 'a\nbcdf\n' != 'a\nbddf\n'
  a
- bcdf
?  ^
+ bddf
?  ^

======================================================================
FAIL: test_trailingnewline_2 (main.AssertEqualTest)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "test.py", line 20, in test_trailingnewline_2
    self.assertEqual("a\nbcdf\n", "a\nbddg\n")
AssertionError: 'a\nbcdf\n' != 'a\nbddg\n'
  a
- bcdf
+ bddg

---

Ran 8 tests in 0.004s

FAILED (failures=8)

[rbtcollins]

Thanks for the patch; reviewed in rietvald.

[adchanw]

Is this still being worked on? I have a potential fix for this.

[adchanw]

I've attached a potential fix for this issue.

While trying to fix this, I noticed that I coudn't assume that I just need to ensure that each line has a newline. If I always ensure each line in diffline has a newline, then the fourth test in testAssertMultilineEqual (in Lib/unittest/test/test_assertions.py) fails because standardMsg in assertMultiLineEqual in Lib/unittest/case.py is just one line without a newline. To sidestep this problem, I made it so that I only ensure there is a newline for each line if and only if there is more than one line in difflines. However, I'm not sure that I can assume there should be a newline in cases similar to the fourth test (where longMessage is set to true and a 'msg' is passed) in testAssertMultilineEqual but where there is more than one line in standardMsg in assertMultiLineEqual.