[TEST] add startproject cli operation testcase

Author: bnbong

src/fastapi_fastkit/utils/logging.py

@@ -13,7 +13,9 @@
 from fastapi_fastkit.core.settings import FastkitConfig
 
 
-def setup_logging(settings: FastkitConfig, terminal_width: Union[int, None] = None) -> None:
+def setup_logging(
+    settings: FastkitConfig, terminal_width: Union[int, None] = None
+) -> None:
     logger = logging.getLogger("fastapi-fastkit")
     console = Console(width=terminal_width) if terminal_width else None
     formatter = logging.Formatter("%(message)s")

tests/conftest.py

@@ -4,16 +4,28 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
+import shutil
 import pytest
 
 from fastapi_fastkit.core.settings import FastkitConfig
 
 
 @pytest.fixture(autouse=True, scope="session")
-def console() -> None:
-    pass
+def temp_dir():
+    """
+    Fixture that creates a temporary directory for test cases and yields its path.
+    After tests are done, the directory is removed.
+    """
+    current_workspace = os.getcwd()
+    temp_dir = os.path.join(current_workspace, "temp_test_workspace")
+    os.makedirs(temp_dir, exist_ok=True)
+    yield temp_dir
+    shutil.rmtree(temp_dir)
 
 
 @pytest.fixture(autouse=True, scope="session")
 def set_terminal_width() -> None:
+    """
+    Fixture to set the terminal width for tests.
+    """
     os.environ["COLUMNS"] = str(FastkitConfig.TEST_DEFAULT_TERMINAL_WIDTH)

tests/test_backends/test_configure.py

@@ -4,38 +4,35 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
-import shutil
 
 from pathlib import Path
 
 from click.testing import CliRunner
 
+from fastapi_fastkit.cli import fastkit_cli
+
 
 class TestBackend:
     def setup_method(self) -> None:
         self.runner = CliRunner()
         self.current_workspace = os.getcwd()
-        self.temp_dir = os.path.join(self.current_workspace, "temp_test_workspace")
-        os.makedirs(self.temp_dir, exist_ok=True)
 
     def teardown_method(self) -> None:
         os.chdir(self.current_workspace)
-        shutil.rmtree(self.temp_dir)
 
-    def test_project_root_and_user_workspace(self) -> None:
+    def test_project_root_and_user_workspace(self, temp_dir) -> None:
         """
         Test that USER_WORKSPACE can change dynamically and is independent
         of FASTKIT_PROJECT_ROOT, which should always point to the source directory.
         """
         # given
-        os.chdir(self.temp_dir)
-        from fastapi_fastkit.cli import fastkit_cli
+        os.chdir(temp_dir)
 
         # when
         result = self.runner.invoke(fastkit_cli, ["--debug", "echo"])  # type: ignore
 
         # then
-        expected_current_user_workspace = self.temp_dir
+        expected_current_user_workspace = temp_dir
         expected_project_root = str(Path(__file__).parent.parent.parent)
 
         assert "running at debugging mode!!" in result.output

tests/test_cli_operations/test_base_cli.py

@@ -0,0 +1,80 @@
+# --------------------------------------------------------------------------
+# Testcases of base CLI operations.
+#
+# @author bnbong bbbong9@gmail.com
+# --------------------------------------------------------------------------
+import os
+
+from click.testing import CliRunner
+from pathlib import Path
+
+from fastapi_fastkit.cli import fastkit_cli
+
+
+class TestCLI:
+    def setup_method(self) -> None:
+        self.runner = CliRunner()
+        self.current_workspace = os.getcwd()
+
+    def teardown_method(self, console) -> None:
+        os.chdir(self.current_workspace)
+
+    def test_echo(self) -> None:
+        # given
+
+        # when
+        result = self.runner.invoke(fastkit_cli, ["echo"])  # type: ignore
+
+        # then
+        assert (
+            "╭─────────────────────────── About FastAPI-fastkit ────────────────────────────╮"
+            in result.output
+        )
+        assert (
+            "│     ⚡️ FastAPI fastkit - fastest FastAPI initializer. ⚡️"
+            in result.output
+        )
+        assert (
+            "│     Deploy FastAPI app foundation instantly at your local!"
+            in result.output
+        )
+        assert "│     - Project Maintainer : bnbong(JunHyeok Lee)" in result.output
+        assert (
+            "│     - Github : https://github.com/bnbong/FastAPI-fastkit"
+            in result.output
+        )
+
+    def test_startproject(self, temp_dir) -> None:
+        # given
+        os.chdir(temp_dir)
+
+        # when
+        result = self.runner.invoke(
+            fastkit_cli,  # type: ignore
+            ["startproject", "fastapi-default"],
+            input='\n'.join(["test-project", "bnbong", "bbbong9@gmail.com", "test project"]),
+        )
+
+        # then
+        project_path = Path(temp_dir) / "fastapi-default"  # TODO : change this after adding folder naming feature.
+        assert project_path.exists() and project_path.is_dir()
+        assert f"FastAPI project 'test-project' from 'fastapi-default' has been created and saved to {temp_dir}!" in result.output
+
+        expected_files = ["main.py", "setup.py"]
+        for file in expected_files:
+            file_path = project_path / file
+            assert file_path.exists() and file_path.is_file()
+
+        main_py_path = project_path / "main.py"
+        setup_py_path = project_path / "setup.py"
+
+        with open(main_py_path, "r") as main_py:
+            main_py_content = main_py.read()
+            assert "test-project" in main_py_content
+            assert "test project" in main_py_content
+
+        with open(setup_py_path, "r") as setup_py:
+            setup_py_content = setup_py.read()
+            assert "test-project" in setup_py_content
+            assert "bnbong" in setup_py_content
+            assert "bbbong9@gmail.com" in setup_py_content