Refactor docs_urls-related tests

Author: YuriiMotov

tests/assets/single_file_docs.py

@@ -1,36 +1,51 @@
 from fastapi import FastAPI
 
-no_openapi = FastAPI(openapi_url=None)
+# App 1: API documentation disabled via `openapi_url=None`
+# ------------------------------------------------------------------------------------
 
+openapi_none = FastAPI(openapi_url=None)
 
-@no_openapi.get("/")
-def no_openapi_root():
-    return {"message": "single file no_openapi"}
 
+@openapi_none.get("/")
+def openapi_none_root():
+    return {"message": "single file openapi_none"}
 
-none_docs = FastAPI(docs_url=None, redoc_url=None)
 
+# App 2: Both docs and redoc disabled via `docs_url=None` and `redoc_url=None`
+# ------------------------------------------------------------------------------------
 
-@none_docs.get("/")
-def none_docs_root():
-    return {"message": "single file none_docs"}
+docs_none_redoc_none = FastAPI(docs_url=None, redoc_url=None)
 
 
-no_docs = FastAPI(docs_url=None)
+@docs_none_redoc_none.get("/")
+def docs_none_redoc_none_root():
+    return {"message": "single file docs_none_redoc_none"}
 
 
-@no_docs.get("/")
-def no_docs_root():
-    return {"message": "single file no_docs"}
+# App 3: Only ReDoc. Swagger docs disabled via `docs_url=None`
+# ------------------------------------------------------------------------------------
 
+only_redoc = FastAPI(docs_url=None)
 
-no_redoc = FastAPI(redoc_url=None)
 
+@only_redoc.get("/")
+def only_redoc_root():
+    return {"message": "single file only_redoc"}
 
-@no_redoc.get("/")
-def no_redoc_root():
-    return {"message": "single file no_redoc"}
 
+# App 4: Only Swagger docs. ReDoc disabled via `redoc_url=None`
+# ------------------------------------------------------------------------------------
+
+only_docs = FastAPI(redoc_url=None)
+
+
+@only_docs.get("/")
+def only_docs_root():
+    return {"message": "single file only_docs"}
+
+
+# App 5: Both docs and redoc enabled with default URLs
+# ------------------------------------------------------------------------------------
 
 full_docs = FastAPI()
 
@@ -40,6 +55,9 @@ def full_docs_root():
     return {"message": "single file full_docs"}
 
 
+# App 6: Swagger docs with custom URL. ReDoc with default URL.
+# ------------------------------------------------------------------------------------
+
 custom_docs = FastAPI(docs_url="/custom-docs-url")
 
 
@@ -48,6 +66,9 @@ def custom_docs_root():
     return {"message": "single file custom_docs"}
 
 
+# App 7: ReDoc with custom URL. Swagger docs with default URL.
+# ------------------------------------------------------------------------------------
+
 custom_redoc = FastAPI(docs_url=None, redoc_url="/custom-redoc-url")
 
 

tests/test_cli.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 from unittest.mock import patch
 
+import pytest
 import uvicorn
 from typer.testing import CliRunner
 
@@ -391,11 +392,18 @@ def test_run_env_vars_and_args() -> None:
         assert "Documentation at http://0.0.0.0:8080/docs" in result.output
 
 
-def test_no_openapi() -> None:
+@pytest.mark.parametrize(
+    "app_name",
+    [
+        "openapi_none",
+        "docs_none_redoc_none",
+    ],
+)
+def test_docs_urls_disabled(app_name: str) -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(
-                app, ["dev", "single_file_docs.py", "--app", "no_openapi"]
+                app, ["dev", "single_file_docs.py", "--app", app_name]
             )
             assert result.exit_code == 0, result.output
             assert mock_run.called
@@ -404,24 +412,24 @@ def test_no_openapi() -> None:
         assert "http://127.0.0.1:8000/redoc" not in result.output
 
 
-def test_none_docs() -> None:
+def test_docs_urls_only_docs() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(
-                app, ["dev", "single_file_docs.py", "--app", "none_docs"]
+                app, ["dev", "single_file_docs.py", "--app", "only_docs"]
             )
             assert result.exit_code == 0, result.output
             assert mock_run.called
 
-        assert "http://127.0.0.1:8000/docs" not in result.output
+        assert "http://127.0.0.1:8000/docs" in result.output
         assert "http://127.0.0.1:8000/redoc" not in result.output
 
 
-def test_no_docs() -> None:
+def test_docs_urls_only_redoc() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(
-                app, ["dev", "single_file_docs.py", "--app", "no_docs"]
+                app, ["dev", "single_file_docs.py", "--app", "only_redoc"]
             )
             assert result.exit_code == 0, result.output
             assert mock_run.called
@@ -430,20 +438,7 @@ def test_no_docs() -> None:
         assert "http://127.0.0.1:8000/docs" not in result.output
 
 
-def test_no_redoc() -> None:
-    with changing_dir(assets_path):
-        with patch.object(uvicorn, "run") as mock_run:
-            result = runner.invoke(
-                app, ["dev", "single_file_docs.py", "--app", "no_redoc"]
-            )
-            assert result.exit_code == 0, result.output
-            assert mock_run.called
-
-        assert "http://127.0.0.1:8000/docs" in result.output
-        assert "http://127.0.0.1:8000/redocs" not in result.output
-
-
-def test_full_docs() -> None:
+def test_docs_urls_full_docs() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(
@@ -456,7 +451,7 @@ def test_full_docs() -> None:
         assert "http://127.0.0.1:8000/redoc" not in result.output  # docs has precedence
 
 
-def test_custom_docs() -> None:
+def test_docs_urls_custom_docs() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(
@@ -468,7 +463,7 @@ def test_custom_docs() -> None:
         assert "http://127.0.0.1:8000/custom-docs-url" in result.output
 
 
-def test_custom_redoc() -> None:
+def test_docs_urls_custom_redoc() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
             result = runner.invoke(