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
|
# Copyright 2021 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Test for Kconfig checker"""
import contextlib
import io
import os
import pathlib
import re
import sys
import tempfile
import unittest
import kconfig_check
# Prefix that we strip from each Kconfig option, when considering whether it is
# equivalent to a CONFIG option with the same name
PREFIX = "PLATFORM_EC_"
@contextlib.contextmanager
def capture_sys_output():
"""Capture output for testing purposes
Use this to suppress stdout/stderr output:
with capture_sys_output() as (stdout, stderr)
...do something...
"""
capture_out, capture_err = io.StringIO(), io.StringIO()
old_out, old_err = sys.stdout, sys.stderr
try:
sys.stdout, sys.stderr = capture_out, capture_err
yield capture_out, capture_err
finally:
sys.stdout, sys.stderr = old_out, old_err
# Use unittest since it produced less verbose output than pytest and can be run
# directly from Python. You can still run this test with 'pytest' if you like.
class KconfigCheck(unittest.TestCase):
"""Tests for the KconfigCheck class"""
def test_simple_check(self):
"""Check it detected a new ad-hoc CONFIG"""
checker = kconfig_check.KconfigCheck()
self.assertEqual(
["NEW_ONE"],
checker.find_new_adhoc(
configs=["NEW_ONE", "OLD_ONE", "IN_KCONFIG"],
kconfigs=["IN_KCONFIG"],
allowed=["OLD_ONE"],
),
)
def test_sorted_check(self):
"""Check it sorts the results in order"""
checker = kconfig_check.KconfigCheck()
self.assertSequenceEqual(
["ANOTHER_NEW_ONE", "NEW_ONE"],
checker.find_new_adhoc(
configs=["NEW_ONE", "ANOTHER_NEW_ONE", "OLD_ONE", "IN_KCONFIG"],
kconfigs=["IN_KCONFIG"],
allowed=["OLD_ONE"],
),
)
def check_read_configs(self, use_defines):
"""Check that kconfigs can be read."""
checker = kconfig_check.KconfigCheck()
with tempfile.NamedTemporaryFile() as configs:
with open(configs.name, "w") as out:
prefix = "#define " if use_defines else ""
suffix = " " if use_defines else "="
out.write(
f"""{prefix}CONFIG_OLD_ONE{suffix}y
{prefix}NOT_A_CONFIG{suffix}
{prefix}CONFIG_STRING{suffix}"something"
{prefix}CONFIG_INT{suffix}123
{prefix}CONFIG_HEX{suffix}45ab
"""
)
self.assertEqual(
["OLD_ONE", "STRING", "INT", "HEX"],
checker.read_configs(configs.name, use_defines),
)
def test_read_configs(self):
"""Test KconfigCheck.read_configs()"""
self.check_read_configs(False)
def test_read_configs_defines(self):
"""Test KconfigCheck.read_configs() containing #defines"""
self.check_read_configs(True)
@classmethod
def setup_srctree(cls, srctree):
"""Set up some Kconfig files in a directory and subdirs
Args:
srctree: Directory to write to
"""
with open(os.path.join(srctree, "Kconfig"), "w") as out:
out.write(
f"""config {PREFIX}MY_KCONFIG
\tbool "my kconfig"
rsource "subdir/Kconfig.wibble"
"""
)
subdir = os.path.join(srctree, "subdir")
os.mkdir(subdir)
with open(os.path.join(subdir, "Kconfig.wibble"), "w") as out:
out.write("menuconfig %sMENU_KCONFIG\n" % PREFIX)
# Add a directory which should be ignored
bad_subdir = os.path.join(subdir, "Kconfig")
os.mkdir(bad_subdir)
with open(os.path.join(bad_subdir, "Kconfig.bad"), "w") as out:
out.write("menuconfig %sBAD_KCONFIG" % PREFIX)
def test_find_kconfigs(self):
"""Test KconfigCheck.find_kconfigs()"""
checker = kconfig_check.KconfigCheck()
with tempfile.TemporaryDirectory() as srctree:
self.setup_srctree(srctree)
files = checker.find_kconfigs(srctree)
fnames = [fname[len(srctree) :] for fname in files]
self.assertEqual(["/Kconfig", "/subdir/Kconfig.wibble"], fnames)
def test_scan_kconfigs(self):
"""Test KconfigCheck.scan_configs()"""
checker = kconfig_check.KconfigCheck()
with tempfile.TemporaryDirectory() as srctree:
self.setup_srctree(srctree)
self.assertEqual(
["MENU_KCONFIG", "MY_KCONFIG"],
checker.scan_kconfigs(srctree, PREFIX),
)
@classmethod
def setup_allowed_and_configs(
cls, allowed_fname, configs_fname, add_new_one=True
):
"""Set up the 'allowed' and 'configs' files for tests
Args:
allowed_fname: Filename to write allowed CONFIGs to
configs_fname: Filename to which CONFIGs to check should be written
add_new_one: True to add CONFIG_NEW_ONE to the configs_fname file
"""
with open(allowed_fname, "w") as out:
out.write("CONFIG_OLD_ONE\n")
out.write("CONFIG_MENU_KCONFIG\n")
with open(configs_fname, "w") as out:
to_add = ["CONFIG_OLD_ONE", "CONFIG_MY_KCONFIG"]
if add_new_one:
to_add.append("CONFIG_NEW_ONE")
out.write("\n".join(to_add))
def test_check_adhoc_configs(self):
"""Test KconfigCheck.check_adhoc_configs()"""
checker = kconfig_check.KconfigCheck()
with tempfile.TemporaryDirectory() as srctree:
self.setup_srctree(srctree)
with tempfile.NamedTemporaryFile() as allowed:
with tempfile.NamedTemporaryFile() as configs:
self.setup_allowed_and_configs(allowed.name, configs.name)
(
new_adhoc,
unneeded_adhoc,
updated_adhoc,
) = checker.check_adhoc_configs(
configs.name, srctree, allowed.name, PREFIX
)
self.assertEqual(["NEW_ONE"], new_adhoc)
self.assertEqual(["MENU_KCONFIG"], unneeded_adhoc)
self.assertEqual(["OLD_ONE"], updated_adhoc)
def test_check(self):
"""Test running the 'check' subcommand"""
with capture_sys_output() as (stdout, stderr):
with tempfile.TemporaryDirectory() as srctree:
self.setup_srctree(srctree)
with tempfile.NamedTemporaryFile() as allowed:
with tempfile.NamedTemporaryFile() as configs:
self.setup_allowed_and_configs(
allowed.name, configs.name
)
ret_code = kconfig_check.main(
[
"-c",
configs.name,
"-s",
srctree,
"-a",
allowed.name,
"-p",
PREFIX,
"check",
]
)
self.assertEqual(1, ret_code)
self.assertEqual("", stdout.getvalue())
found = re.findall("(CONFIG_.*)", stderr.getvalue())
self.assertEqual(["CONFIG_NEW_ONE"], found)
def test_real_kconfig(self):
"""Same Kconfig should be returned for kconfiglib / adhoc"""
if not kconfig_check.USE_KCONFIGLIB:
self.fail("No kconfiglib available")
zephyr_path = pathlib.Path(
"../../../src/third_party/zephyr/main"
).resolve()
if not zephyr_path.exists():
self.fail("No zephyr tree available")
os.environ["ZEPHYR_BASE"] = str(zephyr_path)
checker = kconfig_check.KconfigCheck()
srcdir = "zephyr"
search_paths = [zephyr_path]
kc_version = checker.scan_kconfigs(
srcdir, search_paths=search_paths, try_kconfiglib=True
)
adhoc_version = checker.scan_kconfigs(srcdir, try_kconfiglib=False)
# List of things missing from the Kconfig
missing = sorted(list(set(adhoc_version) - set(kc_version)))
# Some items are defined in files that are not included
# in all cases, only for particular values of $(ARCH)
self.assertEqual(
[
"TRAP_UNALIGNED_ACCESS",
],
missing,
)
def test_check_unneeded(self):
"""Test running the 'check' subcommand with unneeded ad-hoc configs"""
with capture_sys_output() as (stdout, stderr):
with tempfile.TemporaryDirectory() as srctree:
self.setup_srctree(srctree)
with tempfile.NamedTemporaryFile() as allowed:
with tempfile.NamedTemporaryFile() as configs:
self.setup_allowed_and_configs(
allowed.name, configs.name, False
)
ret_code = kconfig_check.main(
[
"-c",
configs.name,
"-s",
srctree,
"-a",
allowed.name,
"-p",
PREFIX,
"check",
]
)
self.assertEqual(1, ret_code)
self.assertEqual("", stderr.getvalue())
found = re.findall("(CONFIG_.*)", stdout.getvalue())
self.assertEqual(["CONFIG_MENU_KCONFIG"], found)
allowed = kconfig_check.NEW_ALLOWED_FNAME.read_text().splitlines()
self.assertEqual(["CONFIG_OLD_ONE"], allowed)
if __name__ == "__main__":
unittest.main()
|