集成测试

设计

集成测试包括 3 个模块：测试用例、测试环境以及测试引擎。

测试用例

用于定义待测试的 SQL 以及测试结果的断言数据。 每个用例定义一条 SQL，SQL 可定义多种数据库执行类型。

测试环境

用于搭建运行测试用例的数据库和 ShardingSphere-Proxy 环境。 环境又具体分为环境准备方式，数据库类型和场景。

环境准备方式分为 Native 和 Docker，未来还将增加 Embed 类型的支持。

  • Native 环境用于测试用例直接运行在开发者提供的测试环境中，适于调试场景；
  • Docker 环境由 Maven 运行 Docker-Compose 插件直接搭建，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action；
  • Embed 环境由测试框架自动搭建嵌入式 MySQL，适用于 ShardingSphere-JDBC 的本地环境测试。

当前默认采用 Native 环境，使用 ShardingSphere-JDBC + H2 数据库运行测试用例。 通过 Maven 的 -P -Pit.env.docker 参数可以指定 Docker 环境的运行方式。 未来将采用 Embed 环境的 ShardingSphere-JDBC + MySQL，替换 Native 执行测试用例的默认环境类型。

数据库类型目前支持 MySQL、PostgreSQL、SQLServer 和 Oracle，并且可以支持使用 ShardingSphere-JDBC 或是使用 ShardingSphere-Proxy 执行测试用例。

场景用于对 ShardingSphere 支持规则进行测试，目前支持数据分片和读写分离的相关场景，未来会不断完善场景的组合。

测试引擎

用于批量读取测试用例，并逐条执行和断言测试结果。

测试引擎通过将用例和环境进行排列组合，以达到用最少的用例测试尽可能多场景的目的。

每条 SQL 会以数据库类型 * 接入端类型 * SQL 执行模式 * JDBC 执行模式 * 场景的组合方式生成测试报告，目前各个维度的支持情况如下：

  • 数据库类型：H2、MySQL、PostgreSQL、SQLServer 和 Oracle；
  • 接入端类型：ShardingSphere-JDBC 和 ShardingSphere-Proxy；
  • SQL 执行模式：Statement 和 PreparedStatement；
  • JDBC 执行模式：execute 和 executeQuery (查询) / executeUpdate (更新)；
  • 场景：分库、分表、读写分离和分库分表 + 读写分离。

因此，1 条 SQL 会驱动：数据库类型(5) * 接入端类型(2) * SQL 执行模式(2) * JDBC 执行模式(2) * 场景(4) = 160 个测试用例运行，以达到项目对于高质量的追求。

使用指南

模块路径：shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-suite

测试用例配置

SQL 用例在 resources/cases/${SQL-TYPE}/${SQL-TYPE}-integration-test-cases.xml。

用例文件格式如下：

  1. <integration-test-cases>
  2.     <test-case sql="${SQL}">
  3.         <assertion parameters="${value_1}:${type_1}, ${value_2}:${type_2}" expected-data-file="${dataset_file_1}.xml" />
  4.         <!-- ... more assertions -->
  5.         <assertion parameters="${value_3}:${type_3}, ${value_4}:${type_4}" expected-data-file="${dataset_file_2}.xml" />
  6.      </test-case>
  8.     <!-- ... more test cases -->
  9. </integration-test-cases>

expected-data-file 的查找规则是：

  1. 查找同级目录中 dataset\${SCENARIO_NAME}\${DATABASE_TYPE}\${dataset_file}.xml 文件；
  2. 查找同级目录中 dataset\${SCENARIO_NAME}\${dataset_file}.xml 文件；
  3. 查找同级目录中 dataset\${dataset_file}.xml 文件；
  4. 都找不到则报错。

断言文件格式如下：

  1. <dataset>
  2.     <metadata>
  3.         <column name="column_1" />
  4.         <!-- ... more columns -->
  5.         <column name="column_n" />
  6.     </metadata>
  7.     <row values="value_01, value_02" />
  8.     <!-- ... more rows -->
  9.     <row values="value_n1, value_n2" />
  10. </dataset>

环境配置

${SCENARIO-TYPE} 表示场景名称，在测试引擎运行中用于标识唯一场景。 ${DATABASE-TYPE} 表示数据库类型。

Native 环境配置

目录：src/test/resources/env/${SCENARIO-TYPE}

  • scenario-env.properties: 数据源配置
  • rules.yaml: 规则配置
  • databases.xml: 真实库名称
  • dataset.xml: 初始化数据
  • init-sql\${DATABASE-TYPE}\init.sql: 初始化数据库表结构
  • authority.xml: 待补充

Docker 环境配置

目录：src/test/resources/docker/${SCENARIO-TYPE}

  • docker-compose.yml: Docker-Compose 配置文件，用于 Docker 环境启动
  • proxy/conf/config-${SCENARIO-TYPE}.yaml: 规则配置

Docker 环境配置为 ShardingSphere-Proxy 提供了远程调试端口，可以在 docker-compose.yml 文件的 shardingsphere-proxy中找到第 2 个暴露的端口用于远程调试。

运行测试引擎

配置测试引擎运行环境

通过配置 src/test/resources/env/engine-env.properties 控制测试引擎。

所有的属性值都可以通过 Maven 命令行 -D 的方式动态注入。

  1. # 配置环境类型，只支持单值。可选值：docker或空，默认值：空
  2. it.env.type=${it.env}
  3. # 待测试的接入端类型，多个值可用逗号分隔。可选值：jdbc, proxy，默认值：jdbc
  4. it.adapters=jdbc
  6. # 场景类型，多个值可用逗号分隔。可选值：db, tbl, dbtbl_with_replica_query, replica_query
  7. it.scenarios=db,tbl,dbtbl_with_replica_query,replica_query
  9. # 场景类型，多个值可用逗号分隔。可选值：H2, MySQL, Oracle, SQLServer, PostgreSQL
  10. it.databases=H2,MySQL,Oracle,SQLServer,PostgreSQL
  12. # 是否运行附加测试用例
  13. it.run.additional.cases=false

运行调试模式

  • 标准测试引擎 运行 org.apache.shardingsphere.test.integration.engine.it.${SQL-TYPE}.General${SQL-TYPE}IT 以启动不同 SQL 类型的测试引擎。

  • 批量测试引擎 运行 org.apache.shardingsphere.test.integration.engine.it.dml.BatchDMLIT，以启动为 DML 语句提供的测试 addBatch() 的批量测试引擎。

  • 附加测试引擎 运行 org.apache.shardingsphere.test.integration.engine.it.${SQL-TYPE}.Additional${SQL-TYPE}IT 以启动使用更多 JDBC 方法调用的测试引擎。 附加测试引擎需要通过设置 it.run.additional.cases=true 开启。

运行Docker 模式

  1. ./mvnw -B clean install -f shardingsphere-test/shardingsphere-integration-test/pom.xml -Pit.env.docker -Dit.adapters=proxy,jdbc -Dit.scenarios=${scenario_name_1,scenario_name_1,scenario_name_n} -Dit.databases=MySQL

注意事项

  1. 如需测试 Oracle，请在 pom.xml 中增加 Oracle 驱动依赖；
  2. 为了保证测试数据的完整性和易读性，整合测试中的分库分表采用了 10 库 10 表的方式，完全运行测试用例所需时间较长。