.. _clicmd_src_plugins_unittest:

===============================================================
Unittest cli reference
===============================================================

test api fuzz
-------------------------------------------------------------------------

.. code-block:: console

    test api fuzz [disable][seed nnn]
               [fuzz-first nn][fuzz-cli-first nn][fuzz-cli-last nn]


Declaration: ``test_api_fuzz`` `src/plugins/unittest/api_fuzz_test.c line 130 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/api_fuzz_test.c#L130>`_

Implementation: ``test_api_fuzz_command_fn``


test bier
-------------------------------------------------------------------------

.. code-block:: console

    bier unit tests


Declaration: ``test_route_command`` `src/plugins/unittest/bier_test.c line 947 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/bier_test.c#L947>`_

Implementation: ``bier_test``


test bitmap
-------------------------------------------------------------------------

.. code-block:: console

    Coverage test for bitmap.h


Declaration: ``test_bihash_command`` `src/plugins/unittest/bitmap_test.c line 62 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/bitmap_test.c#L62>`_

Implementation: ``test_bitmap_command_fn``


test chained-buffer-linearization
-------------------------------------------------------------------------

.. code-block:: console

    test chained-buffer-linearization


Declaration: ``test_linearize_command`` `src/plugins/unittest/test_buffer.c line 266 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/test_buffer.c#L266>`_

Implementation: ``test_linearize_fn``


test chained-buffer-linearization speed
-------------------------------------------------------------------------

.. code-block:: console

    test chained-buffer-linearization speed


Declaration: ``test_linearize_speed_command`` `src/plugins/unittest/test_buffer.c line 315 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/test_buffer.c#L315>`_

Implementation: ``test_linearize_speed_fn``


test counter
-------------------------------------------------------------------------

.. code-block:: console

    test counter [simple | combined] expand


Declaration: ``test_counter_command`` `src/plugins/unittest/counter_test.c line 242 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/counter_test.c#L242>`_

Implementation: ``test_counter_command_fn``


test crash
-------------------------------------------------------------------------

.. code-block:: console

    crash the bus!


Declaration: ``test_crash_command`` `src/plugins/unittest/util_test.c line 41 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/util_test.c#L41>`_

Implementation: ``test_crash_command_fn``


test crypto
-------------------------------------------------------------------------

.. code-block:: console

    test crypto


Declaration: ``test_crypto_command`` `src/plugins/unittest/crypto_test.c line 1066 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/crypto_test.c#L1066>`_

Implementation: ``test_crypto_command_fn``


test format-vlib
-------------------------------------------------------------------------

.. code-block:: console

    vlib format code coverate unit test


Declaration: ``test_format_vlib_command`` `src/plugins/unittest/vlib_test.c line 184 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/vlib_test.c#L184>`_

Implementation: ``test_format_vlib_command_fn``


test gso
-------------------------------------------------------------------------

.. code-block:: console

    test gso [buffers <n>] [buffer-size <size>] [packet-size <size>] [gso-size <size>] [rounds <n>] [warmup-rounds <n>]


Declaration: ``test_gso_command`` `src/plugins/unittest/gso_test.c line 363 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/gso_test.c#L363>`_

Implementation: ``test_gso_command_fn``


test hash_memory
-------------------------------------------------------------------------

.. code-block:: console

    page boundary crossing test


Declaration: ``test_hash_command`` `src/plugins/unittest/util_test.c line 102 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/util_test.c#L102>`_

Implementation: ``test_hash_command_fn``


test interface link-state
-------------------------------------------------------------------------

.. code-block:: console

    test interface link-state <interface> [up] [down]


Declaration: ``test_interface_command`` `src/plugins/unittest/interface_test.c line 61 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/interface_test.c#L61>`_

Implementation: ``test_interface_command_fn``


test ipsec
-------------------------------------------------------------------------

.. code-block:: console

    test ipsec sa <ID> seq-num <VALUE>


Declaration: ``test_ipsec_command`` `src/plugins/unittest/ipsec_test.c line 62 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ipsec_test.c#L62>`_

Implementation: ``test_ipsec_command_fn``


test llist
-------------------------------------------------------------------------

.. code-block:: console

    internal llist unit tests


Declaration: ``llist_test_command`` `src/plugins/unittest/llist_test.c line 339 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/llist_test.c#L339>`_

