:orphan: .. index:: pair: group; Test misc .. _doxid-group__te__ts__tapi__test__misc: Test misc ========= .. toctree:: :hidden: Overview ~~~~~~~~ Miscellaneous definitions useful for test scenarios. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions void :ref:`te_test_sig_handler`(int signum); static unsigned int :ref:`test_sleep_scale`(void); // macros #define :ref:`CHECK_BUFS_EQUAL`(buf1_, buf2_, buf_len_) #define :target:`CHECK_LENGTH`(expr_, exp_length_) #define :ref:`CHECK_NOT_NULL`(expr_) #define :ref:`CHECK_RC`(expr_) #define :ref:`CHECK_RC_ARTIFACT`(expr_, artifact_...) #define :ref:`CHECK_RC_VERDICT`(expr_, verdict_...) #define :ref:`CLEANUP_CHECK_RC`(expr_) #define :ref:`FREE_AND_CLEAN`(ptr_) #define :ref:`MSLEEP`(_to_sleep) #define :ref:`SLEEP`(_to_sleep) #define :ref:`TAPI_WAIT_NETWORK` #define :ref:`TAPI_WAIT_NETWORK_DELAY` #define :ref:`TE_MAX_SCALE` #define :ref:`USLEEP`(_to_sleep) #define :ref:`VSLEEP`(_to_sleep, _msg) .. _details-group__te__ts__tapi__test__misc: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Miscellaneous definitions useful for test scenarios. Global Functions ---------------- .. index:: pair: function; te_test_sig_handler .. _doxid-group__te__ts__tapi__test__misc_1ga791466428a496ade7d9581bf49b53f69: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_test_sig_handler(int signum) Signal handler to close TE when Ctrl-C is pressed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - signum - - signal number .. index:: pair: function; test_sleep_scale .. _doxid-group__te__ts__tapi__test__misc_1ga2abb5690b2bfc202a727e2ffcbc57ed4: .. ref-code-block:: cpp :class: doxyrest-title-code-block static unsigned int test_sleep_scale(void) Function to get sleep scale. .. rubric:: Returns: Scale. Macros ------ .. index:: pair: define; CHECK_BUFS_EQUAL .. _doxid-group__te__ts__tapi__test__misc_1ga4c0c67ad7ba0e14f031a6896a4eaa251: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_BUFS_EQUAL(buf1_, buf2_, buf_len_) Check that two buffers of specified length have the same content and reports an error in case they are not .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - buf1\_ - First buffer * - buf2\_ - Second buffer * - buf_len\_ - Buffer length .. index:: pair: define; CHECK_NOT_NULL .. _doxid-group__te__ts__tapi__test__misc_1ga50cfbce7565f5b89b215874ac5db7195: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_NOT_NULL(expr_) Check that the expression is not NULL .. index:: pair: define; CHECK_RC .. _doxid-group__te__ts__tapi__test__misc_1ga503a00c04b4caa0dbe1943277bc3946e: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_RC(expr_) Check an expression passed as the argument against zero. If the expression is something not zero the macro reports an error, sets 'result' variable to EXIT_FAILURE and goes to 'cleanup' label. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - expr\_ - Expression to be checked .. index:: pair: define; CHECK_RC_ARTIFACT .. _doxid-group__te__ts__tapi__test__misc_1ga0bf26154149fcf1dbe6b5f1d377bbd45: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_RC_ARTIFACT(expr_, artifact_...) Same as CHECK_RC_VERDICT, but log an artifact instead of verdict The macro will terminate(fail) the test after logging the artifact. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - expr\_ - Expression to be checked * - artifact\_ - Artifact to be logged (supports format string) .. index:: pair: define; CHECK_RC_VERDICT .. _doxid-group__te__ts__tapi__test__misc_1ga11daccb064a62adb72b7dd3324f7b105: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CHECK_RC_VERDICT(expr_, verdict_...) Same as CHECK_RC, but verdict in case RC expression result is not ZERO. The macro will terminate(fail) the test after logging the verdict. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - expr\_ - Expression to be checked * - verdict\_ - Verdict to be logged (supports format string) .. index:: pair: define; CLEANUP_CHECK_RC .. _doxid-group__te__ts__tapi__test__misc_1ga94813d69d645e179ad70afb040e55161: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define CLEANUP_CHECK_RC(expr_) Check an expression passed as the argument against zero. The same as CHECK_RC, but does not go to 'cleanup' label. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - expr\_ - Expression to be checked .. index:: pair: define; FREE_AND_CLEAN .. _doxid-group__te__ts__tapi__test__misc_1ga13abb64cb27f62b1bb16e710487c285f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define FREE_AND_CLEAN(ptr_) Free variable and set its value to NULL .. index:: pair: define; MSLEEP .. _doxid-group__te__ts__tapi__test__misc_1gac701f293e03bd60f465ddaa4d18688c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define MSLEEP(_to_sleep) Scalable sleep (sleep scale times for _to_sleep milliseconds). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _to_sleep - number of seconds to sleep is scale is 1 .. index:: pair: define; SLEEP .. _doxid-group__te__ts__tapi__test__misc_1gacaf903875f9598534fda240ad65f2542: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define SLEEP(_to_sleep) Scalable sleep (sleep scale times for _to_sleep seconds). Logs function name. Use :ref:`VSLEEP() ` instead unless you're absolutely sure what you're doing. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _to_sleep - number of seconds to sleep is scale is 1 .. index:: pair: define; TAPI_WAIT_NETWORK .. _doxid-group__te__ts__tapi__test__misc_1ga90c33ef2fc9650944e0950b7cf9d6a5c: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_WAIT_NETWORK Wait for network action to complete. Typically, send() on one side and wait before non-blocing recv() on another side. .. index:: pair: define; TAPI_WAIT_NETWORK_DELAY .. _doxid-group__te__ts__tapi__test__misc_1gaab497d536d91e31768a76e2508785a67: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_WAIT_NETWORK_DELAY Time to wait for a network activity, milliseconds. .. index:: pair: define; TE_MAX_SCALE .. _doxid-group__te__ts__tapi__test__misc_1ga943ea704ad0a5334e11c4d7905e54794: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_MAX_SCALE Maximum allowed sleep scale .. index:: pair: define; USLEEP .. _doxid-group__te__ts__tapi__test__misc_1ga33e915c6c45d30037713f874947fec3e: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define USLEEP(_to_sleep) Scalable sleep (sleep scale times for _to_sleep microseconds). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _to_sleep - number of seconds to sleep is scale is 1 .. index:: pair: define; VSLEEP .. _doxid-group__te__ts__tapi__test__misc_1ga2f5afc4eeea76ab6a9fcded22cab9936: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define VSLEEP(_to_sleep, _msg) Scalable sleep (sleep scale times for _to_sleep seconds) that logs extra information. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _to_sleep - number of seconds to sleep is scale is 1 * - _msg - message to be logged