Documentation/dev-tools/kunit/running_tips.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ============================
   4 Tips For Running KUnit Tests
   5 ============================
   6
   7 Using ``kunit.py run`` ("kunit tool")
   8 =====================================
   9
  10 Running from any directory
  11 --------------------------
  12
  13 It can be handy to create a bash function like:
  14
  15 .. code-block:: bash
  16
  17         function run_kunit() {
  18           ( cd "$(git rev-parse --show-toplevel)" && ./tools/testing/kunit/kunit.py run $@ )
  19         }
  20
  21 .. note::
  22         Early versions of ``kunit.py`` (before 5.6) didn't work unless run from
  23         the kernel root, hence the use of a subshell and ``cd``.
  24
  25 Running a subset of tests
  26 -------------------------
  27
  28 ``kunit.py run`` accepts an optional glob argument to filter tests. The format
  29 is ``"<suite_glob>[.test_glob]"``.
  30
  31 Say that we wanted to run the sysctl tests, we could do so via:
  32
  33 .. code-block:: bash
  34
  35         $ echo -e 'CONFIG_KUNIT=y\nCONFIG_KUNIT_ALL_TESTS=y' > .kunit/.kunitconfig
  36         $ ./tools/testing/kunit/kunit.py run 'sysctl*'
  37
  38 We can filter down to just the "write" tests via:
  39
  40 .. code-block:: bash
  41
  42         $ echo -e 'CONFIG_KUNIT=y\nCONFIG_KUNIT_ALL_TESTS=y' > .kunit/.kunitconfig
  43         $ ./tools/testing/kunit/kunit.py run 'sysctl*.*write*'
  44
  45 We're paying the cost of building more tests than we need this way, but it's
  46 easier than fiddling with ``.kunitconfig`` files or commenting out
  47 ``kunit_suite``'s.
  48
  49 However, if we wanted to define a set of tests in a less ad hoc way, the next
  50 tip is useful.
  51
  52 Defining a set of tests
  53 -----------------------
  54
  55 ``kunit.py run`` (along with ``build``, and ``config``) supports a
  56 ``--kunitconfig`` flag. So if you have a set of tests that you want to run on a
  57 regular basis (especially if they have other dependencies), you can create a
  58 specific ``.kunitconfig`` for them.
  59
  60 E.g. kunit has one for its tests:
  61
  62 .. code-block:: bash
  63
  64         $ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit/.kunitconfig
  65
  66 Alternatively, if you're following the convention of naming your
  67 file ``.kunitconfig``, you can just pass in the dir, e.g.
  68
  69 .. code-block:: bash
  70
  71         $ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit
  72
  73 .. note::
  74         This is a relatively new feature (5.12+) so we don't have any
  75         conventions yet about on what files should be checked in versus just
  76         kept around locally. It's up to you and your maintainer to decide if a
  77         config is useful enough to submit (and therefore have to maintain).
  78
  79 .. note::
  80         Having ``.kunitconfig`` fragments in a parent and child directory is
  81         iffy. There's discussion about adding an "import" statement in these
  82         files to make it possible to have a top-level config run tests from all
  83         child directories. But that would mean ``.kunitconfig`` files are no
  84         longer just simple .config fragments.
  85
  86         One alternative would be to have kunit tool recursively combine configs
  87         automagically, but tests could theoretically depend on incompatible
  88         options, so handling that would be tricky.
  89
  90 Setting kernel commandline parameters
  91 -------------------------------------
  92
  93 You can use ``--kernel_args`` to pass arbitrary kernel arguments, e.g.
  94
  95 .. code-block:: bash
  96
  97         $ ./tools/testing/kunit/kunit.py run --kernel_args=param=42 --kernel_args=param2=false
  98
  99
 100 Generating code coverage reports under UML
 101 ------------------------------------------
 102
 103 .. note::
 104         TODO(brendanhiggins@google.com): There are various issues with UML and
 105         versions of gcc 7 and up. You're likely to run into missing ``.gcda``
 106         files or compile errors.
 107
 108 This is different from the "normal" way of getting coverage information that is
 109 documented in Documentation/dev-tools/gcov.rst.
 110
 111 Instead of enabling ``CONFIG_GCOV_KERNEL=y``, we can set these options:
 112
 113 .. code-block:: none
 114
 115         CONFIG_DEBUG_KERNEL=y
 116         CONFIG_DEBUG_INFO=y
 117         CONFIG_GCOV=y
 118
 119
 120 Putting it together into a copy-pastable sequence of commands:
 121
 122 .. code-block:: bash
 123
 124         # Append coverage options to the current config
 125         $ echo -e "CONFIG_DEBUG_KERNEL=y\nCONFIG_DEBUG_INFO=y\nCONFIG_GCOV=y" >> .kunit/.kunitconfig
 126         $ ./tools/testing/kunit/kunit.py run
 127         # Extract the coverage information from the build dir (.kunit/)
 128         $ lcov -t "my_kunit_tests" -o coverage.info -c -d .kunit/
 129
 130         # From here on, it's the same process as with CONFIG_GCOV_KERNEL=y
 131         # E.g. can generate an HTML report in a tmp dir like so:
 132         $ genhtml -o /tmp/coverage_html coverage.info
 133
 134
 135 If your installed version of gcc doesn't work, you can tweak the steps:
 136
 137 .. code-block:: bash
 138
 139         $ ./tools/testing/kunit/kunit.py run --make_options=CC=/usr/bin/gcc-6
 140         $ lcov -t "my_kunit_tests" -o coverage.info -c -d .kunit/ --gcov-tool=/usr/bin/gcov-6
 141
 142
 143 Running tests manually
 144 ======================
 145
 146 Running tests without using ``kunit.py run`` is also an important use case.
 147 Currently it's your only option if you want to test on architectures other than
 148 UML.
 149
 150 As running the tests under UML is fairly straightforward (configure and compile
 151 the kernel, run the ``./linux`` binary), this section will focus on testing
 152 non-UML architectures.
 153
 154
 155 Running built-in tests
 156 ----------------------
 157
 158 When setting tests to ``=y``, the tests will run as part of boot and print
 159 results to dmesg in TAP format. So you just need to add your tests to your
 160 ``.config``, build and boot your kernel as normal.
 161
 162 So if we compiled our kernel with:
 163
 164 .. code-block:: none
 165
 166         CONFIG_KUNIT=y
 167         CONFIG_KUNIT_EXAMPLE_TEST=y
 168
 169 Then we'd see output like this in dmesg signaling the test ran and passed:
 170
 171 .. code-block:: none
 172
 173         TAP version 14
 174         1..1
 175             # Subtest: example
 176             1..1
 177             # example_simple_test: initializing
 178             ok 1 - example_simple_test
 179         ok 1 - example
 180
 181 Running tests as modules
 182 ------------------------
 183
 184 Depending on the tests, you can build them as loadable modules.
 185
 186 For example, we'd change the config options from before to
 187
 188 .. code-block:: none
 189
 190         CONFIG_KUNIT=y
 191         CONFIG_KUNIT_EXAMPLE_TEST=m
 192
 193 Then after booting into our kernel, we can run the test via
 194
 195 .. code-block:: none
 196
 197         $ modprobe kunit-example-test
 198
 199 This will then cause it to print TAP output to stdout.
 200
 201 .. note::
 202         The ``modprobe`` will *not* have a non-zero exit code if any test
 203         failed (as of 5.13). But ``kunit.py parse`` would, see below.
 204
 205 .. note::
 206         You can set ``CONFIG_KUNIT=m`` as well, however, some features will not
 207         work and thus some tests might break. Ideally tests would specify they
 208         depend on ``KUNIT=y`` in their ``Kconfig``'s, but this is an edge case
 209         most test authors won't think about.
 210         As of 5.13, the only difference is that ``current->kunit_test`` will
 211         not exist.
 212
 213 Pretty-printing results
 214 -----------------------
 215
 216 You can use ``kunit.py parse`` to parse dmesg for test output and print out
 217 results in the same familiar format that ``kunit.py run`` does.
 218
 219 .. code-block:: bash
 220
 221         $ ./tools/testing/kunit/kunit.py parse /var/log/dmesg
 222
 223
 224 Retrieving per suite results
 225 ----------------------------
 226
 227 Regardless of how you're running your tests, you can enable
 228 ``CONFIG_KUNIT_DEBUGFS`` to expose per-suite TAP-formatted results:
 229
 230 .. code-block:: none
 231
 232         CONFIG_KUNIT=y
 233         CONFIG_KUNIT_EXAMPLE_TEST=m
 234         CONFIG_KUNIT_DEBUGFS=y
 235
 236 The results for each suite will be exposed under
 237 ``/sys/kernel/debug/kunit/<suite>/results``.
 238 So using our example config:
 239
 240 .. code-block:: bash
 241
 242         $ modprobe kunit-example-test > /dev/null
 243         $ cat /sys/kernel/debug/kunit/example/results
 244         ... <TAP output> ...
 245
 246         # After removing the module, the corresponding files will go away
 247         $ modprobe -r kunit-example-test
 248         $ cat /sys/kernel/debug/kunit/example/results
 249         /sys/kernel/debug/kunit/example/results: No such file or directory
 250
 251 Generating code coverage reports
 252 --------------------------------
 253
 254 See Documentation/dev-tools/gcov.rst for details on how to do this.
 255
 256 The only vaguely KUnit-specific advice here is that you probably want to build
 257 your tests as modules. That way you can isolate the coverage from tests from
 258 other code executed during boot, e.g.
 259
 260 .. code-block:: bash
 261
 262         # Reset coverage counters before running the test.
 263         $ echo 0 > /sys/kernel/debug/gcov/reset
 264         $ modprobe kunit-example-test