MAGO
----
Mago is a desktop testing initiative, built on top of LDTP (http://ldtp.freedesktop.org/), that aims to have a set of processes and code to make writing automated test scripts easier and more reusable. Although we started this effort as an Ubuntu project it works for vanilla GNOME in most of the cases. 

How to run the tests
--------------------

Some easy steps to run the tests:

 * Enable the Assistive Technologies (System -> Preferences -> Assistive Technologies) 
 * Restart your GNOME session (log out and log in again)
 * Install python-ldtp package (in universe).
 * Get the latest tests from the Bazaar repository:
   bzr branch lp:mago 
 * Go the newly created folder and run PYTHONPATH=. ./bin/mago -a gedit. That will run the gedit tests.
 * Go to the .mago folder under your home folder to retrieve the tests results. 

WARNING
-------
Running the tests is not 100% secure. There are some tests that will override any previous configuration. Please, refer to the README file in each of the applications folder for details

Mago syntax
-----------
Usage: mago [options]

Execute automated tests

Options:
  -h, --help            show this help message and exit
  -i, --info            Display information about test cases without executing
                        them

  Test selection options:
    -a APPLICATION, --application=APPLICATION
                        Application name to test. Option can be repeated and
                        defaults to all applications
    -n NAME, --suite_name=NAME
                        Suite name to test within applications. Option can be
                        repeated and default to all suites unless suite name
                        or suite file filtering has been enabled
    -f FILE, --suite_file=FILE
                        Suite file to test within applications. Option can be
                        repeated and default to all suites unless suite name
                        or suite file filtering has been enabled
    -c CASE, --case=CASE
                        Test cases to run (all, if not specified).

  Logging options:
    -l FILE, --log=FILE
                        The file to write the log to.
    --log-level=LOG_LEVEL
                        One of debug, info, warning, error or critical.
    -t DIR, --target=DIR
                        Target directory for logs and reports. Defaults to:
                        ~/.mago

Logging
-------
By default, logs are written at ~/.mago. This folder can be changed using the -t option (see above).

Two different logs are written per test:
 * A XML file, easier to parse.
 * A HTML file, better for reporting.

