Welcome to autoqa!

Everything here is under heavy development so don't expect that anything to
stay stable - modules, APIs, whatever.  If it's expected to stay stable we
will mark it as such. This documentation will be kept as up-to-date as possible
but if you have questions please feel free to email fedora-test-list@redhat.com
or ask in #fedora-qa on the freenode IRC network.

There's three main things in this tree: 'autoqa', 'hooks', and 'tests'.

'autoqa' is the main binary that kicks off tests (using the autotest framework -
see http://autotest.kernel.org/ for details). It's typically supposed to be 
run by the 'watcher' scripts in reaction to certain events within the Fedora
development/build process.

Each directory under 'hooks' corresponds to an event that happens that should
cause each test listed in 'testlist' in that directory to run. These events are
also called 'triggers' or 'buckets'. Each hook dir should contain the following: 
README: explains the expected environment / arguments for the tests
testlist: lists the names of the tests to be run
watcher: script that watches for the named condition and runs the autoqa
binary with the appropriate arguments
control.template: a template for the 'control' file for tests that are run
for that hook

The 'tests' subdirectory contains the tests. These tests are written for (and
run by) autotest - see http://autotest.kernel.org for more information, or the
(in-progress) Fedora docs at https://fedoraproject.org/wiki/Autotest for more
details about writing tests for autotest.