:orphan:

.. index:: pair: group; Test
.. _doxid-group__te__ts__tapi__test:

Test
====

.. toctree::
	:hidden:

	group_tapi_env.rst
	group_te_ts_tapi_test_log.rst
	group_te_ts_tapi_test_misc.rst
	group_te_ts_tapi_test_param.rst
	group_te_ts_tapi_test_run_status.rst

Overview
~~~~~~~~



|	:ref:`Network environment<doxid-group__tapi__env>`
|	:ref:`Test execution flow<doxid-group__te__ts__tapi__test__log>`
|	:ref:`Test misc<doxid-group__te__ts__tapi__test__misc>`
|	:ref:`Test parameters<doxid-group__te__ts__tapi__test__param>`
|	:ref:`Test run status<doxid-group__te__ts__tapi__test__run__status>`



.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// macros

	#define :ref:`CLEANUP_TEST_FAIL<doxid-group__te__ts__tapi__test_1ga78cdc511fcf93d0e6d3c64ca6bd8ef43>`(fmt...)
	#define :ref:`TEST_BEHAVIOUR_DEF<doxid-group__te__ts__tapi__test_1gad45b5d6fb637568b08085c07152f3f4c>`
	#define :ref:`TEST_END<doxid-group__te__ts__tapi__test_1ga806749d46ee4a9acd0a9d9e416f80d98>`
	#define :ref:`TEST_END_SPECIFIC<doxid-group__te__ts__tapi__test_1ga284a6c22db44ada281550c6b6beba2c1>`
	#define :ref:`TEST_FAIL<doxid-group__te__ts__tapi__test_1ga793adbd44682fc1142cdd75b3579321d>`(fmt...)
	#define :ref:`TEST_ON_JMP_DO<doxid-group__te__ts__tapi__test_1gadbe2e23bc19b8383c8f331c3cf781ae6>`
	#define :target:`TEST_ON_JMP_DO_IF_FAILURE<doxid-group__te__ts__tapi__test_1gad3cbc0f09e0c740d81933312ffc7cc0e>`
	#define :target:`TEST_ON_JMP_DO_IF_SUCCESS<doxid-group__te__ts__tapi__test_1gaaad58adf607d1961c0904829a0958500>`
	#define :ref:`TEST_ON_JMP_DO_SPECIFIC<doxid-group__te__ts__tapi__test_1ga708cf1e7487ca3ea86828ade50846d36>`
	#define :ref:`TEST_SKIP<doxid-group__te__ts__tapi__test_1ga9da8f15ecfd097acc4b5a307cbd52df7>`(...)
	#define :ref:`TEST_START<doxid-group__te__ts__tapi__test_1ga06549ee78edde8ab8d888b504dc86728>`
	#define :ref:`TEST_START_SPECIFIC<doxid-group__te__ts__tapi__test_1ga106f7918149b46740422f65372c2b371>`
	#define :ref:`TEST_START_VARS<doxid-group__te__ts__tapi__test_1ga14d89dddc84e50e922723dcf865ca7ed>`
	#define :ref:`TEST_STOP<doxid-group__te__ts__tapi__test_1ga744eaa8089ee06ac7f4e0b96427f2108>`
	#define :ref:`TEST_SUCCESS<doxid-group__te__ts__tapi__test_1gaee1dc5ecf95c68bc90ba502679668096>`

.. _details-group__te__ts__tapi__test:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Macros
------

.. index:: pair: define; CLEANUP_TEST_FAIL
.. _doxid-group__te__ts__tapi__test_1ga78cdc511fcf93d0e6d3c64ca6bd8ef43:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define CLEANUP_TEST_FAIL(fmt...)

Set test termination status to failure, report an error. Should be used instead of TEST_FAIL in the cleanup section.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- fmt

		- error message format string with parameters

.. index:: pair: define; TEST_BEHAVIOUR_DEF
.. _doxid-group__te__ts__tapi__test_1gad45b5d6fb637568b08085c07152f3f4c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_BEHAVIOUR_DEF

Macro to add behaviour switches in code that does not call TEST_START. It should not exist yet it does

.. index:: pair: define; TEST_END
.. _doxid-group__te__ts__tapi__test_1ga806749d46ee4a9acd0a9d9e416f80d98:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_END

The last action of the test **main()** function.

To define test-specific action define TEST_END_SPECIFIC macro

.. index:: pair: define; TEST_END_SPECIFIC
.. _doxid-group__te__ts__tapi__test_1ga284a6c22db44ada281550c6b6beba2c1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_END_SPECIFIC

Define empty test end procedure if test does not care about it.

.. index:: pair: define; TEST_FAIL
.. _doxid-group__te__ts__tapi__test_1ga793adbd44682fc1142cdd75b3579321d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_FAIL(fmt...)

Terminate a test with failure status, report an error.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- fmt

		- error message format string with parameters

.. index:: pair: define; TEST_ON_JMP_DO
.. _doxid-group__te__ts__tapi__test_1gadbe2e23bc19b8383c8f331c3cf781ae6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_ON_JMP_DO

Template action to be done on jump in the test.

.. index:: pair: define; TEST_ON_JMP_DO_SPECIFIC
.. _doxid-group__te__ts__tapi__test_1ga708cf1e7487ca3ea86828ade50846d36:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_ON_JMP_DO_SPECIFIC

Template action to be done on jump in TEST_START_SPECIFIC.

.. index:: pair: define; TEST_SKIP
.. _doxid-group__te__ts__tapi__test_1ga9da8f15ecfd097acc4b5a307cbd52df7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_SKIP(...)

Terminate a test with skip status, optionally reporting the reason as a verdict.

.. index:: pair: define; TEST_START
.. _doxid-group__te__ts__tapi__test_1ga06549ee78edde8ab8d888b504dc86728:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_START

The first action of any test **main()** function.

Variable *rc* and *result* are defined.

**main()** must get *argc* and *argv* parameters.

To define a set of variables accessed in each test, you should define TEST_START_VARS macro as the list of additional variables To define test-specific action define TEST_START_SPECIFIC macro

.. index:: pair: define; TEST_START_SPECIFIC
.. _doxid-group__te__ts__tapi__test_1ga106f7918149b46740422f65372c2b371:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_START_SPECIFIC

Define empty test start procedure if test does not care about it.

.. index:: pair: define; TEST_START_VARS
.. _doxid-group__te__ts__tapi__test_1ga14d89dddc84e50e922723dcf865ca7ed:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_START_VARS

Define empty list of test-specific variables if test does not care about them.

.. index:: pair: define; TEST_STOP
.. _doxid-group__te__ts__tapi__test_1ga744eaa8089ee06ac7f4e0b96427f2108:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_STOP

Terminate a test with failure status. It is assumed that error is already reported.

.. index:: pair: define; TEST_SUCCESS
.. _doxid-group__te__ts__tapi__test_1gaee1dc5ecf95c68bc90ba502679668096:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_SUCCESS

Terminate a test with success status.