What’s in MO-Tester?

From the 0.5.0 version, MatrixOne introduces an automatic testing framework MO-Tester.

This tester is designed to test MatrixOne or other database functionalities with SQL.

MO-Tester is a java-based tester suite for MatrixOne. It has built a whole toolchain to run automatic SQL tests. It contains the test cases and results. Once launched, MO-Tester runs all SQL test cases with MatrixOne, and compares all output SQL results with expected results. All successful and failed cases will be logged into reports.

MO-Tester content locations:

The Cases and Results are 1-1 correspondence, and they are actually git submodules from MatrixOne repository. Adding new cases and results should be in MatrixOne repo: https://github.com/matrixorigin/matrixone/tree/main/test

How to use MO-Tester?

1. Prepare the testing environment

  • Make sure you have installed jdk8.

  • Launch MatrixOne or other database instance. Please refer to more information about how to install and launch MatrixOne.

  • Clone mo-tester repository.

  1. git clone https://github.com/matrixorigin/mo-tester.git
  • Clone matrixOne repository.
  1. git clone https://github.com/matrixorigin/matrixone.git

2. Configure mo-tester

  • In mo.yml file, configure the server address, default database name, username, and password, and so on. MO-tester is based on java, so these parameters are required for the JDBC(JDBC,Java Database Connectivity) driver. Below is a default example for a local standalone version MatrixOne.
  1. #jdbc
  2. jdbc:
  3.   driver: "com.mysql.cj.jdbc.Driver"
  4.   server:
  5.   - addr: "127.0.0.1:6001"
  6.   database:
  7.     default: "test"
  8.   paremeter:
  9.     characterSetResults: "utf8"
  10.     continueBatchOnError: "false"
  11.     useServerPrepStmts: "true"
  12.     alwaysSendSetIsolation: "false"
  13.     useLocalSessionState: "true"
  14.     zeroDateTimeBehavior: "CONVERT_TO_NULL"
  15.     failoverReadOnly: "false"
  16.     serverTimezone: "Asia/Shanghai"
  17.     socketTimeout: 30000
  18. #users
  19. user:
  20.   name: "root"
  21.   passwrod: "111"

3. Run mo-tester

  • With the simple below command, all the SQL test cases will automatically run and generate reports and error messages to report/report.txt and report/error.txt.
  1. > ./run.sh -p {path_name}/matrixone/test/cases

If you’d like to adjust the test range, you can just change the path parameter of run.yml. And you can also specify some parameters when executing the command ./run.sh, parameters are as followings:

