The mysqltest program runs a test case against a MariaDB or MySQL server and optionally compares the output with a result file. This program reads input written in a special test language. Typically, you invoke mysqltest> via rather than invoking it directly.

mysqltest_embedded is similar but is built with support for the libmysqld embedded server.

Features of mysqltest:

  • Can send SQL statements to the server for execution
  • Can execute external shell commands
  • Can test whether the result from an SQL statement or shell command is as expected
  • Can connect to one or more standalone mysqld servers and switch between connections
  • Can connect to an embedded server (libmysqld), if MariaDB or MySQL is compiled with support for libmysqld. (In this case, the executable is named mysqltest_embedded rather than mysqltest.)

By default, mysqltest reads the test case on the standard input. To run mysqltest this way, you normally invoke it like this:

shell> mysqltest **[options] [db_name]** < //test_file//

You can also name the test case file with a --test-file=file_name option.

The exit value from mysqltest is 0 for success, 1 for failure, and 62 if it skips the test case (for example, if after checking some preconditions it decides not to run the test).


mysqltest supports the following options:

--help, -?Display a help message and exit.
--basedir=dir, -b dirThe base directory for tests.
--character-sets-dir=pathThe directory where character sets are installed.
--compress, -CCompress all information sent between the client and the server if both support compression.
--connect-timeout=NThis can be used to set the MYSQL_OPT_CONNECT_TIMEOUT parameter of mysql_options to change the number of seconds before an unsuccessful connection attempt times out.
--continue-on-errorContinue test even if we got an error. This is mostly useful when testing a storage engine to see what from a test file it can execute, or to find all syntax errors in a newly created big test file
--cursor-protocolUse cursors for prepared statements.
--database=db_name, -D db_nameThe default database to use.
--debug[=debug_options], -#[debug_options]Write a debugging log if MariaDB is built with debugging support. The default debug_options value is d:t:S:i:O,/tmp/mysqltest.trace on Unix and d:t:i:O,\mysqld.trace on Windows.
--debug-checkPrint some debugging information when the program exits.
--debug-infoPrint debugging information and memory and CPU usage statistics when the program exits.
--host=host_name, -h host_nameConnect to the server on the given host.
--logdir=dir_nameThe directory to use for log files.
--mark-progressWrite the line number and elapsed time to test_file.progress.
--max-connect-retries=numThe maximum number of connection attempts when connecting to server.
--max-connections=numThe maximum number of simultaneous server connections per client (that is, per test). If not set, the maximum is 128. Minimum allowed limit is 8, maximum is 5120.
--no-defaultsDo not read default options from any option files. If used, this must be the first option.
--non-blocking-apiUse the non-blocking client API for communication.
--overlay-dir=nameOverlay directory.
--password[=password], -p[password]The password to use when connecting to the server. If you use the short option form (-p), you cannot have a space between the option and the password. If you omit the password value following the --password or -p option on the command line, you are prompted for one.
--port=port_num, -P port_numThe TCP/IP port number to use for the connection, or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306).
--prologue=nameInclude the contents of the given file before processing the contents of the test file. The included file should have the same format as other mysqltest test files. This option has the same effect as putting a --source file_name command as the first line of the test file.
--protocol=nameThe protocol to use for connection (tcp, socket, pipe, memory).
--ps-protocolUse the prepared-statement protocol for communication.
--quietSuppress all normal output. This is a synonym for --silent.
--record, -rRecord the output that results from running the test file into the file named by the --result-file option, if that option is given. It is an error to use this option without also using --result-file.
--result-file=file_name, -R file_nameThis option specifies the file for test case expected results. --result-file, together with --record, determines how mysqltest treats the test actual and expected results for a test case:

If the test produces no results, mysqltest exits with an error message to that effect, unless --result-file is given and the named file is an empty file.

Otherwise, if --result-file is not given, mysqltest sends test results to the standard output.

With --result-file but not --record, mysqltest reads the expected results from the given file and compares them with the actual results. If the results do not match, mysqltest writes a reject file in the same directory as the result file, outputs a diff of the two files, and exits with an error.

With both --result-file and --record, mysqltest updates the given file by writing the actual test results to it.
--result-format-version=# Version of the result file format to use.
--server-arg=value, -A valuePass the argument as an argument to the embedded server. For example, --server-arg=--tmpdir=/tmp or --server-arg=--core. Up to 64 arguments can be given.
--server-file=file_name, -F file_nameRead arguments for the embedded server from the given file. The file should contain one argument per line.
--shared-memory-base-nameShared-memory name to use for Windows connections using shared memory to a local server (started with the --shared-memory option). Case-sensitive.
--silent, -sSuppress all normal output.
--sleep=num, -T numCause all sleep commands in the test case file to sleep num seconds. This option does not affect real_sleep commands. An option value of 0 can be used, which effectively disables sleep commands in the test case.
--socket=path, -S pathThe socket file to use when connecting to localhost (which is the default host).
--sp-protocolExecute DML statements within a stored procedure. For every DML statement, mysqltest creates and invokes a stored procedure that executes the statement rather than executing the statement directly.
--sslEnable SSL for connection (automatically enabled with other flags). Disable with --skip-ssl.
--ssl-ca=nameCA file in PEM format (check OpenSSL docs, implies --ssl).
--ssl-capath=nameCA directory (check OpenSSL docs, implies --ssl).
--ssl-cert=nameX509 cert in PEM format (implies --ssl).
--ssl-cipher=nameSSL cipher to use (implies --ssl).
--ssl-key=nameX509 key in PEM format (implies --ssl).
--ssl-crl=nameCertificate revocation list (implies --ssl).
--ssl-crlpath=nameCertificate revocation list path (implies --ssl).
--ssl-verify-server-certVerify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default.
--suite-dir=nameSuite directory.
--tail-lines=nnSpecify how many lines of the result to include in the output if the test fails because an SQL statement fails. The default is 0, meaning no lines of result printed.
--test-file=file_name, -x file_nameRead test input from this file. The default is to read from the standard input.
--timer-file=file_name, -m file_nameIf given, the number of microseconds spent running the test will be written to this file. This is used by for its reporting.
--tmpdir=dir_name, -t dir_nameThe temporary directory where socket files are created.
--user=user_name, -u user_nameThe user name to use when connecting to the server.
--verbose, -vVerbose mode. Print out more information about what the program does.
--version, -VDisplay version information and exit.
--view-protocolEvery SELECT statement is wrapped inside a view.

See also


Comments loading...