kunit: kunit_tool: Allow .kunitconfig to disable config items
[This is a backport of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=97752c39bdaeea990260d3111250f6c861519808
]
Rework kunit_tool in order to allow .kunitconfig files to better enforce
that disabled items in .kunitconfig are disabled in the generated
.config.
Previously, kunit_tool simply enforced that any line present in
.kunitconfig was also present in .config, but this could cause problems
if a config option was disabled in .kunitconfig, but not listed in
.config due to (for example) having disabled dependencies.
To fix this, re-work the parser to track config names and values, and
require values to match unless they are explicitly disabled with the
"CONFIG_x is not set" comment (or by setting its value to 'n'). Those
"disabled" values will pass validation if omitted from the .config, but
not if they have a different value.
Signed-off-by: David Gow <davidgow@google.com>
Change-Id: I984c459682af33cc77e1b1ee1a19636e301284c5
diff --git a/tools/testing/kunit/kunit_config.py b/tools/testing/kunit/kunit_config.py
index 4196966..e982350 100644
--- a/tools/testing/kunit/kunit_config.py
+++ b/tools/testing/kunit/kunit_config.py
@@ -3,16 +3,18 @@
import collections
import re
-CONFIG_IS_NOT_SET_PATTERN = r'^# CONFIG_\w+ is not set$'
-CONFIG_PATTERN = r'^CONFIG_\w+=\S+$'
+CONFIG_IS_NOT_SET_PATTERN = r'^# CONFIG_(\w+) is not set$'
+CONFIG_PATTERN = r'^CONFIG_(\w+)=(\S+)$'
-KconfigEntryBase = collections.namedtuple('KconfigEntry', ['raw_entry'])
-
+KconfigEntryBase = collections.namedtuple('KconfigEntry', ['name', 'value'])
class KconfigEntry(KconfigEntryBase):
def __str__(self) -> str:
- return self.raw_entry
+ if self.value == 'n':
+ return r'# CONFIG_%s is not set' % (self.name)
+ else:
+ return r'CONFIG_%s=%s' % (self.name, self.value)
class KconfigParseError(Exception):
@@ -32,7 +34,17 @@
self._entries.append(entry)
def is_subset_of(self, other: "Kconfig") -> bool:
- return self.entries().issubset(other.entries())
+ for a in self.entries():
+ found = False
+ for b in other.entries():
+ if a.name != b.name:
+ continue
+ if a.value != b.value:
+ return False
+ found = True
+ if a.value != 'n' and found == False:
+ return False
+ return True
def write_to_file(self, path: str) -> None:
with open(path, 'w') as f:
@@ -48,9 +60,20 @@
line = line.strip()
if not line:
continue
- elif config_matcher.match(line) or is_not_set_matcher.match(line):
- self._entries.append(KconfigEntry(line))
- elif line[0] == '#':
+
+ match = config_matcher.match(line)
+ if match:
+ entry = KconfigEntry(match.group(1), match.group(2))
+ self.add_entry(entry)
+ continue
+
+ empty_match = is_not_set_matcher.match(line)
+ if empty_match:
+ entry = KconfigEntry(empty_match.group(1), 'n')
+ self.add_entry(entry)
+ continue
+
+ if line[0] == '#':
continue
else:
raise KconfigParseError('Failed to parse: ' + line)
diff --git a/tools/testing/kunit/kunit_test.py b/tools/testing/kunit/kunit_test.py
index 7e3be7a..a22eef9 100755
--- a/tools/testing/kunit/kunit_test.py
+++ b/tools/testing/kunit/kunit_test.py
@@ -31,7 +31,7 @@
self.assertTrue(kconfig0.is_subset_of(kconfig0))
kconfig1 = kunit_config.Kconfig()
- kconfig1.add_entry(kunit_config.KconfigEntry('CONFIG_TEST=y'))
+ kconfig1.add_entry(kunit_config.KconfigEntry('TEST','y'))
self.assertTrue(kconfig1.is_subset_of(kconfig1))
self.assertTrue(kconfig0.is_subset_of(kconfig1))
self.assertFalse(kconfig1.is_subset_of(kconfig0))
@@ -45,15 +45,15 @@
expected_kconfig = kunit_config.Kconfig()
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_UML=y'))
+ kunit_config.KconfigEntry('UML','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_MMU=y'))
+ kunit_config.KconfigEntry('MMU','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_TEST=y'))
+ kunit_config.KconfigEntry('TEST','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_EXAMPLE_TEST=y'))
+ kunit_config.KconfigEntry('EXAMPLE_TEST','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('# CONFIG_MK8 is not set'))
+ kunit_config.KconfigEntry('MK8','n'))
self.assertEqual(kconfig.entries(), expected_kconfig.entries())
@@ -62,15 +62,15 @@
expected_kconfig = kunit_config.Kconfig()
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_UML=y'))
+ kunit_config.KconfigEntry('UML','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_MMU=y'))
+ kunit_config.KconfigEntry('MMU','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_TEST=y'))
+ kunit_config.KconfigEntry('TEST','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('CONFIG_EXAMPLE_TEST=y'))
+ kunit_config.KconfigEntry('EXAMPLE_TEST','y'))
expected_kconfig.add_entry(
- kunit_config.KconfigEntry('# CONFIG_MK8 is not set'))
+ kunit_config.KconfigEntry('MK8','n'))
expected_kconfig.write_to_file(kconfig_path)
@@ -287,7 +287,7 @@
def test_not_subset_throw_exception(self):
supersetConfig = kunit_config.Kconfig()
subsetConfig = kunit_config.Kconfig()
- subsetConfig.add_entry(kunit_config.KconfigEntry('CONFIG_TEST=y'))
+ subsetConfig.add_entry(kunit_config.KconfigEntry('TEST','y'))
with self.assertRaises(kunit_kernel.ConfigError):
kunit_kernel.throw_error_if_not_subset(supersetConfig, subsetConfig)
@@ -295,16 +295,16 @@
def test_not_subset_no_exception(self):
subsetConfig = kunit_config.Kconfig()
supersetConfig = kunit_config.Kconfig()
- supersetConfig.add_entry(kunit_config.KconfigEntry('CONFIG_TEST=y'))
+ supersetConfig.add_entry(kunit_config.KconfigEntry('TEST','y'))
kunit_kernel.throw_error_if_not_subset(supersetConfig, subsetConfig)
def test_build_reconfig_no_change(self):
tempConfig = tempfile.NamedTemporaryFile(delete=False, mode="w+")
kconfig = kunit_config.Kconfig()
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_TEST=y'))
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_MMU=y'))
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_UML=y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('TEST','y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('MMU','y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('UML','y'))
operations = TestLinuxSourceTreeOperationsNoChange(tempConfig.name)
@@ -323,9 +323,9 @@
tempConfig = tempfile.NamedTemporaryFile(delete=False, mode="w+")
kconfig = kunit_config.Kconfig()
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_TEST=y'))
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_MMU=y'))
- kconfig.add_entry(kunit_config.KconfigEntry('CONFIG_UML=y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('TEST','y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('MMU','y'))
+ kconfig.add_entry(kunit_config.KconfigEntry('UML','y'))
operations = TestLinuxSourceTreeOperationsDeleteLine(tempConfig.name)
