Commit 97752c39 authored by David Gow's avatar David Gow Committed by Shuah Khan
Browse files

kunit: kunit_tool: Allow .kunitconfig to disable config items 



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: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarBrendan Higgins <brendanhiggins@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 2d68df6c

tools/testing/kunit/kunit_config.py

+32 −9
Original line number Diff line number Diff line
@@ -9,16 +9,18 @@ 
import collections

import re



CONFIG_IS_NOT_SET_PATTERN = r'^# CONFIG_\w+ is not set$'

CONFIG_PATTERN = r'^CONFIG_\w+=\S+$'



KconfigEntryBase = collections.namedtuple('KconfigEntry', ['raw_entry'])

CONFIG_IS_NOT_SET_PATTERN = r'^# CONFIG_(\w+) is not set$'

CONFIG_PATTERN = r'^CONFIG_(\w+)=(\S+)$'



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):
@@ -38,7 +40,17 @@ class Kconfig(object): 
		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:
@@ -54,9 +66,20 @@ class Kconfig(object): 
			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)

tools/testing/kunit/kunit_tool_test.py

+11 −11
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ class KconfigTest(unittest.TestCase): 
		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))
@@ -51,15 +51,15 @@ class KconfigTest(unittest.TestCase): 


		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())
@@ -68,15 +68,15 @@ class KconfigTest(unittest.TestCase): 


		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)