Add push-to-trunk python port.

tools/push-to-trunk/common_includes.py

Index: tools/push-to-trunk/common_includes.py
diff --git a/tools/push-to-trunk/common_includes.py b/tools/push-to-trunk/common_includes.py
new file mode 100644
index 0000000000000000000000000000000000000000..5f41005b9cb40c465e97365d1032d38b81367147
--- /dev/null
+++ b/tools/push-to-trunk/common_includes.py
@@ -0,0 +1,289 @@
+#!/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 os
+import re
+import subprocess
+import sys
+
+PERSISTFILE_BASENAME = "PERSISTFILE_BASENAME"
+TEMP_BRANCH = "TEMP_BRANCH"
+BRANCHNAME = "BRANCHNAME"
+DOT_GIT_LOCATION = "DOT_GIT_LOCATION"
+VERSION_FILE = "VERSION_FILE"
+CHANGELOG_FILE = "CHANGELOG_FILE"
+CHANGELOG_ENTRY_FILE = "CHANGELOG_ENTRY_FILE"
+COMMITMSG_FILE = "COMMITMSG_FILE"
+PATCH_FILE = "PATCH_FILE"
+
+
+def TextToFile(text, file_name):
+  with open(file_name, "w") as f:
+    f.write(text)
+
+
+def AppendToFile(text, file_name):
+  with open(file_name, "a") as f:
+    f.write(text)
+
+
+def LinesInFile(file_name):
+  with open(file_name) as f:
+    for line in f:
+      yield line
+
+
+def FileToText(file_name):
+  with open(file_name) as f:
+    return f.read()
+
+
+def MSub(rexp, replacement, text):
+  return re.sub(rexp, replacement, text, flags=re.MULTILINE)
+
+
+# Some commands don't like the pipe, e.g. calling vi from within the script or
+# from subscripts like git cl upload.
+def Command(cmd, args="", prefix="", pipe=True):
+  stdout = subprocess.PIPE if pipe else None
+  p = subprocess.Popen("%s %s %s" % (prefix, cmd, args),

[Jakob Kummerow, 2013/11/06 16:37:23]

Have you tried using subprocess.check_output()? The test runner uses that for
various git/shell calls, and it seems to be a bit easier to use than wrapping
Popen() by hand.

[Michael Achenbach, 2013/11/07 15:56:46]

Same result. Try:
python -c "import subprocess; subprocess.check_output('vi')"

+                       shell=True,
+                       stdout=stdout)
+  p.wait()
+  if p.returncode != 0:
+    return None
+  return p.stdout.read() if pipe else 0
+
+
+# Wrapper for side effects.
+class SideEffectsHandler(object):
+  def Command(self, cmd, args="", prefix="", pipe=True):
+    return Command(cmd, args, prefix, pipe)
+
+  def ReadLine():
+    return sys.stdin.readline().strip()
+
+DEFAULT_SIDE_EFFECTS_HANDLER = SideEffectsHandler()
+
+
+class Step(object):
+  def __init__(self, text="", requires=None):
+    self._text = text
+    self._number = -1
+    self._requires = requires
+    self._side_effects_hanlder = DEFAULT_SIDE_EFFECTS_HANDLER

[Jakob Kummerow, 2013/11/06 16:37:23]

nit: typo

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+
+  def SetNumber(self, number):
+    self._number = number
+
+  def SetConfig(self, config):
+    self._config = config
+
+  def SetState(self, state):
+    self._state = state
+
+  def SetOptions(self, options):
+    self._options = options
+
+  def SetSideEffectHandler(self, handler):

[Jakob Kummerow, 2013/11/06 16:37:23]

nit: please use the same spelling: if the field is called ...effects...
(plural), then the setter should mirror that.

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+    self._side_effects_hanlder = handler
+
+  def Config(self, key):
+    return self._config[key]
+
+  def Run(self):
+    assert self._number >= 0
+    assert self._config is not None
+    assert self._state is not None
+    assert self._side_effects_hanlder is not None
+    if self._requires:
+      self.RestoreIfUnset(self._requires)
+      if not self._state[self._requires]:
+        return
+    print ">>> Step %d: %s" % (self._number, self._text)
+    self.RunStep()
+
+  def RunStep(self):

[Jakob Kummerow, 2013/11/06 16:37:23]

maybe "raise NotImplementedError" here to clarify that subclasses must override
this method.

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+    pass
+
+  def ReadLine(self):
+    return self._side_effects_hanlder.ReadLine()
+
+  def CommandSE(self, cmd, args="", prefix="", pipe=True):

