Syntax

./mysql-test-run.pl [ OPTIONS ] [ TESTCASE ]

Where the test case can be specified as: testcase[.test] Runs the test case named 'testcase' from all suits

path-to-testcase
[suite.]testcase[,combination]

Examples

alias main.alias 'main' is the name of the suite for the 't' directory.

rpl.rpl_invoked_features,mix,xtradb_plugin
suite/rpl/t/rpl.rpl_invoked_features

Options

Options to Control What Engine/Variation to Run

OptionDescription
--embedded-serverUse the embedded server, i.e. no mysqld daemons.
--ps-protocolUse the binary protocol between client and server.
--cursor-protocolUse the cursor protocol between client and server (implies --ps-protocol).
--view-protocolCreate a view to execute all non updating queries.
--sp-protocolCreate a stored procedure to execute all queries.
--compressUse the compressed protocol between client and server if both support it.
--sslIf 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 TLS, mysql-test-run.pl exits with an error message: Couldn´t find support for SSL.
--skip-sslDont start server with support for TLS connections.
--vs-configVisual Studio configuration used to create executables (default: MTR_VS_CONFIG environment variable).
--parallel=numHow many parallel tests should be run. Default is 1, use --parallel=auto for auto-setting of num.
--defaults-file=<config template>Use fixed config template for all tests.
--defaults_extra_file=<config template>Extra config template to add to all generated configs.
--combination=<opt>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.
--dry-runDon't run any tests, print the list of tests that were selected for execution.

Options to Control Directories to Use

