1.\" $OpenBSD: bsd.regress.mk.5,v 1.16 2018/09/26 09:34:23 bluhm Exp $ 2.\" 3.\" Copyright (c) 2002 Anil Madhavapeddy 4.\" Copyright (c) 2000 Marc Espie 5.\" 6.\" All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27.\" 28.Dd $Mdocdate: September 26 2018 $ 29.Dt BSD.REGRESS.MK 5 30.Os 31.Sh NAME 32.Nm bsd.regress.mk 33.Nd regression test master Makefile fragment 34.Sh SYNOPSIS 35.Fd .include <bsd.regress.mk> 36.Sh DESCRIPTION 37.Nm 38holds the standard routines used by the source regression tests. 39Some variables and targets are for its internal use only. 40The rest are documented here. 41.Pp 42Since this file also includes 43.Nm bsd.prog.mk , 44all of the usual 45.Ox 46Makefile variables may be used to build the regression 47test programs. 48.Sh TARGETS 49.Bl -tag -width regress 50.It Cm depend 51Build any dependencies required to carry out the current set 52of regression tests. 53.It Cm regress 54Executes all of the regression targets defined in the Makefile. 55If one of the tests fails, the line 56.Qq FAILED 57is printed to the standard output. 58By default, execution continues with the next test and, after running 59all the tests, 60.Sy make Cm regress 61exits with an exit status of 0 even if some of the tests failed. 62.It Cm run-regress-* 63Runs an individual regression test. 64If the exit status of the program indicates an error or timeout, 65then a failure is logged, otherwise the test is marked as a success. 66.El 67.Sh VARIABLES 68.Bl -tag -width Ds 69.It Ev REGRESS_CLEANUP 70If this variable is set, it contains a target that is executed 71after all regress targets. 72.It Ev REGRESS_FAIL_EARLY 73If this variable is set to anything but 74.Dq no , 75the 76.Cm regress 77target will abort as soon as a test fails. 78.It Ev REGRESS_LOG 79Points to the fully-qualified path of a file to which regression 80results are appended. 81Defaults to 82.Pa /dev/null . 83.It Ev REGRESS_MAXTIME 84Maximum limit of CPU seconds to spend on the regression test. 85Exceeding this time will result in a failure being logged. 86.It Ev REGRESS_ROOT_TARGETS 87Targets for which root access is required to run the test. 88The 89.Ev SUDO 90variable is invoked for these targets. 91See also 92.Ev SUDO . 93.It Ev REGRESS_SETUP 94If this variable is set, it contains a target that is executed 95before all regress targets. 96The other regress targets depend on this one to enforce setup before 97running each test. 98It is recommended to implement this target with a stamp file to 99execute it only once. 100.It Ev REGRESS_SKIP_SLOW 101If this variable is not empty, skip over all the regression 102tests which have been marked as being 'slow' using the 103.Ev REGRESS_SLOW_TARGETS 104variable. 105.It Ev REGRESS_SLOW_TARGETS 106Targets which are defined as 'slow'. 107All of these tests can be skipped by setting the 108.Ev REGRESS_SKIP_SLOW 109variable. 110.It Ev REGRESS_TARGETS 111Targets which are invoked to run the set of regression tests 112for this Makefile. 113Defaults to 114.Cm run-regress-${PROG} . 115.It Ev SUDO 116Location of a command used to switch to root for certain 117test targets which require it. 118See 119.Xr doas 1 . 120.El 121.Pp 122Some variables are intended to be set at runtime in the environment 123or in 124.Xr mk.conf 5 , 125but not in the regress Makefile itself. 126.Sh GUIDELINES 127If an individual test passes, 128.Sy make Ar testname 129should return with an exit status of 0. 130If it fails, it should return with a non-zero exit status. 131.Pp 132If a test cannot be executed because a package is not installed or 133some environment variable is not set, 134.Sy make Ar testname 135should print 136.Qq SKIPPED 137to stdout and exit with status 0. 138To skip everything, implement the 139.Cm regress 140target with a command that prints 141.Qq SKIPPED . 142.Pp 143Some tests may require a special setup on the test machine that has 144to be done manually before testing. 145This requirement has to be documented in the Makefile or in a 146.Pa README 147file. 148The test should find out whether the setup exists before running 149and print 150.Qq SKIPPED 151and exit if it is missing. 152.Pp 153Tests should not fail because an intended feature has not been 154implemented yet. 155To avoid such false failures, a test should show the reason, print 156.Qq DISABLED 157to stdout and exit with status 0. 158.Pp 159Tests must be able to run with an 160.Pa obj 161directory. 162In case the test is not linked to the build or the tester forgot 163to run 164.Sy make Cm obj 165before, this directory or symlink may not exist. 166Then the test should run anyway. 167.Pp 168Tests are executed with 169.Sy make Cm regress , 170but running 171.Sy make Cm all 172or 173.Sy make 174should have the same effect. 175Tests must be runnable by root, and may also succeed when run as a 176regular user. 177Tests must not assume they have a controlling tty, 178to allow them to be run by 179.Xr cron 8 . 180An individual regress test may create a pseudo tty if it needs one. 181.Pp 182Tests should use the binaries installed and the kernel running on 183the local system. 184They may use environment variables to test alternative binaries or 185remote kernels running on other machines. 186In some cases a test may need binaries or libraries or object files 187to be present in 188.Pa /usr/obj/ 189that exist only after 190.Sy make Cm build 191was run in 192.Pa /usr/src/ . 193The test must not assume that they have already been built, but 194should run 195.Sy make 196in the appropriate source directory as a dependency. 197For missing generated source or header files a target called 198.Sy make Cm generated 199is common. 200The 201.Pa /usr/src/ 202tree can be found with a relative path or with the 203.Ev BSDSRCDIR 204variable. 205.Sh SEE ALSO 206.Xr bsd.port.mk 5 207.Sh HISTORY 208The regression system originally came from 209.Nx , 210with many tests added by 211.Ox 212since. 213The current Makefile framework was written by Artur Grabowski 214and Marc Espie for 215.Ox 3.1 . 216.Sh BUGS AND LIMITATIONS 217The build system is unable to distinguish between timeouts due to 218.Ev REGRESS_MAXTIME 219being exceeded, or a genuine failure occurring. 220