| Name | Date | Size | |
|---|---|---|---|
| .. | 2018-01-22 00:00:47 | 7 | |
| .travis.yml | 2018-01-22 00:00:47 | 243 | |
| aclocal.m4 | 2018-01-22 00:00:47 | 43.5 KiB | |
| admin | 2018-01-22 00:00:47 | 19 | |
| atf-c | 2018-01-22 00:00:47 | 37 | |
| atf-c++ | 2018-01-22 00:00:47 | 27 | |
| atf-c++.hpp | 2018-01-22 00:00:47 | 1.5 KiB | |
| atf-c.h | 2018-01-22 00:00:47 | 1.5 KiB | |
| atf-sh | 2018-01-22 00:00:47 | 22 | |
| Atffile | 2018-01-22 00:00:47 | 146 | |
| AUTHORS | 2013-09-13 01:18:26 | 1.1 KiB | |
| bconfig.h.in | 2018-01-22 00:00:47 | 2.4 KiB | |
| bootstrap | 2018-01-22 00:00:47 | 23 | |
| config.h.in | 2018-01-22 00:00:47 | 2.4 KiB | |
| configure | 2018-01-22 00:00:47 | 622.6 KiB | |
| configure.ac | 2018-01-22 00:00:47 | 7.8 KiB | |
| COPYING | 2013-09-13 01:18:26 | 4.4 KiB | |
| doc | 2018-01-22 00:00:47 | 6 | |
| INSTALL | 2013-09-13 01:18:26 | 7.2 KiB | |
| Kyuafile | 2018-01-22 00:00:47 | 227 | |
| m4 | 2018-01-22 00:00:47 | 16 | |
| Makefile.am | 2018-01-22 00:00:47 | 4.3 KiB | |
| Makefile.in | 2018-01-22 00:00:47 | 348 KiB | |
| NEWS | 2018-01-22 00:00:47 | 28.5 KiB | |
| README | 2011-02-26 03:26:33 | 1.5 KiB | |
| README.md | 2018-01-22 00:00:47 | 1.6 KiB | |
| test-programs | 2018-01-22 00:00:47 | 14 | |
| tools | 2018-01-22 00:00:47 | 92 |
README
Introductory information Automated Testing Framework
===========================================================================
Introduction
************
The Automated Testing Framework (ATF) is a collection of libraries and
utilities designed to ease unattended application testing in the hands of
developers and end users of a specific piece of software.
As regards developers, ATF provides the necessary means to easily create
test suites composed of multiple test programs, which in turn are a
collection of test cases. It also attempts to simplify the debugging of
problems when these test cases detect an error by providing as much
information as possible about the failure.
As regards users, it simplifies the process of running the test suites and,
in special, encourages end users to run them often: they do not need to
have source trees around nor any other development tools installed to be
able to certify that a given piece of software works on their machine as
advertised.
Other documents
***************
* AUTHORS: List of authors and contributors for this project.
* COPYING: License information.
* INSTALL: Compilation and installation instructions. These is not the
standard document shipped with many packages, so be sure to read it for
things that are specific to ATF's build.
* NEWS: List of major changes between formal, published releases.
===========================================================================
vim: filetype=text:textwidth=75:expandtab:shiftwidth=2:softtabstop=2
README.md
# Welcome to the ATF project!
ATF, or Automated Testing Framework, is a **collection of libraries** to
write test programs in **C, C++ and POSIX shell**.
The ATF libraries offer a simple API. The API is orthogonal through the
various bindings, allowing developers to quickly learn how to write test
programs in different languages.
ATF-based test programs offer a **consistent end-user command-line
interface** to allow both humans and automation to run the tests.
ATF-based test programs **rely on an execution engine** to be run and
this execution engine is *not* shipped with ATF.
**[Kyua](https://github.com/jmmv/kyua/) is the engine of choice.**
## Download
Formal releases for source files are available for download from GitHub:
* [atf 0.20](../../releases/tag/atf-0.20), released on February 7th, 2014.
## Installation
You are encouraged to install binary packages for your operating system
wherever available:
* Fedora 20 and above: install the `atf` package with `yum install atf`.
* FreeBSD 10.0 and above: install the `atf` package with `pkg install atf`.
* NetBSD with pkgsrc: install the `pkgsrc/devel/atf` package.
Should you want to build and install ATF from the source tree provided
here, follow the instructions in the [INSTALL file](INSTALL).
## Support
Please use the
[atf-discuss mailing list](https://groups.google.com/forum/#!forum/atf-discuss)
for any support inquiries related to `atf-c`, `atf-c++` or `atf-sh`.
If you have any questions on Kyua proper, please use the
[kyua-discuss mailing list](https://groups.google.com/forum/#!forum/kyua-discuss)
instead.