Skip to content

Latest commit

 

History

History
134 lines (93 loc) · 6.74 KB

README.md

File metadata and controls

134 lines (93 loc) · 6.74 KB
Raw

Preparations

Run integration tests locally

  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
    • bin/etcdctl
    • bin/jq
    • bin/minio

    You can also download the binaries. sync_diff_inspector can be downloaded from tidb-community-toolkit, tidb-server related binaries can be downloaded from tidb-community-server:

    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

    All Tiflash required files can be found in tidb-community-server packages. You should put flash_cluster_manager, libtiflash_proxy.so and tiflash into bin directory in TiCDC code base.

    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). RELEASE.2022-05-08T23-50-31Z is suggested.

  2. These are programs/packages need be installed.

    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.

Run integration tests in docker

The following programs must be installed:

We recommend that you provide docker with at least 6+ cores and 8G+ memory. Of course, the more resources, the better.

Running

Unit Test

  1. Unit test does not need any dependencies, just running make unit_test in root dir of source code, or cd into directory of a test case and run single case via GO111MODULE=on go test -check.f TestXXX.

Integration Test

Run integration tests in docker

Warning: These scripts and files may not work under the arm architecture, and we have not tested against it. We will try to resolve it as soon as possible.

The script is designed to download necessary binaries from the PingCAP intranet by default, requiring access to the PingCAP intranet. However, if you want to download the community version, you can specify it through the COMMUNITY environment variable. For instance, you can use the following command as an example: BRANCH=master COMMUNITY=true VERSION=v7.0.0 START_AT="clustered_index" make kafka_docker_integration_test_with_build

  1. If you want to run kafka tests, run START_AT="clustered_index" make kafka_docker_integration_test_with_build

  2. If you want to run MySQL tests, run CASE="clustered_index" make mysql_docker_integration_test_with_build

  3. Use the command make clean_integration_test_images to clean up the corresponding environment.

Some useful tips:

  1. The log files for the test are mounted in the ./deployments/ticdc/docker-compose/logs directory.

  2. You can specify multiple tests to run in CASE, for example: CASE="clustered_index kafka_messages". You can even use CASE="*" to indicate that you are running all tests。

  3. You can specify in the integration-test.Dockerfile the version of other dependencies that you want to download, such as tidb, tikv, pd, etc.

    For example, you can change RUN ./download-integration-test-binaries.sh master to RUN ./download-integration-test-binaries.sh release-5.2 to use the release-5.2 dependency. Then rebuild the image with make build_mysql_integration_test_images.

Run integration tests locally

  1. Run make integration_test_build to generate TiCDC related binaries for integration test

  2. Run make integration_test to execute the integration tests. This command will

    1. Check that all required executables exist.
    2. Execute tests/integration_tests/run.sh

    If want to run one integration test case only, just pass the CASE parameter, such as make integration_test CASE=simple.

    If want to run integration test cases from the specified one, just pass the START_AT parameter, such as make integration_test START_AT=simple .

    There exists some environment variables that you can set by yourself, variable details can be found in test_prepare.

    MySQL sink will be used by default, if you want to test Kafka sink, please run with make integration_test_kafka CASE=simple.

  3. After executing the tests, run make coverage to get a coverage report at /tmp/tidb_cdc_test/all_cov.html.

Writing new tests

  1. New integration tests can be written as shell scripts in tests/integration_tests/TEST_NAME/run.sh. The script should exit with a nonzero error code on failure.

  2. Add TEST_NAME to existing group in run_group.sh, or add a new group for it.

  3. If you add a new group, the name of the new group must be added to CI.