2008-08-29 12:52:21 +00:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
2012-01-20 16:17:08 +00:00
|
|
|
# Copyright 2012 the V8 project authors. All rights reserved.
|
2008-08-29 12:52:21 +00:00
|
|
|
# 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.
|
|
|
|
|
2010-07-28 12:35:46 +00:00
|
|
|
try:
|
|
|
|
import hashlib
|
|
|
|
md5er = hashlib.md5
|
|
|
|
except ImportError, e:
|
|
|
|
import md5
|
|
|
|
md5er = md5.new
|
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
|
|
|
|
import optparse
|
|
|
|
import os
|
2009-09-11 12:21:48 +00:00
|
|
|
from os.path import abspath, join, dirname, basename, exists
|
2009-11-26 10:17:03 +00:00
|
|
|
import pickle
|
2008-09-09 20:08:45 +00:00
|
|
|
import re
|
2008-08-29 12:52:21 +00:00
|
|
|
import sys
|
|
|
|
import subprocess
|
2012-01-20 16:17:08 +00:00
|
|
|
import multiprocessing
|
2011-09-02 08:04:51 +00:00
|
|
|
from subprocess import PIPE
|
2008-08-29 12:52:21 +00:00
|
|
|
|
2009-04-09 20:07:30 +00:00
|
|
|
# Disabled LINT rules and reason.
|
|
|
|
# build/include_what_you_use: Started giving false positives for variables
|
|
|
|
# named "string" and "map" assuming that you needed to include STL headers.
|
2008-08-29 12:52:21 +00:00
|
|
|
|
|
|
|
ENABLED_LINT_RULES = """
|
|
|
|
build/class
|
|
|
|
build/deprecated
|
|
|
|
build/endif_comment
|
|
|
|
build/forward_decl
|
|
|
|
build/include_order
|
|
|
|
build/printf_format
|
|
|
|
build/storage_class
|
|
|
|
legal/copyright
|
|
|
|
readability/boost
|
|
|
|
readability/braces
|
|
|
|
readability/casting
|
|
|
|
readability/check
|
|
|
|
readability/constructors
|
|
|
|
readability/fn_size
|
|
|
|
readability/function
|
|
|
|
readability/multiline_comment
|
|
|
|
readability/multiline_string
|
|
|
|
readability/streams
|
|
|
|
readability/todo
|
|
|
|
readability/utf8
|
|
|
|
runtime/arrays
|
|
|
|
runtime/casting
|
|
|
|
runtime/deprecated_fn
|
|
|
|
runtime/explicit
|
|
|
|
runtime/int
|
|
|
|
runtime/memset
|
|
|
|
runtime/mutex
|
|
|
|
runtime/nonconf
|
|
|
|
runtime/printf
|
|
|
|
runtime/printf_format
|
|
|
|
runtime/references
|
|
|
|
runtime/rtti
|
|
|
|
runtime/sizeof
|
|
|
|
runtime/string
|
|
|
|
runtime/virtual
|
|
|
|
runtime/vlog
|
|
|
|
whitespace/blank_line
|
|
|
|
whitespace/braces
|
|
|
|
whitespace/comma
|
|
|
|
whitespace/comments
|
|
|
|
whitespace/ending_newline
|
|
|
|
whitespace/indent
|
|
|
|
whitespace/labels
|
|
|
|
whitespace/line_length
|
|
|
|
whitespace/newline
|
|
|
|
whitespace/operators
|
|
|
|
whitespace/parens
|
|
|
|
whitespace/tab
|
|
|
|
whitespace/todo
|
|
|
|
""".split()
|
|
|
|
|
|
|
|
|
2012-01-20 16:17:08 +00:00
|
|
|
LINT_OUTPUT_PATTERN = re.compile(r'^.+[:(]\d+[:)]|^Done processing')
|
|
|
|
|
|
|
|
|
|
|
|
def CppLintWorker(command):
|
|
|
|
try:
|
|
|
|
process = subprocess.Popen(command, stderr=subprocess.PIPE)
|
|
|
|
process.wait()
|
|
|
|
out_lines = ""
|
|
|
|
error_count = -1
|
|
|
|
while True:
|
|
|
|
out_line = process.stderr.readline()
|
|
|
|
if out_line == '' and process.poll() != None:
|
2012-04-19 10:28:26 +00:00
|
|
|
if error_count == -1:
|
|
|
|
print "Failed to process %s" % command.pop()
|
|
|
|
return 1
|
2012-01-20 16:17:08 +00:00
|
|
|
break
|
|
|
|
m = LINT_OUTPUT_PATTERN.match(out_line)
|
|
|
|
if m:
|
|
|
|
out_lines += out_line
|
|
|
|
error_count += 1
|
2012-04-19 10:28:26 +00:00
|
|
|
sys.stdout.write(out_lines)
|
2012-01-20 16:17:08 +00:00
|
|
|
return error_count
|
|
|
|
except KeyboardInterrupt:
|
|
|
|
process.kill()
|
|
|
|
except:
|
|
|
|
print('Error running cpplint.py. Please make sure you have depot_tools' +
|
|
|
|
' in your $PATH. Lint check skipped.')
|
|
|
|
process.kill()
|
|
|
|
|
|
|
|
|
2009-11-26 10:17:03 +00:00
|
|
|
class FileContentsCache(object):
|
|
|
|
|
|
|
|
def __init__(self, sums_file_name):
|
|
|
|
self.sums = {}
|
|
|
|
self.sums_file_name = sums_file_name
|
|
|
|
|
|
|
|
def Load(self):
|
|
|
|
try:
|
|
|
|
sums_file = None
|
|
|
|
try:
|
|
|
|
sums_file = open(self.sums_file_name, 'r')
|
|
|
|
self.sums = pickle.load(sums_file)
|
|
|
|
except IOError:
|
|
|
|
# File might not exist, this is OK.
|
|
|
|
pass
|
|
|
|
finally:
|
|
|
|
if sums_file:
|
|
|
|
sums_file.close()
|
|
|
|
|
|
|
|
def Save(self):
|
|
|
|
try:
|
|
|
|
sums_file = open(self.sums_file_name, 'w')
|
|
|
|
pickle.dump(self.sums, sums_file)
|
|
|
|
finally:
|
|
|
|
sums_file.close()
|
|
|
|
|
|
|
|
def FilterUnchangedFiles(self, files):
|
|
|
|
changed_or_new = []
|
|
|
|
for file in files:
|
|
|
|
try:
|
|
|
|
handle = open(file, "r")
|
2010-07-28 12:35:46 +00:00
|
|
|
file_sum = md5er(handle.read()).digest()
|
2009-11-26 10:17:03 +00:00
|
|
|
if not file in self.sums or self.sums[file] != file_sum:
|
|
|
|
changed_or_new.append(file)
|
|
|
|
self.sums[file] = file_sum
|
|
|
|
finally:
|
|
|
|
handle.close()
|
|
|
|
return changed_or_new
|
|
|
|
|
|
|
|
def RemoveFile(self, file):
|
|
|
|
if file in self.sums:
|
|
|
|
self.sums.pop(file)
|
|
|
|
|
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
class SourceFileProcessor(object):
|
|
|
|
"""
|
|
|
|
Utility class that can run through a directory structure, find all relevant
|
|
|
|
files and invoke a custom check on the files.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def Run(self, path):
|
|
|
|
all_files = []
|
|
|
|
for file in self.GetPathsToSearch():
|
|
|
|
all_files += self.FindFilesIn(join(path, file))
|
2009-09-11 12:21:48 +00:00
|
|
|
if not self.ProcessFiles(all_files, path):
|
2008-08-29 12:52:21 +00:00
|
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
|
|
def IgnoreDir(self, name):
|
2009-11-12 12:11:40 +00:00
|
|
|
return name.startswith('.') or name == 'data' or name == 'sputniktests'
|
2008-08-29 12:52:21 +00:00
|
|
|
|
|
|
|
def IgnoreFile(self, name):
|
|
|
|
return name.startswith('.')
|
|
|
|
|
|
|
|
def FindFilesIn(self, path):
|
|
|
|
result = []
|
|
|
|
for (root, dirs, files) in os.walk(path):
|
|
|
|
for ignored in [x for x in dirs if self.IgnoreDir(x)]:
|
|
|
|
dirs.remove(ignored)
|
|
|
|
for file in files:
|
|
|
|
if not self.IgnoreFile(file) and self.IsRelevant(file):
|
|
|
|
result.append(join(root, file))
|
|
|
|
return result
|
|
|
|
|
|
|
|
|
|
|
|
class CppLintProcessor(SourceFileProcessor):
|
|
|
|
"""
|
|
|
|
Lint files to check that they follow the google code style.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def IsRelevant(self, name):
|
|
|
|
return name.endswith('.cc') or name.endswith('.h')
|
|
|
|
|
|
|
|
def IgnoreDir(self, name):
|
|
|
|
return (super(CppLintProcessor, self).IgnoreDir(name)
|
|
|
|
or (name == 'third_party'))
|
|
|
|
|
2008-09-17 08:47:50 +00:00
|
|
|
IGNORE_LINT = ['flag-definitions.h']
|
2009-11-26 10:17:03 +00:00
|
|
|
|
2008-09-17 08:47:50 +00:00
|
|
|
def IgnoreFile(self, name):
|
|
|
|
return (super(CppLintProcessor, self).IgnoreFile(name)
|
|
|
|
or (name in CppLintProcessor.IGNORE_LINT))
|
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
def GetPathsToSearch(self):
|
2010-11-24 09:57:06 +00:00
|
|
|
return ['src', 'preparser', 'include', 'samples', join('test', 'cctest')]
|
2008-08-29 12:52:21 +00:00
|
|
|
|
2009-09-11 12:21:48 +00:00
|
|
|
def ProcessFiles(self, files, path):
|
2009-11-26 10:17:03 +00:00
|
|
|
good_files_cache = FileContentsCache('.cpplint-cache')
|
|
|
|
good_files_cache.Load()
|
|
|
|
files = good_files_cache.FilterUnchangedFiles(files)
|
|
|
|
if len(files) == 0:
|
|
|
|
print 'No changes in files detected. Skipping cpplint check.'
|
|
|
|
return True
|
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
filt = '-,' + ",".join(['+' + n for n in ENABLED_LINT_RULES])
|
2012-01-20 16:17:08 +00:00
|
|
|
command = ['cpplint.py', '--filter', filt]
|
2009-09-11 12:21:48 +00:00
|
|
|
local_cpplint = join(path, "tools", "cpplint.py")
|
|
|
|
if exists(local_cpplint):
|
2012-01-20 16:17:08 +00:00
|
|
|
command = ['python', local_cpplint, '--filter', filt]
|
2009-11-26 10:17:03 +00:00
|
|
|
|
2012-01-20 16:17:08 +00:00
|
|
|
commands = join([command + [file] for file in files])
|
|
|
|
count = multiprocessing.cpu_count()
|
|
|
|
pool = multiprocessing.Pool(count)
|
2011-10-06 11:08:41 +00:00
|
|
|
try:
|
2012-01-20 16:17:08 +00:00
|
|
|
results = pool.map_async(CppLintWorker, commands).get(999999)
|
|
|
|
except KeyboardInterrupt:
|
|
|
|
print "\nCaught KeyboardInterrupt, terminating workers."
|
|
|
|
sys.exit(1)
|
|
|
|
|
|
|
|
for i in range(len(files)):
|
|
|
|
if results[i] > 0:
|
|
|
|
good_files_cache.RemoveFile(files[i])
|
2009-11-26 10:17:03 +00:00
|
|
|
|
2012-01-20 16:17:08 +00:00
|
|
|
total_errors = sum(results)
|
|
|
|
print "Total errors found: %d" % total_errors
|
2009-11-26 10:17:03 +00:00
|
|
|
good_files_cache.Save()
|
2012-01-20 16:17:08 +00:00
|
|
|
return total_errors == 0
|
2008-08-29 12:52:21 +00:00
|
|
|
|
|
|
|
|
2008-09-09 20:08:45 +00:00
|
|
|
COPYRIGHT_HEADER_PATTERN = re.compile(
|
2010-01-07 10:01:24 +00:00
|
|
|
r'Copyright [\d-]*20[0-1][0-9] the V8 project authors. All rights reserved.')
|
2008-09-09 20:08:45 +00:00
|
|
|
|
|
|
|
class SourceProcessor(SourceFileProcessor):
|
2008-08-29 12:52:21 +00:00
|
|
|
"""
|
2011-09-01 11:28:10 +00:00
|
|
|
Check that all files include a copyright notice and no trailing whitespaces.
|
2008-08-29 12:52:21 +00:00
|
|
|
"""
|
|
|
|
|
|
|
|
RELEVANT_EXTENSIONS = ['.js', '.cc', '.h', '.py', '.c', 'SConscript',
|
2011-09-01 11:28:10 +00:00
|
|
|
'SConstruct', '.status', '.gyp', '.gypi']
|
|
|
|
|
2011-09-02 08:04:51 +00:00
|
|
|
# Overwriting the one in the parent class.
|
|
|
|
def FindFilesIn(self, path):
|
|
|
|
if os.path.exists(path+'/.git'):
|
|
|
|
output = subprocess.Popen('git ls-files --full-name',
|
|
|
|
stdout=PIPE, cwd=path, shell=True)
|
|
|
|
result = []
|
|
|
|
for file in output.stdout.read().split():
|
|
|
|
for dir_part in os.path.dirname(file).split(os.sep):
|
|
|
|
if self.IgnoreDir(dir_part):
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
if self.IsRelevant(file) and not self.IgnoreFile(file):
|
|
|
|
result.append(join(path, file))
|
|
|
|
if output.wait() == 0:
|
|
|
|
return result
|
|
|
|
return super(SourceProcessor, self).FindFilesIn(path)
|
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
def IsRelevant(self, name):
|
2008-09-09 20:08:45 +00:00
|
|
|
for ext in SourceProcessor.RELEVANT_EXTENSIONS:
|
2008-08-29 12:52:21 +00:00
|
|
|
if name.endswith(ext):
|
|
|
|
return True
|
|
|
|
return False
|
|
|
|
|
|
|
|
def GetPathsToSearch(self):
|
|
|
|
return ['.']
|
|
|
|
|
2008-09-09 20:08:45 +00:00
|
|
|
def IgnoreDir(self, name):
|
|
|
|
return (super(SourceProcessor, self).IgnoreDir(name)
|
|
|
|
or (name == 'third_party')
|
2011-08-09 13:45:54 +00:00
|
|
|
or (name == 'gyp')
|
|
|
|
or (name == 'out')
|
2008-09-09 20:08:45 +00:00
|
|
|
or (name == 'obj'))
|
|
|
|
|
2011-08-09 13:45:54 +00:00
|
|
|
IGNORE_COPYRIGHTS = ['cpplint.py',
|
|
|
|
'earley-boyer.js',
|
|
|
|
'raytrace.js',
|
|
|
|
'crypto.js',
|
|
|
|
'libraries.cc',
|
|
|
|
'libraries-empty.cc',
|
|
|
|
'jsmin.py',
|
|
|
|
'regexp-pcre.js']
|
|
|
|
IGNORE_TABS = IGNORE_COPYRIGHTS + ['unicode-test.js', 'html-comments.js']
|
2008-09-09 20:08:45 +00:00
|
|
|
|
2008-08-29 12:52:21 +00:00
|
|
|
def ProcessContents(self, name, contents):
|
2008-09-09 20:08:45 +00:00
|
|
|
result = True
|
|
|
|
base = basename(name)
|
|
|
|
if not base in SourceProcessor.IGNORE_TABS:
|
|
|
|
if '\t' in contents:
|
|
|
|
print "%s contains tabs" % name
|
|
|
|
result = False
|
|
|
|
if not base in SourceProcessor.IGNORE_COPYRIGHTS:
|
|
|
|
if not COPYRIGHT_HEADER_PATTERN.search(contents):
|
|
|
|
print "%s is missing a correct copyright header." % name
|
|
|
|
result = False
|
2011-09-01 11:28:10 +00:00
|
|
|
ext = base.split('.').pop()
|
|
|
|
if ' \n' in contents or contents.endswith(' '):
|
|
|
|
line = 0
|
|
|
|
lines = []
|
|
|
|
parts = contents.split(' \n')
|
|
|
|
if not contents.endswith(' '):
|
|
|
|
parts.pop()
|
|
|
|
for part in parts:
|
|
|
|
line += part.count('\n') + 1
|
|
|
|
lines.append(str(line))
|
|
|
|
linenumbers = ', '.join(lines)
|
|
|
|
if len(lines) > 1:
|
|
|
|
print "%s has trailing whitespaces in lines %s." % (name, linenumbers)
|
|
|
|
else:
|
|
|
|
print "%s has trailing whitespaces in line %s." % (name, linenumbers)
|
|
|
|
result = False
|
2008-09-09 20:08:45 +00:00
|
|
|
return result
|
2008-08-29 12:52:21 +00:00
|
|
|
|
2009-09-11 12:21:48 +00:00
|
|
|
def ProcessFiles(self, files, path):
|
2008-08-29 12:52:21 +00:00
|
|
|
success = True
|
2011-09-07 15:17:18 +00:00
|
|
|
violations = 0
|
2008-08-29 12:52:21 +00:00
|
|
|
for file in files:
|
|
|
|
try:
|
|
|
|
handle = open(file)
|
|
|
|
contents = handle.read()
|
2011-09-07 15:17:18 +00:00
|
|
|
if not self.ProcessContents(file, contents):
|
|
|
|
success = False
|
|
|
|
violations += 1
|
2008-08-29 12:52:21 +00:00
|
|
|
finally:
|
|
|
|
handle.close()
|
2011-09-07 15:17:18 +00:00
|
|
|
print "Total violating files: %s" % violations
|
2008-08-29 12:52:21 +00:00
|
|
|
return success
|
|
|
|
|
|
|
|
|
|
|
|
def GetOptions():
|
|
|
|
result = optparse.OptionParser()
|
|
|
|
result.add_option('--no-lint', help="Do not run cpplint", default=False,
|
|
|
|
action="store_true")
|
|
|
|
return result
|
|
|
|
|
|
|
|
|
|
|
|
def Main():
|
|
|
|
workspace = abspath(join(dirname(sys.argv[0]), '..'))
|
|
|
|
parser = GetOptions()
|
|
|
|
(options, args) = parser.parse_args()
|
|
|
|
success = True
|
2011-09-07 15:17:18 +00:00
|
|
|
print "Running C++ lint check..."
|
2008-08-29 12:52:21 +00:00
|
|
|
if not options.no_lint:
|
|
|
|
success = CppLintProcessor().Run(workspace) and success
|
2011-09-07 15:17:18 +00:00
|
|
|
print "Running copyright header and trailing whitespaces check..."
|
2008-09-09 20:08:45 +00:00
|
|
|
success = SourceProcessor().Run(workspace) and success
|
2008-08-29 12:52:21 +00:00
|
|
|
if success:
|
|
|
|
return 0
|
|
|
|
else:
|
|
|
|
return 1
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
|
sys.exit(Main())
|