ClickHouse

In order to enable clickhouse support you have to add testsuite.databases.clickhouse.pytest_plugin to pytest_plugins list in your conftest.py file and configure ClickHouse schemas location.

By default testsuite starts ClickHouse service. In this case ClickHouse installation is required.

Currently clickhouse plugin uses synchronous clickhouse-driver driver.

ClickHouse plugin creates database schema once. And then populates database with data fixtures on each test. It looks for database fixtures by the following names:

• file ch_DBNAME.sql

• directory ch_DBNAME/

ClickHouse installation

For debian please run these commands:

sudo apt update && apt install clickhouse-common-static

(https://clickhouse.com/docs/en/getting-started/install/#packages),

For macos follow instructions at https://clickhouse.com/docs/en/getting-started/install/#from-binaries-non-linux

If you already have clickhouse installed, please symlink it to /usr/bin/clickhouse

Environment variables

TESTSUITE_CLICKHOUSE_SERVER_TCP_PORT

Use to override clickhouse server port. Default is 17123.

TESTSUITE_CLICKHOUSE_SERVER_HTTP_PORT

Use to override clickhouse http server port. Default is 17124.

TESTSUITE_CLICKHOUSE_SERVER_START_TIMEOUT

By default testsuite will wait for up to 20s for ClickHouse to start, one may customize this timeout via environment variable TESTSUITE_CLICKHOUSE_SERVER_START_TIMEOUT.

Customize ports

Testsuite may start ClickHouse with custom ports, if TESTSUITE_CLICKHOUSE_SERVER_TCP_PORT or TESTSUITE_CLICKHOUSE_SERVER_HTTP_PORT environment variables are specified.

Use external instance

Usage of external installation is not supported for now.

Example integration

from testsuite.databases.clickhouse import discover

@pytest.fixture(scope='session')
def clickhouse_local():
    return discover.find_schemas([SCHEMAS_DIR])

Database access example

def test_read_from_database(clickhouse):
    connection = clickhouse['chat_messages']
    result = connection.execute('SELECT * FROM system.numbers LIMIT 5')
    assert result == [(0,), (1,), (2,), (3,), (4,)]

Functions

find_schemas

testsuite.databases.clickhouse.discover.find_schemas(schema_dirs: List[Path], dbprefix: str = 'testsuite-') → Dict[str, DatabaseConfig]

Fixtures

clickhouse

testsuite.databases.clickhouse.pytest_plugin.clickhouse()

clickhouse_local

testsuite.databases.clickhouse.pytest_plugin.clickhouse_local()

Use to override databases configuration.

clickhouse_conn_info

testsuite.databases.clickhouse.pytest_plugin.clickhouse_conn_info()

Marks

pytest.mark.clickhouse

pytest.mark.clickhouse(dbname, *, files=(), directories=(), queries=()):

Use this mark to specify extra data fixtures in a per-test manner.

Parameters:

• dbname – Database name.

• files – List of filenames to apply to the database.

• directories – List of directories to apply to the database.

• queries – List of queries to apply to the database.

Classes

class testsuite.databases.clickhouse.classes.ConnectionInfo

Clickhouse connection parameters