Implementation: ``llist_test``


test membulk
-------------------------------------------------------------------------

.. code-block:: console

    internal membulk unit tests


Declaration: ``mem_bulk_test_command`` `src/plugins/unittest/mem_bulk_test.c line 133 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/mem_bulk_test.c#L133>`_

Implementation: ``mem_bulk_test``


test phc
-------------------------------------------------------------------------

.. code-block:: console

    test phc [buffers <n>] [buffer-size <size>] [rounds <n>] [warmup-rounds <n>]


Declaration: ``test_phc_command`` `src/plugins/unittest/ip_psh_cksum_test.c line 253 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ip_psh_cksum_test.c#L253>`_

Implementation: ``test_phc_command_fn``


test policing
-------------------------------------------------------------------------

.. code-block:: console

    policer unit test helper - DO NOT RUN ON A LIVE SYSTEM


Declaration: ``test_policer_command`` `src/plugins/unittest/policer_test.c line 61 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/policer_test.c#L61>`_

Implementation: ``policer_test``


test pool
-------------------------------------------------------------------------

.. code-block:: console

    vppinfra pool.h tests


Declaration: ``test_pool_command`` `src/plugins/unittest/pool_test.c line 58 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/pool_test.c#L58>`_

Implementation: ``test_pool_command_fn``


test punt
-------------------------------------------------------------------------

.. code-block:: console

    punt unit tests - DO NOT RUN ON A LIVE SYSTEM


Declaration: ``test_fib_command`` `src/plugins/unittest/punt_test.c line 386 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/punt_test.c#L386>`_

Implementation: ``punt_test``


test rbtree
-------------------------------------------------------------------------

.. code-block:: console

    internal rbtree unit tests


Declaration: ``rbtree_test_command`` `src/plugins/unittest/rbtree_test.c line 242 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/rbtree_test.c#L242>`_

Implementation: ``rbtree_test``


test sparse_vec
-------------------------------------------------------------------------

.. code-block:: console

    test sparse_vec


Declaration: ``test_sparse_vec_command`` `src/plugins/unittest/sparse_vec_test.c line 59 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/sparse_vec_test.c#L59>`_

Implementation: ``test_sparse_vec_command_fn``


test string
-------------------------------------------------------------------------

.. code-block:: console

    test string [memcpy_s | clib_memcpy | memset_s | clib_memset | memcmp_s | clib_memcmp | strcmp_s | clib_strcmp | strncmp_s | clib_strncmp | strcpy_s | strncpy_s | clib_strncpy | strcat_s | strncat_s | strtok_s |  clib_strtok | strnlen_s | clib_strnlen | strstr_s ]


Declaration: ``string_test_command`` `src/plugins/unittest/string_test.c line 1407 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/string_test.c#L1407>`_

Implementation: ``string_test_command_fn``


test svm fifo
-------------------------------------------------------------------------

.. code-block:: console

    internal svm fifo unit tests


Declaration: ``svm_fifo_test_command`` `src/plugins/unittest/svm_fifo_test.c line 2867 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/svm_fifo_test.c#L2867>`_

Implementation: ``svm_fifo_test``


test tcp
-------------------------------------------------------------------------

.. code-block:: console

    internal tcp unit tests


Declaration: ``tcp_test_command`` `src/plugins/unittest/tcp_test.c line 1600 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/tcp_test.c#L1600>`_

Implementation: ``tcp_test``


test time-range
-------------------------------------------------------------------------

.. code-block:: console

    test time-range


Declaration: ``test_time_range_command`` `src/plugins/unittest/mactime_test.c line 169 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/mactime_test.c#L169>`_

Implementation: ``test_time_range_command_fn``


test vlib
-------------------------------------------------------------------------

.. code-block:: console

    vlib code coverage unit test


Declaration: ``test_vlib_command`` `src/plugins/unittest/vlib_test.c line 133 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/vlib_test.c#L133>`_

Implementation: ``test_vlib_command_fn``


test vlib2
-------------------------------------------------------------------------

.. code-block:: console

    vlib code coverage unit test #2


Declaration: ``test_vlib2_command`` `src/plugins/unittest/vlib_test.c line 219 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/vlib_test.c#L219>`_

Implementation: ``test_vlib2_command_fn``