ParametersDescription
-pset the path of test cases needed to be executed by mo-tester, the default value is configured by the path in run.yaml
-mset the method that mo-tester will run with, the default value is configured by the method in run.yaml
-tset the type of the format that mo-tester executes the SQL command in, the default value is configured by the type in run.yaml
-rset The success rate that test cases should reach, the default value is configured by the rate in run.yaml
-iset the including list, and only script files in the path whose name contains one of the lists will be executed, if more than one, separated by ,, if not specified, refers to all cases included
-eset the excluding list, and script files in the path whose name contains one of the lists will not be executed, if more than one, separated by ,, if not specified, refers to none of the cases excluded
-gmeans SQL commands which is marked with [bvt:issue] flag will not be executed,this flag starts with [— @bvt:issue#{issueNO.}],and ends with [— @bvt:issue],eg:
— @bvt:issue#3236

select date_add(“1997-12-31 23:59:59”,INTERVAL “-10000:1” HOUR_MINUTE);

select date_add(“1997-12-31 23:59:59”,INTERVAL “-100 1” YEAR_MONTH);

— @bvt:issue

Those two sql commands are associated with issue#3236, and they will not be executed in bvt test, until the flag is removed when issue#3236 is fixed.
-nmeans the metadata of the resultset will be ignored when comparing the result
-conly check whether the case file matches the related result file

Examples:

  1. ./run.sh -p {path_name}/matrixone/test/cases -m run -t script -r 100 -i select,subquery -e substring -g

If you want to automatically generate SQL results for the new SQL cases, you can just change the method parameter of run.yml file to genrs, or you can just change the command -m run to -m genrs, then running the ./run.sh scripts will directly record test results in the same path of the new SQL case file. For more information on example, see Example 4.

Note

Every time running run.sh will overwrite the report of the error.txt file, report.txt file, and success.txt file in the mo-tester repository.

4. Check the report

  • Once the test is finished, mo-tester generates error.txt file, report.txt file and success.txt file reports.

  • An example of report.txt file looks like this:

  1. [SUMMARY] COST : 98s, TOTAL :12702, SUCCESS : 11851, FAILED :13, IGNORED :838, ABNORAML :0, SUCCESS RATE : 99%
  2. [{path_name}/matrixone/test/cases/auto_increment/auto_increment_columns.sql] COST : 2.159s, TOTAL :185, SUCCESS :163, FAILED :0, IGNORED :22, ABNORAML :0, SUCCESS RATE : 100%
  3. [{path_name}/matrixone/test/cases/benchmark/tpch/01_DDL/01_create_table.sql] COST : 0.226s, TOTAL :11, SUCCESS :11, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  4. [{path_name}/matrixone/test/cases/benchmark/tpch/02_LOAD/02_insert_customer.sql] COST : 0.357s, TOTAL :16, SUCCESS :16, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
Report KeywordsDescription
TOTALthe total number of executed test cases (SQL)
SUCCESSThe total number of successfully executed test cases(SQL)
FAILEDthe total number of failed executed test case(SQL)
IGNOREDthe total number of ignored executed test cases (SQL), especially with the —bvt:issue tag test cases (SQL)
ABNORAMLthe total number of abnormal executed test cases (SQL), such as the execution of MatrixOne can’t determine the actual result is a system exception or .result file parsing error, etc
SUCCESS RATEsuccess rate: SUCCESS/(TOTAL - IGNORED)
  • An example of error.txt file looks like this:
  1. [ERROR]
  2. [SCRIPT   FILE]: cases/transaction/atomicity.sql
  3. [ROW    NUMBER]: 14
  4. [SQL STATEMENT]: select * from test_11 ;
  5. [EXPECT RESULT]:
  6. c   d
  7. 1   1
  8. 2 2
  9. [ACTUAL RESULT]:
  10. c   d
  11. 1   1

5. Test Examples

Example 1

Example Description: Run all test cases in the /cases path of the matrixone repository.

Steps:

  1. Get the latest matrixone code.
  1. cd matrixone
  2. git pull https://github.com/matrixorigin/matrixone.git
  1. To run all the test cases of the matrixone repository, you need switch into the mo-tester repository first, see the following commands:
  1. cd mo-tester
  2. ./run.sh -p {path_name}/matrixone/test/cases
  1. Check the result reports in the error.txt file, report.txt file, and success.txt file in the mo-tester/report/ path.

Example 2

Example Description: Run the test cases in the /cases/transaction/ path of the matrixone repository.

Steps:

  1. Get the latest matrixone code.
  1. cd matrixone
  2. git pull https://github.com/matrixorigin/matrixone.git
  1. To run the test cases in the cases/transaction/ path of the matrixone repository, you need switch into the mo-tester repository first, see the following commands:
  1. cd mo-tester
  2. ./run.sh -p {path_name}/matrixone/test/cases/transaction/
  1. Check the result reports in the error.txt file, report.txt file, and success.txt file in the mo-tester/report/ path. The example of the expected report.txt looks like this:
  1. [SUMMARY] COST : 5s, TOTAL :1362, SUCCESS : 1354, FAILED :0, IGNORED :8, ABNORAML :0, SUCCESS RATE : 100%
  2. [{path_name}/matrixone/test/cases/transaction/atomicity.sql] COST : 0.575s, TOTAL :66, SUCCESS :66, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  3. [{path_name}/matrixone/test/cases/transaction/autocommit.test] COST : 0.175s, TOTAL :50, SUCCESS :50, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  4. [{path_name}/matrixone/test/cases/transaction/autocommit_1.sql] COST : 1.141s, TOTAL :296, SUCCESS :288, FAILED :0, IGNORED :8, ABNORAML :0, SUCCESS RATE : 100%
  5. [{path_name}/matrixone/test/cases/transaction/autocommit_atomicity.sql] COST : 0.52s, TOTAL :75, SUCCESS :75, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  6. [{path_name}/matrixone/test/cases/transaction/autocommit_isolation.sql] COST : 1.607s, TOTAL :215, SUCCESS :215, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  7. [{path_name}/matrixone/test/cases/transaction/autocommit_isolation_1.sql] COST : 1.438s, TOTAL :241, SUCCESS :241, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  8. [{path_name}/matrixone/test/cases/transaction/isolation.sql] COST : 1.632s, TOTAL :202, SUCCESS :202, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  9. [{path_name}/matrixone/test/cases/transaction/isolation_1.sql] COST : 1.512s, TOTAL :217, SUCCESS :217, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%

Example 3

Example Description: Run the single test case cases/transaction/atomicity.sql.

Steps:

  1. Get the latest matrixone code.
  1. cd matrixone
  2. git pull https://github.com/matrixorigin/matrixone.git
  1. To run the test cases cases/transaction/atomicity.sql, you need switch into the mo-tester repository first, see the following commands:
  1. cd mo-tester
  2. ./run.sh -p {path_name}/matrixone/test/cases/transaction/atomicity.sql
  1. Check the result reports in the error.txt file, report.txt file, and success.txt file in the mo-tester/report/ path. The example of the expected report.txt looks like this:
  1. [SUMMARY] COST : 0s, TOTAL :66, SUCCESS : 66, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  2. [{path_name}/matrixone/test/cases/transaction/atomicity.sql] COST : 0.56s, TOTAL :66, SUCCESS :66, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%

Example 4

Example Description:

  • Create a new folder named local_test and place it in {path_name}/matrixone/test/cases
  • Add a test file named new_test.sql to {path_name}/matrixone/test/cases/local_test/
  • Only run the single test case new_test.sql*

Steps

  1. Get the latest matrixone code.
  1. cd matrixone
  2. git pull https://github.com/matrixorigin/matrixone.git

  1. Generate test results:

  2. Method 1: To generate the test result, you need switch into the mo-tester repository first, then, run the following command.

    1. cd mo-tester
    2. ./run.sh -p {path_name}/matrixone/test/cases/local_test/new_test.sql -m genrs -g

  3. Method 2: Open the run.yml file in the mo-tester repository, change the method parameter from the default run to genrs, and run the following command to generate the test result.

    1. cd mo-tester
    2. ./run.sh -p {path_name}/matrixone/test/cases/local_test/new_test.sql

  4. Check the result file in the test/cases,result/ path of the matrixone repository.

  5. Check the result reports in the error.txt file, report.txt file, and success.txt file in the mo-tester/report/ path. The example of the expected report.txt looks like this:

  1. [SUMMARY] COST : 0s, TOTAL :66, SUCCESS : 66, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%
  2. [{path_name}/matrixone/test/cases/transaction/atomicity.sql] COST : 0.56s, TOTAL :66, SUCCESS :66, FAILED :0, IGNORED :0, ABNORAML :0, SUCCESS RATE : 100%

Reference

For more information on the annotations of MO-Tester, see MO-Tester Annotations.