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
|
# 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 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 test_read_configs(self):
"""Test KconfigCheck.read_configs()"""
checker = kconfig_check.KconfigCheck()
with tempfile.NamedTemporaryFile() as configs:
with open(configs.name, 'w') as out:
out.write("""CONFIG_OLD_ONE=y
NOT_A_CONFIG
CONFIG_STRING="something"
CONFIG_INT=123
CONFIG_HEX=45ab
""")
self.assertEqual(['OLD_ONE', 'STRING', 'INT', 'HEX'],
checker.read_configs(configs.name))
@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('config PLATFORM_EC_MY_KCONFIG\n')
subdir = os.path.join(srctree, 'subdir')
os.mkdir(subdir)
with open(os.path.join(subdir, 'Kconfig.wibble'), 'w') as out:
out.write('menuconfig PLATFORM_EC_MENU_KCONFIG\n')
# 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 PLATFORM_EC_BAD_KCONFIG')
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(['MY_KCONFIG', 'MENU_KCONFIG'],
checker.scan_kconfigs(srctree, PREFIX))
@classmethod
def setup_allowed_and_configs(cls, allowed_fname, configs_fname):
"""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
"""
with open(allowed_fname, 'w') as out:
out.write('CONFIG_OLD_ONE')
with open(configs_fname, 'w') as out:
out.write('\n'.join(['CONFIG_OLD_ONE', 'CONFIG_NEW_ONE',
'CONFIG_MY_KCONFIG']))
def test_find_new_adhoc_configs(self):
"""Test KconfigCheck.find_new_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)
result = checker.find_new_adhoc_configs(
configs.name, srctree, allowed.name, PREFIX)
self.assertEqual(['NEW_ONE'], result)
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)
if __name__ == '__main__':
unittest.main()
|
