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