doc/guides/prog_guide/meson_ut.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018-2019 Intel Corporation.
   3
   4 Running DPDK Unit Tests with Meson
   5 ==================================
   6
   7 This section describes how to run test cases with the DPDK meson build system.
   8
   9 Steps to build and install DPDK using meson can be referred
  10 in :doc:`build-sdk-meson`
  11
  12 Grouping of test cases
  13 ----------------------
  14
  15 Test cases have been classified into four different groups.
  16
  17 * Fast tests.
  18 * Performance tests.
  19 * Driver tests.
  20 * Tests which produce lists of objects as output, and therefore that need
  21   manual checking.
  22
  23 These tests can be run using the argument to ``meson test`` as
  24 ``--suite project_name:label``.
  25
  26 For example::
  27
  28     $ meson test -C <build path> --suite DPDK:fast-tests
  29
  30 If the ``<build path>`` is current working directory,
  31 the ``-C <build path>`` option can be skipped as below::
  32
  33     $ meson test --suite DPDK:fast-tests
  34
  35 The project name is optional so the following is equivalent to the previous
  36 command::
  37
  38     $ meson test --suite fast-tests
  39
  40 The meson command to list all available tests::
  41
  42     $ meson test --list
  43
  44 Test cases are run serially by default for better stability.
  45
  46 Arguments of ``test()`` that can be provided in meson.build are as below:
  47
  48 * ``is_parallel`` is used to run test case either in parallel or non-parallel mode.
  49 * ``timeout`` is used to specify the timeout of test case.
  50 * ``args`` is used to specify test specific parameters.
  51 * ``env`` is used to specify test specific environment parameters.
  52
  53
  54 Dealing with skipped test cases
  55 -------------------------------
  56
  57 Some unit test cases have a dependency on external libraries, driver modules
  58 or config flags, without which the test cases cannot be run. Such test cases
  59 will be reported as skipped if they cannot run. To enable those test cases,
  60 the user should ensure the required dependencies are met.
  61 Below are a few possible causes why tests may be skipped:
  62
  63 #. Optional external libraries are not found.
  64 #. Config flags for the dependent library are not enabled.
  65 #. Dependent driver modules are not installed on the system.
  66 #. Not enough processing cores. Some tests are skipped on machines with 2 or 4 cores.