removed reference to "terminal" mode. Corrected errors in doc generation.
This commit is contained in:
@@ -3,7 +3,7 @@ Command Line Interface
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
usage: testium.pyw [-h] [--version] [-b] [-m] [-c CONFIG_FILE [CONFIG_FILE ...]] [-r] [-l LOG_FILE]
|
||||
usage: testium.pyw [-h] [--version] [-b] [-c CONFIG_FILE [CONFIG_FILE ...]] [-r] [-l LOG_FILE]
|
||||
[-d DEFINE [DEFINE ...]] [-p REPORT_FILE] [-t {sqlite,json,junit,html,text}]
|
||||
[-n REPORT_PATTERN [REPORT_PATTERN ...]] [-i INCLUDE_PATH [INCLUDE_PATH ...]] [-o] [-g]
|
||||
[test_file]
|
||||
@@ -16,9 +16,8 @@ Command Line Interface
|
||||
--version Returns the version of testium
|
||||
-b, --batch-execution
|
||||
Executes the test in batch mode
|
||||
-m, --terminal Starts terminal mode
|
||||
-c CONFIG_FILE [CONFIG_FILE ...], --config-file CONFIG_FILE [CONFIG_FILE ...]
|
||||
-o, --no-color Deactivates stdout colors in batch and terminal mode
|
||||
-o, --no-color Deactivates stdout colors in batch mode
|
||||
Configuration file
|
||||
-r, --run-and-close Runs the test then closes the application
|
||||
-l LOG_FILE, --log-file LOG_FILE
|
||||
@@ -45,17 +44,10 @@ Returns what's in the previous section.
|
||||
|
||||
Executes the test in text mode. No need to have QT installed in that case.
|
||||
|
||||
``-m, --terminal``
|
||||
------------------
|
||||
|
||||
Starts a testium interactive console. It allows to run commands and sub-tests manually
|
||||
in a console.
|
||||
|
||||
|
||||
``-o, --no-color``
|
||||
------------------
|
||||
|
||||
Switch allowing to disable the colored output in terminal or batch modes.
|
||||
Switch allowing to disable the colored output in batch mode.
|
||||
|
||||
``-c, --config-file``
|
||||
---------------------
|
||||
|
||||
@@ -23,23 +23,3 @@ graphical interface.
|
||||
:caption: call a test in batch mode
|
||||
|
||||
testium -b test/my_test/main.tum
|
||||
|
||||
Terminal mode
|
||||
-------------
|
||||
|
||||
The terminal mode starts *testium* in interactive mode. From this console, some tests and
|
||||
sequences of tests can be called interactively.
|
||||
|
||||
.. code-block:: text
|
||||
:caption: call a test in terminal mode
|
||||
|
||||
$ testium -m
|
||||
Configuration file loaded: /my/execution/path/param.yaml
|
||||
[...]
|
||||
================================================================================
|
||||
====== Test configuration
|
||||
================================================================================
|
||||
Test executed with testium : 2.4.0 (binary release)
|
||||
|
||||
|
||||
(testium)~
|
||||
|
||||
@@ -6,7 +6,7 @@ This software is developed in python and it implements the Qt6 graphical framewo
|
||||
|
||||
It has been developed since 2013 with production and development testing in mind.
|
||||
|
||||
It's function is to automate the execution of tests. It can be invoked either as command line terminal application or as a graphical interface application.
|
||||
It's function is to automate the execution of tests. It can be invoked either as command line application or as a graphical interface application.
|
||||
|
||||
Tests reports generation and customization are also in this tool's scope.
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ if not provided is given in the table as well.
|
||||
| | | It depends on the test item to take it |
|
||||
| | | into account or not. |
|
||||
| | | For example it makes sense to use it |
|
||||
| | | for ``unittest`` test type |
|
||||
| | | for ``unittest`` test type |
|
||||
| | | because it can contain many sub-tests, |
|
||||
| | | but not for sleep test type. |
|
||||
| | | In cycles, it means that the child |
|
||||
|
||||
@@ -59,7 +59,8 @@ Each entry of ``branches`` is a dict with the following attributes:
|
||||
|
||||
* ``name``: required. The branch name. Used in reports and as a prefix
|
||||
in the live log output (each line printed by the branch is prefixed
|
||||
with ``[<name>] `` so concurrent branches stay readable).
|
||||
with the branch name in square brackets, e.g. ``[Branch A]``, so
|
||||
concurrent branches stay readable).
|
||||
* ``steps``: required. The list of test items executed sequentially
|
||||
inside the branch.
|
||||
* ``wait_for``: optional. Forces the branch to wait until a condition is
|
||||
@@ -79,8 +80,8 @@ Each branch produces its own row in the SQLite report (with type
|
||||
branch's thread, so logs are never mixed between concurrent branches.
|
||||
|
||||
In the live (terminal / GUI) output, lines emitted from a branch are
|
||||
prefixed with ``[<branch name>] ``. The prefix is not stored in the
|
||||
SQLite log column.
|
||||
prefixed with the branch name in square brackets (e.g. ``[Branch A]``).
|
||||
The prefix is not stored in the SQLite log column.
|
||||
|
||||
Notes
|
||||
--------------------
|
||||
|
||||
Binary file not shown.
Reference in New Issue
Block a user