From 73d0aa743d107c89704d1296ee3ac50f3479cbc8 Mon Sep 17 00:00:00 2001 From: Xuanhe Chen Date: Wed, 18 May 2022 19:14:39 +0800 Subject: [PATCH] docs(ticdc): update TiCDC integration test readme (#5457) close pingcap/tiflow#5458 --- tests/integration_tests/README.md | 44 ++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/tests/integration_tests/README.md b/tests/integration_tests/README.md index 6152d6b7db1..a004c232890 100644 --- a/tests/integration_tests/README.md +++ b/tests/integration_tests/README.md @@ -2,16 +2,14 @@ ### Run integration tests locally -1. The following executables must be copied or generated or linked into these locations, `sync_diff_inspector` can be - downloaded - from [tidb-community-toolkit](https://download.pingcap.org/tidb-community-toolkit-v4.0.2-linux-amd64.tar.gz) - , `tidb-server` related binaries can be downloaded - from [tidb-community-server](https://download.pingcap.org/tidb-community-server-v4.0.2-linux-amd64.tar.gz): - - * `bin/tidb-server` # version >= 4.0.0-rc.1 - * `bin/tikv-server` # version >= 4.0.0-rc.1 - * `bin/pd-server` # version >= 4.0.0-rc.1 - * `bin/pd-ctl` # version >= 4.0.0-rc.1 +1. The following executables must be copied or generated or linked into these locations. The versions of them should be + the same as that of TiCDC. If you are compiling the master branch of TiCDC, try the latest release versions of the + components. + + * `bin/tidb-server` # version >= 6.0.0-rc.1 + * `bin/tikv-server` # version >= 6.0.0-rc.1 + * `bin/pd-server` # version >= 6.0.0-rc.1 + * `bin/pd-ctl` # version >= 6.0.0-rc.1 * `bin/tiflash` # needs tiflash binary and some necessary so files * `bin/sync_diff_inspector` * [bin/go-ycsb](https://github.com/pingcap/go-ycsb) @@ -19,14 +17,34 @@ * [bin/jq](https://stedolan.github.io/jq/) * [bin/minio](https://github.com/minio/minio) - > If you are running tests on MacOS, tidb related binaries can be downloaded from tiup mirrors, such as https://tiup-mirrors.pingcap.com/tidb-v4.0.2-darwin-amd64.tar.gz. And `sync_diff_inspector` can be compiled by yourself from source [tidb-tools](https://github.com/pingcap/tidb-tools) + > You can also download the binaries. `sync_diff_inspector` can be downloaded + > from [tidb-community-toolkit](https://download.pingcap.org/tidb-community-toolkit-v6.0.0-linux-amd64.tar.gz), + > `tidb-server` related binaries can be downloaded + > from [tidb-community-server](https://download.pingcap.org/tidb-community-server-v6.0.0-linux-amd64.tar.gz): - > All Tiflash required files can be found in [tidb-community-server](https://download.pingcap.org/tidb-community-server-v4.0.2-linux-amd64.tar.gz) packages. You should put `flash_cluster_manager`, `libtiflash_proxy.so` and `tiflash` into `bin` directory in TiCDC code base. + > If you are running tests on MacOS, tidb related binaries can be downloaded from tiup mirrors, such as + > https://tiup-mirrors.pingcap.com/tidb-v4.0.2-darwin-amd64.tar.gz. And `sync_diff_inspector` can be compiled by + > yourself from source [tidb-tools](https://github.com/pingcap/tidb-tools) + + > All Tiflash required files can be found in + > [tidb-community-server](https://download.pingcap.org/tidb-community-server-v6.0.0-linux-amd64.tar.gz) packages. + > You should put `flash_cluster_manager`, `libtiflash_proxy.so` and `tiflash` into `bin` directory in TiCDC code base. -2. The following programs must be installed: + > Old versions of Minio may cause the integration test cases to fail. You can get a newer version by installing it from source + > ([Source Installation](https://github.com/minio/minio#install-from-source)). + > [RELEASE.2022-05-08T23-50-31Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-05-08T23-50-31Z) is suggested. +2. These are programs/packages need be installed. * [mysql](https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/) (the MySQL cli client, currently [mysql client 8.0 is not supported](https://github.com/pingcap/tidb/issues/14021)) + * [s3cmd](https://s3tools.org/download) + * unzip + * psmisc + + > You can install `unzip` and `psmisc` using `apt-get` (Ubuntu / Debian) or `yum` (RHEL). + + > Since the integration test cases will use port 3306 on localhost, please make sure in advance that port 3306 is + > not occupied. (You’d like to stop the local MySQL service on port 3306, if there is one) 3. The user used to execute the tests must have permission to create the folder /tmp/tidb_cdc_test. All test artifacts will be written into this folder.