================
FunkLoad INSTALL
================

:author: Benoit Delbosc

:address: bdelbosc _at_ nuxeo.com

:version: FunkLoad/1.1.0

:revision: $Id: README.txt 27636 2005-09-27 14:27:34Z bdelbosc $

:abstract: This document describes how to install the FunkLoad_ tool.

.. sectnum::    :depth: 2

.. contents::   :depth: 3


Required packages
-----------------

* libexpat1
* works fine with python 2.3.5, looks like ok with python 2.4
* python xml, for example on a Debian system::

    sudo apt-get install python-xml

* python distutils, on a Debian system::

    sudo apt-get install python-dev

* python Richard Jones' webunit_ version 1.3.8::

    cd /tmp
    wget http://www.mechanicalcat.net/tech/webunit/webunit-1.3.8.tar.gz
    tar xzvf webunit-1.3.8.tar.gz
    cd webunit-1.3.8/
    python setup.py build
    sudo python setup.py install

  Note that webunit_ is also available using easy_install_::

    sudo easy_install webunit


Optional packages
-----------------

* to produce html report : python-docutils (0.3.7-2 is fine), on Debian::

   apt-get install python-docutils

* to produce charts : python-gdchart (0.6.1-8 is fine), on Debian::

   apt-get install python-gdchart

* to have a proxy recorder install TestMaker, this requires a jre 1.4.2
  (seems fine also with 1.5.0)

   - Unzip TestMaker 4.3.1 from http://downloads.pushtotest.com/TestMaker.zip
   - you need to export your JAVA_HOME (like /usr/local/java/jre1.5.0_01)

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

See CHANGES.txt_ to know which package to install.

From a package::

    # check the latest package at http://funkload.nuxeo.org/
    cd /tmp
    wget http://funkload.nuxeo.org/funkload-1.1.0.tar.gz
    tar xzvf funkload-1.1.0.tar.gz
    cd funkload-1.1.0/
    python setup.py build
    sudo python setup.py install


Or from bleeding edge svn sources, if you want to try the latest unstable
sources::

    svn co http://svn.nuxeo.org/pub/funkload/trunk /tmp/funkload
    cd /tmp/funkload/
    python setup.py build
    sudo python setup.py install


easy_install_ funkload is comming soon ...


Test it
-------

Go to the demo/xmlrpc folder then::

  cd demo/xmlrpc/
  make test

To test benching and report building just::

  make bench


--------------------------

See README.txt_ for more information about FunkLoad_.

See CHANGES.txt_ for information on FunkLoad_ packages.

See demo_ folder for other examples.


.. _FunkLoad: http://funkload.nuxeo.org/
.. _webunit: http://mechanicalcat.net/tech/webunit/
.. _TestMaker: http://www.pushtotest.com/
.. _README.txt: README.html
.. _CHANGES.txt: CHANGES.html
.. _demo: http://svn.nuxeo.org/trac/pub/browser/funkload/trunk/demo/
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
