cppcheck/tools/extracttests.py

394 lines
13 KiB
Python
Raw Normal View History

#!/usr/bin/env python3
2013-01-10 11:10:45 +01:00
#
# Cppcheck - A tool for static C/C++ code analysis
2022-01-28 18:30:12 +01:00
# Copyright (C) 2007-2021 Cppcheck team.
2013-01-10 11:10:45 +01:00
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Extract test cases information from Cppcheck test
file
"""
import os
import sys
import re
2013-03-02 16:45:26 +01:00
def get_includes(code):
includes = (('alloca','alloca.h'),
('NULL','cstddef'),
('size_t','cstddef'),
('free','cstdlib'),
('malloc','cstdlib'),
('realloc','cstdlib'),
('memcpy','cstring'),
('stdin','cstdio'),
('strcat','cstring'),
('strchr','cstring'),
('strcpy','cstring'),
('strlen','cstring'),
('strncat','cstring'),
('strncpy','cstring'),
('std::cout','iostream'),
('std::pair','utility'),
('std::shared_ptr','memory'),
('std::string','string'),
('std::unique_ptr','memory'),
('std::vector','vector'))
ret = ''
for i in includes:
if i[0] in code:
2021-05-13 20:33:27 +02:00
include_header = '#include <%s>' % i[1]
if include_header not in ret:
ret += include_header + '\n'
return ret
def tweak_expected(expected, start_code):
if start_code is None or start_code == '':
return expected
res = re.match(r'[^(]*\[([^:\]]+):([0-9]+)\](.*)', expected)
if res is None:
return expected
lines = len(start_code[:-1].split('\n'))
return '[%s:%i]%s' % (res.group(1), lines + int(res.group(2)), res.group(3))
class Extract:
2013-10-18 17:35:59 +02:00
"""
Read Cppcheck test file and create data
representation
"""
# array that stores all the test cases
nodes = []
2013-03-02 16:45:26 +01:00
def parseFile(self, filename):
"""
parse test file and add info to the nodes
variable
"""
name = '[0-9a-zA-Z_]+'
2013-03-02 16:45:26 +01:00
string = '\\"(.+)\\"'
testclass = None
functionName = None
code = None
start_code = None
disable = False
for line in open(filename, 'r'):
# testclass starts
2013-10-18 17:35:59 +02:00
res = re.match('class (' + name + ')', line)
2013-03-02 16:45:26 +01:00
if res is not None:
testclass = res.group(1)
# end of testclass
2013-03-02 16:45:26 +01:00
if re.match('};', line) is not None:
testclass = None
# function start
2013-10-18 17:35:59 +02:00
res = re.match('\\s+void (' + name + ')\\(\\)', line)
2013-03-02 16:45:26 +01:00
if res is not None:
functionName = res.group(1)
start_code = None
2013-03-02 16:45:26 +01:00
elif re.match('\\s+}', line) is not None:
functionName = None
# extracttests commands..
res = re.match(r'\s*//\s*extracttests.start:(.*)', line)
if res is not None:
start_code = res.group(1).replace('\\n', '\n') + '\n'
elif line.find('extracttests.disable') >= 0:
disable = True
elif line.find('extracttests.enable') >= 0:
disable = False
if functionName is None or disable:
continue
# check
for f in check_function:
res = re.match('\\s+' + f + '\\(' + string, line)
if res is not None:
code = res.group(1)
break
# code..
if code is not None:
res = re.match('\\s+' + string, line)
if res is not None:
if line.find('",') > line.find('"'):
code = None
continue
code = code + res.group(1)
if res.group(1).find('"') > 0:
code = None
# assert
res = re.match('\\s+ASSERT_EQUALS\\(\\"([^"]*)\\",', line)
if res is not None and code is not None:
if start_code:
includes = get_includes(start_code + code)
code = includes + start_code + code
expected = tweak_expected(res.group(1), includes + start_code)
else:
includes = get_includes(code)
code = includes + code
expected = tweak_expected(res.group(1), includes)
2013-03-02 16:45:26 +01:00
node = {'testclass': testclass,
'functionName': functionName,
'code': code.replace("\\\\", "\\"),
'expected': expected}
self.nodes.append(node)
code = None
elif re.match('\\s+[TOD_]*ASSERT', line) is not None:
code = None
2013-03-02 16:45:26 +01:00
def strtoxml(s):
"""Convert string to xml/html format"""
2013-03-02 16:45:26 +01:00
return s.replace('&', '&amp;').replace('"', '&quot;').replace('<', '&lt;').replace('>', '&gt;')
def trimname(name):
"""Trim test name. Trailing underscore and digits are removed"""
while name[-1].isdigit():
name = name[:-1]
if name[-1] == '_':
name = name[:-1]
return name
def writeHtmlFile(nodes, functionName, filename, errorsOnly):
"""Write html file for a function name"""
fout = open(filename, 'w')
fout.write('<html>\n')
fout.write('<head>\n')
fout.write(' <style type="text/css">\n')
fout.write(' body { font-size: 0.8em }\n')
2013-10-18 17:35:59 +02:00
fout.write(
' th { background-color: #A3C159; text-transform: uppercase }\n')
fout.write(' td { background-color: white; vertical-align: text-top }\n')
fout.write(' pre { background-color: #EEEEEE }\n')
fout.write(' </style>\n')
fout.write('</head>\n')
fout.write('<body>\n')
fout.write('<a href="index.htm">Home</a> -- ')
if errorsOnly:
2013-10-18 17:35:59 +02:00
fout.write('<a href="all-' + functionName + '.htm">All test cases</a>')
else:
2013-10-18 17:35:59 +02:00
fout.write(
'<a href="errors-' + functionName + '.htm">Error test cases</a>')
fout.write('<br><br>')
testclass = None
num = 0
for node in nodes:
2013-03-02 16:45:26 +01:00
if errorsOnly and node['expected'] == '':
continue
if trimname(node['functionName']) == functionName:
num = num + 1
if not testclass:
testclass = node['testclass']
2013-10-18 17:35:59 +02:00
fout.write(
'<h1>' + node['testclass'] + '::' + functionName + '</h1>')
fout.write('<table border="0" cellspacing="0">\n')
2013-10-18 17:35:59 +02:00
fout.write(
' <tr><th>Nr</th><th>Code</th><th>Expected</th></tr>\n')
fout.write(' <tr><td>' + str(num) + '</td>')
2013-10-18 17:35:59 +02:00
fout.write('<td><pre>' + strtoxml(
node['code']).replace('\\n', '\n') + '</pre></td>')
fout.write(
'<td>' + strtoxml(node['expected']).replace('\\n', '<br>') + '</td>')
fout.write('</tr>\n')
2013-03-02 16:45:26 +01:00
if testclass is not None:
fout.write('</table>\n')
fout.write('</body></html>\n')
fout.close()
if len(sys.argv) <= 1 or '--help' in sys.argv:
2017-06-04 22:51:48 +02:00
print('Extract test cases from test file')
print(
'Syntax: extracttests.py [--html=folder] [--xml] [--code=folder] [--only-tp] [--check-function=check] path/testfile.cpp')
sys.exit(0)
# parse command line
xml = False
filename = None
htmldir = None
codedir = None
onlyTP = None
check_function = ['check[A-Za-z0-9_]*']
for arg in sys.argv[1:]:
if arg == '--xml':
xml = True
elif arg == '--only-tp':
onlyTP = True
elif arg.startswith('--html='):
htmldir = arg[7:]
elif arg.startswith('--code='):
codedir = arg[7:]
elif arg.endswith('.cpp'):
filename = arg
elif arg.startswith('--check-function='):
check_function.append(arg[17:])
else:
2017-06-04 22:51:48 +02:00
print('Invalid option: ' + arg)
sys.exit(1)
# extract test cases
2013-03-02 16:45:26 +01:00
if filename is not None:
# parse test file
e = Extract()
e.parseFile(filename)
# generate output
if xml:
2017-06-04 22:51:48 +02:00
print('<?xml version="1.0"?>')
print('<tree>')
count = 0
for node in e.nodes:
2013-10-18 17:35:59 +02:00
s = ' <node'
s += ' function="' + node['functionName'] + '"'
s += ' code="' + strtoxml(node['code']) + '"'
s += ' expected="' + strtoxml(node['expected']) + '"'
s += '/>'
2017-06-04 22:51:48 +02:00
print(s)
print('</tree>')
2013-03-02 16:45:26 +01:00
elif htmldir is not None:
if not htmldir.endswith('/'):
htmldir += '/'
if not os.path.exists(htmldir):
os.mkdir(htmldir)
findex = open(htmldir + 'index.htm', 'w')
findex.write('<html>\n')
findex.write('<head>\n')
findex.write(' <style type="text/css">\n')
findex.write(' table { font-size: 0.8em }\n')
2013-10-18 17:35:59 +02:00
findex.write(
' th { background-color: #A3C159; text-transform: uppercase }\n')
findex.write(
' td { background-color: #F0FFE0; vertical-align: text-top }\n')
findex.write(' A:link { text-decoration: none }\n')
findex.write(' A:visited { text-decoration: none }\n')
findex.write(' A:active { text-decoration: none }\n')
findex.write(' A:hover { text-decoration: underline; color: blue }\n')
findex.write(' </style>\n')
findex.write('</head>\n')
findex.write('<body>\n')
findex.write('<h1>' + filename + '</h1>\n')
functionNames = []
for node in e.nodes:
functionname = trimname(node['functionName'])
if functionname not in functionNames:
functionNames.append(functionname)
functionNames.sort()
findex.write('<table border="0" cellspacing="0">\n')
findex.write(' <tr><th>Name</th><th>Errors</th><th>All</th></tr>\n')
for functionname in functionNames:
2013-10-18 17:35:59 +02:00
findex.write(' <tr><td>' + functionname + '</td>')
numall = 0
numerr = 0
for node in e.nodes:
if trimname(node['functionName']) == functionname:
numall = numall + 1
if node['expected'] != '':
numerr = numerr + 1
if numerr == 0:
findex.write('<td><div align="right">0</div></td>')
else:
2013-10-18 17:35:59 +02:00
findex.write('<td><a href="errors-' + functionname +
'.htm"><div align="right">' + str(numerr) + '</div></a></td>')
findex.write('<td><a href="all-' + functionname +
'.htm"><div align="right">' + str(numall) + '</div></a></td>')
findex.write('</tr>\n')
findex.write('</table>\n')
findex.write('</body></html>')
findex.close()
# create files for each functionName
for functionName in functionNames:
writeHtmlFile(e.nodes,
functionName,
2011-11-27 13:49:20 +01:00
htmldir + 'errors-' + functionName + '.htm',
True)
writeHtmlFile(e.nodes,
functionName,
htmldir + 'all-' + functionName + '.htm',
False)
elif codedir:
testnum = 0
if not codedir.endswith('/'):
codedir = codedir + '/'
if not os.path.exists(codedir):
os.mkdir(codedir)
testfile = os.path.splitext(os.path.basename(filename))[0]
for node in e.nodes:
if onlyTP and node['expected'] == '':
continue
testnum = testnum + 1
functionName = node['functionName']
code = node['code']
code = code.replace('\\n', '\n')
code = code.replace('\\"', '"')
expected = node['expected']
if expected.endswith('\\n'):
expected = expected[:-2]
filename = '%s-%03i-%s.cpp' % (testfile, testnum, functionName)
# comment error
res = re.match(r'[^(]*\[([^:\]]+):([0-9]+)\]: \([a-z, ]+\) (.*)', expected)
if res:
line_number = int(res.group(2)) - 1
lines = code.split('\n')
if len(lines) > line_number:
lines[line_number] += ' // ' + res.group(3)
code = '\n'.join(lines)
else:
print('filename:%s expected:%s' % (filename, expected))
# source code
with open(codedir + filename, 'w') as fout:
fout.write(code + '\n')
else:
for node in e.nodes:
2017-06-04 22:51:48 +02:00
print(node['functionName'])