tooling: Log errors related to new checks as Infos (#976)

Implement a new function that logs errors related to new checks as Infos and not normal warnings with a message requesting to fix them before the new project version realize.

Author: Aymen-Soussi-01

tooling/docs/_tooling/extensions/score_metamodel/__init__.py

@@ -103,6 +103,12 @@ def is_check_enabled(check: local_check_function | graph_check_function):
     if log.has_warnings:
         log.warning("Some needs have issues. See the log for more information.")
 
+    if log.has_infos:
+        log.info(
+            "Some needs have issues related to the new checks. See the log for more information."
+        )
+        # TODO: exit code
+
 
 def load_metamodel_data():
     """

tooling/docs/_tooling/extensions/score_metamodel/log.py

@@ -21,7 +21,8 @@
 class CheckLogger:
     def __init__(self, log: SphinxLoggerAdapter, prefix: str):
         self._log = log
-        self._count = 0
+        self._info_count = 0
+        self._warning_count = 0
         self._prefix = prefix
 
     @staticmethod
@@ -41,25 +42,53 @@ def get(key: str) -> Any:
             return f"{matching_file}:{need['lineno']}"
         return None
 
-    def warning_for_option(self, need: NeedsInfoType, option: str, msg: str):
-        self.warning(
-            f"{need['id']}.{option} ({need.get(option, None)}): " + msg,
-            location=CheckLogger._location(need, self._prefix),
-        )
+    def warning_for_option(
+        self, need: NeedsInfoType, option: str, msg: str, new_check: bool = False
+    ):
+        full_msg = f"{need['id']}.{option} ({need.get(option, None)}): {msg}"
+        location = CheckLogger._location(need, self._prefix)
+        self._log_message(full_msg, location, new_check)
 
-    def warning_for_need(self, need: NeedsInfoType, msg: str):
-        self.warning(
-            f"{need['id']}: " + msg, location=CheckLogger._location(need, self._prefix)
-        )
+    def warning_for_need(self, need: NeedsInfoType, msg: str, new_check: bool = False):
+        full_msg = f"{need['id']}: {msg}"
+        location = CheckLogger._location(need, self._prefix)
+        self._log_message(full_msg, location, new_check)
+
+    def _log_message(
+        self,
+        msg: str,
+        location: None | str | tuple[str | None, int | None] | Node = None,
+        is_info: bool = False,
+    ):
+        if is_info:
+            msg += (
+                "\nPlease fix this warning related to the new check "
+                "before the release of the next version of Score."
+            )
+            self.info(msg, location)
+        else:
+            self.warning(msg, location)
+
+    def info(
+        self,
+        msg: str,
+        location: None | str | tuple[str | None, int | None] | Node = None,
+    ):
+        self._log.info(msg, type="score_metamodel", location=location)
+        self._info_count += 1
 
     def warning(
         self,
         msg: str,
         location: None | str | tuple[str | None, int | None] | Node = None,
     ):
         self._log.warning(msg, type="score_metamodel", location=location)
-        self._count += 1
+        self._warning_count += 1
 
     @property
     def has_warnings(self):
-        return self._count > 0
+        return self._warning_count > 0
+
+    @property
+    def has_infos(self):
+        return self._info_count > 0

tooling/docs/_tooling/extensions/score_metamodel/tests/__init__.py

@@ -26,6 +26,7 @@ class FakeCheckLogger(CheckLogger):
         def __init__(self):
             self._mock_logger = MagicMock(spec=SphinxLoggerAdapter)
             self._mock_logger.warning = MagicMock()
+            self._mock_logger.info = MagicMock()
             app_path = MagicMock()
             super().__init__(self._mock_logger, app_path)
 
@@ -36,9 +37,16 @@ def assert_no_warnings(self):
                 )
                 pytest.fail(f"Expected no warnings, but got:\n{warnings}")
 
+        def assert_no_infos(self):
+            if self.has_infos:
+                infos = "\n".join(
+                    f"* {call}" for call in self._mock_logger.info.call_args_list
+                )
+                pytest.fail(f"Expected no infos, but got:\n{infos}")
+
         def assert_warning(self, expected_substring: str, expect_location: bool = True):
             """
-            Assert that the logger was called exactly once with a message containing
+            Assert that the logger warning was called exactly once with a message containing
             a specific substring.
 
             This also verifies that the defaults from need() are used correctly.
@@ -61,6 +69,31 @@ def assert_warning(self, expected_substring: str, expect_location: bool = True):
             if expect_location:
                 assert kwargs["location"] == "docname.rst:42"
 
+        def assert_info(self, expected_substring: str, expect_location: bool = True):
+            """
+            Assert that the logger info was called exactly once with a message containing
+            a specific substring.
+
+            This also verifies that the defaults from need() are used correctly.
+            So you must use need() to create the need object that is passed
+            to the checks.
+            """
+            self._mock_logger.info.assert_called_once()
+
+            # Retrieve the call arguments
+            args, kwargs = self._mock_logger.info.call_args
+            log_message = args[0]
+
+            assert expected_substring in log_message, f"Expected substring '{
+                expected_substring
+            }' not found in log message: '{log_message}'"
+
+            # All our checks shall report themselves as score_metamodel checks
+            assert kwargs["type"] == "score_metamodel"
+
+            if expect_location:
+                assert kwargs["location"] == "docname.rst:42"
+
     return FakeCheckLogger()