feat: add todo

.github/workflows/lint.yml

@@ -27,10 +27,29 @@ jobs:
       with:
         commit_message: Adjusted files for isort & autopep
 
-  tag:
+  test:
     runs-on: ubuntu-latest
     needs: lint
-    steps:        
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -r requirements.txt
+      - run: python test.py
+
+  tag:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: setup git
+        run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Action"
+
       - name: Git Version
         uses: codacy/git-version@2.8.0
         id: git_version
@@ -40,7 +59,7 @@ jobs:
           major-identifier: "breaking:"
 
       - name: Create Tag
-        run: git tag -a v${{ steps.git_version.outputs.version }} -m "v${{ steps.git_version.outputs.version }}"
+        run: git tag -a ${{ steps.git_version.outputs.version }} -m "${{ steps.git_version.outputs.version }}"
 
       - name: Push Tag
-        run: git push origin v${{ steps.git_version.outputs.version }}
+        run: git push origin ${{ steps.git_version.outputs.version }}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Conrad
+Copyright (c) 2024 Conrad Großer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,2 @@
 # creyPY
 My collection of Python and FastAPI shortcuts etc.
-
-
-# Release
-
-``` rm -rf dist build creyPY.egg-info && python setup.py sdist bdist_wheel ```
-
-``` twine upload dist/* ```

creyPY/fastapi/models/base.py

@@ -19,6 +19,9 @@ class Base:
 
     __name__: str
 
+    # TODO: Add default representation string
+    # TODO: Add automated foreign key resolution
+
     # Generate __tablename__ automatically
     @declared_attr
     def __tablename__(cls) -> str:

creyPY/fastapi/pagination.py

@@ -9,6 +9,9 @@ from pydantic.json_schema import SkipJsonSchema
 T = TypeVar("T")
 
 
+# TODO: Add complete fastapi-pagination proxy here
+# TODO: Add pagination off functionality
+# SkipJsonSchema is used to avoid generating invalid JSON schema in FastAPI
 class Page(AbstractPage[T], Generic[T]):
     results: Sequence[T]
     page: GreaterEqualOne | SkipJsonSchema[None] = None

creyPY/fastapi/schemas/base.py

@@ -4,6 +4,7 @@ from uuid import UUID
 from pydantic import BaseModel, ConfigDict
 
 
+# The created_by_id is a string because we use the sub from Auth0
 class BaseSchemaModelIN(BaseModel):
     created_by_id: str
     model_config = ConfigDict(from_attributes=True)

setup.py

@@ -23,7 +23,7 @@ def get_latest_git_tag() -> str:
 setup(
     name="creyPY",
     version=get_latest_git_tag(),
-    description="My collection of Python and FastAPI shortcuts etc.",
+    description="Collection of my Python and FastAPI shortcuts, snippets etc.",
     author="Conrad Großer",
     author_email="conrad@noah.tech",
     packages=find_packages(),

test.py

@@ -0,0 +1,90 @@
+import unittest
+from uuid import UUID
+
+from fastapi import HTTPException
+from fastapi.routing import APIRoute
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from creyPY.fastapi.app import generate_unique_id
+from creyPY.fastapi.crud import (
+    get_object_or_404,
+)
+from creyPY.fastapi.models.base import Base
+
+
+class MockDBClass(Base):
+    def __init__(self, id):
+        self.id = id
+
+
+class TestMyFunction(unittest.TestCase):
+    def setUp(self):
+        # Create a SQLite in-memory database for testing
+        engine = create_engine("sqlite:///:memory:")
+
+        # Create a sessionmaker bound to this engine
+        Session = sessionmaker(bind=engine)
+
+        # Now you can use Session() to get a session bound to the engine
+        self.db = Session()
+
+        # create the table
+        Base.metadata.create_all(engine)
+
+    def test_generate_unique_id(self):
+        # Test case 1: Route with no path parameters and GET method
+        route1 = APIRoute(path="/users", methods={"GET"}, endpoint=lambda: None)
+        assert generate_unique_id(route1) == "users_list"
+
+        # Test case 2: Route with path parameters and POST method
+        route2 = APIRoute(path="/users/{user_id}", methods={"POST"}, endpoint=lambda: None)
+        assert generate_unique_id(route2) == "users_post"
+
+        # Test case 3: Route with path parameters and multiple methods
+        route3 = APIRoute(path="/users/{user_id}", methods={"GET", "PUT"}, endpoint=lambda: None)
+        result = generate_unique_id(route3)
+        assert result == "users_get" or result == "users_put"
+
+        # Test case 4: Route with special characters in path
+        route4 = APIRoute(
+            path="/users/{user_id}/posts/{post_id}", methods={"DELETE"}, endpoint=lambda: None
+        )
+        assert generate_unique_id(route4) == "users_posts_delete"
+
+        # Test case 5: Route with multiple path parameters and PATCH method
+        route5 = APIRoute(
+            path="/users/{user_id}/posts/{post_id}", methods={"PATCH"}, endpoint=lambda: None
+        )
+        assert generate_unique_id(route5) == "users_posts_patch"
+
+        # Test case 6: Route with no path parameters and PUT method
+        route6 = APIRoute(path="/users", methods={"PUT"}, endpoint=lambda: None)
+        assert generate_unique_id(route6) == "users_put"
+
+    def test_get_object_or_404_existing_object(self):
+        # Arrange
+        obj_id = UUID("123e4567-e89b-12d3-a456-426614174000")
+        obj = MockDBClass(obj_id)
+        self.db.add(obj)
+        self.db.commit()
+
+        # Act
+        result = get_object_or_404(MockDBClass, obj_id, self.db)
+
+        # Assert
+        assert result == obj
+
+    def test_get_object_or_404_non_existing_object(self):
+        # Arrange
+        obj_id = UUID("123e4567-e89b-12d3-a456-426614174000")
+
+        # Act & Assert
+        with self.assertRaises(HTTPException) as exc_info:
+            get_object_or_404(MockDBClass, obj_id, self.db)
+        assert exc_info.exception.status_code == 404
+        assert exc_info.exception.detail == "The object does not exist."
+
+
+if __name__ == "__main__":
+    unittest.main()