This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 99c43c86f7b Rename it-env.properties to e2e-env.properties for docs
(#36661)
99c43c86f7b is described below
commit 99c43c86f7bfd08ad076da63c285c4dd70795c2e
Author: Liang Zhang <[email protected]>
AuthorDate: Mon Sep 22 00:35:55 2025 +0800
Rename it-env.properties to e2e-env.properties for docs (#36661)
---
.../content/test-manual/integration-test/_index.cn.md | 12 ++++++------
.../content/test-manual/integration-test/_index.en.md | 12 ++++++------
.../content/test-manual/pipeline-e2e-test/_index.cn.md | 8 ++++----
.../content/test-manual/pipeline-e2e-test/_index.en.md | 8 ++++----
4 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/document/content/test-manual/integration-test/_index.cn.md
b/docs/document/content/test-manual/integration-test/_index.cn.md
index 3a4f0ada786..8eaa69154bd 100644
--- a/docs/document/content/test-manual/integration-test/_index.cn.md
+++ b/docs/document/content/test-manual/integration-test/_index.cn.md
@@ -104,7 +104,7 @@ SQL 用例在
`resources/cases/${SQL-TYPE}/e2e-${SQL-TYPE}-${cases-description}.
#### Native 环境配置
-修改 `e2e-sql` 模块 `src/test/resources/env/it-env.properties` 文件中
`it.cluster.env.type` 为 `NATIVE` 模式，然后修改如下的属性为本地数据库地址和账号。
+修改 `e2e-sql` 模块 `src/test/resources/env/e2e-env.properties` 文件中
`it.cluster.env.type` 为 `NATIVE` 模式，然后修改如下的属性为本地数据库地址和账号。
```properties
it.native.storage.host=127.0.0.1
@@ -113,11 +113,11 @@ it.native.storage.username=root
it.native.storage.password=123456
```
-修改完成后，可以再调整 `it-env.properties` 中其他属性，测试 ShardingSphere 的 Proxy、JDBC
接入端，或者测试单机、集群模式。
+修改完成后，可以再调整 `e2e-env.properties` 中其他属性，测试 ShardingSphere 的 Proxy、JDBC
接入端，或者测试单机、集群模式。
#### Docker 环境配置
-修改 `e2e-sql` 模块 `src/test/resources/env/it-env.properties` 文件中
`it.cluster.env.type` 为 `DOCKER` 模式，如果执行 Proxy 接入端测试，需要执行如下的命令打包 Proxy 镜像。
+修改 `e2e-sql` 模块 `src/test/resources/env/e2e-env.properties` 文件中
`it.cluster.env.type` 为 `DOCKER` 模式，如果执行 Proxy 接入端测试，需要执行如下的命令打包 Proxy 镜像。
```bash
./mvnw -B clean install -am -pl test/e2e/sql -Pit.env.docker -DskipTests
-Dspotless.apply.skip=true -Drat.skip=true
@@ -134,7 +134,7 @@ socat TCP-LISTEN:2375,reuseaddr,fork
UNIX-CLIENT:/var/run/docker.sock
export DOCKER_HOST=tcp://127.0.0.1:2375
```
-修改完成后，可以再调整 `it-env.properties` 中其他属性，测试 ShardingSphere 的 Proxy、JDBC
接入端，或者测试单机、集群模式。
+修改完成后，可以再调整 `e2e-env.properties` 中其他属性，测试 ShardingSphere 的 Proxy、JDBC
接入端，或者测试单机、集群模式。
**Docker 环境配置为 ShardingSphere-Proxy 提供了远程调试端口，可以在
`test/e2e/fixture/src/test/assembly/bin/start.sh` 文件的 `JAVA_OPTS` 中找到第 2
个暴露的端口用于远程调试。**
@@ -142,7 +142,7 @@ export DOCKER_HOST=tcp://127.0.0.1:2375
#### 配置测试引擎运行环境
-通过配置 `src/test/resources/env/it-env.properties` 控制测试引擎。
+通过配置 `src/test/resources/env/e2e-env.properties` 控制测试引擎。
所有的属性值都可以通过 Maven 命令行 `-D` 的方式动态注入。
@@ -204,7 +204,7 @@ it.native.storage.password=123456
```
#### 远程 debug Docker 容器中的 Proxy 代码
-首先修改要测试模块的配置文件 it-env.properties，将 function.it.env.type 设置为
`docker`；设置对应的数据库镜像版本，例如 `transaction.it.docker.mysql.version=mysql:5.7`。
+首先修改要测试模块的配置文件 e2e-env.properties，将 function.it.env.type 设置为
`docker`；设置对应的数据库镜像版本，例如 `transaction.it.docker.mysql.version=mysql:5.7`。
其次通过命令生成测试镜像，例如：
```bash
diff --git a/docs/document/content/test-manual/integration-test/_index.en.md
b/docs/document/content/test-manual/integration-test/_index.en.md
index f498135a73b..e93890f79ad 100644
--- a/docs/document/content/test-manual/integration-test/_index.en.md
+++ b/docs/document/content/test-manual/integration-test/_index.en.md
@@ -106,7 +106,7 @@ The assertion file format is as follows:
#### Native environment configuration
-Modify `it.cluster.env.type` in `src/test/resources/env/it-env.properties`
file of `e2e-sql` module to `NATIVE` mode, and then modify the following
properties to the local database address and account.
+Modify `it.cluster.env.type` in `src/test/resources/env/e2e-env.properties`
file of `e2e-sql` module to `NATIVE` mode, and then modify the following
properties to the local database address and account.
```properties
it.native.storage.host=127.0.0.1
@@ -115,11 +115,11 @@ it.native.storage.username=root
it.native.storage.password=123456
```
-After the modification is completed, you can adjust other properties in
`it-env.properties` to test ShardingSphere's Proxy, JDBC access terminal, or
test the stand-alone and cluster modes.
+After the modification is completed, you can adjust other properties in
`e2e-env.properties` to test ShardingSphere's Proxy, JDBC access terminal, or
test the stand-alone and cluster modes.
#### Docker environment configuration
-Modify `it.cluster.env.type` in the `src/test/resources/env/it-env.properties`
file of the `e2e-sql` module to `DOCKER` mode. If you perform a Proxy access
end test, you need to execute the following command to package the Proxy image.
+Modify `it.cluster.env.type` in the
`src/test/resources/env/e2e-env.properties` file of the `e2e-sql` module to
`DOCKER` mode. If you perform a Proxy access end test, you need to execute the
following command to package the Proxy image.
```bash
./mvnw -B clean install -am -pl test/e2e/sql -Pit.env.docker -DskipTests
-Dspotless.apply.skip=true -Drat.skip=true
@@ -136,13 +136,13 @@ socat TCP-LISTEN:2375,reuseaddr,fork
UNIX-CLIENT:/var/run/docker.sock
export DOCKER_HOST=tcp://127.0.0.1:2375
```
-After the modification is completed, you can adjust other properties in
`it-env.properties` to test ShardingSphere's Proxy, JDBC access terminal, or
test the stand-alone and cluster modes.
+After the modification is completed, you can adjust other properties in
`e2e-env.properties` to test ShardingSphere's Proxy, JDBC access terminal, or
test the stand-alone and cluster modes.
### Run the test engine
#### Configure the running environment of the test engine
-Control the test engine by configuring
`src/test/resources/env/it-env.properties`.
+Control the test engine by configuring
`src/test/resources/env/e2e-env.properties`.
All attribute values can be dynamically injected via Maven command line `-D`.
@@ -201,7 +201,7 @@ If you only modify the test code, you can reuse the
existing test mirror without
```
#### Remote debug Proxy code in Docker container
-First of all, you need to modify the configuration file it-env.properties, set
function.it.env.type to `docker`, and then set the corresponding database image
version like `transaction.it.docker.mysql.version=mysql:5.7`.
+First of all, you need to modify the configuration file e2e-env.properties,
set function.it.env.type to `docker`, and then set the corresponding database
image version like `transaction.it.docker.mysql.version=mysql:5.7`.
Then generate the test image through the command, for example:
```bash
diff --git a/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
b/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
index 9d2b2f38bea..bfc792c0483 100644
--- a/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
+++ b/docs/document/content/test-manual/pipeline-e2e-test/_index.cn.md
@@ -26,7 +26,7 @@ weight = 4
`${DOCKER-IMAGE}` 表示 docker 镜像名称，如 `mysql:5.7` 。 `${DATABASE-TYPE}` 表示数据库类型。
目录：`src/test/resources/env/`
-- `it-env.properties`：环境配置文件。
+- `e2e-env.properties`：环境配置文件。
- `${DATABASE-TYPE}/global.yaml`：ShardingSphere-Proxy 配置文件。
- `${DATABASE-TYPE}/initdb.sql`：数据库初始化 SQL 文件。
- `${DATABASE-TYPE}/*.cnf,*.conf`：数据库配置文件。
@@ -47,7 +47,7 @@ weight = 4
### 运行测试用例
-`it-env.properties` 所有属性都可以通过 Maven 命令行 `-D` 的方式传入，优先级高于配置文件。
+`e2e-env.properties` 所有属性都可以通过 Maven 命令行 `-D` 的方式传入，优先级高于配置文件。
#### NATIVE 环境启动
@@ -60,7 +60,7 @@ Proxy 配置可以参考：
2. 启动注册中心（如 ZooKeeper）和数据库。
-3. 以 MySQL 为例，`it-env.properties` 可以配置如下：
+3. 以 MySQL 为例，`e2e-env.properties` 可以配置如下：
```
pipeline.it.env.type=NATIVE
pipeline.it.native.database=mysql
@@ -87,7 +87,7 @@ pipeline.it.native.mysql.port=3306
如果仅修改了测试代码，可以复用已有的测试镜像。
-2. 修改 `it-env.properties` 配置
+2. 修改 `e2e-env.properties` 配置
```
pipeline.it.env.type=DOCKER
diff --git a/docs/document/content/test-manual/pipeline-e2e-test/_index.en.md
b/docs/document/content/test-manual/pipeline-e2e-test/_index.en.md
index 065db93d5a3..7073b825ed6 100644
--- a/docs/document/content/test-manual/pipeline-e2e-test/_index.en.md
+++ b/docs/document/content/test-manual/pipeline-e2e-test/_index.en.md
@@ -25,7 +25,7 @@ Module path: `test/e2e/operation/pipeline`.
`${DOCKER-IMAGE}` refers to the name of a docker mirror, such as `mysql:5.7`.
`${DATABASE-TYPE}` refers to database types.
Directory: `src/test/resources/env/`
-- `it-env.properties`: Environment setup configuration file.
+- `e2e-env.properties`: Environment setup configuration file.
- `${DATABASE-TYPE}/global.yaml`: ShardingSphere-Proxy configuration fi;e.
- `${DATABASE-TYPE}/initdb.sql`: Database initialization SQL file.
- `${DATABASE-TYPE}/*.cnf,*.conf`: Database configuration files.
@@ -46,7 +46,7 @@ Functions included:
### Running the test case
-Any property of `it-env.properties` could be defined by Maven command line
parameter `-D`, and its priority is higher than configuration file.
+Any property of `e2e-env.properties` could be defined by Maven command line
parameter `-D`, and its priority is higher than configuration file.
#### NATIVE environment setup
@@ -59,7 +59,7 @@ Refer to following files for proxy `global.yaml`
configuration:
2. Start registry center (e.g. ZooKeeper) and database.
-3. Take MySQL as an example, `it-env.properties` could be configured as
follows:
+3. Take MySQL as an example, `e2e-env.properties` could be configured as
follows:
```
pipeline.it.env.type=NATIVE
pipeline.it.native.database=mysql
@@ -86,7 +86,7 @@ The docker image has port `3308` for remote debugging.
If only test code is modified, you could reuse existing docker image.
-2. Configure `it-env.properties`.
+2. Configure `e2e-env.properties`.
```
pipeline.it.env.type=DOCKER
