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