Phpunit: assertEquals() Line Ending Differences Are Obscure

Created on 15 Feb 2012 · 5Comments · Source: sebastianbergmann/phpunit

When using assertEquals("Windows EOL", "Unix EOL") with multi-line text, assertEquals() properly displays a failure, but does not show why in the difference report.

1) Namespace\ClassName::testCreateResponse
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
 Parameter: parameter value
 Context: context value
 URL: http://localhost/test?key=value

/path/to/test/file.php:55

Source

ghost

Most helpful comment

As a die-hard windows user, thank you :)

jmauerhan on 24 Oct 2016

😄2

All 5 comments

The best I could come up with for this is:

diff --git a/PHPUnit/Util/Diff.php b/PHPUnit/Util/Diff.php
index f9040bf..df09fde 100644
--- a/PHPUnit/Util/Diff.php
+++ b/PHPUnit/Util/Diff.php
@@ -148,6 +148,9 @@ class PHPUnit_Util_Diff
      */
     public static function diffToArray($from, $to)
     {
+        preg_match_all('(\r\n|\r|\n)', $from, $fromMatches);
+        preg_match_all('(\r\n|\r|\n)', $to, $toMatches);
+
         if (is_string($from)) {
             $from = preg_split('(\r\n|\r|\n)', $from);
         }
@@ -189,6 +192,14 @@ class PHPUnit_Util_Diff
         $diff = array();
         $line = 0;

+        if(isset($fromMatches[0]) 
+            && $toMatches[0] 
+            && count($fromMatches[0]) === count($toMatches[0]) 
+            && $fromMatches[0] !== $toMatches[0]
+        ) {
+            $diff[] = array('#Warning: Strings contain different line endings!', 0);
+        }
+
         foreach ($start as $token) {
             $diff[] = array($token, 0 /* OLD */);
         }

It would produce:

1) Issue503Test::testCompareDifferentLineEnding
Failed asserting that two strings are identical.
--- Expected
+++ Actual
@@ @@
 #Warning: Strings contain different line endings!
 foo

Is that good enough for you @kherge?

Do you like it @sebastianbergmann ? I couldn't come up with nicer reporting without rewriting more than half of the diff algo (and possibly breaking lots of things).

This now only produces the Warning if the number of lines is the same so "Foo\n" vs "Bar\r\n\r\n\r\n" still gets reported properly without that warning.