Skip to content

[doc] improve e2e local run guide #4095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lynx009 merged 1 commit into from
Mar 27, 2026
Merged

[doc] improve e2e local run guide #4095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
Please add the corresponding e2e (aka end-to-end) test cases if you add or update APIs.

## How to work
* Start and watch the [docker-compose](https://docs.docker.com/compose/) via [the script](script/start.sh)
* Run the e2e testing via [api-testing](https://github.com/LinuxSuRen/api-testing)
* It will run the test cases from top to bottom
* You can add the necessary asserts to it
* Start and watch the [Docker Compose](https://docs.docker.com/compose/) environment
* The Compose file is `e2e/docker-compose.yml`
* The `testing` container uses [api-testing](https://github.com/LinuxSuRen/api-testing)
* 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
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 that Docker Compose v2 is installed

* Build the local `apache/hertzbeat:test` image from the repository root
* Change the directory to `e2e`, then run:

> Please make sure you have installed docker-compose v2
```bash
docker compose up --exit-code-from testing --remove-orphans
```

* Change the directory to `e2e`, then execute `./script/start.sh`
* 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
Loading