lkml.org 
[lkml]   [2020]   [Dec]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v5 14/16] selftests: kselftest_harness.h: partially fix kernel-doc markups
On Tue, Dec 01, 2020 at 01:09:07PM +0100, Mauro Carvalho Chehab wrote:
> The kernel-doc markups on this file are weird: they don't
> follow what's specified at:
>
> Documentation/doc-guide/kernel-doc.rst
>
> In particular, markups should use this format:
> identifier - description
>
> and not this:
> identifier(args)
>
> The way the definitions are inside this file cause the
> parser to completely miss the identifier name of each
> function.
>
> This prevents improving the script to do some needed validation
> tests.
>
> Address this part. Yet, furter changes are needed in order
> for it to fully follow the specs.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> tools/testing/selftests/kselftest_harness.h | 22 ++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
> index edce85420d19..99920466076a 100644
> --- a/tools/testing/selftests/kselftest_harness.h
> +++ b/tools/testing/selftests/kselftest_harness.h
> @@ -50,325 +50,325 @@
> #ifndef __KSELFTEST_HARNESS_H
> #define __KSELFTEST_HARNESS_H
>
> #ifndef _GNU_SOURCE
> #define _GNU_SOURCE
> #endif
> #include <asm/types.h>
> #include <errno.h>
> #include <stdbool.h>
> #include <stdint.h>
> #include <stdio.h>
> #include <stdlib.h>
> #include <string.h>
> #include <sys/mman.h>
> #include <sys/types.h>
> #include <sys/wait.h>
> #include <unistd.h>
>
> #include "kselftest.h"
>
> #define TEST_TIMEOUT_DEFAULT 30
>
> /* Utilities exposed to the test definitions */
> #ifndef TH_LOG_STREAM
> # define TH_LOG_STREAM stderr
> #endif
>
> #ifndef TH_LOG_ENABLED
> # define TH_LOG_ENABLED 1
> #endif
>
> /**
> - * TH_LOG(fmt, ...)
> + * TH_LOG()
> *
> * @fmt: format string
> * @...: optional arguments
> *
> * .. code-block:: c
> *
> * TH_LOG(format, ...)
> *
> * Optional debug logging function available for use in tests.
> * Logging may be enabled or disabled by defining TH_LOG_ENABLED.
> * E.g., #define TH_LOG_ENABLED 1
> *
> * If no definition is provided, logging is enabled by default.
> *
> * If there is no way to print an error message for the process running the
> * test (e.g. not allowed to write to stderr), it is still possible to get the
> * ASSERT_* number for which the test failed. This behavior can be enabled by
> * writing `_metadata->no_print = true;` before the check sequence that is
> * unable to print. When an error occur, instead of printing an error message
> * and calling `abort(3)`, the test process call `_exit(2)` with the assert
> * number as argument, which is then printed by the parent process.
> */
> #define TH_LOG(fmt, ...) do { \
> if (TH_LOG_ENABLED) \
> __TH_LOG(fmt, ##__VA_ARGS__); \
> } while (0)
>
> /* Unconditional logger for internal use. */
> #define __TH_LOG(fmt, ...) \
> fprintf(TH_LOG_STREAM, "# %s:%d:%s:" fmt "\n", \
> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>
> /**
> - * SKIP(statement, fmt, ...)
> + * SKIP()
> *
> * @statement: statement to run after reporting SKIP
> * @fmt: format string
> * @...: optional arguments

Please add something like this to retain the "prototype" details:

* .. code-block:: c
*
* SKIP(statement, fmt, ...);

With that added, sure, looks good:

Acked-by: Kees Cook <keescook@chromium.org>

Thanks!

> *
> * Optional debug logging function available for use in tests.
> *
> * This forces a "pass" after reporting why something is being skipped
> * and runs "statement", which is usually "return" or "goto skip".
> */
> #define SKIP(statement, fmt, ...) do { \
> snprintf(_metadata->results->reason, \
> sizeof(_metadata->results->reason), fmt, ##__VA_ARGS__); \
> if (TH_LOG_ENABLED) { \
> fprintf(TH_LOG_STREAM, "# SKIP %s\n", \
> _metadata->results->reason); \
> } \
> _metadata->passed = 1; \
> _metadata->skip = 1; \
> _metadata->trigger = 0; \
> statement; \
> } while (0)
>
> /**
> - * TEST(test_name) - Defines the test function and creates the registration
> + * TEST() - Defines the test function and creates the registration
> * stub
> *
> * @test_name: test name
> *
> * .. code-block:: c
> *
> * TEST(name) { implementation }
> *
> * Defines a test by name.
> * Names must be unique and tests must not be run in parallel. The
> * implementation containing block is a function and scoping should be treated
> * as such. Returning early may be performed with a bare "return;" statement.
> *
> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
> */
> #define TEST(test_name) __TEST_IMPL(test_name, -1)
>
> /**
> - * TEST_SIGNAL(test_name, signal)
> + * TEST_SIGNAL()
> *
> * @test_name: test name
> * @signal: signal number
> *
> * .. code-block:: c
> *
> * TEST_SIGNAL(name, signal) { implementation }
> *
> * Defines a test by name and the expected term signal.
> * Names must be unique and tests must not be run in parallel. The
> * implementation containing block is a function and scoping should be treated
> * as such. Returning early may be performed with a bare "return;" statement.
> *
> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
> */
> #define TEST_SIGNAL(test_name, signal) __TEST_IMPL(test_name, signal)
>
> #define __TEST_IMPL(test_name, _signal) \
> static void test_name(struct __test_metadata *_metadata); \
> static inline void wrapper_##test_name( \
> struct __test_metadata *_metadata, \
> struct __fixture_variant_metadata *variant) \
> { \
> test_name(_metadata); \
> } \
> static struct __test_metadata _##test_name##_object = \
> { .name = #test_name, \
> .fn = &wrapper_##test_name, \
> .fixture = &_fixture_global, \
> .termsig = _signal, \
> .timeout = TEST_TIMEOUT_DEFAULT, }; \
> static void __attribute__((constructor)) _register_##test_name(void) \
> { \
> __register_test(&_##test_name##_object); \
> } \
> static void test_name( \
> struct __test_metadata __attribute__((unused)) *_metadata)
>
> /**
> - * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
> + * FIXTURE_DATA() - Wraps the struct name so we have one less
> * argument to pass around
> *
> * @datatype_name: datatype name
> *
> * .. code-block:: c
> *
> * FIXTURE_DATA(datatype_name)
> *
> * Almost always, you want just FIXTURE() instead (see below).
> * This call may be used when the type of the fixture data
> * is needed. In general, this should not be needed unless
> * the *self* is being passed to a helper directly.
> */
> #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>
> /**
> - * FIXTURE(fixture_name) - Called once per fixture to setup the data and
> + * FIXTURE() - Called once per fixture to setup the data and
> * register
> *
> * @fixture_name: fixture name
> *
> * .. code-block:: c
> *
> * FIXTURE(fixture_name) {
> * type property1;
> * ...
> * };
> *
> * Defines the data provided to TEST_F()-defined tests as *self*. It should be
> * populated and cleaned up using FIXTURE_SETUP() and FIXTURE_TEARDOWN().
> */
> #define FIXTURE(fixture_name) \
> FIXTURE_VARIANT(fixture_name); \
> static struct __fixture_metadata _##fixture_name##_fixture_object = \
> { .name = #fixture_name, }; \
> static void __attribute__((constructor)) \
> _register_##fixture_name##_data(void) \
> { \
> __register_fixture(&_##fixture_name##_fixture_object); \
> } \
> FIXTURE_DATA(fixture_name)
>
> /**
> - * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
> + * FIXTURE_SETUP() - Prepares the setup function for the fixture.
> * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
> *
> * @fixture_name: fixture name
> *
> * .. code-block:: c
> *
> * FIXTURE_SETUP(fixture_name) { implementation }
> *
> * Populates the required "setup" function for a fixture. An instance of the
> * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
> * implementation.
> *
> * ASSERT_* are valid for use in this context and will prempt the execution
> * of any dependent fixture tests.
> *
> * A bare "return;" statement may be used to return early.
> */
> #define FIXTURE_SETUP(fixture_name) \
> void fixture_name##_setup( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self, \
> const FIXTURE_VARIANT(fixture_name) \
> __attribute__((unused)) *variant)
>
> /**
> - * FIXTURE_TEARDOWN(fixture_name)
> + * FIXTURE_TEARDOWN()
> * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly.
> *
> * @fixture_name: fixture name
> *
> * .. code-block:: c
> *
> * FIXTURE_TEARDOWN(fixture_name) { implementation }
> *
> * Populates the required "teardown" function for a fixture. An instance of the
> * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
> * implementation to clean up.
> *
> * A bare "return;" statement may be used to return early.
> */
> #define FIXTURE_TEARDOWN(fixture_name) \
> void fixture_name##_teardown( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> /**
> - * FIXTURE_VARIANT(fixture_name) - Optionally called once per fixture
> + * FIXTURE_VARIANT() - Optionally called once per fixture
> * to declare fixture variant
> *
> * @fixture_name: fixture name
> *
> * .. code-block:: c
> *
> * FIXTURE_VARIANT(fixture_name) {
> * type property1;
> * ...
> * };
> *
> * Defines type of constant parameters provided to FIXTURE_SETUP() and TEST_F()
> * as *variant*. Variants allow the same tests to be run with different
> * arguments.
> */
> #define FIXTURE_VARIANT(fixture_name) struct _fixture_variant_##fixture_name
>
> /**
> - * FIXTURE_VARIANT_ADD(fixture_name, variant_name) - Called once per fixture
> + * FIXTURE_VARIANT_ADD() - Called once per fixture
> * variant to setup and register the data
> *
> * @fixture_name: fixture name
> * @variant_name: name of the parameter set
> *
> * .. code-block:: c
> *
> * FIXTURE_VARIANT_ADD(fixture_name, variant_name) {
> * .property1 = val1,
> * ...
> * };
> *
> * Defines a variant of the test fixture, provided to FIXTURE_SETUP() and
> * TEST_F() as *variant*. Tests of each fixture will be run once for each
> * variant.
> */
> #define FIXTURE_VARIANT_ADD(fixture_name, variant_name) \
> extern FIXTURE_VARIANT(fixture_name) \
> _##fixture_name##_##variant_name##_variant; \
> static struct __fixture_variant_metadata \
> _##fixture_name##_##variant_name##_object = \
> { .name = #variant_name, \
> .data = &_##fixture_name##_##variant_name##_variant}; \
> static void __attribute__((constructor)) \
> _register_##fixture_name##_##variant_name(void) \
> { \
> __register_fixture_variant(&_##fixture_name##_fixture_object, \
> &_##fixture_name##_##variant_name##_object); \
> } \
> FIXTURE_VARIANT(fixture_name) \
> _##fixture_name##_##variant_name##_variant =
>
> /**
> - * TEST_F(fixture_name, test_name) - Emits test registration and helpers for
> + * TEST_F() - Emits test registration and helpers for
> * fixture-based test cases
> *
> * @fixture_name: fixture name
> * @test_name: test name
> *
> * .. code-block:: c
> *
> * TEST_F(fixture, name) { implementation }
> *
> * Defines a test that depends on a fixture (e.g., is part of a test case).
> * Very similar to TEST() except that *self* is the setup instance of fixture's
> * datatype exposed for use by the implementation.
> *
> * Warning: use of ASSERT_* here will skip TEARDOWN.
> */
> /* TODO(wad) register fixtures on dedicated test lists. */
> #define TEST_F(fixture_name, test_name) \
> __TEST_F_IMPL(fixture_name, test_name, -1, TEST_TIMEOUT_DEFAULT)
>
> #define TEST_F_SIGNAL(fixture_name, test_name, signal) \
> __TEST_F_IMPL(fixture_name, test_name, signal, TEST_TIMEOUT_DEFAULT)
>
> #define TEST_F_TIMEOUT(fixture_name, test_name, timeout) \
> __TEST_F_IMPL(fixture_name, test_name, -1, timeout)
>
> #define __TEST_F_IMPL(fixture_name, test_name, signal, tmout) \
> static void fixture_name##_##test_name( \
> struct __test_metadata *_metadata, \
> FIXTURE_DATA(fixture_name) *self, \
> const FIXTURE_VARIANT(fixture_name) *variant); \
> static inline void wrapper_##fixture_name##_##test_name( \
> struct __test_metadata *_metadata, \
> --
> 2.28.0
>

--
Kees Cook

\
 
 \ /
  Last update: 2020-12-01 22:20    [W:0.250 / U:1.312 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site