Skip to content
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

Jump to bottom

lightning: update README to help newcomer run lightning integration tests #55826

Merged
merged 1 commit into from
Sep 4, 2024
Merged

lightning: update README to help newcomer run lightning integration tests #55826

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
18 changes: 14 additions & 4 deletions lightning/tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,27 @@ This folder contains all tests which relies on external processes such as TiDB.
* `bin/tidb-server`
* `bin/tikv-server`
* `bin/pd-server`
* `bin/pd-ctl`
* `bin/tiflash`
* `bin/minio`
* `bin/mc`
* `bin/tiflash`

The versions must be ≥2.1.0.

What's more, there must be dynamic link library for TiFlash, see make target `bin` to learn more.
You can install most of dependencies by running `download_tools.sh`.
**Only some tests requires `minio`/`mc`** which can be downloaded from the official site, you can skip them if you don't need to run those cases.

You can use `tiup` to download binaries related to TiDB cluster, and then link them to the `bin` directory:
```shell
cluster_version=v8.1.0 # change to the version you need
tiup install tidb:$cluster_version tikv:$cluster_version pd:$cluster_version tiflash:$cluster_version
ln -s ~/.tiup/components/tidb/$cluster_version/tidb-server bin/tidb-server
ln -s ~/.tiup/components/tikv/$cluster_version/tikv-server bin/tikv-server
ln -s ~/.tiup/components/pd/$cluster_version/pd-server bin/pd-server
ln -s ~/.tiup/components/tiflash/$cluster_version/tiflash/tiflash bin/tiflash
```

2. `make build_for_lightning_integration_test`

`make server` to build the latest TiDB server if your test requires it.

3. The following programs must be installed:

Expand Down