Compare commits
3 Commits
bd1cd03334
...
v0.2
| Author | SHA1 | Date | |
|---|---|---|---|
| e989d131ad | |||
| cc561e961a | |||
| 87066fabd6 |
11
README.md
11
README.md
@@ -62,17 +62,6 @@ Pre-built artifacts are published at
|
||||
`testium` command is available in the terminal (requires `~/.local/bin` in
|
||||
`PATH`, which most modern distributions provide by default).
|
||||
|
||||
* **AppImage** (`Testium-<version>-x86_64.AppImage`) — a single self-contained
|
||||
executable bundling its own Python. Make it executable and run it:
|
||||
|
||||
```sh
|
||||
chmod +x Testium-*-x86_64.AppImage
|
||||
./Testium-*-x86_64.AppImage -b mytest.tum
|
||||
```
|
||||
|
||||
As with the binary and Flatpak, `py_func` / `lua_func` items run under the
|
||||
*host* Python / Lua so your own modules stay visible.
|
||||
|
||||
Every channel ships the language server, so `testium lsp` (see
|
||||
[Editor support](#editor-support)) works out of the box from any of them.
|
||||
|
||||
|
||||
@@ -23,3 +23,47 @@ graphical interface.
|
||||
: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]'
|
||||
|
||||
@@ -232,6 +232,15 @@ list of the main test item (and eventually of the loop test item).
|
||||
TUM file ``main`` item is itself a variant of test items with a name and an
|
||||
step list attributes.
|
||||
|
||||
.. note::
|
||||
|
||||
Each test item declares the parameters it accepts. When a ``.tum`` file
|
||||
uses a key the item does not know, *testium* emits a warning listing the
|
||||
accepted parameter names (catching typos such as ``param_filee`` for
|
||||
``param_file``); a missing **required** parameter aborts loading with an
|
||||
error pointing at the source ``.tum`` file. Valid existing tests are
|
||||
unaffected.
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
@@ -97,7 +97,10 @@ case "$MODE" in
|
||||
echo "Creating wheel venv at $WHEEL_VENV"
|
||||
python3 -m venv --system-site-packages "$WHEEL_VENV"
|
||||
"$WHEEL_VENV/bin/pip" install --quiet --upgrade pip
|
||||
"$WHEEL_VENV/bin/pip" install --quiet "$WHEEL"
|
||||
# Install with the [lsp] extra so the wheel channel is validated in
|
||||
# its language-server-capable form (pulls pygls), matching how a
|
||||
# user enables `testium lsp` from a wheel: pip install testium[lsp].
|
||||
"$WHEEL_VENV/bin/pip" install --quiet "${WHEEL}[lsp]"
|
||||
fi
|
||||
CMD=("$WHEEL_VENV/bin/python" -m testium)
|
||||
;;
|
||||
|
||||
Reference in New Issue
Block a user