| Message ID | 1579805221-31905-4-git-send-email-alan.maguire@oracle.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | kunit: add debugfs representation to show results/run tests | expand |
On Thu, Jan 23, 2020 at 10:47 AM Alan Maguire <alan.maguire@oracle.com> wrote: > > Documentation should describe debugfs layout and semantics. > > Signed-off-by: Alan Maguire <alan.maguire@oracle.com> > --- > Documentation/dev-tools/kunit/usage.rst | 19 +++++++++++++++++++ > 1 file changed, 19 insertions(+) > > diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst > index 7cd56a1..b05c843 100644 > --- a/Documentation/dev-tools/kunit/usage.rst > +++ b/Documentation/dev-tools/kunit/usage.rst > @@ -590,3 +590,22 @@ able to run one test case per invocation. > > .. TODO(brendanhiggins@google.com): Add an actual example of an architecture > dependent KUnit test. > + > +KUnit debugfs representation > +============================ > +When kunit test suites are initialized, they create an associated directory > +in /sys/kernel/debug/kunit/<test-suite>. The directory contains two files > + > +- results: "cat results" displays results of last test run > +- run: "cat run" runs the test suite and displays the results > + > +Thus to re-run all currently loaded suites and display results, we can do this: > + > +``` > +$ cat /sys/kernel/debug/kunit/*/run > +``` This should be in a ".. code-block:: bash", see above in this file for an example. > + > +The debugfs representation is primarily of use when kunit test suites are > +run in a native environment, either as modules or builtin. Having a way > +to display results like this is valuable as otherwise results can be > +intermixed with other events in dmesg output. > -- > 1.8.3.1 >
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst index 7cd56a1..b05c843 100644 --- a/Documentation/dev-tools/kunit/usage.rst +++ b/Documentation/dev-tools/kunit/usage.rst @@ -590,3 +590,22 @@ able to run one test case per invocation. .. TODO(brendanhiggins@google.com): Add an actual example of an architecture dependent KUnit test. + +KUnit debugfs representation +============================ +When kunit test suites are initialized, they create an associated directory +in /sys/kernel/debug/kunit/<test-suite>. The directory contains two files + +- results: "cat results" displays results of last test run +- run: "cat run" runs the test suite and displays the results + +Thus to re-run all currently loaded suites and display results, we can do this: + +``` +$ cat /sys/kernel/debug/kunit/*/run +``` + +The debugfs representation is primarily of use when kunit test suites are +run in a native environment, either as modules or builtin. Having a way +to display results like this is valuable as otherwise results can be +intermixed with other events in dmesg output.
Documentation should describe debugfs layout and semantics. Signed-off-by: Alan Maguire <alan.maguire@oracle.com> --- Documentation/dev-tools/kunit/usage.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)