| .. | ||
| helpers | ||
| test_cluster_copier | ||
| test_cross_replication | ||
| test_delayed_replica_failover | ||
| test_dictionaries | ||
| test_distributed_ddl | ||
| test_extreme_deduplication | ||
| test_graphite_merge_tree | ||
| test_insert_into_distributed | ||
| test_insert_into_distributed_sync_async | ||
| test_insert_into_distributed_through_materialized_view | ||
| test_merge_table_over_distributed | ||
| test_random_inserts | ||
| test_replicated_mutations | ||
| test_server_initialization | ||
| test_storage_mysql | ||
| test_system_queries | ||
| test_zookeeper_config | ||
| .gitignore | ||
| conftest.py | ||
| pytest.ini | ||
| README.md | ||
ClickHouse integration tests
This directory contains tests that involve several ClickHouse instances, custom configs, ZooKeeper, etc.
Running
Prerequisites:
- Ubuntu 14.04 (Trusty) or higher.
- docker. Minimum required API version: 1.25, check with
docker version.
You must install latest Docker from https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#set-up-the-repository Don't use Docker from your system repository.
- pip. To install:
sudo apt-get install python-pip - py.test testing framework. To install:
sudo -H pip install pytest - docker-compose and additional python libraries. To install:
sudo -H pip install docker-compose docker dicttoxml kazoo PyMySQL
(highly not recommended) If you really want to use OS packages on modern debian/ubuntu instead of "pip": sudo apt install -y docker docker-compose python-pytest python-dicttoxml python-docker python-pymysql python-kazoo
If you want to run the tests under a non-privileged user, you must add this user to docker group: sudo usermod -aG docker $USER and re-login.
(You must close all your sessions (for example, restart your computer))
To check, that you have access to Docker, run docker ps.
Run the tests with the pytest command. To select which tests to run, use: pytest -k <test_name_pattern>
By default tests are run with system-wide client binary, server binary and base configs. To change that, set the following environment variables:
CLICKHOUSE_TESTS_SERVER_BIN_PATHto choose the server binary.CLICKHOUSE_TESTS_CLIENT_BIN_PATHto choose the client binary.CLICKHOUSE_TESTS_BASE_CONFIG_DIRto choose the directory from which base configs (config.xmlandusers.xml) are taken.
Adding new tests
To add new test named foo, create a directory test_foo with an empty __init__.py and a file
named test.py containing tests in it. All functions with names starting with test will become test cases.
helpers directory contains utilities for:
- Launching a ClickHouse cluster with or without ZooKeeper indocker containers.
- Sending queries to launched instances.
- Introducing network failures such as severing network link between two instances.
To assert that two TSV files must be equal, wrap them in the TSV class and use the regular assert
statement. Example: assert TSV(result) == TSV(reference). In case the assertion fails, pytest
will automagically detect the types of variables and only the small diff of two files is printed.