[Jakob Kummerow, 2013/11/06 16:37:23]

Hm... I'm not too happy with the -SE postfix. How do you feel about calling this
just "Command" and routing all external commands through here?

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

[Jakob Kummerow, 2013/11/08 10:43:19]

Sorry if I didn't express that clearly enough; my point was that having to
distinguish at every call site whether a call can be mocked out or not (and
calling either the global Command() or self.Command() accordingly) is brittle
and unintuitive. It would be nice to have a single bottleneck that then decides
whether a command should be passed through the side effect handler or not. As
long as we do have two separate functions, giving them visibly different names
is actually better. AFAICS the only call sites of this method are Git() and
Editor() below, so you should mark it private by prepending an underscore. In
that case I don't care much whether it has the -SE postfix or not. How about
simply inlining it?

[Michael Achenbach, 2013/11/08 13:08:51]

Done.

+    return self._side_effects_hanlder.Command(cmd, args, prefix, pipe)
+
+  def Git(self, args="", prefix="", pipe=True):
+    return self.CommandSE("git", args, prefix, pipe)
+
+  def Editor(self, args):
+    return self.CommandSE(os.environ["EDITOR"],
+        args, pipe=False)

[Jakob Kummerow, 2013/11/06 16:37:23]

nit: fits on last line

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+
+  def Die(self, msg=""):
+    if msg != "":
+      print "Error: %s" % msg
+    print "Exiting"
+    raise Exception(msg)
+
+  def Confirm(self, msg):
+    print "%s [Y/n] " % msg

[Jakob Kummerow, 2013/11/06 16:37:23]

pro tip: if you add a comma:

print "%s [Y/n] " % msg,

that'll suppress the line break that Python automatically inserts at the end of
a print statement's output.

[Michael Achenbach, 2013/11/07 15:56:46]

Good to know. I'll also replace all the sys.stdout.write statements that I used
for that purpose.

+    answer = self.ReadLine()
+    return answer == "" or answer == "Y" or answer == "y"
+
+  def DeleteBranch(self, name):
+    git_result = self.Git("branch").strip()
+    for line in git_result.splitlines():
+      if re.match(r".*\s+%s$" % name, line):
+        msg = "Branch %s exists, do you want to delete it?" % name
+        if self.Confirm(msg):
+          if self.Git("branch -D %s" % name) is None:
+            self.Die("Deleting branch '%s' failed." % name)
+          print "Branch %s deleted." % name
+        else:
+          msg = "Can't continue. Please delete branch %s and try again." % name
+          self.Die(msg)
+
+  def Persist(self, var_name, value):

[Jakob Kummerow, 2013/11/06 16:37:23]

Per-variable persist/restore is fine for now if you want to stay close to the
bash version. Medium-term, we should just write/read all of self._state, encoded
as JSON or whatever.

[Michael Achenbach, 2013/11/07 15:56:46]

Separate CL.

+    value = value or "__EMPTY__"

[Jakob Kummerow, 2013/11/06 16:37:23]

IIRC __EMPTY__ was a hack around the fact that Bash can't properly deal with
empty strings. Python can. So in the bright future, we can remove this hack.

[Michael Achenbach, 2013/11/07 15:56:46]

Separate CL.

+    TextToFile(value, "%s-%s" % (self._config[PERSISTFILE_BASENAME], var_name))
+
+  def Restore(self, var_name):
+    value = FileToText("%s-%s" % (self._config[PERSISTFILE_BASENAME], var_name))
+    value = value or self.Die( "Variable '%s' could not be restored." % var_name)

[Jakob Kummerow, 2013/11/06 16:37:23]

nit: 80col. It's probably enough to delete the superfluous space after
"self.Die(".

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+    return "" if value == "__EMPTY__" else value
+
+  def RestoreIfUnset(self, var_name):
+    if self._state.get(var_name) is None:
+      self._state[var_name] = self.Restore(var_name)
+
+  def InitialEnvironmentChecks(self):
+    # Cancel if this is not a git checkout.
+    if not os.path.exists(self._config[DOT_GIT_LOCATION]):
+      self.Die("This is not a git checkout, this script won't work for you.")
+
+    # Cancel if EDITOR is unset or not executable.
+    if (not os.environ.get("EDITOR") or
+        Command("which", os.environ["EDITOR"]) is None):
+      self.Die("Please set your EDITOR environment variable, you'll need it.")
+
+  def CommonPrepare(self):
+    # Check for a clean workdir.
+    if self.Git("status -s -uno").strip() != "":
+      self.Die("Workspace is not clean. Please commit or undo your changes.")
+
+    # Persist current branch.
+    current_branch = ""
+    git_result = self.Git("status -s -b -uno").strip()
+    for line in git_result.splitlines():
+      if re.match(r"^##.*", line):

[Jakob Kummerow, 2013/11/06 16:37:23]

Let's match only once here.

match = re.match(r"^## (.+)", line)
if match:
  current_branch = match.group(1)

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+        current_branch = re.match(r"^## (.+)", line).group(1)
+        break
+    self.Persist("current_branch", current_branch)
+
+    # Fetch unfetched revisions.
+    if self.Git("svn fetch") is None:
+      self.Die("'git svn fetch' failed.")
+
+    # Get ahold of a safe temporary branch and check it out.
+    if current_branch != self._config[TEMP_BRANCH]:
+      self.DeleteBranch(self._config[TEMP_BRANCH])
+      self.Git("checkout -b %s" % self._config[TEMP_BRANCH])
+
+    # Delete the branch that will be created later if it exists already.
+    self.DeleteBranch(self._config[BRANCHNAME])
+
+  def CommonCleanup(self):
+    self.RestoreIfUnset("current_branch")
+    self.Git("checkout -f %s" % self._state["current_branch"])
+    if self._config[TEMP_BRANCH] != self._state["current_branch"]:
+      self.Git("branch -D %s" % self._config[TEMP_BRANCH])
+    if self._config[BRANCHNAME] != self._state["current_branch"]:
+      self.Git("branch -D %s" % self._config[BRANCHNAME])
+
+    # Clean up all temporary files.
+    Command("rm", "-f %s*" % self._config[PERSISTFILE_BASENAME])
+
+  def ReadAndPersistVersion(self, prefix=""):
+    def ReadAndPersist(var_name, def_name):
+      if re.match(r"^#define %s\s+\d*" % def_name, line):

[Jakob Kummerow, 2013/11/06 16:37:23]

same "match only once" comment applies here.

[Michael Achenbach, 2013/11/07 15:56:46]

Done.

+        major = re.match(r"^#define %s\s+(\d*)" % def_name, line).group(1)
+        self.Persist("%s%s" % (prefix, var_name), major)
+        self._state["%s%s" % (prefix, var_name)] = major
+    for line in LinesInFile(self._config[VERSION_FILE]):
+      for (var_name, def_name) in [("major", "MAJOR_VERSION"),
+                                   ("minor", "MINOR_VERSION"),
+                                   ("build", "BUILD_NUMBER"),
+                                   ("patch", "PATCH_LEVEL")]:
+        ReadAndPersist(var_name, def_name)
+
+  def RestoreVersionIfUnset(self, prefix=""):
+    for v in ["major", "minor", "build", "patch"]:
+      self.RestoreIfUnset("%s%s" % (prefix, v))
+
+  def WaitForLGTM(self):
+    print ("Please wait for an LGTM, then type \"LGTM<Return>\" to commit "
+           "your change. (If you need to iterate on the patch or double check "
+           "that it's sane, do so in another shell, but remember to not "
+           "change the headline of the uploaded CL.")
+    answer = ""
+    while answer != "LGTM":
+      sys.stdout.write("> ")
+      answer = self.ReadLine()
+      if answer != "LGTM":
+        print "That was not 'LGTM'."
+
+  def WaitForResolvingConflicts(self, patch_file):
+    print("Applying the patch \"%s\" failed. Either type \"ABORT<Return>\", "
+          "or resolve the conflicts, stage *all* touched files with "
+          "'git add', and type \"RESOLVED<Return>\"")
+    answer = ""
+    while answer != "RESOLVED":
+      if answer == "ABORT":
+        self.Die("Applying the patch failed.")
+      if answer != "":
+        print "That was not 'RESOLVED' or 'ABORT'."
+      sys.stdout.write("> ")
+      answer = self.ReadLine()
+
+  # Takes a file containing the patch to apply as first argument.
+  def ApplyPatch(self, patch_file, reverse_patch=""):
+    args = "apply --index --reject %s \"%s\"" % (reverse_patch, patch_file)
+    if self.Git(args) is None:
+      self.WaitForResolvingConflicts(patch_file)
+
+
+class UploadStep(Step):
+  def __init__(self):
+    Step.__init__(self, "Upload for code review.")
+
+  def RunStep(self):
+    print "Please enter the email address of a V8 reviewer for your patch: "
+    reviewer = self.ReadLine()
+    args = "cl upload -r \"%s\" --send-mail" % reviewer
+    if self.Git(args,pipe=False) is None:
+      self.Die("'git cl upload' failed, please try again.")