François
de32a524da
Manual (modes.rst) and README: install the extension from Open VSX in VSCodium/Cursor/etc., and as a .vsix by hand in Microsoft VSCode; note that testium must be on PATH or set via testium.serverPath. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
103 lines
3.4 KiB
ReStructuredText
103 lines
3.4 KiB
ReStructuredText
|
|
Modes of operation
|
|
====================
|
|
|
|
.. _sec_graphical_mode:
|
|
|
|
Graphical mode
|
|
---------------
|
|
|
|
*testium* tool has been initially designed to have Graphical User's interface.
|
|
|
|
The way to call it is simply by executing the ``testium`` command. It is the normal mode.
|
|
|
|
.. _sec_batch_mode:
|
|
|
|
Batch mode
|
|
----------
|
|
|
|
The batch mode allows to execute a test in text mode. In this mode, the test does not start any
|
|
graphical interface.
|
|
|
|
.. code-block:: text
|
|
:caption: call a test in batch mode
|
|
|
|
testium -b test/my_test/main.tum
|
|
|
|
.. _sec_language_server:
|
|
|
|
Language server (editor support)
|
|
--------------------------------
|
|
|
|
*testium* ships a `Language Server Protocol
|
|
<https://microsoft.github.io/language-server-protocol/>`_ server so that
|
|
``.tum`` files get editor assistance — completion of test item types, hover
|
|
documentation of their parameters, and an outline view — in any LSP-capable
|
|
editor.
|
|
|
|
The server speaks LSP over standard input/output and is started with:
|
|
|
|
.. code-block:: text
|
|
:caption: start the language server
|
|
|
|
testium lsp
|
|
|
|
It is not meant to be launched directly by the user: an editor's LSP client
|
|
spawns it and drives the exchange. A VSCode / VSCodium client extension,
|
|
*testium_assist*, is provided for that purpose; any other LSP client (Neovim,
|
|
Emacs ``lsp-mode``, …) can be pointed at ``testium lsp`` as well.
|
|
|
|
The information the server exposes is the test item schema, which can also be
|
|
dumped as JSON for inspection or tooling:
|
|
|
|
.. code-block:: text
|
|
:caption: dump the item / parameter schema
|
|
|
|
testium schema
|
|
|
|
Because the schema is built from *testium* itself, every new item type or
|
|
parameter becomes available in the editor on the next *testium* upgrade, with
|
|
no change to the client.
|
|
|
|
The language server is included in the pre-built binary, Flatpak and AppImage
|
|
releases. For a source or wheel installation, pull the optional ``lsp``
|
|
dependencies:
|
|
|
|
.. code-block:: text
|
|
:caption: enable the language server for a wheel / source install
|
|
|
|
pip install 'testium[lsp]'
|
|
|
|
Installing the VSCode / VSCodium extension
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
The *testium_assist* client extension is published on `Open VSX
|
|
<https://open-vsx.org/extension/testium/testium-assist>`_, the registry used by
|
|
VSCodium, Cursor, Windsurf, Eclipse Theia and code-server. In those editors,
|
|
open the Extensions view and search ``testium-assist``, or install it from the
|
|
command line:
|
|
|
|
.. code-block:: text
|
|
:caption: install in VSCodium and other Open VSX editors
|
|
|
|
codium --install-extension testium.testium-assist
|
|
|
|
Microsoft *VSCode* uses a different marketplace that does not list Open VSX
|
|
extensions, so install the packaged ``.vsix`` by hand. Download it from the
|
|
Open VSX page linked above, then either choose *Extensions* → *⋯* →
|
|
*Install from VSIX…* in the UI, or run:
|
|
|
|
.. code-block:: text
|
|
:caption: install the .vsix in Microsoft VSCode
|
|
|
|
code --install-extension testium-assist-0.1.0.vsix
|
|
|
|
The extension launches ``testium lsp``, so the ``testium`` command must be on
|
|
the ``PATH``. If *testium* is installed elsewhere — a specific binary or an
|
|
AppImage — point the ``testium.serverPath`` setting at it instead.
|
|
|
|
Once installed, open a ``.tum`` file: completion of item types, hover
|
|
documentation and the outline view become available. If nothing happens, check
|
|
that no ``files.associations`` entry forces ``*.tum`` to another language (it
|
|
must stay the ``tum`` language the extension provides).
|