.. _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 119 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/api_fuzz_test.c#L119>`_

Implementation: ``test_api_fuzz_command_fn``


test api internal
-------------------------------------------------------------------------

.. code-block:: console

    test internal api client


Declaration: ``test_api_command`` `src/plugins/unittest/api_test.c line 98 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/api_test.c#L98>`_

Implementation: ``test_api_test_command_fn``


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

.. code-block:: console

    bier unit tests


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

Implementation: ``bier_test``


test bihash
-------------------------------------------------------------------------

.. code-block:: console

    test bihash


Declaration: ``test_bihash_command`` `src/plugins/unittest/bihash_test.c line 558 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/bihash_test.c#L558>`_

Implementation: ``test_bihash_command_fn``


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

.. code-block:: console

    Coverage test for bitmap.h


Declaration: ``test_bitmap_command`` `src/plugins/unittest/bitmap_test.c line 214 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/bitmap_test.c#L214>`_

Implementation: ``test_bitmap_command_fn``


test buffer scalar-frame-enqueue
-------------------------------------------------------------------------

.. code-block:: console

    test buffer scalar-frame-enqueue


Declaration: ``test_buffer_scalar_frame_command`` `src/plugins/unittest/test_buffer.c line 152 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/test_buffer.c#L152>`_

Implementation: ``test_buffer_scalar_frame_fn``


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

.. code-block:: console

    test chained-buffer-linearization


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

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 430 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/test_buffer.c#L430>`_

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 214 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/counter_test.c#L214>`_

Implementation: ``test_counter_command_fn``


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

.. code-block:: console

    crash the bus!


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

Implementation: ``test_crash_command_fn``


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

.. code-block:: console

    test crypto [quiet|verbose] [async [engine <name>]] [perf <alg>]


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

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 265 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/vlib_test.c#L265>`_

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 442 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/gso_test.c#L442>`_

Implementation: ``test_gso_command_fn``


test hash
-------------------------------------------------------------------------

.. code-block:: console

    test hash [perf <hash-name>] [buffers <n>] [rounds <n>] [warmup-rounds <n>]


Declaration: ``test_hash_command`` `src/plugins/unittest/hash_test.c line 318 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/hash_test.c#L318>`_

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 50 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/interface_test.c#L50>`_

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 370 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ipsec_test.c#L370>`_

Implementation: ``test_ipsec_command_fn``


test ipsec_spd_outbound_perf
-------------------------------------------------------------------------

.. code-block:: console

    test ipsec_spd_outbound_perf flows <n_flows>


Declaration: ``test_ipsec_spd_perf_command`` `src/plugins/unittest/ipsec_test.c line 364 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ipsec_test.c#L364>`_

Implementation: ``test_ipsec_spd_outbound_perf_command_fn``


test l2fib invalidate
-------------------------------------------------------------------------

.. code-block:: console

    test l2fib invalidate <interface>


Declaration: ``test_l2fib_invalidate_cli`` `src/plugins/unittest/l2fib_test.c line 32 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/l2fib_test.c#L32>`_

Implementation: ``test_l2fib_invalidate``


test link-speed
-------------------------------------------------------------------------

.. code-block:: console

    test link-speed


Declaration: ``test_link_speed_command`` `src/plugins/unittest/link_speed_test.c line 200 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/link_speed_test.c#L200>`_

Implementation: ``test_link_speed_command_fn``


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

.. code-block:: console

    internal llist unit tests


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

Implementation: ``llist_test``


test mem-leak
-------------------------------------------------------------------------

.. code-block:: console

    leak some memory


Declaration: ``test_mem_leak_command`` `src/plugins/unittest/util_test.c line 118 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/util_test.c#L118>`_

Implementation: ``test_mem_leak_command_fn``


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

.. code-block:: console

    internal membulk unit tests


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

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 52 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/policer_test.c#L52>`_

Implementation: ``policer_test``


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

.. code-block:: console

    vppinfra pool.h tests


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

Implementation: ``test_pool_command_fn``


test pool-cache
-------------------------------------------------------------------------

.. code-block:: console

    vlib pool cache multi-worker test


Declaration: ``test_multi_worker_pool_command`` `src/plugins/unittest/pool_cache_test.c line 873 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/pool_cache_test.c#L873>`_

Implementation: ``test_multi_worker_pool_command_fn``


test pool-cache cli
-------------------------------------------------------------------------

.. code-block:: console

    test pool-cache cli init [log2-subpool-size <n>] [cache-batch-size <n>] [alloc <n>] | alloc [n] | free [n] | free-all | cleanup | status


Declaration: ``test_pool_cache_cli_command`` `src/plugins/unittest/pool_cache_test.c line 972 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/pool_cache_test.c#L972>`_

