Developing and Testing

Our tests are inside ./tmuxp/testsuite. Tests are implemented using unittest.

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

Install the latest code from git

To begin developing, check out the code from github:

$ git clone
$ cd tmuxp

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

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.

$ ./

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.

Test runner options


As of v0.1.1, the old way of using --tests is now deprecated.

Testing specific TestSuites and TestCase.

$ ./ config

will test the testsuite.config unittest.TestSuite.

$ ./ config.ImportExportTest

tests testsuite.config.ImportExportTest unittest.TestCase.

individual tests:

$ ./ config.ImportExportTest.test_export_json

Multiple can be separated by spaces:

$ ./ window pane config.ImportExportTest

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:

    $ python ./ --tests tests_workspacebuilder

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

Run tests on save

You can re-run tests automatically on file edit.


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:

$ find . -type f -not -path '*/\.*' | grep -i '.*[.]py$' | entr -c ./

Rebuild the documentation when an .rst file is edited:

$ cd doc
$ find .. -print | grep -i '.*[.]rst' | entr -c make html

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).
before_script: ./ # ./ to load relative to project root.
- window_name: tmuxp
  focus: True
  layout: main-horizontal
    main-pane-height: 35
    - '[ -d .venv -a -f .venv/bin/activate ] && source .venv/bin/activate'
  - focus: true
  - pane 
  - if command -v entr > /dev/null; then find . -type f -not -path '*/\.*' | grep -i '.*[.]py$' | entr -c ./; else ./; echo "\nInstall entr(1) to automatically run tests on file change.\n See"; fi

- window_name: docs
  layout: main-horizontal
    main-pane-height: 35
  start_directory: doc/
    - '[ -d ../.venv -a -f ../.venv/bin/activate ] && source ../.venv/bin/activate'
  - focus: true
  - pane
  - echo 'docs built to <>'; python -m SimpleHTTPServer 8003
  - if command -v entr > /dev/null; then find .. -print | grep -i '.*[.]rst' | entr -c make html; else make html; echo "\nInstall entr(1) to automatically rebuild documentation when files change. \nSee"; fi

Travis CI

tmuxp uses travis-ci for continuous integration / automatic unit testing.

tmuxp is tested against tmux 1.8 and the latest git source. Interpretters tested are 2.6, 2.7 and 3.3. The travis build site uses this .travis.yml configuration:

language: python

sudo: false
  - 2.6
  - 2.7
  - 3.3
  - 3.4
  - 3.5
  - TMUX_VERSION=master
  - export PIP_USE_MIRRORS=true
  - pip install coveralls
  - pip install -e .
  - git clone tmux
  - cd tmux
  - git checkout $TMUX_VERSION
  - sh
  - ./configure --prefix=$HOME/tmux && make && make install
  - export PATH=$PATH:$HOME/tmux/bin
  - cd ..
  - tmux -V
script: coverage run --source=tmuxp test
      - libevent-dev
      - libncurses-dev
  - coveralls