[GitHub] [shardingsphere] sandynz commented on a diff in pull request #18524: Add Scaling IT docs

[GitBox <gi...@apache.org>]

sandynz commented on code in PR #18524:
URL: https://github.com/apache/shardingsphere/pull/18524#discussion_r904462363


##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，

Review Comment:
   The last '，' could be improved.



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试

Review Comment:
   Every english word should be seperated by blank, e.g. `Native_`, `_IDE_`, `_debug_`.
   And also other places.



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试
+- Docker环境  环境由 Maven 运行，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action
+
+当前默认采用 Docker 环境，涉及到的 ShardingSphere-Proxy, Zookeeper, 数据库实例(MySQL,PostgreSQL), 都通过Docker自动启动。
+
+数据库类型目前支持 MySQL、PostgreSQL、openGauss
+
+## 使用指南
+
+模块路径：`shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling`
+
+测试的Class分布如下：
+
+核心用例：
+- MySQLGeneralScalingIT: 覆盖的测试场景最多，包括部分表迁移，表字段最多样等
+- PostgreSQLGeneralScalingIT: 类似，只不过数据库类型是 PostgreSQL/openGauss，包含自定义schema迁移场景
+
+主键用例：
+
+- TextPrimaryKeyScalingIT: 支持主键为文本类型的表迁移
+
+
+### 配置文件
+
+目录：`resources/env/`
+- /common: 存放scaling过程中用到的Dist SQL
+- /{SQL-TYPE}: 存放数据库级别的配置文件
+- /scenario: 存放测试的场景的配置文件，主要是SQL，不同数据库可能写法不一样
+
+### 运行测试引擎
+
+所有的属性值都可以通过 Maven 命令行 `-D` 的方式动态注入。
+
+#### Native 环境启动
+
+Native环境要求本地自行启动 ShardingSphere-Proxy（以及其自身依赖的Cluster，比如Zookeeper），同时要求ShardingSphere-Proxy的端口是3307，数据库会根据用户的配置自行启动，但是对应的端口都是数据库的默认端口（MySQL=3306,PostgreSQL=5432）。
+
+因此Native模式下不支持运行多个case，每次跑完需要自行清理Zookeeper中的信息，以及重启ShardingSphere-Proxy。
+
+启动方式如下: 找到需要测试的Case，比如 MySQLGeneralScalingIT, 在启动之前配置对应的 VM Option，新增如下配置
+```
+-Dit.cluster.env.type=native -Dit.env.mysql.version=${image-name}
+```
+> 其中的image-name需要是合法的docker image名称，比如：mysql:5.7, 多个的话用逗号隔开
+
+在IDE下使用Junit的方式启动即可

Review Comment:
   Could be ended with '。'



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试
+- Docker环境  环境由 Maven 运行，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action
+
+当前默认采用 Docker 环境，涉及到的 ShardingSphere-Proxy, Zookeeper, 数据库实例(MySQL,PostgreSQL), 都通过Docker自动启动。
+
+数据库类型目前支持 MySQL、PostgreSQL、openGauss
+
+## 使用指南
+
+模块路径：`shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling`
+
+测试的Class分布如下：
+
+核心用例：
+- MySQLGeneralScalingIT: 覆盖的测试场景最多，包括部分表迁移，表字段最多样等
+- PostgreSQLGeneralScalingIT: 类似，只不过数据库类型是 PostgreSQL/openGauss，包含自定义schema迁移场景
+
+主键用例：
+
+- TextPrimaryKeyScalingIT: 支持主键为文本类型的表迁移
+
+
+### 配置文件
+
+目录：`resources/env/`
+- /common: 存放scaling过程中用到的Dist SQL
+- /{SQL-TYPE}: 存放数据库级别的配置文件
+- /scenario: 存放测试的场景的配置文件，主要是SQL，不同数据库可能写法不一样
+
+### 运行测试引擎
+
+所有的属性值都可以通过 Maven 命令行 `-D` 的方式动态注入。
+
+#### Native 环境启动
+
+Native环境要求本地自行启动 ShardingSphere-Proxy（以及其自身依赖的Cluster，比如Zookeeper），同时要求ShardingSphere-Proxy的端口是3307，数据库会根据用户的配置自行启动，但是对应的端口都是数据库的默认端口（MySQL=3306,PostgreSQL=5432）。
+
+因此Native模式下不支持运行多个case，每次跑完需要自行清理Zookeeper中的信息，以及重启ShardingSphere-Proxy。
+
+启动方式如下: 找到需要测试的Case，比如 MySQLGeneralScalingIT, 在启动之前配置对应的 VM Option，新增如下配置
+```
+-Dit.cluster.env.type=native -Dit.env.mysql.version=${image-name}
+```
+> 其中的image-name需要是合法的docker image名称，比如：mysql:5.7, 多个的话用逗号隔开
+
+在IDE下使用Junit的方式启动即可
+
+#### Docker 环境启动
+
+第一步：打包镜像
+
+```bash
+./mvnw -B clean install -am -pl shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling -Pit.env.docker -DskipTests
+```
+
+运行以上命令会构建出一个用于集成测试的 Docker 镜像 `apache/shardingsphere-proxy-test:latest`。
+如果仅修改了测试代码，可以复用已有的测试镜像，无须重新构建。
+
+**Docker 环境配置为 ShardingSphere-Proxy 提供了远程调试端口，默认是3308。**
+可以在 ShardingSphereProxyDockerContainer 中自行修改
+
+#### 运行单个用例
+
+和Native一样，只需要改一个参数。
+
+```
+-Dit.cluster.env.type=docker -Dit.env.mysql.version=${image-name}
+```
+
+#### 运行多个用例
+
+```shell
+./mvnw -nsu -B install -f shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling/pom.xml -Dit.cluster.env.type=DOCKER -Dit.env.mysql.version=mysql:5.7,mysql:8.0 -Dit.env.postgresql.version=postgres:12-alpine
+```

