1*b0d29bc4SBrooks Davis.\" Copyright 2012 The Kyua Authors. 2*b0d29bc4SBrooks Davis.\" All rights reserved. 3*b0d29bc4SBrooks Davis.\" 4*b0d29bc4SBrooks Davis.\" Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis.\" modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis.\" met: 7*b0d29bc4SBrooks Davis.\" 8*b0d29bc4SBrooks Davis.\" * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis.\" notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis.\" * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis.\" notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis.\" documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis.\" * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis.\" may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis.\" without specific prior written permission. 16*b0d29bc4SBrooks Davis.\" 17*b0d29bc4SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis.Dd October 13, 2014 29*b0d29bc4SBrooks Davis.Dt KYUA-TEST 1 30*b0d29bc4SBrooks Davis.Os 31*b0d29bc4SBrooks Davis.Sh NAME 32*b0d29bc4SBrooks Davis.Nm "kyua test" 33*b0d29bc4SBrooks Davis.Nd Runs tests 34*b0d29bc4SBrooks Davis.Sh SYNOPSIS 35*b0d29bc4SBrooks Davis.Nm 36*b0d29bc4SBrooks Davis.Op Fl -build-root Ar path 37*b0d29bc4SBrooks Davis.Op Fl -kyuafile Ar file 38*b0d29bc4SBrooks Davis.Op Fl -results-file Ar file 39*b0d29bc4SBrooks Davis.Op Ar test_filter1 .. test_filterN 40*b0d29bc4SBrooks Davis.Sh DESCRIPTION 41*b0d29bc4SBrooks DavisThe 42*b0d29bc4SBrooks Davis.Nm 43*b0d29bc4SBrooks Daviscommand loads a test suite definition from a 44*b0d29bc4SBrooks Davis.Xr kyuafile 5 , 45*b0d29bc4SBrooks Davisruns the tests defined in it, and records the results into a new results 46*b0d29bc4SBrooks Davisfile. 47*b0d29bc4SBrooks DavisBy default, all tests in the test suite are executed but the optional 48*b0d29bc4SBrooks Davisarguments to 49*b0d29bc4SBrooks Davis.Nm 50*b0d29bc4SBrooks Daviscan be used to select which test programs or test cases to run. 51*b0d29bc4SBrooks DavisThese are filters and are described below in 52*b0d29bc4SBrooks Davis.Sx Test filters . 53*b0d29bc4SBrooks Davis.Pp 54*b0d29bc4SBrooks DavisEvery test executed by 55*b0d29bc4SBrooks Davis.Nm 56*b0d29bc4SBrooks Davisis run under a controlled environment as described in 57*b0d29bc4SBrooks Davis.Sx Test isolation . 58*b0d29bc4SBrooks Davis.Pp 59*b0d29bc4SBrooks DavisThe following subcommand options are recognized: 60*b0d29bc4SBrooks Davis.Bl -tag -width XX 61*b0d29bc4SBrooks Davis.It Fl -build-root Ar path 62*b0d29bc4SBrooks DavisSpecifies the build root in which to find the test programs referenced by 63*b0d29bc4SBrooks Davisthe Kyuafile, if different from the Kyuafile's directory. 64*b0d29bc4SBrooks DavisSee 65*b0d29bc4SBrooks Davis.Sx Build directories 66*b0d29bc4SBrooks Davisbelow for more information. 67*b0d29bc4SBrooks Davis.It Fl -kyuafile Ar path , Fl k Ar path 68*b0d29bc4SBrooks DavisSpecifies the Kyuafile to process. 69*b0d29bc4SBrooks DavisDefaults to a 70*b0d29bc4SBrooks Davis.Pa Kyuafile 71*b0d29bc4SBrooks Davisfile in the current directory. 72*b0d29bc4SBrooks Davis.It Fl -results-file Ar path , Fl s Ar path 73*b0d29bc4SBrooks Davis__include__ results-file-flag-write.mdoc 74*b0d29bc4SBrooks Davis.El 75*b0d29bc4SBrooks Davis.Pp 76*b0d29bc4SBrooks DavisYou can later inspect the results of the test run in more detail by using 77*b0d29bc4SBrooks Davis.Xr kyua-report 1 78*b0d29bc4SBrooks Davisor you can execute a single test case with debugging functionality by using 79*b0d29bc4SBrooks Davis.Xr kyua-debug 1 . 80*b0d29bc4SBrooks Davis.Ss Build directories 81*b0d29bc4SBrooks Davis__include__ build-root.mdoc COMMAND=test 82*b0d29bc4SBrooks Davis.Ss Results files 83*b0d29bc4SBrooks Davis__include__ results-files.mdoc 84*b0d29bc4SBrooks Davis.Ss Test filters 85*b0d29bc4SBrooks Davis__include__ test-filters.mdoc 86*b0d29bc4SBrooks Davis.Ss Test isolation 87*b0d29bc4SBrooks Davis__include__ test-isolation.mdoc 88*b0d29bc4SBrooks Davis.Sh EXIT STATUS 89*b0d29bc4SBrooks DavisThe 90*b0d29bc4SBrooks Davis.Nm 91*b0d29bc4SBrooks Daviscommand returns 0 if all executed test cases pass or 1 if any of the 92*b0d29bc4SBrooks Davisexecuted test cases fails or if any of the given test case filters does not 93*b0d29bc4SBrooks Davismatch any test case. 94*b0d29bc4SBrooks Davis.Pp 95*b0d29bc4SBrooks DavisAdditional exit codes may be returned as described in 96*b0d29bc4SBrooks Davis.Xr kyua 1 . 97*b0d29bc4SBrooks Davis.Sh EXAMPLES 98*b0d29bc4SBrooks Davis__include__ results-files-report-example.mdoc REPORT_COMMAND=report 99*b0d29bc4SBrooks Davis.Sh SEE ALSO 100*b0d29bc4SBrooks Davis.Xr kyua 1 , 101*b0d29bc4SBrooks Davis.Xr kyua-report 1 , 102*b0d29bc4SBrooks Davis.Xr kyuafile 5 103