✅ Add tests

Author: tiangolo

tests/conftest.py

@@ -0,0 +1,22 @@
+import sys
+from typing import Generator
+
+import pytest
+from fastapi_cli.logging import setup_logging
+from typer import rich_utils
+
+
+@pytest.fixture(autouse=True)
+def reset_syspath() -> Generator[None, None, None]:
+    initial_python_path = sys.path.copy()
+    try:
+        yield
+    finally:
+        sys.path = initial_python_path
+
+
+@pytest.fixture(autouse=True, scope="session")
+def set_terminal_width() -> None:
+    rich_utils.MAX_WIDTH = 3000
+    setup_logging(terminal_width=3000)
+    return

tests/test_cli.py

@@ -0,0 +1,209 @@
+import subprocess
+import sys
+from pathlib import Path
+from unittest.mock import patch
+
+import uvicorn
+from fastapi_cli.cli import app
+from typer.testing import CliRunner
+
+from tests.utils import changing_dir
+
+runner = CliRunner()
+
+assets_path = Path(__file__).parent / "assets"
+
+
+def test_dev() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["dev", "single_file_app.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "single_file_app:app",
+                "host": "127.0.0.1",
+                "port": 8000,
+                "reload": True,
+                "root_path": "",
+            }
+        assert "Using import string single_file_app:app" in result.output
+        assert (
+            "╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://127.0.0.1:8000" in result.output
+        assert "│  API docs: http://127.0.0.1:8000/docs" in result.output
+        assert "│  Running in development mode, for production use:" in result.output
+        assert "│  fastapi run" in result.output
+
+
+def test_dev_args() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    "dev",
+                    "single_file_app.py",
+                    "--host",
+                    "192.168.0.2",
+                    "--port",
+                    "8080",
+                    "--no-reload",
+                    "--root-path",
+                    "/api",
+                    "--app",
+                    "api",
+                ],
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "single_file_app:api",
+                "host": "192.168.0.2",
+                "port": 8080,
+                "reload": False,
+                "root_path": "/api",
+            }
+        assert "Using import string single_file_app:api" in result.output
+        assert (
+            "╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://192.168.0.2:8080" in result.output
+        assert "│  API docs: http://192.168.0.2:8080/docs" in result.output
+        assert "│  Running in development mode, for production use:" in result.output
+        assert "│  fastapi run" in result.output
+
+
+def test_run() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["run", "single_file_app.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "single_file_app:app",
+                "host": "0.0.0.0",
+                "port": 8000,
+                "reload": False,
+                "root_path": "",
+            }
+        assert "Using import string single_file_app:app" in result.output
+        assert (
+            "╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://0.0.0.0:8000" in result.output
+        assert "│  API docs: http://0.0.0.0:8000/docs" in result.output
+        assert "│  Running in production mode, for development use:" in result.output
+        assert "│  fastapi dev" in result.output
+
+
+def test_run_args() -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    "run",
+                    "single_file_app.py",
+                    "--host",
+                    "192.168.0.2",
+                    "--port",
+                    "8080",
+                    "--no-reload",
+                    "--root-path",
+                    "/api",
+                    "--app",
+                    "api",
+                ],
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "single_file_app:api",
+                "host": "192.168.0.2",
+                "port": 8080,
+                "reload": False,
+                "root_path": "/api",
+            }
+        assert "Using import string single_file_app:api" in result.output
+        assert (
+            "╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://192.168.0.2:8080" in result.output
+        assert "│  API docs: http://192.168.0.2:8080/docs" in result.output
+        assert "│  Running in production mode, for development use:" in result.output
+        assert "│  fastapi dev" in result.output
+
+
+def test_run_error() -> None:
+    with changing_dir(assets_path):
+        result = runner.invoke(app, ["run", "non_existing_file.py"])
+        assert result.exit_code == 1, result.output
+        assert "Path does not exist non_existing_file.py" in result.output
+
+
+def test_dev_help() -> None:
+    result = runner.invoke(app, ["dev", "--help"])
+    assert result.exit_code == 0, result.output
+    assert "Run a FastAPI app in development mode." in result.output
+    assert (
+        "This is equivalent to fastapi run but with reload enabled and listening on the 127.0.0.1 address."
+        in result.output
+    )
+    assert (
+        "Otherwise, it uses the first FastAPI app found in the imported module or package."
+        in result.output
+    )
+    assert "A path to a Python file or package directory" in result.output
+    assert "The host to serve on." in result.output
+    assert "The port to serve on." in result.output
+    assert "Enable auto-reload of the server when (code) files change." in result.output
+    assert "The root path is used to tell your app" in result.output
+    assert "The name of the variable that contains the FastAPI app" in result.output
+
+
+def test_run_help() -> None:
+    result = runner.invoke(app, ["run", "--help"])
+    assert result.exit_code == 0, result.output
+    assert "Run a FastAPI app in production mode." in result.output
+    assert (
+        "This is equivalent to fastapi dev but with reload disabled and listening on the 0.0.0.0 address."
+        in result.output
+    )
+    assert (
+        "Otherwise, it uses the first FastAPI app found in the imported module or package."
+        in result.output
+    )
+    assert "A path to a Python file or package directory" in result.output
+    assert "The host to serve on." in result.output
+    assert "The port to serve on." in result.output
+    assert "Enable auto-reload of the server when (code) files change." in result.output
+    assert "The root path is used to tell your app" in result.output
+    assert "The name of the variable that contains the FastAPI app" in result.output
+
+
+def test_callback_help() -> None:
+    result = runner.invoke(app, ["--help"])
+    assert result.exit_code == 0, result.output
+    assert "FastAPI CLI - The fastapi command line app." in result.output
+    assert "Show the version and exit." in result.output
+
+
+def test_version() -> None:
+    result = runner.invoke(app, ["--version"])
+    assert result.exit_code == 0, result.output
+    assert "FastAPI CLI version:" in result.output
+
+
+def test_script() -> None:
+    result = subprocess.run(
+        [sys.executable, "-m", "coverage", "run", "-m", "fastapi_cli", "--help"],
+        capture_output=True,
+        encoding="utf-8",
+    )
+    assert "Usage" in result.stdout

tests/test_utils_default_dir.py

@@ -0,0 +1,95 @@
+from pathlib import Path
+
+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
+
+assets_path = Path(__file__).parent / "assets"
+
+
+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()
+        assert import_string == "app.main:app"
+
+    captured = capsys.readouterr()
+    assert "Using path app/main.py" in captured.out
+    assert "Resolved absolute path" in captured.out
+    assert (
+        "/fastapi-cli/tests/assets/default_files/default_app_dir_main/app/main.py"
+        in captured.out
+    )
+    assert "Importing from" in captured.out
+    assert "fastapi-cli/tests/assets/default_files/default_app_dir_main" in captured.out
+    assert "╭─ Python package file structure ─╮" in captured.out
+    assert "│  📁 app" in captured.out
+    assert "│  ├── 🐍 __init__.py" in captured.out
+    assert "│  └── 🐍 main.py" in captured.out
+    assert "Importing module app.main" in captured.out
+    assert "Found importable FastAPI app" in captured.out
+    assert "Importable FastAPI app" in captured.out
+    assert "from app.main import app" in captured.out
+    assert "Using import string app.main:app" in captured.out
+
+
+def test_app_dir_app(capsys: CaptureFixture[str]) -> None:
+    with changing_dir(assets_path / "default_files" / "default_app_dir_app"):
+        import_string = get_import_string()
+        assert import_string == "app.app:app"
+
+    captured = capsys.readouterr()
+    assert "Using path app/app.py" in captured.out
+    assert "Resolved absolute path" in captured.out
+    assert (
+        "/fastapi-cli/tests/assets/default_files/default_app_dir_app/app/app.py"
+        in captured.out
+    )
+    assert "Importing from" in captured.out
+    assert "fastapi-cli/tests/assets/default_files/default_app_dir_app" in captured.out
+    assert "╭─ Python package file structure ─╮" in captured.out
+    assert "│  📁 app" in captured.out
+    assert "│  ├── 🐍 __init__.py" in captured.out
+    assert "│  └── 🐍 app.py" in captured.out
+    assert "Importing module app.app" in captured.out
+    assert "Found importable FastAPI app" in captured.out
+    assert "Importable FastAPI app" in captured.out
+    assert "from app.app import app" in captured.out
+    assert "Using import string app.app:app" in captured.out
+
+
+def test_app_dir_api(capsys: CaptureFixture[str]) -> None:
+    with changing_dir(assets_path / "default_files" / "default_app_dir_api"):
+        import_string = get_import_string()
+        assert import_string == "app.api:app"
+
+    captured = capsys.readouterr()
+    assert "Using path app/api.py" in captured.out
+    assert "Resolved absolute path" in captured.out
+    assert (
+        "/fastapi-cli/tests/assets/default_files/default_app_dir_api/app/api.py"
+        in captured.out
+    )
+    assert "Importing from" in captured.out
+    assert "fastapi-cli/tests/assets/default_files/default_app_dir_api" in captured.out
+    assert "╭─ Python package file structure ─╮" in captured.out
+    assert "│  📁 app" in captured.out
+    assert "│  ├── 🐍 __init__.py" in captured.out
+    assert "│  └── 🐍 api.py" in captured.out
+    assert "Importing module app.api" in captured.out
+    assert "Found importable FastAPI app" in captured.out
+    assert "Importable FastAPI app" in captured.out
+    assert "from app.api import app" in captured.out
+    assert "Using import string app.api:app" in captured.out
+
+
+def test_app_dir_non_default() -> None:
+    with changing_dir(assets_path / "default_files" / "default_app_dir_non_default"):
+        with pytest.raises(FastAPICLIException) as e:
+            get_import_string()
+        assert (
+            "Could not find a default file to run, please provide an explicit path"
+            in e.value.args[0]
+        )