1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
#!/usr/bin/env python3
#
# Arm SCP/MCP Software
# Copyright (c) 2015-2018, Arm Limited and Contributors. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
"""
Check if a given file includes the correct license header.
This checker supports the following comment styles:
* Used by .c, .h and .s/.S (GCC) files
; Used by .s (ARM toolchain) and .scat (scatter file) files
# Used by Makefile (including .mk), .py (Python) and dxy (Doxygen) files
"""
import os
import fnmatch
import re
import sys
import datetime
from itertools import islice
#
# Directories to exclude
#
EXCLUDE_DIRECTORIES = [
'.git',
'build',
'cmsis',
]
#
# Supported file types
#
FILE_TYPES = [
'Makefile',
'*.mk',
'*.c',
'*.h',
'*.s',
'*.S',
'*.py',
'*.scat',
'*.dxy',
]
#
# Supported comment styles (Python regex)
#
COMMENT_PATTERN = '^(( \\*)|(;)|(\\#))'
#
# License pattern to match
#
LICENSE_PATTERN = \
'{0} Arm SCP/MCP Software$\n'\
'{0} Copyright \\(c\\) (?P<years>[0-9]{{4}}(-[0-9]{{4}})?), Arm Limited '\
'and Contributors. All rights reserved.$\n'\
'{0}$\n'\
'{0} SPDX-License-Identifier: BSD-3-Clause$\n'\
.format(COMMENT_PATTERN)
#
# The number of lines from the beginning of the file to search for the
# copyright header. This limit avoids the tool searching the whole file when
# the header always appears near the top.
#
# Note: The copyright notice does not usually start on the first line of the
# file. The value should be enough to include the all of the lines in the
# LICENSE_PATTERN, plus any extra lines that appears before the license. The
# performance of the tool may degrade if this value is increased significantly.
#
HEAD_LINE_COUNT = 10
class ErrorYear(Exception):
pass
class ErrorCopyright(Exception):
pass
class ErrorYearNotCurrent(Exception):
pass
def is_valid_file_type(filename):
for file_type in FILE_TYPES:
if fnmatch.fnmatch(filename, file_type):
return True
return False
def check_copyright(pattern, filename):
with open(filename, encoding="utf-8") as file:
# Read just the first HEAD_LINE_COUNT lines of a file
head_lines = islice(file, HEAD_LINE_COUNT)
head = ''
for line in head_lines:
head += line
match = pattern.search(head)
if not match:
raise ErrorCopyright
years = match.group('years').split('-')
if len(years) > 1:
if years[0] > years[1]:
raise ErrorYear
now = datetime.datetime.now()
final_year = len(years) - 1
if int(years[final_year]) != now.year:
raise ErrorYearNotCurrent
def main():
pattern = re.compile(LICENSE_PATTERN, re.MULTILINE)
error_year_count = 0
error_copyright_count = 0
error_incorrect_year_count = 0
print("Checking the copyrights in the code...")
cwd = os.getcwd()
print("Executing from {}".format(cwd))
for i, directory in enumerate(EXCLUDE_DIRECTORIES):
EXCLUDE_DIRECTORIES[i] = os.path.abspath(directory)
print("\tAdding to the exclude list: {}".
format(EXCLUDE_DIRECTORIES[i]))
for root, dirs, files in os.walk(cwd, topdown=True):
#
# Exclude directories based on the EXCLUDE_DIRECTORIES pattern list
#
dirs[:] = [d for d in dirs
if os.path.join(root, d) not in EXCLUDE_DIRECTORIES]
for file in files:
filename = os.path.join(root, file)
if is_valid_file_type(file):
try:
check_copyright(pattern, filename)
except ErrorYear:
print("{}: Invalid year format.".format(filename))
error_year_count += 1
except ErrorCopyright:
print("{}: Invalid copyright header.".format(filename))
error_copyright_count += 1
except ErrorYearNotCurrent:
print("{}: Outdated copyright year range.".
format(filename))
error_incorrect_year_count += 1
if error_year_count != 0 or error_copyright_count != 0 or \
error_incorrect_year_count != 0:
print("\t{} files with invalid year(s) format."
.format(error_year_count))
print("\t{} files with invalid copyright."
.format(error_copyright_count))
print("\t{} files with incorrect year ranges."
.format(error_incorrect_year_count))
return 1
else:
print("No errors found.")
return 0
if __name__ == "__main__":
sys.exit(main())
|
