forked from platformio/platformio-core
c03f93521b
* Add new option --skip-packages for check command Check tools might fail if they're not able to preprocess source files, for example, Cppcheck uses a custom preprocessor that is not able to parse complex preprocessor code in zephyr framework). Instead user can specify this option to skip headers included from packages and only check project sources. * Fix toolchain built-in include paths order C++ and fixed directories should have higher priority * Refactor check feature The main purpose is to prepare a more comprehensive build environment. It's crucial for cppcheck to be able to check complex frameworks like zephyr, esp-idf, etc. Also detect a special case when cppcheck fails to check the entire project (e.g. a syntax error due to custom preprocessor) * Add new test for check feature Tests ststm32 platform all tools and the main frameworks * Update check tools to the latest available versions * Test check tools and Zephyr framework only with Python 3 * Tidy up code * Add history entry
96 lines
3.0 KiB
Python
96 lines
3.0 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
|
|
import click
|
|
|
|
from platformio.project.helpers import get_project_dir
|
|
|
|
# pylint: disable=too-many-instance-attributes, redefined-builtin
|
|
# pylint: disable=too-many-arguments
|
|
|
|
|
|
class DefectItem(object):
|
|
|
|
SEVERITY_HIGH = 1
|
|
SEVERITY_MEDIUM = 2
|
|
SEVERITY_LOW = 4
|
|
SEVERITY_LABELS = {4: "low", 2: "medium", 1: "high"}
|
|
|
|
def __init__(
|
|
self,
|
|
severity,
|
|
category,
|
|
message,
|
|
file="unknown",
|
|
line=0,
|
|
column=0,
|
|
id=None,
|
|
callstack=None,
|
|
cwe=None,
|
|
):
|
|
assert severity in (self.SEVERITY_HIGH, self.SEVERITY_MEDIUM, self.SEVERITY_LOW)
|
|
self.severity = severity
|
|
self.category = category
|
|
self.message = message
|
|
self.line = int(line)
|
|
self.column = int(column)
|
|
self.callstack = callstack
|
|
self.cwe = cwe
|
|
self.id = id
|
|
self.file = file
|
|
if file.lower().startswith(get_project_dir().lower()):
|
|
self.file = os.path.relpath(file, get_project_dir())
|
|
|
|
def __repr__(self):
|
|
defect_color = None
|
|
if self.severity == self.SEVERITY_HIGH:
|
|
defect_color = "red"
|
|
elif self.severity == self.SEVERITY_MEDIUM:
|
|
defect_color = "yellow"
|
|
|
|
format_str = "{file}:{line}: [{severity}:{category}] {message} {id}"
|
|
return format_str.format(
|
|
severity=click.style(self.SEVERITY_LABELS[self.severity], fg=defect_color),
|
|
category=click.style(self.category.lower(), fg=defect_color),
|
|
file=click.style(self.file, bold=True),
|
|
message=self.message,
|
|
line=self.line,
|
|
id="%s" % "[%s]" % self.id if self.id else "",
|
|
)
|
|
|
|
def __or__(self, defect):
|
|
return self.severity | defect.severity
|
|
|
|
@staticmethod
|
|
def severity_to_int(label):
|
|
for key, value in DefectItem.SEVERITY_LABELS.items():
|
|
if label == value:
|
|
return key
|
|
raise Exception("Unknown severity label -> %s" % label)
|
|
|
|
def as_dict(self):
|
|
return {
|
|
"severity": self.SEVERITY_LABELS[self.severity],
|
|
"category": self.category,
|
|
"message": self.message,
|
|
"file": os.path.realpath(self.file),
|
|
"line": self.line,
|
|
"column": self.column,
|
|
"callstack": self.callstack,
|
|
"id": self.id,
|
|
"cwe": self.cwe,
|
|
}
|