Documentation for trunk
Other versions: 4.3  4.0  3.27  Older...

Install Texttest
Windows
Download and run the Windows installer from the sourceforge project page. Since TextTest 4.0 this now installs everything under "Program Files" and does not affect existing Python installations, etc. It is also packaged with Meld instead of tkdiff as the default graphical difference tool. For backwards compatibility tkdiff will however be used by default if such an installation is found. It will use "Notepad++", "Wordpad" or "Notepad" in that order by default for editing files, depending on which of these it finds installed. Both of these tools can be configured via the personal config file, by setting "diff_program" or "view_program" respectively. The installer will set the environment variable TEXTTEST_HOME (see below) to C:\tests, so all tests will be created there. As this change doesn't take effect until you log out and log in again, it's suggested you do that for the moment (or set it to some other desired value before starting TextTest).
Linux
Most Linux distributions come with Python pre-installed. Since TextTest 4.0 a recent version of Python 3 is needed (>=3.6). TextTest can be installed by fetching it using the included pip installer, via "pip install texttest", either into the default Python or into a "virtualenv" if you'd prefer to keep it isolated. In order to use the TextTest GUI it is also necessary to install PyGI/PyGObject, the successor to PyGTK which TextTest 4.0 now uses. There are some guides here for how to do that on various forms of Linux. As above, you will need a graphical difference tool and a text editor, which default to "tkdiff" and "emacs" respectively. Either install these tools or create a personal config file, and set "diff_program" or "view_program" respectively.
Mac
Install Homebrew, and then use it to install a recent version of Python (>=3.6). From there the instructions on Linux largely apply, there is a MacOS section for how to install PyGObject using Homebrew.
Source package
The sourceforge project page. has a default download for non-Windows platforms that is pretty much a source package. While it's possible to run TextTest from there we believe it will nearly always be more convenient to follow the instructions above instead.
Things you might want to install...
For viewing test files while they are running, there is a menu option to display a window with live updates of the file. On UNIX this defaults to using 'xterm -e tail -f'. On Windows there is a nice equivalent called baretail which is TextTest's default. You can download it from Bare Metal Software's site. Like everything else you should add it to your PATH. Naturally, there is no compulsion to use this functionality so this download is optional. Selecting it on Windows will just produce an error dialog if “baretail” can't be found.
Things you need to set...
TextTest uses a root directory where it starts to look for tests, determined primarily by the environment variable TEXTTEST_HOME. This is the first thing determined by TextTest on being called and not much will happen if it isn't set.
You are strongly recommended to pick an existing root directory for all your tests and set TEXTTEST_HOME to this directory in some persistent way. In this way you will not need to think about it more than once.


Last updated: 02 March 2020