~ubuntu-branches/ubuntu/vivid/mago/vivid

===============

Getting Started

===============

 

Requirements

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

 

Assistive Technologies

~~~~~~~~~~~~~~~~~~~~~~

 

Mago makes heavy use of LDTP (http://ldtp.freedesktop.org) to interact with the application and it uses the Accessibility libraries to discover through the application's user interface.

 

To enable the Assistive Technologies, select the menu **System -> Preferences -> Assistive Technologies**. the following dialog will be displayed.

 

.. image:: assistive.png

   :align: center

   :alt: SDFSDFSDF

 

Check the box **Enable Assistive Technologies**

 

Alternatively you can enable it from the command line. Open a terminal and run:

 

::

 

    # Enable accessibility for the current user 

    $ gconftool-2 --set --type bool /desktop/gnome/interface/accessibility true

 

 

You may also need to disable the screensaver to prevent the hang of the tests.

 

Finally restart your GNOME session (log out and log in) 

 

 

Additional Packages

~~~~~~~~~~~~~~~~~~~

 

In order to get a fully working system you need the following packages:

 

**python >=2.7**

    To take advantage of new features introduced in unittest

 

**bzr**

    Easy to use distributed version control system to get mago and push changes if you want to contribute.

 

**ldtp python-ldtp**

    The glue that uses the "Accessibility" libraries to poke through the application's user interface

 

**python-nose**

    Test discovery and running for Python's unittest

 

**python-xlib**

    Interface for Python to the X11 Protocol

 

**python-imaging**

    Python Imaging Library used for image compairison

 

Getting Mago

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

The Mago project is hosted in Launchpad at https://launchpad.net/mago

 

The trunk branch is owned by a Launchpad team, mago-contributors, that it is a moderated team. Once you have contributed through merge proposals, you can apply to be part of the team and will be able to push to trunk and review some other members contributions.

 

To get Mago from Launchpad you need to install the tool Bazaar (http://doc.bazaar.canonical.com)

Then run the following command to get the latest version from the Bazaar repository:

 

::

 

    $ bzr branch lp:mago

 

This will create a directory ``mago``. Go to this newly created directory and you'll be able to start running your first tests.

 

You can get the help of mago by running the command:

 

::

 

    $ ./bin/mago -h

 

 

Running the examples

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

 

The directory ``examples/`` contains few pieces of code which exercises different parts of mago.

 

Mago uses Nose (http://somethingaboutorange.com/mrl/projects/nose/) to collect and run tests and follows the same syntax.

 

To run a specific example:

 

::

 

    $ ./bin/mago examples/test_minimal.py

 

 

Or alternatively

 

::

 

    $ ./bin/mago -w examples test_minimal

 

 

To run all the tests in a directory enter:

 

::

 

    $ ./bin/mago examples/

 

.. automodule:: test_minimal

   :members: