yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Regex mechanism for check-specific exemptions

Browse source 
Suffixes are convenient but not always sufficient.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2020-05-10 16:57:16 +02:00
parent c1d1b669db
commit 0598db84c3
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tests/scripts/check-files.py
View file

@ -14,6 +14,7 @@ import os
import argparse import argparse
import logging import logging
import codecs import codecs
import re
import sys import sys
@ -26,16 +27,31 @@ class FileIssueTracker:
``suffix_exemptions``: files whose name ends with a string in this set ``suffix_exemptions``: files whose name ends with a string in this set
will not be checked. will not be checked.
``path_exemptions``: files whose path (relative to the root of the source
tree) matches this regular expression will not be checked. This can be
``None`` to match no path. Paths are normalized and converted to ``/``
separators before matching.
``heading``: human-readable description of the issue ``heading``: human-readable description of the issue
""" """
suffix_exemptions = frozenset() suffix_exemptions = frozenset()
path_exemptions = None
# heading must be defined in derived classes. # heading must be defined in derived classes.
# pylint: disable=no-member # pylint: disable=no-member
def __init__(self): def __init__(self):
self.files_with_issues = {} self.files_with_issues = {}
@staticmethod
def normalize_path(filepath):
"""Normalize ``filepath`` """
filepath = os.path.normpath(filepath)
seps = os.path.sep
if os.path.altsep is not None:
seps += os.path.altsep
return '/'.join(filepath.split(seps))
def should_check_file(self, filepath): def should_check_file(self, filepath):
"""Whether the given file name should be checked. """Whether the given file name should be checked.
@ -45,6 +61,9 @@ class FileIssueTracker:
for files_exemption in self.suffix_exemptions: for files_exemption in self.suffix_exemptions:
if filepath.endswith(files_exemption): if filepath.endswith(files_exemption):
return False return False
if self.path_exemptions and \
re.match(self.path_exemptions, self.normalize_path(filepath)):
return False
return True return True
def check_file_for_issue(self, filepath): def check_file_for_issue(self, filepath):
@ -152,6 +171,8 @@ class UnixLineEndingIssueTracker(LineIssueTracker):
heading = "Non-Unix line endings:" heading = "Non-Unix line endings:"
def should_check_file(self, filepath): def should_check_file(self, filepath):
if not super().should_check_file(filepath):
return False
return not is_windows_file(filepath) return not is_windows_file(filepath)
def issue_with_line(self, line, _filepath): def issue_with_line(self, line, _filepath):
@ -164,6 +185,8 @@ class WindowsLineEndingIssueTracker(LineIssueTracker):
heading = "Non-Windows line endings:" heading = "Non-Windows line endings:"
def should_check_file(self, filepath): def should_check_file(self, filepath):
if not super().should_check_file(filepath):
return False
return is_windows_file(filepath) return is_windows_file(filepath)
def issue_with_line(self, line, _filepath): def issue_with_line(self, line, _filepath):