Merge bleeding_edge 18021:18297

tools/push-to-trunk/push_to_trunk.py

 #!/usr/bin/env python
 # Copyright 2013 the V8 project authors. All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 #       notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 #       copyright notice, this list of conditions and the following
 #       disclaimer in the documentation and/or other materials provided
 #       with the distribution.
 #     * Neither the name of Google Inc. nor the names of its
 #       contributors may be used to endorse or promote products derived
 #       from this software without specific prior written permission.
 #
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import datetime
 import optparse
 import sys
 import tempfile
+import urllib2
 
 from common_includes import *
 
 TRUNKBRANCH = "TRUNKBRANCH"
 CHROMIUM = "CHROMIUM"
 DEPS_FILE = "DEPS_FILE"
 
 CONFIG = {
   BRANCHNAME: "prepare-push",
   TRUNKBRANCH: "trunk-push",
@@ skipping 41 matching lines @@
         break
       args = "log -1 --format=%H %s^ ChangeLog" % last_push
       last_push = self.Git(args).strip()
     self.Persist("last_push", last_push)
     self._state["last_push"] = last_push
 
 
 class PrepareChangeLog(Step):
   MESSAGE = "Prepare raw ChangeLog entry."
 
+  def Reload(self, body):
+    """Attempts to reload the commit message from rietveld in order to allow
+    late changes to the LOG flag. Note: This is brittle to future changes of
+    the web page name or structure.
+    """
+    match = re.search(r"^Review URL: https://codereview\.chromium\.org/(\d+)$",
+                      body, flags=re.M)
+    if match:
+      cl_url = "https://codereview.chromium.org/%s/description" % match.group(1)
+      try:
+        # Fetch from Rietveld but only retry once with one second delay since
+        # there might be many revisions.
+        body = self.ReadURL(cl_url, wait_plan=[1])
+      except urllib2.URLError:
+        pass
+    return body
+
   def RunStep(self):
     self.RestoreIfUnset("last_push")
 
     # These version numbers are used again later for the trunk commit.
     self.ReadAndPersistVersion()
 
-    date = datetime.date.today().strftime("%Y-%m-%d")
+    date = self.GetDate()
     self.Persist("date", date)
     output = "%s: Version %s.%s.%s\n\n" % (date,
                                            self._state["major"],
                                            self._state["minor"],
                                            self._state["build"])
     TextToFile(output, self.Config(CHANGELOG_ENTRY_FILE))
 
     args = "log %s..HEAD --format=%%H" % self._state["last_push"]
     commits = self.Git(args).strip()
 
     # Cache raw commit messages.
     commit_messages = [
       [
         self.Git("log -1 %s --format=\"%%s\"" % commit),
-        self.Git("log -1 %s --format=\"%%B\"" % commit),
+        self.Reload(self.Git("log -1 %s --format=\"%%B\"" % commit)),
         self.Git("log -1 %s --format=\"%%an\"" % commit),
       ] for commit in commits.splitlines()
     ]
 
     # Auto-format commit messages.
     body = MakeChangeLogBody(commit_messages, auto_format=True)
     AppendToFile(body, self.Config(CHANGELOG_ENTRY_FILE))
 
     msg = ("        Performance and stability improvements on all platforms."
            "\n#\n# The change log above is auto-generated. Please review if "
            "all relevant\n# commit messages from the list below are included."
            "\n# All lines starting with # will be stripped.\n#\n")
     AppendToFile(msg, self.Config(CHANGELOG_ENTRY_FILE))
 
     # Include unformatted commit messages as a reference in a comment.
     comment_body = MakeComment(MakeChangeLogBody(commit_messages))
     AppendToFile(comment_body, self.Config(CHANGELOG_ENTRY_FILE))
 
 
 class EditChangeLog(Step):
   MESSAGE = "Edit ChangeLog entry."
 
   def RunStep(self):
     print ("Please press <Return> to have your EDITOR open the ChangeLog "
            "entry, then edit its contents to your liking. When you're done, "
            "save the file and exit your EDITOR. ")
     self.ReadLine(default="")
-
-    # TODO(machenbach): Don't use EDITOR in forced mode as soon as script is
-    # well tested.
     self.Editor(self.Config(CHANGELOG_ENTRY_FILE))
     handle, new_changelog = tempfile.mkstemp()
     os.close(handle)
 
     # Strip comments and reformat with correct indentation.
     changelog_entry = FileToText(self.Config(CHANGELOG_ENTRY_FILE)).rstrip()
     changelog_entry = StripComments(changelog_entry)
     changelog_entry = "\n".join(map(Fill80, changelog_entry.splitlines()))
+    changelog_entry = changelog_entry.lstrip()
 
     if changelog_entry == "":
       self.Die("Empty ChangeLog entry.")
 
     with open(new_changelog, "w") as f:
       f.write(changelog_entry)
       f.write("\n\n\n")  # Explicitly insert two empty lines.
 
     AppendToFile(FileToText(self.Config(CHANGELOG_FILE)), new_changelog)
     TextToFile(FileToText(new_changelog), self.Config(CHANGELOG_FILE))
@@ skipping 25 matching lines @@
 class CommitLocal(Step):
   MESSAGE = "Commit to local branch."
 
   def RunStep(self):
     self.RestoreVersionIfUnset("new_")
     prep_commit_msg = ("Prepare push to trunk.  "
         "Now working on version %s.%s.%s." % (self._state["new_major"],
                                               self._state["new_minor"],
                                               self._state["new_build"]))
     self.Persist("prep_commit_msg", prep_commit_msg)
-    if self.Git("commit -a -m \"%s\"" % prep_commit_msg) is None:
+
+    # Include optional TBR only in the git command. The persisted commit
+    # message is used for finding the commit again later.
+    review = "\n\nTBR=%s" % self._options.r if not self.IsManual() else ""
+    if self.Git("commit -a -m \"%s%s\"" % (prep_commit_msg, review)) is None:
       self.Die("'git commit -a' failed.")
 
 
 class CommitRepository(Step):
   MESSAGE = "Commit to the repository."
 
   def RunStep(self):
     self.WaitForLGTM()
     # Re-read the ChangeLog entry (to pick up possible changes).
     # FIXME(machenbach): This was hanging once with a broken pipe.
@@ skipping 129 matching lines @@
                     result.splitlines())
     if len(result) > 0:
       trunk_revision = re.sub(r"^Committed r([0-9]+)", r"\1", result[0])
 
     # Sometimes grepping for the revision fails. No idea why. If you figure
     # out why it is flaky, please do fix it properly.
     if not trunk_revision:
       print("Sorry, grepping for the SVN revision failed. Please look for it "
             "in the last command's output above and provide it manually (just "
             "the number, without the leading \"r\").")
