(Edited due to recent watcher/event rethinking) |
(improve definition of event) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 6: | Line 6: | ||
== Events and watchers == | == Events and watchers == | ||
AutoQA defines "watchers" that look for various "events" happening within the Fedora development/build process and then announce them. A single watcher can check for and then announce multiple events. Announcing event means running main AutoQA executable and providing all mandatory arguments for such an event. | |||
=== Events === | |||
The event definition says what a particular event means semantically ("new package built in koji", "some yum repo has been updated", etc) and defines what information are needed to be received from the watcher to be able to execute related tests. | |||
For example, the <code>post-repo-update</code> event is triggered whenever <code>yum-repo</code> watcher determines that a Fedora repo is updated. The repo update is the event, and, obviously, any <code>post-repo-update</code> test needs to know the URL of the repo that was just updated. (This is an example of a ''required'' argument.) Certain repos can't be used properly without other "parent" repos (for example, the Fedora 11 <code>updates</code> repo isn't useful without also knowing the address of the main Fedora 11 repo). So a list of "parent repos" is an ''optional'' argument to the tests. | For example, the <code>post-repo-update</code> event is triggered whenever <code>yum-repo</code> watcher determines that a Fedora repo is updated. The repo update is the event, and, obviously, any <code>post-repo-update</code> test needs to know the URL of the repo that was just updated. (This is an example of a ''required'' argument.) Certain repos can't be used properly without other "parent" repos (for example, the Fedora 11 <code>updates</code> repo isn't useful without also knowing the address of the main Fedora 11 repo). So a list of "parent repos" is an ''optional'' argument to the tests. | ||
| Line 27: | Line 20: | ||
=== Test arguments === | === Test arguments === | ||
The autoqa test launcher needs to know how to process the arguments gathered by the watcher | The autoqa test launcher needs to know how to process the arguments gathered by the watcher. | ||
More detailed information about implementing new events can be found in [[Writing AutoQA | More detailed information about implementing new events can be found in [[Writing AutoQA Events and Watchers]]. | ||
== The autoqa Harness == | == The autoqa Harness == | ||
Latest revision as of 09:49, 30 March 2011
This document describes how AutoQA is structured internally.
Quick look
Events and watchers
AutoQA defines "watchers" that look for various "events" happening within the Fedora development/build process and then announce them. A single watcher can check for and then announce multiple events. Announcing event means running main AutoQA executable and providing all mandatory arguments for such an event.
Events
The event definition says what a particular event means semantically ("new package built in koji", "some yum repo has been updated", etc) and defines what information are needed to be received from the watcher to be able to execute related tests.
For example, the post-repo-update event is triggered whenever yum-repo watcher determines that a Fedora repo is updated. The repo update is the event, and, obviously, any post-repo-update test needs to know the URL of the repo that was just updated. (This is an example of a required argument.) Certain repos can't be used properly without other "parent" repos (for example, the Fedora 11 updates repo isn't useful without also knowing the address of the main Fedora 11 repo). So a list of "parent repos" is an optional argument to the tests.
Watchers
This is a program that watches for the event and launches the autoqa harness when the event occurs. The Watcher is responsible for filling in all the optional arguments for the event and passing that information along to autoqa. Typically watchers are run periodically through cron.
Test arguments
The autoqa test launcher needs to know how to process the arguments gathered by the watcher.
More detailed information about implementing new events can be found in Writing AutoQA Events and Watchers.
The autoqa Harness
The autoqa harness is launched by the watchers in response to an event. It's basically just a python script, /usr/bin/autoqa, which handles the arguments passed by the watcher and schedules the appropriate tests to be run in autotest.
Autotest
Autotest is "a framework for automated testing". It handles scheduling test jobs from the job queue, putting the test code onto the appropriate test machine, running the test, and gathering the test results for later examination. For more information see Autotest.
Tests
AutoQA tests consist of some test metadata, some setup and test reporting code, and the test itself - which may be a pre-existing test or a new test written specifically for AutoQA.
The test results are reported back to the Autotest system and can be examined through its web interface. Tests can also opt to report their results in other ways - commonly by sending email to the autoqa-results mailing list.
For more detailed information about AutoQA tests, see Writing AutoQA Tests.