Implementation: ``test_pool_cache_cli_command_fn``


test pool-cache-perf
-------------------------------------------------------------------------

.. code-block:: console

    test pool-cache-perf [mode local|refill|contended|growth|all] [rounds <n>] [batch-size <n>] [cache-batch-size <n>] [warmup-rounds <n>] [samples <n>] [log2-subpool-size <n>] [csv <filename>]


Declaration: ``pool_cache_perf_command`` `src/plugins/unittest/pool_cache_perf_test.c line 675 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/pool_cache_perf_test.c#L675>`_

Implementation: ``pool_cache_perf_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 371 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/punt_test.c#L371>`_

Implementation: ``punt_test``


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

.. code-block:: console

    internal rbtree unit tests


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

Implementation: ``rbtree_test``


test segment-manager
-------------------------------------------------------------------------

.. code-block:: console

    test segment manager [pressure_levels_1][pressure_level_2][alloc][fifo_ops][prealloc_hdrs][all]


Declaration: ``tcp_test_command`` `src/plugins/unittest/segment_manager_test.c line 780 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/segment_manager_test.c#L780>`_

Implementation: ``segment_manager_test``


test session
-------------------------------------------------------------------------

.. code-block:: console

    internal session unit tests


Declaration: ``session_test_command`` `src/plugins/unittest/session_test.c line 3391 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/session_test.c#L3391>`_

Implementation: ``session_test``


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

.. code-block:: console

    test sparse_vec


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

Implementation: ``test_sparse_vec_command_fn``


test stats histogram-clear
-------------------------------------------------------------------------

.. code-block:: console

    test stats histogram-clear <name>


Declaration: ``histogram_clear_command`` `src/plugins/unittest/histogram_test.c line 118 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/histogram_test.c#L118>`_

Implementation: ``histogram_clear_command_fn``


test stats histogram-gen
-------------------------------------------------------------------------

.. code-block:: console

    test stats histogram-gen <name> <count> <interval-usec> [min-exp] [num-bins]


Declaration: ``histogram_gen_command`` `src/plugins/unittest/histogram_test.c line 88 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/histogram_test.c#L88>`_

Implementation: ``histogram_gen_command_fn``


test stats ring-buffer-gen
-------------------------------------------------------------------------

.. code-block:: console

    test stats ring-buffer-gen <name> <count> <interval-usec> [ring-size]


Declaration: ``ring_buffer_gen_command`` `src/plugins/unittest/ring_buffer_test.c line 117 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ring_buffer_test.c#L117>`_

Implementation: ``ring_buffer_gen_command_fn``


test stats ring-buffer-show-schema
-------------------------------------------------------------------------

.. code-block:: console

    test stats ring-buffer-show-schema <name>


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

Implementation: ``ring_buffer_show_schema_command_fn``


test stats ring-buffer-test-schema
-------------------------------------------------------------------------

.. code-block:: console

    test stats ring-buffer-test-schema <name>


Declaration: ``ring_buffer_test_schema_command`` `src/plugins/unittest/ring_buffer_test.c line 241 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/ring_buffer_test.c#L241>`_

Implementation: ``ring_buffer_test_schema_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 1397 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/string_test.c#L1397>`_

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 3404 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/svm_fifo_test.c#L3404>`_

Implementation: ``svm_fifo_test``


test time
-------------------------------------------------------------------------

.. code-block:: console

    test time [monotonicity | discontinuity | small-discontinuity | accumulated-error | wall-step | virtual-offset | barrier | all]


Declaration: ``test_time_command`` `src/plugins/unittest/time_test.c line 471 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/time_test.c#L471>`_

Implementation: ``test_time_command_fn``


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

.. code-block:: console

    test time-range


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

Implementation: ``test_time_range_command_fn``


test udp
-------------------------------------------------------------------------

.. code-block:: console

    test udp [dst-port-tables|binds|all]


Declaration: ``udp_test_command`` `src/plugins/unittest/udp_test.c line 402 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/udp_test.c#L402>`_

Implementation: ``udp_test``


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

.. code-block:: console

    vlib code coverage unit test


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

Implementation: ``test_vlib_command_fn``


test vlib timing-wheel
-------------------------------------------------------------------------

.. code-block:: console

    test VLIB timing wheel accounting


Declaration: ``test_vlib_timing_wheel_command`` `src/plugins/unittest/vlib_test.c line 217 <https://github.com/FDio/vpp/blob/master//src/plugins/unittest/vlib_test.c#L217>`_

Implementation: ``test_vlib_timing_wheel_command_fn``


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

.. code-block:: console

    vlib code coverage unit test #2


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

Implementation: ``test_vlib2_command_fn``