share/man/man7/tests.7

   1 .\"     $FreeBSD$
   2 .\"     $NetBSD: tests.kyua.7,v 1.2 2013/07/20 21:39:59 wiz Exp $
   3 .\"
   4 .\" Copyright (c) 2010 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 June 2, 2019
  30 .Dt TESTS 7
  31 .Os
  32 .Sh NAME
  33 .Nm tests
  34 .Nd introduction to the
  35 .Fx
  36 Test Suite
  37 .Sh DESCRIPTION
  38 The
  39 .Fx
  40 Test Suite provides a collection of automated tests for two major purposes.
  41 On one hand, the test suite aids
  42 .Em developers
  43 to detect bugs and regressions when they modify the source tree.
  44 On the other hand, it allows
  45 .Em end users
  46 (and, in particular, system administrators) to verify that fresh installations
  47 of the
  48 .Fx
  49 operating system behave correctly on their hardware platform and also to ensure
  50 that the system does not suffer from regressions during regular operation and
  51 maintenance.
  52 .Pp
  53 The
  54 .Fx
  55 Test Suite can be found in the
  56 .Pa /usr/tests
  57 hierarchy.
  58 .Pp
  59 This manual page describes how to run the test suite and how to configure
  60 some of its optional features.
  61 For information on writing the tests, see
  62 .Xr atf 7 .
  63 .Ss Installing the test suite
  64 The test suite is installed by default as of
  65 .Fx
  66 11.0-RELEASE.
  67 .Pp
  68 If the
  69 .Pa /usr/tests
  70 directory is missing, then you will have to enable the build of the test
  71 suite, rebuild your system and install the results.
  72 You can do so by setting
  73 .Sq WITH_TESTS=yes
  74 in your
  75 .Pa /etc/src.conf
  76 file (see
  77 .Xr src.conf 5
  78 for details)
  79 and rebuilding the system as described in
  80 .Xr build 7 .
  81 .Ss When to run the tests?
  82 Before diving into the details of how to run the test suite, here are some
  83 scenarios in which you should run it:
  84 .Bl -bullet -offset indent
  85 .It
  86 After a fresh installation of
  87 .Fx
  88 to ensure that the system works correctly on your hardware platform.
  89 .It
  90 After an upgrade of
  91 .Fx
  92 to a different version to ensure that the new code works well on your
  93 hardware platform and that the upgrade did not introduce regressions in your
  94 configuration.
  95 .It
  96 After modifying the source tree to detect any new bugs and/or regressions.
  97 .It
  98 Periodically, maybe from a
  99 .Xr cron 8
 100 job, to ensure that any changes to the system (such as the installation of
 101 third-party packages or manual modifications to configuration files) do not
 102 introduce unexpected failures.
 103 .El
 104 .Ss Running the tests
 105 First, you will need to install the
 106 .Sq devel/kyua
 107 package from
 108 .Xr ports 7 .
 109 Then use the following command to run the whole test suite:
 110 .Bd -literal -offset indent
 111 $ kyua test -k /usr/tests/Kyuafile
 112 .Ed
 113 .Pp
 114 The above will iterate through all test programs in
 115 .Pa /usr/tests
 116 recursively, execute them, store their results and debugging data in Kyua's
 117 database (by default in
 118 .Pa ~/.kyua/store.db ) ,
 119 and print a summary of the results.
 120 This summary includes a brief count of all total tests run and how many of
 121 them failed.
 122 .Pp
 123 It is possible to restrict which tests to run by providing their names in
 124 the command line.
 125 For example, this would execute the tests for the
 126 .Xr cp 1
 127 and
 128 .Xr cut 1
 129 utilities:
 130 .Bd -literal -offset indent
 131 $ kyua test -k /usr/tests/Kyuafile bin/cp usr.bin/cut
 132 .Ed
 133 .Ss Obtaining reports of the tests execution
 134 Additional information about the test results can be retrieved
 135 by using Kyua's various reporting commands.
 136 For example, the following would print a plain-text report of the executed
 137 tests and show which ones failed:
 138 .Bd -literal -offset indent
 139 $ kyua report
 140 .Ed
 141 .Pp
 142 This example would generate an HTML report ready to be published on a
 143 web server:
 144 .Bd -literal -offset indent
 145 $ kyua report-html --output ~/public_html/tests
 146 .Ed
 147 .Pp
 148 For further details on the command-line interface of Kyua, please refer
 149 to its manual page
 150 .Xr kyua 1 .
 151 .Ss Configuring the tests
 152 Some test cases in the
 153 .Fx
 154 Test Suite require manual configuration by the administrator before they can be
 155 run.
 156 Unless certain properties are defined, the tests that require them will be
 157 skipped.
 158 .Pp
 159 Test suites are configured by defining their configuration
 160 variables in
 161 .Pa /usr/local/etc/kyua/kyua.conf .
 162 The format of this file is detailed in
 163 .Xr kyua.conf 5 .
 164 .Pp
 165 The following configuration variables are available in the
 166 .Fx
 167 Test Suite:
 168 .Bl -tag -width "allow_sysctl_side_effects"
 169 .It allow_devfs_side_effects
 170 If defined, enables tests that may destroy and recreate semipermanent device
 171 nodes, like disk devices.
 172 Without this variable, tests may still create and destroy devices nodes that
 173 are normally transient, like /dev/tap* and /dev/pts*, as long as they clean
 174 them up afterwards.
 175 However, tests that require this variable have a relaxed cleanup requirement;
 176 they must recreate any devices that they destroyed, but not necessarily with
 177 the same devnames.
 178 .It allow_sysctl_side_effects
 179 Enables tests that change globally significant
 180 .Xr sysctl 8
 181 variables.
 182 The tests will undo any changes in their cleanup phases.
 183 .It disks
 184 Must be set to a space delimited list of disk device nodes.
 185 Tests that need destructive access to disks must use these devices.
 186 Tests are not required to preserve any data present on these disks.
 187 .It fibs
 188 Must be set to a space delimited list of FIBs (routing tables).
 189 Tests that need to modify a routing table may use any of these.
 190 Tests will cleanup any new routes that they create.
 191 .El
 192 .Ss What to do if something fails?
 193 If there is
 194 .Em any failure
 195 during the execution of the test suite, please consider reporting it to the
 196 .Fx
 197 developers so that the failure can be analyzed and fixed.
 198 To do so, either send a message to the appropriate mailing list or file a
 199 problem report.
 200 For more details please refer to:
 201 .Bl -bullet -offset indent -compact
 202 .It
 203 .Lk https://lists.freebsd.org/ "FreeBSD Mailing Lists"
 204 .It
 205 .Lk https://www.freebsd.org/support.html "Problem Reporting"
 206 .El
 207 .Sh FILES
 208 .Bl -tag -compact -width usrXlocalXetcXkyuaXkyuaXconfXX
 209 .It Pa /usr/local/etc/kyua/kyua.conf
 210 System-wide configuration file for
 211 .Xr kyua 1 .
 212 .It Pa ~/.kyua/kyua.conf
 213 User-specific configuration file for
 214 .Xr kyua 1 ;
 215 overrides the system file.
 216 .It Pa ~/.kyua/store.db
 217 Default result database used by Kyua.
 218 .It Pa /usr/tests/
 219 Location of the
 220 .Fx
 221 Test Suite.
 222 .It Pa /usr/tests/Kyuafile
 223 Top-level test suite definition file.
 224 .El
 225 .Sh SEE ALSO
 226 .Xr kyua 1 ,
 227 .Xr atf 7 ,
 228 .Xr build 7
 229 .Sh HISTORY
 230 The
 231 .Fx
 232 Test Suite first appeared in
 233 .Fx 10.1 .
 234 .Pp
 235 The
 236 .Nm
 237 manual page first appeared in
 238 .Nx 6.0
 239 and was later ported to
 240 .Fx 10.1 .
 241 .Sh AUTHORS
 242 .An Julio Merino Aq Mt jmmv@FreeBSD.org