external/bsd/atf/dist/doc/atf.7.in

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007, 2008, 2009 The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd January 18, 2009
  30 .Dt ATF 7
  31 .Os
  32 .Sh NAME
  33 .Nm ATF
  34 .Nd introduction to the Automated Testing Framework
  35 .Sh DESCRIPTION
  36 The Automated Testing Framework
  37 .Pf ( Nm )
  38 is a collection of libraries and utilities designed to ease unattended
  39 application testing in the hands of developers and end users of a specific
  40 piece of software.
  41 .Pp
  42 As regards developers,
  43 .Nm
  44 provides the necessary means to easily create
  45 test suites composed of multiple test programs, which in turn are a
  46 collection of test cases.
  47 It also attempts to simplify the debugging of problems when these test
  48 cases detect an error by providing as much information as possible
  49 about the failure.
  50 .Pp
  51 As regards users, it simplifies the process of running the test suites and,
  52 in special, encourages end users to run them often: they do not need to
  53 have source trees around nor any other development tools installed to be
  54 able to certify that a given piece of software works on their machine as
  55 advertised.
  56 .Pp
  57 .Ss License
  58 .Nm
  59 is distributed under the terms of the TNF License, a 2-clause BSD license.
  60 For more details please see:
  61 .Bd -literal -offset indent
  62 .Pa __DOCDIR__/COPYING
  63 .Ed
  64 .Ss Components
  65 .Nm
  66 is a highly modular piece of software.
  67 It provides a couple of libraries to ease the implementation of test
  68 programs: one for the C and C++ languages and another one for shell
  69 scripts.
  70 It also includes multiple small utilities that follow the principle of
  71 doing a single thing but doing it right.
  72 This section outlines which these components are.
  73 .Pp
  74 Public utilities:
  75 .Bl -tag -width atfXtestXprogramXXXXX
  76 .It Xr atf-check 1
  77 Executes a command and checks that its exit code, its standard output
  78 and its standard error output match pre-specified expected values.
  79 .It Xr atf-compile 1
  80 Generates an executable test program based on the description of test
  81 cases written in shell scripting.
  82 .It Xr atf-config 1
  83 Queries static configuration information.
  84 .It Xr atf-report 1
  85 Converts the output of
  86 .Nm atf-run
  87 to user-friendly and/or machine-parseable reports.
  88 .It Xr atf-run 1
  89 Automates the execution of a series of test programs and collects their
  90 results in a unified report.
  91 .El
  92 .Pp
  93 Internal utilities:
  94 .Bl -tag -width atfXtestXprogramXXXXX
  95 .It Xr atf-cleanup 1
  96 Safely cleans up a work directory after a test case terminates.
  97 .It Xr atf-exec 1
  98 Executes a command in a controlled manner.
  99 .It Xr atf-format 1
 100 Reformats a text string to not overflow terminal boundaries.
 101 .El
 102 .Pp
 103 Programming interfaces:
 104 .Bl -tag -width atfXtestXprogramXXXXX
 105 .It Xr atf-c-api 3
 106 C programming interface for test programs.
 107 .It Xr atf-c++-api 3
 108 C++ programming interface for test programs.
 109 .It Xr atf-sh-api 3
 110 POSIX shell programming interface for test programs.
 111 .El
 112 .Pp
 113 Other:
 114 .Bl -tag -width atfXtestXprogramXXXXX
 115 .It Xr atf-formats 5
 116 Description of the machine-parseable data formats used by the tools.
 117 .It Xr atf-test-case 4
 118 Generic description of test cases, independent of the language they are
 119 implemented in.
 120 .It Xr atf-test-program 1
 121 Common interface provided by the test programs written using the
 122 .Nm
 123 libraries.
 124 .El
 125 .Ss Recommended reading order
 126 For end users wishing to run tests:
 127 .Bl -enum -compact
 128 .It
 129 .Xr atf-test-program 1
 130 .It
 131 .Xr atf-run 1
 132 .It
 133 .Xr atf-report 1
 134 .It
 135 .Xr atf-config 1
 136 .El
 137 .Pp
 138 For developers wanting to write their own tests:
 139 .Bl -enum -compact
 140 .It
 141 Everything recommended to users.
 142 .It
 143 .Xr atf-test-case 4
 144 .It
 145 .Xr atf-c-api 3
 146 .It
 147 .Xr atf-c++-api 3
 148 .It
 149 .Xr atf-sh-api 3
 150 .It
 151 .Xr atf-compile 1
 152 .It
 153 .Xr atf-check 1
 154 .El
 155 .Pp
 156 For those interested in
 157 .Nm
 158 internals:
 159 .Bl -enum -compact
 160 .It
 161 Everything recommended to users.
 162 .It
 163 Everything recommended to developers.
 164 .It
 165 .Xr atf-formats 5
 166 .It
 167 .Xr atf-cleanup 1
 168 .It
 169 .Xr atf-format 1
 170 .It
 171 .Xr atf-exec 1
 172 .El
 173 .Sh HISTORY
 174 .Nm
 175 started as a Google Summer of Code 2007 project mentored by The NetBSD
 176 Foundation.
 177 Its original goal was to provide a testing framework for The NetBSD
 178 Operating System, but it grew as an independent project because the
 179 framework itself did not need to be tied to a specific operating system.
 180 .Pp
 181 For more details on this subject, please see:
 182 .Bd -literal -offset indent
 183 .Pa __DOCDIR__/NEWS
 184 .Pa __DOCDIR__/ROADMAP
 185 .Ed
 186 .Sh AUTHORS
 187 For more details on the people that made
 188 .Nm
 189 possible, please see:
 190 .Bd -literal -offset indent
 191 .Pa __DOCDIR__/AUTHORS
 192 .Ed