13f770aabSAndy Fiddaman#!@TOOLS_PYTHON@ -Es 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 20955eb5e1SGarrett D'Amore# Copyright 2019 Garrett D'Amore <garrett@damore.org> 2193d2a904SPaul Dagnelie# Copyright (c) 2015, 2016 by Delphix. All rights reserved. 2228e2b3adSHans Rosenfeld# Copyright 2016 Nexenta Systems, Inc. 23972282a0SJohn Levon# Copyright (c) 2019, Joyent, Inc. 2413904da8SAndy Fiddaman# Copyright 2021 OmniOS Community Edition (OmniOSce) Association. 25*8d226a82SBill Sommerfeld# Copyright 2023 Bill Sommerfeld 268bcea973SRichard Lowe# 278bcea973SRichard Lowe 28ca13eaa5SAndy Fiddamanfrom __future__ import print_function 29ca13eaa5SAndy Fiddaman 308bcea973SRichard Loweimport getopt 31ca13eaa5SAndy Fiddamanimport io 328bcea973SRichard Loweimport os 338bcea973SRichard Loweimport re 348bcea973SRichard Loweimport subprocess 358bcea973SRichard Loweimport sys 36ff50e8e5SRichard Loweimport tempfile 378bcea973SRichard Lowe 38ca13eaa5SAndy Fiddamanif sys.version_info[0] < 3: 398bcea973SRichard Lowe from cStringIO import StringIO 40ca13eaa5SAndy Fiddamanelse: 41ca13eaa5SAndy Fiddaman from io import StringIO 428bcea973SRichard Lowe 438bcea973SRichard Lowe# 448bcea973SRichard Lowe# Adjust the load path based on our location and the version of python into 458bcea973SRichard Lowe# which it is being loaded. This assumes the normal onbld directory 468bcea973SRichard Lowe# structure, where we are in bin/ and the modules are in 478bcea973SRichard Lowe# lib/python(version)?/onbld/Scm/. If that changes so too must this. 488bcea973SRichard Lowe# 498bcea973SRichard Lowesys.path.insert(1, os.path.join(os.path.dirname(__file__), "..", "lib", 508bcea973SRichard Lowe "python%d.%d" % sys.version_info[:2])) 518bcea973SRichard Lowe 528bcea973SRichard Lowe# 538bcea973SRichard Lowe# Add the relative path to usr/src/tools to the load path, such that when run 548bcea973SRichard Lowe# from the source tree we use the modules also within the source tree. 558bcea973SRichard Lowe# 568bcea973SRichard Lowesys.path.insert(2, os.path.join(os.path.dirname(__file__), "..")) 578bcea973SRichard Lowe 58e5587435SJoshua M. Clulowfrom onbld.Scm import Ignore 594ff15898SGordon Rossfrom onbld.Checks import Comments, Copyright, CStyle, HdrChk, WsCheck 6071af3be3SCody Peter Mellofrom onbld.Checks import JStyle, Keywords, ManLint, Mapfile, SpellCheck 6186d41711SAndy Fiddamanfrom onbld.Checks import ShellLint, PkgFmt 628bcea973SRichard Lowe 638bcea973SRichard Loweclass GitError(Exception): 648bcea973SRichard Lowe pass 658bcea973SRichard Lowe 668bcea973SRichard Lowedef git(command): 678bcea973SRichard Lowe """Run a command and return a stream containing its stdout (and write its 688bcea973SRichard Lowe stderr to its stdout)""" 698bcea973SRichard Lowe 708bcea973SRichard Lowe if type(command) != list: 718bcea973SRichard Lowe command = command.split() 728bcea973SRichard Lowe 738bcea973SRichard Lowe command = ["git"] + command 748bcea973SRichard Lowe 75ff50e8e5SRichard Lowe try: 76ca13eaa5SAndy Fiddaman tmpfile = tempfile.TemporaryFile(prefix="git-nits", mode="w+b") 77ca13eaa5SAndy Fiddaman except EnvironmentError as e: 78ff50e8e5SRichard Lowe raise GitError("Could not create temporary file: %s\n" % e) 79ff50e8e5SRichard Lowe 80ff50e8e5SRichard Lowe try: 818bcea973SRichard Lowe p = subprocess.Popen(command, 82ff50e8e5SRichard Lowe stdout=tmpfile, 83380fd671SMatthew Ahrens stderr=subprocess.PIPE) 84ca13eaa5SAndy Fiddaman except OSError as e: 85709afb1dSDillon Amburgey raise GitError("could not execute %s: %s\n" % (command, e)) 868bcea973SRichard Lowe 878bcea973SRichard Lowe err = p.wait() 888bcea973SRichard Lowe if err != 0: 89380fd671SMatthew Ahrens raise GitError(p.stderr.read()) 908bcea973SRichard Lowe 91ff50e8e5SRichard Lowe tmpfile.seek(0) 92ca13eaa5SAndy Fiddaman lines = [] 93ca13eaa5SAndy Fiddaman for l in tmpfile: 94ca13eaa5SAndy Fiddaman lines.append(l.decode('utf-8', 'replace')) 95ca13eaa5SAndy Fiddaman return lines 968bcea973SRichard Lowe 978bcea973SRichard Lowedef git_root(): 988bcea973SRichard Lowe """Return the root of the current git workspace""" 998bcea973SRichard Lowe 1008bcea973SRichard Lowe p = git('rev-parse --git-dir') 101ca13eaa5SAndy Fiddaman dir = p[0] 1028bcea973SRichard Lowe 103ca13eaa5SAndy Fiddaman return os.path.abspath(os.path.join(dir, os.path.pardir)) 1048bcea973SRichard Lowe 1058bcea973SRichard Lowedef git_branch(): 1068bcea973SRichard Lowe """Return the current git branch""" 1078bcea973SRichard Lowe 1088bcea973SRichard Lowe p = git('branch') 1098bcea973SRichard Lowe 1108bcea973SRichard Lowe for elt in p: 1118bcea973SRichard Lowe if elt[0] == '*': 1128bcea973SRichard Lowe if elt.endswith('(no branch)'): 1138bcea973SRichard Lowe return None 1148bcea973SRichard Lowe return elt.split()[1] 1158bcea973SRichard Lowe 1168bcea973SRichard Lowedef git_parent_branch(branch): 1178bcea973SRichard Lowe """Return the parent of the current git branch. 1188bcea973SRichard Lowe 1198bcea973SRichard Lowe If this branch tracks a remote branch, return the remote branch which is 1208bcea973SRichard Lowe tracked. If not, default to origin/master.""" 1218bcea973SRichard Lowe 1228bcea973SRichard Lowe if not branch: 1238bcea973SRichard Lowe return None 1248bcea973SRichard Lowe 12528e2b3adSHans Rosenfeld p = git(["for-each-ref", "--format=%(refname:short) %(upstream:short)", 12628e2b3adSHans Rosenfeld "refs/heads/"]) 1278bcea973SRichard Lowe 1288bcea973SRichard Lowe if not p: 1298bcea973SRichard Lowe sys.stderr.write("Failed finding git parent branch\n") 130972282a0SJohn Levon sys.exit(1) 1318bcea973SRichard Lowe 1328bcea973SRichard Lowe for line in p: 1338bcea973SRichard Lowe # Git 1.7 will leave a ' ' trailing any non-tracking branch 1348bcea973SRichard Lowe if ' ' in line and not line.endswith(' \n'): 1358bcea973SRichard Lowe local, remote = line.split() 1368bcea973SRichard Lowe if local == branch: 1378bcea973SRichard Lowe return remote 1388bcea973SRichard Lowe return 'origin/master' 1398bcea973SRichard Lowe 1408bcea973SRichard Lowedef git_comments(parent): 1418bcea973SRichard Lowe """Return a list of any checkin comments on this git branch""" 1428bcea973SRichard Lowe 14327495383SRichard Lowe p = git('log --pretty=tformat:%%B:SEP: %s..' % parent) 1448bcea973SRichard Lowe 1458bcea973SRichard Lowe if not p: 146972282a0SJohn Levon sys.stderr.write("No outgoing changesets found - missing -p option?\n"); 147972282a0SJohn Levon sys.exit(1) 1488bcea973SRichard Lowe 149ca13eaa5SAndy Fiddaman return [x.strip() for x in p if x != ':SEP:\n'] 1508bcea973SRichard Lowe 1518bcea973SRichard Lowedef git_file_list(parent, paths=None): 1528bcea973SRichard Lowe """Return the set of files which have ever changed on this branch. 1538bcea973SRichard Lowe 1548bcea973SRichard Lowe NB: This includes files which no longer exist, or no longer actually 1558bcea973SRichard Lowe differ.""" 1568bcea973SRichard Lowe 1578bcea973SRichard Lowe p = git("log --name-only --pretty=format: %s.. %s" % 1588bcea973SRichard Lowe (parent, ' '.join(paths))) 1598bcea973SRichard Lowe 1608bcea973SRichard Lowe if not p: 1618bcea973SRichard Lowe sys.stderr.write("Failed building file-list from git\n") 162972282a0SJohn Levon sys.exit(1) 1638bcea973SRichard Lowe 1648bcea973SRichard Lowe ret = set() 1658bcea973SRichard Lowe for fname in p: 16693d2a904SPaul Dagnelie if fname and not fname.isspace() and fname not in ret: 1678bcea973SRichard Lowe ret.add(fname.strip()) 1688bcea973SRichard Lowe 1698bcea973SRichard Lowe return ret 1708bcea973SRichard Lowe 1718bcea973SRichard Lowedef not_check(root, cmd): 1728bcea973SRichard Lowe """Return a function which returns True if a file given as an argument 1738bcea973SRichard Lowe should be excluded from the check named by 'cmd'""" 1748bcea973SRichard Lowe 175ca13eaa5SAndy Fiddaman ignorefiles = list(filter(os.path.exists, 176c82c4676SGordon Ross [os.path.join(root, ".git/info", "%s.NOT" % cmd), 177ca13eaa5SAndy Fiddaman os.path.join(root, "exception_lists", cmd)])) 178e5587435SJoshua M. Clulow return Ignore.ignore(root, ignorefiles) 1798bcea973SRichard Lowe 180955eb5e1SGarrett D'Amoredef gen_files(root, parent, paths, exclude, filter=None): 1818bcea973SRichard Lowe """Return a function producing file names, relative to the current 1828bcea973SRichard Lowe directory, of any file changed on this branch (limited to 'paths' if 1838bcea973SRichard Lowe requested), and excluding files for which exclude returns a true value """ 1848bcea973SRichard Lowe 185955eb5e1SGarrett D'Amore if filter is None: 186955eb5e1SGarrett D'Amore filter = lambda x: os.path.isfile(x) 187955eb5e1SGarrett D'Amore 1888bcea973SRichard Lowe # Taken entirely from Python 2.6's os.path.relpath which we would use if we 1898bcea973SRichard Lowe # could. 1908bcea973SRichard Lowe def relpath(path, here): 1918bcea973SRichard Lowe c = os.path.abspath(os.path.join(root, path)).split(os.path.sep) 1928bcea973SRichard Lowe s = os.path.abspath(here).split(os.path.sep) 1938bcea973SRichard Lowe l = len(os.path.commonprefix((s, c))) 1948bcea973SRichard Lowe return os.path.join(*[os.path.pardir] * (len(s)-l) + c[l:]) 1958bcea973SRichard Lowe 1968bcea973SRichard Lowe def ret(select=None): 1978bcea973SRichard Lowe if not select: 1988bcea973SRichard Lowe select = lambda x: True 1998bcea973SRichard Lowe 20038e36c53SJohn Levon for abspath in git_file_list(parent, paths): 20138e36c53SJohn Levon path = relpath(abspath, '.') 20293d2a904SPaul Dagnelie try: 20338e36c53SJohn Levon res = git("diff %s HEAD %s" % (parent, path)) 204ca13eaa5SAndy Fiddaman except GitError as e: 20538e36c53SJohn Levon # This ignores all the errors that can be thrown. Usually, this 20638e36c53SJohn Levon # means that git returned non-zero because the file doesn't 20738e36c53SJohn Levon # exist, but it could also fail if git can't create a new file 20838e36c53SJohn Levon # or it can't be executed. Such errors are 1) unlikely, and 2) 20938e36c53SJohn Levon # will be caught by other invocations of git(). 21093d2a904SPaul Dagnelie continue 211ca13eaa5SAndy Fiddaman empty = not res 212955eb5e1SGarrett D'Amore if (filter(path) and not empty and 21338e36c53SJohn Levon select(path) and not exclude(abspath)): 21438e36c53SJohn Levon yield path 2158bcea973SRichard Lowe return ret 2168bcea973SRichard Lowe 217955eb5e1SGarrett D'Amoredef gen_links(root, parent, paths, exclude): 218955eb5e1SGarrett D'Amore """Return a function producing symbolic link names, relative to the current 219955eb5e1SGarrett D'Amore directory, of any file changed on this branch (limited to 'paths' if 220955eb5e1SGarrett D'Amore requested), and excluding files for which exclude returns a true value """ 221955eb5e1SGarrett D'Amore 222955eb5e1SGarrett D'Amore return gen_files(root, parent, paths, exclude, lambda x: os.path.islink(x)) 223955eb5e1SGarrett D'Amore 2248bcea973SRichard Lowedef comchk(root, parent, flist, output): 2258bcea973SRichard Lowe output.write("Comments:\n") 2268bcea973SRichard Lowe 227*8d226a82SBill Sommerfeld comments = git_comments(parent) 228*8d226a82SBill Sommerfeld if len(comments) > 2: 229*8d226a82SBill Sommerfeld if re.match('^Change-Id: I[0-9a-f]+', comments[-1]): 230*8d226a82SBill Sommerfeld if comments[-2] == '': 231*8d226a82SBill Sommerfeld print('Note: Gerrit Change Id present in comments') 232*8d226a82SBill Sommerfeld comments = comments[:-2] 233*8d226a82SBill Sommerfeld 234*8d226a82SBill Sommerfeld return Comments.comchk(comments, check_db=True, 2358bcea973SRichard Lowe output=output) 2368bcea973SRichard Lowe 2378bcea973SRichard Lowe 2388bcea973SRichard Lowedef mapfilechk(root, parent, flist, output): 2398bcea973SRichard Lowe ret = 0 2408bcea973SRichard Lowe 2418bcea973SRichard Lowe # We are interested in examining any file that has the following 2428bcea973SRichard Lowe # in its final path segment: 2438bcea973SRichard Lowe # - Contains the word 'mapfile' 2448bcea973SRichard Lowe # - Begins with 'map.' 2458bcea973SRichard Lowe # - Ends with '.map' 2468bcea973SRichard Lowe # We don't want to match unless these things occur in final path segment 2478bcea973SRichard Lowe # because directory names with these strings don't indicate a mapfile. 2488bcea973SRichard Lowe # We also ignore files with suffixes that tell us that the files 2498bcea973SRichard Lowe # are not mapfiles. 2508bcea973SRichard Lowe MapfileRE = re.compile(r'.*((mapfile[^/]*)|(/map\.+[^/]*)|(\.map))$', 2518bcea973SRichard Lowe re.IGNORECASE) 2528bcea973SRichard Lowe NotMapSuffixRE = re.compile(r'.*\.[ch]$', re.IGNORECASE) 2538bcea973SRichard Lowe 2548bcea973SRichard Lowe output.write("Mapfile comments:\n") 2558bcea973SRichard Lowe 2568bcea973SRichard Lowe for f in flist(lambda x: MapfileRE.match(x) and not 2578bcea973SRichard Lowe NotMapSuffixRE.match(x)): 258ca13eaa5SAndy Fiddaman with io.open(f, encoding='utf-8', errors='replace') as fh: 2598bcea973SRichard Lowe ret |= Mapfile.mapfilechk(fh, output=output) 2608bcea973SRichard Lowe return ret 2618bcea973SRichard Lowe 2628bcea973SRichard Lowedef copyright(root, parent, flist, output): 2638bcea973SRichard Lowe ret = 0 2648bcea973SRichard Lowe output.write("Copyrights:\n") 2658bcea973SRichard Lowe for f in flist(): 266ca13eaa5SAndy Fiddaman with io.open(f, encoding='utf-8', errors='replace') as fh: 2678bcea973SRichard Lowe ret |= Copyright.copyright(fh, output=output) 2688bcea973SRichard Lowe return ret 2698bcea973SRichard Lowe 2708bcea973SRichard Lowedef hdrchk(root, parent, flist, output): 2718bcea973SRichard Lowe ret = 0 2728bcea973SRichard Lowe output.write("Header format:\n") 2738bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.h')): 274ca13eaa5SAndy Fiddaman with io.open(f, encoding='utf-8', errors='replace') as fh: 2758bcea973SRichard Lowe ret |= HdrChk.hdrchk(fh, lenient=True, output=output) 2768bcea973SRichard Lowe return ret 2778bcea973SRichard Lowe 2788bcea973SRichard Lowedef cstyle(root, parent, flist, output): 2798bcea973SRichard Lowe ret = 0 2808bcea973SRichard Lowe output.write("C style:\n") 2818bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.c') or x.endswith('.h')): 282a90997d2SAndy Fiddaman with io.open(f, mode='rb') as fh: 2838bcea973SRichard Lowe ret |= CStyle.cstyle(fh, output=output, picky=True, 2848bcea973SRichard Lowe check_posix_types=True, 2858bcea973SRichard Lowe check_continuation=True) 2868bcea973SRichard Lowe return ret 2878bcea973SRichard Lowe 2888bcea973SRichard Lowedef jstyle(root, parent, flist, output): 2898bcea973SRichard Lowe ret = 0 2908bcea973SRichard Lowe output.write("Java style:\n") 2918bcea973SRichard Lowe for f in flist(lambda x: x.endswith('.java')): 29210811751SAndy Fiddaman with io.open(f, mode='rb') as fh: 2938bcea973SRichard Lowe ret |= JStyle.jstyle(fh, output=output, picky=True) 2948bcea973SRichard Lowe return ret 2958bcea973SRichard Lowe 29695c635efSGarrett D'Amoredef manlint(root, parent, flist, output): 29795c635efSGarrett D'Amore ret = 0 29871af3be3SCody Peter Mello output.write("Man page format/spelling:\n") 29995c635efSGarrett D'Amore ManfileRE = re.compile(r'.*\.[0-9][a-z]*$', re.IGNORECASE) 30095c635efSGarrett D'Amore for f in flist(lambda x: ManfileRE.match(x)): 301a90997d2SAndy Fiddaman with io.open(f, mode='rb') as fh: 30295c635efSGarrett D'Amore ret |= ManLint.manlint(fh, output=output, picky=True) 30371af3be3SCody Peter Mello ret |= SpellCheck.spellcheck(fh, output=output) 30495c635efSGarrett D'Amore return ret 30595c635efSGarrett D'Amore 30613904da8SAndy Fiddamandef shelllint(root, parent, flist, output): 30713904da8SAndy Fiddaman ret = 0 30813904da8SAndy Fiddaman output.write("Shell lint:\n") 30913904da8SAndy Fiddaman 31013904da8SAndy Fiddaman def isshell(x): 31113904da8SAndy Fiddaman (_, ext) = os.path.splitext(x) 31213904da8SAndy Fiddaman if ext in ['.sh', '.ksh']: 31313904da8SAndy Fiddaman return True 31413904da8SAndy Fiddaman if ext == '': 31513904da8SAndy Fiddaman with io.open(x, mode='r', errors='ignore') as fh: 31613904da8SAndy Fiddaman if re.match(r'^#.*\bk?sh\b', fh.readline()): 31713904da8SAndy Fiddaman return True 31813904da8SAndy Fiddaman return False 31913904da8SAndy Fiddaman 32013904da8SAndy Fiddaman for f in flist(isshell): 32113904da8SAndy Fiddaman with io.open(f, mode='rb') as fh: 32213904da8SAndy Fiddaman ret |= ShellLint.lint(fh, output=output) 32313904da8SAndy Fiddaman 32413904da8SAndy Fiddaman return ret 32513904da8SAndy Fiddaman 32686d41711SAndy Fiddamandef pkgfmt(root, parent, flist, output): 32786d41711SAndy Fiddaman ret = 0 32886d41711SAndy Fiddaman output.write("Package manifests:\n") 32986d41711SAndy Fiddaman 33025b05a3eSAndy Fiddaman for f in flist(lambda x: x.endswith('.p5m')): 33186d41711SAndy Fiddaman with io.open(f, mode='rb') as fh: 33286d41711SAndy Fiddaman ret |= PkgFmt.check(fh, output=output) 33386d41711SAndy Fiddaman 33486d41711SAndy Fiddaman return ret 33586d41711SAndy Fiddaman 3368bcea973SRichard Lowedef keywords(root, parent, flist, output): 3378bcea973SRichard Lowe ret = 0 3388bcea973SRichard Lowe output.write("SCCS Keywords:\n") 3398bcea973SRichard Lowe for f in flist(): 340ca13eaa5SAndy Fiddaman with io.open(f, encoding='utf-8', errors='replace') as fh: 3418bcea973SRichard Lowe ret |= Keywords.keywords(fh, output=output) 3428bcea973SRichard Lowe return ret 3438bcea973SRichard Lowe 3444ff15898SGordon Rossdef wscheck(root, parent, flist, output): 3454ff15898SGordon Ross ret = 0 3464ff15898SGordon Ross output.write("white space nits:\n") 3474ff15898SGordon Ross for f in flist(): 348ca13eaa5SAndy Fiddaman with io.open(f, encoding='utf-8', errors='replace') as fh: 3494ff15898SGordon Ross ret |= WsCheck.wscheck(fh, output=output) 3504ff15898SGordon Ross return ret 3518bcea973SRichard Lowe 352955eb5e1SGarrett D'Amoredef symlinks(root, parent, flist, output): 353955eb5e1SGarrett D'Amore ret = 0 354955eb5e1SGarrett D'Amore output.write("Symbolic links:\n") 355955eb5e1SGarrett D'Amore for f in flist(): 356955eb5e1SGarrett D'Amore output.write(" "+f+"\n") 357955eb5e1SGarrett D'Amore ret |= 1 358955eb5e1SGarrett D'Amore return ret 359955eb5e1SGarrett D'Amore 360955eb5e1SGarrett D'Amoredef iswinreserved(name): 361955eb5e1SGarrett D'Amore reserved = [ 362955eb5e1SGarrett D'Amore 'con', 'prn', 'aux', 'nul', 363955eb5e1SGarrett D'Amore 'com1', 'com2', 'com3', 'com4', 'com5', 364955eb5e1SGarrett D'Amore 'com6', 'com7', 'com8', 'com9', 'com0', 365955eb5e1SGarrett D'Amore 'lpt1', 'lpt2', 'lpt3', 'lpt4', 'lpt5', 366955eb5e1SGarrett D'Amore 'lpt6', 'lpt7', 'lpt8', 'lpt9', 'lpt0' ] 367955eb5e1SGarrett D'Amore l = name.lower() 368955eb5e1SGarrett D'Amore for r in reserved: 369955eb5e1SGarrett D'Amore if l == r or l.startswith(r+"."): 370955eb5e1SGarrett D'Amore return True 371955eb5e1SGarrett D'Amore return False 372955eb5e1SGarrett D'Amore 373955eb5e1SGarrett D'Amoredef haswinspecial(name): 374955eb5e1SGarrett D'Amore specials = '<>:"\\|?*' 375955eb5e1SGarrett D'Amore for c in name: 376955eb5e1SGarrett D'Amore if c in specials: 377955eb5e1SGarrett D'Amore return True 378955eb5e1SGarrett D'Amore return False 379955eb5e1SGarrett D'Amore 380955eb5e1SGarrett D'Amoredef winnames(root, parent, flist, output): 381955eb5e1SGarrett D'Amore ret = 0 382955eb5e1SGarrett D'Amore output.write("Illegal filenames (Windows):\n") 383955eb5e1SGarrett D'Amore for f in flist(): 384955eb5e1SGarrett D'Amore if haswinspecial(f): 385955eb5e1SGarrett D'Amore output.write(" "+f+": invalid character in name\n") 386955eb5e1SGarrett D'Amore ret |= 1 387955eb5e1SGarrett D'Amore continue 388955eb5e1SGarrett D'Amore 389955eb5e1SGarrett D'Amore parts = f.split('/') 390955eb5e1SGarrett D'Amore for p in parts: 391955eb5e1SGarrett D'Amore if iswinreserved(p): 392955eb5e1SGarrett D'Amore output.write(" "+f+": reserved file name\n") 393955eb5e1SGarrett D'Amore ret |= 1 394955eb5e1SGarrett D'Amore break 395955eb5e1SGarrett D'Amore 396955eb5e1SGarrett D'Amore return ret 397955eb5e1SGarrett D'Amore 398955eb5e1SGarrett D'Amoredef run_checks(root, parent, cmds, scmds, paths='', opts={}): 3998bcea973SRichard Lowe """Run the checks given in 'cmds', expected to have well-known signatures, 4008bcea973SRichard Lowe and report results for any which fail. 4018bcea973SRichard Lowe 4028bcea973SRichard Lowe Return failure if any of them did. 4038bcea973SRichard Lowe 4048bcea973SRichard Lowe NB: the function name of the commands passed in is used to name the NOT 4058bcea973SRichard Lowe file which excepts files from them.""" 4068bcea973SRichard Lowe 4078bcea973SRichard Lowe ret = 0 4088bcea973SRichard Lowe 4098bcea973SRichard Lowe for cmd in cmds: 4108bcea973SRichard Lowe s = StringIO() 4118bcea973SRichard Lowe 412ca13eaa5SAndy Fiddaman exclude = not_check(root, cmd.__name__) 4138bcea973SRichard Lowe result = cmd(root, parent, gen_files(root, parent, paths, exclude), 4148bcea973SRichard Lowe output=s) 4158bcea973SRichard Lowe ret |= result 4168bcea973SRichard Lowe 4178bcea973SRichard Lowe if result != 0: 418ca13eaa5SAndy Fiddaman print(s.getvalue()) 4198bcea973SRichard Lowe 420955eb5e1SGarrett D'Amore for cmd in scmds: 421955eb5e1SGarrett D'Amore s = StringIO() 422955eb5e1SGarrett D'Amore 423955eb5e1SGarrett D'Amore exclude = not_check(root, cmd.__name__) 424955eb5e1SGarrett D'Amore result = cmd(root, parent, gen_links(root, parent, paths, exclude), 425955eb5e1SGarrett D'Amore output=s) 426955eb5e1SGarrett D'Amore ret |= result 427955eb5e1SGarrett D'Amore 428955eb5e1SGarrett D'Amore if result != 0: 429955eb5e1SGarrett D'Amore print(s.getvalue()) 430955eb5e1SGarrett D'Amore 4318bcea973SRichard Lowe return ret 4328bcea973SRichard Lowe 4338bcea973SRichard Lowedef nits(root, parent, paths): 4348bcea973SRichard Lowe cmds = [copyright, 4358bcea973SRichard Lowe cstyle, 4368bcea973SRichard Lowe hdrchk, 4378bcea973SRichard Lowe jstyle, 4388bcea973SRichard Lowe keywords, 43995c635efSGarrett D'Amore manlint, 4404ff15898SGordon Ross mapfilechk, 44113904da8SAndy Fiddaman shelllint, 44286d41711SAndy Fiddaman pkgfmt, 443955eb5e1SGarrett D'Amore winnames, 4444ff15898SGordon Ross wscheck] 445955eb5e1SGarrett D'Amore scmds = [symlinks] 446955eb5e1SGarrett D'Amore run_checks(root, parent, cmds, scmds, paths) 4478bcea973SRichard Lowe 4488bcea973SRichard Lowedef pbchk(root, parent, paths): 4498bcea973SRichard Lowe cmds = [comchk, 4508bcea973SRichard Lowe copyright, 4518bcea973SRichard Lowe cstyle, 4528bcea973SRichard Lowe hdrchk, 4538bcea973SRichard Lowe jstyle, 4548bcea973SRichard Lowe keywords, 45595c635efSGarrett D'Amore manlint, 4564ff15898SGordon Ross mapfilechk, 45713904da8SAndy Fiddaman shelllint, 45886d41711SAndy Fiddaman pkgfmt, 459955eb5e1SGarrett D'Amore winnames, 4604ff15898SGordon Ross wscheck] 461955eb5e1SGarrett D'Amore scmds = [symlinks] 462955eb5e1SGarrett D'Amore run_checks(root, parent, cmds, scmds) 4638bcea973SRichard Lowe 4648bcea973SRichard Lowedef main(cmd, args): 4658bcea973SRichard Lowe parent_branch = None 466eabe844aSJohn Levon checkname = None 4678bcea973SRichard Lowe 4688bcea973SRichard Lowe try: 46942a3762dSJoshua M. Clulow opts, args = getopt.getopt(args, 'b:c:p:') 470ca13eaa5SAndy Fiddaman except getopt.GetoptError as e: 4718bcea973SRichard Lowe sys.stderr.write(str(e) + '\n') 472eabe844aSJohn Levon sys.stderr.write("Usage: %s [-c check] [-p branch] [path...]\n" % cmd) 4738bcea973SRichard Lowe sys.exit(1) 4748bcea973SRichard Lowe 4758bcea973SRichard Lowe for opt, arg in opts: 47642a3762dSJoshua M. Clulow # We accept "-b" as an alias of "-p" for backwards compatibility. 47742a3762dSJoshua M. Clulow if opt == '-p' or opt == '-b': 4788bcea973SRichard Lowe parent_branch = arg 479eabe844aSJohn Levon elif opt == '-c': 480eabe844aSJohn Levon checkname = arg 4818bcea973SRichard Lowe 4828bcea973SRichard Lowe if not parent_branch: 4838bcea973SRichard Lowe parent_branch = git_parent_branch(git_branch()) 4848bcea973SRichard Lowe 485eabe844aSJohn Levon if checkname is None: 4868bcea973SRichard Lowe if cmd == 'git-pbchk': 487eabe844aSJohn Levon checkname = 'pbchk' 488eabe844aSJohn Levon else: 489eabe844aSJohn Levon checkname = 'nits' 490eabe844aSJohn Levon 491eabe844aSJohn Levon if checkname == 'pbchk': 4928bcea973SRichard Lowe if args: 4938bcea973SRichard Lowe sys.stderr.write("only complete workspaces may be pbchk'd\n"); 4948bcea973SRichard Lowe sys.exit(1) 495eabe844aSJohn Levon pbchk(git_root(), parent_branch, None) 496eabe844aSJohn Levon elif checkname == 'nits': 497eabe844aSJohn Levon nits(git_root(), parent_branch, args) 498eabe844aSJohn Levon else: 499eabe844aSJohn Levon run_checks(git_root(), parent_branch, [eval(checkname)], args) 5008bcea973SRichard Lowe 5018bcea973SRichard Loweif __name__ == '__main__': 5028bcea973SRichard Lowe try: 5038bcea973SRichard Lowe main(os.path.basename(sys.argv[0]), sys.argv[1:]) 504ca13eaa5SAndy Fiddaman except GitError as e: 5058bcea973SRichard Lowe sys.stderr.write("failed to run git:\n %s\n" % str(e)) 5068bcea973SRichard Lowe sys.exit(1) 507