shell> mysql-test-run.pl [options] [test_name] ...

shell> mysql-test-run.pl mytest
shell> mysql-test-run.pl mytest.test
shell> mysql-test-run.pl t/mytest.test

[suite_name.]test_name[.suffix]

shell> export MYSQLD_BOOTSTRAP
shell> MYSQLD_BOOTSTRAP=/full/path/to/mysqld
shell> make test force="--skip-test=init_file"

shell> cd mysql-test
shell> export MTR_VS_CONFIG=debug
shell> ./mysqltest-run.pl --force --timer
shell> ./mysqltest-run.pl --force --timer --ps-protocol

Display a help message and exit.

Allow tests marked as "big" to run. Tests can be thus marked by including the line --source include/big_test.inc, and they will only be run if this option is given, or if the environment variable BIG_TEST is set to 1. Repeat this option twice to run only "big" tests.

This is typically used for tests that take a very long to run, or that use many resources, so that they are not suitable for running as part of a normal test suite run.

Run the mysqld server used for bootstrapping the database through the dbx debugger.

Run the mysqld server used for bootstrapping the database through the ddd debugger.

Run the mysqld server used for bootstrapping the database through the gdb debugger.

Specify a number to calculate port numbers from. The formula is 10 * build_thread + 10000. Instead of a number, it can be set to auto, which is also the default value, in which case mysql-test-run.pl will allocate a number unique to this host.

The value (number or auto) can also be set with the MTR_BUILD_THREAD environment variable.

The more logical --port-base is supported as an alternative.

Instructs valgrind to use callgrind.

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.

The path to the directory where client binaries are located.

Start mysqltest in the dbx debugger.

Start mysqltest in the ddd debugger.

Start mysqltest in the named debugger.

Start mysqltest in the gdb debugger.

The path to the directory where client libraries are located.

Extra options to pass to mysqld. The value should consist of one or more comma-separated mysqld options. This option is similar to --mysqld but should be given two or more times. mysql-test-run.pl executes multiple test runs, using the options for each instance of --combination in successive runs. If --combination is given only once, it has no effect. For test runs specific to a given test suite, an alternative to the use of --combination is to create a combinations file in the suite directory. The file should contain a section of options for each test run.

Write str to the output within lines filled with #, as a form of banner.

Compress all information sent between the client and the server if both support compression.

Use the cursor protocol between client and server (implies --ps-protocol).

Start the mysqld(s) in the dbx debugger.

Start the mysqld(s) in the ddd debugger.

Dump trace output for all clients and servers.

Same as --debug, but sets the 'd' debug flags to "query,info,error,enter,exit".

Use debug version of server, but without turning on tracing.

Start mysqld using the named debugger.

Controls whether the Debug Sync facility for testing and debugging is enabled. The option value is a timeout in seconds. The default value is 300. A value of 0 disables Debug Sync. The value of this option also becomes the default timeout for individual synchronization points.

mysql-test-run.pl passes --loose-debug-sync-timeout=N to mysqld. The --loose prefix is used so that mysqld does not fail if Debug Sync is not compiled in.

Use the named file as fixed config file template for all tests.

Add setting from the named file to all generated configs.

Run all test cases having a name that begins with the given prefix value, or fulfils the regex. This option provides a convenient way to run a family of similarly named tests.

The argument for the --do-test 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, --do-test=testa matches tests that begin with testa, --do-test=main.testa matches tests in the main test suite that begin with testa, and --do-test=main.*testa matches test names that contain 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.

Don't run any tests, print the list of tests that were selected for execution.

Use a version of mysqltest built with the embedded server.

Ignore any disabled.def file, and also run tests marked as disabled. Success or failure of those tests will be reported the same way as other tests.

Specify a file that contains a list of test cases that should be displayed with the [ exp-fail ] code rather than [ fail ] if they fail.

For an example of a file that might be specified via this option, see mysql-test/collections/default.experimental.

Use an already running server. The option/value pair is what is needed by the mysql client to connect to the server. Each --extern option can only take one option/value pair as an argument, so you need to repeat --extern for each pair needed. Example:

      ./mysql-test-run.pl --extern socket=var/tmp/mysqld.1.sock alias

Note: If a test case has an .opt file that requires the server to be restarted with specific options, the file will not be used. The test case likely will fail as a result.

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.

Always restart servers between tests.

Normally, mysql-test-run.pl exits if a test case fails. --force causes execution to continue regardless of test case failure.

Collect coverage information after the test. The result is a gcov file per source and header file.

Colllect coverage only within the given subdirectory. For example, if you're only developing the SQL layer, it makes sense to use --gcov-src-dir=sql.

Start the mysqld(s) in the gdb debugger.

Collect profiling information using the gprof profiling tool.

Use a server that has already been started by the user in the dbx debugger.

Use a server that has already been started by the user in the ddd debugger.

Use a server that has already been started by the user in a debugger.

Use a server that has already been started by the user in the gdb debugger.

Use a server that has already been started by the user in the lldb debugger.

Marks progress with timing (in milliseconds) and line number in var/log/testname.progress.

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 mysqltest.

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

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

Stop execution after the specified number of tests have failed, to avoid using up resources (and time) in case of massive failures. retries are not 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

This option is not supported on Windows.

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. mysql-test-run.pl attempts to find a suitable location using a built-in list of standard locations for tmpfs and puts the var directory there. This option also affects placement of temporary files, which are created in var/tmp.

