Skip to content

Commit 54a9969

Browse files
[README] Translate the half of README into Chinese & Correct some mistakes in the original README (#220)
* [README] Translate the half of README to Chinese & Correct some mistakes in the original README * Fix typo * Add a trouble shooting for the error:0308010C * update 特性 * Keep 'Monkey test' * Add some spaces between English words and Chinese character. * Add some spaces between English words and Chinese character - batch 2. * Storage => 存储 * Fix all 'Step X' * Add suitable spaces * 构立 -> 构建 * Update certain description by following the comments * or your custom port => 或自定义的端口号 Co-authored-by: Yang Zhang <yazhang1@microsoft.com>
1 parent 7eb1320 commit 54a9969

File tree

2 files changed

+56
-52
lines changed

2 files changed

+56
-52
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ It enables dev team to quickly build a self-manageable and intelligent cloud tes
2828

2929
Capabilities of Hydra Lab include:
3030
- Scalable test device management under the center-agent distributed design; Test task management and test result visualization.
31-
- Powering [Android Espresso Test](https://developer.android.com/training/testing/espresso)
32-
- Appium(Java) test on different platforms: Windows/iOS/Android/Browser/Cross-platform
33-
- Case-free test automation: Monkey test, Smart exploratory test
31+
- Powering [Android Espresso Test](https://developer.android.com/training/testing/espresso).
32+
- Appium(Java) test on different platforms: Windows/iOS/Android/Browser/Cross-platform.
33+
- Case-free test automation: Monkey test, Smart exploratory test.
3434

3535
For more details, see [Introduction: What is Hydra Lab?](https://github.com/microsoft/HydraLab/wiki)
3636

@@ -51,12 +51,12 @@ Please visit our **[GitHub Project Wiki](https://github.com/microsoft/HydraLab/w
5151
|Web (Browser)| &#10004; | x |
5252

5353
<span id="quick-start"></span>
54-
### Quick guide on out-of-box Uber experience
54+
### Quick guide on out-of-box Uber docker image
5555

5656
Hydra Lab uses [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/) as cloud file storage solution to persist log files, video, app package, etc. Please go to your Azure portal, open an Azure blob storage account, get the [connection string](https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string),
5757
and place it in the environment variable with the name of BLOB_CONNECTION_STR.
5858

59-
Hydra Lab offers an out-of-box experience of docker image. By providing the env variable BLOB_CONNECTION_STR simply, you can follow the below steps and start your docker container with a center instance and an agent instance built in:
59+
Hydra Lab offers an out-of-box experience of docker image called Uber. By providing the env variable BLOB_CONNECTION_STR simply, you can follow the below steps and start your docker container with a center instance and an agent instance built in:
6060

6161
**Step 1. pull Docker image from container registry**
6262

@@ -75,48 +75,50 @@ Or simply run with the env parameter -e:
7575
docker run [-p 9886:9886] [--name=hydra-lab] -e BLOB_CONNECTION_STR=${YOUR_BLOB_CONNECTION_STR} ghcr.io/microsoft/hydra-lab-uber:latest
7676
```
7777

78-
**Step 3: visit front-end page and view your connected devices**
78+
**Step 3. visit front-end page and view your connected devices**
7979

8080
> Url: http://localhost:9886/portal/index.html#/ (or your custom port).
8181
8282
Enjoy starting your journey of exploration!
8383

84-
**Note: out-of-box Uber now only provides the Espresso test feature for Android, please refer to this section for more features: [For Hydra Lab User](#for-user)**
84+
**Note: Uber now only provides the Espresso test feature for Android, please refer to this section for more features: [For Hydra Lab User](#for-user)**
8585

8686
### Quick guide on build and run
8787

8888
You can also run the center java Spring Boot service (a runnable Jar) separately with the following commands:
8989

9090
> The build and run process will require JDK11 | NPM | Android SDK platform-tools in position.
9191
92-
**Step 1: build and run Hydra Lab center service.**
92+
**Step 1. build and run Hydra Lab center service.**
9393

9494
```bash
9595
# In project root, switch to react folder to build the Web front.
9696
cd react
9797
npm ci
9898
npm run pub
9999
# Get back to the project root, and build the center runnable Jar.
100-
# For the gradlew command, if you are on Windows please replace it with `./gradlew` or `./gradlew.bat`
101100
cd ..
101+
# For the gradlew command, if you are on Windows please replace it with `./gradlew` or `./gradlew.bat`
102102
gradlew :center:bootJar
103103
# Run it, and then visit http://localhost:9886/portal/index.html#/
104104
java -jar center/build/libs/center.jar
105105
# Then visit http://localhost:9886/portal/index.html#/auth to generate a new agent ID and agent secret.
106106
```
107107

108-
**Step 2: build and run Hydra Lab agent service.**
108+
> If you encounter the error: `Error: error:0308010C:digital envelope routines::unsupported`, set the System Variable `NODE_OPTIONS` as `--openssl-legacy-provider` and then restart the terminal.
109+
110+
**Step 2. build and run Hydra Lab agent service.**
109111

110112
```bash
111113
# In project root, copy the sample config file and update the:
112-
# YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID, and YOUR_REGISTERED_AGENT_SECRET.
114+
# YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID and YOUR_REGISTERED_AGENT_SECRET.
113115
cp agent/application-sample.yml application.yml
114116
# Then build agent jar and run it
115117
gradlew :agent:bootJar
116118
java -jar agent/build/libs/agent.jar
117119
```
118120

119-
**Step 3: visit http://localhost:9886/portal/index.html#/ and view your connected devices**
121+
**Step 3. visit http://localhost:9886/portal/index.html#/ and view your connected devices**
120122

121123
**Technical design overview:**
122124

README.zh-CN.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -16,94 +16,96 @@
1616
[What is Hydra Lab?](#what-is) | [Get Started](#get-started) | [Who are using Hydra Lab?](#who-use-it) | [Contribute](#contribute) | [Contact Us](#contact) | [Links](#links) | [Wiki](https://github.com/microsoft/HydraLab/wiki)
1717

1818
<span id="what-is"></span>
19-
## Hydra Lab是什么
19+
## Hydra Lab 是什么
2020

21-
Hydra Lab 是一个基于Spring Boot & React 构建的服务框架,帮你快速构建一套集测试运行部署、测试设备管理、低代码测试等功能于一身的跨平台云测服务,开箱即用.
22-
It enables dev team to quickly build a self-manageable and intelligent cloud testing infrastructure. With the help of Hydra Lab, you can:
21+
Hydra Lab 是一个基于 Spring Boot & React 构建的服务框架,帮你快速构建一套集测试运行部署、测试设备管理、低代码测试等功能于一身的跨平台云测服务,开箱即用
22+
它使开发团队能够快速建立一个可自我管理的智能云测试基础设施。在 Hydra Lab 的帮助下,你可以:
2323

24-
- Either: Create a new cloud testing network.
25-
- Or: Onboard your test device to an existing network with a minimized effort.
24+
- 搭建:创建一个新的云测试网络。
25+
- 加入:以最小的代价将你的测试设备部署到现有的网络上。
2626

27-
Capabilities of Hydra Lab include:
28-
- Scalable test device management under the center-agent distributed design; Test task management and test result visualization.
29-
- Powering [Android Espresso Test](https://developer.android.com/training/testing/espresso)
30-
- Appium(Java) test on different platforms: Windows/iOS/Android/Browser/Cross-platform
31-
- Case-free test automation: Monkey test, Smart exploratory test
27+
Hydra Lab 的特性包括:
28+
- center-agent 分布式设计下的可扩展测试设备管理;测试任务管理和测试结果可视化。
29+
- 支持 [Android Espresso Test](https://developer.android.com/training/testing/espresso)
30+
- 支持在不同平台上进行 Appium(Java) 测试:Windows/iOS/Android/浏览器/跨平台。
31+
- 无用例的自动化测试:Monkey test,智能探索测试
3232

33-
For more details, see [Introduction: What is Hydra Lab?](https://github.com/microsoft/HydraLab/wiki)
33+
更多细节,请参见 [介绍:什么是 Hydra Lab](https://github.com/microsoft/HydraLab/wiki)
3434

3535
<span id="get-started"></span>
36-
## Get Started
36+
## 入门
3737

38-
Please visit our **[GitHub Project Wiki](https://github.com/microsoft/HydraLab/wiki)** to understand the dev environment setup procedure: [Contribution Guideline](https://github.com/microsoft/HydraLab/wiki/Contribute-to-the-Hydra-Lab-GitHub-Project)
38+
请访问我们的 **[GitHub 项目 Wiki](https://github.com/microsoft/HydraLab/wiki)** 以了解开发环境的配置流程: [贡献指南](https://github.com/microsoft/HydraLab/wiki/Contribute-to-the-Hydra-Lab-GitHub-Project)
3939

40-
**Supported environments for Hydra Lab agent**: Windows, Mac OSX, and Linux ([Docker](https://github.com/microsoft/HydraLab/blob/main/agent/README.md#run-agent-in-docker)).
40+
**Hydra Lab agent 支持的环境**Windows, Mac OSX, 和Linux ([Docker](https://github.com/microsoft/HydraLab/blob/main/agent/README.md#run-agent-in-docker)).
4141

42-
**Supported platforms and frameworks**:
42+
**支持的平台和框架**:
4343

4444
| | Appium(Java) | Espresso |
4545
| ---- |--------------|---- |
4646
|Android| &#10004; | &#10004; |
4747
|iOS| &#10004; | x | x |
4848
|Windows| &#10004; | x |
49-
|Web (Browser)| &#10004; | x |
49+
|Web (浏览器)| &#10004; | x |
5050

5151
<span id="quick-start"></span>
52-
### Quick guide on out-of-box Uber experience
52+
### 开箱即用的 Uber docker 镜像快速指南
5353

54-
Hydra Lab uses [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/) as cloud file storage solution to persist log files, video, app package, etc. Please go to your Azure portal, open an Azure blob storage account, get the [connection string](https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string),
55-
and place it in the environment variable with the name of BLOB_CONNECTION_STR.
54+
Hydra Lab 使用 [Azure Blob 存储](https://azure.microsoft.com/en-us/products/storage/blobs/) 作为云文件存储解决方案,以持久化存储日志文件、视频、应用包等。请访问你的 Azure 门户,打开一个 Azure Blob 存储账户,获取 [connection string](https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string)
55+
并将其放入环境变量中,名称为 BLOB_CONNECTION_STR
5656

57-
Hydra Lab offers an out-of-box experience of docker image. By providing BLOB_CONNECTION_STR simply, you can follow the below steps and start your docker container with a center instance and an agent instance built in:
57+
Hydra Lab 提供了一个名为 Uber 开箱即用的 docker 镜像。在简单地配置环境变量 BLOB_CONNECTION_STR 后,你可以按照下面的步骤,启动内置了一个 center 实例和一个 agent 实例的 docker 容器:
5858

59-
**Step 1. pull Docker image from container registry**
59+
**第1步. 从容器注册中心获取 Docker 镜像**
6060
> docker pull ghcr.io/microsoft/hydra-lab-uber:latest
6161
62-
**Step 2. run on your machine with BLOB_CONNECTION_STR**
62+
**第2步. 在你的机器上运行,并使用 BLOB_CONNECTION_STR 作为参数**
6363
> docker run [-p 9886:9886] [--name=hydra-lab] -e BLOB_CONNECTION_STR=${BLOB_CONNECTION_STR} ghcr.io/microsoft/hydra-lab-uber:latest
6464
65-
**Step 3: visit front-end page and view your connected devices**
65+
**第3步. 访问前端页面并查看你的已连接设备**
6666

67-
> Url: http://localhost:9886/portal/index.html#/ (or your custom port).
67+
> Url: http://localhost:9886/portal/index.html#/ (或自定义的端口号).
6868
69-
Enjoy starting your journey of exploration!
69+
开始享受你的探索之旅吧!
7070

71-
**Note: out-of-box Uber now only provides the Espresso test feature for Android, please refer to this section for more features: [For Hydra Lab User](#for-user)**
71+
**注意:Uber 现在只提供安卓系统的Espresso测试功能,更多的功能请参考本节:[对于 Hydra Lab 用户](#for-user)**
7272

73-
### Quick guide on build and run
73+
### 构建和运行的快速指南
7474

75-
You can also run the center java Spring Boot service (a runnable Jar) separately with the following commands:
75+
你也可以用以下命令单独运行中心 java Spring Boot 服务(一个可运行的 Jar):
7676

77-
> The build and run process will require JDK | NPM | Android SDK platform-tools in position.
77+
> 构建和运行过程需要用到 JDK | NPM | Android SDK 平台工具。
7878
79-
**Step 1: build and run Hydra Lab center service.**
79+
**第1步. 构建并运行 Hydra Lab center 服务。**
8080

8181
```bash
82-
# In project root, switch to react folder to build the Web front.
82+
# 在项目根目录,切换到 react 文件夹来构建 Web 前端文件。
8383
cd react
8484
npm ci
8585
npm run pub
86-
# Get back to the project root, and build the center runnable Jar.
87-
# For the gradlew command, if you are on Windows please replace it with `./gradlew` or `./gradlew.bat`
86+
# 回到项目根目录,构建 center 可运行的 Jar 。
8887
cd ..
88+
# 对于 gradlew 命令,如果你使用的是 Windows 系统,请用`./gradlew`或`./gradlew.bat`替换。
8989
gradlew :center:bootJar
90-
# Run it, and then visit http://localhost:9886/portal/index.html#/
90+
# 运行并访问 http://localhost:9886/portal/index.html#/
9191
java -jar center/build/libs/center.jar
92-
# Then visit http://localhost:9886/portal/index.html#/auth to generate a new agent ID and agent secret.
92+
# 然后访问 http://localhost:9886/portal/index.html#/auth 来生成新的 agent ID agent secret
9393
```
9494

95-
**Step 2: build and run Hydra Lab agent service.**
95+
> 如果你遇到了以下错误: `Error: error:0308010C:digital envelope routines::unsupported`, 设置环境变量 `NODE_OPTIONS` 的值为 `--openssl-legacy-provider` 并重启命令行。
96+
97+
**第2步. 构建并运行 Hydra Lab agent 服务。**
9698

9799
```bash
98-
# In project root, copy the sample config file and update the:
99-
# YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID, and YOUR_REGISTERED_AGENT_SECRET.
100+
# 在项目根目录下,复制示例配置文件并更新:
101+
# YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID YOUR_REGISTERED_AGENT_SECRET
100102
cp agent/application-sample.yml application.yml
101-
# Then build agent jar and run it
103+
# 然后构建 agent jar 并运行它
102104
gradlew :agent:bootJar
103105
java -jar agent/build/libs/agent.jar
104106
```
105107

106-
**Step 3: visit http://localhost:9886/portal/index.html#/ and view your connected devices**
108+
**第3步. 访问 http://localhost:9886/portal/index.html#/ 并查看你的已连接设备**
107109

108110
**Technical design overview:**
109111

0 commit comments

Comments
 (0)