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

                      EDOS test assistant

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

François Déchelle    <fdechelle@mandriva.com>


1- Content
----------

This module contains the EDOS test assistant.

The EDOS test assistant helps testers roll check lists and report the
result of the check list. The test assistant uses the EDOS test runner
to report test results.


2- Prerequisites
----------------

You need the following packages:
python
python-pyxml: Python XML
python-qt: Python QT bindings
python-kde: Python KDE bindings

(report to your Linux distribution to find the exact package names)

You will also need the EDOS test runner, either from its source tree
or after installation.


3- Building
-----------

As the test assistant is written in Python, building is not mandatory,
unless the GUI files have been modified.

If the .ui files have been modified using QT-Designer, the Python
sources must be re-generated using pyuic. This can be done easily by
running:
python setup.py sdist

This will call if necessary the pyuic compiler. You will need pyuic to
be installed. Check your distribution for required package.


4- Installation
---------------

The test assistant must be installed in order to be able to run it.

This module uses Python distutils tools. To install it:
python setup.py install <<install-options>>

Standard install options are:
--prefix=<<DIRECTORY>>   to specify the installation prefix
--help                   to display other options


5- Running
----------

To run the test assistant, you must first install it and then make
sure that the Python package 'edostestrunner' can be found by the
Python interpreter. 

If you have installed the EDOS test runner in a standard directory,
for instance by using a package (RPM or Debian) version of the EDOS
test runner, setting PYTHONPATH is not mandatory and you can skip
paragraphe 5.1. 

5.1- Setting PYTHONPATH
-----------------------

If you have installed the package in a non-standard directory, you
must set the PYTHONPATH environment variable. The value to give to
PYTHONPATH is different if you are using directly the source tree or
if you have installed the EDOS test runner.

5.1.1- Running using test runner from its source tree
-----------------------------------------------------

Setting PYTHONPATH can be done by:
export PYTHONPATH=PATH_TO_SOURCE_TREE

For instance:
export PYTHONPATH=/var/tmp/edos-testrunner-1.0.3beta
if you have extracted edos-testrunner-1.0.3beta.tar.gz in directory /var/tmp

5.1.2- Running after installing test runner
-------------------------------------------

Refer to test runner README for test runner installation instructions.

Setting PYTHONPATH can be done by:
export PYTHONPATH=PREFIX/lib/python2.4/site-packages
where PREFIX is the prefix directory that you have specified when
installing test runner.

For instance, if you have installed test runner with:
python setup.py install --prefix=$HOME/projects/EDOS/install
then you must set PYTHONPATH with:
export PYTHONPATH=$HOME/projects/EDOS/install/lib/python2.4/site-packages

5.2 Running test assistant
--------------------------

After setting PYTHONPATH if needed, you can run the test assistant with:
edos-testassistant --file=<<test XML file>>

The 'edos-testassistant' script is located in the scripts installation
directory. For instance, if you have installed the test assistant
with:
python setup.py install --prefix=/home/fdechelle/tmp/foo
then edos-testassistant script will be located in:
/home/fdechelle/tmp/foo/usr/bin/edos-testassistant

An example test XML file is located in subdirectory:
tests/oo_insfrm03.xml

For more help on edos-testassistant options:
edos-testassistant --help