The default list includes /dev/shm. You can also enable this option by setting the environment variable MTR_MEM[=dir_name]. If dir_name is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built-in locations.

Once you have run tests with --mem 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 --mem option next time.

Extra options to pass to mysqld. The value should consist of one or more comma-separated mysqld options.

Specify additional environment settings for "mysqld". Use additional --mysqld-env options to set more than one variable.

Disable the check for test case side effects; see --check-testcases for a description.

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 similar 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.

Cause mysqltest 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.

Do not look for and report errors and warning in the server logs.

Run tests using N parallel threads. By default, 1 thread is used. Use --parallel=auto for auto-setting of N.

Specify base of port numbers to be used; a block of 10 will be allocated. P 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.

If the port number is given as auto, which is also the default, mysql-test-run.pl will allocate a number unique to this host. The value may also be given with the environment variable MTR_PORT_BASE.

If both --build-thread and --port-base are used, --port-base takes precedence.

Do not run any tests, but print details about all tests, in the order they would have been run.

Use the binary protocol between client and server.

Pass the --record option to mysqltest. This option requires a specific test case to be named on the command line.

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.

Run each test N number of times.

First run a "test" that reports MariaDB features, displaying the output of SHOW ENGINES and SHOW VARIABLES. This can be used to verify that binaries are built with all required features.

Report how much time has been spent on different phases of test execution.

If a test fails, it is retried up to a maximum of N runs (default 1). Retries are also limited by the maximum number of failures before stopping, set with the --retry-failure option. This option has no effect unless --force is also used; without it, test execution will terminate after the first failure.

The --retry and --retry-failure options do not affect how many times a test repeated with --repeat may fail in total, as each repetition is considered a new test case, which may in turn be retried if it fails.

When using the --retry option to retry failed tests, stop when N failures have occurred (default 2). Setting it to 0 or 1 effectively turns off retries.

Max number of seconds to wait for servers to do controlled shutdown before killing them. Default is 10.

Do not apply combinations; ignore combinations file or option.

Skip replication test cases.

Do not start mysqld with support for SSL connections.

Specify a regular expression to be applied to test case names. Cases with names that match the expression are skipped. tests to skip.

The argument for the --skip-test 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 --do-test option for details.

Skip the tests listed in FILE. Each line in the file is an entry and should be formatted as: <TESTNAME> : <COMMENT>

--skip-* options not otherwise recognized by mysql-test-run.pl are passed to the master server.

Pass --sleep=N to mysqltest.

Create a stored procedure to execute all queries.

If mysql-test-run.pl is started with the --ssl option, it sets up a secure connection for all test cases. In this case, if mysqld does not support SSL, mysql-test-run.pl exits with an error message: Couldn't find support for SSL

Run a limited number of tests (no slow tests). Used for running staging trees with valgrind.

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 mysql client like this:

shell> cd mysql-test
shell> ./mysql-test-run.pl --start alias &
shell> ../mysql -S ./var/tmp/master.sock -h localhost -u root

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 --start option.

mysql-test-run.pl will stop once the server has been started, but will terminate if the server dies. If killed, it will also shut down the server.

Same --start, but mysql-test-run terminates and leaves just the server running.

This is similar to --start, 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.

mysql-test-run.pl sorts the list of names of the test cases to be run, and then begins with test_name.

Run the "mysqld" executables using strace. Default options are -f -o var/log/'mysqld-name'.strace.

Create strace output for mysqltest, optionally specifying name and path to the trace program to use.

Example: ./mysql-test-run.pl --strace-client=ktrace

Option to give strace, replaces default option(s).

Run stress test, providing options to mysql-stress-test.pl. Options are separated by comma.

Comma separated list of suite names to run. The default is: "main-,archive-,binlog-,csv-,federated-,funcs_1-,funcs_2-, handler-,heap-,innodb-,innodb_fts-,innodb_zip-,maria-, multi_source-,optimizer_unfixed_bugs-,parts-,perfschema-, plugins-,roles-,rpl-,sys_vars-,unit-,vcol-".

If this file is detected, mysqltest will not start new tests until the file is removed (also MTR_STOP_FILE environment variable).

Works with --stop-file, print messages every sec seconds when mysqltest is waiting to remove the file (for buildbot) (also MTR_STOP_KEEP_ALIVE environment variable).

Specify the maximum test suite runtime in minutes. The default is 360.

Specify the maximum test case runtime in minutes. The default is 15.

Used with --timestamp, also print time passed since the previous test started.

Cause mysqltest to generate a timing file. The default file is named ./var/log/timer.

Prints a timestamp before the test case name in each test report line, showing when the test ended.

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.

The MariaDB user name to use when connecting to the server (default root).

In combination with start* and no test name, drops arguments to mysqld except those specified with --mysqld (if any).

Run mysqltest and mysqld with valgrind. This and the following --valgrind options require that the executables have been built with valgrind support.

Run the mysqld server with valgrind.

Run the mysqltest and mysql_client_test executables with valgrind.

Option to give valgrind. Replaces default option(s). Can be specified more then once&.

Path to the valgrind executable.

Specify the path where files generated during the test run are stored. The default location is ./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.

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.

Write when and why servers are restarted between test cases.

Create a view to execute all non updating queries.

Visual Studio configuration used to create executables (default: MTR_VS_CONFIG environment variable) This option is for Windows only.

If --start or --start-dirty is used, wait for all servers to exit before termination. Otherwise, it will terminate if one (of several) servers is restarted.

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 --nowarnings.