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