.. -*- mode: rst -*-

*********
maas-test
*********

A utility to test if a particular piece of hardware is compatible
with MAAS.

For more information see the `Launchpad project page`_.

.. _Launchpad project page: https://launchpad.net/maas-test


Setting up for development
--------------------------

To get maas-test running should be fairly easy, assuming you're on
Ubuntu 13.10 or later::

  # Add uvtool's dev PPA in order to get a recent enough package.
  sudo add-apt-repository -y ppa:uvtool-dev/trunk
  sudo apt-get update
  # Get a local copy of lp:maas-test.
  bzr branch lp:maas-test
  cd maas-test
  # Install the dependencies and build the environment.
  make install-dependencies
  make build

The ``make install-dependencies`` step ensures that maas-test's
dependencies are installed as system packages, and will not later be
installed by pip.


Dependencies
------------

The policy is:

  * All production dependencies must be satisfied from system packages.

  * Development-only dependencies can be installed from PyPI.

That means that production dependencies need to go in ``packages.txt``
and development-only ones into ``requirements.txt``. The latter can be
maintained like so::

  make update-requirements

Then **carefully** review the changes; libraries installed elsewhere on
the system can cause ``freeze --local`` to come up with radically
different answers to those on another machine.
