Script to determine in what branch a commit was merged into

tools/release/mergeinfo.py

+#!/usr/bin/env python
 # Copyright 2013 the V8 project authors. All rights reserved.

[Michael Achenbach, 2015/03/26 19:31:00]

Please use short license header, see newer files, e.g. create_release.py with
2015.

[Michael Hablich, 2015/03/27 11:36:39]

Done.

 # 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 argparse
 import os
+import sys
 
-from testrunner.local import testsuite
-from testrunner.objects import testcase
+from subprocess import call
 
+def printAnalysis(gitWorkingDir, hashToSearch):

[Michael Achenbach, 2015/03/26 19:31:00]

nit: as it is a new file rather use pythonish method names, e.g.:
print_analysis and git_execute

[Michael Hablich, 2015/03/27 11:36:40]

Acknowledged.

+  print '0.) Info'
+  gitExecute(gitWorkingDir, ['status'])

[Michael Achenbach, 2015/03/26 19:31:00]

I'd make the api of this tool more concise. Just search for the cherry-pick
commits and nothing else - e.g. no show and no status, etc. Then it's easier to
use the tool from other tools and consume the output.

[Michael Hablich, 2015/03/27 11:36:40]

Not meant for consumption by other tools. For now it should show you every
information it can find on a hash. And reverts are also very interesting.

+  print '1.) Pulling'
+  gitExecute(gitWorkingDir, ['pull'])

[Michael Achenbach, 2015/03/26 19:31:00]

I wouldn't let the script attempt to pull as pull merges to the current branch.
Rather use fetch. Or even better, assume the checkout is in an up-to-date state.

[Michael Hablich, 2015/03/27 11:36:40]

Acknowledged.

+  print '2.) Searching'
+  print '=====================ORIGINAL COMMIT START====================='
+  gitExecute(gitWorkingDir, ['show', hashToSearch])
+  print '=====================ORIGINAL COMMIT END====================='
+  print '#####################FOUND MERGES START#####################'
+  gitExecute(gitWorkingDir, ["log",'--all', '--grep='+hashToSearch])

[Michael Achenbach, 2015/03/26 19:31:00]

Add --format="%H" so that only the hashes are returned.

Grepping for the hash will lead to some false positives e.g. commits that revert
the original commit and mention it in the commit message. Rather search for the
exact expression "Merged deadbeef"

log searches only on the current HEAD IIRC. I think you need something like
rev-list - not sure right now. rev-list only returns hashes which you could then
use in another command. Or use log on all the heads and branch-heads.

[Michael Achenbach, 2015/03/27 10:59:42]

Ignore my comment about log seaching in HEADS. You added --all which does the
trick...

[Michael Hablich, 2015/03/27 11:36:39]

It should be human readable. I like it more verbose. The parameter --all
searches also the refs.

+  print '#####################FOUND MERGES END#####################'
+  print '3.) Done'
 
-class IntlTestSuite(testsuite.TestSuite):
+def gitExecute(workingDir, commands):
+  return call(["git", '-C', workingDir] + commands)
 
-  def __init__(self, name, root):
-    super(IntlTestSuite, self).__init__(name, root)
+if __name__ == "__main__":  # pragma: no cover
+  parser = argparse.ArgumentParser('Tool to check where a git commit was merged into.')
+  parser.add_argument("-g", "--git-dir", required=True,

[Michael Achenbach, 2015/03/26 19:31:00]

This should be optional and just work for the current git checkout in which the
script lives.

[Michael Hablich, 2015/03/27 11:36:40]

Acknowledged.

+                        help=("The path to your git working directory."))
 
-  def ListTests(self, context):
-    tests = []
-    for dirname, dirs, files in os.walk(self.root):
-      for dotted in [x for x in dirs if x.startswith('.')]:
-        dirs.remove(dotted)
-      dirs.sort()
-      files.sort()
-      for filename in files:
-        if (filename.endswith(".js") and filename != "assert.js" and
-            filename != "utils.js"):
-          testname = os.path.join(dirname[len(self.root) + 1:], filename[:-3])
-          test = testcase.TestCase(self, testname)
-          tests.append(test)
-    return tests
+  parser.add_argument("--hash", help="Hash of the commit to be searched.", required=True)

[Michael Achenbach, 2015/03/26 19:31:00]

I'd make this a parameterless argument so that the tool can be called:
mergeinfo.py deadbeef

[Michael Hablich, 2015/03/27 11:36:39]

Acknowledged.

+  args = sys.argv[1:]
+  options = parser.parse_args(args)
 
-  def GetFlagsForTestCase(self, testcase, context):
-    flags = ["--allow-natives-syntax"] + context.mode_flags
-
-    files = []
-    files.append(os.path.join(self.root, "assert.js"))
-    files.append(os.path.join(self.root, "utils.js"))
-    files.append(os.path.join(self.root, testcase.path + self.suffix()))
-
-    flags += files
-    if context.isolates:
-      flags.append("--isolate")
-      flags += files
-
-    return testcase.flags + flags
-
-
-def GetSuite(name, root):
-  return IntlTestSuite(name, root)
+  sys.exit(printAnalysis(options.git_dir, options.hash))