👷 Tweak CI testing and fix import error detection for Python 3.8 (#8)

Author: tiangolo

.github/workflows/test.yml

@@ -11,6 +11,15 @@ on:
   schedule:
     # cron every week on monday
     - cron: "0 0 * * 1"
+  workflow_dispatch:
+    inputs:
+      number:
+        description: PR number
+        required: true
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
 
 jobs:
   test:
@@ -41,6 +50,12 @@ jobs:
         with:
           path: ${{ env.pythonLocation }}
           key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }}
+      # Allow debugging with tmate
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+        with:
+          limit-access-to-actor: true
       - name: Install Dependencies
         if: steps.cache.outputs.cache-hit != 'true'
         run: pip install -r requirements-tests.txt

src/fastapi_cli/discover.py

@@ -101,7 +101,7 @@ def get_module_data_from_path(path: Path) -> ModuleData:
 def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) -> str:
     try:
         mod = importlib.import_module(mod_data.module_import_str)
-    except ImportError as e:
+    except (ImportError, ValueError) as e:
         logger.error(f"Import error: {e}")
         logger.warning(
             "Ensure all the package directories have an [blue]__init__.py[/blue] file"

tests/conftest.py

@@ -16,7 +16,8 @@ def reset_syspath() -> Generator[None, None, None]:
 
 
 @pytest.fixture(autouse=True, scope="session")
-def set_terminal_width() -> None:
+def setup_terminal() -> None:
     rich_utils.MAX_WIDTH = 3000
+    rich_utils.FORCE_TERMINAL = False
     setup_logging(terminal_width=3000)
     return

tests/test_utils_default_dir.py

@@ -19,11 +19,10 @@ def test_app_dir_main(capsys: CaptureFixture[str]) -> None:
     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
+        "/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 "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
@@ -43,12 +42,9 @@ def test_app_dir_app(capsys: CaptureFixture[str]) -> None:
     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 "/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 "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
@@ -68,12 +64,9 @@ def test_app_dir_api(capsys: CaptureFixture[str]) -> None:
     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 "/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 "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

tests/test_utils_default_file.py

@@ -17,20 +17,18 @@ def test_single_file_main(capsys: CaptureFixture[str]) -> None:
     old_sys_path = sys.path.copy()
     with changing_dir(root_path):
         sys.path.insert(0, str(root_path))
-        app = importlib.import_module("app")
+        mod = importlib.import_module("main")
 
-        importlib.reload(app)
+        importlib.reload(mod)
         import_string = get_import_string()
         assert import_string == "main:app"
 
     captured = capsys.readouterr()
     assert "Using path main.py" in captured.out
     assert "Resolved absolute path" in captured.out
-    assert (
-        "/fastapi-cli/tests/assets/default_files/default_main/main.py" in captured.out
-    )
+    assert "/tests/assets/default_files/default_main/main.py" in captured.out
     assert "Importing from" in captured.out
-    assert "fastapi-cli/tests/assets/default_files/default_main" in captured.out
+    assert "/tests/assets/default_files/default_main" in captured.out
     assert "╭─ Python module file ─╮" in captured.out
     assert "│  🐍 main.py" in captured.out
     assert "Importing module main" in captured.out
@@ -46,18 +44,18 @@ def test_single_file_app(capsys: CaptureFixture[str]) -> None:
     old_sys_path = sys.path.copy()
     with changing_dir(root_path):
         sys.path.insert(0, str(root_path))
-        app = importlib.import_module("app")
+        mod = importlib.import_module("app")
 
-        importlib.reload(app)
+        importlib.reload(mod)
         import_string = get_import_string()
         assert import_string == "app:app"
 
     captured = capsys.readouterr()
     assert "Using path app.py" in captured.out
     assert "Resolved absolute path" in captured.out
-    assert "/fastapi-cli/tests/assets/default_files/default_app/app.py" in captured.out
+    assert "/tests/assets/default_files/default_app/app.py" in captured.out
     assert "Importing from" in captured.out
-    assert "fastapi-cli/tests/assets/default_files/default_app" in captured.out
+    assert "/tests/assets/default_files/default_app" in captured.out
     assert "╭─ Python module file ─╮" in captured.out
     assert "│  🐍 app.py" in captured.out
     assert "Importing module app" in captured.out
@@ -73,18 +71,18 @@ def test_single_file_api(capsys: CaptureFixture[str]) -> None:
     old_sys_path = sys.path.copy()
     with changing_dir(root_path):
         sys.path.insert(0, str(root_path))
-        app = importlib.import_module("app")
+        mod = importlib.import_module("api")
 
-        importlib.reload(app)
+        importlib.reload(mod)
         import_string = get_import_string()
         assert import_string == "api:app"
 
     captured = capsys.readouterr()
     assert "Using path api.py" in captured.out
     assert "Resolved absolute path" in captured.out
-    assert "/fastapi-cli/tests/assets/default_files/default_api/api.py" in captured.out
+    assert "/tests/assets/default_files/default_api/api.py" in captured.out
     assert "Importing from" in captured.out
-    assert "fastapi-cli/tests/assets/default_files/default_api" in captured.out
+    assert "/tests/assets/default_files/default_api" in captured.out
     assert "╭─ Python module file ─╮" in captured.out
     assert "│  🐍 api.py" in captured.out
     assert "Importing module api" in captured.out