-      self.DieInForcedMode("Can't prompt in forced mode.")
+      self.DieNoManualMode("Can't prompt in forced mode.")
       while not trunk_revision:
         print "> ",
         trunk_revision = self.ReadLine()
     self.Persist("trunk_revision", trunk_revision)
 
 
 class TagRevision(Step):
   MESSAGE = "Tag the new revision."
 
   def RunStep(self):
     self.RestoreVersionIfUnset()
     ver = "%s.%s.%s" % (self._state["major"],
                         self._state["minor"],
                         self._state["build"])
     if self.Git("svn tag %s -m \"Tagging version %s\"" % (ver, ver)) is None:
       self.Die("'git svn tag' failed.")
 
 
 class CheckChromium(Step):
   MESSAGE = "Ask for chromium checkout."
 
   def Run(self):
     chrome_path = self._options.c
     if not chrome_path:
-      self.DieInForcedMode("Please specify the path to a Chromium checkout in "
+      self.DieNoManualMode("Please specify the path to a Chromium checkout in "
                           "forced mode.")
       print ("Do you have a \"NewGit\" Chromium checkout and want "
           "this script to automate creation of the roll CL? If yes, enter the "
           "path to (and including) the \"src\" directory here, otherwise just "
           "press <Return>: "),
       chrome_path = self.ReadLine()
     self.Persist("chrome_path", chrome_path)
 
 
 class SwitchChromium(Step):
@@ skipping 47 matching lines @@
 
     self.RestoreVersionIfUnset()
     ver = "%s.%s.%s" % (self._state["major"],
                         self._state["minor"],
                         self._state["build"])
     if self._options and self._options.r:
       print "Using account %s for review." % self._options.r
       rev = self._options.r
     else:
       print "Please enter the email address of a reviewer for the roll CL: ",
-      self.DieInForcedMode("A reviewer must be specified in forced mode.")
+      self.DieNoManualMode("A reviewer must be specified in forced mode.")
       rev = self.ReadLine()
     args = "commit -am \"Update V8 to version %s.\n\nTBR=%s\"" % (ver, rev)
     if self.Git(args) is None:
       self.Die("'git commit' failed.")
-    force_flag = " -f" if self._options.f else ""
+    force_flag = " -f" if not self.IsManual() else ""
     if self.Git("cl upload --send-mail%s" % force_flag, pipe=False) is None:
       self.Die("'git cl upload' failed, please try again.")
     print "CL uploaded."
 
 
 class SwitchV8(Step):
   MESSAGE = "Returning to V8 checkout."
   REQUIRES = "chrome_path"
 
   def RunStep(self):
@@ skipping 64 matching lines @@
   result = optparse.OptionParser()
   result.add_option("-c", "--chromium", dest="c",
                     help=("Specify the path to your Chromium src/ "
                           "directory to automate the V8 roll."))
   result.add_option("-f", "--force", dest="f",
                     help="Don't prompt the user.",
                     default=False, action="store_true")
   result.add_option("-l", "--last-push", dest="l",
                     help=("Manually specify the git commit ID "
                           "of the last push to trunk."))
+  result.add_option("-m", "--manual", dest="m",
+                    help="Prompt the user at every important step.",
+                    default=False, action="store_true")
   result.add_option("-r", "--reviewer", dest="r",
                     help=("Specify the account name to be used for reviews."))
   result.add_option("-s", "--step", dest="s",
                     help="Specify the step where to start work. Default: 0.",
                     default=0, type="int")
   return result
 
 
 def ProcessOptions(options):
   if options.s < 0:
     print "Bad step number %d" % options.s
     return False
+  if not options.m and not options.r:
+    print "A reviewer (-r) is required in (semi-)automatic mode."
+    return False
+  if options.f and options.m:
+    print "Manual and forced mode cannot be combined."
+    return False
+  if not options.m and not options.c:
+    print "A chromium checkout (-c) is required in (semi-)automatic mode."
+    return False
   return True
 
 
 def Main():
   parser = BuildOptions()
   (options, args) = parser.parse_args()
   if not ProcessOptions(options):
     parser.print_help()
     return 1
   RunPushToTrunk(CONFIG, options)
 
 if __name__ == "__main__":
   sys.exit(Main())