Page MenuHomec4science
Files F94076397

issue_formatter.py
No OneTemporary
Actions

File Metadata

Created
Tue, Dec 3, 16:40

issue_formatter.py
View Options

__copyright__ = (
"Copyright (©) 2021-2023 EPFL (Ecole Polytechnique Fédérale de Lausanne)"
"Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)"
)
__license__ = "LGPLv3"
import hashlib
import os
class IssueFormatter:
CLASSIFICATIONS = {
'bugprone': {
'categories': ['Bug Risk'],
'severity': 'major',
},
'modernize': {
'categories': ['Clarity', 'Compatibility', 'Style'],
'severity': 'info'
},
'mpi': {
'categories': ['Bug Risk', 'Performance'],
'severity': 'critical',
},
'openmp': {
'categories': ['Bug Risk', 'Performance'],
'severity': 'critical',
},
'performance': {
'categories': ['Performance'],
'severity': 'minor',
},
'readability': {
'categories': ['Clarity', 'Style'],
'severity': 'info'
},
}
def _get_classifiaction(self, type_):
categories = ['Bug Risk']
severity = 'blocker'
if type_ in self.CLASSIFICATIONS:
categories = self.CLASSIFICATIONS[type_]['categories']
severity = self.CLASSIFICATIONS[type_]['severity']
elif type_[0] == 'clang':
if type_[1] == 'diagnostic':
categories = ['Bug Risk']
severity = 'blocker'
elif type_[1] == 'analyzer':
categories = ['Bug Risk']
severity = 'major'
return (categories, severity)
def __init__(self, issue):
self.issue_dict = issue
def format(self):
self.issue_dict['file'] = os.path.relpath(self.issue_dict['file'])
issue = {
'type': 'issue',
'check_name': self.issue_dict['type'],
'description': self.issue_dict['detail'],
'location': {
"path": self.issue_dict['file'],
"lines": {
"begin": int(self.issue_dict['line']),
"end": int(self.issue_dict['line']),
},
"positions": {
"begin": {
"line": int(self.issue_dict['line']),
"column": int(self.issue_dict['column']),
},
"end": {
"line": int(self.issue_dict['line']),
"column": int(self.issue_dict['column']),
},
},
},
}
if 'content' in self.issue_dict:
issue['content'] = {
'body': '```\n' +
'\n'.join(self.issue_dict['content']) +
'\n```'
}
issue['fingerprint'] = hashlib.md5(
'{file}:{line}:{column}:{type}'.format(**self.issue_dict).encode()
).hexdigest()
type_ = self.issue_dict['type'].split('-')[0]
issue['categories'], issue['severity'] = \
self._get_classifiaction(type_)
return issue

Event Timeline

c4science · Help