xref: /netbsd-src/external/bsd/kyua-cli/dist/doc/kyua-test.1.in (revision 6b3a42af15b5e090c339512c790dd68f3d11a9d8)
1.\" Copyright 2012 Google Inc.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions are
6.\" met:
7.\"
8.\" * Redistributions of source code must retain the above copyright
9.\"   notice, this list of conditions and the following disclaimer.
10.\" * Redistributions in binary form must reproduce the above copyright
11.\"   notice, this list of conditions and the following disclaimer in the
12.\"   documentation and/or other materials provided with the distribution.
13.\" * Neither the name of Google Inc. nor the names of its contributors
14.\"   may be used to endorse or promote products derived from this software
15.\"   without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.Dd September 9, 2012
29.Dt KYUA-TEST 1
30.Os
31.Sh NAME
32.Nm test
33.Nd Runs tests
34.Sh SYNOPSIS
35.Nm
36.Op Fl -build-root Ar path
37.Op Fl -kyuafile Ar file
38.Op Fl -store Ar file
39.Op Ar test_filter1 .. test_filterN
40.Sh DESCRIPTION
41The
42.Nm
43command runs the tests of a test suite and records the results into the
44store in the form of a new action.
45.Pp
46The optional arguments to
47.Nm
48are used to select which test programs or test cases to run.  These are
49filters and are explained in more detail in
50.Xr kyua-test-filters 7 .
51.Pp
52The following subcommand options are recognized:
53.Bl -tag -width XX
54.It Fl -build-root Ar path
55Specifies the build root in which to find the test programs referenced by
56the Kyuafile, if different from the Kyuafile's directory.  See
57.Xr kyua-build-root 7
58for more information.
59.It Fl -kyuafile Ar path , Fl k Ar path
60Specifies the Kyuafile to process.  Defaults to a
61.Pa Kyuafile
62file in the current directory.
63.It Fl -store Ar path , Fl s Ar path
64Specifies the database to use.  Defaults to
65.Pa ~/.kyua/store.db .
66The database is created if it does not exist.
67.El
68.Pp
69Because
70.Nm
71records the result of the execution into the database, it does not provide
72much feedback on the activity of the program.  You can later inspect the
73results in more detail by using
74.Xr kyua-report 1
75or you can execute a single test case with debugging functionality by using
76.Xr kyua-debug 1 .
77.Sh EXIT STATUS
78The
79.Nm
80command returns 0 if all executed test cases pass or 1 if any of the
81executed test cases fails or if any of the given test case filters does not
82match any test case.
83.Pp
84Additional exit codes may be returned as described in
85.Xr kyua 1 .
86.Sh SEE ALSO
87.Xr kyua 1 ,
88.Xr kyua-report 1
89