Widen mancheck to all of man and test-runner
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12125
This commit is contained in:
parent
f2e890ddfa
commit
a61c502907
|
@ -170,7 +170,7 @@ checkbashisms:
|
||||||
PHONY += mancheck
|
PHONY += mancheck
|
||||||
mancheck:
|
mancheck:
|
||||||
@if type mandoc > /dev/null 2>&1; then \
|
@if type mandoc > /dev/null 2>&1; then \
|
||||||
find ${top_srcdir}/man/man8 -type f -name '*[1-9]*' \
|
find ${top_srcdir}/man ${top_srcdir}/tests/test-runner/man -type f -name '*[1-9]*' \
|
||||||
-exec mandoc -Tlint -Werror {} \+; \
|
-exec mandoc -Tlint -Werror {} \+; \
|
||||||
else \
|
else \
|
||||||
echo "skipping mancheck because mandoc is not installed"; \
|
echo "skipping mancheck because mandoc is not installed"; \
|
||||||
|
|
|
@ -8,10 +8,9 @@
|
||||||
.\" source. A copy of the CDDL is also available via the Internet at
|
.\" source. A copy of the CDDL is also available via the Internet at
|
||||||
.\" http://www.illumos.org/license/CDDL.
|
.\" http://www.illumos.org/license/CDDL.
|
||||||
.\"
|
.\"
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2012 by Delphix. All rights reserved.
|
.\" Copyright (c) 2012 by Delphix. All rights reserved.
|
||||||
.\"
|
.\"
|
||||||
.Dd March 10, 2020
|
.Dd May 26, 2021
|
||||||
.Dt RUN 1
|
.Dt RUN 1
|
||||||
.Os
|
.Os
|
||||||
.
|
.
|
||||||
|
@ -45,24 +44,28 @@
|
||||||
.
|
.
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm
|
.Nm
|
||||||
command has three basic modes of operation. With neither
|
command has three basic modes of operation.
|
||||||
|
With neither
|
||||||
.Fl c
|
.Fl c
|
||||||
nor
|
nor
|
||||||
.Fl w ,
|
.Fl w ,
|
||||||
.Nm
|
.Nm
|
||||||
processes the arguments provided on
|
processes the arguments provided on
|
||||||
the command line, adding them to the list for this run. If a specified
|
the command line, adding them to the list for this run.
|
||||||
|
If a specified
|
||||||
.Ar pathname
|
.Ar pathname
|
||||||
is an executable file, it is added as a test. If a specified
|
is an executable file, it is added as a test.
|
||||||
|
If a specified
|
||||||
.Ar pathname
|
.Ar pathname
|
||||||
is a directory, the behavior depends upon the presence of
|
is a directory, the behavior depends upon the presence of
|
||||||
.Fl g .
|
.Fl g .
|
||||||
If
|
If
|
||||||
.Fl g
|
.Fl g
|
||||||
is specified, the directory is treated as a test group. See the
|
is specified, the directory is treated as a test group.
|
||||||
section on
|
See the section on
|
||||||
.Sy Test Groups
|
.Sy Test Groups
|
||||||
below. Without
|
below.
|
||||||
|
Without
|
||||||
.Fl g ,
|
.Fl g ,
|
||||||
.Nm
|
.Nm
|
||||||
simply descends into the directory looking for executable files.
|
simply descends into the directory looking for executable files.
|
||||||
|
@ -76,8 +79,8 @@ Rather than executing the tests and logging the results, the test configuration
|
||||||
is stored in a
|
is stored in a
|
||||||
.Ar runfile ,
|
.Ar runfile ,
|
||||||
which can be used in future invocations, or edited
|
which can be used in future invocations, or edited
|
||||||
to modify which tests are executed and which options are applied. Options
|
to modify which tests are executed and which options are applied.
|
||||||
included on the command line with
|
Options included on the command line with
|
||||||
.Fl w
|
.Fl w
|
||||||
become defaults in the
|
become defaults in the
|
||||||
.Ar runfile .
|
.Ar runfile .
|
||||||
|
@ -92,20 +95,23 @@ The tests are then executed, and the results are logged.
|
||||||
.
|
.
|
||||||
.Ss Test Groups
|
.Ss Test Groups
|
||||||
A test group is comprised of a set of executable files, all of which exist in
|
A test group is comprised of a set of executable files, all of which exist in
|
||||||
one directory. The options specified on the command line or in a
|
one directory.
|
||||||
|
The options specified on the command line or in a
|
||||||
.Ar runfile
|
.Ar runfile
|
||||||
apply to individual tests in the group. The exception is options pertaining to
|
apply to individual tests in the group.
|
||||||
pre and post scripts, which act on all tests as a group. Rather than running
|
The exception is options pertaining to pre and post scripts, which act on all tests as a group.
|
||||||
before and after each test, these scripts are run only once each at the start
|
Rather than running before and after each test,
|
||||||
and end of the test group.
|
these scripts are run only once each at the start and end of the test group.
|
||||||
.Ss Test Execution
|
.Ss Test Execution
|
||||||
The specified tests run serially, and are typically assigned results according
|
The specified tests run serially, and are typically assigned results according
|
||||||
to exit values. Tests that exit zero and non-zero are marked
|
to exit values.
|
||||||
|
Tests that exit zero and non-zero are marked
|
||||||
.Sy PASS
|
.Sy PASS
|
||||||
and
|
and
|
||||||
.Sy FAIL ,
|
.Sy FAIL ,
|
||||||
respectively. When a pre script fails for a test group, only the post script is
|
respectively.
|
||||||
executed, and the remaining tests are marked
|
When a pre script fails for a test group, only the post script is executed,
|
||||||
|
and the remaining tests are marked
|
||||||
.Sy SKIPPED .
|
.Sy SKIPPED .
|
||||||
Any test that exceeds
|
Any test that exceeds
|
||||||
its
|
its
|
||||||
|
@ -114,30 +120,31 @@ is terminated, and marked
|
||||||
.Sy KILLED .
|
.Sy KILLED .
|
||||||
.Pp
|
.Pp
|
||||||
By default, tests are executed with the credentials of the
|
By default, tests are executed with the credentials of the
|
||||||
.Sy
|
.Nm
|
||||||
script.
|
script.
|
||||||
Executing tests with other credentials is done via
|
Executing tests with other credentials is done via
|
||||||
.Xr sudo 1m ,
|
.Xr sudo 1m ,
|
||||||
which must
|
which must
|
||||||
be configured to allow execution without prompting for a password. Environment
|
be configured to allow execution without prompting for a password.
|
||||||
variables from the calling shell are available to individual tests. During test
|
Environment variables from the calling shell are available to individual tests.
|
||||||
execution, the working directory is changed to
|
During test execution, the working directory is changed to
|
||||||
.Ar outputdir .
|
.Ar outputdir .
|
||||||
.
|
.
|
||||||
.Ss Output Logging
|
.Ss Output Logging
|
||||||
By default,
|
By default,
|
||||||
.Nm
|
.Nm
|
||||||
will print one line on standard output at the conclusion
|
will print one line on standard output at the conclusion
|
||||||
of each test indicating the test name, result and elapsed time. Additionally,
|
of each test indicating the test name, result and elapsed time.
|
||||||
for each invocation of
|
Additionally, for each invocation of
|
||||||
.Nm ,
|
.Nm ,
|
||||||
a directory is created using the ISO 8601
|
a directory is created using the ISO 8601 date format.
|
||||||
date format. Within this directory is a file named
|
Within this directory is a file named
|
||||||
.Sy log
|
.Sy log
|
||||||
containing all the
|
containing all the
|
||||||
test output with timestamps, and a directory for each test. Within the test
|
test output with timestamps, and a directory for each test.
|
||||||
directories, there is one file each for standard output, standard error and
|
Within the test directories, there is one file each for standard output,
|
||||||
merged output. The default location for the
|
standard error and merged output.
|
||||||
|
The default location for the
|
||||||
.Ar outputdir
|
.Ar outputdir
|
||||||
is
|
is
|
||||||
.Pa /var/tmp/test_results .
|
.Pa /var/tmp/test_results .
|
||||||
|
@ -150,11 +157,12 @@ The file has one section named
|
||||||
which contains configuration option
|
which contains configuration option
|
||||||
names and their values in
|
names and their values in
|
||||||
.Sy name No = Ar value
|
.Sy name No = Ar value
|
||||||
format. The values in this section
|
format.
|
||||||
apply to all the subsequent sections, unless they are also specified there, in
|
The values in this section apply to all the subsequent sections,
|
||||||
which case the default is overridden. The remaining section names are the
|
unless they are also specified there, in which case the default is overridden.
|
||||||
absolute pathnames of files and directories, describing tests and test groups
|
The remaining section names are the absolute pathnames of files and directories,
|
||||||
respectively. The legal option names are:
|
describing tests and test groups respectively.
|
||||||
|
The legal option names are:
|
||||||
.Bl -tag -width "tests = ['filename', …]"
|
.Bl -tag -width "tests = ['filename', …]"
|
||||||
.It Sy outputdir No = Ar pathname
|
.It Sy outputdir No = Ar pathname
|
||||||
The name of the directory that holds test logs.
|
The name of the directory that holds test logs.
|
||||||
|
@ -176,11 +184,12 @@ Execute the post script as
|
||||||
If
|
If
|
||||||
.Sy True ,
|
.Sy True ,
|
||||||
only the results summary is printed to standard out.
|
only the results summary is printed to standard out.
|
||||||
.It Sy tests No = [ Ns Ar 'filename' Ns , …]
|
.It Sy tests No = [ Ns Ar 'filename' , No … ]
|
||||||
Specify a list of
|
Specify a list of
|
||||||
.Ar filenames
|
.Ar filenames
|
||||||
for this test group. Only the basename of the
|
for this test group.
|
||||||
absolute path is required. This option is only valid for test groups, and each
|
Only the basename of the absolute path is required.
|
||||||
|
This option is only valid for test groups, and each
|
||||||
.Ar filename
|
.Ar filename
|
||||||
must be single quoted.
|
must be single quoted.
|
||||||
.It Sy timeout No = Ar n
|
.It Sy timeout No = Ar n
|
||||||
|
@ -199,8 +208,8 @@ Specify a
|
||||||
.Ar runfile
|
.Ar runfile
|
||||||
to be consumed by the run command.
|
to be consumed by the run command.
|
||||||
.It Fl d
|
.It Fl d
|
||||||
Dry run mode. Execute no tests, but print a description of each test that would
|
Dry run mode.
|
||||||
have been run.
|
Execute no tests, but print a description of each test that would have been run.
|
||||||
.It Fl g
|
.It Fl g
|
||||||
Create test groups from any directories found while searching for tests.
|
Create test groups from any directories found while searching for tests.
|
||||||
.It Fl o Ar outputdir
|
.It Fl o Ar outputdir
|
||||||
|
@ -217,13 +226,15 @@ after any test or test group.
|
||||||
Print only the results summary to the standard output.
|
Print only the results summary to the standard output.
|
||||||
.It Fl s Ar script
|
.It Fl s Ar script
|
||||||
Run
|
Run
|
||||||
.Ar script as a failsafe after any test is killed.
|
.Ar script
|
||||||
|
as a failsafe after any test is killed.
|
||||||
.It Fl S Ar username
|
.It Fl S Ar username
|
||||||
Execute the failsafe script as
|
Execute the failsafe script as
|
||||||
.Ar username .
|
.Ar username .
|
||||||
.It Fl t Ar n
|
.It Fl t Ar n
|
||||||
Specify a timeout value of
|
Specify a timeout value of
|
||||||
.Ar n seconds per test.
|
.Ar n
|
||||||
|
seconds per test.
|
||||||
.It Fl u Ar username
|
.It Fl u Ar username
|
||||||
Execute tests or test groups as
|
Execute tests or test groups as
|
||||||
.Ar username .
|
.Ar username .
|
||||||
|
@ -241,7 +252,7 @@ Execute the post script as
|
||||||
.
|
.
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
.Bl -tag -width "-h"
|
.Bl -tag -width "-h"
|
||||||
.It Sy Example 1 Ns : Running ad-hoc tests.
|
.It Sy Example 1 : No Running ad-hoc tests.
|
||||||
This example demonstrates the simplest invocation of
|
This example demonstrates the simplest invocation of
|
||||||
.Nm .
|
.Nm .
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
|
@ -257,7 +268,7 @@ Running Time: 00:00:07
|
||||||
Percent passed: 100.0%
|
Percent passed: 100.0%
|
||||||
Log directory: /var/tmp/test_results/20120923T180654
|
Log directory: /var/tmp/test_results/20120923T180654
|
||||||
.Ed
|
.Ed
|
||||||
.It Sy Example 2 Ns : Creating a Ar runfile No for future use.
|
.It Sy Example 2 : No Creating a Ar runfile No for future use.
|
||||||
This example demonstrates creating a
|
This example demonstrates creating a
|
||||||
.Ar runfile
|
.Ar runfile
|
||||||
with non-default options.
|
with non-default options.
|
||||||
|
|
Loading…
Reference in New Issue