16066d16eSPiotr Jasiukajtis#!/usr/bin/python2.6 28bcea973SRichard Lowe# 38bcea973SRichard Lowe# This program is free software; you can redistribute it and/or modify 48bcea973SRichard Lowe# it under the terms of the GNU General Public License version 2 58bcea973SRichard Lowe# as published by the Free Software Foundation. 68bcea973SRichard Lowe# 78bcea973SRichard Lowe# This program is distributed in the hope that it will be useful, 88bcea973SRichard Lowe# but WITHOUT ANY WARRANTY; without even the implied warranty of 98bcea973SRichard Lowe# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 108bcea973SRichard Lowe# GNU General Public License for more details. 118bcea973SRichard Lowe# 128bcea973SRichard Lowe# You should have received a copy of the GNU General Public License 138bcea973SRichard Lowe# along with this program; if not, write to the Free Software 148bcea973SRichard Lowe# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 158bcea973SRichard Lowe# 168bcea973SRichard Lowe 178bcea973SRichard Lowe# 188bcea973SRichard Lowe# Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 198bcea973SRichard Lowe# Copyright 2008, 2012 Richard Lowe 208bcea973SRichard Lowe# 218bcea973SRichard Lowe 228bcea973SRichard Loweimport getopt 238bcea973SRichard Loweimport os 248bcea973SRichard Loweimport re 258bcea973SRichard Loweimport subprocess 268bcea973SRichard Loweimport sys 27ff50e8e5SRichard Loweimport tempfile 288bcea973SRichard Lowe 298bcea973SRichard Lowefrom cStringIO import StringIO 308bcea973SRichard Lowe 318bcea973SRichard Lowe# This is necessary because, in a fit of pique, we used hg-format ignore lists 328bcea973SRichard Lowe# for NOT files. 338bcea973SRichard Lowefrom mercurial import ignore 348bcea973SRichard Lowe 358bcea973SRichard Lowe# 368bcea973SRichard Lowe# Adjust the load path based on our location and the version of python into 378bcea973SRichard Lowe# which it is being loaded. This assumes the normal onbld directory 388bcea973SRichard Lowe# structure, where we are in bin/ and the modules are in 398bcea973SRichard Lowe# lib/python(version)?/onbld/Scm/. If that changes so too must this. 408bcea973SRichard Lowe# 418bcea973SRichard Lowesys.path.insert(1, os.path.join(os.path.dirname(__file__), "..", "lib", 428bcea973SRichard Lowe "python%d.%d" % sys.version_info[:2])) 438bcea973SRichard Lowe 448bcea973SRichard Lowe# 458bcea973SRichard Lowe# Add the relative path to usr/src/tools to the load path, such that when run 468bcea973SRichard Lowe# from the source tree we use the modules also within the source tree. 478bcea973SRichard Lowe# 488bcea973SRichard Lowesys.path.insert(2, os.path.join(os.path.dirname(__file__), "..")) 498bcea973SRichard Lowe 508bcea973SRichard Lowefrom onbld.Checks import Comments, Copyright, CStyle, HdrChk 518bcea973SRichard Lowefrom onbld.Checks import JStyle, Keywords, Mapfile 528bcea973SRichard Lowe 538bcea973SRichard Lowe 548bcea973SRichard Loweclass GitError(Exception): 558bcea973SRichard Lowe pass 568bcea973SRichard Lowe 578bcea973SRichard Lowedef git(command): 588bcea973SRichard Lowe """Run a command and return a stream containing its stdout (and write its 598bcea973SRichard Lowe stderr to its stdout)""" 608bcea973SRichard Lowe 618bcea973SRichard Lowe if type(command) != list: 628bcea973SRichard Lowe command = command.split() 638bcea973SRichard Lowe 648bcea973SRichard Lowe command = ["git"] + command 658bcea973SRichard Lowe 66ff50e8e5SRichard Lowe try: 67ff50e8e5SRichard Lowe tmpfile = tempfile.TemporaryFile(prefix="git-nits") 68ff50e8e5SRichard Lowe except EnvironmentError, e: 69ff50e8e5SRichard Lowe raise GitError("Could not create temporary file: %s\n" % e) 70ff50e8e5SRichard Lowe 71ff50e8e5SRichard Lowe try: 728bcea973SRichard Lowe p = subprocess.Popen(command, 73ff50e8e5SRichard Lowe stdout=tmpfile, 748bcea973SRichard Lowe stderr=subprocess.STDOUT) 75ff50e8e5SRichard Lowe except OSError, e: 76ff50e8e5SRichard Lowe raise GitError("could not execute %s: %s\n" (command, e)) 778bcea973SRichard Lowe 788bcea973SRichard Lowe err = p.wait() 798bcea973SRichard Lowe if err != 0: 808bcea973SRichard Lowe raise GitError(p.stdout.read()) 818bcea973SRichard Lowe 82ff50e8e5SRichard Lowe tmpfile.seek(0) 83ff50e8e5SRichard Lowe return tmpfile 848bcea973SRichard Lowe 858bcea973SRichard Lowe 868bcea973SRichard Lowedef git_root(): 878bcea973SRichard Lowe """Return the root of the current git workspace""" 888bcea973SRichard Lowe 898bcea973SRichard Lowe p = git('rev-parse --git-dir') 908bcea973SRichard Lowe 918bcea973SRichard Lowe if not p: 928bcea973SRichard Lowe sys.stderr.write("Failed finding git workspace\n") 938bcea973SRichard Lowe sys.exit(err) 948bcea973SRichard Lowe 958bcea973SRichard Lowe return os.path.abspath(os.path.join(p.readlines()[0], 968bcea973SRichard Lowe os.path.pardir)) 978bcea973SRichard Lowe 988bcea973SRichard Lowe 998bcea973SRichard Lowedef git_branch(): 1008bcea973SRichard Lowe """Return the current git branch""" 1018bcea973SRichard Lowe 1028bcea973SRichard Lowe p = git('branch') 1038bcea973SRichard Lowe 1048bcea973SRichard Lowe if not p: 1058bcea973SRichard Lowe sys.stderr.write("Failed finding git branch\n") 1068bcea973SRichard Lowe sys.exit(err) 1078bcea973SRichard Lowe 1088bcea973SRichard Lowe for elt in p: 1098bcea973SRichard Lowe if elt[0] == '*': 1108bcea973SRichard Lowe if elt.endswith('(no branch)'): 1118bcea973SRichard Lowe return None 1128bcea973SRichard Lowe return elt.split()[1] 1138bcea973SRichard Lowe 1148bcea973SRichard Lowe 1158bcea973SRichard Lowedef git_parent_branch(branch): 1168bcea973SRichard Lowe """Return the parent of the current git branch. 1178bcea973SRichard Lowe 1188bcea973SRichard Lowe If this branch tracks a remote branch, return the remote branch which is 1198bcea973SRichard Lowe tracked. If not, default to origin/master.""" 1208bcea973SRichard Lowe 1218bcea973SRichard Lowe if not branch: 1228bcea973SRichard Lowe return None 1238bcea973SRichard Lowe 1248bcea973SRichard Lowe p = git("for-each-ref --format=%(refname:short) %(upstream:short) " + 1258bcea973SRichard Lowe "refs/heads/") 1268bcea973SRichard Lowe 1278bcea973SRichard Lowe if not p: 1288bcea973SRichard Lowe sys.stderr.write("Failed finding git parent branch\n") 1298bcea973SRichard Lowe sys.exit(err) 1308bcea973SRichard Lowe 1318bcea973SRichard Lowe for line in p: 1328bcea973SRichard Lowe # Git 1.7 will leave a ' ' trailing any non-tracking branch 1338bcea973SRichard Lowe if ' ' in line and not line.endswith(' \n'): 1348bcea973SRichard Lowe local, remote = line.split() 1358bcea973SRichard Lowe if local == branch: 1368bcea973SRichard Lowe return remote 1378bcea973SRichard Lowe return 'origin/master' 1388bcea973SRichard Lowe 1398bcea973SRichard Lowe 1408bcea973SRichard Lowedef git_comments(parent): 1418bcea973SRichard Lowe """Return a list of any checkin comments on this git branch""" 1428bcea973SRichard Lowe 143*27495383SRichard Lowe p = git('log --pretty=tformat:%%B:SEP: %s..' % parent) 1448bcea973SRichard Lowe 1458bcea973SRichard Lowe if not p: 1468bcea973SRichard Lowe sys.stderr.write("Failed getting git comments\n") 1478bcea973SRichard Lowe sys.exit(err) 1488bcea973SRichard Lowe 149*27495383SRichard Lowe return [x.strip() for x in p.readlines() if x != ':SEP:\n'] 1508bcea973SRichard Lowe 1518bcea973SRichard Lowe 1528bcea973SRichard Lowedef git_file_list(parent, paths=None): 1538bcea973SRichard Lowe """Return the set of files which have ever changed on this branch. 1548bcea973SRichard Lowe 1558bcea973SRichard Lowe NB: This includes files which no longer exist, or no longer actually 1568bcea973SRichard Lowe differ.""" 1578bcea973SRichard Lowe 1588bcea973SRichard Lowe p = git("log --name-only --pretty=format: %s.. %s" % 1598bcea973SRichard Lowe (parent, ' '.join(paths))) 1608bcea973SRichard Lowe 1618bcea973SRichard Lowe if not p: 1628bcea973SRichard Lowe sys.stderr.write("Failed building file-list from git\n") 1638bcea973SRichard Lowe sys.exit(err) 1648bcea973SRichard Lowe 1658bcea973SRichard Lowe ret = set() 1668bcea973SRichard Lowe for fname in p: 1678bcea973SRichard Lowe if fname and not fname.isspace() and fname not in ret: 1688bcea973SRichard Lowe ret.add(fname.strip()) 1698bcea973SRichard Lowe 1708bcea973SRichard Lowe return ret 1718bcea973SRichard Lowe 1728bcea973SRichard Lowe 1738bcea973SRichard Lowedef not_check(root, cmd): 1748bcea973SRichard Lowe """Return a function which returns True if a file given as an argument 1758bcea973SRichard Lowe should be excluded from the check named by 'cmd'""" 1768bcea973SRichard Lowe 1778bcea973SRichard Lowe ignorefiles = filter(os.path.exists, 1788bcea973SRichard Lowe [os.path.join(root, ".git", "%s.NOT" % cmd), 1798bcea973SRichard Lowe os.path.join(root, "exception_lists", cmd)]) 1808bcea973SRichard Lowe if len(ignorefiles) > 0: 1818bcea973SRichard Lowe return ignore.ignore(root, ignorefiles, sys.stderr.write) 1828bcea973SRichard Lowe else: 1838bcea973SRichard Lowe return lambda x: False 1848bcea973SRichard Lowe 1858bcea973SRichard Lowe 1868bcea973SRichard Lowedef gen_files(root, parent, paths, exclude): 1878bcea973SRichard Lowe """Return a function producing file names, relative to the current 1888bcea973SRichard Lowe directory, of any file changed on this branch (limited to 'paths' if 1898bcea973SRichard Lowe requested), and excluding files for which exclude returns a true value """ 1908bcea973SRichard Lowe 1918bcea973SRichard Lowe # Taken entirely from Python 2.6's os.path.relpath which we would use if we 1928bcea973SRichard Lowe # could. 1938bcea973SRichard Lowe def relpath(path, here): 1948bcea973SRichard Lowe c = os.path.abspath(os.path.join(root, path)).split(os.path.sep) 1958bcea973SRichard Lowe s = os.path.abspath(here).split(os.path.sep) 1968bcea973SRichard Lowe l = len(os.path.commonprefix((s, c))) 1978bcea973SRichard Lowe return os.path.join(*[os.path.pardir] * (len(s)-l) + c[l:]) 1988bcea973SRichard Lowe 1998bcea973SRichard Lowe def ret(select=None): 2008bcea973SRichard Lowe if not select: 2018bcea973SRichard Lowe select = lambda x: True 2028bcea973SRichard Lowe 2038bcea973SRichard Lowe for f in git_file_list(parent, paths): 2048bcea973SRichard Lowe f = relpath(f, '.') 2058bcea973SRichard Lowe if (os.path.exists(f) and select(f) and not exclude(f)): 2068bcea973SRichard Lowe yield f 2078bcea973SRichard Lowe return ret 2088bcea973SRichard Lowe 2098bcea973SRichard Lowe 2108bcea973SRichard Lowedef comchk(root, parent, flist, output): 2118bcea973SRichard Lowe output.write("Comments:\n") 2128bcea973SRichard Lowe 2138bcea973SRichard Lowe return Comments.comchk(git_comments(parent), check_db=True, 2148bcea973SRichard Lowe output=output) 2158bcea973SRichard Lowe 2168bcea973SRichard Lowe 2178bcea973SRichard Lowedef mapfilechk(root, parent, flist, output): 2188bcea973SRichard Lowe ret = 0 2198bcea973SRichard Lowe 2208bcea973SRichard Lowe # We are interested in examining any file that has the following 2218bcea973SRichard Lowe # in its final path segment: 2228bcea973SRichard Lowe # - Contains the word 'mapfile' 2238bcea973SRichard Lowe # - Begins with 'map.' 2248bcea973SRichard Lowe # - Ends with '.map' 2258bcea973SRichard Lowe # We don't want to match unless these things occur in final path segment 2268bcea973SRichard Lowe # because directory names with these strings don't indicate a mapfile. 2278bcea973SRichard Lowe # We also ignore files with suffixes that tell us that the files 2288bcea973SRichard Lowe # are not mapfiles. 2298bcea973SRichard Lowe MapfileRE = re.compile(r'.*((mapfile[^/]*)|(/map\.+[^/]*)|(\.map))$', 2308bcea973SRichard Lowe re.IGNORECASE) 2318bcea973SRichard Lowe NotMapSuffixRE = re.compile(r'.*\.[ch]$', re.IGNORECASE) 2328bcea973SRichard Lowe 2338bcea973SRichard Lowe output.write("Mapfile comments:\n") 2348bcea973SRichard Lowe 2358bcea973SRichard Lowe for f in flist(lambda x: MapfileRE.match(x) and not 2368bcea973SRichard Lowe NotMapSuffixRE.match(x)): 2378bcea973SRichard Lowe fh = open(f, 'r') 2388bcea973SRichard Lowe ret |= Mapfile.mapfilechk(fh, output=output) 2398bcea973SRichard Lowe fh.close() 2408bcea973SRichard Lowe return ret 2418bcea973SRichard Lowe 2428bcea973SRichard Lowe 2438bcea973SRichard Lowedef copyright(root, parent, flist, output): 2448bcea973SRichard Lowe ret = 0 2458bcea973SRichard Lowe output.write("Copyrights:\n") 2468bcea973SRichard Lowe for f in flist(): 2478bcea973SRichard Lowe fh = open(f, 'r') 2488bcea973SRichard Lowe ret |= Copyright.copyright(fh, output=output) 2498bcea973SRichard Lowe fh.close() 2508bcea973SRichard Lowe return ret 2518bcea973SRichard Lowe 2528bcea973SRichard Lowe 2538bcea973SRichard Lowedef hdrchk(root, parent, flist, output): 2548bcea973SRichard Lowe ret = 0 2558bcea973SRichard Lowe output.write("Header format:\n") 2568bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.h')): 2578bcea973SRichard Lowe fh = open(f, 'r') 2588bcea973SRichard Lowe ret |= HdrChk.hdrchk(fh, lenient=True, output=output) 2598bcea973SRichard Lowe fh.close() 2608bcea973SRichard Lowe return ret 2618bcea973SRichard Lowe 2628bcea973SRichard Lowe 2638bcea973SRichard Lowedef cstyle(root, parent, flist, output): 2648bcea973SRichard Lowe ret = 0 2658bcea973SRichard Lowe output.write("C style:\n") 2668bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.c') or x.endswith('.h')): 2678bcea973SRichard Lowe fh = open(f, 'r') 2688bcea973SRichard Lowe ret |= CStyle.cstyle(fh, output=output, picky=True, 2698bcea973SRichard Lowe check_posix_types=True, 2708bcea973SRichard Lowe check_continuation=True) 2718bcea973SRichard Lowe fh.close() 2728bcea973SRichard Lowe return ret 2738bcea973SRichard Lowe 2748bcea973SRichard Lowe 2758bcea973SRichard Lowedef jstyle(root, parent, flist, output): 2768bcea973SRichard Lowe ret = 0 2778bcea973SRichard Lowe output.write("Java style:\n") 2788bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.java')): 2798bcea973SRichard Lowe fh = open(f, 'r') 2808bcea973SRichard Lowe ret |= JStyle.jstyle(fh, output=output, picky=True) 2818bcea973SRichard Lowe fh.close() 2828bcea973SRichard Lowe return ret 2838bcea973SRichard Lowe 2848bcea973SRichard Lowe 2858bcea973SRichard Lowedef keywords(root, parent, flist, output): 2868bcea973SRichard Lowe ret = 0 2878bcea973SRichard Lowe output.write("SCCS Keywords:\n") 2888bcea973SRichard Lowe for f in flist(): 2898bcea973SRichard Lowe fh = open(f, 'r') 2908bcea973SRichard Lowe ret |= Keywords.keywords(fh, output=output) 2918bcea973SRichard Lowe fh.close() 2928bcea973SRichard Lowe return ret 2938bcea973SRichard Lowe 2948bcea973SRichard Lowe 2958bcea973SRichard Lowedef run_checks(root, parent, cmds, paths='', opts={}): 2968bcea973SRichard Lowe """Run the checks given in 'cmds', expected to have well-known signatures, 2978bcea973SRichard Lowe and report results for any which fail. 2988bcea973SRichard Lowe 2998bcea973SRichard Lowe Return failure if any of them did. 3008bcea973SRichard Lowe 3018bcea973SRichard Lowe NB: the function name of the commands passed in is used to name the NOT 3028bcea973SRichard Lowe file which excepts files from them.""" 3038bcea973SRichard Lowe 3048bcea973SRichard Lowe ret = 0 3058bcea973SRichard Lowe 3068bcea973SRichard Lowe for cmd in cmds: 3078bcea973SRichard Lowe s = StringIO() 3088bcea973SRichard Lowe 3098bcea973SRichard Lowe exclude = not_check(root, cmd.func_name) 3108bcea973SRichard Lowe result = cmd(root, parent, gen_files(root, parent, paths, exclude), 3118bcea973SRichard Lowe output=s) 3128bcea973SRichard Lowe ret |= result 3138bcea973SRichard Lowe 3148bcea973SRichard Lowe if result != 0: 3158bcea973SRichard Lowe print s.getvalue() 3168bcea973SRichard Lowe 3178bcea973SRichard Lowe return ret 3188bcea973SRichard Lowe 3198bcea973SRichard Lowe 3208bcea973SRichard Lowedef nits(root, parent, paths): 3218bcea973SRichard Lowe cmds = [copyright, 3228bcea973SRichard Lowe cstyle, 3238bcea973SRichard Lowe hdrchk, 3248bcea973SRichard Lowe jstyle, 3258bcea973SRichard Lowe keywords, 3268bcea973SRichard Lowe mapfilechk] 3278bcea973SRichard Lowe run_checks(root, parent, cmds, paths) 3288bcea973SRichard Lowe 3298bcea973SRichard Lowe 3308bcea973SRichard Lowedef pbchk(root, parent, paths): 3318bcea973SRichard Lowe cmds = [comchk, 3328bcea973SRichard Lowe copyright, 3338bcea973SRichard Lowe cstyle, 3348bcea973SRichard Lowe hdrchk, 3358bcea973SRichard Lowe jstyle, 3368bcea973SRichard Lowe keywords, 3378bcea973SRichard Lowe mapfilechk] 3388bcea973SRichard Lowe run_checks(root, parent, cmds) 3398bcea973SRichard Lowe 3408bcea973SRichard Lowe 3418bcea973SRichard Lowedef main(cmd, args): 3428bcea973SRichard Lowe parent_branch = None 3438bcea973SRichard Lowe 3448bcea973SRichard Lowe try: 3458bcea973SRichard Lowe opts, args = getopt.getopt(args, 'b:') 3468bcea973SRichard Lowe except getopt.GetoptError, e: 3478bcea973SRichard Lowe sys.stderr.write(str(e) + '\n') 3488bcea973SRichard Lowe sys.stderr.write("Usage: %s [-b branch] [path...]\n" % cmd) 3498bcea973SRichard Lowe sys.exit(1) 3508bcea973SRichard Lowe 3518bcea973SRichard Lowe for opt, arg in opts: 3528bcea973SRichard Lowe if opt == '-b': 3538bcea973SRichard Lowe parent_branch = arg 3548bcea973SRichard Lowe 3558bcea973SRichard Lowe if not parent_branch: 3568bcea973SRichard Lowe parent_branch = git_parent_branch(git_branch()) 3578bcea973SRichard Lowe 3588bcea973SRichard Lowe func = nits 3598bcea973SRichard Lowe if cmd == 'git-pbchk': 3608bcea973SRichard Lowe func = pbchk 3618bcea973SRichard Lowe if args: 3628bcea973SRichard Lowe sys.stderr.write("only complete workspaces may be pbchk'd\n"); 3638bcea973SRichard Lowe sys.exit(1) 3648bcea973SRichard Lowe 3658bcea973SRichard Lowe func(git_root(), parent_branch, args) 3668bcea973SRichard Lowe 3678bcea973SRichard Loweif __name__ == '__main__': 3688bcea973SRichard Lowe try: 3698bcea973SRichard Lowe main(os.path.basename(sys.argv[0]), sys.argv[1:]) 3708bcea973SRichard Lowe except GitError, e: 3718bcea973SRichard Lowe sys.stderr.write("failed to run git:\n %s\n" % str(e)) 3728bcea973SRichard Lowe sys.exit(1) 373