Reapply r193525 "Make gcl use git_cl.py code for consistency in the CL description formatting."

depot_tools/tests/gcl_unittest.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 gcl.py."""
 
 # pylint: disable=E1103,E1101,E1120
 
 import os
@@ skipping 35 matching lines @@
     change_info.issue = 1
     change_info.patchset = 0
     change_info.description = 'deescription'
     change_info.files = files
     change_info.GetFiles = lambda : change_info.files
     change_info.GetIssueDescription = lambda : change_info.description
     change_info.GetFileNames = lambda : [f[1] for f in change_info.files]
     change_info.GetLocalRoot = lambda : 'proout'
     change_info.patch = None
     change_info.rietveld = 'https://my_server'
-    change_info.reviewers = None
     change_info._closed = False
     change_info._deleted = False
     change_info._comments_added = []
 
     class RpcServer(object):
       # pylint: disable=R0201,W0613
       def get_issue_properties(self, issue, messages):
         return { 'patchsets': [1337] }
     change_info.RpcServer = RpcServer
 
@@ skipping 28 matching lines @@
         'CMDopened', 'CMDpassthru', 'CMDpresubmit', 'CMDrename', 'CMDsettings',
         'CMDstatus', 'CMDtry', 'CMDupload',
         'ChangeInfo', 'Command', 'DEFAULT_LINT_IGNORE_REGEX',
         'DEFAULT_LINT_REGEX', 'CheckHomeForFile', 'DoPresubmitChecks',
         'ErrorExit', 'FILES_CACHE', 'FilterFlag', 'GenUsage',
         'GenerateChangeName', 'GenerateDiff', 'GetCLs', 'GetCacheDir',
         'GetCachedFile', 'GetChangelistInfoFile', 'GetChangesDir',
         'GetCodeReviewSetting', 'GetFilesNotInCL', 'GetInfoDir',
         'GetModifiedFiles', 'GetRepositoryRoot', 'ListFiles',
         'LoadChangelistInfoForMultiple', 'MISSING_TEST_MSG',
-        'OptionallyDoPresubmitChecks', 'REPOSITORY_ROOT', 'REVIEWERS_REGEX',
+        'OptionallyDoPresubmitChecks', 'REPOSITORY_ROOT',
         'RunShell', 'RunShellWithReturnCode', 'SVN',
         'TryChange', 'UnknownFiles', 'Warn',
         'attrs', 'breakpad', 'defer_attributes', 'fix_encoding',
-        'gclient_utils', 'json', 'main', 'need_change', 'need_change_and_args',
-        'no_args', 'optparse', 'os', 'presubmit_support', 'random', 're',
-        'rietveld',
+        'gclient_utils', 'git_cl', 'json', 'main', 'need_change',
+        'need_change_and_args', 'no_args', 'optparse', 'os',
+        'presubmit_support', 'random', 're', 'rietveld',
         'string', 'subprocess2', 'sys', 'tempfile', 'time',
         'upload', 'urllib2',
     ]
     # If this test fails, you should add the relevant test.
     self.compareMembers(gcl, members)
 
   def testIsSVNMoved(self):
     # TODO(maruel): TEST ME
     pass
 
@@ skipping 68 matching lines @@
     self.mox.StubOutWithMock(gcl, 'GetRepositoryRoot')
 
   def testChangeInfoMembers(self):
     self.mox.ReplayAll()
     members = [
       'AddComment', 'CloseIssue', 'Delete', 'Exists', 'GetFiles',
       'GetFileNames', 'GetLocalRoot', 'GetIssueDescription', 'Load',
       'MissingTests', 'NeedsUpload', 'PrimeLint', 'RpcServer', 'Save',
       'SendToRietveld',
       'SEPARATOR',
-      'UpdateRietveldDescription',
-      'description', 'issue', 'name',
-      'needs_upload', 'patch', 'patchset', 'reviewers', 'rietveld',
+      'UpdateDescriptionFromIssue', 'UpdateRietveldDescription',
+      'append_footer',
+      'description', 'force_description', 'get_reviewers', 'issue', 'name',
+      'needs_upload', 'patch', 'patchset', 'rietveld',
     ]
     # If this test fails, you should add the relevant test.
     self.compareMembers(
         gcl.ChangeInfo('', 0, 0, '', None, self.fake_root_dir, 'foo', False),
         members)
 
   def testChangeInfoBase(self):
     files = [('M', 'foo'), ('A', 'bar')]
     self.mox.ReplayAll()
     o = gcl.ChangeInfo(
@@ skipping 102 matching lines @@
     change_info.files = [('A', 'aa'), ('M', 'bb')]
     change_info.patch = None
     change_info.rietveld = 'https://my_server'
     files = [item[1] for item in change_info.files]
     output = presubmit_support.PresubmitOutput()
     gcl.DoPresubmitChecks(change_info, False, True).AndReturn(output)
     #gcl.GetCodeReviewSetting('CODE_REVIEW_SERVER').AndReturn('my_server')
     gcl.os.getcwd().AndReturn('somewhere')
     change_info.GetFiles().AndReturn(change_info.files)
     gcl.os.chdir('proout')
+    change_info.get_reviewers().AndReturn('foo@bar.com')
     change_info.GetFileNames().AndReturn(files)
     gcl.GenerateDiff(files)
     gcl.upload.RealMain(['upload.py', '-y', '--server=https://my_server',
                          '-r', 'georges@example.com',
                          '--issue=1', '--title= '],
                          change_info.patch).AndReturn(("1",
                                                                     "2"))
     change_info.GetLocalRoot().AndReturn('proout')
     change_info.Save()
     change_info.PrimeLint()
@@ skipping 114 matching lines @@
 
   def testReviewersInDescription(self):
     change_info = self.mox.CreateMock(gcl.ChangeInfo)
     change_info.name = 'naame'
     change_info.issue = 1
     change_info.patchset = 0
     change_info.description = 'deescription\n\nR=georges@example.com',
     change_info.files = [('A', 'aa'), ('M', 'bb')]
     change_info.patch = None
     change_info.rietveld = 'https://my_server'
-    change_info.reviewers = ['georges@example.com']
     files = [item[1] for item in change_info.files]
     output = presubmit_support.PresubmitOutput()
     gcl.DoPresubmitChecks(change_info, False, True).AndReturn(output)
     #gcl.GetCodeReviewSetting('CODE_REVIEW_SERVER').AndReturn('my_server')
     gcl.os.getcwd().AndReturn('somewhere')
     change_info.GetFiles().AndReturn(change_info.files)
+    change_info.get_reviewers().AndReturn(['georges@example.com'])
     change_info.GetFileNames().AndReturn(files)
     change_info.GetLocalRoot().AndReturn('proout')
     gcl.os.chdir('proout')
     gcl.GenerateDiff(files)
     gcl.upload.RealMain(['upload.py', '-y', '--server=https://my_server',
                          '--reviewers=georges@example.com',
                          '--issue=1', '--title= '],
                          change_info.patch).AndReturn(("1", "2"))
     change_info.Save()
     change_info.PrimeLint()
@@ skipping 17 matching lines @@
     output.reviewers = ['foo@example.com', 'bar@example.com']
     gcl.DoPresubmitChecks(change_info, False, True).AndReturn(output)
     #gcl.GetCodeReviewSetting('CODE_REVIEW_SERVER').AndReturn('my_server')
     gcl.os.getcwd().AndReturn('somewhere')
     gcl.os.chdir('proout')
     gcl.GenerateDiff(change_info.GetFileNames())
     gcl.upload.RealMain(['upload.py', '-y', '--server=https://my_server',
                          '--reviewers=foo@example.com,bar@example.com',
                          '--issue=1', '--title= '],
                          change_info.patch).AndReturn(("1", "2"))
+    change_info.get_reviewers().AndReturn(['foo@example.com,bar@example.com'])
     change_info.Save()
     change_info.PrimeLint()
     gcl.os.chdir('somewhere')
     gcl.sys.stdout.write("*** Upload does not submit a try; use gcl try to"
                          " submit a try. ***")
     gcl.sys.stdout.write("\n")
     gcl.GetRepositoryRoot().AndReturn(self.fake_root_dir)
     gcl.ChangeInfo.Load('naame', self.fake_root_dir, True, True
         ).AndReturn(change_info)
     self.mox.ReplayAll()
@@ skipping 52 matching lines @@
     self.mox.ReplayAll()
 
     retval = gcl.CMDcommit(['naame'])
 
     self.assertEquals(retval, 1)
 
   def testPresubmitSucceeds(self):
     change_info = self.mockLoad()
     self.mockPresubmit(change_info, fail=False)
     self.mockCommit(
-        change_info, 'deescription\nReview URL: https://my_server/1', '')
+        change_info, 'deescription\n\nReview URL: https://my_server/1', '')
+    change_info.UpdateDescriptionFromIssue()
     self.mox.ReplayAll()
 
     retval = gcl.CMDcommit(['naame'])
 
     self.assertEquals(retval, 0)
     self.assertEquals(change_info.description, 'deescription')
     # pylint: disable=W0212
     self.assertFalse(change_info._deleted)
     self.assertFalse(change_info._closed)
 
   def testPresubmitSucceedsWithCommittedMessage(self):
     change_info = self.mockLoad()
     self.mockPresubmit(change_info, fail=False)
     self.mockCommit(
-        change_info, 'deescription\nReview URL: https://my_server/1',
+        change_info,
+        'deescription\n\nReview URL: https://my_server/1',
         '\nCommitted revision 12345')
-
+    change_info.UpdateDescriptionFromIssue()
+    change_info.append_footer('Committed: http://view/12345')
     self.mox.ReplayAll()
 
     retval = gcl.CMDcommit(['naame'])
     self.assertEquals(retval, 0)
-    self.assertEquals(change_info.description,
-        'deescription\n\nCommitted: http://view/12345')
+    # This is because append_footer is mocked.
+    self.assertEquals(change_info.description, 'deescription')
     # pylint: disable=W0212
     self.assertTrue(change_info._deleted)
     self.assertTrue(change_info._closed)
     self.assertEqual(
         change_info._comments_added,
         ["Committed patchset #1 manually as r12345 (presubmit successful)."])
 
 
 if __name__ == '__main__':
   import unittest
   unittest.main()