Review Comment:
   Could be merged to `Docker 环境启动`, seprated to MySQL and PostgreSQL for better debugging, and also just keep one docker image for every database type.



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试
+- Docker环境  环境由 Maven 运行，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action
+
+当前默认采用 Docker 环境，涉及到的 ShardingSphere-Proxy, Zookeeper, 数据库实例(MySQL,PostgreSQL), 都通过Docker自动启动。
+
+数据库类型目前支持 MySQL、PostgreSQL、openGauss
+
+## 使用指南
+
+模块路径：`shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling`
+
+测试的Class分布如下：
+
+核心用例：
+- MySQLGeneralScalingIT: 覆盖的测试场景最多，包括部分表迁移，表字段最多样等
+- PostgreSQLGeneralScalingIT: 类似，只不过数据库类型是 PostgreSQL/openGauss，包含自定义schema迁移场景
+
+主键用例：
+
+- TextPrimaryKeyScalingIT: 支持主键为文本类型的表迁移
+
+
+### 配置文件
+
+目录：`resources/env/`
+- /common: 存放scaling过程中用到的Dist SQL

Review Comment:
   `Dist SQL` could be `DistSQL`



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试
+- Docker环境  环境由 Maven 运行，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action
+
+当前默认采用 Docker 环境，涉及到的 ShardingSphere-Proxy, Zookeeper, 数据库实例(MySQL,PostgreSQL), 都通过Docker自动启动。
+
+数据库类型目前支持 MySQL、PostgreSQL、openGauss
+
+## 使用指南
+
+模块路径：`shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling`
+
+测试的Class分布如下：
+
+核心用例：
+- MySQLGeneralScalingIT: 覆盖的测试场景最多，包括部分表迁移，表字段最多样等
+- PostgreSQLGeneralScalingIT: 类似，只不过数据库类型是 PostgreSQL/openGauss，包含自定义schema迁移场景
+
+主键用例：
+
+- TextPrimaryKeyScalingIT: 支持主键为文本类型的表迁移
+
+
+### 配置文件
+
+目录：`resources/env/`
+- /common: 存放scaling过程中用到的Dist SQL
+- /{SQL-TYPE}: 存放数据库级别的配置文件
+- /scenario: 存放测试的场景的配置文件，主要是SQL，不同数据库可能写法不一样
+
+### 运行测试引擎
+
+所有的属性值都可以通过 Maven 命令行 `-D` 的方式动态注入。
+
+#### Native 环境启动
+
+Native环境要求本地自行启动 ShardingSphere-Proxy（以及其自身依赖的Cluster，比如Zookeeper），同时要求ShardingSphere-Proxy的端口是3307，数据库会根据用户的配置自行启动，但是对应的端口都是数据库的默认端口（MySQL=3306,PostgreSQL=5432）。
+
+因此Native模式下不支持运行多个case，每次跑完需要自行清理Zookeeper中的信息，以及重启ShardingSphere-Proxy。
+
+启动方式如下: 找到需要测试的Case，比如 MySQLGeneralScalingIT, 在启动之前配置对应的 VM Option，新增如下配置
+```
+-Dit.cluster.env.type=native -Dit.env.mysql.version=${image-name}
+```
+> 其中的image-name需要是合法的docker image名称，比如：mysql:5.7, 多个的话用逗号隔开
+
+在IDE下使用Junit的方式启动即可
+
+#### Docker 环境启动
+
+第一步：打包镜像
+
+```bash
+./mvnw -B clean install -am -pl shardingsphere-test/shardingsphere-integration-test/shardingsphere-integration-test-scaling -Pit.env.docker -DskipTests
+```
+
+运行以上命令会构建出一个用于集成测试的 Docker 镜像 `apache/shardingsphere-proxy-test:latest`。
+如果仅修改了测试代码，可以复用已有的测试镜像，无须重新构建。
+
+**Docker 环境配置为 ShardingSphere-Proxy 提供了远程调试端口，默认是3308。**
+可以在 ShardingSphereProxyDockerContainer 中自行修改
+
+#### 运行单个用例
+
+和Native一样，只需要改一个参数。
+
+```
+-Dit.cluster.env.type=docker -Dit.env.mysql.version=${image-name}
+```

Review Comment:
   Could be merged to `Native 环境启动`



##########
docs/document/content/reference/test/scaling-integration-test/_index.cn.md:
##########
@@ -0,0 +1,91 @@
++++
+title = "Scaling集成测试"
+weight = 4
++++
+
+## 测试目的
+
+验证Scaling自身功能和依赖模块的正确性。
+
+## 测试环境
+
+环境准备方式分为 Native 和 Docker，不论哪种环境，本地都需要预先安装Docker，
+
+- Native环境 用于本地调试，可以使用IDE的debug模式进行调试
+- Docker环境  环境由 Maven 运行，适用于云编译环境和测试 ShardingSphere-Proxy 的场景，如：GitHub Action
+
+当前默认采用 Docker 环境，涉及到的 ShardingSphere-Proxy, Zookeeper, 数据库实例(MySQL,PostgreSQL), 都通过Docker自动启动。

Review Comment:
   ',' could be replaced to '，' or '、'



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org