Skip to content

Commit

Permalink
lightning: update README to help newcomer run lightning integration t…
Browse files Browse the repository at this point in the history
…ests (pingcap#55826)
  • Loading branch information
D3Hunter committed Sep 4, 2024
1 parent 3176b9c commit eb19c10
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions lightning/tests/README.md
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

0 comments on commit eb19c10

Please sign in to comment.