wyl/hertzbeat
1
0
Fork 0
mirror of https://github.com/dromara/hertzbeat.git synced 2026-09-17 09:40:58 +00:00
Code Issues Projects Releases Wiki Activity

[doc] improve e2e local run guide (#4095)

Browse Source
This commit is contained in:
P_Peaceful
2026-03-27 16:25:00 +08:00
committed by GitHub
parent 75d6dee367
commit 695be421f2
1 changed files with 28 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
e2e/README.md
+28 -7
View File
@@ -1,14 +1,35 @@
Please add the corresponding e2e (aka end-to-end) test cases if you add or update APIs. Please add the corresponding e2e (aka end-to-end) test cases if you add or update APIs.
## How to work ## How to work
* Start and watch the [docker-compose](https://docs.docker.com/compose/) via [the script](script/start.sh) * Start and watch the [Docker Compose](https://docs.docker.com/compose/) environment
* Run the e2e testing via [api-testing](https://github.com/LinuxSuRen/api-testing) * The Compose file is `e2e/docker-compose.yml`
* It will run the test cases from top to bottom * The `testing` container uses [api-testing](https://github.com/LinuxSuRen/api-testing)
* You can add the necessary asserts to it * The main test definition file is `e2e/testsuite.yaml`
* Before starting the suite locally, build the `apache/hertzbeat:test` image from the repository root:
```bash
mvn clean -B package -Prelease -Dmaven.test.skip=true --file pom.xml
docker build -t apache/hertzbeat:test -f script/docker/server/Dockerfile ./dist
```
* Run the E2E tests via [api-testing](https://github.com/LinuxSuRen/api-testing)
* The test cases run from top to bottom
* You can add the necessary assertions there
* Test data files are under `e2e/data/`
* The test report is generated at `e2e/report/report.md`
* HertzBeat logs are written to `e2e/logs/`
## Run locally ## Run locally
Please follow these steps if you want to run the e2e testing locally. Please follow these steps if you want to run the E2E tests locally.
> Please make sure you have installed docker-compose v2 > Please make sure that Docker Compose v2 is installed
* Change the directory to `e2e`, then execute `./script/start.sh` * Build the local `apache/hertzbeat:test` image from the repository root
* Change the directory to `e2e`, then run:
```bash
docker compose up --exit-code-from testing --remove-orphans
```
* If your environment uses the standalone Compose binary, use `docker-compose` instead of `docker compose`
* After the run, check `e2e/report/report.md` and `e2e/logs/` for the test result and runtime logs