Developing and Testing#

Our tests are inside tests/. Tests are implemented using pytest.

make test will create a tmux server on a separate socket_name using $ tmux -L test_case.

Install the latest code from git#

Get the source#

To begin developing, check out the code from github:

$ git clone git@github.com:tmux-python/tmuxp.git

$ cd tmuxp

Bootstrap#

The easiest way to configure a dev environment is through poetry. This automatically will manage virtualenv and python dependencies for tmuxp. For information on installing poetry visit the poetry’s documentation.

To begin developing, check out the code from github:

$ git clone git@github.com:tmux-python/tmuxp.git

$ cd tmuxp

You can create a virtualenv, and install all of the locked packages as listed in poetry.lock:

$ poetry install

If you ever need to update packages during your development session, the following command can be used to update all packages as per poetry settings or individual package (second command):

$ poetry update

$ poetry update requests

Then activate it to your current tty / terminal session with:

$ poetry shell

That is it! You are now ready to code!

Advanced: Manual virtualenv#

Now create a virtualenv, if you don’t know how to, you can create a virtualenv with:

$ virtualenv .venv

Then activate it to your current tty / terminal session with:

$ source .venv/bin/activate

Good! Now let’s run this:

$ pip install -e .

This has pip, a python package manager install the python package in the current directory. -e means --editable, which means you can adjust the code and the installed software will reflect the changes.

$ tmuxp

Test Runner#

pytest is used for tests.

As you seen above, the tmuxp command will now be available to you, since you are in the virtual environment, your {}PATH environment was updated to include a special version of python inside your .venv folder with its own packages.

Rerun on file change#

via pytest-watcher (works out of the box):

$ make start

via entr(1) (requires installation):

$ make watch_test

Manual (just the command, please)#

$ poetry run py.test

or:

$ make test

pytest options#

PYTEST_ADDOPTS can be set in the commands below. For more information read docs.pytest.com for the latest documentation.

Verbose:

$ env PYTEST_ADDOPTS="-verbose" make start

Pick a file:

$ env PYTEST_ADDOPTS="tests/workspace/test_builder.py" poetry run make start

Drop into test_automatic_rename_option() in tests/workspace/test_builder.py:

$ env PYTEST_ADDOPTS="-s -x -vv tests/workspace/test_builder.py" poetry run make start

Drop into test_automatic_rename_option() in tests/workspace/test_builder.py and stop on first error:

$ env PYTEST_ADDOPTS="-s -x -vv tests/workspace/test_builder.py::test_automatic_rename_option" poetry run make start

Drop into pdb on first error:

$ env PYTEST_ADDOPTS="-x -s --pdb" make start

If you have ipython installed:

$ env PYTEST_ADDOPTS="--pdbcls=IPython.terminal.debugger:TerminalPdb" make start

$ make test

You probably didn’t see anything but tests scroll by.

If you found a problem or are trying to write a test, you can file an issue on github.

Manual invocation#

Test only a file:

$ py.test tests/test_config.py

will test the tests/test_config.py tests.

$ py.test tests/test_config.py::test_export_json

tests test_export_json inside of tests/test_config.py.

Multiple can be separated by spaces:

$ py.test tests/test_{window,pane}.py tests/test_config.py::test_export_json

Visual testing#

You can watch tmux testsuite build sessions visually by keeping a client open in a separate terminal.

Create two terminals:

Terminal 1: $ tmux -L test_case
Terminal 2: $ cd into the tmuxp project and into the virtualenv if you are using one, see details on installing the dev version of tmuxp above. Then:
```
$ py.test tests/workspace/test_builder.py
```

Terminal 1 should have flickered and built the session before your eyes. tmuxp hides this building from normal users.

Run tests on save (old method)#

You can re-run tests automatically on file edit.

Note

This requires entr(1).

Install entr. Packages are available available on most Linux and BSD variants, including Debian, Ubuntu, FreeBSD, OS X.

To run all tests upon editing any .py file:

$ make watch_test

You can also re-run a specific test file or any other py.test usage argument:

$ make watch_test test=tests/test_config.py

$ make watch_test test='-x tests/test_config.py tests/test_util.py'

Testing options#

RETRY_TIMEOUT_SECONDS can be toggled if certain workspace builder tests are being stubborn.

e.g. RETRY_TIMEOUT_SECONDS=10 py.test

name: tests

on: [push, pull_request]

