1GOGUI-REGRESS(1)                GoGui Reference               GOGUI-REGRESS(1)
2
3
4

NAME

6       gogui-regress - Runs GTP regression tests.
7

SYNOPSIS

9       gogui-regress [-config file] [-gtpfile file] [-long]
10                     [-output directory] [-verbose] program test.tst...
11
12       gogui-regress -help
13
14       gogui-regress -version
15

DESCRIPTION

17       Runs a list of regression tests for a Go program supporting the Go Text
18       Protocol, and formats the output as HTML. The regression tests are GTP
19       files, which use the special comment #?, as used for the GNU Go[1]
20       regression tests (see section Regression testing[2] of the GNU Go
21       documentation). The regular expression syntax for the expected
22       responses is mostly compatible to the one used by the GNU Go regression
23       test suite, see the documentation for java.util.regex.Pattern[3] for a
24       complete description.
25
26       Test names that start with a '@' are interpreted as files containing a
27       test suite. The file with the corresponding name (excluding the '@') is
28       read and every non-empty line that does not start with the comment
29       character '#' is added to the list of test names. The files are allowed
30       to contain names of other test suites.
31
32       The main output file is index.html. For each test file test.tst,
33       additional files with name test.html and test.out.html are generated.
34       Additionally, a text file summary.dat is generated, with a table row
35       containing the most important summary statistics. gogui-regress will
36       start a new instance of the Go program for each test and use the
37       directory of the test file as the working directory for the Go program.
38
39       The return value of gogui-regress is 0, if all tests completed
40       successfully with no unexpected fails, 1 if there was at least one
41       unexpected fail, and 2 if the Go program crashed or some other error
42       occurred.
43

OPTIONS

45       -config file
46           Read command line options and arguments from the given file.
47
48       -gtpfile file
49           File with GTP commands to execute before each test. This file can
50           be used to configure engine parameters. If a command from the file
51           fails, the program will exit with an error message.
52
53       -help
54           Display help and exit.
55
56       -long
57           Print longer output to standard output, one line per test.
58
59       -output directory
60           Write output files to the given directory.
61
62       -verbose
63           Print the GTP stream to the Go program to standard error.
64
65       -version
66           Print version and exit.
67

NOTES

69        1. GNU Go
70           http://www.gnu.org/software/gnugo/gnugo.html
71
72        2. Regression testing
73           http://www.gnu.org/software/gnugo/gnugo_20.html#SEC205
74
75        3. java.util.regex.Pattern
76           http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html
77
78
79
80GoGui 1.4.9                       02/10/2017                  GOGUI-REGRESS(1)
Impressum