2021-11-11 18:34:05

by Daniel Latypov

[permalink] [raw]
Subject: [PATCH] kunit: tool: revamp message for invalid kunitconfig

The current error message is precise, but not very clear if you don't
already know what it's talking about, e.g.

> $ make ARCH=um olddefconfig O=.kunit
> ERROR:root:Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, but not in .config: CONFIG_DRM=y

Try to reword the error message so that it's
* your missing options usually have unsatisified dependencies
* if you're on UML, that might be the cause (it is, in this example)

Signed-off-by: Daniel Latypov <[email protected]>
---

Note: this is based on https://lore.kernel.org/linux-kselftest/[email protected]/
There's a fairly trivial merge conflict between these two patches (that
patch changes the line above where this diff starts).

---
tools/testing/kunit/kunit_kernel.py | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py
index 7d459d6d6ff2..350883672be0 100644
--- a/tools/testing/kunit/kunit_kernel.py
+++ b/tools/testing/kunit/kunit_kernel.py
@@ -266,15 +266,17 @@ class LinuxSourceTree(object):
def validate_config(self, build_dir) -> bool:
kconfig_path = get_kconfig_path(build_dir)
validated_kconfig = kunit_config.parse_file(kconfig_path)
- if not self._kconfig.is_subset_of(validated_kconfig):
- invalid = self._kconfig.entries() - validated_kconfig.entries()
- message = 'Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, ' \
- 'but not in .config: %s' % (
- ', '.join([str(e) for e in invalid])
- )
- logging.error(message)
- return False
- return True
+ if self._kconfig.is_subset_of(validated_kconfig):
+ return True
+ invalid = self._kconfig.entries() - validated_kconfig.entries()
+ message = 'Not all Kconfig options selected in kunitconfig were in the generated .config.\n' \
+ 'This is probably due to unsatisfied dependencies.\n' \
+ 'Missing: ' + ', '.join([str(e) for e in invalid])
+ if self._arch == 'um':
+ message += '\nNote: many Kconfig options aren\'t available on UML. You can try running ' \
+ 'on a different architecture with something like "--arch=x86_64".'
+ logging.error(message)
+ return False

def build_config(self, build_dir, make_options) -> bool:
kconfig_path = get_kconfig_path(build_dir)

base-commit: c949316af0a7c2103521aaa39be85392e2f02bab
--
2.34.0.rc1.387.gb447b232ab-goog



2021-11-12 04:53:16

by David Gow

[permalink] [raw]
Subject: Re: [PATCH] kunit: tool: revamp message for invalid kunitconfig

On Fri, Nov 12, 2021 at 2:34 AM Daniel Latypov <[email protected]> wrote:
>
> The current error message is precise, but not very clear if you don't
> already know what it's talking about, e.g.
>
> > $ make ARCH=um olddefconfig O=.kunit
> > ERROR:root:Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, but not in .config: CONFIG_DRM=y
>
> Try to reword the error message so that it's
> * your missing options usually have unsatisified dependencies
> * if you're on UML, that might be the cause (it is, in this example)
>
> Signed-off-by: Daniel Latypov <[email protected]>
> ---

Thanks -- I think this is a good improvement: the previous message was
pretty opaque.

Reviewed-by: David Gow <[email protected]>

>
> Note: this is based on https://lore.kernel.org/linux-kselftest/[email protected]/
> There's a fairly trivial merge conflict between these two patches (that
> patch changes the line above where this diff starts).
>
> ---
> tools/testing/kunit/kunit_kernel.py | 20 +++++++++++---------
> 1 file changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py
> index 7d459d6d6ff2..350883672be0 100644
> --- a/tools/testing/kunit/kunit_kernel.py
> +++ b/tools/testing/kunit/kunit_kernel.py
> @@ -266,15 +266,17 @@ class LinuxSourceTree(object):
> def validate_config(self, build_dir) -> bool:
> kconfig_path = get_kconfig_path(build_dir)
> validated_kconfig = kunit_config.parse_file(kconfig_path)
> - if not self._kconfig.is_subset_of(validated_kconfig):
> - invalid = self._kconfig.entries() - validated_kconfig.entries()
> - message = 'Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, ' \
> - 'but not in .config: %s' % (
> - ', '.join([str(e) for e in invalid])
> - )
> - logging.error(message)
> - return False
> - return True
> + if self._kconfig.is_subset_of(validated_kconfig):
> + return True
> + invalid = self._kconfig.entries() - validated_kconfig.entries()
> + message = 'Not all Kconfig options selected in kunitconfig were in the generated .config.\n' \
> + 'This is probably due to unsatisfied dependencies.\n' \
> + 'Missing: ' + ', '.join([str(e) for e in invalid])
> + if self._arch == 'um':
> + message += '\nNote: many Kconfig options aren\'t available on UML. You can try running ' \
> + 'on a different architecture with something like "--arch=x86_64".'
> + logging.error(message)
> + return False
>
> def build_config(self, build_dir, make_options) -> bool:
> kconfig_path = get_kconfig_path(build_dir)
>
> base-commit: c949316af0a7c2103521aaa39be85392e2f02bab
> --
> 2.34.0.rc1.387.gb447b232ab-goog
>

2021-12-07 22:53:20

by Brendan Higgins

[permalink] [raw]
Subject: Re: [PATCH] kunit: tool: revamp message for invalid kunitconfig

On Thu, Nov 11, 2021 at 1:34 PM Daniel Latypov <[email protected]> wrote:
>
> The current error message is precise, but not very clear if you don't
> already know what it's talking about, e.g.
>
> > $ make ARCH=um olddefconfig O=.kunit
> > ERROR:root:Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, but not in .config: CONFIG_DRM=y
>
> Try to reword the error message so that it's
> * your missing options usually have unsatisified dependencies
> * if you're on UML, that might be the cause (it is, in this example)
>
> Signed-off-by: Daniel Latypov <[email protected]>

Reviewed-by: Brendan Higgins <[email protected]>