jobs:
  build:
    # Don't run twice for internal PRs from our own repo
    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.12']
        tmux-version: ['2.6', '2.7', '2.8', '3.0a', '3.1b', '3.2a', '3.3a', 'master']
        # balance ci coverage across supported python/tmux versions with CI speed
        include:
          - python-version: '3.8'
            tmux-version: '2.6'
          - python-version: '3.8'
            tmux-version: 'master'
    steps:
      - uses: actions/checkout@v4

      - name: Install poetry
        run: pipx install "poetry==1.7.1"

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'poetry'

      - name: Setup tmux build cache for tmux ${{ matrix.tmux-version }}
        id: tmux-build-cache
        uses: actions/cache@v3
        with:
          path: ~/tmux-builds/tmux-${{ matrix.tmux-version }}
          key: tmux-${{ matrix.tmux-version }}

      - name: Build tmux ${{ matrix.tmux-version }}
        if: steps.tmux-build-cache.outputs.cache-hit != 'true'
        run: |
          sudo apt install libevent-dev libncurses5-dev libtinfo-dev libutempter-dev bison
          mkdir ~/tmux-builds
          mkdir ~/tmux-src
          git clone https://github.com/tmux/tmux.git ~/tmux-src/tmux-${{ matrix.tmux-version }}
          cd ~/tmux-src/tmux-${{ matrix.tmux-version }}
          git checkout ${{ matrix.tmux-version }}
          sh autogen.sh
          ./configure --prefix=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }} && make && make install
          export PATH=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin:$PATH
          cd ~
          tmux -V

      - name: Install python dependencies
        run: poetry install --with=test,coverage,lint

      - name: Lint with ruff .
        run: poetry run ruff .

      - name: Format with ruff
        run: poetry run ruff format . --check

      - name: Lint with mypy
        run: poetry run mypy .

      - name: Print python versions
        run: |
          python -V
          poetry run python -V

      - name: Test with pytest
        continue-on-error: ${{ matrix.tmux-version == 'master' }}
        run: |
          sudo apt install libevent-2.1-7
          export PATH=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin:$PATH
          ls $HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin
          tmux -V
          poetry run py.test --cov=./ --cov-report=xml

      - uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

  release:
    runs-on: ubuntu-latest
    needs: build
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')

    strategy:
      matrix:
        python-version: ['3.12']

    steps:
      - uses: actions/checkout@v4

      - name: Install poetry
        run: pipx install "poetry==1.7.1"

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'poetry'

      - name: Build package
        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
        run: poetry build

      - name: Publish package
        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          user: __token__
          password: ${{ secrets.PYPI_API_TOKEN }}
          skip_existing: true

Documentation#

Rebuild on save#

Rebuild the documentation when an .md file is edited:

$ cd doc

$ make watch

If you’re not source’d via poetry shell, you can use this:

$ make SPHINXBUILD='poetry run sphinx-build' watch

tmuxp developer config#

After you Install the latest code from git, when inside the tmuxp checkout:

$ tmuxp load .

this will load the .tmuxp.yaml in the root of the project.

session_name: tmuxp
start_directory: ./ # load session relative to config location (project root).
shell_command_before:
- '[ -f .venv/bin/activate ] && source .venv/bin/activate && reset'
windows:
- window_name: tmuxp
  focus: True
  layout: main-horizontal
  options:
    main-pane-height: 35
  panes:
  - focus: true
  - pane 
  - make watch_mypy
  - make watch_test
- window_name: docs
  layout: main-horizontal
  options:
    main-pane-height: 35
  start_directory: docs/
  panes:
  - focus: true
  - pane
  - pane
  - make start

Formatting#

ruff#

The project uses ruff to handles formatting, sorting imports and linting.

Command

poetry:

$ poetry run ruff

If you setup manually:

$ ruff .

make

$ make ruff

Watch

$ make watch_ruff

requires entr(1).

Fix files

poetry:

$ poetry run ruff . --fix

If you setup manually:

$ ruff . --fix

ruff format#

ruff format is used for formatting.

Command

poetry:

$ poetry run ruff format .

If you setup manually:

$ ruff format .

make

$ make ruff_format

mypy#

mypy is used for static type checking.

Command

poetry:

$ poetry run mypy .

If you setup manually:

$ mypy .

make

$ make mypy

Watch

$ make watch_mypy

requires entr(1).

Continuous integration#

Github Actions#

tmuxp uses github actions for continuous integration / automatic unit testing.

To view the tmux and python versions tested see the .github/workflows/tests.yml. Builds are done on master and pull requests and can be viewed on the gh build site.