len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-10-14 08:47:45 -04:00
Code Issues Projects Releases Packages Wiki Activity

ci: core_checker: Match copyright line with regex

Browse source 
Allow for a variety of copyright dates by matching copyright statements
with a regex.
This commit is contained in:
Paul Bartell 2022-08-12 17:44:44 -07:00 • committed by Paul Bartell
parent 8f21b61908
commit 0048a568c9
2 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.github/scripts/common/header_checker.py vendored
View file

@ -67,10 +67,13 @@ class HeaderChecker:
py_ext=None, py_ext=None,
asm_ext=None, asm_ext=None,
third_party_patterns=None, third_party_patterns=None,
copyright_regex = None
): ):
self.padding = padding self.padding = padding
self.header = header self.header = header
self.copyright_regex = re.compile(copyright_regex)
# Construct mutated header for assembly files # Construct mutated header for assembly files
self.asm_header = [";" + line for line in header] self.asm_header = [";" + line for line in header]
@ -124,7 +127,12 @@ class HeaderChecker:
def isValidHeaderSection(self, file_ext, section_name, section): def isValidHeaderSection(self, file_ext, section_name, section):
"""Validate a given section based on file extentions and section name""" """Validate a given section based on file extentions and section name"""
valid = False valid = False
if file_ext in self.pyExtList: if self.copyright_regex and section_name == "copyright":
valid = True
for line in section:
if not self.copyright_regex.match(line):
valid = False
elif file_ext in self.pyExtList:
valid = self.headers_py[section_name] == section valid = self.headers_py[section_name] == section
elif file_ext in self.asmExtList: elif file_ext in self.asmExtList:
valid = self.headers[section_name] == section valid = self.headers[section_name] == section

4
.github/scripts/core_checker.py vendored
View file

@ -320,12 +320,14 @@ FREERTOS_HEADER = [
' */\n', ' */\n',
] ]
FREERTOS_COPYRIGHT_REGEX = r"^( *(\/\*|\*|#|\/\/))? Copyright \(C\) 20\d\d Amazon.com, Inc. or its affiliates. All Rights Reserved\.( \*\/)?$"
def main(): def main():
parser = HeaderChecker.configArgParser() parser = HeaderChecker.configArgParser()
args = parser.parse_args() args = parser.parse_args()
# Configure the checks then run # Configure the checks then run
checker = HeaderChecker(FREERTOS_HEADER) checker = HeaderChecker(FREERTOS_HEADER, copyright_regex=FREERTOS_COPYRIGHT_REGEX)
checker.ignoreExtension(*FREERTOS_IGNORED_EXTENSIONS) checker.ignoreExtension(*FREERTOS_IGNORED_EXTENSIONS)
checker.ignorePattern(*FREERTOS_IGNORED_PATTERNS) checker.ignorePattern(*FREERTOS_IGNORED_PATTERNS)
checker.ignoreFile(*FREERTOS_IGNORED_FILES) checker.ignoreFile(*FREERTOS_IGNORED_FILES)