Move integration tests to its own file

Since the integration tests in the `FileWatcher` tests are actually
testing 3 different classes (and interacting with the OS), we move it
to its own file, and we call it more generally.

We also mark the tests with the pytest mark `integration` to make it
more clear they are integration tests, and to enable an easy way to
only run (exclude) integration tests.

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

Author: llucax

pyproject.toml

@@ -74,6 +74,9 @@ src_paths = ["src", "examples", "tests"]
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 required_plugins = ["pytest-asyncio", "pytest-mock"]
+markers = [
+  "integration: integration tests (deselect with '-m \"not integration\"')",
+]
 
 [[tool.mypy.overrides]]
 module = ["async_solipsism", "async_solipsism.*"]

tests/utils/test_file_watcher.py

@@ -5,18 +5,16 @@
 
 from __future__ import annotations
 
-import os
 import pathlib
 from collections.abc import AsyncGenerator, Iterator, Sequence
-from datetime import timedelta
 from typing import Any
 from unittest import mock
 
 import pytest
 from watchfiles import Change
 from watchfiles.main import FileChange
 
-from frequenz.channels.util import FileWatcher, Select, Timer
+from frequenz.channels.util import FileWatcher
 
 
 class _FakeAwatch:
@@ -72,67 +70,3 @@ async def test_file_watcher_receive_updates(
     for change in changes:
         recv_changes = await file_watcher.receive()
         assert recv_changes == pathlib.Path(change[1])
-
-
-async def test_file_watcher(tmp_path: pathlib.Path) -> None:
-    """Ensure file watcher is returning paths on file events.
-
-    Args:
-        tmp_path (pathlib.Path): A tmp directory to run the file watcher on.
-            Created by pytest.
-    """
-    filename = tmp_path / "test-file"
-    file_watcher = FileWatcher(paths=[str(tmp_path)])
-
-    number_of_writes = 0
-    expected_number_of_writes = 3
-
-    select = Select(
-        timer=Timer.timeout(timedelta(seconds=0.1)),
-        file_watcher=file_watcher,
-    )
-    while await select.ready():
-        if msg := select.timer:
-            filename.write_text(f"{msg.inner}")
-        elif msg := select.file_watcher:
-            assert msg.inner == filename
-            number_of_writes += 1
-            # After receiving a write 3 times, unsubscribe from the writes channel
-            if number_of_writes == expected_number_of_writes:
-                break
-
-    assert number_of_writes == expected_number_of_writes
-
-
-async def test_file_watcher_change_types(tmp_path: pathlib.Path) -> None:
-    """Ensure file watcher is returning paths only on the DELETE change.
-
-    Args:
-        tmp_path (pathlib.Path): A tmp directory to run the file watcher on.
-            Created by pytest.
-    """
-    filename = tmp_path / "test-file"
-    file_watcher = FileWatcher(
-        paths=[str(tmp_path)], event_types={FileWatcher.EventType.DELETE}
-    )
-
-    select = Select(
-        write_timer=Timer.timeout(timedelta(seconds=0.1)),
-        deletion_timer=Timer.timeout(timedelta(seconds=0.25)),
-        watcher=file_watcher,
-    )
-    number_of_deletes = 0
-    number_of_write = 0
-    while await select.ready():
-        if msg := select.write_timer:
-            filename.write_text(f"{msg.inner}")
-            number_of_write += 1
-        elif _ := select.deletion_timer:
-            os.remove(filename)
-        elif _ := select.watcher:
-            number_of_deletes += 1
-            break
-
-    assert number_of_deletes == 1
-    # Can be more because the watcher could take some time to trigger
-    assert number_of_write >= 2

tests/utils/test_integration.py

@@ -0,0 +1,80 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Integration tests for the `util` module."""
+
+from __future__ import annotations
+
+import os
+import pathlib
+from datetime import timedelta
+
+import pytest
+
+from frequenz.channels.util import FileWatcher, Select, Timer
+
+
+@pytest.mark.integration
+async def test_file_watcher(tmp_path: pathlib.Path) -> None:
+    """Ensure file watcher is returning paths on file events.
+
+    Args:
+        tmp_path (pathlib.Path): A tmp directory to run the file watcher on.
+            Created by pytest.
+    """
+    filename = tmp_path / "test-file"
+    file_watcher = FileWatcher(paths=[str(tmp_path)])
+
+    number_of_writes = 0
+    expected_number_of_writes = 3
+
+    select = Select(
+        timer=Timer.timeout(timedelta(seconds=0.1)),
+        file_watcher=file_watcher,
+    )
+    while await select.ready():
+        if msg := select.timer:
+            filename.write_text(f"{msg.inner}")
+        elif msg := select.file_watcher:
+            assert msg.inner == filename
+            number_of_writes += 1
+            # After receiving a write 3 times, unsubscribe from the writes channel
+            if number_of_writes == expected_number_of_writes:
+                break
+
+    assert number_of_writes == expected_number_of_writes
+
+
+@pytest.mark.integration
+async def test_file_watcher_change_types(tmp_path: pathlib.Path) -> None:
+    """Ensure file watcher is returning paths only on the DELETE change.
+
+    Args:
+        tmp_path (pathlib.Path): A tmp directory to run the file watcher on.
+            Created by pytest.
+    """
+    filename = tmp_path / "test-file"
+    file_watcher = FileWatcher(
+        paths=[str(tmp_path)], event_types={FileWatcher.EventType.DELETE}
+    )
+
+    select = Select(
+        write_timer=Timer.timeout(timedelta(seconds=0.1)),
+        deletion_timer=Timer.timeout(timedelta(seconds=0.25)),
+        watcher=file_watcher,
+    )
+    number_of_deletes = 0
+    number_of_write = 0
+    while await select.ready():
+        if msg := select.write_timer:
+            filename.write_text(f"{msg.inner}")
+            number_of_write += 1
+        elif _ := select.deletion_timer:
+            os.remove(filename)
+        elif _ := select.watcher:
+            number_of_deletes += 1
+            break
+
+    assert number_of_deletes == 1
+    # Can be more because the watcher could take some time to trigger
+    assert number_of_write >= 2