Add validation that method was specified before in NoxTasks

Author: ArBridgeman

exasol/toolbox/config.py

@@ -11,20 +11,29 @@
     computed_field,
 )
 
-from exasol.toolbox.nox.plugin import PLUGIN_ATTR_NAME
+from exasol.toolbox.nox.plugin import (
+    METHODS_SPECIFIED_FOR_HOOKS,
+    PLUGIN_ATTR_NAME,
+)
 from exasol.toolbox.util.version import Version
 
 
 def validate_plugin_hook(plugin_class: object):
     """
-    Checks all methods in a class for at least one specific pluggy hookimpl marker.
-    Raises ValueError if no methods are found with the marker.
+    Checks methods in a class for at least one specific pluggy @hookimpl marker
+    and verifies it is specified in `exasol.toolbox.nox.plugins.NoxTasks`.
     """
     for name, method in inspect.getmembers(plugin_class, inspect.isroutine):
         if hasattr(method, PLUGIN_ATTR_NAME):
-            return True
+            if name in METHODS_SPECIFIED_FOR_HOOKS:
+                return True
+            raise ValueError(
+                f"Method `{name}` in `{plugin_class.__name__}` was decorated with "
+                "`@hookimpl`, but this is not defined in "
+                "`exasol.toolbox.nox.plugins.NoxTasks`."
+            )
     raise ValueError(
-        f"No methods in {plugin_class.__name__} were found to be decorated"
+        f"No methods in `{plugin_class.__name__}` were found to be decorated"
         "with `@hookimpl`"
     )
 
@@ -92,8 +101,7 @@ class BaseConfig(BaseModel):
         by the python-toolbox. As described on the plugins pages:
             - https://exasol.github.io/python-toolbox/main/user_guide/customization.html#plugins
             - https://exasol.github.io/python-toolbox/main/developer_guide/plugins.html,
-        possible plugin options are defined in the `exasol.toolbox.nox.plugins`
-        namespace.
+        possible plugin options are defined in `exasol.toolbox.nox.plugins.NoxTasks`.
         """,
     )
     model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)

exasol/toolbox/nox/plugin.py

@@ -1,3 +1,5 @@
+import inspect
+
 import pluggy
 
 _PLUGIN_MARKER = "python-toolbox-nox"
@@ -109,3 +111,10 @@ def plugin_manager(config) -> pluggy.PluginManager:
         for plugin in getattr(config, "plugins", []):
             pm.register(plugin())
         return pm
+
+
+METHODS_SPECIFIED_FOR_HOOKS = [
+    name
+    for name, method in inspect.getmembers(NoxTasks, inspect.isroutine)
+    if hasattr(method, f"{_PLUGIN_MARKER}_spec")
+]

test/unit/config_test.py

@@ -96,6 +96,12 @@ def prepare_release_update_version(self, session, config, version: Version) -> N
         print("This is a simple, silly hook.")
 
 
+class WithNotSpecifiedHook:
+    @hookimpl
+    def not_specified_anywhere(self, session, config, version: Version) -> None:
+        print("This is not a properly prepared hook.")
+
+
 class WithoutHook:
     def prepare_release_update_version(self, session, config, version: Version) -> None:
         print("This is not a properly prepared hook.")
@@ -110,7 +116,14 @@ def test_works_when_empty():
     def test_works_for_hook(capsys):
         BaseConfig(plugins=(WithHook,))
 
+    @staticmethod
+    def test_raises_exception_method_with_hook_not_specified():
+        with pytest.raises(ValidationError) as ex:
+            BaseConfig(plugins=(WithNotSpecifiedHook,))
+        assert "Method `not_specified_anywhere`" in str(ex.value)
+
     @staticmethod
     def test_raises_exception_without_hook():
-        with pytest.raises(ValueError, match="with `@hookimpl`"):
+        with pytest.raises(ValidationError) as ex:
             BaseConfig(plugins=(WithoutHook,))
+        assert "No methods in `WithoutHook`" in str(ex.value)