CockroachDB

Integration with CockroachDB

Installation

pip install pytest-databases[cockroachdb]

Usage Example

import pytest
import psycopg
from pytest_databases.docker.cockroachdb import CockroachDBService

pytest_plugins = ["pytest_databases.docker.cockroachdb"]

@pytest.fixture(scope="session")
def cockroach_uri(cockroachdb_service: CockroachDBService) -> str:
    opts = "&".join(f"{k}={v}" for k, v in cockroachdb_service.driver_opts.items())
    return f"postgresql://root@{cockroachdb_service.host}:{cockroachdb_service.port}/{cockroachdb_service.database}?{opts}"

def test(cockroach_uri: str) -> None:
    with psycopg.connect(cockroach_uri) as conn:
        db_open = conn.execute("SELECT 1").fetchone()
        assert db_open is not None and db_open[0] == 1

def test(cockroachdb_connection: psycopg.Connection) -> None:
    cockroachdb_connection.execute("CREATE TABLE if not exists simple_table as SELECT 1")
    result = cockroachdb_connection.execute("select * from simple_table").fetchone()
    assert result is not None and result[0] == 1

Available Fixtures

• cockroachdb_image: The Docker image to use for CockroachDB.

• cockroachdb_service: A fixture that provides a CockroachDB service.

• cockroachdb_connection: A fixture that provides a CockroachDB connection.

• cockroachdb_driver_opts: A fixture that provides driver options for CockroachDB.

Service API

pytest_databases.docker.cockroachdb.xdist_cockroachdb_isolation_level()

Return type:

Literal['database', 'server']

class pytest_databases.docker.cockroachdb.CockroachDBService(host, port, database, driver_opts)

Bases: ServiceContainer

database: str

driver_opts: dict[str, str]

__init__(host, port, database, driver_opts)

pytest_databases.docker.cockroachdb.cockroachdb_driver_opts()

Return type:

dict[str, str]

pytest_databases.docker.cockroachdb.cockroachdb_image()

Return type:

str

pytest_databases.docker.cockroachdb.cockroachdb_service(docker_service, xdist_cockroachdb_isolation_level, cockroachdb_driver_opts, cockroachdb_image)

Return type:

Generator[CockroachDBService, None, None]

pytest_databases.docker.cockroachdb.cockroachdb_connection(cockroachdb_service, cockroachdb_driver_opts)

Return type:

Generator[Connection, None, None]