=====================
Stress Tests for Kofa
=====================

Stress- and performance tests in here are based on the Python package
`multi-mechanize`. See the homepage
http://testutils.org/multi-mechanize/ for details.

Installation
------------

The stuff in here is *not* buildout-based.

To make it work, you need a Python with the packages
`multi-mechanize`, `numpy`, and `matplotlib` installed.

I'm used to install such packages in a virtual environment like this::

  $ virtualenv --no-site-packages mysandbox
  $ source mysandbox/bin/activate

Afterwards the required packages can be installed into this sandbox::

  (mysandbox) $ pip install numpy
  (mysandbox) $ pip install matplotlib
  (mysandbox) $ pip install multi-mechanize

Especially `matplotlib` is very demanding regarding already installed
(C and C++) libraries. On my Ubuntu I had to install at least::

  $ sudo apt-get install libfreetype6-dev
  $ sudo apt-get install libpng12-dev

to make it compile and install.

Running Stresstests
-------------------

The different stress tests are put into different multi-mechanize
'projects'. Each project runs a certain stress test for which you have
to setup certain things to make it work.

Basically, you run a stresstest like this::

  (mysandbox) $ multimech-run <PROJECT>

where ``<PROJECT>`` is one of the directories in here.

The projects in here are the subdirectories, each one representing a
different 'project' or kind of stresstest. Please see the respective
README files in this folder to learn what conditions must be met to
run each test.

Please keep in mind, that these tests normally require some local or
remote setup, for instance a running Kofa instance with certain
reachable URLs. Again, you can lookup the specific READMEs in this
directory to learn what setup is required to run a certain test.