Use the core warnings helpers in the tests

The tests used `warnings.catch_warnings()` blocks for two different
things, now done by the `frequenz.core.warnings` helper made for each:

* An "ignore" filter, to call deprecated APIs the test needs as setup,
  becomes `ignoring_deprecations()`, like in the library.
* An "error" filter, to check that a replacement API doesn't go through
  a deprecated one, becomes `asserting_no_deprecations()`. It records
  the warnings instead of raising them inside the code under test, so a
  broad `except` there can't swallow the failure, and it reports every
  offending warning with its location when the block ends.

The blocks that record warnings to check what a helper lets through are
left alone: that is what `catch_warnings(record=True)` is for.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Author: llucax

tests/grid/_delivery_area/test_delivery_area.py

@@ -3,10 +3,10 @@
 
 """Tests for the DeliveryArea class."""
 
-import warnings
 from dataclasses import dataclass
 
 import pytest
+from frequenz.core.warnings import asserting_no_deprecations
 
 from frequenz.client.common import (
     UnrecognizedEnumValueError,
@@ -62,8 +62,7 @@ class _TestCase:
 )
 def test_creation_valid(case: _TestCase) -> None:
     """Well-formed DeliveryArea construction succeeds without warnings."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         area = DeliveryArea(code=case.code, code_type=case.code_type)
     assert area.code == case.code
     assert area.code_type == case.code_type
@@ -161,8 +160,7 @@ def test_creation_with_unspecified_code_type_member_emits_deprecation_warning()
 )
 def test_creation_raises_on_invalid_code(case: _TestCase) -> None:
     """`_raise_on_invalid=True` raises `ValueError` on empty/`None` code."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         with pytest.raises(ValueError, match="`code` cannot be None or empty"):
             DeliveryArea(
                 code=case.code,
@@ -173,8 +171,7 @@ def test_creation_raises_on_invalid_code(case: _TestCase) -> None:
 
 def test_creation_raises_on_unspecified_int_code_type() -> None:
     """`_raise_on_invalid=True` raises `ValueError` on `code_type=0`."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         with pytest.raises(
             ValueError, match="`code_type` cannot be 0 \\(UNSPECIFIED\\)"
         ):
@@ -185,8 +182,7 @@ def test_creation_raises_on_unspecified_member_code_type() -> None:
     """`_raise_on_invalid=True` raises `ValueError` on the UNSPECIFIED member."""
     with pytest.deprecated_call():
         unspecified = EnergyMarketCodeType.UNSPECIFIED
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         with pytest.raises(
             ValueError, match="`code_type` cannot be 0 \\(UNSPECIFIED\\)"
         ):
@@ -195,8 +191,7 @@ def test_creation_raises_on_unspecified_member_code_type() -> None:
 
 def test_creation_does_not_raise_when_valid() -> None:
     """`_raise_on_invalid=True` does not raise on well-formed data."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         area = DeliveryArea(
             code="DE",
             code_type=EnergyMarketCodeType.EUROPE_EIC,
@@ -263,8 +258,7 @@ def test_get_code_type_raises_unspecified_for_value_zero_member() -> None:
         unspecified = EnergyMarketCodeType.UNSPECIFIED
     with pytest.deprecated_call():
         area = DeliveryArea(code="TEST", code_type=unspecified)
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         with pytest.raises(UnspecifiedEnumValueError):
             area.get_code_type()
 

tests/grid/_delivery_area/test_invalid_delivery_area.py

@@ -3,10 +3,10 @@
 
 """Tests for the InvalidDeliveryArea class."""
 
-import warnings
 from dataclasses import dataclass
 
 import pytest
+from frequenz.core.warnings import asserting_no_deprecations
 
 from frequenz.client.common.grid import (
     BaseDeliveryArea,
@@ -70,8 +70,7 @@ def test_is_base_delivery_area_subclass() -> None:
 )
 def test_creation(case: _TestCase) -> None:
     """`InvalidDeliveryArea` accepts any data with no invariants and no warnings."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         area = InvalidDeliveryArea(code=case.code, code_type=case.code_type)
     assert area.code == case.code
     assert area.code_type == case.code_type

tests/grid/proto/v1alpha8/test_delivery_area.py

@@ -8,6 +8,7 @@
 
 import pytest
 from frequenz.api.common.v1alpha8.grid import delivery_area_pb2
+from frequenz.core.warnings import asserting_no_deprecations
 
 from frequenz.client.common import UnspecifiedEnumValueError
 from frequenz.client.common.grid import (
@@ -264,8 +265,7 @@ def test_from_proto2(
         code=case.code, code_type=case.code_type  # type: ignore[arg-type]
     )
     with caplog.at_level("WARNING"):
-        with warnings.catch_warnings():
-            warnings.simplefilter("error", DeprecationWarning)
+        with asserting_no_deprecations():
             area = delivery_area_from_proto2(proto)
 
     assert isinstance(area, case.expected_type)

tests/metrics/proto/v1alpha8/test_sample_metric_connection.py

@@ -3,10 +3,9 @@
 
 """Tests for MetricConnection protobuf conversion."""
 
-import warnings
-
 import pytest
 from frequenz.api.common.v1alpha8.metrics import metrics_pb2
+from frequenz.core.warnings import asserting_no_deprecations
 
 from frequenz.client.common.metrics import MetricConnectionCategory
 from frequenz.client.common.metrics.proto.v1alpha8 import (
@@ -111,8 +110,7 @@ def test_from_proto_unspecified_category() -> None:
         name="some_connection",
     )
 
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         connection = metric_connection_from_proto(proto)
 
     assert connection.category == 0

tests/metrics/proto/v1alpha8/test_sample_metric_sample.py

@@ -4,13 +4,13 @@
 """Tests for MetricSample protobuf conversion."""
 
 import math
-import warnings
 from dataclasses import dataclass, field
 from datetime import datetime, timezone
 from typing import Final
 
 import pytest
 from frequenz.api.common.v1alpha8.metrics import bounds_pb2, metrics_pb2
+from frequenz.core.warnings import asserting_no_deprecations
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.common import InvalidDatetime, InvalidDatetimeError
@@ -373,8 +373,7 @@ def test_from_proto_unspecified_metric() -> None:
         ),
     )
 
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         sample = metric_sample_from_proto(proto)
 
     assert sample.metric == 0

tests/microgrid/electrical_components/proto/v1alpha8/conftest.py

@@ -3,7 +3,6 @@
 
 """Fixtures and utilities for testing electrical component protobuf conversion."""
 
-import warnings
 from datetime import datetime, timezone
 
 import pytest
@@ -12,6 +11,7 @@
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core.warnings import ignoring_deprecations
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.common.metrics import Bounds, BoundsSet, Metric
@@ -53,8 +53,7 @@ def default_component_base_data(
     component_id: ElectricalComponentId, microgrid_id: MicrogridId
 ) -> _ElectricalComponentBaseData:
     """Provide a fixture for common component fields."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.UNSPECIFIED
     return _ElectricalComponentBaseData(
         component_id=component_id,

tests/microgrid/electrical_components/proto/v1alpha8/test_electrical_component_base.py

@@ -4,14 +4,14 @@
 """Tests for protobuf conversion of the base/common part of electrical components."""
 
 import math
-import warnings
 from datetime import timezone
 
 import pytest
 from frequenz.api.common.v1alpha8.metrics import bounds_pb2, metrics_pb2
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core.warnings import ignoring_deprecations
 from google.protobuf.timestamp_pb2 import Timestamp
 
 from frequenz.client.common.metrics import (
@@ -85,8 +85,7 @@ def test_operational_mode_to_bools(
 
 def test_complete(default_component_base_data: _ElectricalComponentBaseData) -> None:
     """Test parsing of a complete base component proto."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.CHP  # Just to pick a valid category
     base_data = default_component_base_data._replace(category=category)
     proto = base_data_as_proto(base_data)
@@ -99,8 +98,7 @@ def test_missing_category_specific_info(
     default_component_base_data: _ElectricalComponentBaseData,
 ) -> None:
     """Test parsing with missing optional category specific info."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.UNSPECIFIED
     base_data = default_component_base_data._replace(
         name="",
@@ -122,8 +120,7 @@ def test_empty_lifetime_is_unbounded(
     default_component_base_data: _ElectricalComponentBaseData,
 ) -> None:
     """A present but empty protobuf lifetime becomes an unbounded `Lifetime`."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.CHP
     base_data = default_component_base_data._replace(
         category=category,
@@ -141,8 +138,7 @@ def test_category_specific_info_mismatch(
     default_component_base_data: _ElectricalComponentBaseData,
 ) -> None:
     """Test category and category specific info mismatch."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.GRID_CONNECTION_POINT
     base_data = default_component_base_data._replace(
         category=category,
@@ -165,8 +161,7 @@ def test_invalid_lifetime(
     default_component_base_data: _ElectricalComponentBaseData,
 ) -> None:
     """Test invalid lifetime (start after end)."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.CHP
     base_data = default_component_base_data._replace(
         category=category,
@@ -204,8 +199,7 @@ def _metric_bound(
 
 def test_metric_config_bounds_stores_unspecified_as_int() -> None:
     """Test UNSPECIFIED metric bounds load as plain int key 0."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         unspecified = Metric.UNSPECIFIED
     message = [
         _metric_bound(int(unspecified.value), 0.0, 1.0),

tests/microgrid/electrical_components/proto/v1alpha8/test_electrical_component_simple.py

@@ -3,12 +3,11 @@
 
 """Tests for protobuf conversion of simple electrical components."""
 
-import warnings
-
 import pytest
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core.warnings import ignoring_deprecations
 
 from frequenz.client.common.microgrid.electrical_components import (
     Breaker,
@@ -100,8 +99,7 @@ def test_category_mismatch(
     assert electrical_component_class_to_proto(component) == (1, None)
 
 
-with warnings.catch_warnings():
-    warnings.simplefilter("ignore", DeprecationWarning)
+with ignoring_deprecations():
     _TRIVIAL_CASES = [
         pytest.param(ElectricalComponentCategory.BREAKER, Breaker, id="Breaker"),
         pytest.param(
@@ -167,8 +165,7 @@ def test_power_transformer(
     secondary: float | None,
 ) -> None:
     """Test PowerTransformer component."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.POWER_TRANSFORMER
     base_data = default_component_base_data._replace(category=category)
 
@@ -196,8 +193,7 @@ def test_grid(
     rated_fuse_current: int | None,
 ) -> None:
     """Test GridConnectionPoint component with default values."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.GRID_CONNECTION_POINT
     base_data = default_component_base_data._replace(category=category)
 

tests/microgrid/electrical_components/proto/v1alpha8/test_electrical_component_with_type.py

@@ -3,12 +3,11 @@
 
 """Tests for protobuf conversion of components with a type."""
 
-import warnings
-
 import pytest
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core.warnings import ignoring_deprecations
 
 from frequenz.client.common.microgrid.electrical_components import (
     AcEvCharger,
@@ -72,8 +71,7 @@ def test_battery(
     pb_battery_type: int,
 ) -> None:
     """Test battery component."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.BATTERY
     base_data = default_component_base_data._replace(category=category)
     proto = base_data_as_proto(base_data)
@@ -126,8 +124,7 @@ def test_ev_charger(
     pb_ev_charger_type: int,
 ) -> None:
     """Test EV Charger component."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.EV_CHARGER
     base_data = default_component_base_data._replace(category=category)
     proto = base_data_as_proto(base_data)
@@ -180,8 +177,7 @@ def test_inverter(
     pb_inverter_type: int,
 ) -> None:
     """Test inverter component."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         category = ElectricalComponentCategory.INVERTER
     base_data = default_component_base_data._replace(category=category)
     proto = base_data_as_proto(base_data)

tests/microgrid/electrical_components/proto/v1alpha8/test_enum_deprecation.py

@@ -3,12 +3,11 @@
 
 """Tests for deprecation of the category enum and its proto converters."""
 
-import warnings
-
 import pytest
 from frequenz.api.common.v1alpha8.microgrid.electrical_components import (
     electrical_components_pb2,
 )
+from frequenz.core.warnings import asserting_no_deprecations, ignoring_deprecations
 
 from frequenz.client.common.microgrid.electrical_components import (
     ElectricalComponentCategory,
@@ -29,8 +28,7 @@ def test_electrical_component_category_member_warns() -> None:
 
 def test_electrical_component_category_to_proto_warns() -> None:
     """Calling `electrical_component_category_to_proto` must warn."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("ignore", DeprecationWarning)
+    with ignoring_deprecations():
         member = ElectricalComponentCategory.BATTERY
     with pytest.deprecated_call():
         _ = electrical_component_category_to_proto(member)
@@ -46,8 +44,7 @@ def test_electrical_component_category_from_proto_warns() -> None:
 
 def test_class_to_proto_does_not_warn() -> None:
     """The non-deprecated `electrical_component_class_to_proto` must NOT warn."""
-    with warnings.catch_warnings():
-        warnings.simplefilter("error", DeprecationWarning)
+    with asserting_no_deprecations():
         result = electrical_component_class_to_proto(LiIonBattery)
     assert result == (
         electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_BATTERY,