Merge lp:~jamestait/u1-test-utils/pep8-report-summary into lp:u1-test-utils

[James Tait]

Summarise code format errors in the failure message.

Add a UnitTestReport that collates PEP8 format warnings and reports them
in the failure message, for easy readability at the end of the test run,
rather than having to scroll back through all the test output.

[Leo Arias (elopio)]

Thank you! Looks good.

review: Approve (code review)

=== modified file 'u1testutils/static/test_pep8_conformance.py'
--- u1testutils/static/test_pep8_conformance.py	2013-08-08 16:32:44 +0000
+++ u1testutils/static/test_pep8_conformance.py	2013-10-25 12:41:07 +0000
@@ -20,6 +20,24 @@
 from collections import defaultdict
 
 
+class UnitTestReport(pep8.BaseReport):
+    def __init__(self, options):
+        super(UnitTestReport, self).__init__(options)
+        self._fmt = pep8.REPORT_FORMAT.get(options.format.lower(),
+                                           options.format)
+        self._msgs = []
+
+    def error(self, line_number, offset, text, check):
+        """Report an error, according to options."""
+        super(UnitTestReport, self).error(line_number, offset,
+                                          text, check)
+        self._msgs.append(self._fmt % {
+            'path': self.filename,
+            'row': self.line_offset + line_number, 'col': offset + 1,
+            'code': text[:4], 'text': text[5:],
+        })
+
+
 class Pep8ConformanceTestCase(unittest.TestCase):
 
     packages = []
@@ -43,10 +61,12 @@
             testsuite='',
             verbose=0
         )
+        self.report = self.pep8style.init_report(UnitTestReport)
 
     def test_pep8_conformance(self):
         self.assertNotEqual([], self.packages,
                             'You should define some packages to check')
         for package in self.packages:
             self.pep8style.input_dir(os.path.dirname(package.__file__))
-        self.assertEqual(self.pep8style.options.report.total_errors, 0)
+        self.assertEqual(self.pep8style.options.report.total_errors, 0,
+                         '\n'.join(self.report._msgs))