Use obd.sh to run mysqltest|V4.4.2|OceanBase Database|docs|OceanBase Documentations

Parameter	Required?	Description
servers	Yes	Specify each server in the format of `- name: server identifier (line feed) ip: server IP address`. You can specify multiple servers. The server identifiers must be unique. You can specify unique server IP addresses in the format of `- <ip> (line feed) - <ip>`, where `- <ip>` is equivalent to `- name: server IP address (line feed) ip: server IP address`.
mysql_port	Yes	The port number for the SQL service protocol.
rpc_port	Yes	The port number for remote access, which is the remote procedure call (RPC) communication port between the observer process and other node processes.
home_path	Yes	The installation path of the component.
production_mode	Yes	Specifies whether to enable the production mode. If the production mode is enabled, mysqltest checks whether the server resources meet the production environment requirements. We recommend that you disable this mode for a test scenario. Otherwise, the deployment may fail.
devname	No	The network interface card (NIC) corresponding to the IP address specified in `servers`. You can view the mapping between IP addresses and NICs by using the `ip addr` command.
listen_port	Yes	The listening port of ODP.
prometheus_listen_port	Yes	The Prometheus service port of ODP.

Option	Required?	Data type	Default value	Description
-n	Yes	String	Empty	The name of the cluster where the test is to be run.
--component	No	String	Empty	The name of the component to be tested. Valid values: `obproxy`, `obproxy-ce`, `oceanbase`, and `oceanbase-ce`. If you do not specify a value, the existence of `obproxy`, `obproxy-ce`, `oceanbase`, and `oceanbase-ce` is checked sequentially. The traversal stops when a component is found, and the component is then tested.
--test-server	No	String	The name of the first node under the specified component.	The server to be tested. You can set this option to the value of `name` in `servers` in the `.yaml` file. If `name` is not specified for the `servers` parameter, you can use the `ip` value. It must be a node under the specified component.
--user	No	String	admin	The username used to run the test. Generally, you do not need to modify the value.
--password	No	String	admin	The user password used to run the test.
--database	No	String	test	The database where the test is to be run.
--mysqltest-bin	No	String	/u01/obclient/bin/mysqltest	The path to the directory where the binary files of mysqltest are stored.
--obclient-bin	No	String	obclient	The path to the directory where the binary files of OceanBase Command-Line Client (OBClient) are stored.
--test-dir	No	String	./mysql_test/t	The directory where the test file required by mysqltest is stored. If the test file cannot be found, the system will try to find it in the built-in obd directory.
--test-file-suffix	No	String	.test	The suffix of the test file that is required by mysqltest.
--result-dir	No	String	./mysql_test/r	The directory where the result file required by mysqltest is stored. If the result file cannot be found, the system will try to find it in the built-in obd directory.
--result-file-suffix	No	String	.result	The suffix of the result file that is required by mysqltest.
--record	No	Boolean	false	The record file that records only the execution result of mysqltest.
--record-dir	No	String	./record	The directory where the execution result of mysqltest is stored.
--record-file-suffix	No	String	.record	The suffix of the file that records the execution result of mysqltest.
--tmp-dir	No	String	./tmp	The temporary directory for mysqltest, which stores temporary files generated during the test.
--var-dir	No	String	./var	The path where the log directory is to be created. The path will be passed in as the `--log-dir` option to mysqltest.
--test-set	No	String	N/A	The test case array. Separate multiple cases with commas (`,`).
--exclude	No	String	N/A	The array of test cases to be excluded. Separate multiple cases with commas (`,`).
--test-pattern	No	String	N/A	The regular expression that matches the test file name. All cases that match the expression will override the `test-set` option.
--suite	No	String	N/A	The suite array. Separate tests in a suite with commas (`,`).
--suite-dir	No	String	./mysql_test/test_suite	The path where suites are stored. When a suite cannot be found, the system will try to find it in the built-in obd directory.
--all	No	Boolean	false	Specifies to execute all cases in the `--suite-dir` directory. `--suite-dir` specifies the path where suites are stored.
--need-init	No	Boolean	false	Specifies to execute initialization SQL files. For a new cluster, the system may need to execute some initialization files before running mysqltest, for example, initialization files that create accounts and tenants required for creating test cases. The feature is disabled by default.
--init-sql-dir	No	String	./	The directory where initialization SQL files are located. When the SQL files cannot be found, the system will try to find them in the built-in obd directory.
--init-sql-files	No	String	Empty	The array of initialization SQL files to be executed. Separate the files with commas (`,`). If initialization is required but this option is not set, obd executes the built-in initialization file based on the cluster configuration.
--auto-retry	No	Boolean	false	Specifies to automatically redeploy the cluster upon a deployment failure.
--psmall	No	Boolean	false	Specifies whether to execute the cases in psmall mode.
--slices	No	Integer	Empty	The number of slices into which the case to be executed is divided.
--slice-idx	No	Integer	Empty	The ID of the current slice.
--slb-host	No	String	Empty	The host for soft load balancing.
--exec-id	No	String	Empty	The ID of the execution.
--case-filter	No	String	./mysql_test/filter.py	The `filter.py` file, which contains lists of cases to be filtered out.
--reboot-timeout	No	Integer	0	The timeout period for a restart.
--reboot-retries	No	Integer	5	The number of retries allowed if a restart fails.
--collect-all	No	Boolean	false	Specifies whether to collect component logs.
--log-dir	No	String	$--var-dir/log	The path to the directory where the mysqltest logs are stored.
--log-pattern	No	String	*.log	The regular expression that is used to match log file names. Files that match the expression are collected.
--case-timeout	No	Integer	3600	The timeout period for a single test of mysqltest.
--disable-reboot	No	Boolean	false	Specifies whether to disable restarts during the test.
--collect-components	No	String	Empty	The components for which the logs are collected. Separate the components with commas (`,`).
--init-only	No	Boolean	false	Specifies whether to execute only initialization SQL files.