OptionDescription
--tmpdir=DIRThe directory where temporary files are stored (default: ./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.
--vardir=DIRThe directory where files generated from the test run is stored (default: ./var). Specifying a ramdisk or tmpfs will speed up tests. 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.
--memRun testsuite 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. Attempts to find a suitable location using a builtin list of standard locations for tmpfs (/dev/shm). The option can also be set using environment variable MTR_MEM=[DIR]. If DIR 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.
--client-bindir=PATHPath to the directory where client binaries are located.
--client-libdir=PATHPath to the directory where client libraries are located.

Options to Control What Test Suites or Cases to Run

OptionDescription
--forceNormally, mysql-test-run.pl exits if a test case fails. --force causes execution to continue regardless of test case failure.
--with-ndbcluster-onlyRun only tests that include "ndb" in the filename.
--skip-ndb[cluster]Skip all tests that need cluster. Default.
--do-test=PREFIX or REGEXRun test cases with names prefixed with PREFIX or which fulfil the REGEX. 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.
--skip-test=PREFIX or REGEXSkip test cases with names prefixed with PREFIX or which fulfil the REGEX. See -do-test for examples.
--start-from=PREFIXSorts the list of names of the test cases to be run, and then starts with the test prefixed with PREFIX, where the prefix may be suite.testname or just testname.
--suite[s]=NAME1,..,NAMENComma 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-,percona-,perfschema-,plugins-,roles-,rpl-,sys_vars-,unit-,vcol-".
--skip-rplSkip the replication test cases.
--big-testAllow 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
--staging-runRun a limited number of tests (no slow tests). Used for running staging trees with valgrind.
--enable-disabledIgnore 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.
--print-testcasesDon't run the tests but print details about all the selected tests, in the order they would be run.
--skip-test-list=FILESkip the tests listed in FILE. Each line in the file is an entry and should be formatted as: <TESTNAME> : <COMMENT>

Options That Specify Ports

OptionDescription
--[mtr-]port-base=numBase for port numbers. Ports from this number to number+9 are reserved. Should be divisible by 10; if not it will be rounded down. May be set with environment variable MTR_PORT_BASE. If this value is set and is not "auto", it overrides build-thread.
--[mtr-]build-thread=numSpecify unique number to calculate port number(s) from. Can be set in environment variable MTR_BUILD_THREAD. Set MTR_BUILD_THREAD="auto" to automatically acquire a build thread id that is unique to current host. The more logical --port-base is supported as an alternative.

Options For Test Case Authoring

OptionDescription
--record TESTNAME (Re)generate the result file for TESTNAME.
--check-testcasesCheck testcases 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. Use --nocheck-testcases to disable.
mark-progressLog line number and elapsed time to <testname>.progress

Options That Pass On Options

OptionDescription
--mysqld=ARGSSpecify additional arguments to "mysqld"
--mysqltest=ARGSSpecify additional arguments to "mysqltest". Use additional --mysqld-env options to set more than one variable.

Options to Run Test On Running Server

OptionDescription
extern option=valueUse 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.

Options For Debugging the Product

OptionDescription
--boot-dbxRun the mysqld server used for bootstrapping the database through the dbx debugger.
--boot-dddRun the mysqld server used for bootstrapping the database through the ddd debugger.
--boot-gdbRun the mysqld server used for bootstrapping the database through the gdb debugger.
--client-dbxStart mysqltest client in the dbx debugger.
--client-dddStart mysqltest client in the ddd debugger.
--client-debugger=NAMEStart mysqltest in the selected debugger.
--client-gdbStart mysqltest client in the gdb debugger.
--dbxStart the mysqld(s) in the dbx debugger.
--dddStart the mysqld(s) in the ddd debugger.
--debugDump trace output for all servers and client programs.
--debug-commonSame as --debug, but sets the 'd' debug flags to "query,info,error,enter,exit"
--debug-serverUse debug version of server, but without turning on tracing.
--debugger=NAMEStart mysqld in the selected debugger.
--gdb[=COMMANDS]Start the mysqld(s) in the gdb debugger. From MariaDB 10.3.6, optionally execute specified commands (semicolon-separated) in gdb.
--manual-debugLet user manually start mysqld in debugger, before running test(s).
--manual-dbxLet user manually start mysqld in the dbx debugger , before running test(s).
--manual-dddLet user manually start mysqld in the ddd debugger , before running test(s).
--manual-gdbLet user manually start mysqld in the gdb debugger, before running test(s).
--manual-lldbLet user manually start mysqld in the lldb debugger, before running test(s).
--max-save-coreLimit the number of core files saved (to avoid filling up disks for heavily crashing server). Defaults to 5, set to 0 for no limit. Set its default with MTR_MAX_SAVE_CORE.
--max-save-datadirLimit the number of datadir saved (to avoid filling up disks for heavily crashing server). Defaults to 20, set to 0 for no limit. Set its default with MTR_MAX_SAVE_DATDIR.
--max-test-failLimit the number of test failurs before aborting the current test run. Defaults to 10, set to 0 for no limit. Set its default with MTR_MAX_TEST_FAIL.

Options For Valgrind

OptionDescription
--valgrindRun the "mysqltest" and "mysqld" executables using valgrind with default options. This and the following valgrind options require that the executables have been built with valgrind support.
--valgrind-allSynonym for --valgrind.
--valgrind-mysqldRun the "mysqld" executable with valgrind.
--valgrind-mysqltestRun the "mysqltest" and "mysql_client_test" executables with valgrind.
--valgrind-options=ARGSDeprecated, use --valgrind-option.
--valgrind-option=ARGSOption to give valgrind. Replaces default option(s). Can be specified more then once.
--valgrind-path=<EXE>Path to the valgrind executable.
--callgrindInstruct valgrind to use callgrind.

Options For Strace

OptionDescription
--straceRun the "mysqld" executables using strace. Default options are -f -o var/log/'mysqld-name'.strace
--strace-option=ARGSOption to give strace, replaces default option(s),
--strace-client=[path]Create strace output for mysqltest client, optionally specifying name and path to the trace program to use. Example: ./mysql-test-run.pl --strace-client=ktrace

Misc Options

OptionDescription
--user=USERUser for connecting to mysqld (default: root)
--comment=STRWrite STR to the output within lines filled with #, as a form of banner.
--timerShow test case execution time. Use no-timer to disable.
--verboseMore verbose output(use multiple times for even more)
--verbose-restartWrite when and why servers are restarted between test cases.
--startOnly initialize and start the servers, using the startup settings for the first specified test case Example: ./mysql-test-run.pl --start alias & start-dirty Only start the servers (without initialization) for the first specified test case
--start-and-exitSame as --start, but mysql-test-run terminates and leaves just the server running.
--start-dirtyThis 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.
--user-argsIn combination with start* and no test name, drops arguments to mysqld except those specified with --mysqld (if any).
--wait-allIf --start or --start-dirty option is used, wait for all servers to exit before finishing the process. Otherwise, it will terminate if one (of several) servers is restarted.
--fastDo 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.
--force-restartAlways restart servers between tests.
--parallel=NRun tests in N parallel threads (default 1) Use parallel=auto for auto-setting of N.
--repeat=NRun each test N number of times.
--retry=NIf 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.
--retry-failure=NWhen using the --retry option to retry failed tests, stop when N failures have occured (default 2). Setting it to 0 or 1 effectively turns off retries.
--reorderReorder tests to get fewer server restarts. This is the default behavior. There is no guarantee that a particular set of tests will always end up in the same order. Use -no-reorder to disable.
--helpDisplay help text.
--testcase-timeout=MINUTESMax test case run time in minutes (default 15).
--suite-timeout=MINUTESMax test suite run time in minutes (default 360).
--shutdown-timeout=SECONDSMax number of seconds to wait for server shutdown before killing servers (default 10).
--warningsScan the log files for warnings and report any suspicious ones; if any are found, the test will be marked as failed. Use --nowarnings to turn off.
--stop-file=fileIf this file is detected, mysqltest will not start new tests until the file is removed (also MTR_STOP_FILE environment variable).
--stop-keep-alive=secWorks 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).
--sleep=SECONDSPassed to mysqltest; will be used as fixed sleep time.
--debug-sync-timeout=NUMSet default timeout for WAIT_FOR debug sync actions. Disable facility with NUM=0.
--gcovCollect coverage information after the test. The result is a dgcov file per source and header file and a last_changes.dgcov file in the vardir with the coverage for the uncommitted changes if any (or the last commit).
--gprofCollect profiling information using the gprof profiling tool.
--experimental=<file>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.
--report-featuresFirst 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.
--timestampPrint timestamp before each test report line, showing when the test ended.
--timediffUsed with --timestamp, also print time passed since the previous test started.
--max-connections=NMaximum number of simultaneous server connections that may be used per test. Default is 128. Minimum is 8, maximum is 5120. Corresponds to the same option for mysqltest.
--default-myisamSet default storage engine to MyISAM for non-innodb tests. This is needed after switching default storage engine to InnoDB.
--report-timesReport how much time has been spent on different phases of test execution.
--stress=ARGSRun stress test, providing options to mysql-stress-test.pl. Options are separated by comma.

Comments

Comments loading...