Fix tests by removing app imports via fixture

Author: mattmess1221

tests/test_cli.py

@@ -3,21 +3,27 @@
 import subprocess
 import sys
 from pathlib import Path
-from typing import Any
+from typing import Any, Generator
 from unittest.mock import patch
 
 import pytest
 import uvicorn
 from fastapi_cli.cli import app
 from typer.testing import CliRunner
 
-from tests.utils import changing_dir
+from tests.utils import changing_dir, importing
 
 runner = CliRunner()
 
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def single_file_app_fixture() -> Generator[None, None, None]:
+    with importing(["single_file_app", "server", "app"]):
+        yield
+
+
 def test_dev() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:

tests/test_utils_default_dir.py

@@ -1,15 +1,22 @@
 from pathlib import Path
+from typing import Generator
 
 import pytest
 from fastapi_cli.discover import get_import_string
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
-from .utils import changing_dir
+from .utils import changing_dir, importing
 
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def single_file_app_fixture() -> Generator[None, None, None]:
+    with importing(["app", "app.main", "app.app", "app.api"]):
+        yield
+
+
 def test_app_dir_main(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path / "default_files" / "default_app_dir_main"):
         import_string = get_import_string()

tests/test_utils_default_file.py

@@ -1,17 +1,24 @@
 import importlib
 import sys
 from pathlib import Path
+from typing import Generator
 
 import pytest
 from fastapi_cli.discover import get_import_string
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
-from .utils import changing_dir
+from .utils import changing_dir, importing
 
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def single_file_app_fixture() -> Generator[None, None, None]:
+    with importing(["app", "api", "main"]):
+        yield
+
+
 def test_single_file_main(capsys: CaptureFixture[str]) -> None:
     root_path = assets_path / "default_files" / "default_main"
     old_sys_path = sys.path.copy()

tests/test_utils_package.py

@@ -1,15 +1,30 @@
 from pathlib import Path
+from typing import Generator
 
 import pytest
 from fastapi_cli.discover import get_import_string
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
-from tests.utils import changing_dir
+from tests.utils import changing_dir, importing
 
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def single_file_app_fixture() -> Generator[None, None, None]:
+    with importing(
+        [
+            "package",
+            "package.mod",
+            "package.mod.app",
+            "package.mod.api",
+            "package.mod.other",
+        ]
+    ):
+        yield
+
+
 def test_package_app_root(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
         import_string = get_import_string(path=Path("package/mod/app.py"))

tests/test_utils_single_file.py

@@ -1,15 +1,22 @@
 from pathlib import Path
+from typing import Generator
 
 import pytest
 from fastapi_cli.discover import get_import_string
 from fastapi_cli.exceptions import FastAPICLIException
 from pytest import CaptureFixture
 
-from .utils import changing_dir
+from .utils import changing_dir, importing
 
 assets_path = Path(__file__).parent / "assets"
 
 
+@pytest.fixture(autouse=True)
+def single_file_app_fixture() -> Generator[None, None, None]:
+    with importing(["single_file_app", "single_file_api", "single_file_other"]):
+        yield
+
+
 def test_single_file_app(capsys: CaptureFixture[str]) -> None:
     with changing_dir(assets_path):
         import_string = get_import_string(path=Path("single_file_app.py"))

tests/utils.py

@@ -1,4 +1,8 @@
+from __future__ import annotations
+
 import os
+import sys
+import warnings
 from contextlib import contextmanager
 from pathlib import Path
 from typing import Generator, Union
@@ -12,3 +16,22 @@ def changing_dir(directory: Union[str, Path]) -> Generator[None, None, None]:
         yield
     finally:
         os.chdir(initial_dir)
+
+
+@contextmanager
+def importing(names: Union[str, list[str]]) -> Generator[None, None, None]:
+    for name in names:
+        if name in sys.modules:
+            warnings.warn(
+                f"{name} is already imported",
+                category=UserWarning,
+                stacklevel=1,
+            )
+    try:
+        yield
+    finally:
+        if isinstance(names, str):
+            names = [names]
+        for name in names:
+            if name in sys.modules:
+                del sys.modules[name]