Print expected/actual file contents on mismatch

Author: matyasselmeci

osgtest/library/osgunittest.py

@@ -12,6 +12,19 @@
 import unittest
 import time
 
+
+# Copied from unittest.util, Python 3.6
+_MAX_LENGTH = 80
+def safe_repr(obj, short=False):
+    try:
+        result = repr(obj)
+    except Exception:
+        result = object.__repr__(obj)
+    if not short or len(result) < _MAX_LENGTH:
+        return result
+    return result[:_MAX_LENGTH] + ' [truncated]...'
+
+
 # Define the classes we need to handle the two new types of test results: ok
 # skip, and bad skip.
 
@@ -111,6 +124,14 @@ def failIfSubsetOf(self, a, b, message=None):
         if set(a).issubset(set(b)):
             raise AssertionError(message)
 
+    def assertEqualVerbose(self, actual, expected, message=None):
+        aftermessage = "actual %s != expected %s" % (safe_repr(actual), safe_repr(expected))
+        if message:
+            fullmessage = "%s (%s)" % (message, aftermessage)
+        else:
+            fullmessage = aftermessage
+        self.assertEqual(actual, expected, fullmessage)
+
     # This is mostly a copy of the method from unittest in python 2.4.
     # There is some code here to test if the 'result' object accepts 'skips',
     # since the original TestResult object does not. If it does not, an

osgtest/tests/test_460_stashcache.py

@@ -33,8 +33,9 @@ def assertCached(self, name, contents):
         fpath = os.path.join(_getcfg("cache_dir"), name)
         self.assertTrue(os.path.exists(fpath),
                         name + " not cached")
-        self.assertEqual(contents, files.read(fpath, as_single_string=True),
-                         "cached file %s contents do not match expected" % name)
+        self.assertEqualVerbose(actual=files.read(fpath, as_single_string=True),
+                                expected=contents,
+                                message="cached file %s mismatch" % name)
 
     def skip_bad_unless_running(self, *services):
         for svc in services:
@@ -58,7 +59,7 @@ def test_02_xroot_fetch_from_origin(self):
             core.check_system(["xrdcp", "-d1", "-N", "-f",
                                "root://localhost:%d//%s" % (_getcfg("origin_xroot_port"), name),
                                "-"], "Checking xroot copy from origin")
-        self.assertEqual(result, contents, "downloaded file does not match expected")
+        self.assertEqualVerbose(result, contents, "downloaded file mismatch")
 
     def test_03_http_fetch_from_cache(self):
         name, contents = self.testfiles[1]
@@ -69,7 +70,7 @@ def test_03_http_fetch_from_cache(self):
             result = f.read()
         except IOError as e:
             self.fail("Unable to download from cache via http: %s" % e)
-        self.assertEqual(result, contents, "downloaded file does not match expected")
+        self.assertEqualVerbose(result, contents, "downloaded file mismatch")
         self.assertCached(name, contents)
 
     def test_04_xroot_fetch_from_cache(self):
@@ -78,7 +79,7 @@ def test_04_xroot_fetch_from_cache(self):
             core.check_system(["xrdcp", "-d1", "-N", "-f",
                                "root://localhost:%d//%s" % (_getcfg("cache_xroot_port"), name),
                                "-"], "Checking xroot copy from cache")
-        self.assertEqual(result, contents, "downloaded file does not match expected")
+        self.assertEqualVerbose(result, contents, "downloaded file mismatch")
         self.assertCached(name, contents)
 
     def test_05_stashcp(self):
@@ -90,5 +91,5 @@ def test_05_stashcp(self):
             core.check_system(command + ["/"+name, tf.name],
                               "Checking stashcp")
             result = tf.read()
-        self.assertEqual(result, contents, "stashcp'ed file does match expected")
+        self.assertEqualVerbose(result, contents, "stashcp'ed file mismatch")
         self.assertCached(name, contents)