Refactoring: Extract low-level git from push and merge scripts.

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
@@ skipping 80 matching lines @@
     self.InitialEnvironmentChecks()
     self.CommonPrepare()
     self.PrepareBranch()
     self.DeleteBranch(self.Config(TRUNKBRANCH))
 
 
 class FreshBranch(Step):
   MESSAGE = "Create a fresh branch."
 
   def RunStep(self):
-    args = "checkout -b %s svn/bleeding_edge" % self.Config(BRANCHNAME)
-    self.Git(args)
+    self.GitCreateBranch(self.Config(BRANCHNAME), "svn/bleeding_edge")
 
 
 class DetectLastPush(Step):
   MESSAGE = "Detect commit ID of last push to trunk."
 
   def RunStep(self):
-    last_push_trunk = self._options.l or self.FindLastTrunkPush()
+    last_push = self._options.l or self.FindLastTrunkPush()
     while True:
       # Print assumed commit, circumventing git's pager.
-      print self.Git("log -1 %s" % last_push_trunk)
+      print self.GitLog(n=1, git_hash=last_push)
       if self.Confirm("Is the commit printed above the last push to trunk?"):
         break
-      args = ("log -1 --format=%%H %s^ --grep=\"%s\""
-              % (last_push_trunk, push_pattern))
-      last_push_trunk = self.Git(args).strip()
+      last_push = self.FindLastTrunkPush(parent_hash=last_push)
 
     if self._options.b:
       # Read the bleeding edge revision of the last push from a command-line
       # option.
       last_push_bleeding_edge = self._options.b
     else:
       # Retrieve the bleeding edge revision of the last push from the text in
       # the push commit message.
-      args = "log -1 --format=%%s %s" % last_push_trunk
-      last_push_trunk_title = self.Git(args).strip()
-      last_push_be_svn = PUSH_MESSAGE_RE.match(last_push_trunk_title).group(1)
+      last_push_title = self.GitLog(n=1, format="%s", git_hash=last_push)
+      last_push_be_svn = PUSH_MESSAGE_RE.match(last_push_title).group(1)
       if not last_push_be_svn:
         self.Die("Could not retrieve bleeding edge revision for trunk push %s"
-                 % last_push_trunk)
-      args = "svn find-rev r%s" % last_push_be_svn
-      last_push_bleeding_edge = self.Git(args).strip()
+                 % last_push)
+      last_push_bleeding_edge = self.GitSVNFindGitHash(last_push_be_svn)
       if not last_push_bleeding_edge:
         self.Die("Could not retrieve bleeding edge git hash for trunk push %s"
-                 % last_push_trunk)
+                 % last_push)
 
     # TODO(machenbach): last_push_trunk points to the svn revision on trunk.
     # It is not used yet but we'll need it for retrieving the current version.
-    self["last_push_trunk"] = last_push_trunk
+    self["last_push_trunk"] = last_push
     # TODO(machenbach): This currently points to the prepare push revision that
     # will be deprecated soon. After the deprecation it will point to the last
     # bleeding_edge revision that went into the last push.
     self["last_push_bleeding_edge"] = last_push_bleeding_edge
 
 
 class PrepareChangeLog(Step):
   MESSAGE = "Prepare raw ChangeLog entry."
 
   def Reload(self, body):
@@ skipping 17 matching lines @@
   def RunStep(self):
     # These version numbers are used again later for the trunk commit.
     self.ReadAndPersistVersion()
     self["date"] = self.GetDate()
     self["version"] = "%s.%s.%s" % (self["major"],
                                     self["minor"],
                                     self["build"])
     output = "%s: Version %s\n\n" % (self["date"],
                                      self["version"])
     TextToFile(output, self.Config(CHANGELOG_ENTRY_FILE))
