Fix warning about TestEnv being interpreted as a test

The `TestEnv` class actually holds just stuff that it is reused in
different test, but `pytest` integret classes starting with `Test` as
test suites. We just rename to `_TestEnv` to avoid the confusion (and
warnings).

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

Author: llucax

tests/test_frequenz_dispatch.py

@@ -55,7 +55,7 @@ def _now() -> datetime:
 
 
 @dataclass(frozen=True)
-class TestEnv:
+class _TestEnv:
     """Test environment for the service."""
 
     service: DispatchScheduler
@@ -71,7 +71,7 @@ class TestEnv:
 
 
 @fixture
-async def test_env() -> AsyncIterator[TestEnv]:
+async def test_env() -> AsyncIterator[_TestEnv]:
     """Return an actor test environment."""
     microgrid_id = randint(1, 100)
     client = FakeClient()
@@ -83,7 +83,7 @@ async def test_env() -> AsyncIterator[TestEnv]:
 
     service.start()
     try:
-        yield TestEnv(
+        yield _TestEnv(
             service=service,
             lifecycle_events=service.new_lifecycle_events_receiver("TEST_TYPE"),
             running_state_change=await service.new_running_state_event_receiver(
@@ -103,7 +103,7 @@ def generator() -> DispatchGenerator:
 
 
 async def test_new_dispatch_created(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
 ) -> None:
     """Test that a new dispatch is created."""
@@ -131,7 +131,7 @@ def update_dispatch(sample: BaseDispatch, dispatch: BaseDispatch) -> BaseDispatc
 
 
 async def _test_new_dispatch_created(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     sample: BaseDispatch,
 ) -> Dispatch:
     """Test that a new dispatch is created.
@@ -159,7 +159,7 @@ async def _test_new_dispatch_created(
 
 
 async def test_existing_dispatch_updated(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -197,7 +197,7 @@ async def test_existing_dispatch_updated(
 
 
 async def test_existing_dispatch_deleted(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -220,7 +220,7 @@ async def test_existing_dispatch_deleted(
 
 
 async def test_dispatch_inf_duration_deleted(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -255,7 +255,7 @@ async def test_dispatch_inf_duration_deleted(
 
 
 async def test_dispatch_inf_duration_updated_stopped_started(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -304,7 +304,7 @@ async def test_dispatch_inf_duration_updated_stopped_started(
 
 
 async def test_dispatch_inf_duration_updated_to_finite_and_stops(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -347,7 +347,7 @@ async def test_dispatch_inf_duration_updated_to_finite_and_stops(
 
 
 async def test_dispatch_schedule(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -385,7 +385,7 @@ async def test_dispatch_schedule(
 
 
 async def test_dispatch_inf_duration_updated_to_finite_and_continues(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -432,7 +432,7 @@ async def test_dispatch_inf_duration_updated_to_finite_and_continues(
 
 
 async def test_dispatch_new_but_finished(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:
@@ -490,7 +490,7 @@ async def test_dispatch_new_but_finished(
 
 
 async def test_notification_on_actor_start(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     generator: DispatchGenerator,
     fake_time: time_machine.Coordinates,
 ) -> None:

tests/test_mananging_actor.py

@@ -93,7 +93,7 @@ async def create_fail(
 
 
 @dataclass
-class TestEnv:
+class _TestEnv:
     """Test environment."""
 
     actors_service: ActorDispatcher
@@ -109,7 +109,7 @@ def actor(self, identity: int) -> MockActor:
 
 
 @fixture
-async def test_env() -> AsyncIterator[TestEnv]:
+async def test_env() -> AsyncIterator[_TestEnv]:
     """Create a test environment."""
     channel = Broadcast[Dispatch](name="dispatch ready test channel")
 
@@ -122,7 +122,7 @@ async def test_env() -> AsyncIterator[TestEnv]:
     actors_service.start()
     await asyncio.sleep(1)
 
-    yield TestEnv(
+    yield _TestEnv(
         actors_service=actors_service,
         running_status_sender=channel.new_sender(),
     )
@@ -131,7 +131,7 @@ async def test_env() -> AsyncIterator[TestEnv]:
 
 
 async def test_simple_start_stop(
-    test_env: TestEnv,
+    test_env: _TestEnv,
     fake_time: time_machine.Coordinates,
 ) -> None:
     """Test behavior when receiving start/stop messages."""
@@ -178,7 +178,7 @@ async def test_simple_start_stop(
 
 
 async def test_start_failed(
-    test_env: TestEnv, fake_time: time_machine.Coordinates
+    test_env: _TestEnv, fake_time: time_machine.Coordinates
 ) -> None:
     """Test auto-retry after 60 seconds."""
     # pylint: disable=protected-access
@@ -218,7 +218,7 @@ async def test_start_failed(
     assert test_env.actor(1).is_running is True
 
 
-def test_heapq_dispatch_compare(test_env: TestEnv) -> None:
+def test_heapq_dispatch_compare(test_env: _TestEnv) -> None:
     """Test that the heapq compare function works."""
     dispatch1 = test_env.generator.generate_dispatch()
     dispatch2 = test_env.generator.generate_dispatch()
@@ -241,7 +241,7 @@ def test_heapq_dispatch_compare(test_env: TestEnv) -> None:
     )
 
 
-def test_heapq_dispatch_start_stop_compare(test_env: TestEnv) -> None:
+def test_heapq_dispatch_start_stop_compare(test_env: _TestEnv) -> None:
     """Test that the heapq compare function works."""
     dispatch1 = test_env.generator.generate_dispatch()
     dispatch2 = test_env.generator.generate_dispatch()
@@ -267,7 +267,7 @@ def test_heapq_dispatch_start_stop_compare(test_env: TestEnv) -> None:
     assert scheduled_events[1].dispatch_id == dispatch2.id
 
 
-async def test_dry_run(test_env: TestEnv, fake_time: time_machine.Coordinates) -> None:
+async def test_dry_run(test_env: _TestEnv, fake_time: time_machine.Coordinates) -> None:
     """Test the dry run mode."""
     dispatch = test_env.generator.generate_dispatch()
     dispatch = replace(