:orphan:

.. index:: pair: group; GTest support
.. _doxid-group__tapi__gtest:

GTest support
=============

.. toctree::
	:hidden:

	struct_tapi_gtest.rst
	struct_tapi_gtest_impl.rst

Overview
~~~~~~~~

Test API for run Google Test binaries

Copyright (C) 2019-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__gtest>`


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

	
	// typedefs

	typedef struct :ref:`tapi_gtest_impl<doxid-structtapi__gtest__impl>` :ref:`tapi_gtest_impl<doxid-group__tapi__gtest_1ga1cbd2ea527a2da21b516dd61412442c4>`;
	typedef struct :ref:`tapi_gtest<doxid-structtapi__gtest>` :ref:`tapi_gtest<doxid-group__tapi__gtest_1ga71dfa0c48604fd32b6bca5e95c188228>`;

	// structs

	struct :ref:`tapi_gtest<doxid-structtapi__gtest>`;
	struct :ref:`tapi_gtest_impl<doxid-structtapi__gtest__impl>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_gtest_init<doxid-group__tapi__gtest_1ga35b2d2fbcb9f5b1377266b6b1c74e2de>`(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest, :ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_gtest_start<doxid-group__tapi__gtest_1ga2824f55706b287b1db3d645d80f5b6db>`(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_gtest_stop<doxid-group__tapi__gtest_1ga0568cdb5796cb8f328fe5fbe8228d558>`(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_gtest_wait<doxid-group__tapi__gtest_1ga4b043905281e1ee7f23e572c93f3f61f>`(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_gtest_fini<doxid-group__tapi__gtest_1ga5b3f4dc2455fbd33a20e913e08e54d3d>`(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest);

	// macros

	#define :ref:`TAPI_GTEST_DEFAULTS<doxid-group__tapi__gtest_1ga1765e7601a2c6ef9049c547421a7c2ae>`
	#define :ref:`TAPI_GTEST_IMPL_DEFAULTS<doxid-group__tapi__gtest_1gad3530022dd586b55952e32cda5f786ac>`
	#define :ref:`TEST_GET_GTEST_PARAM<doxid-group__tapi__gtest_1ga06878be6a0c5095b2df8060f9607b400>`(_gtest)
	#define :ref:`TEST_GTEST_PARAM<doxid-group__tapi__gtest_1ga58068633e1fa0391e41118847486b8b2>`(_gtest)

.. _details-group__tapi__gtest:

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

Test API for run Google Test binaries

Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_gtest_impl
.. _doxid-group__tapi__gtest_1ga1cbd2ea527a2da21b516dd61412442c4:

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

	typedef struct :ref:`tapi_gtest_impl<doxid-structtapi__gtest__impl>` tapi_gtest_impl

Internal implementation struct

.. index:: pair: typedef; tapi_gtest
.. _doxid-group__tapi__gtest_1ga71dfa0c48604fd32b6bca5e95c188228:

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

	typedef struct :ref:`tapi_gtest<doxid-structtapi__gtest>` tapi_gtest

GTest handler

Global Functions
----------------

.. index:: pair: function; tapi_gtest_init
.. _doxid-group__tapi__gtest_1ga35b2d2fbcb9f5b1377266b6b1c74e2de:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_gtest_init(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest, :ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory)

Create GTest



.. rubric:: Parameters:

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

	*
		- gtest

		- GTest handler

	*
		- factory

		- Job factory



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_gtest_start
.. _doxid-group__tapi__gtest_1ga2824f55706b287b1db3d645d80f5b6db:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_gtest_start(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest)

Start GTest



.. rubric:: Parameters:

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

	*
		- gtest

		- GTest handler



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_gtest_stop
.. _doxid-group__tapi__gtest_1ga0568cdb5796cb8f328fe5fbe8228d558:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_gtest_stop(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest)

Stop GTest



.. rubric:: Parameters:

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

	*
		- gtest

		- GTest handler



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_gtest_wait
.. _doxid-group__tapi__gtest_1ga4b043905281e1ee7f23e572c93f3f61f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_gtest_wait(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest, int timeout_ms)

Wait GTest and get result



.. rubric:: Parameters:

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

	*
		- gtest

		- GTest handler

	*
		- timeout_ms

		- Timeout for wait



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_gtest_fini
.. _doxid-group__tapi__gtest_1ga5b3f4dc2455fbd33a20e913e08e54d3d:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_gtest_fini(:ref:`tapi_gtest<doxid-structtapi__gtest>`* gtest)

Cleanup GTest



.. rubric:: Parameters:

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

	*
		- gtest

		- GTest handler



.. rubric:: Returns:

Status code

Macros
------

.. index:: pair: define; TAPI_GTEST_DEFAULTS
.. _doxid-group__tapi__gtest_1ga1765e7601a2c6ef9049c547421a7c2ae:

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

	#define TAPI_GTEST_DEFAULTS

Defaults for implementation for GTest handler

.. index:: pair: define; TAPI_GTEST_IMPL_DEFAULTS
.. _doxid-group__tapi__gtest_1gad3530022dd586b55952e32cda5f786ac:

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

	#define TAPI_GTEST_IMPL_DEFAULTS

Defaults for implementation struct

.. index:: pair: define; TEST_GET_GTEST_PARAM
.. _doxid-group__tapi__gtest_1ga06878be6a0c5095b2df8060f9607b400:

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

	#define TEST_GET_GTEST_PARAM(_gtest)

A way for read gtest option from test arguments

.. index:: pair: define; TEST_GTEST_PARAM
.. _doxid-group__tapi__gtest_1ga58068633e1fa0391e41118847486b8b2:

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

	#define TEST_GTEST_PARAM(_gtest)

A way for read gtest option from test arguments