Function test_state_with_invalid_yield

tests/units/test_state.py:1774–1814

Test that an error is thrown when a state yields an invalid value. Args: token: A token. mock_base_state_event_processor: The event processor.

(
    token: str,
    mock_base_state_event_processor: BaseStateEventProcessor,
)

@pytest.mark.asyncio
async def test_state_with_invalid_yield(
    token: str,
    mock_base_state_event_processor: BaseStateEventProcessor,
):
    """Test that an error is thrown when a state yields an invalid value.

    Args:
        token: A token.
        mock_base_state_event_processor: The event processor.
    """

    class StateWithInvalidYield(BaseState):
        """A state that yields an invalid value."""

        def invalid_handler(self):
            """Invalid handler.

            Yields:
                an invalid value.
            """
            yield 1

    captured_exceptions: list[Exception] = []

    def capture_exception(ex: Exception) -> None:
        captured_exceptions.append(ex)

    mock_base_state_event_processor.backend_exception_handler = capture_exception

    event = Event(
        name=f"{StateWithInvalidYield.get_full_name()}.invalid_handler",
        payload={},
    )
    async with mock_base_state_event_processor as processor:
        await processor.enqueue(token, event)

    assert len(captured_exceptions) == 1
    assert isinstance(captured_exceptions[0], TypeError)
    assert "must only return/yield: None, Events or other EventHandlers" in str(
        captured_exceptions[0]
    )


@pytest.fixture