diff --git a/doc/manual/sphinx/source/test_items/run_test_item.rst b/doc/manual/sphinx/source/test_items/run_test_item.rst index 7b71c09..7e0c3f0 100644 --- a/doc/manual/sphinx/source/test_items/run_test_item.rst +++ b/doc/manual/sphinx/source/test_items/run_test_item.rst @@ -1,7 +1,15 @@ **run** test item ============================================================ -This test item executes a new instance of testium. +This test item executes a new instance of testium with the specified ``.tum`` file. + +* In **batch mode** (``-b``): the sub-instance is started with ``-b``. +* In **GUI mode**: the sub-instance is started with ``-r`` (run and close). + +The item result is **SUCCESS** if the sub-instance launched and ran to completion, +regardless of whether the sub-tests passed or failed. +It is **FAILURE** if the file could not be found, the sub-instance could not be +launched, or the time window was not reached (see ``start_time`` / ``end_time``). .. code-block:: yaml :caption: ``run`` test item usage example @@ -18,12 +26,12 @@ Attributes run test item has the following specific attributes: -* ``tum``: mandatory the path of the file to execute, it can be relative to current execution folder, -* ``param_file`` (optional) the path of the parameter file to use, otherwise default parameter file is used. -* ``python_bin`` (optional) the path of a specific python to run your scripts, -* ``testium_path`` (optional) the path of a specific testium to run your scripts, -* ``log_file`` (optional) the path of log file to register, if not provided a file is created with timestamp at the location of TUM file. -* ``report_file`` (optional), the path of report file to create -* ``start_time`` (optional), start time for the script execution, in HH:MM format. -* ``end_time`` (optional), end time for an execution within a time frame, in HH:MM format. -* ``wait_for_exec`` (optional). True or False, wait to be in the execution window defined by start_time and end_time to run the script. \ No newline at end of file +* ``tum``: mandatory, the path of the file to execute. Can be relative to the current execution folder. +* ``param_file`` (optional): the path of the parameter file to use; otherwise the default parameter file is used. +* ``python_bin`` (optional): the path of a specific Python interpreter to use. +* ``testium_path`` (optional): the path of a specific testium executable to use. +* ``log_file`` (optional): the path of the log file. In GUI mode, if not provided, a file is created with a timestamp next to the ``.tum`` file. Not used in batch mode. +* ``report_file`` (optional): the path of the report file to create. +* ``start_time`` (optional): earliest time to execute the sub-instance, in ``HH:MM`` format. +* ``end_time`` (optional): latest time for execution within a time frame, in ``HH:MM`` format. +* ``wait_for_exec`` (optional): ``true`` to wait until the time window defined by ``start_time`` and ``end_time`` is reached before running. Requires both ``start_time`` and ``end_time``. \ No newline at end of file