refactor(CFMTech#46): Use markers to generate documentation.

The pytest_configure hook now uses the `PyTestMonitorMarkerProcessor` to iterate over all known markers in order to
generate the documentation.

Author: js-dieu

pytest_monitor/markers.py

@@ -1,5 +1,5 @@
 import warnings
-from typing import Any, Dict, List
+from typing import Any, Dict, Iterator, List
 
 import pytest
 
@@ -96,6 +96,9 @@ def __init__(self):
     def _defaults(self) -> Dict[str, Any]:
         return {marker.attribute: marker.default_value for marker in self._markers}
 
+    def __iter__(self) -> Iterator[PyTestMonitorMarker]:
+        return iter(self._markers)
+
     def __call__(self, item: pytest.Item) -> PyTestMonitorItemConfig:
         item_monitor_markers: Dict[str, pytest.Mark] = {
             marker.name: marker for marker in item.iter_markers() if marker and marker.name.startswith("monitor_")

pytest_monitor/models.py

@@ -41,6 +41,14 @@ def post_process(self, configuration: Dict[str, bool]) -> Dict[str, bool]:
     def name(self) -> str:
         return self._name
 
+    @property
+    def require_item(self) -> bool:
+        return self._require_item
+
+    @property
+    def documentation(self) -> str:
+        return self._doc
+
     @property
     def deprecated(self) -> bool:
         return self._deprecated

pytest_monitor/pytest_monitor.py

@@ -87,24 +87,13 @@ def pytest_addoption(parser):
     )
 
 
-def pytest_configure(config):
-    config.addinivalue_line("markers", "monitor_skip_test: mark test to be executed but not monitored.")
-    config.addinivalue_line(
-        "markers",
-        "monitor_skip_test_if(cond): mark test to be executed but not monitored if cond is verified.",
-    )
-    config.addinivalue_line(
-        "markers",
-        "monitor_test: mark test to be monitored (default behaviour)."
-        " This can turn handy to whitelist some test when you have disabled"
-        " monitoring on a whole module.",
-    )
-    config.addinivalue_line(
-        "markers",
-        "monitor_test_if(cond): mark test to be monitored if and only if cond"
-        " is verified. This can help you in whitelisting tests to be monitored"
-        " depending on some external conditions.",
-    )
+def pytest_configure(config: pytest.Config):
+    for marker in marker_processor:
+        marker_name = f"{marker.name}(condition)" if marker.require_item else marker.name
+        doc = f"{marker_name}: {marker.documentation}"
+        if marker.deprecated:
+            doc += "Deprecated, please consult documentation to update your test."
+        config.addinivalue_line("markers", doc)
 
 
 def pytest_runtest_setup(item: pytest.Item):