✨ Allow to specify application directory

Shortcake-Parent: improve-how-we-handle-invalid-tokens

Author: patrick91

pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
     "uvicorn[standard] >= 0.15.0",
     "rignore >= 0.5.1",
     "httpx >= 0.27.0",
-    "rich-toolkit >= 0.14.5",
+    "rich-toolkit >= 0.19.3",
     "pydantic[email] >= 2.0",
     "sentry-sdk >= 2.20.0",
     "fastar >= 0.8.0",

src/fastapi_cloud_cli/commands/deploy.py

@@ -1,19 +1,20 @@
 import contextlib
 import logging
+import re
 import subprocess
 import tempfile
 import time
 from enum import Enum
 from itertools import cycle
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from textwrap import dedent
 from typing import Annotated, Any, Optional, Union
 
 import fastar
 import rignore
 import typer
 from httpx import Client
-from pydantic import BaseModel, EmailStr, TypeAdapter, ValidationError
+from pydantic import AfterValidator, BaseModel, EmailStr, TypeAdapter, ValidationError
 from rich.text import Text
 from rich_toolkit import RichToolkit
 from rich_toolkit.menu import Option
@@ -27,6 +28,39 @@
 logger = logging.getLogger(__name__)
 
 
+def validate_app_directory(v: Optional[str]) -> Optional[str]:
+    if v is None:
+        return None
+
+    v = v.strip()
+
+    if not v:
+        return None
+
+    if v.startswith("~"):
+        raise ValueError("cannot start with '~'")
+
+    path = PurePosixPath(v)
+
+    if path.is_absolute():
+        raise ValueError("must be a relative path, not absolute")
+
+    if ".." in path.parts:
+        raise ValueError("cannot contain '..' path segments")
+
+    normalized = path.as_posix()
+
+    if not re.fullmatch(r"[A-Za-z0-9._/ -]+", normalized):
+        raise ValueError(
+            "contains invalid characters (allowed: letters, numbers, space, / . _ -)"
+        )
+
+    return normalized
+
+
+AppDirectory = Annotated[Optional[str], AfterValidator(validate_app_directory)]
+
+
 def _cancel_upload(deployment_id: str) -> None:
     logger.debug("Cancelling upload for deployment: %s", deployment_id)
 
@@ -115,11 +149,11 @@ class AppResponse(BaseModel):
     slug: str
 
 
-def _create_app(team_id: str, app_name: str) -> AppResponse:
+def _create_app(team_id: str, app_name: str, directory: Optional[str]) -> AppResponse:
     with APIClient() as client:
         response = client.post(
             "/apps/",
-            json={"name": app_name, "team_id": team_id},
+            json={"name": app_name, "team_id": team_id, "directory": directory},
         )
 
         response.raise_for_status()
@@ -332,10 +366,23 @@ def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
 
     toolkit.print_line()
 
+    directory_input = toolkit.input(
+        title="Path to the directory containing your app (e.g. src, backend):",
+        tag="dir",
+        placeholder="[italic]Leave empty if it's the current directory[/italic]",
+        validator=TypeAdapter(AppDirectory),
+    )
+
+    directory: Optional[str] = directory_input if directory_input else None
+
+    toolkit.print_line()
+
     toolkit.print("Deployment configuration:", tag="summary")
     toolkit.print_line()
     toolkit.print(f"Team: [bold]{team.name}[/bold]")
     toolkit.print(f"App name: [bold]{app_name}[/bold]")
+    toolkit.print(f"Directory: [bold]{directory or '.'}[/bold]")
+
     toolkit.print_line()
 
     choice = toolkit.ask(
@@ -357,7 +404,7 @@ def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
     else:
         with toolkit.progress(title="Creating app...") as progress:
             with handle_http_errors(progress):
-                app = _create_app(team.id, app_name)
+                app = _create_app(team.id, app_name, directory=directory)
 
             progress.log(f"App created successfully! App slug: {app.slug}")
 

src/fastapi_cloud_cli/utils/cli.py

@@ -56,12 +56,13 @@ def get_rich_toolkit(minimal: bool = False) -> RichToolkit:
         theme={
             "tag.title": "white on #009485",
             "tag": "white on #007166",
-            "placeholder": "grey85",
+            "placeholder": "grey62",
             "text": "white",
             "selected": "#007166",
             "result": "grey85",
             "progress": "on #007166",
             "error": "red",
+            "cancelled": "indian_red italic",
         },
     )
 

