Refactor git_footers for later use in git cl.

tests/git_footers_test.py

 #!/usr/bin/env python
 
 """Tests for git_footers."""
 
 import os
 import StringIO
 import sys
 import unittest
 
 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
@@ skipping 17 matching lines @@
   _git_svn_id = ('svn://svn.chromium.org/chrome/trunk/src@290386'
                  ' 0039d316-1c4b-4281-b951-d872f2087c98')
 
   _git_svn_id_footer = 'git-svn-id: %s\n' % _git_svn_id
 
   _git_svn_id_branch = (
       'svn://svn.chromium.org/chrome/branches/blabble/src@177288')
 
   _git_svn_id_footer_branch = 'git-svn-id: %s\n' % _git_svn_id_branch
 
+  def testFootersBasic(self):
+    self.assertEqual(
+        git_footers.split_footers('Not-A: footer'),
+        (['Not-A: footer'], [], []))
+    self.assertEqual(
+        git_footers.split_footers('Header\n\nActual: footer'),
+        (['Header', ''], ['Actual: footer'], [('Actual', 'footer')]))

[Sergiy Byelozyorov, 2016/06/02 23:16:27]

also add

self.assertEqual(git_footers.split_footers('\nActual: footer'), ([''], ['Actual:
footer'], [('Actual', 'footer')]))

[tandrii(chromium), 2016/06/03 09:16:17]

good idea.

 
-  def testFootersBasic(self):
     self.assertEqual(
         git_footers.parse_footers(self._message), {})
     self.assertEqual(
         git_footers.parse_footers(self._message + self._position_footer),
         { 'Cr-Commit-Position': [ self._position ] })
     self.assertEqual(
         git_footers.parse_footers(self._message + self._git_svn_id_footer),
         { 'Git-Svn-Id': [ self._git_svn_id ] })
     self.assertEqual(
         git_footers.parse_footers(self._message + self._position_footer
@@ skipping 25 matching lines @@
                      'Change-Id: ignored',
                      '',  # Above is ignored because of this empty line.
                      'Change-Id: Ideadbeaf'])
     self.assertEqual(['Ideadbeaf'], git_footers.get_footer_change_id(msg))
     self.assertEqual([], git_footers.get_footer_change_id(
         'desc\nBUG=not-a-valid-footer\nChange-Id: Ixxx'))
     self.assertEqual(['Ixxx'], git_footers.get_footer_change_id(
         'desc\nBUG=not-a-valid-footer\n\nChange-Id: Ixxx'))
 
   def testAddFooterChangeId(self):
+    with self.assertRaises(AssertionError):
+      git_footers.add_footer_change_id('Already has\n\nChange-Id: Ixxx', 'Izzz')
+
     self.assertEqual(
         git_footers.add_footer_change_id('header-only', 'Ixxx'),
         'header-only\n\nChange-Id: Ixxx')
 
     self.assertEqual(
         git_footers.add_footer_change_id('header\n\nsome: footter', 'Ixxx'),
         'header\n\nChange-Id: Ixxx\nsome: footter')
 
     self.assertEqual(
         git_footers.add_footer_change_id('header\n\nBUG: yy', 'Ixxx'),
         'header\n\nBUG: yy\nChange-Id: Ixxx')
 
     self.assertEqual(
         git_footers.add_footer_change_id('header\n\nBUG: yy\nPos: 1', 'Ixxx'),
         'header\n\nBUG: yy\nChange-Id: Ixxx\nPos: 1')
 
     self.assertEqual(
         git_footers.add_footer_change_id('header\n\nBUG: yy\n\nPos: 1', 'Ixxx'),
         'header\n\nBUG: yy\n\nChange-Id: Ixxx\nPos: 1')
 
     # Special case: first line is never a footer, even if it looks line one.
     self.assertEqual(
         git_footers.add_footer_change_id('header: like footer', 'Ixxx'),
         'header: like footer\n\nChange-Id: Ixxx')
 
+  def testAddFooter(self):
+    self.assertEqual(
+        git_footers.add_footer('', 'Key', 'Value'),
+        '\n\nKey: Value')
+    self.assertEqual(
+        git_footers.add_footer('Top\n\nSome: footer', 'Key', 'value'),
+        'Top\n\nSome: footer\nKey: value')
+    self.assertEqual(
+        git_footers.add_footer('Top\n\nSome: footer', 'Key', 'value',
+                               after_keys=['Any']),
+        'Top\n\nKey: value\nSome: footer')
+    self.assertEqual(
+        git_footers.add_footer('Top\n\nSome: footer', 'Key', 'value',
+                               after_keys=['Some']),
+        'Top\n\nSome: footer\nKey: value')

[Sergiy Byelozyorov, 2016/06/02 23:16:27]

I would also add a test when the footer must be added somewhere in the middle,
e.g.

     self.assertEqual(
         git_footers.add_footer('Top\n\nSome: footer\nOther: footer',
                                'Key', 'value', after_keys=['Some']),
         'Top\n\nSome: footer\nKey: value\nOther: footer')

[tandrii(chromium), 2016/06/03 09:16:17]

excellent!

+
   def testReadStdin(self):
     self.mock(git_footers.sys, 'stdin', StringIO.StringIO(
         'line\r\notherline\r\n\r\n\r\nFoo: baz'))
 
     stdout = StringIO.StringIO()
     self.mock(git_footers.sys, 'stdout', stdout)
 
     self.assertEqual(git_footers.main([]), 0)
     self.assertEqual(stdout.getvalue(), "Foo: baz\n")
 
 
 
 if __name__ == '__main__':
   unittest.main()