1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2018-2019 Intel Corporation. 3 4Running DPDK Unit Tests with Meson 5================================== 6 7This section describes how to run test cases with the DPDK meson build system. 8 9Steps to build and install DPDK using meson can be referred 10in :doc:`build-sdk-meson` 11 12Grouping of test cases 13---------------------- 14 15Test 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 23These tests can be run using the argument to ``meson test`` as 24``--suite project_name:label``. 25 26For example:: 27 28 $ meson test -C <build path> --suite DPDK:fast-tests 29 30If the ``<build path>`` is current working directory, 31the ``-C <build path>`` option can be skipped as below:: 32 33 $ meson test --suite DPDK:fast-tests 34 35The project name is optional so the following is equivalent to the previous 36command:: 37 38 $ meson test --suite fast-tests 39 40If desired, additional arguments can be passed to the test run via the meson 41``--test-args`` option. 42For example, tests will by default run on as many available cores as is needed 43for the test, starting with the lowest number core - generally core 0. 44To run the fast-tests suite using only cores 8 through 16, one can use:: 45 46 $ meson test --suite fast-tests --test-args="-l 8-16" 47 48The meson command to list all available tests:: 49 50 $ meson test --list 51 52Test cases are run serially by default for better stability. 53 54Arguments of ``test()`` that can be provided in meson.build are as below: 55 56* ``is_parallel`` is used to run test case either in parallel or non-parallel mode. 57* ``timeout`` is used to specify the timeout of test case. 58* ``args`` is used to specify test specific parameters (see note below). 59* ``env`` is used to specify test specific environment parameters. 60 61Note: the content of meson ``--test-args`` option and the content of ``args`` 62are appended when invoking the DPDK test binary. 63Because of this, it is recommended not to set any default coremask or memory 64configuration in per test ``args`` and rather let users select what best fits 65their environment. If a test can't run, then it should be skipped, as described 66below. 67 68 69Dealing with skipped test cases 70------------------------------- 71 72Some unit test cases have a dependency on external libraries, driver modules 73or config flags, without which the test cases cannot be run. Such test cases 74will be reported as skipped if they cannot run. To enable those test cases, 75the user should ensure the required dependencies are met. 76Below are a few possible causes why tests may be skipped: 77 78#. Optional external libraries are not found. 79#. Config flags for the dependent library are not enabled. 80#. Dependent driver modules are not installed on the system. 81#. Not enough processing cores. Some tests are skipped on machines with 2 or 4 cores. 82