Add a hack to ignore logs unrelated to the tests

Some resampling tests started getting some log errors about some gRPC
task not being properly closed, which are clearly artefacts from other
tests that shouldn't appear there.

For example:

        assert config.initial_buffer_len == init_len
>       assert caplog.record_tuples == [
            (
                "frequenz.sdk.timeseries._resampling",
                logging.WARNING,
                f"initial_buffer_len ({init_len}) is bigger than "
                f"warn_buffer_len ({DEFAULT_BUFFER_LEN_WARN})",
            )
        ]
E       assert [('asyncio', 40, "Task was destroyed but it is pending!\ntask: <Task pending name='raw-component-data-8' coro=<MicrogridGrpcClient._component_data_task() done, defined at /home/luca/devel/sdk/src/frequenz/sdk/microgrid/client/_client.py:298> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7f9224472ca0>()]>>"), ('asyncio', 40, "Task was destroyed but it is pending!\ntask: <Task pending name='raw-component-data-18' coro=<MicrogridGrpcClient._component_data_task() done, defined at /home/luca/devel/sdk/src/frequenz/sdk/microgrid/client/_client.py:298> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7f9224472c10>()]>>"), ('frequenz.sdk.timeseries._resampling', 30, 'initial_buffer_len (257) is bigger than warn_buffer_len (128)')] == [('frequenz.sdk.timeseries._resampling', 30, 'initial_buffer_len (257) is bigger than warn_buffer_len (128)')]
E         At index 0 diff: ('asyncio', 40, "Task was destroyed but it is pending!\ntask: <Task pending name='raw-component-data-8' coro=<MicrogridGrpcClient._component_data_task() done, defined at /home/luca/devel/sdk/src/frequenz/sdk/microgrid/client/_client.py:298> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7f9224472ca0>()]>>") != ('frequenz.sdk.timeseries._resampling', 30, 'initial_buffer_len (257) is bigger than warn_buffer_len (128)')
E         Left contains 2 more items, first extra item: ('asyncio', 40, "Task was destroyed but it is pending!\ntask: <Task pending name='raw-component-data-18' coro=<Microgr...k/microgrid/client/_client.py:298> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7f9224472c10>()]>>")
E         Full diff:
E           [
E         +  ('asyncio',
E         +   40,
E         +   'Task was destroyed but it is pending!\n'
E         +   "task: <Task pending name='raw-component-data-8' "
E         +   'coro=<MicrogridGrpcClient._component_data_task() done, defined at '
E         +   '/home/luca/devel/sdk/src/frequenz/sdk/microgrid/client/_client.py:298> '
E         +   'wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at '
E         +   '0x7f9224472ca0>()]>>'),
E         +  ('asyncio',
E         +   40,
E         +   'Task was destroyed but it is pending!\n'
E         +   "task: <Task pending name='raw-component-data-18' "
E         +   'coro=<MicrogridGrpcClient._component_data_task() done, defined at '
E         +   '/home/luca/devel/sdk/src/frequenz/sdk/microgrid/client/_client.py:298> '
E         +   'wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at '
E         +   '0x7f9224472c10>()]>>'),
E            ('frequenz.sdk.timeseries._resampling',
E             30,
E             'initial_buffer_len (257) is bigger than warn_buffer_len (128)'),
E           ]

tests/timeseries/test_resampling.py:113: AssertionError

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

tests/timeseries/test_resampling.py

@@ -5,6 +5,8 @@
 Tests for the `TimeSeriesResampler`
 """
 
+from __future__ import annotations
+
 import logging
 from datetime import datetime, timedelta, timezone
 from typing import AsyncIterator, Iterator
@@ -94,7 +96,8 @@ async def test_resampler_config_len_ok(
         initial_buffer_len=init_len,
     )
     assert config.initial_buffer_len == init_len
-    assert caplog.records == []
+    # Ignore errors produced by wrongly finalized gRPC server in unrelated tests
+    assert _filter_logs(caplog.record_tuples, logger_name="") == []
 
 
 @pytest.mark.parametrize(
@@ -110,13 +113,11 @@ async def test_resampler_config_len_warn(
         initial_buffer_len=init_len,
     )
     assert config.initial_buffer_len == init_len
-    for record in caplog.records:
-        assert record.levelname == "WARNING"
-        assert caplog.text.startswith("")
-        assert (
-            caplog.text
-            == f"initial_buffer_len ({init_len}) is bigger than {DEFAULT_BUFFER_LEN_WARN}"
-    assert caplog.record_tuples == [
+    # Ignore errors produced by wrongly finalized gRPC server in unrelated tests
+    assert _filter_logs(
+        caplog.record_tuples,
+        logger_name="frequenz.sdk.timeseries._resampling",
+    ) == [
         (
             "frequenz.sdk.timeseries._resampling",
             logging.WARNING,
@@ -156,7 +157,11 @@ async def test_helper_buffer_too_big(
         fake_time.shift(1)
 
     _ = helper.resample(datetime.now(timezone.utc))
-    assert caplog.record_tuples == [
+    # Ignore errors produced by wrongly finalized gRPC server in unrelated tests
+    assert _filter_logs(
+        caplog.record_tuples,
+        logger_name="frequenz.sdk.timeseries._resampling",
+    ) == [
         (
             "frequenz.sdk.timeseries._resampling",
             logging.ERROR,
@@ -698,3 +703,9 @@ def _get_buffer_len(resampler: Resampler, source_recvr: Source) -> int:
     blen = resampler._resamplers[source_recvr]._helper._buffer.maxlen
     assert blen is not None
     return blen
+
+
+def _filter_logs(
+    record_tuples: list[tuple[str, int, str]], *, logger_name: str
+) -> list[tuple[str, int, str]]:
+    return [t for t in record_tuples if t[0] == logger_name]