xref: /freebsd/contrib/atf/README (revision 3078531de10dcae44b253a35125c949ff4235284)
1Introductory information                        Automated Testing Framework
2===========================================================================
3
4
5Introduction
6************
7
8The Automated Testing Framework (ATF) is a collection of libraries to
9implement test programs in a variety of languages.  At the moment, ATF
10offers C, C++ and POSIX shell bindings with which to implement tests.
11These bindings all offer a similar set of functionality and any test
12program written with them exposes a consistent user interface.
13
14ATF-based test programs rely on a separate runtime engine to execute them.
15The runtime engine is in charge of isolating the test programs from the
16rest of the system to ensure that their results are deterministic and that
17they cannot affect the running system.  The runtime engine is also
18responsible for gathering the results of all tests and composing reports.
19The current runtime of choice is Kyua.
20
21
22Other documents
23***************
24
25* AUTHORS: List of authors and contributors for this project.
26
27* COPYING: License information.
28
29* INSTALL: Compilation and installation instructions.  These is not the
30  standard document shipped with many packages, so be sure to read it for
31  things that are specific to ATF's build.
32
33* NEWS: List of major changes between formal, published releases.
34
35
36===========================================================================
37vim: filetype=text:textwidth=75:expandtab:shiftwidth=2:softtabstop=2
38