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
|
# -*- coding: utf-8 -*-
# Copyright (c) 2022, Compiler Explorer Authors
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import sys
from os import listdir
from os.path import isfile, join
import re
PROP_RE = re.compile(r'[^#]*=.*')
COMPILERS_LIST_RE = re.compile(r'compilers=(.*)')
ALIAS_LIST_RE = re.compile(r'alias=(.*)')
GROUP_NAME_RE = re.compile(r'group\.(.*?)\.')
COMPILER_EXE_RE = re.compile(r'compiler\.(.*?)\.exe=(.*)')
DEFAULT_COMPILER_RE = re.compile(r'defaultCompiler=(.*)')
FORMATTERS_LIST_RE = re.compile(r'formatters=(.*)')
FORMATTER_EXE_RE = re.compile(r'formatter\.(.*?)\.exe=(.*)')
LIBS_LIST_RE = re.compile(r'libs=(.+)')
LIB_VERSIONS_LIST_RE = re.compile(r'libs\.(.*?)\.versions=(.*)')
LIB_VERSION_RE = re.compile(r'libs\.(.*?)\.versions\.(.*?)\.version')
TOOLS_LIST_RE = re.compile(r'tools=(.+)')
TOOL_EXE_RE = re.compile(r'tools\.(.*?)\.exe=(.*)')
EMPTY_LIST_RE = re.compile(r'.*(compilers|formatters|versions|tools|alias|exclude|libPath)=((.*::.*)|(:.*)|(.*:))$')
DISABLED_RE = re.compile(r'^# Disabled?:?\s*(.*)')
class Line:
def __init__(self, line_number, text):
self.number = line_number
self.text = text.strip()
def __str__(self):
return f'<{self.number}> {self.text}'
def match_and_add(line: Line, expr, s):
match = expr.match(line.text)
if match:
s.add(match.group(1))
return match
def match_and_update(line: Line, expr, s, split=':'):
match = expr.match(line.text)
if match:
s.update(match.group(1).split(split))
return match
def process_file(file: str):
default_compiler = set()
listed_groups = set()
seen_groups = set()
listed_compilers = set()
seen_compilers = set()
listed_formatters = set()
seen_formatters = set()
listed_tools = set()
seen_tools = set()
listed_libs_ids = set()
seen_libs_ids = set()
listed_libs_versions = set()
seen_libs_versions = set()
empty_separators = set()
seen_lines = set()
duplicate_lines = set()
duplicated_compiler_references = set()
duplicated_group_references = set()
suspicious_path = set()
# By default, consider this one valid as it's in several configs.
disabled = set({'/usr/bin/ldd'})
with open(file) as f:
for line_number, text in enumerate(f, start=1):
text = text.strip()
if not text:
continue
line = Line(line_number, text)
match_and_update(line, DISABLED_RE, disabled, ' ')
match_prop = PROP_RE.match(line.text)
if not match_prop:
continue
if line.text in seen_lines:
duplicate_lines.add(str(line))
else:
seen_lines.add(line.text)
match_empty = EMPTY_LIST_RE.match(line.text)
if match_empty:
empty_separators.add(str(line))
match_compilers = COMPILERS_LIST_RE.search(line.text)
if match_compilers:
ids = match_compilers.group(1).split(':')
for elem_id in ids:
if elem_id.startswith('&'):
if elem_id[1:] in listed_groups:
duplicated_group_references.add (elem_id[1:])
listed_groups.add(elem_id[1:])
elif '@' not in elem_id:
if elem_id in listed_compilers:
duplicated_compiler_references.add (elem_id)
listed_compilers.add(elem_id)
match_libs_versions = LIB_VERSIONS_LIST_RE.match(line.text)
if match_libs_versions:
lib_id = match_libs_versions.group(1)
versions = match_libs_versions.group(2).split(':')
seen_libs_ids.add(lib_id)
listed_libs_versions.update([f"{lib_id} {v}" for v in versions])
match_libs_version = LIB_VERSION_RE.match(line.text)
if match_libs_version:
lib_id = match_libs_version.group(1)
version = match_libs_version.group(2)
seen_libs_versions.add(f"{lib_id} {version}")
match_and_add(line, DEFAULT_COMPILER_RE, default_compiler)
match_and_add(line, GROUP_NAME_RE, seen_groups)
m = match_and_add(line, COMPILER_EXE_RE, seen_compilers)
if m and not m.group(2).startswith('/opt/compiler-explorer'):
suspicious_path.add(m.group(2))
m = match_and_add(line, FORMATTER_EXE_RE, seen_formatters)
if m and not m.group(2).startswith('/opt/compiler-explorer'):
suspicious_path.add(m.group(2))
m = match_and_add(line, TOOL_EXE_RE, seen_tools)
if m and not m.group(2).startswith('/opt/compiler-explorer'):
suspicious_path.add(m.group(2))
match_and_update(line, ALIAS_LIST_RE, seen_compilers)
match_and_update(line, FORMATTERS_LIST_RE, listed_formatters)
match_and_update(line, TOOLS_LIST_RE, listed_tools)
match_and_update(line, LIBS_LIST_RE, listed_libs_ids)
bad_compilers = listed_compilers.symmetric_difference(seen_compilers)
bad_groups = listed_groups.symmetric_difference(seen_groups)
bad_formatters = listed_formatters.symmetric_difference(seen_formatters)
bad_libs_ids = listed_libs_ids.symmetric_difference(seen_libs_ids)
bad_libs_versions = listed_libs_versions.symmetric_difference(seen_libs_versions)
bad_tools = listed_tools.symmetric_difference(seen_tools)
bad_default = default_compiler - listed_compilers
return {
"filename": file,
"bad_compilers": bad_compilers - disabled,
"bad_groups": bad_groups - disabled,
"bad_formatters": bad_formatters - disabled,
"bad_libs_ids": bad_libs_ids - disabled,
"bad_libs_versions": bad_libs_versions - disabled,
"bad_tools": bad_tools - disabled,
"bad_default": bad_default,
"empty_separators": empty_separators,
"duplicate_lines": duplicate_lines,
"duplicated_compiler_references": duplicated_compiler_references,
"duplicated_group_references": duplicated_group_references,
"suspicious_path": suspicious_path - disabled
}
def process_folder(folder: str):
return [process_file(join(folder, f))
for f in listdir(folder)
if isfile(join(folder, f))
and not (f.endswith('.defaults.properties') or f.endswith('.local.properties'))
and f.endswith('.properties')]
def problems_found(file_result):
return any([len(file_result[r]) > 0 for r in file_result if r != "filename"])
def print_issue(name, result):
if len(result) > 0:
sep = "\n\t"
print(f"{name}:\n\t{sep.join(sorted(result))}")
def find_orphans(folder: str):
result = sorted([r for r in process_folder(folder) if problems_found(r)], key=lambda x: x["filename"])
if result:
print(f"Found {len(result)} property file(s) with issues:")
for r in result:
print('################')
print(f'## {r["filename"]}')
for k in r:
if k != "filename":
print_issue(k, r[k])
print("")
print("To suppress this warning on IDs that are temporally disabled, "
"add one or more comments to each listed file:")
print("# Disabled: id1 id2 ...")
else:
print("No configuration mismatches found")
return result
if __name__ == '__main__':
if find_orphans('./etc/config/'):
sys.exit(1)
|