tests/test_cli_deploy.py

@@ -332,7 +332,7 @@ def test_asks_for_app_name_after_team(
 def test_creates_app_on_backend(
     logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
 ) -> None:
-    steps = [Keys.ENTER, Keys.ENTER, *"demo", Keys.ENTER, Keys.ENTER]
+    steps = [Keys.ENTER, Keys.ENTER, *"demo", Keys.ENTER, Keys.ENTER, Keys.ENTER]
 
     team = _get_random_team()
 
@@ -343,10 +343,50 @@ def test_creates_app_on_backend(
         )
     )
 
-    respx_mock.post("/apps/", json={"name": "demo", "team_id": team["id"]}).mock(
-        return_value=Response(201, json=_get_random_app(team_id=team["id"]))
+    respx_mock.post(
+        "/apps/", json={"name": "demo", "team_id": team["id"], "directory": None}
+    ).mock(return_value=Response(201, json=_get_random_app(team_id=team["id"])))
+
+    with (
+        changing_dir(tmp_path),
+        patch("rich_toolkit.container.getchar") as mock_getchar,
+    ):
+        mock_getchar.side_effect = steps
+
+        result = runner.invoke(app, ["deploy"])
+
+        assert result.exit_code == 1
+
+        assert "App created successfully" in result.output
+
+
+@pytest.mark.respx
+def test_creates_app_with_directory(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    steps = [
+        Keys.ENTER,
+        Keys.ENTER,
+        *"demo",
+        Keys.ENTER,
+        *"src",
+        Keys.ENTER,
+        Keys.ENTER,
+    ]
+
+    team = _get_random_team()
+
+    respx_mock.get("/teams/").mock(
+        return_value=Response(
+            200,
+            json={"data": [team]},
+        )
     )
 
+    respx_mock.post(
+        "/apps/", json={"name": "demo", "team_id": team["id"], "directory": "src"}
+    ).mock(return_value=Response(201, json=_get_random_app(team_id=team["id"])))
+
     with (
         changing_dir(tmp_path),
         patch("rich_toolkit.container.getchar") as mock_getchar,
@@ -358,6 +398,52 @@ def test_creates_app_on_backend(
         assert result.exit_code == 1
 
         assert "App created successfully" in result.output
+        assert "Directory: src" in result.output
+
+
+@pytest.mark.respx
+@pytest.mark.parametrize(
+    "directory,expected_error",
+    [
+        ("~/src", "cannot start with '~'"),
+        ("/absolute/path", "must be a relative path, not absolute"),
+        ("src/../etc", "cannot contain '..' path segments"),
+        ("src/@app", "contains invalid characters"),
+    ],
+)
+def test_shows_validation_error_for_invalid_directory(
+    logged_in_cli: None,
+    tmp_path: Path,
+    respx_mock: respx.MockRouter,
+    directory: str,
+    expected_error: str,
+) -> None:
+    steps = [
+        Keys.ENTER,  # Select team
+        Keys.ENTER,  # Confirm new app
+        *"demo",
+        Keys.ENTER,  # App name
+        *directory,
+        Keys.ENTER,  # Submit invalid directory -> validation error shown
+        Keys.CTRL_C,  # Cancel
+    ]
+
+    respx_mock.get("/teams/").mock(
+        return_value=Response(
+            200,
+            json={"data": [_get_random_team()]},
+        )
+    )
+
+    with (
+        changing_dir(tmp_path),
+        patch("rich_toolkit.container.getchar") as mock_getchar,
+    ):
+        mock_getchar.side_effect = steps
+
+        result = runner.invoke(app, ["deploy"])
+
+        assert expected_error in result.output
 
 
 @pytest.mark.respx
@@ -369,6 +455,7 @@ def test_cancels_deployment_when_user_selects_no(
         Keys.ENTER,
         *"demo",
         Keys.ENTER,
+        Keys.ENTER,
         Keys.DOWN_ARROW,
         Keys.ENTER,
     ]
@@ -434,6 +521,7 @@ def test_exits_successfully_when_deployment_is_done(
         *"demo",
         Keys.ENTER,
         Keys.ENTER,
+        Keys.ENTER,
     ]
 
     team_data = _get_random_team()
@@ -443,9 +531,9 @@ def test_exits_successfully_when_deployment_is_done(
         return_value=Response(200, json={"data": [team_data]})
     )
 
-    respx_mock.post("/apps/", json={"name": "demo", "team_id": team_data["id"]}).mock(
-        return_value=Response(201, json=app_data)
-    )
+    respx_mock.post(
+        "/apps/", json={"name": "demo", "team_id": team_data["id"], "directory": None}
+    ).mock(return_value=Response(201, json=app_data))
 
     respx_mock.get(f"/apps/{app_data['id']}").mock(
         return_value=Response(200, json=app_data)
@@ -685,6 +773,7 @@ def _deploy_without_waiting(respx_mock: respx.MockRouter, tmp_path: Path) -> Res
         *"demo",
         Keys.ENTER,
         Keys.ENTER,
+        Keys.ENTER,
     ]
 
     team_data = _get_random_team()
@@ -698,9 +787,9 @@ def _deploy_without_waiting(respx_mock: respx.MockRouter, tmp_path: Path) -> Res
         )
     )
 
-    respx_mock.post("/apps/", json={"name": "demo", "team_id": team_data["id"]}).mock(
-        return_value=Response(201, json=app_data)
-    )
+    respx_mock.post(
+        "/apps/", json={"name": "demo", "team_id": team_data["id"], "directory": None}
+    ).mock(return_value=Response(201, json=app_data))
 
     respx_mock.get(f"/apps/{app_data['id']}").mock(
         return_value=Response(200, json=app_data)

tests/test_deploy_utils.py

@@ -1,8 +1,13 @@
 from pathlib import Path
+from typing import Optional
 
 import pytest
 
-from fastapi_cloud_cli.commands.deploy import DeploymentStatus, _should_exclude_entry
+from fastapi_cloud_cli.commands.deploy import (
+    DeploymentStatus,
+    _should_exclude_entry,
+    validate_app_directory,
+)
 
 
 @pytest.mark.parametrize(
@@ -75,3 +80,60 @@ def test_deployment_status_to_human_readable(
 ) -> None:
     """Should convert deployment status to human readable format."""
     assert DeploymentStatus.to_human_readable(status) == expected
+
+
+@pytest.mark.parametrize(
+    "value,expected",
+    [
+        (None, None),
+        ("", None),
+        ("   ", None),
+        ("src", "src"),
+        ("src/app", "src/app"),
+        ("  src/app  ", "src/app"),
+        ("my-app", "my-app"),
+        ("my_app", "my_app"),
+        ("my.app", "my.app"),
+        ("src/my app", "src/my app"),
+        ("a/b/c", "a/b/c"),
+    ],
+)
+def test_validate_app_directory_valid(
+    value: Optional[str], expected: Optional[str]
+) -> None:
+    """Should accept valid directory values and normalize them."""
+    assert validate_app_directory(value) == expected
+
+
+@pytest.mark.parametrize(
+    "value,expected_message",
+    [
+        ("~/src", "cannot start with '~'"),
+        ("/absolute/path", "must be a relative path, not absolute"),
+        ("src/../etc", "cannot contain '..' path segments"),
+        ("..", "cannot contain '..' path segments"),
+        ("src/../../etc", "cannot contain '..' path segments"),
+        (
+            "src/@app",
+            "contains invalid characters (allowed: letters, numbers, space, / . _ -)",
+        ),
+        (
+            "src/$app",
+            "contains invalid characters (allowed: letters, numbers, space, / . _ -)",
+        ),
+        (
+            "src/app!",
+            "contains invalid characters (allowed: letters, numbers, space, / . _ -)",
+        ),
+        (
+            "src/app#1",
+            "contains invalid characters (allowed: letters, numbers, space, / . _ -)",
+        ),
+    ],
+)
+def test_validate_app_directory_invalid(value: str, expected_message: str) -> None:
+    """Should reject invalid directory values with descriptive errors."""
+    with pytest.raises(ValueError) as exc_info:
+        validate_app_directory(value)
+
+    assert str(exc_info.value) == expected_message