-
-    args = "log %s..HEAD --format=%%H" % self["last_push_bleeding_edge"]
-    commits = self.Git(args).strip()
+    commits = self.GitLog(format="%H",
+        git_hash="%s..HEAD" % self["last_push_bleeding_edge"])
 
     # Cache raw commit messages.
     commit_messages = [
       [
-        self.Git("log -1 %s --format=\"%%s\"" % commit),
-        self.Reload(self.Git("log -1 %s --format=\"%%B\"" % commit)),
-        self.Git("log -1 %s --format=\"%%an\"" % commit),
+        self.GitLog(n=1, format="%s", git_hash=commit),
+        self.Reload(self.GitLog(n=1, format="%B", git_hash=commit)),
+        self.GitLog(n=1, format="%an", git_hash=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."
@@ skipping 61 matching lines @@
 
   def RunStep(self):
     self["prep_commit_msg"] = ("Prepare push to trunk.  "
         "Now working on version %s.%s.%s." % (self["new_major"],
                                               self["new_minor"],
                                               self["new_build"]))
 
     # Include optional TBR only in the git command. The persisted commit
     # message is used for finding the commit again later.
     if self._options.tbr_commit:
-      review = "\n\nTBR=%s" % self._options.reviewer
+      message = "%s\n\nTBR=%s" % (self["prep_commit_msg"],
+                                  self._options.reviewer)
     else:
-      review = ""
-    self.Git("commit -a -m \"%s%s\"" % (self["prep_commit_msg"], review))
+      message = "%s" % self["prep_commit_msg"]
+    self.GitCommit(message)
 
 
 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.
     TextToFile(GetLastChangeLogEntries(self.Config(CHANGELOG_FILE)),
                self.Config(CHANGELOG_ENTRY_FILE))
 
-    self.Git("cl presubmit", "PRESUBMIT_TREE_CHECK=\"skip\"")
-    self.Git("cl dcommit -f --bypass-hooks", retry_on=lambda x: x is None)
+    self.GitPresubmit()
+    self.GitDCommit()
 
 
 class StragglerCommits(Step):
   MESSAGE = ("Fetch straggler commits that sneaked in since this script was "
              "started.")
 
   def RunStep(self):
-    self.Git("svn fetch")
-    self.Git("checkout svn/bleeding_edge")
-    args = "log -1 --format=%%H --grep=\"%s\"" % self["prep_commit_msg"]
-    self["prepare_commit_hash"] = self.Git(args).strip()
+    self.GitSVNFetch()
+    self.GitCheckout("svn/bleeding_edge")
+    self["prepare_commit_hash"] = self.GitLog(n=1, format="%H",
+                                              grep=self["prep_commit_msg"])
 
 
 class SquashCommits(Step):
   MESSAGE = "Squash commits into one."
 
   def RunStep(self):
     # Instead of relying on "git rebase -i", we'll just create a diff, because
     # that's easier to automate.
-    args = "diff svn/trunk %s" % self["prepare_commit_hash"]
-    TextToFile(self.Git(args), self.Config(PATCH_FILE))
+    TextToFile(self.GitDiff("svn/trunk", self["prepare_commit_hash"]),
+               self.Config(PATCH_FILE))
 
     # Convert the ChangeLog entry to commit message format.
     text = FileToText(self.Config(CHANGELOG_ENTRY_FILE))
 
     # Remove date and trailing white space.
     text = re.sub(r"^%s: " % self["date"], "", text.rstrip())
 
     # Retrieve svn revision for showing the used bleeding edge revision in the
     # commit message.
-    args = "svn find-rev %s" % self["prepare_commit_hash"]
-    self["svn_revision"] = self.Git(args).strip()
+    self["svn_revision"] = self.GitSVNFindSVNRev(self["prepare_commit_hash"])
     suffix = PUSH_MESSAGE_SUFFIX % int(self["svn_revision"])
     text = MSub(r"^(Version \d+\.\d+\.\d+)$", "\\1%s" % suffix, text)
 
     # Remove indentation and merge paragraphs into single long lines, keeping
     # empty lines between them.
     def SplitMapJoin(split_text, fun, join_text):
       return lambda text: join_text.join(map(fun, text.split(split_text)))
     strip = lambda line: line.strip()
     text = SplitMapJoin("\n\n", SplitMapJoin("\n", strip, " "), "\n\n")(text)
 
     if not text:
       self.Die("Commit message editing failed.")
     TextToFile(text, self.Config(COMMITMSG_FILE))
     os.remove(self.Config(CHANGELOG_ENTRY_FILE))
 
 
 class NewBranch(Step):
   MESSAGE = "Create a new branch from trunk."
 
   def RunStep(self):
-    self.Git("checkout -b %s svn/trunk" % self.Config(TRUNKBRANCH))
+    self.GitCreateBranch(self.Config(TRUNKBRANCH), "svn/trunk")
 
 
 class ApplyChanges(Step):
   MESSAGE = "Apply squashed changes."
 
   def RunStep(self):
     self.ApplyPatch(self.Config(PATCH_FILE))
     Command("rm", "-f %s*" % self.Config(PATCH_FILE))
 
 
@@ skipping 14 matching lines @@
       elif line.startswith("#define IS_CANDIDATE_VERSION"):
         line = re.sub("\d+$", "0", line)
       output += "%s\n" % line
     TextToFile(output, self.Config(VERSION_FILE))
 
 
 class CommitTrunk(Step):
   MESSAGE = "Commit to local trunk branch."
 
   def RunStep(self):
-    self.Git("add \"%s\"" % self.Config(VERSION_FILE))
-    self.Git("commit -F \"%s\"" % self.Config(COMMITMSG_FILE))
+    self.GitAdd(self.Config(VERSION_FILE))
+    self.GitCommit(file_name = self.Config(COMMITMSG_FILE))
     Command("rm", "-f %s*" % self.Config(COMMITMSG_FILE))
 
 
 class SanityCheck(Step):
   MESSAGE = "Sanity check."
 
   def RunStep(self):
     if not self.Confirm("Please check if your local checkout is sane: Inspect "
         "%s, compile, run tests. Do you want to commit this new trunk "
         "revision to the repository?" % self.Config(VERSION_FILE)):
       self.Die("Execution canceled.")
 
 
 class CommitSVN(Step):
   MESSAGE = "Commit to SVN."
 
   def RunStep(self):
-    result = self.Git("svn dcommit 2>&1", retry_on=lambda x: x is None)
+    result = self.GitSVNDCommit()
     if not result:
       self.Die("'git svn dcommit' failed.")
     result = filter(lambda x: re.search(r"^Committed r[0-9]+", x),
                     result.splitlines())
     if len(result) > 0:
       self["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 self["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.DieNoManualMode("Can't prompt in forced mode.")
       while not self["trunk_revision"]:
         print "> ",
         self["trunk_revision"] = self.ReadLine()
 
 
 class TagRevision(Step):
   MESSAGE = "Tag the new revision."
 
   def RunStep(self):
-    self.Git(("svn tag %s -m \"Tagging version %s\""
-              % (self["version"], self["version"])),
-             retry_on=lambda x: x is None)
+    self.GitSVNTag(self["version"])
 
 
 class CheckChromium(Step):
   MESSAGE = "Ask for chromium checkout."
 
   def Run(self):
     self["chrome_path"] = self._options.c
     if not self["chrome_path"]:
       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>: "),
       self["chrome_path"] = self.ReadLine()
 
 
 class SwitchChromium(Step):
   MESSAGE = "Switch to Chromium checkout."
   REQUIRES = "chrome_path"
 
   def RunStep(self):
     self["v8_path"] = os.getcwd()
     os.chdir(self["chrome_path"])
     self.InitialEnvironmentChecks()
     # Check for a clean workdir.
-    if self.Git("status -s -uno").strip() != "":
+    if not self.GitIsWorkdirClean():
       self.Die("Workspace is not clean. Please commit or undo your changes.")
     # Assert that the DEPS file is there.
     if not os.path.exists(self.Config(DEPS_FILE)):
       self.Die("DEPS file not present.")
 
 
 class UpdateChromiumCheckout(Step):
   MESSAGE = "Update the checkout and create a new branch."
   REQUIRES = "chrome_path"
 
   def RunStep(self):
     os.chdir(self["chrome_path"])
-    self.Git("checkout master")
-    self.Git("pull")
-    self.Git("checkout -b v8-roll-%s" % self["trunk_revision"])
+    self.GitCheckout("master")
+    self.GitPull()
+    self.GitCreateBranch("v8-roll-%s" % self["trunk_revision"])
 
 
 class UploadCL(Step):
   MESSAGE = "Create and upload CL."
   REQUIRES = "chrome_path"
 
   def RunStep(self):
     os.chdir(self["chrome_path"])
 
     # Patch DEPS file.
     deps = FileToText(self.Config(DEPS_FILE))
     deps = re.sub("(?<=\"v8_revision\": \")([0-9]+)(?=\")",
                   self["trunk_revision"],
                   deps)
     TextToFile(deps, self.Config(DEPS_FILE))
 
     if self._options.reviewer:
       print "Using account %s for review." % self._options.reviewer
       rev = self._options.reviewer
     else:
       print "Please enter the email address of a reviewer for the roll CL: ",
       self.DieNoManualMode("A reviewer must be specified in forced mode.")
       rev = self.ReadLine()
-    self.Git("commit -am \"Update V8 to version %s "
-             "(based on bleeding_edge revision r%s).\n\nTBR=%s\""
-             % (self["version"], self["svn_revision"], rev))
-    author_option = self._options.author
-    author = " --email \"%s\"" % author_option if author_option else ""
-    force_flag = " -f" if self._options.force_upload else ""
-    self.Git("cl upload%s --send-mail%s" % (author, force_flag), pipe=False)
+    suffix = PUSH_MESSAGE_SUFFIX % int(self["svn_revision"])
+    self.GitCommit("Update V8 to version %s%s.\n\nTBR=%s"
+                   % (self["version"], suffix, rev))
+    self.GitUpload(author=self._options.author,
+                   force=self._options.force_upload)
     print "CL uploaded."
 
 
 class SwitchV8(Step):
   MESSAGE = "Returning to V8 checkout."
   REQUIRES = "chrome_path"
 
   def RunStep(self):
     os.chdir(self["v8_path"])
 
 
 class CleanUp(Step):
   MESSAGE = "Done!"
 
   def RunStep(self):
     if self["chrome_path"]:
       print("Congratulations, you have successfully created the trunk "
             "revision %s and rolled it into Chromium. Please don't forget to "
             "update the v8rel spreadsheet:" % self["version"])
     else:
       print("Congratulations, you have successfully created the trunk "
             "revision %s. Please don't forget to roll this new version into "
             "Chromium, and to update the v8rel spreadsheet:"
             % self["version"])
     print "%s\ttrunk\t%s" % (self["version"],
                              self["trunk_revision"])
 
     self.CommonCleanup()
     if self.Config(TRUNKBRANCH) != self["current_branch"]:
-      self.Git("branch -D %s" % self.Config(TRUNKBRANCH))
+      self.GitDeleteBranch(self.Config(TRUNKBRANCH))
 
 
 def RunPushToTrunk(config,
                    options,
                    side_effect_handler=DEFAULT_SIDE_EFFECT_HANDLER):
   step_classes = [
     Preparation,
     FreshBranch,
     DetectLastPush,
     PrepareChangeLog,
@@ skipping 73 matching lines @@
 def Main():
   parser = BuildOptions()
   (options, args) = parser.parse_args()
   if not ProcessOptions(options):
     parser.print_help()
     return 1
   RunPushToTrunk(CONFIG, PushToTrunkOptions(options))
 
 if __name__ == "__main__":
   sys.exit(Main())