patman: Add some tests for warnings

Add tests that check that warnings are generated when expected.

Signed-off-by: Simon Glass <sjg@chromium.org>

3 files changed, 116 insertions, 13 deletions

diff --git a/tools/patman/func_test.py b/tools/patman/func_test.py
index 2a0da8b3cc..02d46ae5f7 100644
--- a/tools/patman/func_test.py
+++ b/tools/patman/func_test.py
@@ -33,6 +33,9 @@ class TestFunctional(unittest.TestCase):
     """Functional tests for checking that patman behaves correctly"""
     leb = (b'Lord Edmund Blackadd\xc3\xabr <weasel@blackadder.org>'.
            decode('utf-8'))
+    fred = 'Fred Bloggs <f.bloggs@napier.net>'
+    joe = 'Joe Bloggs <joe@napierwallies.co.nz>'
+    mary = 'Mary Bloggs <mary@napierwallies.co.nz>'
 
     def setUp(self):
         self.tmpdir = tempfile.mkdtemp(prefix='patman.')
@@ -180,7 +183,6 @@ class TestFunctional(unittest.TestCase):
         stefan = b'Stefan Br\xc3\xbcns <stefan.bruens@rwth-aachen.de>'.decode('utf-8')
         rick = 'Richard III <richard@palace.gov>'
         mel = b'Lord M\xc3\xablchett <clergy@palace.gov>'.decode('utf-8')
-        fred = 'Fred Bloggs <f.bloggs@napier.net>'
         add_maintainers = [stefan, rick]
         dry_run = True
         in_reply_to = mel
@@ -189,7 +191,7 @@ class TestFunctional(unittest.TestCase):
             'fdt': ['simon'],
             'u-boot': ['u-boot@lists.denx.de'],
             'simon': [self.leb],
-            'fred': [fred],
+            'fred': [self.fred],
         }
 
         text = self._get_text('test01.txt')
@@ -231,7 +233,7 @@ class TestFunctional(unittest.TestCase):
         self.assertEqual('Prefix:\t  RFC', lines[line + 3])
         self.assertEqual('Cover: 4 lines', lines[line + 4])
         line += 5
