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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
|
"""
``PluginManager`` unit and public API testing.
"""
import pytest
from napari_plugin_engine import (
HookCallError,
HookImplementationMarker,
HookSpecificationMarker,
PluginValidationError,
)
hookspec = HookSpecificationMarker("example")
hookimpl = HookImplementationMarker("example")
def test_plugin_double_register(pm):
"""Registering the same plugin more then once isn't allowed"""
pm.register(42, name="abc")
with pytest.raises(ValueError):
pm.register(42, name="abc")
with pytest.raises(ValueError):
pm.register(42, name="def")
def test_pm(pm):
"""Basic registration with objects"""
class A:
pass
a1, a2 = A(), A()
pm.register(a1)
assert pm.is_registered(a1)
pm.register(a2, "hello")
assert pm.is_registered(a1)
assert pm.is_registered(a2)
assert pm.plugins.get("hello") == a2
assert pm.unregister(a1) == a1
assert not pm.is_registered(a1)
def test_is_registered(pm):
class A:
pass
a1 = A()
pm.register(a1, "hello")
assert pm.is_registered(a1)
assert pm.is_registered("hello")
def test_register_dynamic_attr(he_pm):
class A:
def __getattr__(self, name):
if name[0] != "_":
return 42
raise AttributeError()
a = A()
pname = he_pm.register(a)
assert he_pm.plugins.get(pname)
assert not he_pm.get_hookcallers(a)
def test_pm_name(pm):
class A:
pass
a1 = A()
name = pm.register(a1, name="hello")
assert name == "hello"
pm.unregister(a1)
assert not pm.is_registered(a1)
assert not pm.plugins
name2 = pm.register(a1, name="hello")
assert name2 == name
pm.unregister("hello")
assert not pm.is_registered(a1)
assert not pm.plugins
def test_set_blocked(pm):
class A:
pass
a1 = A()
name = pm.register(a1)
assert pm.is_registered(a1)
assert not pm.is_blocked(name)
pm.set_blocked(name)
assert pm.is_blocked(name)
assert not pm.is_registered(a1)
pm.set_blocked("somename")
assert pm.is_blocked("somename")
assert not pm.register(A(), "somename")
with pytest.warns(UserWarning):
pm.unregister("somename")
assert pm.is_blocked("somename")
def test_register_mismatch_method(he_pm):
class hello:
@hookimpl
def he_method_notexists(self):
pass
plugin = hello()
he_pm.register(plugin)
with pytest.raises(PluginValidationError) as excinfo:
he_pm.check_pending()
assert excinfo.value.plugin is plugin
def test_register_mismatch_arg(he_pm):
class hello:
@hookimpl
def he_method1(self, qlwkje):
pass
plugin = hello()
with pytest.raises(PluginValidationError) as excinfo:
he_pm.register(plugin)
assert excinfo.value.plugin == plugin
def test_register(pm):
class MyPlugin:
pass
my = MyPlugin()
myname = pm.register(my)
assert pm.is_registered(my)
my2 = MyPlugin()
my2name = pm.register(my2)
assert set([myname, my2name]).issubset(set(pm.plugins))
assert pm.is_registered(my)
assert pm.is_registered(my2)
pm.unregister(my)
assert not pm.is_registered(my)
def test_register_dict(he_pm):
assert not he_pm.hook.he_method1.get_hookimpls()
assert not he_pm.plugins
he_pm.register({'he_method1': lambda arg: arg + 1})
assert len(he_pm.plugins) == 1
assert 'orphan' in he_pm.plugins.keys()
assert he_pm.hook.he_method1.get_hookimpls()
assert he_pm.hook.he_method1(arg=1) == [2]
def test_register_getattr_error(he_pm):
"""This test mimics the dask.delayed decorator. It should pass gracefully."""
def mock_delayed(func):
class GetAnything:
def __getattr__(self, val):
return self
def __call__(self, *args):
return func(*args)
def __bool__(self):
raise TypeError("Truth of object not supported")
def __get__(self, instance, cls):
import types
if instance is None:
return self
return types.MethodType(self, instance)
return GetAnything()
class Plugin1:
@mock_delayed
def he_method1(self):
pass
pname = he_pm.register(Plugin1)
# make sure that nonsense wasn't registered
assert len(he_pm.get_hookcallers(he_pm.plugins.get(pname))) == 0
def test_register_unknown_hooks(pm):
class Plugin1:
@hookimpl
def he_method1(self, arg):
return arg + 1
pname = pm.register(Plugin1())
class Hooks:
@hookspec
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
# assert not pm._unverified_hooks
assert pm.hook.he_method1(arg=1) == [2]
assert len(pm.get_hookcallers(pm.plugins.get(pname))) == 1
def test_register_historic(pm):
class Hooks:
@hookspec(historic=True)
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
pm.hook.he_method1.call_historic(kwargs=dict(arg=1))
out = []
class Plugin:
@hookimpl
def he_method1(self, arg):
out.append(arg)
pm.register(Plugin())
assert out == [1]
class Plugin2:
@hookimpl
def he_method1(self, arg):
out.append(arg * 10)
pm.register(Plugin2())
assert out == [1, 10]
pm.hook.he_method1.call_historic(kwargs=dict(arg=12))
assert out == [1, 10, 120, 12]
def test_historic_firstresult_incompatible(pm):
with pytest.raises(ValueError):
@hookspec(historic=True, firstresult=True)
def he_method1(self, arg):
pass
@pytest.mark.parametrize("result_callback", [True, False])
def test_with_result_memorized(pm, result_callback):
"""Verify that ``HookCaller._maybe_apply_history()`
correctly applies the ``result_callback`` function, when provided,
to the result from calling each newly registered hook.
"""
out = []
if result_callback:
def callback(res):
out.append(res)
else:
callback = None
class Hooks:
@hookspec(historic=True)
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
class Plugin1:
@hookimpl
def he_method1(self, arg):
return arg * 10
pm.register(Plugin1())
he_method1 = pm.hook.he_method1
he_method1.call_historic(result_callback=callback, kwargs=dict(arg=1))
class Plugin2:
@hookimpl
def he_method1(self, arg):
return arg * 10
pm.register(Plugin2())
if result_callback:
assert out == [10, 10]
else:
assert out == []
def test_with_callbacks_immediately_executed(pm):
class Hooks:
@hookspec(historic=True)
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
class Plugin1:
@hookimpl
def he_method1(self, arg):
return arg * 10
class Plugin2:
@hookimpl
def he_method1(self, arg):
return arg * 20
class Plugin3:
@hookimpl
def he_method1(self, arg):
return arg * 30
out = []
pm.register(Plugin1())
pm.register(Plugin2())
he_method1 = pm.hook.he_method1
he_method1.call_historic(lambda res: out.append(res), dict(arg=1))
assert out == [20, 10]
pm.register(Plugin3())
assert out == [20, 10, 30]
def test_register_historic_incompat_hookwrapper(pm):
class Hooks:
@hookspec(historic=True)
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
out = []
class Plugin:
@hookimpl(hookwrapper=True)
def he_method1(self, arg):
out.append(arg)
with pytest.raises(PluginValidationError):
pm.register(Plugin())
def test_call_extra(pm):
class Hooks:
@hookspec
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
def he_method1(arg):
return arg * 10
out = pm.hook.he_method1.call_extra([he_method1], dict(arg=1))
assert out == [10]
def test_call_with_too_few_args(pm):
class Hooks:
@hookspec
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
class Plugin1:
@hookimpl
def he_method1(self, arg):
0 / 0
pm.register(Plugin1())
with pytest.raises(HookCallError):
with pytest.warns(UserWarning):
pm.hook.he_method1()
# @pytest.mark.skip(reason='removed subset hook caller function')
# def test_subset_hook_caller(pm):
# class Hooks:
# @hookspec
# def he_method1(self, arg):
# pass
# pm.add_hookspecs(Hooks)
# out = []
# class Plugin1:
# @hookimpl
# def he_method1(self, arg):
# out.append(arg)
# class Plugin2:
# @hookimpl
# def he_method1(self, arg):
# out.append(arg * 10)
# class PluginNo:
# pass
# plugin1, plugin2, plugin3 = Plugin1(), Plugin2(), PluginNo()
# pm.register(plugin1)
# pm.register(plugin2)
# pm.register(plugin3)
# pm.hook.he_method1(arg=1)
# assert out == [10, 1]
# out[:] = []
# hc = pm.subset_hook_caller("he_method1", [plugin1])
# hc(arg=2)
# assert out == [20]
# out[:] = []
# hc = pm.subset_hook_caller("he_method1", [plugin2])
# hc(arg=2)
# assert out == [2]
# out[:] = []
# pm.unregister(plugin1)
# hc(arg=2)
# assert out == []
# out[:] = []
# pm.hook.he_method1(arg=1)
# assert out == [10]
def test_get_hookimpls(pm):
class Hooks:
@hookspec
def he_method1(self, arg):
pass
pm.add_hookspecs(Hooks)
assert pm.hook.he_method1.get_hookimpls() == []
class Plugin1:
@hookimpl
def he_method1(self, arg):
pass
class Plugin2:
@hookimpl
def he_method1(self, arg):
pass
class PluginNo:
pass
plugin1, plugin2, plugin3 = Plugin1(), Plugin2(), PluginNo()
pm.register(plugin1)
pm.register(plugin2)
pm.register(plugin3)
hookimpls = pm.hook.he_method1.get_hookimpls()
hook_plugins = [item.plugin for item in hookimpls]
assert hook_plugins == [plugin1, plugin2]
def test_add_hookspecs_nohooks(pm):
with pytest.raises(ValueError):
pm.add_hookspecs(10)
def test_add_tracefuncs(he_pm):
out = []
class api1:
@hookimpl
def he_method1(self):
out.append("he_method1-api1")
class api2:
@hookimpl
def he_method1(self):
out.append("he_method1-api2")
he_pm.register(api1())
he_pm.register(api2())
def before(hook_name, hook_impls, kwargs):
out.append((hook_name, list(hook_impls), kwargs))
def after(outcome, hook_name, hook_impls, kwargs):
out.append((outcome, hook_name, list(hook_impls), kwargs))
undo = he_pm.add_hookcall_monitoring(before, after)
he_pm.hook.he_method1(arg=1)
assert len(out) == 4
assert out[0][0] == "he_method1"
assert len(out[0][1]) == 2
assert isinstance(out[0][2], dict)
assert out[1] == "he_method1-api2"
assert out[2] == "he_method1-api1"
assert len(out[3]) == 4
assert out[3][1] == out[0][0]
undo()
he_pm.hook.he_method1(arg=1)
assert len(out) == 4 + 2
def test_hook_tracing(he_pm):
saveindent = []
class api1:
@hookimpl
def he_method1(self):
saveindent.append(he_pm.trace.root.indent)
class api2:
@hookimpl
def he_method1(self):
saveindent.append(he_pm.trace.root.indent)
raise ValueError()
he_pm.register(api1())
out = []
he_pm.trace.root.setwriter(out.append)
undo = he_pm.enable_tracing()
try:
indent = he_pm.trace.root.indent
he_pm.hook.he_method1(arg=1)
assert indent == he_pm.trace.root.indent
assert len(out) == 2
assert "he_method1" in out[0]
assert "finish" in out[1]
out[:] = []
he_pm.register(api2())
# # TODO: decide on exception handling behavior. We currently
# # catch errors in multicall so this fails
# with pytest.raises(ValueError):
# he_pm.hook.he_method1(arg=1)
# assert he_pm.trace.root.indent == indent
# assert saveindent[0] > indent
finally:
undo()
|