Re: [PATCH 3/3] kunit: tool: move kunitconfig parsing into __init__

From: David Gow
Date: Thu Dec 03 2020 - 22:58:02 EST

On Fri, Dec 4, 2020 at 3:41 AM Daniel Latypov <dlatypov@xxxxxxxxxx> wrote:
>
> LinuxSourceTree will unceremoniously crash if the user doesn't call
> read_kunitconfig() first in a number of functions.

This patch seems to partly be reverting the changes here, right:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/tools/testing/kunit?h=kunit&id=fcdb0bc08ced274078f371e1e0fe6421a97fa9f2
(That patch moved the reading of kunitconfig out of __init__)

My overall concern is that, really, there are some operations that
shouldn't need a kunitconfig (even if they do at the moment), so we'd
ideally want at least some of the operations currently under
LinuxSourceTree to be able to be run without first reading a
kunitconfig. Most notably, it'd be nice if kunit.py exec (and hence
LinuxSourceTree::run_kernel()) didn't need a kunitconfig, as the
kernel ought to already be built at this point.

Now, this is all a little bit hypothetical, as we haven't bothered to
make kunit.py exec work without a kunitconfig thus far, but I'm a
touch hesitant to make it harder to bypass the kunitconfig reading
anyway.

>
> Adn currently every place we create an instance, the caller also calls
> create_kunitconfig() and read_kunitconfig().
>
> Move these instead into __init__() so they can't be forgotten and to
> reduce copy-paste.

This seems to now be missing the create_kunitconfig() stuff (see below).
>
> The https://github.com/google/pytype type-checker complained that
> _config wasn't initialized. With this, kunit_tool now type checks
> under both pytype and mypy.
>
> Signed-off-by: Daniel Latypov <dlatypov@xxxxxxxxxx>
> ---
> tools/testing/kunit/kunit.py | 20 ++++----------------
> tools/testing/kunit/kunit_kernel.py | 19 +++++++------------
> 2 files changed, 11 insertions(+), 28 deletions(-)
>
> diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py
> index 08951a114654..b58fb3733cfa 100755
> --- a/tools/testing/kunit/kunit.py
> +++ b/tools/testing/kunit/kunit.py
> @@ -256,10 +256,7 @@ def main(argv, linux=None):
> os.mkdir(cli_args.build_dir)
>
> if not linux:
> - linux = kunit_kernel.LinuxSourceTree()
> -
> - linux.create_kunitconfig(cli_args.build_dir)
> - linux.read_kunitconfig(cli_args.build_dir)
> + linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
>
> request = KunitRequest(cli_args.raw_output,
> cli_args.timeout,
> @@ -277,10 +274,7 @@ def main(argv, linux=None):
> os.mkdir(cli_args.build_dir)
>
> if not linux:
> - linux = kunit_kernel.LinuxSourceTree()
> -
> - linux.create_kunitconfig(cli_args.build_dir)
> - linux.read_kunitconfig(cli_args.build_dir)
> + linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
>
> request = KunitConfigRequest(cli_args.build_dir,
> cli_args.make_options)
> @@ -292,10 +286,7 @@ def main(argv, linux=None):
> sys.exit(1)
> elif cli_args.subcommand == 'build':
> if not linux:
> - linux = kunit_kernel.LinuxSourceTree()
> -
> - linux.create_kunitconfig(cli_args.build_dir)
> - linux.read_kunitconfig(cli_args.build_dir)
> + linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
>
> request = KunitBuildRequest(cli_args.jobs,
> cli_args.build_dir,
> @@ -309,10 +300,7 @@ def main(argv, linux=None):
> sys.exit(1)
> elif cli_args.subcommand == 'exec':
> if not linux:
> - linux = kunit_kernel.LinuxSourceTree()
> -
> - linux.create_kunitconfig(cli_args.build_dir)
> - linux.read_kunitconfig(cli_args.build_dir)
> + linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
>
> exec_request = KunitExecRequest(cli_args.timeout,
> cli_args.build_dir,
> diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py
> index bda7c4fd4d3e..79793031d2c4 100644
> --- a/tools/testing/kunit/kunit_kernel.py
> +++ b/tools/testing/kunit/kunit_kernel.py
> @@ -129,10 +129,15 @@ def get_outfile_path(build_dir) -> str:
> class LinuxSourceTree(object):
> """Represents a Linux kernel source tree with KUnit tests."""
>
> - def __init__(self) -> None:
> - self._ops = LinuxSourceTreeOperations()
> + def __init__(self, build_dir: str, defconfig=DEFAULT_KUNITCONFIG_PATH) -> None:
> signal.signal(signal.SIGINT, self.signal_handler)
>
> + self._ops = LinuxSourceTreeOperations()
> +
> + kunitconfig_path = get_kunitconfig_path(build_dir)
> + self._kconfig = kunit_config.Kconfig()
> + self._kconfig.read_from_file(kunitconfig_path)
> +
> def clean(self) -> bool:
> try:
> self._ops.make_mrproper()
> @@ -141,16 +146,6 @@ class LinuxSourceTree(object):
> return False
> return True
>
> - def create_kunitconfig(self, build_dir, defconfig=DEFAULT_KUNITCONFIG_PATH) -> None:
> - kunitconfig_path = get_kunitconfig_path(build_dir)
> - if not os.path.exists(kunitconfig_path):
> - shutil.copyfile(defconfig, kunitconfig_path)
> -

What happened to create_kunitconfig() here? With this patch, I can no
longer run .../kunit.py run with an empty build_dir and get results,
instead getting:
---
Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 336, in <module>
main(sys.argv[1:])
File "./tools/testing/kunit/kunit.py", line 259, in main
linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
File "./tools/testing/kunit/kunit_kernel.py", line 139, in __init__
self._kconfig.read_from_file(kunitconfig_path)
File "./tools/testing/kunit/kunit_config.py", line 89, in read_from_file
with open(path, 'r') as f:
FileNotFoundError: [Errno 2] No such file or directory: 'asdf/.kunitconfig'
---

Prior to this change, the defconfig is copied over, and the kernel is
built, tests run succesfully.


> - def read_kunitconfig(self, build_dir) -> None:
> - kunitconfig_path = get_kunitconfig_path(build_dir)
> - self._kconfig = kunit_config.Kconfig()
> - self._kconfig.read_from_file(kunitconfig_path)
> -
> def validate_config(self, build_dir) -> bool:
> kconfig_path = get_kconfig_path(build_dir)
> validated_kconfig = kunit_config.Kconfig()
> --
> 2.29.2.576.ga3fc446d84-goog
>