Added a new naming check addon. Also verifies variable and function p… (#1456)
* Added a new naming check addon. Also verifies variable and function prefixes * Verification added to code * added naming checks ng selftest to travis file * Ensure zero exit value for tests if tests succeed * Expected values adjusted * Fixed copy and paste error
This commit is contained in:
Thorsten Sick
Daniel Marjamäki
parent
35d18be311
commit
43b6a391d8
|
|
@ -140,6 +140,11 @@ script:
|
||||||
- ${CPPCHECK} --dump misra-test.cpp
|
- ${CPPCHECK} --dump misra-test.cpp
|
||||||
- python3 ../misra.py -verify misra-test.cpp.dump
|
- python3 ../misra.py -verify misra-test.cpp.dump
|
||||||
- cd ../../
|
- cd ../../
|
||||||
|
# check addons/namingng.py
|
||||||
|
- cd addons/test
|
||||||
|
- ${CPPCHECK} --dump namingng_test.c
|
||||||
|
- python3 ../namingng.py --configfile ../naming.json --verify namingng_test.c.dump
|
||||||
|
- cd ../..
|
||||||
|
|
||||||
|
|
||||||
notifications:
|
notifications:
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
{
|
||||||
|
"RE_VARNAME": "[a-z]*[a-zA-Z0-9_]*\\Z",
|
||||||
|
"RE_PRIVATE_MEMBER_VARIABLE": null,
|
||||||
|
"RE_FUNCTIONNAME": "[a-z0-9A-Z]*\\Z",
|
||||||
|
"var_prefixes": {"uint32_t": "ui32",
|
||||||
|
"int*": "intp"},
|
||||||
|
"function_prefixes": {"uint16_t": "ui16",
|
||||||
|
"uint32_t": "ui32"},
|
||||||
|
"skip_one_char_variables": false
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,165 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
#
|
||||||
|
# cppcheck addon for naming conventions
|
||||||
|
# An enhanced version. Configuration is taken from a json file
|
||||||
|
# It supports to check for type-based prefixes in function or variable names.
|
||||||
|
#
|
||||||
|
# Example usage (variable name must start with lowercase, function name must start with uppercase):
|
||||||
|
# $ cppcheck --dump path-to-src/
|
||||||
|
# $ python naming.py namingng.py test.c.dump
|
||||||
|
#
|
||||||
|
# JSON format:
|
||||||
|
#
|
||||||
|
# {
|
||||||
|
# "RE_VARNAME": "[a-z]*[a-zA-Z0-9_]*\\Z",
|
||||||
|
# "RE_PRIVATE_MEMBER_VARIABLE": null,
|
||||||
|
# "RE_FUNCTIONNAME": "[a-z0-9A-Z]*\\Z",
|
||||||
|
# "var_prefixes": {"uint32_t": "ui32"},
|
||||||
|
# "function_prefixes": {"uint16_t": "ui16",
|
||||||
|
# "uint32_t": "ui32"}
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
# RE_VARNAME, RE_PRIVATE_MEMBER_VARIABE and RE_FUNCTIONNAME are regular expressions to cover hte basic names
|
||||||
|
# In var_prefixes and function_prefixes there are the variable-type/prefix pairs
|
||||||
|
|
||||||
|
import cppcheckdata
|
||||||
|
import sys
|
||||||
|
import re
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
|
|
||||||
|
|
||||||
|
def reportError(filename, linenr, severity, msg):
|
||||||
|
message = "[{filename}:{linenr}] ( {severity} ) naming.py: {msg}\n".format(
|
||||||
|
filename=filename,
|
||||||
|
linenr=linenr,
|
||||||
|
severity=severity,
|
||||||
|
msg=msg
|
||||||
|
)
|
||||||
|
sys.stderr.write(message)
|
||||||
|
return message
|
||||||
|
|
||||||
|
|
||||||
|
def loadConfig(configfile):
|
||||||
|
with open(configfile) as fh:
|
||||||
|
data = json.load(fh)
|
||||||
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
def process(dumpfiles, configfile, debugprint=False):
|
||||||
|
|
||||||
|
errors = []
|
||||||
|
|
||||||
|
conf = loadConfig(configfile)
|
||||||
|
|
||||||
|
for afile in dumpfiles:
|
||||||
|
if not afile[-5:] == '.dump':
|
||||||
|
continue
|
||||||
|
print('Checking ' + afile + '...')
|
||||||
|
data = cppcheckdata.parsedump(afile)
|
||||||
|
for cfg in data.configurations:
|
||||||
|
if len(data.configurations) > 1:
|
||||||
|
print('Checking ' + afile + ', config "' + cfg.name + '"...')
|
||||||
|
if conf["RE_VARNAME"]:
|
||||||
|
for var in cfg.variables:
|
||||||
|
if var.nameToken:
|
||||||
|
prev = var.nameToken.previous
|
||||||
|
varType = prev.str
|
||||||
|
while "*" in varType and len(varType.replace("*", "")) == 0:
|
||||||
|
prev = prev.previous
|
||||||
|
varType = prev.str + varType
|
||||||
|
|
||||||
|
if debugprint:
|
||||||
|
print("Variable Name: " + str(var.nameToken.str))
|
||||||
|
print("original Type Name: " + str(var.nameToken.valueType.originalTypeName))
|
||||||
|
print("Type Name: " + var.nameToken.valueType.type)
|
||||||
|
print("Sign: " + str(var.nameToken.valueType.sign))
|
||||||
|
print("variable type: " + varType)
|
||||||
|
print("\n")
|
||||||
|
print("\t-- {} {}".format(varType, str(var.nameToken.str)))
|
||||||
|
|
||||||
|
if conf["skip_one_char_variables"] and len(var.nameToken.str) == 1:
|
||||||
|
continue
|
||||||
|
if varType in conf["var_prefixes"]:
|
||||||
|
if not var.nameToken.str.startswith(conf["var_prefixes"][varType]):
|
||||||
|
errors.append(reportError(
|
||||||
|
var.typeStartToken.file,
|
||||||
|
var.typeStartToken.linenr,
|
||||||
|
'style',
|
||||||
|
'Variable ' +
|
||||||
|
var.nameToken.str +
|
||||||
|
' violates naming convention'))
|
||||||
|
res = re.match(conf["RE_VARNAME"], var.nameToken.str)
|
||||||
|
if not res:
|
||||||
|
errors.append(reportError(var.typeStartToken.file, var.typeStartToken.linenr, 'style', 'Variable ' +
|
||||||
|
var.nameToken.str + ' violates naming convention'))
|
||||||
|
|
||||||
|
if conf["RE_PRIVATE_MEMBER_VARIABLE"]:
|
||||||
|
# TODO: Not converted yet
|
||||||
|
for var in cfg.variables:
|
||||||
|
if (var.access is None) or var.access != 'Private':
|
||||||
|
continue
|
||||||
|
res = re.match(conf["RE_PRIVATE_MEMBER_VARIABLE"], var.nameToken.str)
|
||||||
|
if not res:
|
||||||
|
errors.append(reportError(var.typeStartToken.file, var.typeStartToken.linenr, 'style', 'Private member variable ' +
|
||||||
|
var.nameToken.str + ' violates naming convention'))
|
||||||
|
|
||||||
|
if conf["RE_FUNCTIONNAME"]:
|
||||||
|
for token in cfg.tokenlist:
|
||||||
|
if token.function:
|
||||||
|
retval = token.previous.str
|
||||||
|
prev = token.previous
|
||||||
|
while "*" in retval and len(retval.replace("*", "")) == 0:
|
||||||
|
prev = prev.previous
|
||||||
|
retval = prev.str + retval
|
||||||
|
if debugprint:
|
||||||
|
print("\t:: {} {}".format(retval, token.function.name))
|
||||||
|
|
||||||
|
if retval and retval in conf["function_prefixes"]:
|
||||||
|
if not token.function.name.startswith(conf["function_prefixes"][retval]):
|
||||||
|
errors.append(reportError(
|
||||||
|
token.file, token.linenr, 'style', 'Function ' + token.function.name + ' violates naming convention'))
|
||||||
|
res = re.match(conf["RE_FUNCTIONNAME"], token.function.name)
|
||||||
|
if not res:
|
||||||
|
errors.append(reportError(
|
||||||
|
token.file, token.linenr, 'style', 'Function ' + token.function.name + ' violates naming convention'))
|
||||||
|
return errors
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
parser = argparse.ArgumentParser(description='Naming verification')
|
||||||
|
parser.add_argument('dumpfiles', type=str, nargs='+',
|
||||||
|
help='A set of dumpfiles to process')
|
||||||
|
parser.add_argument("--debugprint", action="store_true", default=False,
|
||||||
|
help="Add debug prints")
|
||||||
|
parser.add_argument("--configfile", type=str, default="naming.json",
|
||||||
|
help="Naming check config file")
|
||||||
|
parser.add_argument("--verify", action="store_true", default=False,
|
||||||
|
help="verify this script. Bust be executed in test folder !")
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
errors = process(args.dumpfiles, args.configfile, args.debugprint)
|
||||||
|
|
||||||
|
if args.verify:
|
||||||
|
print(errors)
|
||||||
|
if len(errors) < 6:
|
||||||
|
print("Not enough errors found")
|
||||||
|
sys.exit(1)
|
||||||
|
target = [
|
||||||
|
'[namingng_test.c:8] ( style ) naming.py: Variable badui32 violates naming convention\n',
|
||||||
|
'[namingng_test.c:11] ( style ) naming.py: Variable a violates naming convention\n',
|
||||||
|
'[namingng_test.c:29] ( style ) naming.py: Variable badui32 violates naming convention\n',
|
||||||
|
'[namingng_test.c:20] ( style ) naming.py: Function ui16bad_underscore violates naming convention\n',
|
||||||
|
'[namingng_test.c:25] ( style ) naming.py: Function u32Bad violates naming convention\n',
|
||||||
|
'[namingng_test.c:37] ( style ) naming.py: Function Badui16 violates naming convention\n']
|
||||||
|
diff = set(errors) - set(target)
|
||||||
|
if len(diff):
|
||||||
|
print("Not the right errors found {}".format(str(diff)))
|
||||||
|
sys.exit(1)
|
||||||
|
print("Verification done\n")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
if len(errors):
|
||||||
|
print('Found errors: {}'.format(len(errors)))
|
||||||
|
sys.exit(1)
|
||||||
|
sys.exit(0)
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <inttypes.h>
|
||||||
|
|
||||||
|
uint32_t ui32Good (int a)
|
||||||
|
{
|
||||||
|
uint32_t ui32good;
|
||||||
|
int32_t i32good;
|
||||||
|
uint32_t badui32;
|
||||||
|
int32_t badi32;
|
||||||
|
|
||||||
|
uint32_t a; // Short
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint16_t ui16Good (int a)
|
||||||
|
{
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint16_t ui16bad_underscore (int a)
|
||||||
|
{
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t u32Bad (int a)
|
||||||
|
{
|
||||||
|
uint32_t ui32good;
|
||||||
|
int32_t i32good;
|
||||||
|
uint32_t badui32;
|
||||||
|
int32_t badi32;
|
||||||
|
int * intpointer=NULL;
|
||||||
|
int ** intppointer=NULL;
|
||||||
|
int *** intpppointer=NULL;
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint16_t Badui16 (int a)
|
||||||
|
{
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
void * Pointer()
|
||||||
|
{
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
void ** PPointer()
|
||||||
|
{
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue