Yugabyte

Integration with Yugabyte DB

Installation

pip install pytest-databases[yugabyte]

Usage Example

import pytest
import psycopg
from pytest_databases.docker.yugabyte import YugabyteService

pytest_plugins = ["pytest_databases.docker.yugabyte"]

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

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

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

Available Fixtures

• yugabyte_image: The Docker image to use for Yugabyte DB.

• yugabyte_service: A fixture that provides a Yugabyte DB service.

• yugabyte_connection: A fixture that provides a Yugabyte DB connection.

• yugabyte_driver_opts: A fixture that provides driver options for Yugabyte DB.

Service API

pytest_databases.docker.yugabyte.xdist_yugabyte_isolation_level()

Return type:

Literal['database', 'server']

class pytest_databases.docker.yugabyte.YugabyteService(host, port, database, driver_opts)

Bases: ServiceContainer

database: str

driver_opts: dict[str, str]

__init__(host, port, database, driver_opts)

pytest_databases.docker.yugabyte.yugabyte_driver_opts()

Return type:

dict[str, str]

pytest_databases.docker.yugabyte.yugabyte_image()

Return type:

str

pytest_databases.docker.yugabyte.yugabyte_service(docker_service, xdist_yugabyte_isolation_level, yugabyte_driver_opts, yugabyte_image)

Return type:

Generator[YugabyteService, None, None]

pytest_databases.docker.yugabyte.yugabyte_connection(yugabyte_service, yugabyte_driver_opts)

Return type:

Generator[Connection, None, None]