b0d29bc47d
Having kyua in the base system will simplify automated testing in CI and eliminates bootstrapping issues on new platforms. The build of kyua is controlled by WITH(OUT)_TESTS_SUPPORT. Reviewed by: emaste Obtained from: CheriBSD Sponsored by: DARPA Differential Revision: https://reviews.freebsd.org/D24103
103 lines
3.5 KiB
Groff
103 lines
3.5 KiB
Groff
.\" Copyright 2012 The Kyua Authors.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions are
|
|
.\" met:
|
|
.\"
|
|
.\" * Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" * Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" * Neither the name of Google Inc. nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.Dd October 13, 2014
|
|
.Dt KYUA-TEST 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm "kyua test"
|
|
.Nd Runs tests
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl -build-root Ar path
|
|
.Op Fl -kyuafile Ar file
|
|
.Op Fl -results-file Ar file
|
|
.Op Ar test_filter1 .. test_filterN
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
command loads a test suite definition from a
|
|
.Xr kyuafile 5 ,
|
|
runs the tests defined in it, and records the results into a new results
|
|
file.
|
|
By default, all tests in the test suite are executed but the optional
|
|
arguments to
|
|
.Nm
|
|
can be used to select which test programs or test cases to run.
|
|
These are filters and are described below in
|
|
.Sx Test filters .
|
|
.Pp
|
|
Every test executed by
|
|
.Nm
|
|
is run under a controlled environment as described in
|
|
.Sx Test isolation .
|
|
.Pp
|
|
The following subcommand options are recognized:
|
|
.Bl -tag -width XX
|
|
.It Fl -build-root Ar path
|
|
Specifies the build root in which to find the test programs referenced by
|
|
the Kyuafile, if different from the Kyuafile's directory.
|
|
See
|
|
.Sx Build directories
|
|
below for more information.
|
|
.It Fl -kyuafile Ar path , Fl k Ar path
|
|
Specifies the Kyuafile to process.
|
|
Defaults to a
|
|
.Pa Kyuafile
|
|
file in the current directory.
|
|
.It Fl -results-file Ar path , Fl s Ar path
|
|
__include__ results-file-flag-write.mdoc
|
|
.El
|
|
.Pp
|
|
You can later inspect the results of the test run in more detail by using
|
|
.Xr kyua-report 1
|
|
or you can execute a single test case with debugging functionality by using
|
|
.Xr kyua-debug 1 .
|
|
.Ss Build directories
|
|
__include__ build-root.mdoc COMMAND=test
|
|
.Ss Results files
|
|
__include__ results-files.mdoc
|
|
.Ss Test filters
|
|
__include__ test-filters.mdoc
|
|
.Ss Test isolation
|
|
__include__ test-isolation.mdoc
|
|
.Sh EXIT STATUS
|
|
The
|
|
.Nm
|
|
command returns 0 if all executed test cases pass or 1 if any of the
|
|
executed test cases fails or if any of the given test case filters does not
|
|
match any test case.
|
|
.Pp
|
|
Additional exit codes may be returned as described in
|
|
.Xr kyua 1 .
|
|
.Sh EXAMPLES
|
|
__include__ results-files-report-example.mdoc REPORT_COMMAND=report
|
|
.Sh SEE ALSO
|
|
.Xr kyua 1 ,
|
|
.Xr kyua-report 1 ,
|
|
.Xr kyuafile 5
|