1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
import pykka
from pykka import Actor, ActorDeadError, ActorProxy
from tests.log_handler import LogLevel, PykkaTestLogHandler
if TYPE_CHECKING:
from collections.abc import Iterator
from tests.types import Runtime
class NestedObject:
pass
class ObjectWithEqImpl:
foo: str = "bar"
def __eq__(self, other: object) -> bool:
raise Exception("This is a broken __eq__ implementation")
class ActorForProxying(Actor):
a_nested_object = pykka.traversable(NestedObject())
a_class_attr = "class_attr"
# Include an object with a broken __eq__() implementation to test that it
# doesn't break introspection.
object_with_eq_impl = ObjectWithEqImpl()
def __init__(self) -> None:
super().__init__()
self.an_instance_attr = "an_instance_attr"
def a_method(self) -> None:
pass
@pytest.fixture(scope="module")
def actor_class(runtime: Runtime) -> type[ActorForProxying]:
class ActorForProxyingImpl(ActorForProxying, runtime.actor_class): # type: ignore[name-defined]
pass
return ActorForProxyingImpl
@pytest.fixture
def proxy(
actor_class: type[ActorForProxying],
) -> Iterator[ActorProxy[ActorForProxying]]:
proxy = ActorProxy(actor_ref=actor_class.start())
yield proxy
proxy.stop()
def test_eq_to_self(proxy: ActorProxy[ActorForProxying]) -> None:
assert proxy == proxy # noqa: PLR0124
def test_is_hashable(proxy: ActorProxy[ActorForProxying]) -> None:
assert hash(proxy) == hash(proxy)
def test_eq_to_another_proxy_for_same_actor_and_attr_path(
proxy: ActorProxy[ActorForProxying],
) -> None:
proxy2 = proxy.actor_ref.proxy()
assert proxy == proxy2
def test_not_eq_to_proxy_with_different_attr_path(
proxy: ActorProxy[ActorForProxying],
) -> None:
assert proxy != proxy.a_nested_object
def test_repr_is_wrapped_in_lt_and_gt(proxy: ActorProxy[ActorForProxying]) -> None:
result = repr(proxy)
assert result.startswith("<")
assert result.endswith(">")
def test_repr_reveals_that_this_is_a_proxy(proxy: ActorProxy[ActorForProxying]) -> None:
assert "ActorProxy" in repr(proxy)
def test_repr_contains_actor_class_name(proxy: ActorProxy[ActorForProxying]) -> None:
assert "ActorForProxying" in repr(proxy)
def test_repr_contains_actor_urn(proxy: ActorProxy[ActorForProxying]) -> None:
assert proxy.actor_ref.actor_urn in repr(proxy)
def test_repr_contains_attr_path(proxy: ActorProxy[ActorForProxying]) -> None:
assert "a_nested_object" in repr(proxy.a_nested_object)
def test_str_contains_actor_class_name(proxy: ActorProxy[ActorForProxying]) -> None:
assert "ActorForProxying" in str(proxy)
def test_str_contains_actor_urn(proxy: ActorProxy[ActorForProxying]) -> None:
assert proxy.actor_ref.actor_urn in str(proxy)
def test_dir_on_proxy_lists_attributes_of_the_actor(
proxy: ActorProxy[ActorForProxying],
) -> None:
result = dir(proxy)
assert "a_class_attr" in result
assert "an_instance_attr" in result
assert "a_method" in result
assert "object_with_eq_impl" in result
def test_dir_on_proxy_lists_private_attributes_of_the_proxy(
proxy: ActorProxy[ActorForProxying],
) -> None:
result = dir(proxy)
assert "__class__" in result
assert "__dict__" in result
assert "__getattr__" in result
assert "__setattr__" in result
def test_refs_proxy_method_returns_a_proxy(
actor_class: type[ActorForProxying],
) -> None:
proxy_from_ref_proxy = actor_class.start().proxy()
assert isinstance(proxy_from_ref_proxy, ActorProxy)
proxy_from_ref_proxy.stop().get()
def test_proxy_constructor_raises_exception_if_actor_is_dead(
actor_class: type[Actor],
) -> None:
actor_ref = actor_class.start()
actor_ref.stop()
with pytest.raises(ActorDeadError) as exc_info:
ActorProxy(actor_ref=actor_ref)
assert str(exc_info.value) == f"{actor_ref} not found"
def test_actor_ref_may_be_retrieved_from_proxy_if_actor_is_dead(
proxy: ActorProxy[ActorForProxying],
) -> None:
proxy.actor_ref.stop()
assert not proxy.actor_ref.is_alive()
def test_actor_proxy_does_not_expose_proxy_to_self(
runtime: Runtime,
log_handler: PykkaTestLogHandler,
) -> None:
class SelfReferencingActor(runtime.actor_class): # type: ignore[name-defined]
def __init__(self) -> None:
super().__init__()
self.self_proxy = self.actor_ref.proxy()
self.foo = "bar"
actor_ref = SelfReferencingActor.start()
try:
proxy = actor_ref.proxy()
assert proxy.foo.get() == "bar"
with pytest.raises(AttributeError, match="has no attribute 'self_proxy'"):
proxy.self_proxy.foo.get()
finally:
actor_ref.stop()
log_handler.wait_for_message(LogLevel.WARNING)
with log_handler.lock:
assert len(log_handler.messages[LogLevel.WARNING]) == 2
log_record = log_handler.messages[LogLevel.WARNING][0]
assert (
"attribute 'self_proxy' is a proxy to itself. "
"Consider making it private by renaming it to '_self_proxy'."
) in log_record.getMessage()
|