🐛 Disable propagation for aiida logger (#7319)

Set `propagate` to `False` for the top-level `aiida` logger.
This prevents AiiDA log records from bubbling up to the root
logger and being emitted twice when third-party code, such as
circus, installs its own root handler.

Add an autouse test fixture that forwards `aiida` and `verdi`
log records to pytest's `caplog` handler even when the
production logging configuration disables propagation. This
keeps the existing logging assertions working after setting the
top-level `aiida` logger to `propagate = False`.

The issue #7339 to solve hotfix properly has been created.

Reviewed-by: Julian Geiger <julian.geiger@psi.ch>

Author: agoscinski

src/aiida/common/log.py

@@ -96,7 +96,7 @@ def get_logging_config() -> dict[str, t.Any]:
             'aiida': {
                 'handlers': ['console'],
                 'level': lambda: get_config_option('logging.aiida_loglevel'),
-                'propagate': True,
+                'propagate': False,
             },
             'verdi': {
                 'handlers': ['cli'],

tests/conftest.py

@@ -16,6 +16,7 @@
 
 import copy
 import dataclasses
+import logging
 import os
 import pathlib
 import subprocess
@@ -118,6 +119,51 @@ def pytest_addoption(parser):
     )
 
 
+@pytest.fixture(autouse=True)
+def capture_aiida_and_verdi_logs(request, monkeypatch):
+    """Forward AiiDA and verdi log records to ``caplog`` despite ``propagate=False``.
+
+    The production logging configuration disables propagation for the top-level ``aiida`` and ``verdi`` loggers.
+    For tests that use ``caplog``, attach the pytest log capture handler directly to those loggers and re-attach it
+    after any logging reconfiguration so existing ``caplog``-based assertions keep observing their records.
+    """
+    if 'caplog' not in request.fixturenames:
+        yield
+        return
+
+    from aiida.common import log as common_log
+
+    caplog = request.getfixturevalue('caplog')
+
+    def attach_handler() -> None:
+        for logger_name in ('aiida', 'verdi'):
+            logger = logging.getLogger(logger_name)
+            if caplog.handler not in logger.handlers:
+                logger.addHandler(caplog.handler)
+
+    original_configure_logging = common_log.configure_logging
+
+    def configure_logging(*args, **kwargs):
+        result = original_configure_logging(*args, **kwargs)
+        attach_handler()
+        return result
+
+    monkeypatch.setattr(common_log, 'configure_logging', configure_logging)
+    monkeypatch.setattr('aiida.configure_logging', configure_logging, raising=False)
+    monkeypatch.setattr('aiida.engine.daemon.worker.configure_logging', configure_logging, raising=False)
+    monkeypatch.setattr('aiida.cmdline.params.options.main.configure_logging', configure_logging, raising=False)
+
+    attach_handler()
+
+    try:
+        yield
+    finally:
+        for logger_name in ('aiida', 'verdi'):
+            logger = logging.getLogger(logger_name)
+            if caplog.handler in logger.handlers:
+                logger.removeHandler(caplog.handler)
+
+
 @pytest.fixture(scope='session')
 def aiida_profile(pytestconfig, aiida_config, aiida_profile_factory, config_psql_dos, config_sqlite_dos):
     """Create and load a profile with ``core.psql_dos`` as a storage backend and RabbitMQ as the broker.