Merge pull request fastapi#41 from fastapilabs/09-18-_add_.fastapi_to_.gitignore_and_explain_what_the_folder_is

✨ Add .fastapi to .gitignore and explain what the folder is

Author: patrick91

src/fastapi_cli/utils/apps.py

@@ -18,11 +18,40 @@ def get_app_config(path_to_deploy: Path) -> Optional[AppConfig]:
     return AppConfig.model_validate_json(config_path.read_text(encoding="utf-8"))
 
 
+README = """
+> Why do I have a folder named ".fastapi" in my project? 🤔
+The ".fastapi" folder is created when you link a directory to a FastAPI Cloud project.
+
+> What does the "cloud.json" file contain?
+The "cloud.json" file contains:
+- The ID of the FastAPI app that you linked ("app_id")
+- The ID of the team your FastAPI Cloud project is owned by ("team_id")
+
+> Should I commit the ".fastapi" folder?
+No, you should not commit the ".fastapi" folder to your version control system.
+On creation, it will be automatically added to your ".gitignore" file.
+"""
+
+
 def write_app_config(path_to_deploy: Path, app_config: AppConfig) -> None:
     config_path = path_to_deploy / ".fastapi/cloud.json"
+    readme_path = path_to_deploy / ".fastapi/README.md"
     config_path.parent.mkdir(parents=True, exist_ok=True)
 
     config_path.write_text(
         app_config.model_dump_json(),
         encoding="utf-8",
     )
+    readme_path.write_text(README, encoding="utf-8")
+
+    git_ignore_path = path_to_deploy / ".gitignore"
+
+    if not git_ignore_path.exists():
+        git_ignore_path.write_text(".fastapi\n", encoding="utf-8")
+    else:
+        git_ignore_content = git_ignore_path.read_text(encoding="utf-8")
+
+        if ".fastapi" not in git_ignore_content:
+            git_ignore_path.write_text(
+                f"{git_ignore_content}.fastapi\n", encoding="utf-8"
+            )

tests/test_cli_deploy.py

@@ -6,6 +6,7 @@
 
 import pytest
 import respx
+from click.testing import Result
 from fastapi_cli.cli import app
 from fastapi_cli.config import settings
 from httpx import Response
@@ -449,10 +450,7 @@ def test_returns_error_when_team_not_found(
         assert result.exit_code == 1
 
 
-@pytest.mark.respx(base_url=settings.base_api_url)
-def test_can_skip_waiting(
-    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
-) -> None:
+def _deploy_without_waiting(respx_mock: respx.MockRouter, tmp_path: Path) -> Result:
     steps = [ENTER, ENTER, ENTER, *"demo", ENTER]
 
     team_data = _get_random_team()
@@ -499,8 +497,55 @@ def test_can_skip_waiting(
     with changing_dir(tmp_path), patch("click.getchar") as mock_getchar:
         mock_getchar.side_effect = steps
 
-        result = runner.invoke(app, ["deploy", "--no-wait"])
+        return runner.invoke(app, ["deploy", "--no-wait"])
 
-        assert result.exit_code == 0
 
-        assert "Check the status of your deployment at" in result.output
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_can_skip_waiting(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    result = _deploy_without_waiting(respx_mock, tmp_path)
+
+    assert result.exit_code == 0
+
+    assert "Check the status of your deployment at" in result.output
+
+
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_creates_config_folder_and_adds_it_to_gitignore(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    git_ignore_path = tmp_path / ".gitignore"
+    git_ignore_path.write_text(".venv\n")
+
+    _deploy_without_waiting(respx_mock, tmp_path)
+
+    assert (tmp_path / ".fastapi" / "cloud.json").exists()
+    assert (tmp_path / ".fastapi" / "README.md").exists()
+
+    assert git_ignore_path.read_text() == ".venv\n.fastapi\n"
+
+
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_creates_config_folder_and_creates_git_ignore(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    _deploy_without_waiting(respx_mock, tmp_path)
+
+    assert (tmp_path / ".fastapi" / "cloud.json").exists()
+    assert (tmp_path / ".fastapi" / "README.md").exists()
+    assert (tmp_path / ".gitignore").exists()
+
+    assert (tmp_path / ".gitignore").read_text() == ".fastapi\n"
+
+
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_does_not_duplicate_entry_in_git_ignore(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    git_ignore_path = tmp_path / ".gitignore"
+    git_ignore_path.write_text(".fastapi\n")
+
+    _deploy_without_waiting(respx_mock, tmp_path)
+
+    assert git_ignore_path.read_text() == ".fastapi\n"