-        self.assertEqual('      Cc:  %s' % fred, lines[line + 0])
+        self.assertEqual('      Cc:  %s' % self.fred, lines[line + 0])
         self.assertEqual('      Cc:  %s' % tools.FromUnicode(self.leb),
                          lines[line + 1])
         self.assertEqual('      Cc:  %s' % tools.FromUnicode(mel),
@@ -248,7 +250,7 @@ class TestFunctional(unittest.TestCase):
         self.assertEqual(('%s %s\0%s' % (args[0], rick, stefan)),
                          tools.ToUnicode(cc_lines[0]))
         self.assertEqual(
-            '%s %s\0%s\0%s\0%s' % (args[1], fred, self.leb, rick, stefan),
+            '%s %s\0%s\0%s\0%s' % (args[1], self.fred, self.leb, rick, stefan),
             tools.ToUnicode(cc_lines[1]))
 
         expected = '''
@@ -487,12 +489,103 @@ complicated as possible''')
         text = '''This is a patch
 
 Signed-off-by: Terminator
-Reviewed-by: Joe Bloggs <joe@napierwallies.co.nz>
-Reviewed-by: Mary Bloggs <mary@napierwallies.co.nz>
+Reviewed-by: %s
+Reviewed-by: %s
 Tested-by: %s
-''' % self.leb
+''' % (self.joe, self.mary, self.leb)
         pstrm = PatchStream.process_text(text)
         self.assertEqual(pstrm.commit.rtags, {
-            'Reviewed-by': {'Mary Bloggs <mary@napierwallies.co.nz>',
-                            'Joe Bloggs <joe@napierwallies.co.nz>'},
+            'Reviewed-by': {self.joe, self.mary},
             'Tested-by': {self.leb}})
+
+    def testMissingEnd(self):
+        """Test a missing END tag"""
+        text = '''This is a patch
+
+Cover-letter:
+This is the title
+missing END after this line
+Signed-off-by: Fred
+'''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Missing 'END' in section 'cover'"],
+                         pstrm.commit.warn)
+
+    def testMissingBlankLine(self):
+        """Test a missing blank line after a tag"""
+        text = '''This is a patch
+
+Series-changes: 2
+- First line of changes
+- Missing blank line after this line
+Signed-off-by: Fred
+'''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Missing 'blank line' in section 'Series-changes'"],
+                         pstrm.commit.warn)
+
+    def testInvalidCommitTag(self):
+        """Test an invalid Commit-xxx tag"""
+        text = '''This is a patch
+
+Commit-fred: testing
+'''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Line 3: Ignoring Commit-fred"], pstrm.commit.warn)
+
+    def testSelfTest(self):
+        """Test a tested by tag by this user"""
+        test_line = 'Tested-by: %s@napier.com' % os.getenv('USER')
+        text = '''This is a patch
+
+%s
+''' % test_line
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Ignoring '%s'" % test_line], pstrm.commit.warn)
+
+    def testSpaceBeforeTab(self):
+        """Test a space before a tab"""
+        text = '''This is a patch
+
++ \tSomething
+'''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Line 3/0 has space before tab"], pstrm.commit.warn)
+
+    def testLinesAfterTest(self):
+        """Test detecting lines after TEST= line"""
+        text = '''This is a patch
+
+TEST=sometest
+more lines
+here
+'''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(["Found 2 lines after TEST="], pstrm.commit.warn)
+
+    def testBlankLineAtEnd(self):
+        """Test detecting a blank line at the end of a file"""
+        text = '''This is a patch
+
+diff --git a/lib/fdtdec.c b/lib/fdtdec.c
+index c072e54..942244f 100644
+--- a/lib/fdtdec.c
++++ b/lib/fdtdec.c
+@@ -1200,7 +1200,8 @@ int fdtdec_setup_mem_size_base(void)
+ 	}
+
+ 	gd->ram_size = (phys_size_t)(res.end - res.start + 1);
+-	debug("%s: Initial DRAM size %llx\n", __func__, (u64)gd->ram_size);
++	debug("%s: Initial DRAM size %llx\n", __func__,
++	      (unsigned long long)gd->ram_size);
++
+diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c
+
+--
+2.7.4
+
+ '''
+        pstrm = PatchStream.process_text(text)
+        self.assertEqual(
+            ["Found possible blank line(s) at end of file 'lib/fdtdec.c'"],
+            pstrm.commit.warn)
diff --git a/tools/patman/main.py b/tools/patman/main.py
index b96000807e..d1a43c44fc 100755
--- a/tools/patman/main.py
+++ b/tools/patman/main.py
@@ -86,6 +86,8 @@ AddCommonArgs(send)
 send.add_argument('patchfiles', nargs='*')
 
 test_parser = subparsers.add_parser('test', help='Run tests')
+test_parser.add_argument('testname', type=str, default=None, nargs='?',
+                         help="Specify the test to run")
 AddCommonArgs(test_parser)
 
 # Parse options twice: first to get the project and second to handle
@@ -111,15 +113,23 @@ if args.cmd == 'test':
 
     sys.argv = [sys.argv[0]]
     result = unittest.TestResult()
+    suite = unittest.TestSuite()
+    loader = unittest.TestLoader()
     for module in (test_checkpatch.TestPatch, func_test.TestFunctional):
-        suite = unittest.TestLoader().loadTestsFromTestCase(module)
-        suite.run(result)
+        if args.testname:
+            try:
+                suite.addTests(loader.loadTestsFromName(args.testname, module))
+            except AttributeError:
+                continue
+        else:
+            suite.addTests(loader.loadTestsFromTestCase(module))
+    suite.run(result)
 
     for module in ['gitutil', 'settings', 'terminal']:
         suite = doctest.DocTestSuite(module)
         suite.run(result)
 
-    sys.exit(test_util.ReportResult('patman', None, result))
+    sys.exit(test_util.ReportResult('patman', args.testname, result))
 
 # Process commits, produce patches files, check them, email them
 elif args.cmd == 'send':
diff --git a/tools/patman/patchstream.py b/tools/patman/patchstream.py
index d6f6ae9251..1cb4d6ed0d 100644
--- a/tools/patman/patchstream.py
+++ b/tools/patman/patchstream.py
@@ -419,7 +419,7 @@ class PatchStream:
             # Remove Tested-by self, since few will take much notice
             if (rtag_type == 'Tested-by' and
                     who.find(os.getenv('USER') + '@') != -1):
-                self._add_warn("Ignoring %s" % line)
+                self._add_warn("Ignoring '%s'" % line)
             elif rtag_type == 'Patch-cc':
                 self.commit.AddCc(who.split(','))
             else: