* [PATCH v5 0/7] Add kselftest_harness.h
@ 2017-05-26 18:43 Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 1/7] selftests: Make test_harness.h more generally available Mickaël Salaün
` (7 more replies)
0 siblings, 8 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:43 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Hi,
This patch series make the seccomp/test_harness.h more generally available [1]
and update the kselftest documentation in the Sphinx format. It also improve
the Makefile of seccomp tests to take into account any kselftest_harness.h
update.
[1] https://lkml.kernel.org/r/CAGXu5j+8CVz8vL51DRYXqOY=xc3zuKFf=PTENe88XYHzFYidUQ@mail.gmail.com
Regards,
Mickaël Salaün (7):
selftests: Make test_harness.h more generally available
selftests: Cosmetic renames in kselftest_harness.h
selftests/seccomp: Force rebuild according to dependencies
Documentation/dev-tools: Add kselftest
Documentation/dev-tools: Use reStructuredText markups for kselftest
selftests: Remove the TEST_API() wrapper from kselftest_harness.h
Documentation/dev-tools: Add kselftest_harness documentation
Documentation/00-INDEX | 2 -
Documentation/dev-tools/index.rst | 1 +
.../{kselftest.txt => dev-tools/kselftest.rst} | 101 ++-
MAINTAINERS | 1 +
.../test_harness.h => kselftest_harness.h} | 691 +++++++++++++--------
tools/testing/selftests/seccomp/Makefile | 2 +
tools/testing/selftests/seccomp/seccomp_bpf.c | 2 +-
7 files changed, 520 insertions(+), 280 deletions(-)
rename Documentation/{kselftest.txt => dev-tools/kselftest.rst} (52%)
rename tools/testing/selftests/{seccomp/test_harness.h => kselftest_harness.h} (52%)
--
2.11.0
^ permalink raw reply [flat|nested] 18+ messages in thread
* [PATCH v5 1/7] selftests: Make test_harness.h more generally available
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
@ 2017-05-26 18:43 ` Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 2/7] selftests: Cosmetic renames in kselftest_harness.h Mickaël Salaün
` (6 subsequent siblings)
7 siblings, 0 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:43 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
The seccomp/test_harness.h file contains useful helpers to build tests.
Moving it to the selftest directory should benefit to other test
components.
Keep seccomp maintainers for this file.
Changes since v1:
* rename to kselftest_harness.h (suggested by Shuah Khan)
* keep maintainers
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Acked-by: Will Drewry <wad@chromium.org>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Shuah Khan <shuah@kernel.org>
Link: https://lkml.kernel.org/r/CAGXu5j+8CVz8vL51DRYXqOY=xc3zuKFf=PTENe88XYHzFYidUQ@mail.gmail.com
---
MAINTAINERS | 1 +
tools/testing/selftests/{seccomp/test_harness.h => kselftest_harness.h} | 0
tools/testing/selftests/seccomp/seccomp_bpf.c | 2 +-
3 files changed, 2 insertions(+), 1 deletion(-)
rename tools/testing/selftests/{seccomp/test_harness.h => kselftest_harness.h} (100%)
diff --git a/MAINTAINERS b/MAINTAINERS
index f7d568b8f133..ef292b8c771d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11492,6 +11492,7 @@ F: kernel/seccomp.c
F: include/uapi/linux/seccomp.h
F: include/linux/seccomp.h
F: tools/testing/selftests/seccomp/*
+F: tools/testing/selftests/kselftest_harness.h
K: \bsecure_computing
K: \bTIF_SECCOMP\b
diff --git a/tools/testing/selftests/seccomp/test_harness.h b/tools/testing/selftests/kselftest_harness.h
similarity index 100%
rename from tools/testing/selftests/seccomp/test_harness.h
rename to tools/testing/selftests/kselftest_harness.h
diff --git a/tools/testing/selftests/seccomp/seccomp_bpf.c b/tools/testing/selftests/seccomp/seccomp_bpf.c
index 03f1fa495d74..7ba94efb24fd 100644
--- a/tools/testing/selftests/seccomp/seccomp_bpf.c
+++ b/tools/testing/selftests/seccomp/seccomp_bpf.c
@@ -37,7 +37,7 @@
#include <unistd.h>
#include <sys/syscall.h>
-#include "test_harness.h"
+#include "../kselftest_harness.h"
#ifndef PR_SET_PTRACER
# define PR_SET_PTRACER 0x59616d61
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 2/7] selftests: Cosmetic renames in kselftest_harness.h
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 1/7] selftests: Make test_harness.h more generally available Mickaël Salaün
@ 2017-05-26 18:43 ` Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies Mickaël Salaün
` (5 subsequent siblings)
7 siblings, 0 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:43 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Keep the content consistent with the new name.
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Will Drewry <wad@chromium.org>
---
tools/testing/selftests/kselftest_harness.h | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
index a786c69c7584..171e70aead9c 100644
--- a/tools/testing/selftests/kselftest_harness.h
+++ b/tools/testing/selftests/kselftest_harness.h
@@ -2,10 +2,10 @@
* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by the GPLv2 license.
*
- * test_harness.h: simple C unit test helper.
+ * kselftest_harness.h: simple C unit test helper.
*
* Usage:
- * #include "test_harness.h"
+ * #include "../kselftest_harness.h"
* TEST(standalone_test) {
* do_some_stuff;
* EXPECT_GT(10, stuff) {
@@ -38,8 +38,9 @@
*
* API inspired by code.google.com/p/googletest
*/
-#ifndef TEST_HARNESS_H_
-#define TEST_HARNESS_H_
+
+#ifndef __KSELFTEST_HARNESS_H
+#define __KSELFTEST_HARNESS_H
#define _GNU_SOURCE
#include <stdint.h>
@@ -532,4 +533,4 @@ static void __attribute__((constructor)) __constructor_order_first(void)
__constructor_order = _CONSTRUCTOR_ORDER_FORWARD;
}
-#endif /* TEST_HARNESS_H_ */
+#endif /* __KSELFTEST_HARNESS_H */
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 1/7] selftests: Make test_harness.h more generally available Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 2/7] selftests: Cosmetic renames in kselftest_harness.h Mickaël Salaün
@ 2017-05-26 18:43 ` Mickaël Salaün
2017-06-02 19:31 ` Shuah Khan
2017-05-26 18:43 ` [PATCH v5 4/7] Documentation/dev-tools: Add kselftest Mickaël Salaün
` (4 subsequent siblings)
7 siblings, 1 reply; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:43 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Rebuild the seccomp tests when kselftest_harness.h is updated.
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Will Drewry <wad@chromium.org>
---
tools/testing/selftests/seccomp/Makefile | 2 ++
1 file changed, 2 insertions(+)
diff --git a/tools/testing/selftests/seccomp/Makefile b/tools/testing/selftests/seccomp/Makefile
index 5fa6fd2246b1..aeb0c805f3ca 100644
--- a/tools/testing/selftests/seccomp/Makefile
+++ b/tools/testing/selftests/seccomp/Makefile
@@ -4,3 +4,5 @@ LDFLAGS += -lpthread
include ../lib.mk
+$(TEST_GEN_PROGS): seccomp_bpf.c ../kselftest_harness.h
+ $(CC) $(CFLAGS) $(LDFLAGS) $< -o $@
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 4/7] Documentation/dev-tools: Add kselftest
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
` (2 preceding siblings ...)
2017-05-26 18:43 ` [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies Mickaël Salaün
@ 2017-05-26 18:43 ` Mickaël Salaün
2017-05-26 18:44 ` [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest Mickaël Salaün
` (3 subsequent siblings)
7 siblings, 0 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:43 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Move kselftest.txt to dev-tools/kselftest.rst .
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
---
Documentation/00-INDEX | 2 --
Documentation/{kselftest.txt => dev-tools/kselftest.rst} | 0
2 files changed, 2 deletions(-)
rename Documentation/{kselftest.txt => dev-tools/kselftest.rst} (100%)
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index ed3e5e949fce..6daf51536153 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -246,8 +246,6 @@ kprobes.txt
- documents the kernel probes debugging feature.
kref.txt
- docs on adding reference counters (krefs) to kernel objects.
-kselftest.txt
- - small unittests for (some) individual codepaths in the kernel.
laptops/
- directory with laptop related info and laptop driver documentation.
ldm.txt
diff --git a/Documentation/kselftest.txt b/Documentation/dev-tools/kselftest.rst
similarity index 100%
rename from Documentation/kselftest.txt
rename to Documentation/dev-tools/kselftest.rst
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
` (3 preceding siblings ...)
2017-05-26 18:43 ` [PATCH v5 4/7] Documentation/dev-tools: Add kselftest Mickaël Salaün
@ 2017-05-26 18:44 ` Mickaël Salaün
2017-05-26 18:44 ` [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Mickaël Salaün
` (2 subsequent siblings)
7 siblings, 0 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:44 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Include and convert kselftest to the Sphinx format.
Changes since v2:
* lighten the modifications (suggested by Kees Cook)
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
---
Documentation/dev-tools/index.rst | 1 +
Documentation/dev-tools/kselftest.rst | 67 +++++++++++++++++++++--------------
2 files changed, 41 insertions(+), 27 deletions(-)
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index 07d881147ef3..e50054c6aeaa 100644
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -23,6 +23,7 @@ whole; patches welcome!
kmemleak
kmemcheck
gdb-kernel-debugging
+ kselftest
.. only:: subproject and html
diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index 5bd590335839..9232ce94612c 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -1,4 +1,6 @@
+======================
Linux Kernel Selftests
+======================
The kernel contains a set of "self tests" under the tools/testing/selftests/
directory. These are intended to be small tests to exercise individual code
@@ -15,29 +17,34 @@ hotplug test is run on 2% of hotplug capable memory instead of 10%.
Running the selftests (hotplug tests are run in limited mode)
=============================================================
-To build the tests:
- $ make -C tools/testing/selftests
+To build the tests::
+ make -C tools/testing/selftests
-To run the tests:
- $ make -C tools/testing/selftests run_tests
+To run the tests::
-To build and run the tests with a single command, use:
- $ make kselftest
+ make -C tools/testing/selftests run_tests
-- note that some tests will require root privileges.
+To build and run the tests with a single command, use::
+
+ make kselftest
+
+Note that some tests will require root privileges.
Running a subset of selftests
-========================================
+=============================
+
You can use the "TARGETS" variable on the make command line to specify
single test to run, or a list of tests to run.
-To run only tests targeted for a single subsystem:
- $ make -C tools/testing/selftests TARGETS=ptrace run_tests
+To run only tests targeted for a single subsystem::
-You can specify multiple tests to build and run:
- $ make TARGETS="size timers" kselftest
+ make -C tools/testing/selftests TARGETS=ptrace run_tests
+
+You can specify multiple tests to build and run::
+
+ make TARGETS="size timers" kselftest
See the top-level tools/testing/selftests/Makefile for the list of all
possible targets.
@@ -46,13 +53,15 @@ possible targets.
Running the full range hotplug selftests
========================================
-To build the hotplug tests:
- $ make -C tools/testing/selftests hotplug
+To build the hotplug tests::
-To run the hotplug tests:
- $ make -C tools/testing/selftests run_hotplug
+ make -C tools/testing/selftests hotplug
-- note that some tests will require root privileges.
+To run the hotplug tests::
+
+ make -C tools/testing/selftests run_hotplug
+
+Note that some tests will require root privileges.
Install selftests
@@ -62,13 +71,15 @@ You can use kselftest_install.sh tool installs selftests in default
location which is tools/testing/selftests/kselftest or a user specified
location.
-To install selftests in default location:
- $ cd tools/testing/selftests
- $ ./kselftest_install.sh
+To install selftests in default location::
-To install selftests in a user specified location:
- $ cd tools/testing/selftests
- $ ./kselftest_install.sh install_dir
+ cd tools/testing/selftests
+ ./kselftest_install.sh
+
+To install selftests in a user specified location::
+
+ cd tools/testing/selftests
+ ./kselftest_install.sh install_dir
Running installed selftests
===========================
@@ -79,8 +90,10 @@ named "run_kselftest.sh" to run the tests.
You can simply do the following to run the installed Kselftests. Please
note some tests will require root privileges.
-cd kselftest
-./run_kselftest.sh
+::
+
+ cd kselftest
+ ./run_kselftest.sh
Contributing new tests
======================
@@ -96,8 +109,8 @@ In general, the rules for selftests are
* Don't cause the top-level "make run_tests" to fail if your feature is
unconfigured.
-Contributing new tests(details)
-===============================
+Contributing new tests (details)
+================================
* Use TEST_GEN_XXX if such binaries or files are generated during
compiling.
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
` (4 preceding siblings ...)
2017-05-26 18:44 ` [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest Mickaël Salaün
@ 2017-05-26 18:44 ` Mickaël Salaün
2017-05-26 19:07 ` Kees Cook
2017-05-26 18:44 ` [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün
2017-05-26 19:09 ` [PATCH v5 0/7] Add kselftest_harness.h Kees Cook
7 siblings, 1 reply; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:44 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Remove the TEST_API() wrapper to expose the underlying macro arguments
to the documentation tools.
Use "git diff --patience" to get a more readable patch.
Changes since v4:
* standalone patch to ease the review (requested by Kees Cook)
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Kees Cook <keescook@chromium.org>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Will Drewry <wad@chromium.org>
---
tools/testing/selftests/kselftest_harness.h | 349 ++++++++++++----------------
1 file changed, 147 insertions(+), 202 deletions(-)
diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
index 171e70aead9c..45f807ce37e1 100644
--- a/tools/testing/selftests/kselftest_harness.h
+++ b/tools/testing/selftests/kselftest_harness.h
@@ -51,147 +51,6 @@
#include <sys/wait.h>
#include <unistd.h>
-/* All exported functionality should be declared through this macro. */
-#define TEST_API(x) _##x
-
-/*
- * Exported APIs
- */
-
-/* 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_API(TEST)
-
-/* 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_API(TEST_SIGNAL)
-
-/* FIXTURE(datatype 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 TEST_API(FIXTURE)
-
-/* FIXTURE_DATA(datatype name)
- * 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 TEST_API(FIXTURE_DATA)
-
-/* 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 TEST_API(FIXTURE_SETUP)
-
-/* 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 TEST_API(FIXTURE_TEARDOWN)
-
-/* 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.
- */
-#define TEST_F TEST_API(TEST_F)
-
-#define TEST_F_SIGNAL TEST_API(TEST_F_SIGNAL)
-
-/* Use once to append a main() to the test file. E.g.,
- * TEST_HARNESS_MAIN
- */
-#define TEST_HARNESS_MAIN TEST_API(TEST_HARNESS_MAIN)
-
-/*
- * Operators for use in TEST and TEST_F.
- * ASSERT_* calls will stop test execution immediately.
- * EXPECT_* calls will emit a failure warning, note it, and continue.
- */
-
-/* ASSERT_EQ(expected, measured): expected == measured */
-#define ASSERT_EQ TEST_API(ASSERT_EQ)
-/* ASSERT_NE(expected, measured): expected != measured */
-#define ASSERT_NE TEST_API(ASSERT_NE)
-/* ASSERT_LT(expected, measured): expected < measured */
-#define ASSERT_LT TEST_API(ASSERT_LT)
-/* ASSERT_LE(expected, measured): expected <= measured */
-#define ASSERT_LE TEST_API(ASSERT_LE)
-/* ASSERT_GT(expected, measured): expected > measured */
-#define ASSERT_GT TEST_API(ASSERT_GT)
-/* ASSERT_GE(expected, measured): expected >= measured */
-#define ASSERT_GE TEST_API(ASSERT_GE)
-/* ASSERT_NULL(measured): NULL == measured */
-#define ASSERT_NULL TEST_API(ASSERT_NULL)
-/* ASSERT_TRUE(measured): measured != 0 */
-#define ASSERT_TRUE TEST_API(ASSERT_TRUE)
-/* ASSERT_FALSE(measured): measured == 0 */
-#define ASSERT_FALSE TEST_API(ASSERT_FALSE)
-/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
-#define ASSERT_STREQ TEST_API(ASSERT_STREQ)
-/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
-#define ASSERT_STRNE TEST_API(ASSERT_STRNE)
-/* EXPECT_EQ(expected, measured): expected == measured */
-#define EXPECT_EQ TEST_API(EXPECT_EQ)
-/* EXPECT_NE(expected, measured): expected != measured */
-#define EXPECT_NE TEST_API(EXPECT_NE)
-/* EXPECT_LT(expected, measured): expected < measured */
-#define EXPECT_LT TEST_API(EXPECT_LT)
-/* EXPECT_LE(expected, measured): expected <= measured */
-#define EXPECT_LE TEST_API(EXPECT_LE)
-/* EXPECT_GT(expected, measured): expected > measured */
-#define EXPECT_GT TEST_API(EXPECT_GT)
-/* EXPECT_GE(expected, measured): expected >= measured */
-#define EXPECT_GE TEST_API(EXPECT_GE)
-/* EXPECT_NULL(measured): NULL == measured */
-#define EXPECT_NULL TEST_API(EXPECT_NULL)
-/* EXPECT_TRUE(measured): 0 != measured */
-#define EXPECT_TRUE TEST_API(EXPECT_TRUE)
-/* EXPECT_FALSE(measured): 0 == measured */
-#define EXPECT_FALSE TEST_API(EXPECT_FALSE)
-/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
-#define EXPECT_STREQ TEST_API(EXPECT_STREQ)
-/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
-#define EXPECT_STRNE TEST_API(EXPECT_STRNE)
-
-/* 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.
- */
-#define TH_LOG TEST_API(TH_LOG)
-
-/*
- * Internal implementation.
- *
- */
/* Utilities exposed to the test definitions */
#ifndef TH_LOG_STREAM
@@ -202,7 +61,13 @@
# define TH_LOG_ENABLED 1
#endif
-#define _TH_LOG(fmt, ...) do { \
+/* 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.
+ */
+#define TH_LOG(fmt, ...) do { \
if (TH_LOG_ENABLED) \
__TH_LOG(fmt, ##__VA_ARGS__); \
} while (0)
@@ -212,10 +77,26 @@
fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
__FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
+/* 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.
+ */
/* Defines the test function and creates the registration stub. */
-#define _TEST(test_name) __TEST_IMPL(test_name, -1)
+#define TEST(test_name) __TEST_IMPL(test_name, -1)
-#define _TEST_SIGNAL(test_name, signal) __TEST_IMPL(test_name, signal)
+/* 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); \
@@ -229,50 +110,84 @@
static void test_name( \
struct __test_metadata __attribute__((unused)) *_metadata)
+/* FIXTURE_DATA(datatype name)
+ * 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.
+ */
/* Wraps the struct name so we have one less argument to pass around. */
-#define _FIXTURE_DATA(fixture_name) struct _test_data_##fixture_name
+#define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
+/* FIXTURE(datatype 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.
+ */
/* Called once per fixture to setup the data and register. */
-#define _FIXTURE(fixture_name) \
+#define FIXTURE(fixture_name) \
static void __attribute__((constructor)) \
_register_##fixture_name##_data(void) \
{ \
__fixture_count++; \
} \
- _FIXTURE_DATA(fixture_name)
+ FIXTURE_DATA(fixture_name)
+/* 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.
+ */
/* Prepares the setup function for the fixture. |_metadata| is included
* so that ASSERT_* work as a convenience.
*/
-#define _FIXTURE_SETUP(fixture_name) \
+#define FIXTURE_SETUP(fixture_name) \
void fixture_name##_setup( \
struct __test_metadata __attribute__((unused)) *_metadata, \
- _FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
-#define _FIXTURE_TEARDOWN(fixture_name) \
+ FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
+/* 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_DATA(fixture_name) __attribute__((unused)) *self)
+/* 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.
+ */
/* Emits test registration and helpers for fixture-based test
* cases.
* TODO(wad) register fixtures on dedicated test lists.
*/
-#define _TEST_F(fixture_name, test_name) \
+#define TEST_F(fixture_name, test_name) \
__TEST_F_IMPL(fixture_name, test_name, -1)
-#define _TEST_F_SIGNAL(fixture_name, test_name, signal) \
+#define TEST_F_SIGNAL(fixture_name, test_name, signal) \
__TEST_F_IMPL(fixture_name, test_name, signal)
#define __TEST_F_IMPL(fixture_name, test_name, signal) \
static void fixture_name##_##test_name( \
struct __test_metadata *_metadata, \
- _FIXTURE_DATA(fixture_name) *self); \
+ FIXTURE_DATA(fixture_name) *self); \
static inline void wrapper_##fixture_name##_##test_name( \
struct __test_metadata *_metadata) \
{ \
/* fixture data is alloced, setup, and torn down per call. */ \
- _FIXTURE_DATA(fixture_name) self; \
- memset(&self, 0, sizeof(_FIXTURE_DATA(fixture_name))); \
+ FIXTURE_DATA(fixture_name) self; \
+ memset(&self, 0, sizeof(FIXTURE_DATA(fixture_name))); \
fixture_name##_setup(_metadata, &self); \
/* Let setup failure terminate early. */ \
if (!_metadata->passed) \
@@ -293,10 +208,13 @@
} \
static void fixture_name##_##test_name( \
struct __test_metadata __attribute__((unused)) *_metadata, \
- _FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
+ FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
+/* Use once to append a main() to the test file. E.g.,
+ * TEST_HARNESS_MAIN
+ */
/* Exports a simple wrapper to run the test harness. */
-#define _TEST_HARNESS_MAIN \
+#define TEST_HARNESS_MAIN \
static void __attribute__((constructor)) \
__constructor_order_last(void) \
{ \
@@ -307,54 +225,81 @@
return test_harness_run(argc, argv); \
}
-#define _ASSERT_EQ(_expected, _seen) \
- __EXPECT(_expected, _seen, ==, 1)
-#define _ASSERT_NE(_expected, _seen) \
- __EXPECT(_expected, _seen, !=, 1)
-#define _ASSERT_LT(_expected, _seen) \
- __EXPECT(_expected, _seen, <, 1)
-#define _ASSERT_LE(_expected, _seen) \
- __EXPECT(_expected, _seen, <=, 1)
-#define _ASSERT_GT(_expected, _seen) \
- __EXPECT(_expected, _seen, >, 1)
-#define _ASSERT_GE(_expected, _seen) \
- __EXPECT(_expected, _seen, >=, 1)
-#define _ASSERT_NULL(_seen) \
- __EXPECT(NULL, _seen, ==, 1)
+/*
+ * Operators for use in TEST and TEST_F.
+ * ASSERT_* calls will stop test execution immediately.
+ * EXPECT_* calls will emit a failure warning, note it, and continue.
+ */
+/* ASSERT_EQ(expected, measured): expected == measured */
+#define ASSERT_EQ(expected, seen) \
+ __EXPECT(expected, seen, ==, 1)
+/* ASSERT_NE(expected, measured): expected != measured */
+#define ASSERT_NE(expected, seen) \
+ __EXPECT(expected, seen, !=, 1)
+/* ASSERT_LT(expected, measured): expected < measured */
+#define ASSERT_LT(expected, seen) \
+ __EXPECT(expected, seen, <, 1)
+/* ASSERT_LE(expected, measured): expected <= measured */
+#define ASSERT_LE(expected, seen) \
+ __EXPECT(expected, seen, <=, 1)
+/* ASSERT_GT(expected, measured): expected > measured */
+#define ASSERT_GT(expected, seen) \
+ __EXPECT(expected, seen, >, 1)
+/* ASSERT_GE(expected, measured): expected >= measured */
+#define ASSERT_GE(expected, seen) \
+ __EXPECT(expected, seen, >=, 1)
+/* ASSERT_NULL(measured): NULL == measured */
+#define ASSERT_NULL(seen) \
+ __EXPECT(NULL, seen, ==, 1)
-#define _ASSERT_TRUE(_seen) \
- _ASSERT_NE(0, _seen)
-#define _ASSERT_FALSE(_seen) \
- _ASSERT_EQ(0, _seen)
-#define _ASSERT_STREQ(_expected, _seen) \
- __EXPECT_STR(_expected, _seen, ==, 1)
-#define _ASSERT_STRNE(_expected, _seen) \
- __EXPECT_STR(_expected, _seen, !=, 1)
+/* ASSERT_TRUE(measured): measured != 0 */
+#define ASSERT_TRUE(seen) \
+ ASSERT_NE(0, seen)
+/* ASSERT_FALSE(measured): measured == 0 */
+#define ASSERT_FALSE(seen) \
+ ASSERT_EQ(0, seen)
+/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
+#define ASSERT_STREQ(expected, seen) \
+ __EXPECT_STR(expected, seen, ==, 1)
+/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
+#define ASSERT_STRNE(expected, seen) \
+ __EXPECT_STR(expected, seen, !=, 1)
-#define _EXPECT_EQ(_expected, _seen) \
- __EXPECT(_expected, _seen, ==, 0)
-#define _EXPECT_NE(_expected, _seen) \
- __EXPECT(_expected, _seen, !=, 0)
-#define _EXPECT_LT(_expected, _seen) \
- __EXPECT(_expected, _seen, <, 0)
-#define _EXPECT_LE(_expected, _seen) \
- __EXPECT(_expected, _seen, <=, 0)
-#define _EXPECT_GT(_expected, _seen) \
- __EXPECT(_expected, _seen, >, 0)
-#define _EXPECT_GE(_expected, _seen) \
- __EXPECT(_expected, _seen, >=, 0)
+/* EXPECT_EQ(expected, measured): expected == measured */
+#define EXPECT_EQ(expected, seen) \
+ __EXPECT(expected, seen, ==, 0)
+/* EXPECT_NE(expected, measured): expected != measured */
+#define EXPECT_NE(expected, seen) \
+ __EXPECT(expected, seen, !=, 0)
+/* EXPECT_LT(expected, measured): expected < measured */
+#define EXPECT_LT(expected, seen) \
+ __EXPECT(expected, seen, <, 0)
+/* EXPECT_LE(expected, measured): expected <= measured */
+#define EXPECT_LE(expected, seen) \
+ __EXPECT(expected, seen, <=, 0)
+/* EXPECT_GT(expected, measured): expected > measured */
+#define EXPECT_GT(expected, seen) \
+ __EXPECT(expected, seen, >, 0)
+/* EXPECT_GE(expected, measured): expected >= measured */
+#define EXPECT_GE(expected, seen) \
+ __EXPECT(expected, seen, >=, 0)
-#define _EXPECT_NULL(_seen) \
- __EXPECT(NULL, _seen, ==, 0)
-#define _EXPECT_TRUE(_seen) \
- _EXPECT_NE(0, _seen)
-#define _EXPECT_FALSE(_seen) \
- _EXPECT_EQ(0, _seen)
+/* EXPECT_NULL(measured): NULL == measured */
+#define EXPECT_NULL(seen) \
+ __EXPECT(NULL, seen, ==, 0)
+/* EXPECT_TRUE(measured): 0 != measured */
+#define EXPECT_TRUE(seen) \
+ EXPECT_NE(0, seen)
+/* EXPECT_FALSE(measured): 0 == measured */
+#define EXPECT_FALSE(seen) \
+ EXPECT_EQ(0, seen)
-#define _EXPECT_STREQ(_expected, _seen) \
- __EXPECT_STR(_expected, _seen, ==, 0)
-#define _EXPECT_STRNE(_expected, _seen) \
- __EXPECT_STR(_expected, _seen, !=, 0)
+/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
+#define EXPECT_STREQ(expected, seen) \
+ __EXPECT_STR(expected, seen, ==, 0)
+/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
+#define EXPECT_STRNE(expected, seen) \
+ __EXPECT_STR(expected, seen, !=, 0)
#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
` (5 preceding siblings ...)
2017-05-26 18:44 ` [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Mickaël Salaün
@ 2017-05-26 18:44 ` Mickaël Salaün
2017-05-26 19:08 ` Kees Cook
2017-06-02 20:02 ` Shuah Khan
2017-05-26 19:09 ` [PATCH v5 0/7] Add kselftest_harness.h Kees Cook
7 siblings, 2 replies; 18+ messages in thread
From: Mickaël Salaün @ 2017-05-26 18:44 UTC (permalink / raw)
To: linux-kernel
Cc: Mickaël Salaün, Andy Lutomirski, Jonathan Corbet,
Kees Cook, Shuah Khan, Will Drewry, linux-doc, linux-kselftest
Add ReST metadata to kselftest_harness.h to be able to include the
comments in the Sphinx documentation.
Changes since v4:
* exclude the TEST_API() changes (requested by Kees Cook)
Changes since v3:
* document macros as actual functions (suggested by Jonathan Corbet)
* remove the TEST_API() wrapper to expose the underlying macro arguments
to the documentation tools
* move and cleanup comments
Changes since v2:
* add reference to the full documentation in the header file (suggested
by Kees Cook)
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Kees Cook <keescook@chromium.org>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Will Drewry <wad@chromium.org>
---
Documentation/dev-tools/kselftest.rst | 34 +++
tools/testing/selftests/kselftest_harness.h | 415 ++++++++++++++++++++++------
2 files changed, 364 insertions(+), 85 deletions(-)
diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index 9232ce94612c..a92fa181b6cf 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -120,3 +120,37 @@ Contributing new tests (details)
executable which is not tested by default.
TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
test.
+
+Test Harness
+============
+
+The kselftest_harness.h file contains useful helpers to build tests. The tests
+from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.
+
+Example
+-------
+
+.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
+ :doc: example
+
+
+Helpers
+-------
+
+.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
+ :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
+ FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN
+
+Operators
+---------
+
+.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
+ :doc: operators
+
+.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
+ :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
+ ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
+ ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
+ EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
+ EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
+
diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
index 45f807ce37e1..c56f72e07cd7 100644
--- a/tools/testing/selftests/kselftest_harness.h
+++ b/tools/testing/selftests/kselftest_harness.h
@@ -4,41 +4,49 @@
*
* kselftest_harness.h: simple C unit test helper.
*
- * Usage:
- * #include "../kselftest_harness.h"
- * TEST(standalone_test) {
- * do_some_stuff;
- * EXPECT_GT(10, stuff) {
- * stuff_state_t state;
- * enumerate_stuff_state(&state);
- * TH_LOG("expectation failed with state: %s", state.msg);
- * }
- * more_stuff;
- * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
- * last_stuff;
- * EXPECT_EQ(0, last_stuff);
- * }
- *
- * FIXTURE(my_fixture) {
- * mytype_t *data;
- * int awesomeness_level;
- * };
- * FIXTURE_SETUP(my_fixture) {
- * self->data = mytype_new();
- * ASSERT_NE(NULL, self->data);
- * }
- * FIXTURE_TEARDOWN(my_fixture) {
- * mytype_free(self->data);
- * }
- * TEST_F(my_fixture, data_is_good) {
- * EXPECT_EQ(1, is_my_data_good(self->data));
- * }
- *
- * TEST_HARNESS_MAIN
+ * See documentation in Documentation/dev-tools/kselftest.rst
*
* API inspired by code.google.com/p/googletest
*/
+/**
+ * DOC: example
+ *
+ * .. code-block:: c
+ *
+ * #include "../kselftest_harness.h"
+ *
+ * TEST(standalone_test) {
+ * do_some_stuff;
+ * EXPECT_GT(10, stuff) {
+ * stuff_state_t state;
+ * enumerate_stuff_state(&state);
+ * TH_LOG("expectation failed with state: %s", state.msg);
+ * }
+ * more_stuff;
+ * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
+ * last_stuff;
+ * EXPECT_EQ(0, last_stuff);
+ * }
+ *
+ * FIXTURE(my_fixture) {
+ * mytype_t *data;
+ * int awesomeness_level;
+ * };
+ * FIXTURE_SETUP(my_fixture) {
+ * self->data = mytype_new();
+ * ASSERT_NE(NULL, self->data);
+ * }
+ * FIXTURE_TEARDOWN(my_fixture) {
+ * mytype_free(self->data);
+ * }
+ * TEST_F(my_fixture, data_is_good) {
+ * EXPECT_EQ(1, is_my_data_good(self->data));
+ * }
+ *
+ * TEST_HARNESS_MAIN
+ */
+
#ifndef __KSELFTEST_HARNESS_H
#define __KSELFTEST_HARNESS_H
@@ -61,10 +69,20 @@
# define TH_LOG_ENABLED 1
#endif
-/* TH_LOG(format, ...)
+/**
+ * TH_LOG(fmt, ...)
+ *
+ * @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.
*/
#define TH_LOG(fmt, ...) do { \
@@ -77,7 +95,16 @@
fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
__FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
-/* TEST(name) { implementation }
+/**
+ * TEST(test_name) - 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
@@ -85,10 +112,18 @@
*
* EXPECT_* and ASSERT_* are valid in a TEST() { } context.
*/
-/* Defines the test function and creates the registration stub. */
#define TEST(test_name) __TEST_IMPL(test_name, -1)
-/* TEST_SIGNAL(name, signal) { implementation }
+/**
+ * TEST_SIGNAL(test_name, 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
@@ -110,22 +145,38 @@
static void test_name( \
struct __test_metadata __attribute__((unused)) *_metadata)
-/* FIXTURE_DATA(datatype name)
+/**
+ * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
+ * argument to pass around
+ *
+ * @datatype_name: datatype name
+ *
+ * .. code-block:: c
+ *
+ * FIXTURE_DATA(datatype name)
+ *
* 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.
+ * the *self* is being passed to a helper directly.
*/
-/* Wraps the struct name so we have one less argument to pass around. */
#define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
-/* FIXTURE(datatype 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.
+/**
+ * FIXTURE(fixture_name) - Called once per fixture to setup the data and
+ * register
+ *
+ * @fixture_name: fixture name
+ *
+ * .. code-block:: c
+ *
+ * FIXTURE(datatype 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().
*/
-/* Called once per fixture to setup the data and register. */
#define FIXTURE(fixture_name) \
static void __attribute__((constructor)) \
_register_##fixture_name##_data(void) \
@@ -134,9 +185,18 @@
} \
FIXTURE_DATA(fixture_name)
-/* FIXTURE_SETUP(fixture name) { implementation }
+/**
+ * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
+ * *_metadata* is included so that ASSERT_* work as a convenience
+ *
+ * @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
+ * 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
@@ -144,16 +204,21 @@
*
* A bare "return;" statement may be used to return early.
*/
-/* Prepares the setup function for the fixture. |_metadata| is included
- * so that ASSERT_* work as a convenience.
- */
#define FIXTURE_SETUP(fixture_name) \
void fixture_name##_setup( \
struct __test_metadata __attribute__((unused)) *_metadata, \
FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
-/* FIXTURE_TEARDOWN(fixture name) { implementation }
+/**
+ * FIXTURE_TEARDOWN(fixture_name)
+ *
+ * @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
+ * 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.
@@ -163,15 +228,22 @@
struct __test_metadata __attribute__((unused)) *_metadata, \
FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
-/* TEST_F(fixture, name) { implementation }
+/**
+ * TEST_F(fixture_name, test_name) - 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
+ * Very similar to TEST() except that *self* is the setup instance of fixture's
* datatype exposed for use by the implementation.
*/
-/* Emits test registration and helpers for fixture-based test
- * cases.
- * TODO(wad) register fixtures on dedicated test lists.
- */
+/* TODO(wad) register fixtures on dedicated test lists. */
#define TEST_F(fixture_name, test_name) \
__TEST_F_IMPL(fixture_name, test_name, -1)
@@ -210,10 +282,15 @@
struct __test_metadata __attribute__((unused)) *_metadata, \
FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
-/* Use once to append a main() to the test file. E.g.,
- * TEST_HARNESS_MAIN
+/**
+ * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
+ *
+ * .. code-block:: c
+ *
+ * TEST_HARNESS_MAIN
+ *
+ * Use once to append a main() to the test file.
*/
-/* Exports a simple wrapper to run the test harness. */
#define TEST_HARNESS_MAIN \
static void __attribute__((constructor)) \
__constructor_order_last(void) \
@@ -225,79 +302,247 @@
return test_harness_run(argc, argv); \
}
-/*
- * Operators for use in TEST and TEST_F.
+/**
+ * DOC: operators
+ *
+ * Operators for use in TEST() and TEST_F().
* ASSERT_* calls will stop test execution immediately.
* EXPECT_* calls will emit a failure warning, note it, and continue.
*/
-/* ASSERT_EQ(expected, measured): expected == measured */
+
+/**
+ * ASSERT_EQ(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_EQ(expected, measured): expected == measured
+ */
#define ASSERT_EQ(expected, seen) \
__EXPECT(expected, seen, ==, 1)
-/* ASSERT_NE(expected, measured): expected != measured */
+
+/**
+ * ASSERT_NE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_NE(expected, measured): expected != measured
+ */
#define ASSERT_NE(expected, seen) \
__EXPECT(expected, seen, !=, 1)
-/* ASSERT_LT(expected, measured): expected < measured */
+
+/**
+ * ASSERT_LT(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_LT(expected, measured): expected < measured
+ */
#define ASSERT_LT(expected, seen) \
__EXPECT(expected, seen, <, 1)
-/* ASSERT_LE(expected, measured): expected <= measured */
+
+/**
+ * ASSERT_LE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_LE(expected, measured): expected <= measured
+ */
#define ASSERT_LE(expected, seen) \
__EXPECT(expected, seen, <=, 1)
-/* ASSERT_GT(expected, measured): expected > measured */
+
+/**
+ * ASSERT_GT(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_GT(expected, measured): expected > measured
+ */
#define ASSERT_GT(expected, seen) \
__EXPECT(expected, seen, >, 1)
-/* ASSERT_GE(expected, measured): expected >= measured */
+
+/**
+ * ASSERT_GE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_GE(expected, measured): expected >= measured
+ */
#define ASSERT_GE(expected, seen) \
__EXPECT(expected, seen, >=, 1)
-/* ASSERT_NULL(measured): NULL == measured */
+
+/**
+ * ASSERT_NULL(seen)
+ *
+ * @seen: measured value
+ *
+ * ASSERT_NULL(measured): NULL == measured
+ */
#define ASSERT_NULL(seen) \
__EXPECT(NULL, seen, ==, 1)
-/* ASSERT_TRUE(measured): measured != 0 */
+/**
+ * ASSERT_TRUE(seen)
+ *
+ * @seen: measured value
+ *
+ * ASSERT_TRUE(measured): measured != 0
+ */
#define ASSERT_TRUE(seen) \
ASSERT_NE(0, seen)
-/* ASSERT_FALSE(measured): measured == 0 */
+
+/**
+ * ASSERT_FALSE(seen)
+ *
+ * @seen: measured value
+ *
+ * ASSERT_FALSE(measured): measured == 0
+ */
#define ASSERT_FALSE(seen) \
ASSERT_EQ(0, seen)
-/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
+
+/**
+ * ASSERT_STREQ(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
+ */
#define ASSERT_STREQ(expected, seen) \
__EXPECT_STR(expected, seen, ==, 1)
-/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
+
+/**
+ * ASSERT_STRNE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
+ */
#define ASSERT_STRNE(expected, seen) \
__EXPECT_STR(expected, seen, !=, 1)
-/* EXPECT_EQ(expected, measured): expected == measured */
+/**
+ * EXPECT_EQ(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_EQ(expected, measured): expected == measured
+ */
#define EXPECT_EQ(expected, seen) \
__EXPECT(expected, seen, ==, 0)
-/* EXPECT_NE(expected, measured): expected != measured */
+
+/**
+ * EXPECT_NE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_NE(expected, measured): expected != measured
+ */
#define EXPECT_NE(expected, seen) \
__EXPECT(expected, seen, !=, 0)
-/* EXPECT_LT(expected, measured): expected < measured */
+
+/**
+ * EXPECT_LT(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_LT(expected, measured): expected < measured
+ */
#define EXPECT_LT(expected, seen) \
__EXPECT(expected, seen, <, 0)
-/* EXPECT_LE(expected, measured): expected <= measured */
+
+/**
+ * EXPECT_LE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_LE(expected, measured): expected <= measured
+ */
#define EXPECT_LE(expected, seen) \
__EXPECT(expected, seen, <=, 0)
-/* EXPECT_GT(expected, measured): expected > measured */
+
+/**
+ * EXPECT_GT(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_GT(expected, measured): expected > measured
+ */
#define EXPECT_GT(expected, seen) \
__EXPECT(expected, seen, >, 0)
-/* EXPECT_GE(expected, measured): expected >= measured */
+
+/**
+ * EXPECT_GE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_GE(expected, measured): expected >= measured
+ */
#define EXPECT_GE(expected, seen) \
__EXPECT(expected, seen, >=, 0)
-/* EXPECT_NULL(measured): NULL == measured */
+/**
+ * EXPECT_NULL(seen)
+ *
+ * @seen: measured value
+ *
+ * EXPECT_NULL(measured): NULL == measured
+ */
#define EXPECT_NULL(seen) \
__EXPECT(NULL, seen, ==, 0)
-/* EXPECT_TRUE(measured): 0 != measured */
+
+/**
+ * EXPECT_TRUE(seen)
+ *
+ * @seen: measured value
+ *
+ * EXPECT_TRUE(measured): 0 != measured
+ */
#define EXPECT_TRUE(seen) \
EXPECT_NE(0, seen)
-/* EXPECT_FALSE(measured): 0 == measured */
+
+/**
+ * EXPECT_FALSE(seen)
+ *
+ * @seen: measured value
+ *
+ * EXPECT_FALSE(measured): 0 == measured
+ */
#define EXPECT_FALSE(seen) \
EXPECT_EQ(0, seen)
-/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
+/**
+ * EXPECT_STREQ(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
+ */
#define EXPECT_STREQ(expected, seen) \
__EXPECT_STR(expected, seen, ==, 0)
-/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
+
+/**
+ * EXPECT_STRNE(expected, seen)
+ *
+ * @expected: expected value
+ * @seen: measured value
+ *
+ * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
+ */
#define EXPECT_STRNE(expected, seen) \
__EXPECT_STR(expected, seen, !=, 0)
--
2.11.0
^ permalink raw reply related [flat|nested] 18+ messages in thread
* Re: [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h
2017-05-26 18:44 ` [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Mickaël Salaün
@ 2017-05-26 19:07 ` Kees Cook
0 siblings, 0 replies; 18+ messages in thread
From: Kees Cook @ 2017-05-26 19:07 UTC (permalink / raw)
To: Mickaël Salaün
Cc: LKML, Andy Lutomirski, Jonathan Corbet, Shuah Khan, Will Drewry,
linux-doc, linux-kselftest
On Fri, May 26, 2017 at 11:44 AM, Mickaël Salaün <mic@digikod.net> wrote:
> Remove the TEST_API() wrapper to expose the underlying macro arguments
> to the documentation tools.
>
> Use "git diff --patience" to get a more readable patch.
>
> Changes since v4:
> * standalone patch to ease the review (requested by Kees Cook)
>
> Signed-off-by: Mickaël Salaün <mic@digikod.net>
> Cc: Andy Lutomirski <luto@amacapital.net>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Kees Cook <keescook@chromium.org>
> Cc: Shuah Khan <shuah@kernel.org>
> Cc: Will Drewry <wad@chromium.org>
Thanks for the split!
Acked-by: Kees Cook <keescook@chromium.org>
-Kees
> ---
> tools/testing/selftests/kselftest_harness.h | 349 ++++++++++++----------------
> 1 file changed, 147 insertions(+), 202 deletions(-)
>
> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
> index 171e70aead9c..45f807ce37e1 100644
> --- a/tools/testing/selftests/kselftest_harness.h
> +++ b/tools/testing/selftests/kselftest_harness.h
> @@ -51,147 +51,6 @@
> #include <sys/wait.h>
> #include <unistd.h>
>
> -/* All exported functionality should be declared through this macro. */
> -#define TEST_API(x) _##x
> -
> -/*
> - * Exported APIs
> - */
> -
> -/* 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_API(TEST)
> -
> -/* 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_API(TEST_SIGNAL)
> -
> -/* FIXTURE(datatype 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 TEST_API(FIXTURE)
> -
> -/* FIXTURE_DATA(datatype name)
> - * 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 TEST_API(FIXTURE_DATA)
> -
> -/* 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 TEST_API(FIXTURE_SETUP)
> -
> -/* 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 TEST_API(FIXTURE_TEARDOWN)
> -
> -/* 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.
> - */
> -#define TEST_F TEST_API(TEST_F)
> -
> -#define TEST_F_SIGNAL TEST_API(TEST_F_SIGNAL)
> -
> -/* Use once to append a main() to the test file. E.g.,
> - * TEST_HARNESS_MAIN
> - */
> -#define TEST_HARNESS_MAIN TEST_API(TEST_HARNESS_MAIN)
> -
> -/*
> - * Operators for use in TEST and TEST_F.
> - * ASSERT_* calls will stop test execution immediately.
> - * EXPECT_* calls will emit a failure warning, note it, and continue.
> - */
> -
> -/* ASSERT_EQ(expected, measured): expected == measured */
> -#define ASSERT_EQ TEST_API(ASSERT_EQ)
> -/* ASSERT_NE(expected, measured): expected != measured */
> -#define ASSERT_NE TEST_API(ASSERT_NE)
> -/* ASSERT_LT(expected, measured): expected < measured */
> -#define ASSERT_LT TEST_API(ASSERT_LT)
> -/* ASSERT_LE(expected, measured): expected <= measured */
> -#define ASSERT_LE TEST_API(ASSERT_LE)
> -/* ASSERT_GT(expected, measured): expected > measured */
> -#define ASSERT_GT TEST_API(ASSERT_GT)
> -/* ASSERT_GE(expected, measured): expected >= measured */
> -#define ASSERT_GE TEST_API(ASSERT_GE)
> -/* ASSERT_NULL(measured): NULL == measured */
> -#define ASSERT_NULL TEST_API(ASSERT_NULL)
> -/* ASSERT_TRUE(measured): measured != 0 */
> -#define ASSERT_TRUE TEST_API(ASSERT_TRUE)
> -/* ASSERT_FALSE(measured): measured == 0 */
> -#define ASSERT_FALSE TEST_API(ASSERT_FALSE)
> -/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
> -#define ASSERT_STREQ TEST_API(ASSERT_STREQ)
> -/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
> -#define ASSERT_STRNE TEST_API(ASSERT_STRNE)
> -/* EXPECT_EQ(expected, measured): expected == measured */
> -#define EXPECT_EQ TEST_API(EXPECT_EQ)
> -/* EXPECT_NE(expected, measured): expected != measured */
> -#define EXPECT_NE TEST_API(EXPECT_NE)
> -/* EXPECT_LT(expected, measured): expected < measured */
> -#define EXPECT_LT TEST_API(EXPECT_LT)
> -/* EXPECT_LE(expected, measured): expected <= measured */
> -#define EXPECT_LE TEST_API(EXPECT_LE)
> -/* EXPECT_GT(expected, measured): expected > measured */
> -#define EXPECT_GT TEST_API(EXPECT_GT)
> -/* EXPECT_GE(expected, measured): expected >= measured */
> -#define EXPECT_GE TEST_API(EXPECT_GE)
> -/* EXPECT_NULL(measured): NULL == measured */
> -#define EXPECT_NULL TEST_API(EXPECT_NULL)
> -/* EXPECT_TRUE(measured): 0 != measured */
> -#define EXPECT_TRUE TEST_API(EXPECT_TRUE)
> -/* EXPECT_FALSE(measured): 0 == measured */
> -#define EXPECT_FALSE TEST_API(EXPECT_FALSE)
> -/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
> -#define EXPECT_STREQ TEST_API(EXPECT_STREQ)
> -/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
> -#define EXPECT_STRNE TEST_API(EXPECT_STRNE)
> -
> -/* 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.
> - */
> -#define TH_LOG TEST_API(TH_LOG)
> -
> -/*
> - * Internal implementation.
> - *
> - */
>
> /* Utilities exposed to the test definitions */
> #ifndef TH_LOG_STREAM
> @@ -202,7 +61,13 @@
> # define TH_LOG_ENABLED 1
> #endif
>
> -#define _TH_LOG(fmt, ...) do { \
> +/* 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.
> + */
> +#define TH_LOG(fmt, ...) do { \
> if (TH_LOG_ENABLED) \
> __TH_LOG(fmt, ##__VA_ARGS__); \
> } while (0)
> @@ -212,10 +77,26 @@
> fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>
> +/* 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.
> + */
> /* Defines the test function and creates the registration stub. */
> -#define _TEST(test_name) __TEST_IMPL(test_name, -1)
> +#define TEST(test_name) __TEST_IMPL(test_name, -1)
>
> -#define _TEST_SIGNAL(test_name, signal) __TEST_IMPL(test_name, signal)
> +/* 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); \
> @@ -229,50 +110,84 @@
> static void test_name( \
> struct __test_metadata __attribute__((unused)) *_metadata)
>
> +/* FIXTURE_DATA(datatype name)
> + * 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.
> + */
> /* Wraps the struct name so we have one less argument to pass around. */
> -#define _FIXTURE_DATA(fixture_name) struct _test_data_##fixture_name
> +#define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>
> +/* FIXTURE(datatype 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.
> + */
> /* Called once per fixture to setup the data and register. */
> -#define _FIXTURE(fixture_name) \
> +#define FIXTURE(fixture_name) \
> static void __attribute__((constructor)) \
> _register_##fixture_name##_data(void) \
> { \
> __fixture_count++; \
> } \
> - _FIXTURE_DATA(fixture_name)
> + FIXTURE_DATA(fixture_name)
>
> +/* 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.
> + */
> /* Prepares the setup function for the fixture. |_metadata| is included
> * so that ASSERT_* work as a convenience.
> */
> -#define _FIXTURE_SETUP(fixture_name) \
> +#define FIXTURE_SETUP(fixture_name) \
> void fixture_name##_setup( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> - _FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
> -#define _FIXTURE_TEARDOWN(fixture_name) \
> + FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
> +/* 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_DATA(fixture_name) __attribute__((unused)) *self)
>
> +/* 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.
> + */
> /* Emits test registration and helpers for fixture-based test
> * cases.
> * TODO(wad) register fixtures on dedicated test lists.
> */
> -#define _TEST_F(fixture_name, test_name) \
> +#define TEST_F(fixture_name, test_name) \
> __TEST_F_IMPL(fixture_name, test_name, -1)
>
> -#define _TEST_F_SIGNAL(fixture_name, test_name, signal) \
> +#define TEST_F_SIGNAL(fixture_name, test_name, signal) \
> __TEST_F_IMPL(fixture_name, test_name, signal)
>
> #define __TEST_F_IMPL(fixture_name, test_name, signal) \
> static void fixture_name##_##test_name( \
> struct __test_metadata *_metadata, \
> - _FIXTURE_DATA(fixture_name) *self); \
> + FIXTURE_DATA(fixture_name) *self); \
> static inline void wrapper_##fixture_name##_##test_name( \
> struct __test_metadata *_metadata) \
> { \
> /* fixture data is alloced, setup, and torn down per call. */ \
> - _FIXTURE_DATA(fixture_name) self; \
> - memset(&self, 0, sizeof(_FIXTURE_DATA(fixture_name))); \
> + FIXTURE_DATA(fixture_name) self; \
> + memset(&self, 0, sizeof(FIXTURE_DATA(fixture_name))); \
> fixture_name##_setup(_metadata, &self); \
> /* Let setup failure terminate early. */ \
> if (!_metadata->passed) \
> @@ -293,10 +208,13 @@
> } \
> static void fixture_name##_##test_name( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> - _FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
> + FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> +/* Use once to append a main() to the test file. E.g.,
> + * TEST_HARNESS_MAIN
> + */
> /* Exports a simple wrapper to run the test harness. */
> -#define _TEST_HARNESS_MAIN \
> +#define TEST_HARNESS_MAIN \
> static void __attribute__((constructor)) \
> __constructor_order_last(void) \
> { \
> @@ -307,54 +225,81 @@
> return test_harness_run(argc, argv); \
> }
>
> -#define _ASSERT_EQ(_expected, _seen) \
> - __EXPECT(_expected, _seen, ==, 1)
> -#define _ASSERT_NE(_expected, _seen) \
> - __EXPECT(_expected, _seen, !=, 1)
> -#define _ASSERT_LT(_expected, _seen) \
> - __EXPECT(_expected, _seen, <, 1)
> -#define _ASSERT_LE(_expected, _seen) \
> - __EXPECT(_expected, _seen, <=, 1)
> -#define _ASSERT_GT(_expected, _seen) \
> - __EXPECT(_expected, _seen, >, 1)
> -#define _ASSERT_GE(_expected, _seen) \
> - __EXPECT(_expected, _seen, >=, 1)
> -#define _ASSERT_NULL(_seen) \
> - __EXPECT(NULL, _seen, ==, 1)
> +/*
> + * Operators for use in TEST and TEST_F.
> + * ASSERT_* calls will stop test execution immediately.
> + * EXPECT_* calls will emit a failure warning, note it, and continue.
> + */
> +/* ASSERT_EQ(expected, measured): expected == measured */
> +#define ASSERT_EQ(expected, seen) \
> + __EXPECT(expected, seen, ==, 1)
> +/* ASSERT_NE(expected, measured): expected != measured */
> +#define ASSERT_NE(expected, seen) \
> + __EXPECT(expected, seen, !=, 1)
> +/* ASSERT_LT(expected, measured): expected < measured */
> +#define ASSERT_LT(expected, seen) \
> + __EXPECT(expected, seen, <, 1)
> +/* ASSERT_LE(expected, measured): expected <= measured */
> +#define ASSERT_LE(expected, seen) \
> + __EXPECT(expected, seen, <=, 1)
> +/* ASSERT_GT(expected, measured): expected > measured */
> +#define ASSERT_GT(expected, seen) \
> + __EXPECT(expected, seen, >, 1)
> +/* ASSERT_GE(expected, measured): expected >= measured */
> +#define ASSERT_GE(expected, seen) \
> + __EXPECT(expected, seen, >=, 1)
> +/* ASSERT_NULL(measured): NULL == measured */
> +#define ASSERT_NULL(seen) \
> + __EXPECT(NULL, seen, ==, 1)
>
> -#define _ASSERT_TRUE(_seen) \
> - _ASSERT_NE(0, _seen)
> -#define _ASSERT_FALSE(_seen) \
> - _ASSERT_EQ(0, _seen)
> -#define _ASSERT_STREQ(_expected, _seen) \
> - __EXPECT_STR(_expected, _seen, ==, 1)
> -#define _ASSERT_STRNE(_expected, _seen) \
> - __EXPECT_STR(_expected, _seen, !=, 1)
> +/* ASSERT_TRUE(measured): measured != 0 */
> +#define ASSERT_TRUE(seen) \
> + ASSERT_NE(0, seen)
> +/* ASSERT_FALSE(measured): measured == 0 */
> +#define ASSERT_FALSE(seen) \
> + ASSERT_EQ(0, seen)
> +/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
> +#define ASSERT_STREQ(expected, seen) \
> + __EXPECT_STR(expected, seen, ==, 1)
> +/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
> +#define ASSERT_STRNE(expected, seen) \
> + __EXPECT_STR(expected, seen, !=, 1)
>
> -#define _EXPECT_EQ(_expected, _seen) \
> - __EXPECT(_expected, _seen, ==, 0)
> -#define _EXPECT_NE(_expected, _seen) \
> - __EXPECT(_expected, _seen, !=, 0)
> -#define _EXPECT_LT(_expected, _seen) \
> - __EXPECT(_expected, _seen, <, 0)
> -#define _EXPECT_LE(_expected, _seen) \
> - __EXPECT(_expected, _seen, <=, 0)
> -#define _EXPECT_GT(_expected, _seen) \
> - __EXPECT(_expected, _seen, >, 0)
> -#define _EXPECT_GE(_expected, _seen) \
> - __EXPECT(_expected, _seen, >=, 0)
> +/* EXPECT_EQ(expected, measured): expected == measured */
> +#define EXPECT_EQ(expected, seen) \
> + __EXPECT(expected, seen, ==, 0)
> +/* EXPECT_NE(expected, measured): expected != measured */
> +#define EXPECT_NE(expected, seen) \
> + __EXPECT(expected, seen, !=, 0)
> +/* EXPECT_LT(expected, measured): expected < measured */
> +#define EXPECT_LT(expected, seen) \
> + __EXPECT(expected, seen, <, 0)
> +/* EXPECT_LE(expected, measured): expected <= measured */
> +#define EXPECT_LE(expected, seen) \
> + __EXPECT(expected, seen, <=, 0)
> +/* EXPECT_GT(expected, measured): expected > measured */
> +#define EXPECT_GT(expected, seen) \
> + __EXPECT(expected, seen, >, 0)
> +/* EXPECT_GE(expected, measured): expected >= measured */
> +#define EXPECT_GE(expected, seen) \
> + __EXPECT(expected, seen, >=, 0)
>
> -#define _EXPECT_NULL(_seen) \
> - __EXPECT(NULL, _seen, ==, 0)
> -#define _EXPECT_TRUE(_seen) \
> - _EXPECT_NE(0, _seen)
> -#define _EXPECT_FALSE(_seen) \
> - _EXPECT_EQ(0, _seen)
> +/* EXPECT_NULL(measured): NULL == measured */
> +#define EXPECT_NULL(seen) \
> + __EXPECT(NULL, seen, ==, 0)
> +/* EXPECT_TRUE(measured): 0 != measured */
> +#define EXPECT_TRUE(seen) \
> + EXPECT_NE(0, seen)
> +/* EXPECT_FALSE(measured): 0 == measured */
> +#define EXPECT_FALSE(seen) \
> + EXPECT_EQ(0, seen)
>
> -#define _EXPECT_STREQ(_expected, _seen) \
> - __EXPECT_STR(_expected, _seen, ==, 0)
> -#define _EXPECT_STRNE(_expected, _seen) \
> - __EXPECT_STR(_expected, _seen, !=, 0)
> +/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
> +#define EXPECT_STREQ(expected, seen) \
> + __EXPECT_STR(expected, seen, ==, 0)
> +/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
> +#define EXPECT_STRNE(expected, seen) \
> + __EXPECT_STR(expected, seen, !=, 0)
>
> #define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
>
> --
> 2.11.0
>
--
Kees Cook
Pixel Security
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation
2017-05-26 18:44 ` [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün
@ 2017-05-26 19:08 ` Kees Cook
2017-06-02 20:02 ` Shuah Khan
1 sibling, 0 replies; 18+ messages in thread
From: Kees Cook @ 2017-05-26 19:08 UTC (permalink / raw)
To: Mickaël Salaün, Mauro Carvalho Chehab
Cc: LKML, Andy Lutomirski, Jonathan Corbet, Shuah Khan, Will Drewry,
linux-doc, linux-kselftest
On Fri, May 26, 2017 at 11:44 AM, Mickaël Salaün <mic@digikod.net> wrote:
> Add ReST metadata to kselftest_harness.h to be able to include the
> comments in the Sphinx documentation.
>
> Changes since v4:
> * exclude the TEST_API() changes (requested by Kees Cook)
>
> Changes since v3:
> * document macros as actual functions (suggested by Jonathan Corbet)
> * remove the TEST_API() wrapper to expose the underlying macro arguments
> to the documentation tools
> * move and cleanup comments
>
> Changes since v2:
> * add reference to the full documentation in the header file (suggested
> by Kees Cook)
>
> Signed-off-by: Mickaël Salaün <mic@digikod.net>
> Cc: Andy Lutomirski <luto@amacapital.net>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Kees Cook <keescook@chromium.org>
> Cc: Shuah Khan <shuah@kernel.org>
> Cc: Will Drewry <wad@chromium.org>
Awesome, this is great to have. :) I wonder if we have a self-test doc
section yet. Hmmm.
Acked-by: Kees Cook <keescook@chromium.org>
-Kees
> ---
> Documentation/dev-tools/kselftest.rst | 34 +++
> tools/testing/selftests/kselftest_harness.h | 415 ++++++++++++++++++++++------
> 2 files changed, 364 insertions(+), 85 deletions(-)
>
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index 9232ce94612c..a92fa181b6cf 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -120,3 +120,37 @@ Contributing new tests (details)
> executable which is not tested by default.
> TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
> test.
> +
> +Test Harness
> +============
> +
> +The kselftest_harness.h file contains useful helpers to build tests. The tests
> +from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.
> +
> +Example
> +-------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :doc: example
> +
> +
> +Helpers
> +-------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
> + FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN
> +
> +Operators
> +---------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :doc: operators
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
> + ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
> + ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
> + EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
> + EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
> +
> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
> index 45f807ce37e1..c56f72e07cd7 100644
> --- a/tools/testing/selftests/kselftest_harness.h
> +++ b/tools/testing/selftests/kselftest_harness.h
> @@ -4,41 +4,49 @@
> *
> * kselftest_harness.h: simple C unit test helper.
> *
> - * Usage:
> - * #include "../kselftest_harness.h"
> - * TEST(standalone_test) {
> - * do_some_stuff;
> - * EXPECT_GT(10, stuff) {
> - * stuff_state_t state;
> - * enumerate_stuff_state(&state);
> - * TH_LOG("expectation failed with state: %s", state.msg);
> - * }
> - * more_stuff;
> - * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
> - * last_stuff;
> - * EXPECT_EQ(0, last_stuff);
> - * }
> - *
> - * FIXTURE(my_fixture) {
> - * mytype_t *data;
> - * int awesomeness_level;
> - * };
> - * FIXTURE_SETUP(my_fixture) {
> - * self->data = mytype_new();
> - * ASSERT_NE(NULL, self->data);
> - * }
> - * FIXTURE_TEARDOWN(my_fixture) {
> - * mytype_free(self->data);
> - * }
> - * TEST_F(my_fixture, data_is_good) {
> - * EXPECT_EQ(1, is_my_data_good(self->data));
> - * }
> - *
> - * TEST_HARNESS_MAIN
> + * See documentation in Documentation/dev-tools/kselftest.rst
> *
> * API inspired by code.google.com/p/googletest
> */
>
> +/**
> + * DOC: example
> + *
> + * .. code-block:: c
> + *
> + * #include "../kselftest_harness.h"
> + *
> + * TEST(standalone_test) {
> + * do_some_stuff;
> + * EXPECT_GT(10, stuff) {
> + * stuff_state_t state;
> + * enumerate_stuff_state(&state);
> + * TH_LOG("expectation failed with state: %s", state.msg);
> + * }
> + * more_stuff;
> + * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
> + * last_stuff;
> + * EXPECT_EQ(0, last_stuff);
> + * }
> + *
> + * FIXTURE(my_fixture) {
> + * mytype_t *data;
> + * int awesomeness_level;
> + * };
> + * FIXTURE_SETUP(my_fixture) {
> + * self->data = mytype_new();
> + * ASSERT_NE(NULL, self->data);
> + * }
> + * FIXTURE_TEARDOWN(my_fixture) {
> + * mytype_free(self->data);
> + * }
> + * TEST_F(my_fixture, data_is_good) {
> + * EXPECT_EQ(1, is_my_data_good(self->data));
> + * }
> + *
> + * TEST_HARNESS_MAIN
> + */
> +
> #ifndef __KSELFTEST_HARNESS_H
> #define __KSELFTEST_HARNESS_H
>
> @@ -61,10 +69,20 @@
> # define TH_LOG_ENABLED 1
> #endif
>
> -/* TH_LOG(format, ...)
> +/**
> + * TH_LOG(fmt, ...)
> + *
> + * @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.
> */
> #define TH_LOG(fmt, ...) do { \
> @@ -77,7 +95,16 @@
> fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>
> -/* TEST(name) { implementation }
> +/**
> + * TEST(test_name) - 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
> @@ -85,10 +112,18 @@
> *
> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
> */
> -/* Defines the test function and creates the registration stub. */
> #define TEST(test_name) __TEST_IMPL(test_name, -1)
>
> -/* TEST_SIGNAL(name, signal) { implementation }
> +/**
> + * TEST_SIGNAL(test_name, 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
> @@ -110,22 +145,38 @@
> static void test_name( \
> struct __test_metadata __attribute__((unused)) *_metadata)
>
> -/* FIXTURE_DATA(datatype name)
> +/**
> + * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
> + * argument to pass around
> + *
> + * @datatype_name: datatype name
> + *
> + * .. code-block:: c
> + *
> + * FIXTURE_DATA(datatype name)
> + *
> * 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.
> + * the *self* is being passed to a helper directly.
> */
> -/* Wraps the struct name so we have one less argument to pass around. */
> #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>
> -/* FIXTURE(datatype 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.
> +/**
> + * FIXTURE(fixture_name) - Called once per fixture to setup the data and
> + * register
> + *
> + * @fixture_name: fixture name
> + *
> + * .. code-block:: c
> + *
> + * FIXTURE(datatype 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().
> */
> -/* Called once per fixture to setup the data and register. */
> #define FIXTURE(fixture_name) \
> static void __attribute__((constructor)) \
> _register_##fixture_name##_data(void) \
> @@ -134,9 +185,18 @@
> } \
> FIXTURE_DATA(fixture_name)
>
> -/* FIXTURE_SETUP(fixture name) { implementation }
> +/**
> + * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
> + * *_metadata* is included so that ASSERT_* work as a convenience
> + *
> + * @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
> + * 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
> @@ -144,16 +204,21 @@
> *
> * A bare "return;" statement may be used to return early.
> */
> -/* Prepares the setup function for the fixture. |_metadata| is included
> - * so that ASSERT_* work as a convenience.
> - */
> #define FIXTURE_SETUP(fixture_name) \
> void fixture_name##_setup( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
> -/* FIXTURE_TEARDOWN(fixture name) { implementation }
> +/**
> + * FIXTURE_TEARDOWN(fixture_name)
> + *
> + * @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
> + * 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.
> @@ -163,15 +228,22 @@
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> -/* TEST_F(fixture, name) { implementation }
> +/**
> + * TEST_F(fixture_name, test_name) - 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
> + * Very similar to TEST() except that *self* is the setup instance of fixture's
> * datatype exposed for use by the implementation.
> */
> -/* Emits test registration and helpers for fixture-based test
> - * cases.
> - * TODO(wad) register fixtures on dedicated test lists.
> - */
> +/* TODO(wad) register fixtures on dedicated test lists. */
> #define TEST_F(fixture_name, test_name) \
> __TEST_F_IMPL(fixture_name, test_name, -1)
>
> @@ -210,10 +282,15 @@
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> -/* Use once to append a main() to the test file. E.g.,
> - * TEST_HARNESS_MAIN
> +/**
> + * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
> + *
> + * .. code-block:: c
> + *
> + * TEST_HARNESS_MAIN
> + *
> + * Use once to append a main() to the test file.
> */
> -/* Exports a simple wrapper to run the test harness. */
> #define TEST_HARNESS_MAIN \
> static void __attribute__((constructor)) \
> __constructor_order_last(void) \
> @@ -225,79 +302,247 @@
> return test_harness_run(argc, argv); \
> }
>
> -/*
> - * Operators for use in TEST and TEST_F.
> +/**
> + * DOC: operators
> + *
> + * Operators for use in TEST() and TEST_F().
> * ASSERT_* calls will stop test execution immediately.
> * EXPECT_* calls will emit a failure warning, note it, and continue.
> */
> -/* ASSERT_EQ(expected, measured): expected == measured */
> +
> +/**
> + * ASSERT_EQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_EQ(expected, measured): expected == measured
> + */
> #define ASSERT_EQ(expected, seen) \
> __EXPECT(expected, seen, ==, 1)
> -/* ASSERT_NE(expected, measured): expected != measured */
> +
> +/**
> + * ASSERT_NE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_NE(expected, measured): expected != measured
> + */
> #define ASSERT_NE(expected, seen) \
> __EXPECT(expected, seen, !=, 1)
> -/* ASSERT_LT(expected, measured): expected < measured */
> +
> +/**
> + * ASSERT_LT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_LT(expected, measured): expected < measured
> + */
> #define ASSERT_LT(expected, seen) \
> __EXPECT(expected, seen, <, 1)
> -/* ASSERT_LE(expected, measured): expected <= measured */
> +
> +/**
> + * ASSERT_LE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_LE(expected, measured): expected <= measured
> + */
> #define ASSERT_LE(expected, seen) \
> __EXPECT(expected, seen, <=, 1)
> -/* ASSERT_GT(expected, measured): expected > measured */
> +
> +/**
> + * ASSERT_GT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_GT(expected, measured): expected > measured
> + */
> #define ASSERT_GT(expected, seen) \
> __EXPECT(expected, seen, >, 1)
> -/* ASSERT_GE(expected, measured): expected >= measured */
> +
> +/**
> + * ASSERT_GE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_GE(expected, measured): expected >= measured
> + */
> #define ASSERT_GE(expected, seen) \
> __EXPECT(expected, seen, >=, 1)
> -/* ASSERT_NULL(measured): NULL == measured */
> +
> +/**
> + * ASSERT_NULL(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_NULL(measured): NULL == measured
> + */
> #define ASSERT_NULL(seen) \
> __EXPECT(NULL, seen, ==, 1)
>
> -/* ASSERT_TRUE(measured): measured != 0 */
> +/**
> + * ASSERT_TRUE(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_TRUE(measured): measured != 0
> + */
> #define ASSERT_TRUE(seen) \
> ASSERT_NE(0, seen)
> -/* ASSERT_FALSE(measured): measured == 0 */
> +
> +/**
> + * ASSERT_FALSE(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_FALSE(measured): measured == 0
> + */
> #define ASSERT_FALSE(seen) \
> ASSERT_EQ(0, seen)
> -/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
> +
> +/**
> + * ASSERT_STREQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
> + */
> #define ASSERT_STREQ(expected, seen) \
> __EXPECT_STR(expected, seen, ==, 1)
> -/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
> +
> +/**
> + * ASSERT_STRNE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
> + */
> #define ASSERT_STRNE(expected, seen) \
> __EXPECT_STR(expected, seen, !=, 1)
>
> -/* EXPECT_EQ(expected, measured): expected == measured */
> +/**
> + * EXPECT_EQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_EQ(expected, measured): expected == measured
> + */
> #define EXPECT_EQ(expected, seen) \
> __EXPECT(expected, seen, ==, 0)
> -/* EXPECT_NE(expected, measured): expected != measured */
> +
> +/**
> + * EXPECT_NE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_NE(expected, measured): expected != measured
> + */
> #define EXPECT_NE(expected, seen) \
> __EXPECT(expected, seen, !=, 0)
> -/* EXPECT_LT(expected, measured): expected < measured */
> +
> +/**
> + * EXPECT_LT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_LT(expected, measured): expected < measured
> + */
> #define EXPECT_LT(expected, seen) \
> __EXPECT(expected, seen, <, 0)
> -/* EXPECT_LE(expected, measured): expected <= measured */
> +
> +/**
> + * EXPECT_LE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_LE(expected, measured): expected <= measured
> + */
> #define EXPECT_LE(expected, seen) \
> __EXPECT(expected, seen, <=, 0)
> -/* EXPECT_GT(expected, measured): expected > measured */
> +
> +/**
> + * EXPECT_GT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_GT(expected, measured): expected > measured
> + */
> #define EXPECT_GT(expected, seen) \
> __EXPECT(expected, seen, >, 0)
> -/* EXPECT_GE(expected, measured): expected >= measured */
> +
> +/**
> + * EXPECT_GE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_GE(expected, measured): expected >= measured
> + */
> #define EXPECT_GE(expected, seen) \
> __EXPECT(expected, seen, >=, 0)
>
> -/* EXPECT_NULL(measured): NULL == measured */
> +/**
> + * EXPECT_NULL(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_NULL(measured): NULL == measured
> + */
> #define EXPECT_NULL(seen) \
> __EXPECT(NULL, seen, ==, 0)
> -/* EXPECT_TRUE(measured): 0 != measured */
> +
> +/**
> + * EXPECT_TRUE(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_TRUE(measured): 0 != measured
> + */
> #define EXPECT_TRUE(seen) \
> EXPECT_NE(0, seen)
> -/* EXPECT_FALSE(measured): 0 == measured */
> +
> +/**
> + * EXPECT_FALSE(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_FALSE(measured): 0 == measured
> + */
> #define EXPECT_FALSE(seen) \
> EXPECT_EQ(0, seen)
>
> -/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
> +/**
> + * EXPECT_STREQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
> + */
> #define EXPECT_STREQ(expected, seen) \
> __EXPECT_STR(expected, seen, ==, 0)
> -/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
> +
> +/**
> + * EXPECT_STRNE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
> + */
> #define EXPECT_STRNE(expected, seen) \
> __EXPECT_STR(expected, seen, !=, 0)
>
> --
> 2.11.0
>
--
Kees Cook
Pixel Security
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 0/7] Add kselftest_harness.h
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
` (6 preceding siblings ...)
2017-05-26 18:44 ` [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün
@ 2017-05-26 19:09 ` Kees Cook
2017-05-30 21:31 ` Shuah Khan
7 siblings, 1 reply; 18+ messages in thread
From: Kees Cook @ 2017-05-26 19:09 UTC (permalink / raw)
To: Mickaël Salaün, Shuah Khan
Cc: LKML, Andy Lutomirski, Jonathan Corbet, Will Drewry, linux-doc,
linux-kselftest
On Fri, May 26, 2017 at 11:43 AM, Mickaël Salaün <mic@digikod.net> wrote:
> Hi,
>
> This patch series make the seccomp/test_harness.h more generally available [1]
> and update the kselftest documentation in the Sphinx format. It also improve
> the Makefile of seccomp tests to take into account any kselftest_harness.h
> update.
>
> [1] https://lkml.kernel.org/r/CAGXu5j+8CVz8vL51DRYXqOY=xc3zuKFf=PTENe88XYHzFYidUQ@mail.gmail.com
>
> Regards,
>
> Mickaël Salaün (7):
> selftests: Make test_harness.h more generally available
> selftests: Cosmetic renames in kselftest_harness.h
> selftests/seccomp: Force rebuild according to dependencies
> Documentation/dev-tools: Add kselftest
> Documentation/dev-tools: Use reStructuredText markups for kselftest
> selftests: Remove the TEST_API() wrapper from kselftest_harness.h
> Documentation/dev-tools: Add kselftest_harness documentation
I think this series looks great; I've added my two remaining Acks.
Shuah, when you have time, please pull these into the selftest tree.
Thanks!
-Kees
>
> Documentation/00-INDEX | 2 -
> Documentation/dev-tools/index.rst | 1 +
> .../{kselftest.txt => dev-tools/kselftest.rst} | 101 ++-
> MAINTAINERS | 1 +
> .../test_harness.h => kselftest_harness.h} | 691 +++++++++++++--------
> tools/testing/selftests/seccomp/Makefile | 2 +
> tools/testing/selftests/seccomp/seccomp_bpf.c | 2 +-
> 7 files changed, 520 insertions(+), 280 deletions(-)
> rename Documentation/{kselftest.txt => dev-tools/kselftest.rst} (52%)
> rename tools/testing/selftests/{seccomp/test_harness.h => kselftest_harness.h} (52%)
>
> --
> 2.11.0
>
--
Kees Cook
Pixel Security
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 0/7] Add kselftest_harness.h
2017-05-26 19:09 ` [PATCH v5 0/7] Add kselftest_harness.h Kees Cook
@ 2017-05-30 21:31 ` Shuah Khan
0 siblings, 0 replies; 18+ messages in thread
From: Shuah Khan @ 2017-05-30 21:31 UTC (permalink / raw)
To: Kees Cook, Mickaël Salaün
Cc: LKML, Andy Lutomirski, Jonathan Corbet, Will Drewry, linux-doc,
linux-kselftest, Shuah Khan
On 05/26/2017 01:09 PM, Kees Cook wrote:
> On Fri, May 26, 2017 at 11:43 AM, Mickaël Salaün <mic@digikod.net> wrote:
>> Hi,
>>
>> This patch series make the seccomp/test_harness.h more generally available [1]
>> and update the kselftest documentation in the Sphinx format. It also improve
>> the Makefile of seccomp tests to take into account any kselftest_harness.h
>> update.
>>
>> [1] https://lkml.kernel.org/r/CAGXu5j+8CVz8vL51DRYXqOY=xc3zuKFf=PTENe88XYHzFYidUQ@mail.gmail.com
>>
>> Regards,
>>
>> Mickaël Salaün (7):
>> selftests: Make test_harness.h more generally available
>> selftests: Cosmetic renames in kselftest_harness.h
>> selftests/seccomp: Force rebuild according to dependencies
>> Documentation/dev-tools: Add kselftest
>> Documentation/dev-tools: Use reStructuredText markups for kselftest
>> selftests: Remove the TEST_API() wrapper from kselftest_harness.h
>> Documentation/dev-tools: Add kselftest_harness documentation
>
> I think this series looks great; I've added my two remaining Acks.
> Shuah, when you have time, please pull these into the selftest tree.
> Thanks!
>
> -Kees
Awesome. I will get this in this week.
-- Shuah
>
>>
>> Documentation/00-INDEX | 2 -
>> Documentation/dev-tools/index.rst | 1 +
>> .../{kselftest.txt => dev-tools/kselftest.rst} | 101 ++-
>> MAINTAINERS | 1 +
>> .../test_harness.h => kselftest_harness.h} | 691 +++++++++++++--------
>> tools/testing/selftests/seccomp/Makefile | 2 +
>> tools/testing/selftests/seccomp/seccomp_bpf.c | 2 +-
>> 7 files changed, 520 insertions(+), 280 deletions(-)
>> rename Documentation/{kselftest.txt => dev-tools/kselftest.rst} (52%)
>> rename tools/testing/selftests/{seccomp/test_harness.h => kselftest_harness.h} (52%)
>>
>> --
>> 2.11.0
>>
>
>
>
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies
2017-05-26 18:43 ` [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies Mickaël Salaün
@ 2017-06-02 19:31 ` Shuah Khan
2017-06-03 11:13 ` Mickaël Salaün
0 siblings, 1 reply; 18+ messages in thread
From: Shuah Khan @ 2017-06-02 19:31 UTC (permalink / raw)
To: Mickaël Salaün, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan, Shuah Khan
Hi Mickaël,
On 05/26/2017 12:43 PM, Mickaël Salaün wrote:
> Rebuild the seccomp tests when kselftest_harness.h is updated.
>
> Signed-off-by: Mickaël Salaün <mic@digikod.net>
> Acked-by: Kees Cook <keescook@chromium.org>
> Cc: Andy Lutomirski <luto@amacapital.net>
> Cc: Shuah Khan <shuah@kernel.org>
> Cc: Will Drewry <wad@chromium.org>
> ---
> tools/testing/selftests/seccomp/Makefile | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/tools/testing/selftests/seccomp/Makefile b/tools/testing/selftests/seccomp/Makefile
> index 5fa6fd2246b1..aeb0c805f3ca 100644
> --- a/tools/testing/selftests/seccomp/Makefile
> +++ b/tools/testing/selftests/seccomp/Makefile
> @@ -4,3 +4,5 @@ LDFLAGS += -lpthread
>
> include ../lib.mk
>
> +$(TEST_GEN_PROGS): seccomp_bpf.c ../kselftest_harness.h
> + $(CC) $(CFLAGS) $(LDFLAGS) $< -o $@
>
This change breaks seccomp build:
make -C tools/testing/selftests/seccomp/
make: Entering directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
make: Leaving directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
shuah@mazurka:/mnt/data/lkml/linux_4.12$ cd tools/testing/selftests/seccomp/
shuah@mazurka:/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp$ make
make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
Did you happen to try building with this change?
thanks,
-- Shuah
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation
2017-05-26 18:44 ` [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün
2017-05-26 19:08 ` Kees Cook
@ 2017-06-02 20:02 ` Shuah Khan
2017-06-03 11:17 ` Mickaël Salaün
1 sibling, 1 reply; 18+ messages in thread
From: Shuah Khan @ 2017-06-02 20:02 UTC (permalink / raw)
To: Mickaël Salaün, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan, Shuah Khan
Hi Mickaël,
On 05/26/2017 12:44 PM, Mickaël Salaün wrote:
> Add ReST metadata to kselftest_harness.h to be able to include the
> comments in the Sphinx documentation.
>
These don't belong the change log. These types of changes are for
reviewers benefit and should be added between the sign-of block
and the start of diff.
I had to fix a few patches in this series before commit.
> Changes since v4:
> * exclude the TEST_API() changes (requested by Kees Cook)
>
> Changes since v3:
> * document macros as actual functions (suggested by Jonathan Corbet)
> * remove the TEST_API() wrapper to expose the underlying macro arguments
> to the documentation tools
> * move and cleanup comments
>
> Changes since v2:
> * add reference to the full documentation in the header file (suggested
> by Kees Cook)
>
> Signed-off-by: Mickaël Salaün <mic@digikod.net>
> Cc: Andy Lutomirski <luto@amacapital.net>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Kees Cook <keescook@chromium.org>
> Cc: Shuah Khan <shuah@kernel.org>
> Cc: Will Drewry <wad@chromium.org>
git am isn't happy:
Applying: Documentation/dev-tools: Add kselftest_harness documentation
.git/rebase-apply/patch:47: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Please fix and resend.
-- Shuah
> ---
> Documentation/dev-tools/kselftest.rst | 34 +++
> tools/testing/selftests/kselftest_harness.h | 415 ++++++++++++++++++++++------
> 2 files changed, 364 insertions(+), 85 deletions(-)
>
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index 9232ce94612c..a92fa181b6cf 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -120,3 +120,37 @@ Contributing new tests (details)
> executable which is not tested by default.
> TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
> test.
> +
> +Test Harness
> +============
> +
> +The kselftest_harness.h file contains useful helpers to build tests. The tests
> +from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.
> +
> +Example
> +-------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :doc: example
> +
> +
> +Helpers
> +-------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
> + FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN
> +
> +Operators
> +---------
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :doc: operators
> +
> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
> + :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
> + ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
> + ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
> + EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
> + EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
> +
> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
> index 45f807ce37e1..c56f72e07cd7 100644
> --- a/tools/testing/selftests/kselftest_harness.h
> +++ b/tools/testing/selftests/kselftest_harness.h
> @@ -4,41 +4,49 @@
> *
> * kselftest_harness.h: simple C unit test helper.
> *
> - * Usage:
> - * #include "../kselftest_harness.h"
> - * TEST(standalone_test) {
> - * do_some_stuff;
> - * EXPECT_GT(10, stuff) {
> - * stuff_state_t state;
> - * enumerate_stuff_state(&state);
> - * TH_LOG("expectation failed with state: %s", state.msg);
> - * }
> - * more_stuff;
> - * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
> - * last_stuff;
> - * EXPECT_EQ(0, last_stuff);
> - * }
> - *
> - * FIXTURE(my_fixture) {
> - * mytype_t *data;
> - * int awesomeness_level;
> - * };
> - * FIXTURE_SETUP(my_fixture) {
> - * self->data = mytype_new();
> - * ASSERT_NE(NULL, self->data);
> - * }
> - * FIXTURE_TEARDOWN(my_fixture) {
> - * mytype_free(self->data);
> - * }
> - * TEST_F(my_fixture, data_is_good) {
> - * EXPECT_EQ(1, is_my_data_good(self->data));
> - * }
> - *
> - * TEST_HARNESS_MAIN
> + * See documentation in Documentation/dev-tools/kselftest.rst
> *
> * API inspired by code.google.com/p/googletest
> */
>
> +/**
> + * DOC: example
> + *
> + * .. code-block:: c
> + *
> + * #include "../kselftest_harness.h"
> + *
> + * TEST(standalone_test) {
> + * do_some_stuff;
> + * EXPECT_GT(10, stuff) {
> + * stuff_state_t state;
> + * enumerate_stuff_state(&state);
> + * TH_LOG("expectation failed with state: %s", state.msg);
> + * }
> + * more_stuff;
> + * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
> + * last_stuff;
> + * EXPECT_EQ(0, last_stuff);
> + * }
> + *
> + * FIXTURE(my_fixture) {
> + * mytype_t *data;
> + * int awesomeness_level;
> + * };
> + * FIXTURE_SETUP(my_fixture) {
> + * self->data = mytype_new();
> + * ASSERT_NE(NULL, self->data);
> + * }
> + * FIXTURE_TEARDOWN(my_fixture) {
> + * mytype_free(self->data);
> + * }
> + * TEST_F(my_fixture, data_is_good) {
> + * EXPECT_EQ(1, is_my_data_good(self->data));
> + * }
> + *
> + * TEST_HARNESS_MAIN
> + */
> +
> #ifndef __KSELFTEST_HARNESS_H
> #define __KSELFTEST_HARNESS_H
>
> @@ -61,10 +69,20 @@
> # define TH_LOG_ENABLED 1
> #endif
>
> -/* TH_LOG(format, ...)
> +/**
> + * TH_LOG(fmt, ...)
> + *
> + * @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.
> */
> #define TH_LOG(fmt, ...) do { \
> @@ -77,7 +95,16 @@
> fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>
> -/* TEST(name) { implementation }
> +/**
> + * TEST(test_name) - 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
> @@ -85,10 +112,18 @@
> *
> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
> */
> -/* Defines the test function and creates the registration stub. */
> #define TEST(test_name) __TEST_IMPL(test_name, -1)
>
> -/* TEST_SIGNAL(name, signal) { implementation }
> +/**
> + * TEST_SIGNAL(test_name, 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
> @@ -110,22 +145,38 @@
> static void test_name( \
> struct __test_metadata __attribute__((unused)) *_metadata)
>
> -/* FIXTURE_DATA(datatype name)
> +/**
> + * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
> + * argument to pass around
> + *
> + * @datatype_name: datatype name
> + *
> + * .. code-block:: c
> + *
> + * FIXTURE_DATA(datatype name)
> + *
> * 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.
> + * the *self* is being passed to a helper directly.
> */
> -/* Wraps the struct name so we have one less argument to pass around. */
> #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>
> -/* FIXTURE(datatype 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.
> +/**
> + * FIXTURE(fixture_name) - Called once per fixture to setup the data and
> + * register
> + *
> + * @fixture_name: fixture name
> + *
> + * .. code-block:: c
> + *
> + * FIXTURE(datatype 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().
> */
> -/* Called once per fixture to setup the data and register. */
> #define FIXTURE(fixture_name) \
> static void __attribute__((constructor)) \
> _register_##fixture_name##_data(void) \
> @@ -134,9 +185,18 @@
> } \
> FIXTURE_DATA(fixture_name)
>
> -/* FIXTURE_SETUP(fixture name) { implementation }
> +/**
> + * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
> + * *_metadata* is included so that ASSERT_* work as a convenience
> + *
> + * @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
> + * 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
> @@ -144,16 +204,21 @@
> *
> * A bare "return;" statement may be used to return early.
> */
> -/* Prepares the setup function for the fixture. |_metadata| is included
> - * so that ASSERT_* work as a convenience.
> - */
> #define FIXTURE_SETUP(fixture_name) \
> void fixture_name##_setup( \
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
> -/* FIXTURE_TEARDOWN(fixture name) { implementation }
> +/**
> + * FIXTURE_TEARDOWN(fixture_name)
> + *
> + * @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
> + * 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.
> @@ -163,15 +228,22 @@
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> -/* TEST_F(fixture, name) { implementation }
> +/**
> + * TEST_F(fixture_name, test_name) - 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
> + * Very similar to TEST() except that *self* is the setup instance of fixture's
> * datatype exposed for use by the implementation.
> */
> -/* Emits test registration and helpers for fixture-based test
> - * cases.
> - * TODO(wad) register fixtures on dedicated test lists.
> - */
> +/* TODO(wad) register fixtures on dedicated test lists. */
> #define TEST_F(fixture_name, test_name) \
> __TEST_F_IMPL(fixture_name, test_name, -1)
>
> @@ -210,10 +282,15 @@
> struct __test_metadata __attribute__((unused)) *_metadata, \
> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>
> -/* Use once to append a main() to the test file. E.g.,
> - * TEST_HARNESS_MAIN
> +/**
> + * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
> + *
> + * .. code-block:: c
> + *
> + * TEST_HARNESS_MAIN
> + *
> + * Use once to append a main() to the test file.
> */
> -/* Exports a simple wrapper to run the test harness. */
> #define TEST_HARNESS_MAIN \
> static void __attribute__((constructor)) \
> __constructor_order_last(void) \
> @@ -225,79 +302,247 @@
> return test_harness_run(argc, argv); \
> }
>
> -/*
> - * Operators for use in TEST and TEST_F.
> +/**
> + * DOC: operators
> + *
> + * Operators for use in TEST() and TEST_F().
> * ASSERT_* calls will stop test execution immediately.
> * EXPECT_* calls will emit a failure warning, note it, and continue.
> */
> -/* ASSERT_EQ(expected, measured): expected == measured */
> +
> +/**
> + * ASSERT_EQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_EQ(expected, measured): expected == measured
> + */
> #define ASSERT_EQ(expected, seen) \
> __EXPECT(expected, seen, ==, 1)
> -/* ASSERT_NE(expected, measured): expected != measured */
> +
> +/**
> + * ASSERT_NE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_NE(expected, measured): expected != measured
> + */
> #define ASSERT_NE(expected, seen) \
> __EXPECT(expected, seen, !=, 1)
> -/* ASSERT_LT(expected, measured): expected < measured */
> +
> +/**
> + * ASSERT_LT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_LT(expected, measured): expected < measured
> + */
> #define ASSERT_LT(expected, seen) \
> __EXPECT(expected, seen, <, 1)
> -/* ASSERT_LE(expected, measured): expected <= measured */
> +
> +/**
> + * ASSERT_LE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_LE(expected, measured): expected <= measured
> + */
> #define ASSERT_LE(expected, seen) \
> __EXPECT(expected, seen, <=, 1)
> -/* ASSERT_GT(expected, measured): expected > measured */
> +
> +/**
> + * ASSERT_GT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_GT(expected, measured): expected > measured
> + */
> #define ASSERT_GT(expected, seen) \
> __EXPECT(expected, seen, >, 1)
> -/* ASSERT_GE(expected, measured): expected >= measured */
> +
> +/**
> + * ASSERT_GE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_GE(expected, measured): expected >= measured
> + */
> #define ASSERT_GE(expected, seen) \
> __EXPECT(expected, seen, >=, 1)
> -/* ASSERT_NULL(measured): NULL == measured */
> +
> +/**
> + * ASSERT_NULL(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_NULL(measured): NULL == measured
> + */
> #define ASSERT_NULL(seen) \
> __EXPECT(NULL, seen, ==, 1)
>
> -/* ASSERT_TRUE(measured): measured != 0 */
> +/**
> + * ASSERT_TRUE(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_TRUE(measured): measured != 0
> + */
> #define ASSERT_TRUE(seen) \
> ASSERT_NE(0, seen)
> -/* ASSERT_FALSE(measured): measured == 0 */
> +
> +/**
> + * ASSERT_FALSE(seen)
> + *
> + * @seen: measured value
> + *
> + * ASSERT_FALSE(measured): measured == 0
> + */
> #define ASSERT_FALSE(seen) \
> ASSERT_EQ(0, seen)
> -/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
> +
> +/**
> + * ASSERT_STREQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
> + */
> #define ASSERT_STREQ(expected, seen) \
> __EXPECT_STR(expected, seen, ==, 1)
> -/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
> +
> +/**
> + * ASSERT_STRNE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
> + */
> #define ASSERT_STRNE(expected, seen) \
> __EXPECT_STR(expected, seen, !=, 1)
>
> -/* EXPECT_EQ(expected, measured): expected == measured */
> +/**
> + * EXPECT_EQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_EQ(expected, measured): expected == measured
> + */
> #define EXPECT_EQ(expected, seen) \
> __EXPECT(expected, seen, ==, 0)
> -/* EXPECT_NE(expected, measured): expected != measured */
> +
> +/**
> + * EXPECT_NE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_NE(expected, measured): expected != measured
> + */
> #define EXPECT_NE(expected, seen) \
> __EXPECT(expected, seen, !=, 0)
> -/* EXPECT_LT(expected, measured): expected < measured */
> +
> +/**
> + * EXPECT_LT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_LT(expected, measured): expected < measured
> + */
> #define EXPECT_LT(expected, seen) \
> __EXPECT(expected, seen, <, 0)
> -/* EXPECT_LE(expected, measured): expected <= measured */
> +
> +/**
> + * EXPECT_LE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_LE(expected, measured): expected <= measured
> + */
> #define EXPECT_LE(expected, seen) \
> __EXPECT(expected, seen, <=, 0)
> -/* EXPECT_GT(expected, measured): expected > measured */
> +
> +/**
> + * EXPECT_GT(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_GT(expected, measured): expected > measured
> + */
> #define EXPECT_GT(expected, seen) \
> __EXPECT(expected, seen, >, 0)
> -/* EXPECT_GE(expected, measured): expected >= measured */
> +
> +/**
> + * EXPECT_GE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_GE(expected, measured): expected >= measured
> + */
> #define EXPECT_GE(expected, seen) \
> __EXPECT(expected, seen, >=, 0)
>
> -/* EXPECT_NULL(measured): NULL == measured */
> +/**
> + * EXPECT_NULL(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_NULL(measured): NULL == measured
> + */
> #define EXPECT_NULL(seen) \
> __EXPECT(NULL, seen, ==, 0)
> -/* EXPECT_TRUE(measured): 0 != measured */
> +
> +/**
> + * EXPECT_TRUE(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_TRUE(measured): 0 != measured
> + */
> #define EXPECT_TRUE(seen) \
> EXPECT_NE(0, seen)
> -/* EXPECT_FALSE(measured): 0 == measured */
> +
> +/**
> + * EXPECT_FALSE(seen)
> + *
> + * @seen: measured value
> + *
> + * EXPECT_FALSE(measured): 0 == measured
> + */
> #define EXPECT_FALSE(seen) \
> EXPECT_EQ(0, seen)
>
> -/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
> +/**
> + * EXPECT_STREQ(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
> + */
> #define EXPECT_STREQ(expected, seen) \
> __EXPECT_STR(expected, seen, ==, 0)
> -/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
> +
> +/**
> + * EXPECT_STRNE(expected, seen)
> + *
> + * @expected: expected value
> + * @seen: measured value
> + *
> + * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
> + */
> #define EXPECT_STRNE(expected, seen) \
> __EXPECT_STR(expected, seen, !=, 0)
>
>
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies
2017-06-02 19:31 ` Shuah Khan
@ 2017-06-03 11:13 ` Mickaël Salaün
2017-06-05 18:17 ` Shuah Khan
0 siblings, 1 reply; 18+ messages in thread
From: Mickaël Salaün @ 2017-06-03 11:13 UTC (permalink / raw)
To: shuah, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan
[-- Attachment #1.1: Type: text/plain, Size: 2218 bytes --]
Hi Shuah,
On 02/06/2017 21:31, Shuah Khan wrote:
> Hi Mickaël,
>
> On 05/26/2017 12:43 PM, Mickaël Salaün wrote:
>> Rebuild the seccomp tests when kselftest_harness.h is updated.
>>
>> Signed-off-by: Mickaël Salaün <mic@digikod.net>
>> Acked-by: Kees Cook <keescook@chromium.org>
>> Cc: Andy Lutomirski <luto@amacapital.net>
>> Cc: Shuah Khan <shuah@kernel.org>
>> Cc: Will Drewry <wad@chromium.org>
>> ---
>> tools/testing/selftests/seccomp/Makefile | 2 ++
>> 1 file changed, 2 insertions(+)
>>
>> diff --git a/tools/testing/selftests/seccomp/Makefile b/tools/testing/selftests/seccomp/Makefile
>> index 5fa6fd2246b1..aeb0c805f3ca 100644
>> --- a/tools/testing/selftests/seccomp/Makefile
>> +++ b/tools/testing/selftests/seccomp/Makefile
>> @@ -4,3 +4,5 @@ LDFLAGS += -lpthread
>>
>> include ../lib.mk
>>
>> +$(TEST_GEN_PROGS): seccomp_bpf.c ../kselftest_harness.h
>> + $(CC) $(CFLAGS) $(LDFLAGS) $< -o $@
>>
>
> This change breaks seccomp build:
>
> make -C tools/testing/selftests/seccomp/
> make: Entering directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
> make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
> make: Leaving directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
> shuah@mazurka:/mnt/data/lkml/linux_4.12$ cd tools/testing/selftests/seccomp/
> shuah@mazurka:/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp$ make
> make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
>
>
> Did you happen to try building with this change?
Yes I did, and it builds fine for me (with the same command and
patches). There is only one warning from GCC with
../kselftest_harness.h:368 because of the trick from OPTIONAL_HANDLER(),
which is intentional (and not modified by my patches).
I don't get why your "make" said that there is "No rule to make target"
../kselftest_harness.h . This file exists (patch 1/7) so there is no
need to create it…
gen_kselftest_tar.sh works fine too.
Thanks,
Mickaël
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation
2017-06-02 20:02 ` Shuah Khan
@ 2017-06-03 11:17 ` Mickaël Salaün
2017-06-05 18:20 ` Shuah Khan
0 siblings, 1 reply; 18+ messages in thread
From: Mickaël Salaün @ 2017-06-03 11:17 UTC (permalink / raw)
To: shuah, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan
[-- Attachment #1.1: Type: text/plain, Size: 21067 bytes --]
On 02/06/2017 22:02, Shuah Khan wrote:
> Hi Mickaël,
>
> On 05/26/2017 12:44 PM, Mickaël Salaün wrote:
>> Add ReST metadata to kselftest_harness.h to be able to include the
>> comments in the Sphinx documentation.
>>
>
> These don't belong the change log. These types of changes are for
> reviewers benefit and should be added between the sign-of block
> and the start of diff.
OK, I didn't know this rule, which seems different from one maintainer
to another. I'll take this into account the next time.
>
> I had to fix a few patches in this series before commit.
>
>> Changes since v4:
>> * exclude the TEST_API() changes (requested by Kees Cook)
>>
>> Changes since v3:
>> * document macros as actual functions (suggested by Jonathan Corbet)
>> * remove the TEST_API() wrapper to expose the underlying macro arguments
>> to the documentation tools
>> * move and cleanup comments
>>
>> Changes since v2:
>> * add reference to the full documentation in the header file (suggested
>> by Kees Cook)
>
>>
>> Signed-off-by: Mickaël Salaün <mic@digikod.net>
>> Cc: Andy Lutomirski <luto@amacapital.net>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Kees Cook <keescook@chromium.org>
>> Cc: Shuah Khan <shuah@kernel.org>
>> Cc: Will Drewry <wad@chromium.org>
>
> git am isn't happy:
>
> Applying: Documentation/dev-tools: Add kselftest_harness documentation
> .git/rebase-apply/patch:47: new blank line at EOF.
> +
> warning: 1 line adds whitespace errors.
>
> Please fix and resend.
I didn't try to apply the series with "git am" since neither "git
format-patch" nor scripts/checkpatch.pl output a warning.
This "git am" warning is about the last line of the ReST file which end
with an empty line. I will fix it if needed.
>
> -- Shuah
>
>> ---
>> Documentation/dev-tools/kselftest.rst | 34 +++
>> tools/testing/selftests/kselftest_harness.h | 415 ++++++++++++++++++++++------
>> 2 files changed, 364 insertions(+), 85 deletions(-)
>>
>> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
>> index 9232ce94612c..a92fa181b6cf 100644
>> --- a/Documentation/dev-tools/kselftest.rst
>> +++ b/Documentation/dev-tools/kselftest.rst
>> @@ -120,3 +120,37 @@ Contributing new tests (details)
>> executable which is not tested by default.
>> TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
>> test.
>> +
>> +Test Harness
>> +============
>> +
>> +The kselftest_harness.h file contains useful helpers to build tests. The tests
>> +from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.
>> +
>> +Example
>> +-------
>> +
>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>> + :doc: example
>> +
>> +
>> +Helpers
>> +-------
>> +
>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>> + :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
>> + FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN
>> +
>> +Operators
>> +---------
>> +
>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>> + :doc: operators
>> +
>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>> + :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
>> + ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
>> + ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
>> + EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
>> + EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
>> +
>> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
>> index 45f807ce37e1..c56f72e07cd7 100644
>> --- a/tools/testing/selftests/kselftest_harness.h
>> +++ b/tools/testing/selftests/kselftest_harness.h
>> @@ -4,41 +4,49 @@
>> *
>> * kselftest_harness.h: simple C unit test helper.
>> *
>> - * Usage:
>> - * #include "../kselftest_harness.h"
>> - * TEST(standalone_test) {
>> - * do_some_stuff;
>> - * EXPECT_GT(10, stuff) {
>> - * stuff_state_t state;
>> - * enumerate_stuff_state(&state);
>> - * TH_LOG("expectation failed with state: %s", state.msg);
>> - * }
>> - * more_stuff;
>> - * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
>> - * last_stuff;
>> - * EXPECT_EQ(0, last_stuff);
>> - * }
>> - *
>> - * FIXTURE(my_fixture) {
>> - * mytype_t *data;
>> - * int awesomeness_level;
>> - * };
>> - * FIXTURE_SETUP(my_fixture) {
>> - * self->data = mytype_new();
>> - * ASSERT_NE(NULL, self->data);
>> - * }
>> - * FIXTURE_TEARDOWN(my_fixture) {
>> - * mytype_free(self->data);
>> - * }
>> - * TEST_F(my_fixture, data_is_good) {
>> - * EXPECT_EQ(1, is_my_data_good(self->data));
>> - * }
>> - *
>> - * TEST_HARNESS_MAIN
>> + * See documentation in Documentation/dev-tools/kselftest.rst
>> *
>> * API inspired by code.google.com/p/googletest
>> */
>>
>> +/**
>> + * DOC: example
>> + *
>> + * .. code-block:: c
>> + *
>> + * #include "../kselftest_harness.h"
>> + *
>> + * TEST(standalone_test) {
>> + * do_some_stuff;
>> + * EXPECT_GT(10, stuff) {
>> + * stuff_state_t state;
>> + * enumerate_stuff_state(&state);
>> + * TH_LOG("expectation failed with state: %s", state.msg);
>> + * }
>> + * more_stuff;
>> + * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
>> + * last_stuff;
>> + * EXPECT_EQ(0, last_stuff);
>> + * }
>> + *
>> + * FIXTURE(my_fixture) {
>> + * mytype_t *data;
>> + * int awesomeness_level;
>> + * };
>> + * FIXTURE_SETUP(my_fixture) {
>> + * self->data = mytype_new();
>> + * ASSERT_NE(NULL, self->data);
>> + * }
>> + * FIXTURE_TEARDOWN(my_fixture) {
>> + * mytype_free(self->data);
>> + * }
>> + * TEST_F(my_fixture, data_is_good) {
>> + * EXPECT_EQ(1, is_my_data_good(self->data));
>> + * }
>> + *
>> + * TEST_HARNESS_MAIN
>> + */
>> +
>> #ifndef __KSELFTEST_HARNESS_H
>> #define __KSELFTEST_HARNESS_H
>>
>> @@ -61,10 +69,20 @@
>> # define TH_LOG_ENABLED 1
>> #endif
>>
>> -/* TH_LOG(format, ...)
>> +/**
>> + * TH_LOG(fmt, ...)
>> + *
>> + * @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.
>> */
>> #define TH_LOG(fmt, ...) do { \
>> @@ -77,7 +95,16 @@
>> fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
>> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>>
>> -/* TEST(name) { implementation }
>> +/**
>> + * TEST(test_name) - 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
>> @@ -85,10 +112,18 @@
>> *
>> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
>> */
>> -/* Defines the test function and creates the registration stub. */
>> #define TEST(test_name) __TEST_IMPL(test_name, -1)
>>
>> -/* TEST_SIGNAL(name, signal) { implementation }
>> +/**
>> + * TEST_SIGNAL(test_name, 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
>> @@ -110,22 +145,38 @@
>> static void test_name( \
>> struct __test_metadata __attribute__((unused)) *_metadata)
>>
>> -/* FIXTURE_DATA(datatype name)
>> +/**
>> + * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
>> + * argument to pass around
>> + *
>> + * @datatype_name: datatype name
>> + *
>> + * .. code-block:: c
>> + *
>> + * FIXTURE_DATA(datatype name)
>> + *
>> * 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.
>> + * the *self* is being passed to a helper directly.
>> */
>> -/* Wraps the struct name so we have one less argument to pass around. */
>> #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>>
>> -/* FIXTURE(datatype 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.
>> +/**
>> + * FIXTURE(fixture_name) - Called once per fixture to setup the data and
>> + * register
>> + *
>> + * @fixture_name: fixture name
>> + *
>> + * .. code-block:: c
>> + *
>> + * FIXTURE(datatype 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().
>> */
>> -/* Called once per fixture to setup the data and register. */
>> #define FIXTURE(fixture_name) \
>> static void __attribute__((constructor)) \
>> _register_##fixture_name##_data(void) \
>> @@ -134,9 +185,18 @@
>> } \
>> FIXTURE_DATA(fixture_name)
>>
>> -/* FIXTURE_SETUP(fixture name) { implementation }
>> +/**
>> + * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
>> + * *_metadata* is included so that ASSERT_* work as a convenience
>> + *
>> + * @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
>> + * 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
>> @@ -144,16 +204,21 @@
>> *
>> * A bare "return;" statement may be used to return early.
>> */
>> -/* Prepares the setup function for the fixture. |_metadata| is included
>> - * so that ASSERT_* work as a convenience.
>> - */
>> #define FIXTURE_SETUP(fixture_name) \
>> void fixture_name##_setup( \
>> struct __test_metadata __attribute__((unused)) *_metadata, \
>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>> -/* FIXTURE_TEARDOWN(fixture name) { implementation }
>> +/**
>> + * FIXTURE_TEARDOWN(fixture_name)
>> + *
>> + * @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
>> + * 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.
>> @@ -163,15 +228,22 @@
>> struct __test_metadata __attribute__((unused)) *_metadata, \
>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>>
>> -/* TEST_F(fixture, name) { implementation }
>> +/**
>> + * TEST_F(fixture_name, test_name) - 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
>> + * Very similar to TEST() except that *self* is the setup instance of fixture's
>> * datatype exposed for use by the implementation.
>> */
>> -/* Emits test registration and helpers for fixture-based test
>> - * cases.
>> - * TODO(wad) register fixtures on dedicated test lists.
>> - */
>> +/* TODO(wad) register fixtures on dedicated test lists. */
>> #define TEST_F(fixture_name, test_name) \
>> __TEST_F_IMPL(fixture_name, test_name, -1)
>>
>> @@ -210,10 +282,15 @@
>> struct __test_metadata __attribute__((unused)) *_metadata, \
>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>>
>> -/* Use once to append a main() to the test file. E.g.,
>> - * TEST_HARNESS_MAIN
>> +/**
>> + * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
>> + *
>> + * .. code-block:: c
>> + *
>> + * TEST_HARNESS_MAIN
>> + *
>> + * Use once to append a main() to the test file.
>> */
>> -/* Exports a simple wrapper to run the test harness. */
>> #define TEST_HARNESS_MAIN \
>> static void __attribute__((constructor)) \
>> __constructor_order_last(void) \
>> @@ -225,79 +302,247 @@
>> return test_harness_run(argc, argv); \
>> }
>>
>> -/*
>> - * Operators for use in TEST and TEST_F.
>> +/**
>> + * DOC: operators
>> + *
>> + * Operators for use in TEST() and TEST_F().
>> * ASSERT_* calls will stop test execution immediately.
>> * EXPECT_* calls will emit a failure warning, note it, and continue.
>> */
>> -/* ASSERT_EQ(expected, measured): expected == measured */
>> +
>> +/**
>> + * ASSERT_EQ(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_EQ(expected, measured): expected == measured
>> + */
>> #define ASSERT_EQ(expected, seen) \
>> __EXPECT(expected, seen, ==, 1)
>> -/* ASSERT_NE(expected, measured): expected != measured */
>> +
>> +/**
>> + * ASSERT_NE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_NE(expected, measured): expected != measured
>> + */
>> #define ASSERT_NE(expected, seen) \
>> __EXPECT(expected, seen, !=, 1)
>> -/* ASSERT_LT(expected, measured): expected < measured */
>> +
>> +/**
>> + * ASSERT_LT(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_LT(expected, measured): expected < measured
>> + */
>> #define ASSERT_LT(expected, seen) \
>> __EXPECT(expected, seen, <, 1)
>> -/* ASSERT_LE(expected, measured): expected <= measured */
>> +
>> +/**
>> + * ASSERT_LE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_LE(expected, measured): expected <= measured
>> + */
>> #define ASSERT_LE(expected, seen) \
>> __EXPECT(expected, seen, <=, 1)
>> -/* ASSERT_GT(expected, measured): expected > measured */
>> +
>> +/**
>> + * ASSERT_GT(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_GT(expected, measured): expected > measured
>> + */
>> #define ASSERT_GT(expected, seen) \
>> __EXPECT(expected, seen, >, 1)
>> -/* ASSERT_GE(expected, measured): expected >= measured */
>> +
>> +/**
>> + * ASSERT_GE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_GE(expected, measured): expected >= measured
>> + */
>> #define ASSERT_GE(expected, seen) \
>> __EXPECT(expected, seen, >=, 1)
>> -/* ASSERT_NULL(measured): NULL == measured */
>> +
>> +/**
>> + * ASSERT_NULL(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * ASSERT_NULL(measured): NULL == measured
>> + */
>> #define ASSERT_NULL(seen) \
>> __EXPECT(NULL, seen, ==, 1)
>>
>> -/* ASSERT_TRUE(measured): measured != 0 */
>> +/**
>> + * ASSERT_TRUE(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * ASSERT_TRUE(measured): measured != 0
>> + */
>> #define ASSERT_TRUE(seen) \
>> ASSERT_NE(0, seen)
>> -/* ASSERT_FALSE(measured): measured == 0 */
>> +
>> +/**
>> + * ASSERT_FALSE(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * ASSERT_FALSE(measured): measured == 0
>> + */
>> #define ASSERT_FALSE(seen) \
>> ASSERT_EQ(0, seen)
>> -/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
>> +
>> +/**
>> + * ASSERT_STREQ(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
>> + */
>> #define ASSERT_STREQ(expected, seen) \
>> __EXPECT_STR(expected, seen, ==, 1)
>> -/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
>> +
>> +/**
>> + * ASSERT_STRNE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
>> + */
>> #define ASSERT_STRNE(expected, seen) \
>> __EXPECT_STR(expected, seen, !=, 1)
>>
>> -/* EXPECT_EQ(expected, measured): expected == measured */
>> +/**
>> + * EXPECT_EQ(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_EQ(expected, measured): expected == measured
>> + */
>> #define EXPECT_EQ(expected, seen) \
>> __EXPECT(expected, seen, ==, 0)
>> -/* EXPECT_NE(expected, measured): expected != measured */
>> +
>> +/**
>> + * EXPECT_NE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_NE(expected, measured): expected != measured
>> + */
>> #define EXPECT_NE(expected, seen) \
>> __EXPECT(expected, seen, !=, 0)
>> -/* EXPECT_LT(expected, measured): expected < measured */
>> +
>> +/**
>> + * EXPECT_LT(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_LT(expected, measured): expected < measured
>> + */
>> #define EXPECT_LT(expected, seen) \
>> __EXPECT(expected, seen, <, 0)
>> -/* EXPECT_LE(expected, measured): expected <= measured */
>> +
>> +/**
>> + * EXPECT_LE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_LE(expected, measured): expected <= measured
>> + */
>> #define EXPECT_LE(expected, seen) \
>> __EXPECT(expected, seen, <=, 0)
>> -/* EXPECT_GT(expected, measured): expected > measured */
>> +
>> +/**
>> + * EXPECT_GT(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_GT(expected, measured): expected > measured
>> + */
>> #define EXPECT_GT(expected, seen) \
>> __EXPECT(expected, seen, >, 0)
>> -/* EXPECT_GE(expected, measured): expected >= measured */
>> +
>> +/**
>> + * EXPECT_GE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_GE(expected, measured): expected >= measured
>> + */
>> #define EXPECT_GE(expected, seen) \
>> __EXPECT(expected, seen, >=, 0)
>>
>> -/* EXPECT_NULL(measured): NULL == measured */
>> +/**
>> + * EXPECT_NULL(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * EXPECT_NULL(measured): NULL == measured
>> + */
>> #define EXPECT_NULL(seen) \
>> __EXPECT(NULL, seen, ==, 0)
>> -/* EXPECT_TRUE(measured): 0 != measured */
>> +
>> +/**
>> + * EXPECT_TRUE(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * EXPECT_TRUE(measured): 0 != measured
>> + */
>> #define EXPECT_TRUE(seen) \
>> EXPECT_NE(0, seen)
>> -/* EXPECT_FALSE(measured): 0 == measured */
>> +
>> +/**
>> + * EXPECT_FALSE(seen)
>> + *
>> + * @seen: measured value
>> + *
>> + * EXPECT_FALSE(measured): 0 == measured
>> + */
>> #define EXPECT_FALSE(seen) \
>> EXPECT_EQ(0, seen)
>>
>> -/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
>> +/**
>> + * EXPECT_STREQ(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
>> + */
>> #define EXPECT_STREQ(expected, seen) \
>> __EXPECT_STR(expected, seen, ==, 0)
>> -/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
>> +
>> +/**
>> + * EXPECT_STRNE(expected, seen)
>> + *
>> + * @expected: expected value
>> + * @seen: measured value
>> + *
>> + * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
>> + */
>> #define EXPECT_STRNE(expected, seen) \
>> __EXPECT_STR(expected, seen, !=, 0)
>>
>>
>
>
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies
2017-06-03 11:13 ` Mickaël Salaün
@ 2017-06-05 18:17 ` Shuah Khan
0 siblings, 0 replies; 18+ messages in thread
From: Shuah Khan @ 2017-06-05 18:17 UTC (permalink / raw)
To: Mickaël Salaün, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan, Shuah Khan
[-- Attachment #1.1: Type: text/plain, Size: 2476 bytes --]
Hi Mickaël,
On 06/03/2017 05:13 AM, Mickaël Salaün wrote:
> Hi Shuah,
>
> On 02/06/2017 21:31, Shuah Khan wrote:
>> Hi Mickaël,
>>
>> On 05/26/2017 12:43 PM, Mickaël Salaün wrote:
>>> Rebuild the seccomp tests when kselftest_harness.h is updated.
>>>
>>> Signed-off-by: Mickaël Salaün <mic@digikod.net>
>>> Acked-by: Kees Cook <keescook@chromium.org>
>>> Cc: Andy Lutomirski <luto@amacapital.net>
>>> Cc: Shuah Khan <shuah@kernel.org>
>>> Cc: Will Drewry <wad@chromium.org>
>>> ---
>>> tools/testing/selftests/seccomp/Makefile | 2 ++
>>> 1 file changed, 2 insertions(+)
>>>
>>> diff --git a/tools/testing/selftests/seccomp/Makefile b/tools/testing/selftests/seccomp/Makefile
>>> index 5fa6fd2246b1..aeb0c805f3ca 100644
>>> --- a/tools/testing/selftests/seccomp/Makefile
>>> +++ b/tools/testing/selftests/seccomp/Makefile
>>> @@ -4,3 +4,5 @@ LDFLAGS += -lpthread
>>>
>>> include ../lib.mk
>>>
>>> +$(TEST_GEN_PROGS): seccomp_bpf.c ../kselftest_harness.h
>>> + $(CC) $(CFLAGS) $(LDFLAGS) $< -o $@
>>>
>>
>> This change breaks seccomp build:
>>
>> make -C tools/testing/selftests/seccomp/
>> make: Entering directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
>> make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
>> make: Leaving directory '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp'
>> shuah@mazurka:/mnt/data/lkml/linux_4.12$ cd tools/testing/selftests/seccomp/
>> shuah@mazurka:/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp$ make
>> make: *** No rule to make target '../kselftest_harness.h', needed by '/mnt/data/lkml/linux_4.12/tools/testing/selftests/seccomp/seccomp_bpf'. Stop.
>>
>>
>> Did you happen to try building with this change?
>
> Yes I did, and it builds fine for me (with the same command and
> patches). There is only one warning from GCC with
> ../kselftest_harness.h:368 because of the trick from OPTIONAL_HANDLER(),
> which is intentional (and not modified by my patches).
>
> I don't get why your "make" said that there is "No rule to make target"
> ../kselftest_harness.h . This file exists (patch 1/7) so there is no
> need to create it…
> gen_kselftest_tar.sh works fine too.
>
I think I know what's going on here. It is my bad. Never mind, we are good.
I will apply this patch to linux-kselftest next.
thanks,
-- Shuah
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 801 bytes --]
^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation
2017-06-03 11:17 ` Mickaël Salaün
@ 2017-06-05 18:20 ` Shuah Khan
0 siblings, 0 replies; 18+ messages in thread
From: Shuah Khan @ 2017-06-05 18:20 UTC (permalink / raw)
To: Mickaël Salaün, linux-kernel
Cc: Andy Lutomirski, Jonathan Corbet, Kees Cook, Will Drewry,
linux-doc, linux-kselftest, Shuah Khan, Shuah Khan
[-- Attachment #1.1: Type: text/plain, Size: 22140 bytes --]
On 06/03/2017 05:17 AM, Mickaël Salaün wrote:
>
> On 02/06/2017 22:02, Shuah Khan wrote:
>> Hi Mickaël,
>>
>> On 05/26/2017 12:44 PM, Mickaël Salaün wrote:
>>> Add ReST metadata to kselftest_harness.h to be able to include the
>>> comments in the Sphinx documentation.
>>>
>>
>> These don't belong the change log. These types of changes are for
>> reviewers benefit and should be added between the sign-of block
>> and the start of diff.
>
> OK, I didn't know this rule, which seems different from one maintainer
> to another. I'll take this into account the next time.
It is a standard practice. Not just mine. If there is any information
from these version to version differences that belong in the changelog,
they need to be in the changelog format.
>
>>
>> I had to fix a few patches in this series before commit.
>>
>>> Changes since v4:
>>> * exclude the TEST_API() changes (requested by Kees Cook)
>>>
>>> Changes since v3:
>>> * document macros as actual functions (suggested by Jonathan Corbet)
>>> * remove the TEST_API() wrapper to expose the underlying macro arguments
>>> to the documentation tools
>>> * move and cleanup comments
>>>
>>> Changes since v2:
>>> * add reference to the full documentation in the header file (suggested
>>> by Kees Cook)
>>
>>>
>>> Signed-off-by: Mickaël Salaün <mic@digikod.net>
>>> Cc: Andy Lutomirski <luto@amacapital.net>
>>> Cc: Jonathan Corbet <corbet@lwn.net>
>>> Cc: Kees Cook <keescook@chromium.org>
>>> Cc: Shuah Khan <shuah@kernel.org>
>>> Cc: Will Drewry <wad@chromium.org>
>>
>> git am isn't happy:
>>
>> Applying: Documentation/dev-tools: Add kselftest_harness documentation
>> .git/rebase-apply/patch:47: new blank line at EOF.
>> +
>> warning: 1 line adds whitespace errors.
>>
>> Please fix and resend.
>
> I didn't try to apply the series with "git am" since neither "git
> format-patch" nor scripts/checkpatch.pl output a warning.
>
> This "git am" warning is about the last line of the ReST file which end
> with an empty line. I will fix it if needed.
Yeah that is what it is complaining about. Checkpatch didn't complain.
Fix it and resend. I don't like git am complaining about patches. :)
-- Shuah
>
>>
>> -- Shuah
>>
>>> ---
>>> Documentation/dev-tools/kselftest.rst | 34 +++
>>> tools/testing/selftests/kselftest_harness.h | 415 ++++++++++++++++++++++------
>>> 2 files changed, 364 insertions(+), 85 deletions(-)
>>>
>>> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
>>> index 9232ce94612c..a92fa181b6cf 100644
>>> --- a/Documentation/dev-tools/kselftest.rst
>>> +++ b/Documentation/dev-tools/kselftest.rst
>>> @@ -120,3 +120,37 @@ Contributing new tests (details)
>>> executable which is not tested by default.
>>> TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
>>> test.
>>> +
>>> +Test Harness
>>> +============
>>> +
>>> +The kselftest_harness.h file contains useful helpers to build tests. The tests
>>> +from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as example.
>>> +
>>> +Example
>>> +-------
>>> +
>>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>>> + :doc: example
>>> +
>>> +
>>> +Helpers
>>> +-------
>>> +
>>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>>> + :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
>>> + FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN
>>> +
>>> +Operators
>>> +---------
>>> +
>>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>>> + :doc: operators
>>> +
>>> +.. kernel-doc:: tools/testing/selftests/kselftest_harness.h
>>> + :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
>>> + ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
>>> + ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
>>> + EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
>>> + EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
>>> +
>>> diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h
>>> index 45f807ce37e1..c56f72e07cd7 100644
>>> --- a/tools/testing/selftests/kselftest_harness.h
>>> +++ b/tools/testing/selftests/kselftest_harness.h
>>> @@ -4,41 +4,49 @@
>>> *
>>> * kselftest_harness.h: simple C unit test helper.
>>> *
>>> - * Usage:
>>> - * #include "../kselftest_harness.h"
>>> - * TEST(standalone_test) {
>>> - * do_some_stuff;
>>> - * EXPECT_GT(10, stuff) {
>>> - * stuff_state_t state;
>>> - * enumerate_stuff_state(&state);
>>> - * TH_LOG("expectation failed with state: %s", state.msg);
>>> - * }
>>> - * more_stuff;
>>> - * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
>>> - * last_stuff;
>>> - * EXPECT_EQ(0, last_stuff);
>>> - * }
>>> - *
>>> - * FIXTURE(my_fixture) {
>>> - * mytype_t *data;
>>> - * int awesomeness_level;
>>> - * };
>>> - * FIXTURE_SETUP(my_fixture) {
>>> - * self->data = mytype_new();
>>> - * ASSERT_NE(NULL, self->data);
>>> - * }
>>> - * FIXTURE_TEARDOWN(my_fixture) {
>>> - * mytype_free(self->data);
>>> - * }
>>> - * TEST_F(my_fixture, data_is_good) {
>>> - * EXPECT_EQ(1, is_my_data_good(self->data));
>>> - * }
>>> - *
>>> - * TEST_HARNESS_MAIN
>>> + * See documentation in Documentation/dev-tools/kselftest.rst
>>> *
>>> * API inspired by code.google.com/p/googletest
>>> */
>>>
>>> +/**
>>> + * DOC: example
>>> + *
>>> + * .. code-block:: c
>>> + *
>>> + * #include "../kselftest_harness.h"
>>> + *
>>> + * TEST(standalone_test) {
>>> + * do_some_stuff;
>>> + * EXPECT_GT(10, stuff) {
>>> + * stuff_state_t state;
>>> + * enumerate_stuff_state(&state);
>>> + * TH_LOG("expectation failed with state: %s", state.msg);
>>> + * }
>>> + * more_stuff;
>>> + * ASSERT_NE(some_stuff, NULL) TH_LOG("how did it happen?!");
>>> + * last_stuff;
>>> + * EXPECT_EQ(0, last_stuff);
>>> + * }
>>> + *
>>> + * FIXTURE(my_fixture) {
>>> + * mytype_t *data;
>>> + * int awesomeness_level;
>>> + * };
>>> + * FIXTURE_SETUP(my_fixture) {
>>> + * self->data = mytype_new();
>>> + * ASSERT_NE(NULL, self->data);
>>> + * }
>>> + * FIXTURE_TEARDOWN(my_fixture) {
>>> + * mytype_free(self->data);
>>> + * }
>>> + * TEST_F(my_fixture, data_is_good) {
>>> + * EXPECT_EQ(1, is_my_data_good(self->data));
>>> + * }
>>> + *
>>> + * TEST_HARNESS_MAIN
>>> + */
>>> +
>>> #ifndef __KSELFTEST_HARNESS_H
>>> #define __KSELFTEST_HARNESS_H
>>>
>>> @@ -61,10 +69,20 @@
>>> # define TH_LOG_ENABLED 1
>>> #endif
>>>
>>> -/* TH_LOG(format, ...)
>>> +/**
>>> + * TH_LOG(fmt, ...)
>>> + *
>>> + * @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.
>>> */
>>> #define TH_LOG(fmt, ...) do { \
>>> @@ -77,7 +95,16 @@
>>> fprintf(TH_LOG_STREAM, "%s:%d:%s:" fmt "\n", \
>>> __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
>>>
>>> -/* TEST(name) { implementation }
>>> +/**
>>> + * TEST(test_name) - 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
>>> @@ -85,10 +112,18 @@
>>> *
>>> * EXPECT_* and ASSERT_* are valid in a TEST() { } context.
>>> */
>>> -/* Defines the test function and creates the registration stub. */
>>> #define TEST(test_name) __TEST_IMPL(test_name, -1)
>>>
>>> -/* TEST_SIGNAL(name, signal) { implementation }
>>> +/**
>>> + * TEST_SIGNAL(test_name, 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
>>> @@ -110,22 +145,38 @@
>>> static void test_name( \
>>> struct __test_metadata __attribute__((unused)) *_metadata)
>>>
>>> -/* FIXTURE_DATA(datatype name)
>>> +/**
>>> + * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less
>>> + * argument to pass around
>>> + *
>>> + * @datatype_name: datatype name
>>> + *
>>> + * .. code-block:: c
>>> + *
>>> + * FIXTURE_DATA(datatype name)
>>> + *
>>> * 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.
>>> + * the *self* is being passed to a helper directly.
>>> */
>>> -/* Wraps the struct name so we have one less argument to pass around. */
>>> #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name
>>>
>>> -/* FIXTURE(datatype 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.
>>> +/**
>>> + * FIXTURE(fixture_name) - Called once per fixture to setup the data and
>>> + * register
>>> + *
>>> + * @fixture_name: fixture name
>>> + *
>>> + * .. code-block:: c
>>> + *
>>> + * FIXTURE(datatype 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().
>>> */
>>> -/* Called once per fixture to setup the data and register. */
>>> #define FIXTURE(fixture_name) \
>>> static void __attribute__((constructor)) \
>>> _register_##fixture_name##_data(void) \
>>> @@ -134,9 +185,18 @@
>>> } \
>>> FIXTURE_DATA(fixture_name)
>>>
>>> -/* FIXTURE_SETUP(fixture name) { implementation }
>>> +/**
>>> + * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture.
>>> + * *_metadata* is included so that ASSERT_* work as a convenience
>>> + *
>>> + * @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
>>> + * 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
>>> @@ -144,16 +204,21 @@
>>> *
>>> * A bare "return;" statement may be used to return early.
>>> */
>>> -/* Prepares the setup function for the fixture. |_metadata| is included
>>> - * so that ASSERT_* work as a convenience.
>>> - */
>>> #define FIXTURE_SETUP(fixture_name) \
>>> void fixture_name##_setup( \
>>> struct __test_metadata __attribute__((unused)) *_metadata, \
>>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>>> -/* FIXTURE_TEARDOWN(fixture name) { implementation }
>>> +/**
>>> + * FIXTURE_TEARDOWN(fixture_name)
>>> + *
>>> + * @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
>>> + * 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.
>>> @@ -163,15 +228,22 @@
>>> struct __test_metadata __attribute__((unused)) *_metadata, \
>>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>>>
>>> -/* TEST_F(fixture, name) { implementation }
>>> +/**
>>> + * TEST_F(fixture_name, test_name) - 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
>>> + * Very similar to TEST() except that *self* is the setup instance of fixture's
>>> * datatype exposed for use by the implementation.
>>> */
>>> -/* Emits test registration and helpers for fixture-based test
>>> - * cases.
>>> - * TODO(wad) register fixtures on dedicated test lists.
>>> - */
>>> +/* TODO(wad) register fixtures on dedicated test lists. */
>>> #define TEST_F(fixture_name, test_name) \
>>> __TEST_F_IMPL(fixture_name, test_name, -1)
>>>
>>> @@ -210,10 +282,15 @@
>>> struct __test_metadata __attribute__((unused)) *_metadata, \
>>> FIXTURE_DATA(fixture_name) __attribute__((unused)) *self)
>>>
>>> -/* Use once to append a main() to the test file. E.g.,
>>> - * TEST_HARNESS_MAIN
>>> +/**
>>> + * TEST_HARNESS_MAIN - Simple wrapper to run the test harness
>>> + *
>>> + * .. code-block:: c
>>> + *
>>> + * TEST_HARNESS_MAIN
>>> + *
>>> + * Use once to append a main() to the test file.
>>> */
>>> -/* Exports a simple wrapper to run the test harness. */
>>> #define TEST_HARNESS_MAIN \
>>> static void __attribute__((constructor)) \
>>> __constructor_order_last(void) \
>>> @@ -225,79 +302,247 @@
>>> return test_harness_run(argc, argv); \
>>> }
>>>
>>> -/*
>>> - * Operators for use in TEST and TEST_F.
>>> +/**
>>> + * DOC: operators
>>> + *
>>> + * Operators for use in TEST() and TEST_F().
>>> * ASSERT_* calls will stop test execution immediately.
>>> * EXPECT_* calls will emit a failure warning, note it, and continue.
>>> */
>>> -/* ASSERT_EQ(expected, measured): expected == measured */
>>> +
>>> +/**
>>> + * ASSERT_EQ(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_EQ(expected, measured): expected == measured
>>> + */
>>> #define ASSERT_EQ(expected, seen) \
>>> __EXPECT(expected, seen, ==, 1)
>>> -/* ASSERT_NE(expected, measured): expected != measured */
>>> +
>>> +/**
>>> + * ASSERT_NE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_NE(expected, measured): expected != measured
>>> + */
>>> #define ASSERT_NE(expected, seen) \
>>> __EXPECT(expected, seen, !=, 1)
>>> -/* ASSERT_LT(expected, measured): expected < measured */
>>> +
>>> +/**
>>> + * ASSERT_LT(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_LT(expected, measured): expected < measured
>>> + */
>>> #define ASSERT_LT(expected, seen) \
>>> __EXPECT(expected, seen, <, 1)
>>> -/* ASSERT_LE(expected, measured): expected <= measured */
>>> +
>>> +/**
>>> + * ASSERT_LE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_LE(expected, measured): expected <= measured
>>> + */
>>> #define ASSERT_LE(expected, seen) \
>>> __EXPECT(expected, seen, <=, 1)
>>> -/* ASSERT_GT(expected, measured): expected > measured */
>>> +
>>> +/**
>>> + * ASSERT_GT(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_GT(expected, measured): expected > measured
>>> + */
>>> #define ASSERT_GT(expected, seen) \
>>> __EXPECT(expected, seen, >, 1)
>>> -/* ASSERT_GE(expected, measured): expected >= measured */
>>> +
>>> +/**
>>> + * ASSERT_GE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_GE(expected, measured): expected >= measured
>>> + */
>>> #define ASSERT_GE(expected, seen) \
>>> __EXPECT(expected, seen, >=, 1)
>>> -/* ASSERT_NULL(measured): NULL == measured */
>>> +
>>> +/**
>>> + * ASSERT_NULL(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_NULL(measured): NULL == measured
>>> + */
>>> #define ASSERT_NULL(seen) \
>>> __EXPECT(NULL, seen, ==, 1)
>>>
>>> -/* ASSERT_TRUE(measured): measured != 0 */
>>> +/**
>>> + * ASSERT_TRUE(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_TRUE(measured): measured != 0
>>> + */
>>> #define ASSERT_TRUE(seen) \
>>> ASSERT_NE(0, seen)
>>> -/* ASSERT_FALSE(measured): measured == 0 */
>>> +
>>> +/**
>>> + * ASSERT_FALSE(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_FALSE(measured): measured == 0
>>> + */
>>> #define ASSERT_FALSE(seen) \
>>> ASSERT_EQ(0, seen)
>>> -/* ASSERT_STREQ(expected, measured): !strcmp(expected, measured) */
>>> +
>>> +/**
>>> + * ASSERT_STREQ(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_STREQ(expected, measured): !strcmp(expected, measured)
>>> + */
>>> #define ASSERT_STREQ(expected, seen) \
>>> __EXPECT_STR(expected, seen, ==, 1)
>>> -/* ASSERT_STRNE(expected, measured): strcmp(expected, measured) */
>>> +
>>> +/**
>>> + * ASSERT_STRNE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * ASSERT_STRNE(expected, measured): strcmp(expected, measured)
>>> + */
>>> #define ASSERT_STRNE(expected, seen) \
>>> __EXPECT_STR(expected, seen, !=, 1)
>>>
>>> -/* EXPECT_EQ(expected, measured): expected == measured */
>>> +/**
>>> + * EXPECT_EQ(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_EQ(expected, measured): expected == measured
>>> + */
>>> #define EXPECT_EQ(expected, seen) \
>>> __EXPECT(expected, seen, ==, 0)
>>> -/* EXPECT_NE(expected, measured): expected != measured */
>>> +
>>> +/**
>>> + * EXPECT_NE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_NE(expected, measured): expected != measured
>>> + */
>>> #define EXPECT_NE(expected, seen) \
>>> __EXPECT(expected, seen, !=, 0)
>>> -/* EXPECT_LT(expected, measured): expected < measured */
>>> +
>>> +/**
>>> + * EXPECT_LT(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_LT(expected, measured): expected < measured
>>> + */
>>> #define EXPECT_LT(expected, seen) \
>>> __EXPECT(expected, seen, <, 0)
>>> -/* EXPECT_LE(expected, measured): expected <= measured */
>>> +
>>> +/**
>>> + * EXPECT_LE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_LE(expected, measured): expected <= measured
>>> + */
>>> #define EXPECT_LE(expected, seen) \
>>> __EXPECT(expected, seen, <=, 0)
>>> -/* EXPECT_GT(expected, measured): expected > measured */
>>> +
>>> +/**
>>> + * EXPECT_GT(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_GT(expected, measured): expected > measured
>>> + */
>>> #define EXPECT_GT(expected, seen) \
>>> __EXPECT(expected, seen, >, 0)
>>> -/* EXPECT_GE(expected, measured): expected >= measured */
>>> +
>>> +/**
>>> + * EXPECT_GE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_GE(expected, measured): expected >= measured
>>> + */
>>> #define EXPECT_GE(expected, seen) \
>>> __EXPECT(expected, seen, >=, 0)
>>>
>>> -/* EXPECT_NULL(measured): NULL == measured */
>>> +/**
>>> + * EXPECT_NULL(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_NULL(measured): NULL == measured
>>> + */
>>> #define EXPECT_NULL(seen) \
>>> __EXPECT(NULL, seen, ==, 0)
>>> -/* EXPECT_TRUE(measured): 0 != measured */
>>> +
>>> +/**
>>> + * EXPECT_TRUE(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_TRUE(measured): 0 != measured
>>> + */
>>> #define EXPECT_TRUE(seen) \
>>> EXPECT_NE(0, seen)
>>> -/* EXPECT_FALSE(measured): 0 == measured */
>>> +
>>> +/**
>>> + * EXPECT_FALSE(seen)
>>> + *
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_FALSE(measured): 0 == measured
>>> + */
>>> #define EXPECT_FALSE(seen) \
>>> EXPECT_EQ(0, seen)
>>>
>>> -/* EXPECT_STREQ(expected, measured): !strcmp(expected, measured) */
>>> +/**
>>> + * EXPECT_STREQ(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_STREQ(expected, measured): !strcmp(expected, measured)
>>> + */
>>> #define EXPECT_STREQ(expected, seen) \
>>> __EXPECT_STR(expected, seen, ==, 0)
>>> -/* EXPECT_STRNE(expected, measured): strcmp(expected, measured) */
>>> +
>>> +/**
>>> + * EXPECT_STRNE(expected, seen)
>>> + *
>>> + * @expected: expected value
>>> + * @seen: measured value
>>> + *
>>> + * EXPECT_STRNE(expected, measured): strcmp(expected, measured)
>>> + */
>>> #define EXPECT_STRNE(expected, seen) \
>>> __EXPECT_STR(expected, seen, !=, 0)
>>>
>>>
>>
>>
>
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 801 bytes --]
^ permalink raw reply [flat|nested] 18+ messages in thread
end of thread, other threads:[~2017-06-05 18:20 UTC | newest]
Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-26 18:43 [PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 1/7] selftests: Make test_harness.h more generally available Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 2/7] selftests: Cosmetic renames in kselftest_harness.h Mickaël Salaün
2017-05-26 18:43 ` [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies Mickaël Salaün
2017-06-02 19:31 ` Shuah Khan
2017-06-03 11:13 ` Mickaël Salaün
2017-06-05 18:17 ` Shuah Khan
2017-05-26 18:43 ` [PATCH v5 4/7] Documentation/dev-tools: Add kselftest Mickaël Salaün
2017-05-26 18:44 ` [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest Mickaël Salaün
2017-05-26 18:44 ` [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Mickaël Salaün
2017-05-26 19:07 ` Kees Cook
2017-05-26 18:44 ` [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün
2017-05-26 19:08 ` Kees Cook
2017-06-02 20:02 ` Shuah Khan
2017-06-03 11:17 ` Mickaël Salaün
2017-06-05 18:20 ` Shuah Khan
2017-05-26 19:09 ` [PATCH v5 0/7] Add kselftest_harness.h Kees Cook
2017-05-30 21:31 ` Shuah Khan
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).