MIME-Version: 1.0
References: <20211111183356.4073001-1-dlatypov@google.com>
In-Reply-To: <20211111183356.4073001-1-dlatypov@google.com>
From:   David Gow <davidgow@google.com>
Date:   Fri, 12 Nov 2021 12:52:56 +0800
Message-ID: <CABVgOSmOd4L+9HPT6ajq8zZ6RLBkHiXXa04F1JZcE83+31+HyQ@mail.gmail.com>
Subject: Re: [PATCH] kunit: tool: revamp message for invalid kunitconfig
To:     Daniel Latypov <dlatypov@google.com>
Cc:     brendanhiggins@google.com, linux-kernel@vger.kernel.org,
        kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org,
        skhan@linuxfoundation.org
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Fri, Nov 12, 2021 at 2:34 AM Daniel Latypov <dlatypov@google.com> 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 <dlatypov@google.com>
> ---

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

Reviewed-by: David Gow <davidgow@google.com>

>
> Note: this is based on https://lore.kernel.org/linux-kselftest/20211106013058.2621799-1-dlatypov@google.com/
> 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
>