Merge pull request #17 from vintasoftware/ft/actions

Ft/actions

Author: andersonresende

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-fastapi:
+    name: FastAPI CI
+
+    runs-on: ubuntu-latest
+
+    env:
+      DATABASE_URL: ${{ secrets.DATABASE_URL }}
+      ACCESS_SECRET_KEY: ${{ secrets.ACCESS_SECRET_KEY }}
+      RESET_PASSWORD_SECRET_KEY: ${{ secrets.RESET_PASSWORD_SECRET_KEY }}
+      VERIFICATION_SECRET_KEY: ${{ secrets.VERIFICATION_SECRET_KEY }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Poetry with pip
+        run: pip install poetry
+
+      - name: Configure Poetry
+        working-directory: ./fastapi_backend
+        run: poetry config virtualenvs.create false
+
+      - name: Install dependencies
+        working-directory: ./fastapi_backend
+        run: poetry install
+
+      - name: Run tests
+        working-directory: ./fastapi_backend
+        run: poetry run pytest

.pre-commit-config.docker.yaml

@@ -31,7 +31,7 @@ repos:
     hooks:
       - id: generate-openapi-schema
         name: generate OpenAPI schema
-        entry: sh -c 'docker compose run --rm --no-deps -T backend poetry run python -m commands.generate_openapi_schema'
+        entry: sh -c 'docker compose run --rm --no-deps -T backend poetry run python -m app.commands.generate_openapi_schema'
         language: system
         pass_filenames: false
       - id: generate-frontend-client

.pre-commit-config.yaml

@@ -31,7 +31,7 @@ repos:
     hooks:
       - id: generate-openapi-schema
         name: generate OpenAPI schema
-        entry: sh -c 'cd fastapi_backend && poetry run python -m commands.generate_openapi_schema'
+        entry: sh -c 'cd fastapi_backend && poetry run python -m app.commands.generate_openapi_schema'
         language: system
         pass_filenames: false
       - id: generate-frontend-client

fastapi_backend/__init__.py renamed to fastapi_backend/app/__init__.py

@@ -6,7 +6,7 @@
 from sqlalchemy.ext.asyncio import async_engine_from_config
 
 from alembic import context
-from src.models import Base
+from app.src.models import Base
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.

fastapi_backend/alembic.ini renamed to fastapi_backend/app/alembic.ini

@@ -1,6 +1,6 @@
 import json
 from pathlib import Path
-from src.main import app
+from app.src.main import app
 import os
 
 from dotenv import load_dotenv
@@ -14,13 +14,13 @@ def generate_openapi_schema(output_file):
     schema = app.openapi()
     output_path = Path(output_file)
 
-    updated_schema = _remove_operation_id_tag(schema)
+    updated_schema = remove_operation_id_tag(schema)
 
     output_path.write_text(json.dumps(updated_schema, indent=2))
     print(f"OpenAPI schema saved to {output_file}")
 
 
-def _remove_operation_id_tag(schema):
+def remove_operation_id_tag(schema):
     """
     Removes the tag prefix from the operation IDs in the OpenAPI schema.
 

fastapi_backend/alembic/README renamed to fastapi_backend/app/alembic/README

@@ -3,9 +3,9 @@
 import pytest
 from pathlib import Path
 
-from commands.generate_openapi_schema import (
-    _remove_operation_id_tag,
+from app.commands.generate_openapi_schema import (
     generate_openapi_schema,
+    remove_operation_id_tag,
 )
 
 
@@ -27,13 +27,13 @@ def expected_output_schema():
 
 
 def test_remove_operation_id_tag(sample_openapi_schema, expected_output_schema):
-    cleaned_schema = _remove_operation_id_tag(sample_openapi_schema)
+    cleaned_schema = remove_operation_id_tag(sample_openapi_schema)
     assert cleaned_schema == expected_output_schema
 
 
 @pytest.fixture
 def mock_app(mocker):
-    app = mocker.patch("commands.generate_openapi_schema.app")
+    app = mocker.patch("app.commands.generate_openapi_schema.app")
     app.openapi.return_value = {
         "openapi": "3.1.0",
         "info": {"title": "FastAPI", "version": "0.1.0"},
@@ -44,7 +44,7 @@ def mock_app(mocker):
 
 def test_generate_openapi_schema(mocker, mock_app):
     mock_remove_operation_id_tag = mocker.patch(
-        "commands.generate_openapi_schema._remove_operation_id_tag"
+        "app.commands.generate_openapi_schema.remove_operation_id_tag"
     )
     mock_remove_operation_id_tag.return_value = {"mocked_schema": True}
 

fastapi_backend/alembic/env.py renamed to fastapi_backend/app/alembic/env.py

@@ -2,7 +2,7 @@
 from fastapi import status
 from fastapi.testclient import TestClient
 from fastapi_users.router import ErrorCode
-from src.main import app
+from app.src.main import app
 
 
 class TestPasswordValidation:

fastapi_backend/alembic/script.py.mako renamed to fastapi_backend/app/alembic/script.py.mako

@@ -1,5 +1,5 @@
 from fastapi.routing import APIRoute
-from src.utils import simple_generate_unique_route_id
+from app.src.utils import simple_generate_unique_route_id
 
 
 def test_simple_generate_unique_route_id(mocker):

fastapi_backend/alembic/versions/402d067a8b92_added_user_table.py renamed to fastapi_backend/app/alembic/versions/402d067a8b92_added_user_table.py

@@ -7,7 +7,7 @@
 from threading import Timer
 
 WATCHER_REGEX_PATTERN = re.compile(r"(main|schemas)\.py$")
-APP_PATH = "src"
+APP_PATH = "app/src"
 
 
 class MyHandler(FileSystemEventHandler):

fastapi_backend/commands/__init__.py renamed to fastapi_backend/app/commands/__init__.py

@@ -2,12 +2,12 @@
 
 if [ -f /.dockerenv ]; then
     echo "Running in Docker"
-    fastapi dev src/main.py --host 0.0.0.0 --port 8000 --reload &
-    python watcher.py
+    fastapi dev app/src/main.py --host 0.0.0.0 --port 8000 --reload &
+    python app/watcher.py
 else
     echo "Running locally with Poetry"
-    poetry run fastapi dev src/main.py --host 0.0.0.0 --port 8000 --reload &
-    poetry run python watcher.py
+    poetry run fastapi dev app/src/main.py --host 0.0.0.0 --port 8000 --reload &
+    poetry run python app/watcher.py
 fi
 
 wait