diff options
Diffstat (limited to 'man/mysql-test-run.pl.1')
| -rw-r--r-- | man/mysql-test-run.pl.1 | 1128 |
1 files changed, 461 insertions, 667 deletions
diff --git a/man/mysql-test-run.pl.1 b/man/mysql-test-run.pl.1 index cd8fec1d287..b9c3fcb6421 100644 --- a/man/mysql-test-run.pl.1 +++ b/man/mysql-test-run.pl.1 @@ -2,12 +2,12 @@ .\" Title: \fBmysql-test-run.pl\fR .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 10/29/2009 +.\" Date: 03/31/2010 .\" Manual: MySQL Database System .\" Source: MySQL .\" Language: English .\" -.TH "\FBMYSQL\-TEST\-RUN\" "1" "10/29/2009" "MySQL" "MySQL Database System" +.TH "\FBMYSQL\-TEST\-RUN\" "1" "03/31/2010" "MySQL" "MySQL Database System" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -30,8 +30,7 @@ The \fBmysql\-test\-run\&.pl\fR Perl script is the main application used to run the MySQL test suite\&. It invokes \fBmysqltest\fR -to run individual test cases\&. (Prior to MySQL 4\&.1, a similar shell script, -\fBmysql\-test\-run\fR, can be used instead\&.) +to run individual test cases\&. .PP Invoke \fBmysql\-test\-run\&.pl\fR @@ -84,7 +83,7 @@ shell> \fBmysql\-test\-run\&.pl t/mytest\&.test\fR .RE .\} .PP -As of MySQL 5\&.1\&.23, a suite name can be given as part of the test name\&. That is, the syntax for naming a test is: +A suite name can be given as part of the test name\&. That is, the syntax for naming a test is: .sp .if n \{\ .RS 4 @@ -98,7 +97,14 @@ As of MySQL 5\&.1\&.23, a suite name can be given as part of the test name\&. Th .PP If a suite name is given, \fBmysql\-test\-run\&.pl\fR -looks in that suite for the test\&. With no suite name, +looks in that suite for the test\&. The test file corresponding to a test named +\fIsuite_name\&.test_name\fR +is found in +suite/\fIsuite_name\fR/t/\fItest_name\fR\&.test\&. There is also an implicit suite name +main +for the tests in the top +t +directory\&. With no suite name, \fBmysql\-test\-run\&.pl\fR looks in the default list of suites for a match and runs the test in any suites where it finds the test\&. Suppose that the default suite list is main, @@ -131,11 +137,11 @@ rpl)\&. \fB\-\-skip\-test\fR has the opposite effect of skipping test cases for which the names share a common prefix\&. .PP -As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the +The argument for the \fB\-\-do\-test\fR and \fB\-\-skip\-test\fR -options allows more flexible specification of which tests to perform or skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, +options also allows more flexible specification of which tests to perform or skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, \fB\-\-do\-test=testa\fR matches tests that begin with testa, @@ -150,7 +156,7 @@ main followed by testa with anything in between\&. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as -xmainytestz\&. +xmainytesta\&. .PP To perform setup prior to running tests, \fBmysql\-test\-run\&.pl\fR @@ -160,8 +166,7 @@ with the \fB\-\-bootstrap\fR and \fB\-\-skip\-grant\-tables\fR -options (see -\m[blue]\fBTypical \fBconfigure\fR Options\fR\m[]\&\s-2\u[1]\d\s+2)\&. If MySQL was configured with the +options\&. If MySQL was configured with the \fB\-\-disable\-grant\-options\fR option, \fB\-\-bootstrap\fR, @@ -217,28 +222,11 @@ shell> \fB\&./mysqltest\-run\&.pl \-\-force \-\-timer \-\-ps\-protocol\fR .RE .\} .PP -If you have a copy of -\fBmysqld\fR -running on the machine where you want to run the test suite, you do not have to stop it, as long as it is not using ports -9306 -or -9307\&. If either of those ports is taken, you should set the -MTR_BUILD_THREAD -environment variable to an appropriate value, and the test suite will use a different set of ports for master, slave, NDB, and Instance Manager)\&. For example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -shell> \fBexport MTR_BUILD_THREAD=31\fR -shell> \fB\&./mysql\-test\-run\&.pl [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB]\fR -.fi -.if n \{\ -.RE -.\} -.PP \fBmysql\-test\-run\&.pl\fR -defines several environment variables\&. Some of them are listed in the following table\&. +uses several environment variables\&. Some of them are listed in the following table\&. Some of these are set from the outside and used by +\fBmysql\-test\-run\&.pl\fR, others are set by +\fBmysql\-test\-run\&.pl\fR +instead, and may be referred to in tests\&. .TS allbox tab(:); l l @@ -246,6 +234,12 @@ l l l l l l l l +l l +l l +l l +l l +l l +l l l l. T{ \fBVariable\fR @@ -253,15 +247,52 @@ T}:T{ \fBMeaning\fR T} T{ -MYSQL_TEST +MTR_VERSION T}:T{ -Path name to \fBmysqltest\fR binary +If set to 1, will run the older version 1 of + \fBmysql\-test\-run\&.pl\fR\&. This will affect + what functionailty is available and what command line + options are supported\&. T} T{ -MYSQLTEST_VARDIR +MTR_MEM T}:T{ -Path name to the var directory that is used for - logs, temporary files, and so forth +If set to anything, will run tests with files in "memory" using tmpfs or + ramdisk\&. Not available on Windows\&. Same as + \fB\-\-mem\fR option +T} +T{ +MTR_PARALLEL +T}:T{ +If set, defines number of parallel threads executing tests\&. Same as + \fB\-\-parallel\fR option +T} +T{ +MTR_BUILD_THREAD +T}:T{ +If set, defines which port number range is used for the server +T} +T{ +MTR_PORT_BASE +T}:T{ +If set, defines which port number range is used for the server +T} +T{ +MTR_\fINAME\fR_TIMEOUT +T}:T{ +Setting of a timeout in minutes or seconds, corresponding to command + line option + \fB\-\-\fR\fB\fIname\fR\fR\fB\-timeout\fR\&. + Avaliable timeout names are TESTCASE, + SUITE (both in minutes) and + START, SHUTDOWN + (both in seconds)\&. These variables are supported from + MySQL 5\&.1\&.44\&. +T} +T{ +MYSQL_TEST +T}:T{ +Path name to \fBmysqltest\fR binary T} T{ MYSQLD_BOOTSTRAP @@ -269,18 +300,31 @@ T}:T{ Full path name to \fBmysqld\fR that has all options enabled T} T{ -MASTER_MYPORT +MYSQLTEST_VARDIR +T}:T{ +Path name to the var directory that is used for + logs, temporary files, and so forth +T} +T{ +MYSQL_TEST_DIR T}:T{ -??? +Full path to the mysql\-test directory where tests + are being run from T} T{ -MASTER_MYSOCK +MYSQL_TMP_DIR T}:T{ -??? +Path to temp directory used for temporary files during tests T} .TE .sp 1 .PP +The variable +MTR_PORT_BASE +was added in MySQL 5\&.1\&.45 as a more logical replacement for +MTR_BUILD_THREAD\&. It gives the actual port number directly (will be rounded down to a multiple of 10)\&. If you use +MTR_BUILD_THREAD, the port number is found by multiplying this by 10 and adding 10000\&. +.PP Tests sometimes rely on certain environment variables being defined\&. For example, certain tests assume that MYSQL_TEST is defined so that @@ -288,16 +332,23 @@ is defined so that can invoke itself with exec $MYSQL_TEST\&. .PP +Other tests may refer to the last three variables listed in the preceeding table, to locate files to read or write\&. For example, tests that need to create files will typically put them in +$MYSQL_TMP_DIR/\fIfile_name\fR\&. +.PP +If you are running +\fBmysql\-test\-run\&.pl\fR +version 1 by setting +MTR_VERSION, note that this only affects the test driver, not the test client (and its language) or the tests themselves\&. +.PP +A few tests might not run with version 1 because they depend on some feature of version 2\&. You may have those tests skipped by adding the test name to the file +lib/v1/incompatible\&.tests\&. This feature is available from MySQL 5\&.1\&.40\&. +.PP \fBmysql\-test\-run\&.pl\fR supports the options in the following list\&. An argument of \fB\-\-\fR tells \fBmysql\-test\-run\&.pl\fR -not to process any following arguments as options\&. (A description of differences between the options supported by -\fBmysql\-test\-run\&.pl\fR -and -\fBmysql\-test\-run\fR -appears following the list\&.) +not to process any following arguments as options\&. .sp .RS 4 .ie n \{\ @@ -323,11 +374,16 @@ Display a help message and exit\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: bench option -.\" bench option: mysql-test-run.pl -\fB\-\-bench\fR +.\" mysql-test-run.pl: big-test option +.\" big-test option: mysql-test-run.pl +\fB\-\-big\-test\fR .sp -Run the benchmark suite\&. +Allow tests marked as "big" to run\&. Tests can be thus marked by including the line +\fB\-\-source include/big_test\&.inc\fR, and they will only be run if this option is given, or if the environment variable +BIG_TEST +is set to 1\&. +.sp +This is typically done for tests that take very long to run, or that use very much resources, so that they are not suitable for running as part of a normal test suite run\&. .RE .sp .RS 4 @@ -338,12 +394,25 @@ Run the benchmark suite\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: benchdir option -.\" benchdir option: mysql-test-run.pl -\fB\-\-benchdir=\fR\fB\fIpath\fR\fR +.\" mysql-test-run.pl: build-thread option +.\" build-thread option: mysql-test-run.pl +\fB\-\-build\-thread=\fR\fB\fInumber\fR\fR +.sp +Specify a number to calculate port numbers from\&. The formula is 10 * +\fIbuild_thread\fR ++ 10000\&. Instead of a number, it can be set to +auto, which is also the default value, in which case +\fBmysql\-test\-run\&.pl\fR +will allocate a number unique to this host\&. +.sp +The value (number or +auto) can also be set with the +MTR_BUILD_THREAD +environment variable\&. .sp -The directory where the benchmark suite is located\&. The default path is -\&.\&./\&.\&./mysql\-bench\&. +From MySQL 5\&.1\&.45, the more logical +\fB\-\-port\-base\fR +is supported as an alternative\&. .RE .sp .RS 4 @@ -354,14 +423,14 @@ The directory where the benchmark suite is located\&. The default path is .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: big option -.\" big option: mysql-test-run.pl -\fB\-\-big\-test\fR +.\" mysql-test-run.pl: callgrind option +.\" callgrind option: mysql-test-run.pl +\fB\-\-callgrind\fR .sp -Pass the -\fB\-\-big\-test\fR -option to -\fBmysqltest\fR\&. +Instructs +\fBvalgrind\fR +to use +\fBcallgrind\fR\&. .RE .sp .RS 4 @@ -376,7 +445,7 @@ option to .\" check-testcases option: mysql-test-run.pl \fB\-\-check\-testcases\fR .sp -Check test cases for side effects\&. +Check test cases for side effects\&. This is done by checking system state before and after each test case; if there is any difference, a warning to that effect will be written, but the test case will not be marked as failed because of it\&. This check is enabled by default\&. .RE .sp .RS 4 @@ -389,9 +458,9 @@ Check test cases for side effects\&. .\} .\" mysql-test-run.pl: client-bindir option .\" client-bindir option: mysql-test-run.pl -\fB\-\-client\-bindir\fR +\fB\-\-client\-bindir=\fR\fB\fIpath\fR\fR .sp -The path to the directory where client binaries are located\&. This option was added in MySQL 5\&.0\&.66/5\&.1\&.27\&. +The path to the directory where client binaries are located\&. .RE .sp .RS 4 @@ -423,7 +492,7 @@ debugger\&. .\} .\" mysql-test-run.pl: client-debugger option .\" client-debugger option: mysql-test-run.pl -\fB\-\-client\-debugger\fR +\fB\-\-client\-debugger=\fR\fB\fIdebugger\fR\fR .sp Start \fBmysqltest\fR @@ -459,9 +528,9 @@ debugger\&. .\} .\" mysql-test-run.pl: client-libdir option .\" client-libdir option: mysql-test-run.pl -\fB\-\-client\-libdir\fR +\fB\-\-client\-libdir=\fR\fB\fIpath\fR\fR .sp -The path to the directory where client libraries are located\&. This option was added in MySQL 5\&.0\&.66/5\&.1\&.27\&. +The path to the directory where client libraries are located\&. .RE .sp .RS 4 @@ -493,8 +562,6 @@ is to create a combinations file in the suite directory\&. The file should contain a section of options for each test run\&. See Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltest\(rq\&. -.sp -This option was added in MySQL 5\&.1\&.23/6\&.0\&.4\&. .RE .sp .RS 4 @@ -511,7 +578,8 @@ This option was added in MySQL 5\&.1\&.23/6\&.0\&.4\&. .sp Write \fIstr\fR -to the output\&. +to the output within lines filled with +#, as a form of banner\&. .RE .sp .RS 4 @@ -593,7 +661,7 @@ Dump trace output for all clients and servers\&. .\} .\" mysql-test-run.pl: debugger option .\" debugger option: mysql-test-run.pl -\fB\-\-debugger\fR +\fB\-\-debugger=\fR\fB\fIdebugger\fR\fR .sp Start \fBmysqld\fR @@ -627,7 +695,37 @@ does not fail if Debug Sync is not compiled in\&. For information about using the Debug Sync facility for testing, see Section\ \&4.14, \(lqThread Synchronization in Test Cases\(rq\&. .sp -This option was added in MySQL 5\&.4\&.4/6\&.0\&.6\&. +This option was added in MySQL 5\&.1\&.41/5\&.5\&.0/6\&.0\&.6\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: defaults-file option +.\" default-file option: mysql-test-run.pl +\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR +.sp +Use the named file as fixed config file template for all tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: defaults_extra_file option +.\" default_extra_file option: mysql-test-run.pl +\fB\-\-defaults_extra_file=\fR\fB\fIfile_name\fR\fR +.sp +Add setting from the named file to all generated configs\&. .RE .sp .RS 4 @@ -646,9 +744,9 @@ Run all test cases having a name that begins with the given \fIprefix\fR value\&. This option provides a convenient way to run a family of similarly named tests\&. .sp -As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the +The argument for the \fB\-\-do\-test\fR -option allows more flexible specification of which tests to perform\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, +option also allows more flexible specification of which tests to perform\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example, \fB\-\-do\-test=testa\fR matches tests that begin with testa, @@ -691,6 +789,23 @@ built with the embedded server\&. .sp -1 .IP \(bu 2.3 .\} +.\" mysql-test-run.pl: enable-disabled option +.\" enable-disabled option: mysql-test-run.pl +\fB\-\-enable\-disabled\fR +.sp +Ignore any +disabled\&.def +file, and run also tests marked as disbaled\&. Success or failure of those tests will be reported the same way as other tests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} .\" mysql-test-run.pl: experimental option .\" experimental option: mysql-test-run.pl \fB\-\-experimental=\fR\fB\fIfile_name\fR\fR @@ -699,7 +814,7 @@ Specify a file that contains a list of test cases that should be displayed with [ exp\-fail ] code rather than [ fail ] -if they fail\&. This option was added in MySQL 5\&.1\&.33/6\&.0\&.11\&. +if they fail\&. This option was added in MySQL 5\&.1\&.33\&. .sp For an example of a file that might be specified via this option, see mysql\-test/collections/default\&.experimental\&. @@ -716,8 +831,25 @@ mysql\-test/collections/default\&.experimental\&. .\" mysql-test-run.pl: extern option .\" extern option: mysql-test-run.pl \fB\-\-extern\fR +\fIoption\fR=\fIvalue\fR .sp -Use an already running server\&. +Use an already running server\&. The option/value pair is what is needed by the +\fBmysql\fR +client to connect to the server\&. Each +\fB\-\-extern\fR +can only take one option/value pair as argument, so it you need more you need to repeat +\fB\-\-extern\fR +for each of them\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \&./mysql\-test\-run\&.pl \-\-extern socket=var/tmp/mysqld\&.1\&.sock alias +.fi +.if n \{\ +.RE +.\} .sp Note: If a test case has an \&.opt @@ -736,7 +868,8 @@ file that requires the server to be restarted with specific options, the file wi .\" fast option: mysql-test-run.pl \fB\-\-fast\fR .sp -Do not clean up from earlier test runs\&. +Do not perform controlled shutdown when servers need to be restarted or at the end of the test run\&. This is equivalent to using +\-\-shutdown\-timeout=0\&. .RE .sp .RS 4 @@ -809,6 +942,8 @@ debugger\&. Run tests with the \fBgprof\fR profiling tool\&. +\fB\-\-gprof\fR +was added in 5\&.1\&.45\&. .RE .sp .RS 4 @@ -819,12 +954,13 @@ profiling tool\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: im-mysqld1-port option -.\" im-mysqld1-port option: mysql-test-run.pl -\fB\-\-im\-mysqld1\-port\fR +.\" mysql-test-run.pl: manual-ddd option +.\" manual-ddd option: mysql-test-run.pl +\fB\-\-manual\-ddd\fR .sp -TCP/IP port number to use for the first -\fBmysqld\fR, controlled by Instance Manager\&. +Use a server that has already been started by the user in the +\fBddd\fR +debugger\&. .RE .sp .RS 4 @@ -835,12 +971,11 @@ TCP/IP port number to use for the first .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: im-mysqld2-port option -.\" im-mysqld2-port option: mysql-test-run.pl -\fB\-\-im\-mysqld2\-port\fR +.\" mysql-test-run.pl: manual-debug option +.\" manual-debug option: mysql-test-run.pl +\fB\-\-manual\-debug\fR .sp -TCP/IP port number to use for the second -\fBmysqld\fR, controlled by Instance Manager\&. +Use a server that has already been started by the user in a debugger\&. .RE .sp .RS 4 @@ -851,12 +986,13 @@ TCP/IP port number to use for the second .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: im-port option -.\" im-port option: mysql-test-run.pl -\fB\-\-im\-port\fR +.\" mysql-test-run.pl: manual-gdb option +.\" manual-gdb option: mysql-test-run.pl +\fB\-\-manual\-gdb\fR .sp -TCP/IP port number to use for -\fBmysqld\fR, controlled by Instance Manager\&. +Use a server that has already been started by the user in the +\fBgdb\fR +debugger\&. .RE .sp .RS 4 @@ -867,14 +1003,12 @@ TCP/IP port number to use for .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: log-warnings option -.\" log-warnings option: mysql-test-run.pl -\fB\-\-log\-warnings\fR +.\" mysql-test-run.pl: mark-progress option +.\" mark-progress option: mysql-test-run.pl +\fB\-\-mark\-progress\fR .sp -Pass the -\fB\-\-log\-warnings\fR -option to -\fBmysqld\fR\&. +Marks progress with timing (in milliseconds) and line number in +var/log/\fItestname\fR\&.progress\&. .RE .sp .RS 4 @@ -885,11 +1019,14 @@ option to .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: manual-debug option -.\" manual-debug option: mysql-test-run.pl -\fB\-\-manual\-debug\fR +.\" mysql-test-run.pl: max-connections option +.\" max-connections option: mysql-test-run.pl +\fB\-\-max\-connections=\fR\fB\fInum\fR\fR .sp -Use a server that has already been started by the user in a debugger\&. +The maximum number of simultaneous server connections that may be used per test\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&. Corresponds to the same option for +\fBmysqltest\fR\&. +.sp +This option is available from MySQL 5\&.1\&.45\&. .RE .sp .RS 4 @@ -900,13 +1037,12 @@ Use a server that has already been started by the user in a debugger\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: manual-gdb option -.\" manual-gdb option: mysql-test-run.pl -\fB\-\-manual\-gdb\fR +.\" mysql-test-run.pl: max-save-core option +.\" max-save-core option: mysql-test-run.pl +\fB\-\-max\-save\-core=\fR\fB\fIN\fR\fR .sp -Use a server that has already been started by the user in the -\fBgdb\fR -debugger\&. +Limit the number of core files saved, to avoid filling up disks in case of a frequently crashing server\&. Defaults to 5, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_SAVE_CORE .RE .sp .RS 4 @@ -917,13 +1053,12 @@ debugger\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: master-binary option -.\" master-binary option: mysql-test-run.pl -\fB\-\-master\-binary=\fR\fB\fIpath\fR\fR +.\" mysql-test-run.pl: max-save-datadir option +.\" max-save-datadir option: mysql-test-run.pl +\fB\-\-max\-save\-datadir=\fR\fB\fIN\fR\fR .sp -Specify the path of the -\fBmysqld\fR -binary to use for master servers\&. +Limit the number of data directories saved after failed tests, to avoid filling up disks in case of frequent failures\&. Defaults to 20, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_SAVE_DATADIR .RE .sp .RS 4 @@ -934,11 +1069,12 @@ binary to use for master servers\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: master_port option -.\" master_port option: mysql-test-run.pl -\fB\-\-master_port=\fR\fB\fIport_num\fR\fR +.\" mysql-test-run.pl: max-test-fail option +.\" max-test-fail option: mysql-test-run.pl +\fB\-\-max\-test\-fail=\fR\fB\fIN\fR\fR .sp -Specify the TCP/IP port number for the first master server to use\&. Observe that the option name has an underscore and not a dash\&. +Stop execution after the specified number of tests have failed, to avoid using up resources (and time) in case of massive failures\&. retries are noe counted, nor are failures of tests marked experimental\&. Defaults to 10, set to 0 for no limit\&. May also be set with the environment variable +MTR_MAX_TEST_FAIL .RE .sp .RS 4 @@ -953,7 +1089,9 @@ Specify the TCP/IP port number for the first master server to use\&. Observe tha .\" mem option: mysql-test-run.pl \fB\-\-mem\fR .sp -Run the test suite in memory, using tmpfs or ramdisk\&. This can decrease test times significantly\&. +This option is not supported on Windows\&. +.sp +Run the test suite in memory, using tmpfs or ramdisk\&. This can decrease test times significantly, in particular if you would otherwise be running over a remote file system\&. \fBmysql\-test\-run\&.pl\fR attempts to find a suitable location using a built\-in list of standard locations for tmpfs and puts the var @@ -966,7 +1104,14 @@ MTR_MEM[=\fIdir_name\fR]\&. If \fIdir_name\fR is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built\-in locations\&. .sp -This option was added in MySQL 4\&.1\&.22, 5\&.0\&.30, and 5\&.1\&.13\&. +Once you have run tests with +\fB\-\-mem\fR +within a +mysql\-testdirectory, a soflink +var +will have been set up to the temporary directory, and this will be re\-used the next time, until the soflink is deleted\&. Thus, you do not have to repeat the +\fB\-\-mem\fR +option next time\&. .RE .sp .RS 4 @@ -996,25 +1141,6 @@ Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltes .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: mysqltest option -.\" mysqltest option: mysql-test-run.pl -\fB\-\-mysqltest=\fR\fB\fIvalue\fR\fR -.sp -Extra options to pass to -\fBmysqltest\fR\&. The value should consist of one or more comma\-separated -\fBmysqltest\fR -options\&. See -Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltest\(rq\&. This option was added in MySQL 6\&.0\&.6\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: ndb-connectstring option .\" ndb-connectstring option: mysql-test-run.pl \fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR @@ -1034,15 +1160,13 @@ from starting a cluster\&. It is assumed that there is already a cluster running .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: ndb-connectstring-slave option -.\" ndb-connectstring-slave option: mysql-test-run.pl -\fB\-\-ndb\-connectstring\-slave=\fR\fB\fIstr\fR\fR +.\" mysql-test-run.pl: nocheck-testcases option +.\" nocheck-testcases option: mysql-test-run.pl +\fB\-\-nocheck\-testcases\fR .sp -Pass -\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR -to slave MySQL servers\&. This option also prevents -\fBmysql\-test\-run\&.pl\fR -from starting a cluster\&. It is assumed that there is already a cluster running to which the server can connect with the given connectstring\&. +Disable the check for test case side effects; see +\fB\-\-check\-testcases\fR +for a description\&. .RE .sp .RS 4 @@ -1053,11 +1177,11 @@ from starting a cluster\&. It is assumed that there is already a cluster running .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: ndb-extra-test option -.\" ndb-extra-test option: mysql-test-run.pl -\fB\-\-ndb\-extra\-test\fR +.\" mysql-test-run.pl: noreorder option +.\" noreorder option: mysql-test-run.pl +\fB\-\-noreorder\fR .sp -Unknown\&. +Do not reorder tests to reduce number of restarts, but run them in exactly the order given\&. If a whole suite is to be run, the tests are run in alphabetical order, though similiar combinations will be grouped together\&. If more than one suite is listed, the tests are run one suite at a time, in the order listed\&. .RE .sp .RS 4 @@ -1068,14 +1192,13 @@ Unknown\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: ndbcluster-port option -.\" ndbcluster-port option: mysql-test-run.pl -.\" mysql-test-run.pl: ndbcluster_port option -.\" ndbcluster_port option: mysql-test-run.pl -\fB\-\-ndbcluster\-port=\fR\fB\fIport_num\fR\fR, -\fB\-\-ndbcluster_port=\fR\fB\fIport_num\fR\fR +.\" mysql-test-run.pl: notimer option +.\" notimer option: mysql-test-run.pl +\fB\-\-notimer\fR .sp -Specify the TCP/IP port number that NDB Cluster should use\&. +Cause +\fBmysqltest\fR +not to generate a timing file\&. The effect of this is that the report from each test case does not include the timing in milliseconds as it normally does\&. .RE .sp .RS 4 @@ -1086,11 +1209,11 @@ Specify the TCP/IP port number that NDB Cluster should use\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: ndbcluster-port-slave option -.\" ndbcluster-port-slave option: mysql-test-run.pl -\fB\-\-ndbcluster\-port\-slave=\fR\fB\fIport_num\fR\fR +.\" mysql-test-run.pl: nowarnings option +.\" nowarnings option: mysql-test-run.pl +\fB\-\-nowarnings\fR .sp -Specify the TCP/IP port number that the slave NDB Cluster should use\&. +Do not look for and report errors and warning in the server logs\&. .RE .sp .RS 4 @@ -1101,13 +1224,16 @@ Specify the TCP/IP port number that the slave NDB Cluster should use\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: netware option -.\" netware option: mysql-test-run.pl -\fB\-\-netware\fR +.\" mysql-test-run.pl: parallel option +.\" parallel option: mysql-test-run.pl +\fB\-\-parallel={\fR\fB\fIN\fR\fR\fB|auto}\fR .sp -Run -\fBmysqld\fR -with options needed on NetWare\&. +Run tests using +\fIN\fR +parallel threads\&. By default, 1 thread is used\&. Use +\fB\-\-parallel=auto\fR +for auto\-setting of +\fIN\fR\&. The auto value was added in MySQL 5\&.1\&.36\&. .RE .sp .RS 4 @@ -1118,13 +1244,24 @@ with options needed on NetWare\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: notimer option -.\" notimer option: mysql-test-run.pl -\fB\-\-notimer\fR +.\" mysql-test-run.pl: port-base option +.\" port-base option: mysql-test-run.pl +\fB\-\-port\-base=\fR\fB\fIP\fR\fR .sp -Cause -\fBmysqltest\fR -not to generate a timing file\&. +Specify base of port numbers to be used; a block of 10 will be allocated\&. +\fIP\fR +should be divisible by 10; if it is not, it will be rounded down\&. If running with more than one parallel test thread, thread 2 will use the next block of 10 and so on\&. +.sp +If the port number is given as +auto, which is also the default, +\fBmysql\-test\-run\&.pl\fRwill allocate a number unique to this host\&. The value may also be given with the environment variable +MTR_PORT_BASE\&. +.sp +\fB\-\-port\-base\fR +was added in MySQL 5\&.1\&.45 as a more logical alternative to +\fB\-\-build\-thread\fR\&. If both are used, +\fB\-\-port\-base\fR +takes presedence\&. .RE .sp .RS 4 @@ -1135,16 +1272,11 @@ not to generate a timing file\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: parallel option -.\" parallel option: mysql-test-run.pl -\fB\-\-parallel={\fR\fB\fIN\fR\fR\fB|auto}\fR +.\" mysql-test-run.pl: print-testcases option +.\" print-testcases option: mysql-test-run.pl +\fB\-\-print\-testcases\fR .sp -Run tests using -\fIN\fR -parallel threads\&. By default, 1 thread is used\&. Use -\fB\-\-parallel=auto\fR -for auto\-setting of -\fIN\fR\&. This option was added in MySQL 5\&.1\&.36\&. +Do not run any tests, but print details about all tests, in the order they would have been run\&. .RE .sp .RS 4 @@ -1195,7 +1327,24 @@ option to .\" reorder option: mysql-test-run.pl \fB\-\-reorder\fR .sp -Reorder tests to minimize the number of server restarts needed\&. +Reorder tests to minimize the number of server restarts needed\&. This is the default behavior\&. There is no guarantee that a particular set of tests will always end up in the same order\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: repeat option +.\" repeat option: mysql-test-run.pl +\fB\-\-repeat=\fR\fB\fIN\fR\fR +.sp +Run each test +\fIN\fR +number of times\&. .RE .sp .RS 4 @@ -1214,8 +1363,33 @@ Display the output of SHOW ENGINES and SHOW VARIABLES\&. This can be used to verify that binaries are built with all required features\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +.\" mysql-test-run.pl: retry option +.\" retry option: mysql-test-run.pl +\fB\-\-retry=\fR\fB\fIN\fR\fR .sp -This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&. +If a test fails, it is retried up to a maximum of +\fIN\fR +runs, but will terminate after 2 failures\&. Default is 3, set to 1 or 0 for no retries\&. This option has no effect unless +\fB\-\-force\fR +is also used; without it, test execution will terminate after the first failure\&. +.sp +The +\fB\-\-retry\fR +and +\fB\-\-retry\-failure\fR +options do not affect how many times a test repeated with +\fB\-\-repeat\fR +may fail in total, as each repetition is considered a new test case, which may in turn be retried if it fails\&. .RE .sp .RS 4 @@ -1226,13 +1400,11 @@ This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: script-debug option -.\" script-debug option: mysql-test-run.pl -\fB\-\-script\-debug\fR +.\" mysql-test-run.pl: retry-failure option +.\" retry-failure option: mysql-test-run.pl +\fB\-\-retry\-failure=\fR\fB\fIN\fR\fR .sp -Enable debug output for -\fBmysql\-test\-run\&.pl\fR -itself\&. +Allow a failed and retried test to fail more than the default 2 times before giving it up\&. Setting it to 0 or 1 effectively turns off retries .RE .sp .RS 4 @@ -1243,11 +1415,11 @@ itself\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: skip-im option -.\" skip-im option: mysql-test-run.pl -\fB\-\-skip\-im\fR +.\" mysql-test-run.pl: shutdown-timeout option +.\" shutdown-timeout option: mysql-test-run.pl +\fB\-\-shutdown\-timeout=\fR\fB\fISECONDS\fR\fR .sp -Do not start Instance Manager; skip Instance Manager test cases\&. +Max number of seconds to wait for servers to do controlled shutdown before killing them\&. Default is 10\&. .RE .sp .RS 4 @@ -1258,11 +1430,11 @@ Do not start Instance Manager; skip Instance Manager test cases\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: skip-master-binlog option -.\" skip-master-binlog option: mysql-test-run.pl -\fB\-\-skip\-master\-binlog\fR +.\" mysql-test-run.pl: skip-combinations option +.\" skip-combinations option: mysql-test-run.pl +\fB\-\-skip\-combinations\fR .sp -Do not enable master server binary logging\&. +Do not apply combinations; ignore combinations file or option\&. .RE .sp .RS 4 @@ -1324,21 +1496,6 @@ Skip replication test cases\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: skip-slave-binlog option -.\" skip-slave-binlog option: mysql-test-run.pl -\fB\-\-skip\-slave\-binlog\fR -.sp -Do not enable master server binary logging\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: skip-ssl option .\" skip-ssl option: mysql-test-run.pl \fB\-\-skip\-ssl\fR @@ -1362,7 +1519,7 @@ with support for SSL connections\&. .sp Specify a regular expression to be applied to test case names\&. Cases with names that match the expression are skipped\&. tests to skip\&. .sp -As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the +The argument for the \fB\-\-skip\-test\fR option allows more flexible specification of which tests to skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. See the description of the \fB\-\-do\-test\fR @@ -1393,38 +1550,6 @@ are passed to the master server\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: slave-binary option -.\" slave-binary option: mysql-test-run.pl -\fB\-\-slave\-binary=\fR\fB\fIpath\fR\fR -.sp -Specify the path of the -\fBmysqld\fR -binary to use for slave servers\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: slave_port option -.\" slave_port option: mysql-test-run.pl -\fB\-\-slave_port=\fR\fB\fIport_num\fR\fR -.sp -Specify the TCP/IP port number for the first master server to use\&. Observe that the option name has an underscore and not a dash\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: sleep option .\" sleep option: mysql-test-run.pl \fB\-\-sleep=\fR\fB\fIN\fR\fR @@ -1443,41 +1568,6 @@ to .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: small-bench option -.\" small-bench option: mysql-test-run.pl -\fB\-\-small\-bench\fR -.sp -Run the benchmarks with the -\fB\-\-small\-tests\fR -and -\fB\-\-small\-tables\fR -options\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: socket option -.\" socket option: mysql-test-run.pl -\fB\-\-socket=\fR\fB\fIfile_name\fR\fR -.sp -For connections to -localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: sp-protocol option .\" sp-protocol option: mysql-test-run.pl \fB\-\-sp\-protocol\fR @@ -1520,39 +1610,11 @@ Couldn\'t find support for SSL .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: start option -.\" start option: mysql-test-run.pl -\fB\-\-start\fR -.sp -Initialize and start servers with the startup settings for the first specified test case\&. For example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -shell> \fBcd mysql\-test\fR -shell> \fB\&./mysql\-test\-run\&.pl \-\-start alias &\fR -.fi -.if n \{\ -.RE -.\} -.sp -This option was added in MySQL 5\&.1\&.32/6\&.0\&.11\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: start-and-exit option .\" start-and-exit option: mysql-test-run.pl -\fB\-\-start\-and\-exit\fR +\fB\-\-start\fR .sp -Initialize and start servers with the startup settings for the specified test case or cases, if any, and then exit\&. You can use this option to start a server to which you can connect later\&. For example, after building a source distribution you can start a server and connect to it with the +Initialize and start servers with the startup settings for the specified test case\&. You can use this option to start a server to which you can connect later\&. For example, after building a source distribution you can start a server and connect to it with the \fBmysql\fR client like this: .sp @@ -1561,12 +1623,19 @@ client like this: .\} .nf shell> \fBcd mysql\-test\fR -shell> \fB\&./mysql\-test\-run\&.pl \-\-start\-and\-exit\fR +shell> \fB\&./mysql\-test\-run\&.pl \-\-start alias &\fR shell> \fB\&.\&./mysql \-S \&./var/tmp/master\&.sock \-h localhost \-u root\fR .fi .if n \{\ .RE .\} +.sp +If no tests are named on the command line, the server(s) will be started with settings for the first test that would have been run without the +\fB\-\-start\fR +option\&. +.sp +\fBmysql\-test\-run\&.pl\fR +will stop once the server has been started, but will terminate if the server dies\&. If killed, it will also shut down the server\&. .RE .sp .RS 4 @@ -1581,7 +1650,8 @@ shell> \fB\&.\&./mysql \-S \&./var/tmp/master\&.sock \-h localhost \-u root\fR .\" start-dirty option: mysql-test-run.pl \fB\-\-start\-dirty\fR .sp -Start servers (without initialization) for the specified test case or cases, if any, and then exit\&. You can then manually run the test cases\&. +This is similar to +\fB\-\-start\fR, but will skip the database initialization phase and assume that database files are already available\&. Usually this means you must have run another test first\&. .RE .sp .RS 4 @@ -1627,161 +1697,6 @@ output for .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: stress option -.\" stress option: mysql-test-run.pl -\fB\-\-stress\fR -.sp -Run the stress test\&. The other -\fB\-\-stress\-\fR\fB\fIxxx\fR\fR -options apply in this case\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-init-file option -.\" stress-init-file option: mysql-test-run.pl -\fB\-\-stress\-init\-file=\fR\fB\fIfile_name\fR\fR -.sp -\fIfile_name\fR -is the location of the file that contains the list of tests\&. The default file is -stress_init\&.txt -in the test suite directory\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-loop-count option -.\" stress-loop-count option: mysql-test-run.pl -\fB\-\-stress\-loop\-count=\fR\fB\fIN\fR\fR -.sp -In sequential stress\-test mode, the number of loops to execute before exiting\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-mode option -.\" stress-mode option: mysql-test-run.pl -\fB\-\-stress\-mode=\fR\fB\fImode\fR\fR -.sp -This option indicates the test order in stress\-test mode\&. The -\fImode\fR -value is either -random -to select tests in random order or -seq -to run tests in each thread in the order specified in the test list file\&. The default mode is -random\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-suite option -.\" stress-suite option: mysql-test-run.pl -\fB\-\-stress\-suite=\fR\fB\fIsuite_name\fR\fR -.sp -The name of the test suite to use for stress testing\&. The default suite name is -main -(the regular test suite located in the -mysql\-test -directory)\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-test-count option -.\" stress-test-count option: mysql-test-run.pl -\fB\-\-stress\-test\-count=\fR\fB\fIN\fR\fR -.sp -For stress testing, the number of tests to execute before exiting\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-test-duration option -.\" stress-test-duration option: mysql-test-run.pl -\fB\-\-stress\-test\-duration=\fR\fB\fIN\fR\fR -.sp -For stress testing, the duration of stress testing in seconds\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-test-file option -.\" stress-test-file option: mysql-test-run.pl -\fB\-\-stress\-test\-file=\fR\fB\fIfile_name\fR\fR -.sp -The file that contains the list of tests to use in stress testing\&. The tests should be named without the -\&.test -extension\&. The default file is -stress_tests\&.txt -in the test suite directory\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: stress-threads option -.\" stress-threads option: mysql-test-run.pl -\fB\-\-stress\-threads=\fR\fB\fIN\fR\fR -.sp -The number of threads to use in stress testing\&. The default is 5\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: suite option .\" suite option: mysql-test-run.pl \fB\-\-suite=\fR\fB\fIsuite_name\fR\fR @@ -1831,30 +1746,12 @@ Specify the maximum test case runtime\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: timer option -.\" timer option: mysql-test-run.pl -\fB\-\-timer\fR -.sp -Cause -\fBmysqltest\fR -to generate a timing file\&. The default file is named -\&./var/log/timer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: tmpdir option -.\" tmpdir option: mysql-test-run.pl -\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR +.\" mysql-test-run.pl: timediff option +.\" timediff option: mysql-test-run.pl +\fB\-\-timediff\fR .sp -The directory where temporary file are stored\&. The default location is -\&./var/tmp\&. +Adds to each test report for a test case, the total time in sconds and milliseconds passed since the preceding test ended\&. This option can only be used together with +\fB\-\-timestamp\fR, and has no effect without it\&. .RE .sp .RS 4 @@ -1865,12 +1762,14 @@ The directory where temporary file are stored\&. The default location is .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: unified-diff option -.\" unified-diff option: mysql-test-run.pl -\fB\-\-unified\-diff\fR, -\fB\-\-udiff\fR +.\" mysql-test-run.pl: timer option +.\" timer option: mysql-test-run.pl +\fB\-\-timer\fR .sp -Use unified diff format when presenting differences between expected and actual test case results\&. +Cause +\fBmysqltest\fR +to generate a timing file\&. The default file is named +\&./var/log/timer\&. .RE .sp .RS 4 @@ -1881,11 +1780,11 @@ Use unified diff format when presenting differences between expected and actual .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: use-old-data option -.\" use-old-data option: mysql-test-run.pl -\fB\-\-use\-old\-data\fR +.\" mysql-test-run.pl: timestamp option +.\" timestamp option: mysql-test-run.pl +\fB\-\-timestamp\fR .sp -Do not install the test databases\&. (Use existing ones\&.) +Prints a timestamp before the test case name in each test report line, showing when the test ended\&. .RE .sp .RS 4 @@ -1896,11 +1795,14 @@ Do not install the test databases\&. (Use existing ones\&.) .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: user-test option -.\" user-test option: mysql-test-run.pl -\fB\-\-user\-test=\fR\fB\fIval\fR\fR +.\" mysql-test-run.pl: tmpdir option +.\" tmpdir option: mysql-test-run.pl +\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR .sp -Unused\&. +The directory where temporary file are stored\&. The default location is +\&./var/tmp\&. The environment variable +MYSQL_TMP_DIR +will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&. .RE .sp .RS 4 @@ -1935,7 +1837,11 @@ Run and \fBmysqld\fR with -\fBvalgrind\fR\&. +\fBvalgrind\fR\&. Thiks and the following +\fB\-\-valgrind\fR +options require that the executables have been build with +\fBvalgrind\fR +support\&. .RE .sp .RS 4 @@ -1946,16 +1852,13 @@ with .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: valgrind-all option -.\" valgrind-all option: mysql-test-run.pl -\fB\-\-valgrind\-all\fR +.\" mysql-test-run.pl: valgrind-mysqld option +.\" valgrind-mysqld option: mysql-test-run.pl +\fB\-\-valgrind\-mysqld\fR .sp -Like -\fB\-\-valgrind\fR, but passes the -\fB\-\-verbose\fR -and -\fB\-\-show\-reachable\fR -options to +Run the +\fBmysqld\fR +server with \fBvalgrind\fR\&. .RE .sp @@ -1985,30 +1888,9 @@ with .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: valgrind-mysqltest-all option -.\" valgrind-mysqltest-all option: mysql-test-run.pl -\fB\-\-valgrind\-mysqltest\-all\fR -.sp -Like -\fB\-\-valgrind\-mysqltest\fR, but passes the -\fB\-\-verbose\fR -and -\fB\-\-show\-reachable\fR -options to -\fBvalgrind\fR\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} .\" mysql-test-run.pl: valgrind-options option .\" valgrind-options option: mysql-test-run.pl -\fB\-\-valgrind\-options=\fR\fB\fIstr\fR\fR +\fB\-\-valgrind\-option=\fR\fB\fIstr\fR\fR .sp Extra options to pass to \fBvalgrind\fR\&. @@ -2044,7 +1926,9 @@ executable\&. \fB\-\-vardir=\fR\fB\fIpath\fR\fR .sp Specify the path where files generated during the test run are stored\&. The default location is -\&./var\&. +\&./var\&. The environment variable +MYSQLTEST_VARDIR +will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&. .RE .sp .RS 4 @@ -2055,14 +1939,11 @@ Specify the path where files generated during the test run are stored\&. The def .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: view-protocol option -.\" view-protocol option: mysql-test-run.pl -\fB\-\-view\-protocol\fR +.\" mysql-test-run.pl: verbose option +.\" verbose option: mysql-test-run.pl +\fB\-\-verbose\fR .sp -Pass the -\fB\-\-view\-protocol\fR -option to -\fBmysqltest\fR\&. +Give more verbose output regarding test execution\&. Use the option twice to get even more output\&. Note that the output generated within each test case is not affected\&. .RE .sp .RS 4 @@ -2073,13 +1954,11 @@ option to .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: vs-config option -.\" vs-config option: mysql-test-run.pl -\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR +.\" mysql-test-run.pl: verbose-restart option +.\" verbose-restart option: mysql-test-run.pl +\fB\-\-verbose\-restart\fR .sp -Specify the configuration used to build MySQL (for example, -\fB\-\-vs\-config=debug\fR -\fB\-\-vs\-config=release\fR)\&. This option is for Windows only\&. It is available as of MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&. +Write when and why servers are restarted between test cases\&. .RE .sp .RS 4 @@ -2090,11 +1969,14 @@ Specify the configuration used to build MySQL (for example, .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: wait-timeout option -.\" wait-timeout option: mysql-test-run.pl -\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR +.\" mysql-test-run.pl: view-protocol option +.\" view-protocol option: mysql-test-run.pl +\fB\-\-view\-protocol\fR .sp -Unused? +Pass the +\fB\-\-view\-protocol\fR +option to +\fBmysqltest\fR\&. .RE .sp .RS 4 @@ -2105,12 +1987,13 @@ Unused? .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: warnings option -.\" warnings option: mysql-test-run.pl -\fB\-\-warnings\fR +.\" mysql-test-run.pl: vs-config option +.\" vs-config option: mysql-test-run.pl +\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR .sp -This option is a synonym for -\fB\-\-log\-warnings\fR\&. +Specify the configuration used to build MySQL (for example, +\fB\-\-vs\-config=debug\fR +\fB\-\-vs\-config=release\fR)\&. This option is for Windows only\&. .RE .sp .RS 4 @@ -2121,11 +2004,17 @@ This option is a synonym for .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: with-ndbcluster option -.\" with-ndbcluster option: mysql-test-run.pl -\fB\-\-with\-ndbcluster\fR +.\" mysql-test-run.pl: wait-all option +.\" wait-all option: mysql-test-run.pl +\fB\-\-wait\-all\fR .sp -Use NDB Cluster and enable test cases that require it\&. +If +\fB\-\-start\fR +or +\fB\-\-start\-dirty\fR +is used, wait for all servers to exit before termination\&. Otherise, it will terminate if one (of several) servers is restarted\&. +.sp +This option was added in MySQL 5\&.1\&.36\&. .RE .sp .RS 4 @@ -2136,11 +2025,12 @@ Use NDB Cluster and enable test cases that require it\&. .sp -1 .IP \(bu 2.3 .\} -.\" mysql-test-run.pl: with-ndbcluster-all option -.\" with-ndbcluster-all option: mysql-test-run.pl -\fB\-\-with\-ndbcluster\-all\fR +.\" mysql-test-run.pl: warnings option +.\" warnings option: mysql-test-run.pl +\fB\-\-warnings\fR .sp -Use NDB Cluster in all tests\&. +Search the server log for errors or warning after each test and report any suspicious ones; if any are found, the test will be marked as failed\&. This is the default behavior, it may be turned off with +\fB\-\-nowarnings\fR\&. .RE .sp .RS 4 @@ -2159,100 +2049,10 @@ Run only test cases that have ndb in their name\&. .RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: with-ndbcluster-slave option -.\" with-ndbcluster-slave option: mysql-test-run.pl -\fB\-\-with\-ndbcluster\-slave\fR -.sp -Unknown\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -.\" mysql-test-run.pl: with-openssl option -.\" with-openssl option: mysql-test-run.pl -\fB\-\-with\-openssl\fR -.sp -This option is a synonym for -\fB\-\-ssl\fR\&. -.RE -.if n \{\ -.sp -.\} -.RS 4 -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.ps +1 -\fBNote\fR -.ps -1 -.br -.PP -\fBmysql\-test\-run\fR -supports the following options not supported by -\fBmysql\-test\-run\&.pl\fR: -\fB\-\-local\fR, -\fB\-\-local\-master\fR, -\fB\-\-ndb\-verbose\fR, -\fB\-\-ndb_mgm\-extra\-opts\fR, -\fB\-\-ndb_mgmd\-extra\-opts\fR, -\fB\-\-ndbd\-extra\-opts\fR, -\fB\-\-old\-master\fR, -\fB\-\-purify\fR, -\fB\-\-use\-old\-data\fR, -\fB\-\-valgrind\-mysqltest\-all\fR\&. -.PP -Conversely, -\fBmysql\-test\-run\&.pl\fR -supports the following options not supported by -\fBmysql\-test\-run\fR: -\fB\-\-benchdir\fR, -\fB\-\-check\-testcases\fR, -\fB\-\-client\-ddd\fR, -\fB\-\-client\-debugger\fR, -\fB\-\-cursor\-protocol\fR, -\fB\-\-debugger\fR, -\fB\-\-im\-mysqld1\-port\fR, -\fB\-\-im\-mysqld2\-port\fR, -\fB\-\-im\-port\fR, -\fB\-\-manual\-debug\fR, -\fB\-\-netware\fR, -\fB\-\-notimer\fR, -\fB\-\-reorder\fR, -\fB\-\-script\-debug\fR, -\fB\-\-skip\-im\fR, -\fB\-\-skip\-ssl\fR, -\fB\-\-sp\-protocol\fR, -\fB\-\-start\-dirty\fR, -\fB\-\-suite\fR, -\fB\-\-suite\-timeout\fR, -\fB\-\-testcase\-timeout\fR, -\fB\-\-udiff\fR, -\fB\-\-unified\-diff\fR,, -\fB\-\-valgrind\-path\fR, -\fB\-\-vardir\fR, -\fB\-\-view\-protocol\fR\&. -.sp .5v -.RE .SH "COPYRIGHT" .br .PP -Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc. +Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved. .PP This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. .PP @@ -2260,12 +2060,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU .PP You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. .sp -.SH "NOTES" -.IP " 1." 4 -Typical \fBconfigure\fR Options -.RS 4 -\%http://dev.mysql.com/doc/refman/5.1/en/configure-options.html -.RE .SH "SEE ALSO" For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available |