Simplify CRUD definitions, make a clearer distinction between schemas and models

.gitignore

@@ -1,3 +1,7 @@
 .vscode
-testing-project
 .mypy_cache
+.pytest_cache
+Pipfile.lock
+
+testing-project
+docker-stack.yml

test-backend.sh

@@ -0,0 +1,19 @@
+#! /usr/bin/env bash
+
+# pre-requisite: use test.sh script at least once before using this script
+
+# this script produces the same result as test.sh, but faster
+# because it rsyncs the latest modification into testing-project
+# instead of removing it and generating it again
+
+# Exit in case of error
+set -e
+
+# push new src files
+rsync -av \{\{cookiecutter.project_slug\}\}/backend testing-project/
+
+# restart backend container
+docker-compose -f testing-project/docker-stack.yml restart backend
+
+# run tests
+docker-compose -f testing-project/docker-stack.yml exec -T backend-tests /tests-start.sh $*

test.sh

@@ -9,6 +9,6 @@ cookiecutter --config-file ./testing-config.yml --no-input -f ./
 
 cd ./testing-project
 
-bash ./scripts/test.sh
+bash ./scripts/test.sh $*
 
 cd ../

{{cookiecutter.project_slug}}/README.md

@@ -55,7 +55,7 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec
 
 Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.
 
-Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.
+Modify or add SQLAlchemy models in `./backend/app/app/models/`, Pydantic schemas in `./backend/app/app/schemas/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.
 
 Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 
 
@@ -205,7 +205,7 @@ Make sure you create a "revision" of your models and that you "upgrade" your dat
 docker-compose exec backend bash
 ```
 
-* If you created a new model in `./backend/app/app/db_models/`, make sure to import it in `./backend/app/app/db/base.py`, that Python module (`base.py`) that imports all the models will be used by Alembic.
+* If you created a new model in `./backend/app/app/models/`, make sure to import it in `./backend/app/app/db/base.py`, that Python module (`base.py`) that imports all the models will be used by Alembic.
 
 * After changing a model (for example, adding a column), inside the container, create a revision, e.g.:
 

{{cookiecutter.project_slug}}/backend/app/alembic/versions/d4867f3a4c0a_first_revision.py

@@ -19,33 +19,52 @@
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
     op.create_table('user',
-    sa.Column('id', sa.Integer(), nullable=False),
-    sa.Column('full_name', sa.String(), nullable=True),
-    sa.Column('email', sa.String(), nullable=True),
-    sa.Column('hashed_password', sa.String(), nullable=True),
-    sa.Column('is_active', sa.Boolean(), nullable=True),
-    sa.Column('is_superuser', sa.Boolean(), nullable=True),
-    sa.PrimaryKeyConstraint('id')
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('full_name', sa.String(), nullable=True),
+        sa.Column('email', sa.String(), nullable=True),
+        sa.Column('hashed_password', sa.String(), nullable=True),
+        sa.Column('is_active', sa.Boolean(), nullable=True),
+        sa.Column('is_superuser', sa.Boolean(), nullable=True),
+        sa.Column('created_at', sa.DateTime(), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.PrimaryKeyConstraint('id')
     )
     op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
     op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
     op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
+
     op.create_table('item',
-    sa.Column('id', sa.Integer(), nullable=False),
-    sa.Column('title', sa.String(), nullable=True),
-    sa.Column('description', sa.String(), nullable=True),
-    sa.Column('owner_id', sa.Integer(), nullable=True),
-    sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
-    sa.PrimaryKeyConstraint('id')
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(), nullable=True),
+        sa.Column('description', sa.String(), nullable=True),
+        sa.Column('owner_id', sa.Integer(), nullable=True),
+        sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
+        sa.PrimaryKeyConstraint('id')
     )
     op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
     op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
     op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
+
+    op.create_table('subitem',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(), nullable=True),
+        sa.Column('description', sa.String(), nullable=True),
+        sa.Column('item_id', sa.Integer(), nullable=True),
+        sa.ForeignKeyConstraint(['item_id'], ['item.id'], ),
+        sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_subitem_description'), 'subitem', ['description'], unique=False)
+    op.create_index(op.f('ix_subitem_id'), 'subitem', ['id'], unique=False)
+    op.create_index(op.f('ix_subitem_title'), 'subitem', ['title'], unique=False)
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_subitem_title'), table_name='subitem')
+    op.drop_index(op.f('ix_subitem_id'), table_name='subitem')
+    op.drop_index(op.f('ix_subitem_description'), table_name='subitem')
+    op.drop_table('subitem')
     op.drop_index(op.f('ix_item_title'), table_name='item')
     op.drop_index(op.f('ix_item_id'), table_name='item')
     op.drop_index(op.f('ix_item_description'), table_name='item')

