test_spy_events.py

"""Tests for the spy interaction event values."""
import pytest
from typing import List, NamedTuple

from decoy.spy_events import (
    PropAccessType,
    SpyCall,
    SpyEvent,
    SpyInfo,
    SpyPropAccess,
    SpyRehearsal,
    WhenRehearsal,
    VerifyRehearsal,
    match_event,
)


class MatchEventSpec(NamedTuple):
    """Spec data for testing `match_event`."""

    event: SpyEvent
    rehearsal: SpyRehearsal
    expected_result: bool


match_event_specs: List[MatchEventSpec] = [
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        expected_result=True,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=VerifyRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        expected_result=True,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1,), kwargs={"baz": "qux"}, ignore_extra_args=True),
        ),
        expected_result=True,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        rehearsal=VerifyRehearsal(
            spy=SpyInfo(id=21, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1,), kwargs={}),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(), kwargs={}),
        ),
        rehearsal=VerifyRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1,), kwargs={}),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(2,), kwargs={"baz": "qux"}, ignore_extra_args=True),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=VerifyRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "qux"}, ignore_extra_args=True),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(
                args=(1, 2, 3),
                kwargs={"foo": "bar", "baz": "qux"},
                ignore_extra_args=True,
            ),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(args=(1, 2), kwargs={"foo": "bar", "baz": "qux"}),
        ),
        rehearsal=VerifyRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyCall(
                args=(1, 2),
                kwargs={"foo": "bar", "baz": "qux", "fizz": "buzz"},
                ignore_extra_args=True,
            ),
        ),
        expected_result=False,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyPropAccess(prop_name="prop", access_type=PropAccessType.GET),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyPropAccess(prop_name="prop", access_type=PropAccessType.GET),
        ),
        expected_result=True,
    ),
    MatchEventSpec(
        event=SpyEvent(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyPropAccess(prop_name="prop", access_type=PropAccessType.DELETE),
        ),
        rehearsal=WhenRehearsal(
            spy=SpyInfo(id=42, name="my_spy", is_async=False),
            payload=SpyPropAccess(prop_name="prop", access_type=PropAccessType.GET),
        ),
        expected_result=False,
    ),
]


@pytest.mark.parametrize(MatchEventSpec._fields, match_event_specs)
def test_match_event(
    event: SpyEvent,
    rehearsal: SpyRehearsal,
    expected_result: bool,
) -> None:
    """It should match a call to a rehearsal."""
    result = match_event(event, rehearsal)
    assert result is expected_result


def test_match_eq_override() -> None:
    """It should prefer __eq__ from the rehearsal."""

    class _Matcher:
        def __eq__(self, other: object) -> bool:
            return True

    class _Value:
        def __eq__(self, other: object) -> bool:
            return False

    event_args = SpyEvent(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(_Value(),), kwargs={}),
    )

    event_kwargs = SpyEvent(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(), kwargs={"value": _Value()}),
    )

    rehearsal_ars = WhenRehearsal(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(_Matcher(),), kwargs={}),
    )

    rehearsal_kwargs = WhenRehearsal(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(), kwargs={"value": _Matcher()}),
    )

    rehearsal_args_ignore_extra = WhenRehearsal(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(_Matcher(),), kwargs={}, ignore_extra_args=True),
    )

    rehearsal_kwargs_ignore_extra = WhenRehearsal(
        spy=SpyInfo(id=42, name="my_spy", is_async=False),
        payload=SpyCall(args=(), kwargs={"value": _Matcher()}, ignore_extra_args=True),
    )

    assert match_event(event_args, rehearsal_ars) is True
    assert match_event(event_kwargs, rehearsal_kwargs) is True
    assert match_event(event_args, rehearsal_args_ignore_extra) is True
    assert match_event(event_kwargs, rehearsal_kwargs_ignore_extra) is True