Refactor hook tests

Author: linuxdaemon

tests/core_tests/test_plugin_hooks.py

@@ -8,15 +8,28 @@
 
 from sqlalchemy import MetaData
 
+from cloudbot.event import Event, CommandEvent, RegexEvent, CapEvent, PostHookEvent, IrcOutEvent
 from cloudbot.hook import Action
 from cloudbot.plugin import Plugin, Hook
+from cloudbot.util import database
+
+database.metadata = MetaData()
+Hook.original_init = Hook.__init__
+
+PLUGINS = []
+
+
+class MockBot:
+    def __init__(self):
+        self.loop = None
 
 
 def patch_hook_init(self, _type, plugin, func_hook):
     self.original_init(_type, plugin, func_hook)
+    self.func_hook = func_hook
+
 
-    assert not func_hook.kwargs, \
-        "Unknown arguments '{}' passed during registration of hook '{}'".format(func_hook.kwargs, self.function_name)
+Hook.__init__ = patch_hook_init
 
 
 def gather_plugins():
@@ -25,14 +38,7 @@ def gather_plugins():
     return path_list
 
 
-def load_plugin(plugin_path, monkeypatch):
-    if not hasattr(Hook, "original_init"):
-        monkeypatch.setattr('cloudbot.plugin.Hook.original_init', Hook.__init__, raising=False)
-
-    monkeypatch.setattr('cloudbot.plugin.Hook.__init__', patch_hook_init)
-
-    monkeypatch.setattr('cloudbot.util.database.metadata', MetaData())
-
+def load_plugin(plugin_path):
     path = Path(plugin_path)
     file_path = path.resolve()
     file_name = file_path.name
@@ -47,10 +53,23 @@ def load_plugin(plugin_path, monkeypatch):
     return Plugin(str(file_path), file_name, title, plugin_module)
 
 
+def get_plugins():
+    if not PLUGINS:
+        PLUGINS.extend(map(load_plugin, gather_plugins()))
+
+    return PLUGINS
+
+
 def pytest_generate_tests(metafunc):
-    if 'plugin_path' in metafunc.fixturenames:
-        paths = list(gather_plugins())
-        metafunc.parametrize('plugin_path', paths, ids=list(map(str, paths)))
+    if 'plugin' in metafunc.fixturenames:
+        plugins = get_plugins()
+        metafunc.parametrize('plugin', plugins, ids=[plugin.title for plugin in plugins])
+    elif 'hook' in metafunc.fixturenames:
+        plugins = get_plugins()
+        hooks = [hook for plugin in plugins for hook_list in plugin.hooks.values() for hook in hook_list]
+        metafunc.parametrize(
+            'hook', hooks, ids=["{}.{}".format(hook.plugin.title, hook.function_name) for hook in hooks]
+        )
 
 
 HOOK_ATTR_TYPES = {
@@ -69,15 +88,12 @@ def pytest_generate_tests(metafunc):
 }
 
 
-def test_plugin(plugin_path, monkeypatch):
-    plugin = load_plugin(plugin_path, monkeypatch)
-    for hooks in plugin.hooks.values():
-        for hook in hooks:
-            _test_hook(hook)
-
+def test_hook_kwargs(hook):
+    assert not hook.func_hook.kwargs, \
+        "Unknown arguments '{}' passed during registration of hook '{}'".format(
+            hook.func_hook.kwargs, hook.function_name
+        )
 
-def _test_hook(hook):
-    assert 'async' not in hook.required_args, "Use of deprecated function Event.async"
     for name, types in HOOK_ATTR_TYPES.items():
         try:
             attr = getattr(hook, name)
@@ -87,6 +103,33 @@ def _test_hook(hook):
             assert isinstance(attr, types), \
                 "Unexpected type '{}' for hook attribute '{}'".format(type(attr).__name__, name)
 
+
+def test_hook_doc(hook):
     if hook.type == "command" and hook.doc:
         assert hook.doc[:1] not in "." + string.ascii_letters, \
             "Invalid docstring '{}' format for command hook".format(hook.doc)
+
+
+def test_hook_args(hook):
+    assert 'async' not in hook.required_args, "Use of deprecated function Event.async"
+
+    bot = MockBot()
+    if hook.type in ("irc_raw", "perm_check", "periodic", "on_start", "on_stop", "event", "on_connect"):
+        event = Event(bot=bot)
+    elif hook.type == "command":
+        event = CommandEvent(bot=bot, hook=hook, text="", triggered_command="")
+    elif hook.type == "regex":
+        event = RegexEvent(bot=bot, hook=hook, match=None)
+    elif hook.type.startswith("on_cap"):
+        event = CapEvent(bot=bot, cap="")
+    elif hook.type == "post_hook":
+        event = PostHookEvent(bot=bot)
+    elif hook.type == "irc_out":
+        event = IrcOutEvent(bot=bot)
+    elif hook.type == "sieve":
+        return
+    else:
+        assert False, "Unhandled hook type '{}' in tests".format(hook.type)
+
+    for arg in hook.required_args:
+        assert hasattr(event, arg), "Undefined parameter '{}' for hook function".format(arg)