Received-SPF: pass (google.com: domain of linux-kernel+bounces-51653-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Sun, 04 Feb 2024 14:03:51 +0100
From: Kees Cook <kees@kernel.org>
To: Rae Moar <rmoar@google.com>, frowand.list@gmail.com, davidgow@google.com,
 keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org,
 brendanhiggins@google.com, dlatypov@google.com
CC: tytso@google.com, gustavo.padovan@collabora.com,
 ricardo.canuelo@collabora.com, guillaume.tucker@collabora.com,
 corbet@lwn.net, kernelci@lists.linux.dev, linux-kselftest@vger.kernel.org,
 kunit-dev@googlegroups.com, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org
Subject: Re: [KTAP V2 PATCH v2] ktap_v2: add test metadata
User-Agent: K-9 Mail for Android
In-Reply-To: <20240126221426.4173112-1-rmoar@google.com>
References: <20240126221426.4173112-1-rmoar@google.com>
Message-ID: <6CCB5F6D-EC6C-452A-9D25-0D7B3F9739AB@kernel.org>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain;
 charset=utf-8
Content-Transfer-Encoding: quoted-printable


On January 26, 2024 11:14:26 PM GMT+01:00, Rae Moar <rmoar@google=2Ecom> w=
rote:
> KTAP version 2
> # ktap_test: main
> # ktap_arch: uml
> 1=2E=2E1
>     KTAP version 2
>     # ktap_test: suite_1
>     # ktap_subsystem: example
>     # ktap_test_file: lib/test=2Ec

I think it's a mistake to mix "diagnostics" lines with semantic lines=2E S=
ince the diagnostic prefix is [# ] (hash space) how about make the test met=
adata lines be [#:] (hash colon)=2E For example:


     1=2E=2E2
     ok 1 test_1
     #:ktap_test: test_2
     #:ktap_speed: very_slow
     #:custom_is_flaky: true
     # format-free stuff goes here
     ok 2 test_2
=2E=2E=2E

> ok 1 test_suite
>
>The changes to the KTAP specification outline the format, location, and
>different types of metadata=2E
>
>Here is a link to a version of the KUnit parser that is able to parse tes=
t
>metadata lines for KTAP version 2=2E Note this includes test metadata
>lines for the main level of KTAP=2E
>
>Link: https://kunit-review=2Egooglesource=2Ecom/c/linux/+/5889
>
>Signed-off-by: Rae Moar <rmoar@google=2Ecom>
>---
> Documentation/dev-tools/ktap=2Erst | 163 ++++++++++++++++++++++++++++++-
> 1 file changed, 159 insertions(+), 4 deletions(-)
>
>diff --git a/Documentation/dev-tools/ktap=2Erst b/Documentation/dev-tools=
/ktap=2Erst
>index ff77f4aaa6ef=2E=2E4480eaf5bbc3 100644
>--- a/Documentation/dev-tools/ktap=2Erst
>+++ b/Documentation/dev-tools/ktap=2Erst
>@@ -17,19 +17,20 @@ KTAP test results describe a series of tests (which m=
ay be nested: i=2Ee=2E, test
> can have subtests), each of which can contain both diagnostic data -- e=
=2Eg=2E, log
> lines -- and a final result=2E The test structure and results are
> machine-readable, whereas the diagnostic data is unstructured and is the=
re to

We even say it's unstructured=2E=2E=2E :)


>+prefix must not include spaces or the characters ":" or "_"=2E

Why not _?

--=20
Kees Cook