-n

Yes

String

Empty

The name of the cluster where the test is to be run.

--component

No

String

Empty

The name of the component to be tested. Valid values: obproxy, obproxy-ce, oceanbase, and oceanbase-ce. If you do not specify a value, the existence of obproxy, obproxy-ce, oceanbase, and oceanbase-ce is checked sequentially. The traversal stops when a component is found, and the component is then tested.

--test-server

No

String

The name of the first node under the specified component.

The server to be tested. You can set this option to the value of name in servers in the .yaml file. If name is not specified for the servers parameter, you can use the ip value. It must be a node under the specified component.

--user

No

String

admin

The username used to run the test. Generally, you do not need to modify the value.

--password

No

String

admin

The user password used to run the test.

--database

No

String

test

The database where the test is to be run.

--mysqltest-bin

No

String

/u01/obclient/bin/mysqltest

The path to the directory where the binary files of mysqltest are stored.

--obclient-bin

No

String

obclient

The path to the directory where the binary files of OceanBase Command-Line Client (OBClient) are stored.

--test-dir

No

String

./mysql_test/t

The directory where the test file required by mysqltest is stored. If the test file cannot be found, the system will try to find it in the built-in obd directory.

--test-file-suffix

No

String

.test

The suffix of the test file that is required by mysqltest.

--result-dir

No

String

./mysql_test/r

The directory where the result file required by mysqltest is stored. If the result file cannot be found, the system will try to find it in the built-in obd directory.

--result-file-suffix

No

String

.result

The suffix of the result file that is required by mysqltest.

--record

No

Boolean

false

The record file that records only the execution result of mysqltest.

--record-dir

No

String

./record

The directory where the execution result of mysqltest is stored.

--record-file-suffix

No

String

.record

The suffix of the file that records the execution result of mysqltest.

--tmp-dir

No

String

./tmp

The temporary directory for mysqltest, which stores temporary files generated during the test.

--var-dir

No

String

./var

The path where the log directory is to be created. The path will be passed in as the --log-dir option to mysqltest.

--test-set

No

String

N/A

The test case array. Separate multiple cases with commas (,).

--exclude

No

String

N/A

The array of test cases to be excluded. Separate multiple cases with commas (,).

--test-pattern

No

String

N/A

The regular expression that matches the test file name. All cases that match the expression will override the test-set option.

--suite

No

String

N/A

The suite array. Separate tests in a suite with commas (,).

--suite-dir

No

String

./mysql_test/test_suite

The path where suites are stored. When a suite cannot be found, the system will try to find it in the built-in obd directory.

--all

No

Boolean

false

Specifies to execute all cases in the --suite-dir directory. --suite-dir specifies the path where suites are stored.

--need-init

No

Boolean

false

Specifies to execute initialization SQL files. For a new cluster, the system may need to execute some initialization files before running mysqltest, for example, initialization files that create accounts and tenants required for creating test cases. The feature is disabled by default.

--init-sql-dir

No

String

./

The directory where initialization SQL files are located. When the SQL files cannot be found, the system will try to find them in the built-in obd directory.

--init-sql-files

No

String

Empty

The array of initialization SQL files to be executed. Separate the files with commas (,). If initialization is required but this option is not set, obd executes the built-in initialization file based on the cluster configuration.

--auto-retry

No

Boolean

false

Specifies to automatically redeploy the cluster upon a deployment failure.

--psmall

No

Boolean

false

Specifies whether to execute the cases in psmall mode.

--slices

No

Integer

Empty

The number of slices into which the case to be executed is divided.

--slice-idx

No

Integer

Empty

The ID of the current slice.

--slb-host

No

String

Empty

The host for soft load balancing.

--exec-id

No

String

Empty

The ID of the execution.

--case-filter

No

String

./mysql_test/filter.py

The filter.py file, which contains lists of cases to be filtered out.

--reboot-timeout

No

Integer

0

The timeout period for a restart.

--reboot-retries

No

Integer

5

The number of retries allowed if a restart fails.

--collect-all

No

Boolean

false

Specifies whether to collect component logs.

--log-dir

No

String

$--var-dir/log

The path to the directory where the mysqltest logs are stored.

--log-pattern

No

String

*.log

The regular expression that is used to match log file names. Files that match the expression are collected.

--case-timeout

No

Integer

3600

The timeout period for a single test of mysqltest.

--disable-reboot

No

Boolean

false

Specifies whether to disable restarts during the test.

--collect-components

No

String

Empty

The components for which the logs are collected. Separate the components with commas (,).

--init-only

No

Boolean

false

Specifies whether to execute only initialization SQL files.

Use obd.sh to run mysqltest

Background information

Concepts

Note

Procedure

Step 1: Compile the source code of OceanBase Database

Step 2: Deploy the compiled OceanBase file

Note

Step 3: Run a mysqltest test

Appendix