Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 2.49 KB

pytest-plugin.md

File metadata and controls

96 lines (62 loc) · 2.49 KB

(pytest_plugin)=

pytest plugin

Testing tmux with libtmux


Do you want more flexbility? Correctness? Power? Defaults changed? [Connect with us] on the tracker, we want to know
your case, we won't stabilize APIs until we're sure everything is by the book.

[connect with us]: https://github.com/tmux-python/libtmux/discussions

Usage

Install libtmux via the python package manager of your choosing, e.g.

$ pip install libtmux

The pytest plugin will automatically be detected via pytest, and the fixtures will be added.

Fixtures

pytest-tmux works through providing {ref}pytest fixtures <pytest:fixtures-api> - so read up on those!

The plugin's fixtures guarantee a fresh, headless tmux(1) server, session, window, or pane is passed into your test.

(recommended-fixtures)=

Recommended fixtures

These are fixtures are automatically used when the plugin is enabled and pytest is ran.

  • Creating temporary, test directories for:

    • /home/ ({func}home_path)
    • /home/${user} ({func}user_path)

  • Default .tmux.conf configuration with these settings ({func}config_file):

    • base-index -g 1

    These are set to ensure panes and windows can be reliably referenced and asserted.

Setting a tmux configuration

If you would like {func}session fixture <libtmux.pytest_plugin.session> to automatically use a configuration, you have a few options:

  • Pass a config_file into {class}~libtmux.server.Server
  • Set the HOME directory to a local or temporary pytest path with a configurat configuration file

You could also read the code and override {func}server fixtures <libtmux.pytest_plugin.server>'s in your own doctest. doctest.

(set_home)=

Setting a temporary home directory

import pathlib
import pytest

@pytest.fixture(autouse=True, scope="function")
def set_home(
    monkeypatch: pytest.MonkeyPatch,
    user_path: pathlib.Path,
):
    monkeypatch.setenv("HOME", str(user_path))

See examples

View libtmux's own tests/ as well as tmuxp's tests/.

libtmux's tests autouse the {ref}recommended-fixtures above to ensure stable, assertions and object lookups in the test grid.

API reference

.. automodule:: libtmux.pytest_plugin
    :members:
    :inherited-members:
    :private-members:
    :show-inheritance:
    :member-order: bysource