-
Notifications
You must be signed in to change notification settings - Fork 0
/
copyright.py
285 lines (221 loc) · 9.52 KB
/
copyright.py
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# This script copy from
# https://github.com/DataDog/datadog-agent/blob/main/tasks/libs/copyright.py
# We just made some adjust according to specific conditions.
import re
import subprocess
import sys
import argparse
from pathlib import Path, PurePosixPath
GLOB_PATTERN = "**/*.go"
COPYRIGHT_HEADER = """
// Unless explicitly stated otherwise all files in this repository are licensed
// under the MIT License.
// This product includes software developed at Guance Cloud (https://www.guance.com/).
// Copyright 2021-present Guance, Inc.
""".strip()
COPYRIGHT_REGEX = [
r'^// Unless explicitly stated otherwise all files in this repository are licensed$',
r'^// under the MIT License\.$',
r'^// This product includes software developed at Guance Cloud \(https://www\.guance\.com/\)\.$',
r'^// Copyright 20[1-3][0-9]-([Pp]resent|20[1-3][0-9]) Guance, (Inc|Inmetrics)\.$',
]
# These path patterns are excluded from checks
PATH_EXCLUSION_REGEX = [
# These are auto-generated files but without headers to indicate it
'/vendor',
'datakit/plugins/inputs/skywalking/compiled',
'/plugins/externals/ebpf',
'/plugins/inputs/skywalking/v3',
'/internal/win_utils/pdh',
'/internal/obfuscate',
'/internal/msgpack',
'/internal/obfuscate',
'/pipeline/grok',
'/pipeline/core/parser/lex_test.go',
'/pipeline/core/parser/strutil.go',
'/io/cachedata.pb.go',
'/.git/',
'/git/',
]
# These header matchers skip enforcement of the rules if found in the first
# line of the file
HEADER_EXCLUSION_REGEX = [
'^// Code generated ',
'^//go:generate ',
'^// AUTOGENERATED FILE: ',
'^// Copyright.* OpenTelemetry Authors',
'^// Copyright.* The Go Authors',
'^// This file includes software developed at CoreOS',
'^// Copyright 2017 Kinvolk',
]
COMPILED_COPYRIGHT_REGEX = [re.compile(regex, re.UNICODE) for regex in COPYRIGHT_REGEX]
COMPILED_PATH_EXCLUSION_REGEX = [re.compile(regex, re.UNICODE) for regex in PATH_EXCLUSION_REGEX]
COMPILED_HEADER_EXCLUSION_REGEX = [re.compile(regex, re.UNICODE) for regex in HEADER_EXCLUSION_REGEX]
class CopyrightLinter:
"""
This class is used to enforce copyright headers on specified file patterns
"""
def __init__(self, debug=False):
self._debug = debug
@staticmethod
def _get_repo_dir():
script_dir = PurePosixPath(__file__).parent
repo_dir = (
subprocess.check_output(
['git', 'rev-parse', '--show-toplevel'],
cwd=script_dir,
)
.decode(sys.stdout.encoding)
.strip()
)
return PurePosixPath(repo_dir)
@staticmethod
def _is_excluded_path(filepath, exclude_matchers):
for matcher in exclude_matchers:
if re.search(matcher, filepath.as_posix()):
return True
return False
@staticmethod
def _get_matching_files(root_dir, glob_pattern, exclude=None):
if exclude is None:
exclude = []
# Glob is a generator so we have to do the counting ourselves
all_matching_files_cnt = 0
filtered_files = []
for filepath in Path(root_dir).glob(glob_pattern):
all_matching_files_cnt += 1
if not CopyrightLinter._is_excluded_path(filepath, exclude):
filtered_files.append(filepath)
excluded_files_cnt = all_matching_files_cnt - len(filtered_files)
print(f"[INFO] Excluding {excluded_files_cnt} files based on path filters!")
return sorted(filtered_files)
@staticmethod
def _get_header(filepath):
header = []
with open(filepath, "r") as file_obj:
# We expect a specific header format which should be 4 lines
for _ in range(4):
header.append(file_obj.readline().strip())
return header
@staticmethod
def _is_excluded_header(header, exclude=None):
if exclude is None:
exclude = []
for matcher in exclude:
if re.search(matcher, header[0]):
return True
return False
def _has_copyright(self, filepath):
header = CopyrightLinter._get_header(filepath)
if header is None:
print("[WARN] Mismatch found! Could not find any content in file!")
return False
if len(header) > 0 and CopyrightLinter._is_excluded_header(header, exclude=COMPILED_HEADER_EXCLUSION_REGEX):
if self._debug:
print(f"[INFO] Excluding {filepath} based on header '{header[0]}'")
return True
if len(header) <= 3:
print("[WARN] Mismatch found! File too small for header stanza!")
return False
for line_idx, matcher in enumerate(COMPILED_COPYRIGHT_REGEX):
if not re.match(matcher, header[line_idx]):
print(
f"[WARN] Mismatch found! Expected '{COPYRIGHT_REGEX[line_idx]}' pattern but got '{header[line_idx]}'"
)
return False
return True
def _assert_copyrights(self, files):
failing_files = []
for filepath in files:
if self._has_copyright(filepath):
if self._debug:
print(f"[ OK ] {filepath}")
continue
print(f"[FAIL] {filepath}")
failing_files.append(filepath)
total_files = len(files)
if failing_files:
pct_failing = (len(failing_files) / total_files) * 100
print()
print(
f"FAIL: There are {len(failing_files)} files out of "
+ f"{total_files} ({pct_failing:.2f}%) that are missing the proper copyright!"
)
return failing_files
def _prepend_header(self, filepath, dry_run=True):
with open(filepath, 'r+') as file_obj:
existing_content = file_obj.read()
if dry_run:
return True
file_obj.seek(0)
new_content = COPYRIGHT_HEADER + "\n\n" + existing_content
file_obj.write(new_content)
# Verify result. A problem here is not benign so we stop the whole run.
if not self._has_copyright(filepath):
raise Exception(f"[ERROR] Header prepend failed to produce correct output for {filepath}!")
return True
@staticmethod
def _is_build_header(line):
return line.startswith("// +build ") or line.startswith("//+build ") or line.startswith("//go:build ")
def _is_package_comment_or_nolint(line):
return line.startswith("// Package ") or line.startswith("//nolint")
def _fix_file_header(self, filepath, dry_run=True):
header = CopyrightLinter._get_header(filepath)
# Empty file - ignore
if len(header) < 1:
return False
# If the file starts with a comment and it's not a build comment,
# there is likely a manual fix to the header needed
if header[0].startswith("//") and not CopyrightLinter._is_build_header(header[0]) and not CopyrightLinter._is_package_comment_or_nolint(header[0]):
return False
if dry_run:
return True
return self._prepend_header(filepath, dry_run=dry_run)
def _fix(self, failing_files, dry_run=True):
failing_files_cnt = len(failing_files)
errors = []
for idx, filepath in enumerate(failing_files):
print(f"[INFO] ({idx+1:3d}/{failing_files_cnt:3}) Fixing '{filepath}'...")
if not self._fix_file_header(filepath, dry_run=dry_run):
error_message = f"'{filepath}' could not be fixed!"
print(f"[WARN] ({idx+1:3d}/{failing_files_cnt:3}) {error_message}")
errors.append(Exception(error_message))
return errors
def assert_compliance(self, fix=False, dry_run=True):
"""
This method applies the GLOB_PATTERN to the root of the repository and
verifies that all files have the expected copyright header.
"""
git_repo_dir = CopyrightLinter._get_repo_dir()
if self._debug:
print(f"[DEBG] Repo root: {git_repo_dir}")
print(f"[DEBG] Finding all files in {git_repo_dir} matching '{GLOB_PATTERN}'...")
matching_files = CopyrightLinter._get_matching_files(
git_repo_dir,
GLOB_PATTERN,
exclude=COMPILED_PATH_EXCLUSION_REGEX,
)
print(f"[INFO] Found {len(matching_files)} files matching '{GLOB_PATTERN}'")
failing_files = self._assert_copyrights(matching_files)
if len(failing_files) > 0:
if not fix:
print("CHECK: FAIL")
raise Exception(
f"Copyright linting found {len(failing_files)} files that did not have the expected header!"
)
# If "fix=True", we will attempt to fix the failing files
errors = self._fix(failing_files, dry_run=dry_run)
if errors:
raise Exception(f"Copyright linter was unable to fix {len(errors)}/{len(failing_files)} files!")
return
print("CHECK: OK")
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument("--fix", dest="fix", action='store_true', help='auto add copyright to code')
parser.add_argument("--dry-run", dest="dry_run", action='store_true', help='dry run')
args = parser.parse_args()
#CopyrightLinter(debug=True).assert_compliance(fix=True, dry_run=False)
print(args)
CopyrightLinter(debug=True).assert_compliance(fix=args.fix, dry_run=args.dry_run)