Function requireCapability

tortoise/contrib/test/__init__.py:163–235

Skip a test if the required capabilities are not matched. .. note:: The database must be initialized *before* the decorated test runs. Usage: .. code-block:: python3 @requireCapability(dialect='sqlite') @pytest.mark.asyncio async def test_run_sqli

(
    connection_name: str = "models", **conditions: typing.Any
)

def requireCapability(
    connection_name: str = "models", **conditions: typing.Any
) -> Callable[[_FT], _FT]:
    """
    Skip a test if the required capabilities are not matched.

    .. note::
        The database must be initialized *before* the decorated test runs.

    Usage:

    .. code-block:: python3

        @requireCapability(dialect='sqlite')
        @pytest.mark.asyncio
        async def test_run_sqlite_only(db):
            ...

    Or to conditionally skip a class:

    .. code-block:: python3

        @requireCapability(dialect='sqlite')
        class TestSqlite:
            @pytest.mark.asyncio
            async def test_something(self, db):
                ...

    :param connection_name: name of the connection to retrieve capabilities from.
    :param conditions: capability tests which must all pass for the test to run.
    """

    def decorator(test_item: _FT) -> _FT:
        if not isinstance(test_item, type):

            def check_capabilities() -> None:
                db = get_connection(connection_name)
                for key, val in conditions.items():
                    if getattr(db.capabilities, key) != val:
                        raise SkipTest(f"Capability {key} != {val}")

            if inspect.iscoroutinefunction(test_item):

                @wraps(test_item)
                async def skip_wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
                    check_capabilities()
                    return await test_item(*args, **kwargs)

            else:

                @wraps(test_item)
                def skip_wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
                    check_capabilities()
                    return test_item(*args, **kwargs)

            return cast(_FT, skip_wrapper)

        # Assume a class is decorated