{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

@@ -6,8 +6,8 @@
 from app import crud
 from app.api.utils.db import get_db
 from app.api.utils.security import get_current_active_user
-from app.db_models.user import User as DBUser
-from app.models.item import Item, ItemCreate, ItemUpdate
+from app.models.user import User as DBUser
+from app.schemas.item import Item, ItemCreate, ItemUpdate
 
 router = APIRouter()
 
@@ -22,7 +22,7 @@ def read_items(
     """
     Retrieve items.
     """
-    if crud.user.is_superuser(current_user):
+    if current_user.is_superuser:
         items = crud.item.get_multi(db, skip=skip, limit=limit)
     else:
         items = crud.item.get_multi_by_owner(
@@ -41,7 +41,8 @@ def create_item(
     """
     Create new item.
     """
-    item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
+    item_in.owner_id = current_user.id
+    item = crud.item.create(db_session=db, item_in=item_in)
     return item
 
 
@@ -59,7 +60,7 @@ def update_item(
     item = crud.item.get(db_session=db, id=id)
     if not item:
         raise HTTPException(status_code=404, detail="Item not found")
-    if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
+    if not current_user.is_superuser and (item.owner_id != current_user.id):
         raise HTTPException(status_code=400, detail="Not enough permissions")
     item = crud.item.update(db_session=db, item=item, item_in=item_in)
     return item
@@ -78,7 +79,7 @@ def read_user_me(
     item = crud.item.get(db_session=db, id=id)
     if not item:
         raise HTTPException(status_code=400, detail="Item not found")
-    if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
+    if not current_user.is_superuser and (item.owner_id != current_user.id):
         raise HTTPException(status_code=400, detail="Not enough permissions")
     return item
 
@@ -96,7 +97,7 @@ def delete_item(
     item = crud.item.get(db_session=db, id=id)
     if not item:
         raise HTTPException(status_code=404, detail="Item not found")
-    if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
+    if not current_user.is_superuser and (item.owner_id != current_user.id):
         raise HTTPException(status_code=400, detail="Not enough permissions")
     item = crud.item.remove(db_session=db, id=id)
     return item

{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/login.py

@@ -10,10 +10,10 @@
 from app.core import config
 from app.core.jwt import create_access_token
 from app.core.security import get_password_hash
-from app.db_models.user import User as DBUser
-from app.models.msg import Msg
-from app.models.token import Token
-from app.models.user import User
+from app.models.user import User as DBUser
+from app.schemas.msg import Msg
+from app.schemas.token import Token
+from app.schemas.user import User
 from app.utils import (
     generate_password_reset_token,
     send_reset_password_email,
@@ -35,7 +35,7 @@ def login_access_token(
     )
     if not user:
         raise HTTPException(status_code=400, detail="Incorrect email or password")
-    elif not crud.user.is_active(user):
+    elif not user.is_active:
         raise HTTPException(status_code=400, detail="Inactive user")
     access_token_expires = timedelta(minutes=config.ACCESS_TOKEN_EXPIRE_MINUTES)
     return {
@@ -87,7 +87,7 @@ def reset_password(token: str = Body(...), new_password: str = Body(...), db: Se
             status_code=404,
             detail="The user with this username does not exist in the system.",
         )
-    elif not crud.user.is_active(user):
+    elif not user.is_active:
         raise HTTPException(status_code=400, detail="Inactive user")
     hashed_password = get_password_hash(new_password)
     user.hashed_password = hashed_password

{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/users.py

@@ -9,13 +9,43 @@
 from app.api.utils.db import get_db
 from app.api.utils.security import get_current_active_superuser, get_current_active_user
 from app.core import config
-from app.db_models.user import User as DBUser
-from app.models.user import User, UserCreate, UserInDB, UserUpdate
+from app.models.user import User as DBUser
+from app.schemas.user import User, UserCreate, UserUpdate
 from app.utils import send_new_account_email
 
 router = APIRouter()
 
 
+@router.get("/me", response_model=User)
+def read_user_me(
+    db: Session = Depends(get_db),
+    current_user: DBUser = Depends(get_current_active_user),
+):
+    """
+    Get current user.
+    """
+    return current_user
+
+
+@router.get("/{user_id}", response_model=User)
+def read_user_by_id(
+    user_id: int,
+    current_user: DBUser = Depends(get_current_active_user),
+    db: Session = Depends(get_db),
+):
+    """
+    Get a specific user by id.
+    """
+    user = crud.user.get(db, obj_id=user_id)
+    if user == current_user:
+        return user
+    if not current_user.is_superuser:
+        raise HTTPException(
+            status_code=400, detail="The user doesn't have enough privileges"
+        )
+    return user
+
+
 @router.get("/", response_model=List[User])
 def read_users(
     db: Session = Depends(get_db),
@@ -30,6 +60,33 @@ def read_users(
     return users
 
 
+@router.post("/open", response_model=User)
+def create_user_open(
+    *,
+    db: Session = Depends(get_db),
+    password: str = Body(...),
+    email: EmailStr = Body(...),
+    full_name: str = Body(None),
+):
+    """
+    Create new user without the need to be logged in.
+    """
+    if not config.USERS_OPEN_REGISTRATION:
+        raise HTTPException(
+            status_code=403,
+            detail="Open user resgistration is forbidden on this server",
+        )
+    user = crud.user.get_by_email(db, email=email)
+    if user:
+        raise HTTPException(
+            status_code=400,
+            detail="The user with this username already exists in the system",
+        )
+    user_in = UserCreate(password=password, email=email, full_name=full_name)
+    user = crud.user.create(db, obj_in=user_in)
+    return user
+
+
 @router.post("/", response_model=User)
 def create_user(
     *,
@@ -46,7 +103,7 @@ def create_user(
             status_code=400,
             detail="The user with this username already exists in the system.",
         )
-    user = crud.user.create(db, user_in=user_in)
+    user = crud.user.create(db, obj_in=user_in)
     if config.EMAILS_ENABLED and user_in.email:
         send_new_account_email(
             email_to=user_in.email, username=user_in.email, password=user_in.password
@@ -74,64 +131,7 @@ def update_user_me(
         user_in.full_name = full_name
     if email is not None:
         user_in.email = email
-    user = crud.user.update(db, user=current_user, user_in=user_in)
-    return user
-
-
-@router.get("/me", response_model=User)
-def read_user_me(
-    db: Session = Depends(get_db),
-    current_user: DBUser = Depends(get_current_active_user),
-):
-    """
-    Get current user.
-    """
-    return current_user
-
-
-@router.post("/open", response_model=User)
-def create_user_open(
-    *,
-    db: Session = Depends(get_db),
-    password: str = Body(...),
-    email: EmailStr = Body(...),
-    full_name: str = Body(None),
-):
-    """
-    Create new user without the need to be logged in.
-    """
-    if not config.USERS_OPEN_REGISTRATION:
-        raise HTTPException(
-            status_code=403,
-            detail="Open user resgistration is forbidden on this server",
-        )
-    user = crud.user.get_by_email(db, email=email)
-    if user:
-        raise HTTPException(
-            status_code=400,
-            detail="The user with this username already exists in the system",
-        )
-    user_in = UserCreate(password=password, email=email, full_name=full_name)
-    user = crud.user.create(db, user_in=user_in)
-    return user
-
-
-@router.get("/{user_id}", response_model=User)
-def read_user_by_id(
-    user_id: int,
-    current_user: DBUser = Depends(get_current_active_user),
-    db: Session = Depends(get_db),
-):
-    """
-    Get a specific user by id.
-    """
-    user = crud.user.get(db, user_id=user_id)
-    if user == current_user:
-        return user
-    if not crud.user.is_superuser(current_user):
-        raise HTTPException(
-            status_code=400, detail="The user doesn't have enough privileges"
-        )
+    user = crud.user.update(db, obj=current_user, obj_in=user_in)
     return user
 
 
@@ -141,16 +141,16 @@ def update_user(
     db: Session = Depends(get_db),
     user_id: int,
     user_in: UserUpdate,
-    current_user: UserInDB = Depends(get_current_active_superuser),
+    current_user: User = Depends(get_current_active_superuser),
 ):
     """
     Update a user.
     """
-    user = crud.user.get(db, user_id=user_id)
+    user = crud.user.get(db, obj_id=user_id)
     if not user:
         raise HTTPException(
             status_code=404,
             detail="The user with this username does not exist in the system",
         )
-    user = crud.user.update(db, user=user, user_in=user_in)
+    user = crud.user.update(db, obj=user, obj_in=user_in)
     return user