git cl description: avoid appending BUG= after Change-Id.

tests/git_cl_test.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Unit tests for git_cl.py."""
 
 import os
 import StringIO
 import stat
@@ skipping 1004 matching lines @@
         ((['git', 'var', 'GIT_AUTHOR_IDENT'], ),
           'A B <a@b.org> 1456848326 +0100'),
         ((['git', 'var', 'GIT_COMMITTER_IDENT'], ),
           'C D <c@d.org> 1456858326 +0100'),
         ((['git', 'hash-object', '-t', 'commit', '--stdin'], ),
           'hashchange'),
     ]
     change_id = git_cl.GenerateGerritChangeId('line1\nline2\n')
     self.assertEqual(change_id, 'Ihashchange')
 
+  def test_desecription_append_footer(self):
+    for init_desc, footer_line, expected_desc in [
+      # Use unique desc first lines for easy test failure identification.
+      ('foo', 'R=one', 'foo\n\nR=one'),
+      ('foo\n\nR=one', 'BUG=', 'foo\n\nR=one\nBUG='),
+      ('foo\n\nR=one', 'Change-Id: Ixx', 'foo\n\nR=one\n\nChange-Id: Ixx'),
+      ('foo\n\nChange-Id: Ixx', 'R=one', 'foo\n\nR=one\n\nChange-Id: Ixx'),

[Sergiy Byelozyorov, 2016/06/02 22:59:53]

Also test adding a new footer to an existing one (first 3 tests) and adding
Gerrit footer to simple description (last test):

('foo\n\nR=one\n\nChange-Id: Ixx', 'TBR=two',
'foo\n\nR=one\nTBR=two\n\nChange-Id: Ixx'),
('foo\n\nR=one\n\nChange-Id: Ixx', 'Foo-Bar: baz', 'foo\n\nR=one\n\nChange-Id:
Ixx\nFoo-Bar: baz'),
('foo\n\nChange-Id: Ixx', 'Foo-Bar: baz', 'foo\n\nChange-Id: Ixx\nFoo-Bar:
baz'),
('foo', 'Change-Id: Ixx', 'foo\n\nChange-Id: Ixx'),

[tandrii(chromium), 2016/06/03 09:34:59]

Done.

+    ]:
+      desc = git_cl.ChangeDescription(init_desc)
+      desc.append_footer(footer_line)
+      self.assertEqual(desc.description, expected_desc)
+
   def test_update_reviewers(self):
     data = [
       ('foo', [], 'foo'),
       ('foo\nR=xx', [], 'foo\nR=xx'),
       ('foo\nTBR=xx', [], 'foo\nTBR=xx'),
       ('foo', ['a@c'], 'foo\n\nR=a@c'),
       ('foo\nR=xx', ['a@c'], 'foo\n\nR=a@c, xx'),
       ('foo\nTBR=xx', ['a@c'], 'foo\n\nR=a@c\nTBR=xx'),
       ('foo\nTBR=xx\nR=yy', ['a@c'], 'foo\n\nR=a@c, yy\nTBR=xx'),
       ('foo\nBUG=', ['a@c'], 'foo\nBUG=\nR=a@c'),
@@ skipping 402 matching lines @@
     out = StringIO.StringIO()
     self.mock(git_cl.sys, 'stdout', out)
 
     self.mock(git_cl, 'Changelist', ChangelistMock)
     self.mock(git_cl.sys, 'stdin', StringIO.StringIO('hihi'))
 
     self.assertEqual(0, git_cl.main(['description', '-n', 'hihi']))
     self.assertEqual('hihi', ChangelistMock.desc)
 
   def test_description_appends_bug_line(self):
-    current_desc = 'Some\n\nChange-Id: xxx'
+    current_desc = 'Some.\n\nChange-Id: xxx'
 
     def RunEditor(desc, _, **kwargs):
       self.assertEquals(
           '# Enter a description of the change.\n'
           '# This will be displayed on the codereview site.\n'
           '# The first line will also be used as the subject of the review.\n'
           '#--------------------This line is 72 characters long'
-          '--------------------\n' +
-          # TODO(tandrii): fix this http://crbug.com/614587.
-          current_desc + '\n\nBUG=',
+          '--------------------\n'
+          'Some.\n\nBUG=\n\nChange-Id: xxx',
           desc)
-      return current_desc + '\n\nBUG='
+      # Simulate user changing something.
+      return 'Some.\n\nBUG=123\n\nChange-Id: xxx'
 
     def UpdateDescriptionRemote(_, desc):
-      # TODO(tandrii): fix this http://crbug.com/614587.
-      self.assertEquals(desc, current_desc + '\n\nBUG=')
+      self.assertEquals(desc, 'Some.\n\nBUG=123\n\nChange-Id: xxx')
 
     self.mock(git_cl.sys, 'stdout', StringIO.StringIO())
     self.mock(git_cl.Changelist, 'GetDescription',
               lambda *args: current_desc)
     self.mock(git_cl._GerritChangelistImpl, 'UpdateDescriptionRemote',
               UpdateDescriptionRemote)
     self.mock(git_cl.gclient_utils, 'RunEditor', RunEditor)
 
     self.calls = [
         ((['git', 'symbolic-ref', 'HEAD'],), 'feature'),
@@ skipping 30 matching lines @@
         ((['git', 'config', '--unset', 'branch.feature.gerritsquashhash'],),
          ''),
     ]
     self.assertEqual(0, git_cl.main(['issue', '0']))
 
 
 if __name__ == '__main__':
   git_cl.logging.basicConfig(
       level=git_cl.logging.DEBUG if '-v' in sys.argv else git_cl.logging.ERROR)
   unittest.main()