Use Flask custom CLI commands for custom scripts

app/Makefile

@@ -33,6 +33,19 @@ else
 PY_RUN_CMD := docker-compose run $(DOCKER_EXEC_ARGS) --rm $(APP_NAME) poetry run
 endif
 
+FLASK_CMD := $(PY_RUN_CMD) flask --env-file local.env
+
+##################################################
+# Local Development Environment Setup
+##################################################
+
+setup-local:
+	# Configure poetry to use virtualenvs in the project directory
+	poetry config virtualenvs.in-project true
+
+	# Install dependencies
+	poetry install --no-root
+
 ##################################################
 # API Build & Run
 ##################################################
@@ -46,7 +59,6 @@ start:
 run-logs: start
 	docker-compose logs --follow --no-color $(APP_NAME)
 
-
 init: build init-db
 
 clean-volumes: ## Remove project docker volumes (which includes the DB state)
@@ -57,13 +69,6 @@ stop:
 
 check: format-check lint test
 
-# Set init-db as pre-requisite since there seems to be a race condition
-# where the DB can't yet receive connections if it's starting from a 
-# clean state (e.g. after make stop, make clean-volumes, make openapi-spec)
-openapi-spec: init-db ## Generate OpenAPI spec
-	$(PY_RUN_CMD) flask spec --format yaml --output ./openapi.yml
-
-
 ##################################################
 # DB & migrations
 ##################################################
@@ -168,11 +173,21 @@ lint-security: # https://bandit.readthedocs.io/en/latest/index.html
 
 
 ##################################################
-# Scripts
+# CLI Commands
 ##################################################
 
-create-user-csv:
-	$(PY_RUN_CMD) create-user-csv
+cmd: ## Run Flask app CLI command (Run `make cli args="--help"` to see list of CLI commands)
+	$(FLASK_CMD) $(args)
+
+cmd-user-create-csv: ## Create a CSV of the useres in the database (Run `make cli-user-create-csv args="--help"` to see the command's options)
+	$(FLASK_CMD) user create-csv $(args)
+
+# Set init-db as pre-requisite since there seems to be a race condition
+# where the DB can't yet receive connections if it's starting from a 
+# clean state (e.g. after make stop, make clean-volumes, make openapi-spec)
+openapi-spec: init-db ## Generate OpenAPI spec
+	$(FLASK_CMD) spec --format yaml --output ./openapi.yml
+
 
 ##################################################
 # Miscellaneous Utilities
@@ -184,10 +199,3 @@ login: start ## Start shell in running container
 # Pauses for 5 seconds
 sleep-5:
 	sleep 5
-
-setup-local:
-	# Configure poetry to use virtualenvs in the project directory
-	poetry config virtualenvs.in-project true
-
-	# Install dependencies
-	poetry install --no-root

app/api/route/healthcheck.py → app/api/api/healthcheck.py

@@ -7,8 +7,8 @@
 from werkzeug.exceptions import ServiceUnavailable
 
 import api.adapters.db.flask_db as flask_db
-from api.route import response
-from api.route.schemas import request_schema
+from api.api import response
+from api.api.schemas import request_schema
 
 logger = logging.getLogger(__name__)
 

app/api/route/response.py → app/api/api/response.py

@@ -1,8 +1,8 @@
 import dataclasses
 from typing import Optional
 
+from api.api.schemas import response_schema
 from api.db.models.base import Base
-from api.route.schemas import response_schema
 
 
 @dataclasses.dataclass

app/api/route/schemas/response_schema.py → app/api/api/schemas/response_schema.py

@@ -1,6 +1,6 @@
 from apiflask import fields
 
-from api.route.schemas import request_schema
+from api.api.schemas import request_schema
 
 
 class ValidationErrorSchema(request_schema.OrderedSchema):

app/api/api/users/__init__.py

@@ -0,0 +1,10 @@
+from api.api.users.user_blueprint import user_blueprint
+
+# import user_commands module to register the CLI commands on the user_blueprint
+import api.api.users.user_commands  # noqa: F401 E402 isort:skip
+
+# import user_commands module to register the API routes on the user_blueprint
+import api.api.users.user_routes  # noqa: F401 E402 isort:skip
+
+
+__all__ = ["user_blueprint"]

app/api/api/users/user_blueprint.py

@@ -0,0 +1,3 @@
+from apiflask import APIBlueprint
+
+user_blueprint = APIBlueprint("user", __name__, tag="User", cli_group="user")

app/api/api/users/user_commands.py

@@ -0,0 +1,34 @@
+import logging
+import os.path as path
+from typing import Optional
+
+import click
+
+import api.adapters.db as db
+import api.adapters.db.flask_db as flask_db
+import api.services.users as user_service
+from api.api.users.user_blueprint import user_blueprint
+from api.util.datetime_util import utcnow
+
+logger = logging.getLogger(__name__)
+
+user_blueprint.cli.help = "User commands"
+
+
+@user_blueprint.cli.command("create-csv", help="Create a CSV of all users and their roles")
+@flask_db.with_db_session
+@click.option(
+    "--dir",
+    default=".",
+    help="Directory to save output file in. Can be an S3 path (e.g. 's3://bucketname/folder/') Defaults to current directory ('.').",
+)
+@click.option(
+    "--filename",
+    default=None,
+    help="Filename to save output file as. Defaults to '[timestamp]-user-roles.csv.",
+)
+def create_csv(db_session: db.Session, dir: str, filename: Optional[str]) -> None:
+    if filename is None:
+        filename = utcnow().strftime("%Y-%m-%d-%H-%M-%S") + "-user-roles.csv"
+    filepath = path.join(dir, filename)
+    user_service.create_user_csv(db_session, filepath)

app/api/route/user_route.py → app/api/api/users/user_routes.py

@@ -1,44 +1,34 @@
 import logging
 from typing import Any
 
-from apiflask import APIBlueprint
-
 import api.adapters.db as db
 import api.adapters.db.flask_db as flask_db
+import api.api.response as response
+import api.api.users.user_schemas as user_schemas
 import api.services.users as user_service
+import api.services.users as users
+from api.api.users.user_blueprint import user_blueprint
 from api.auth.api_key_auth import api_key_auth
 from api.db.models.user_models import User
-from api.route import response
-from api.route.schemas import user_schemas
-from api.services import users
 
 logger = logging.getLogger(__name__)
 
 
-user_blueprint = APIBlueprint("user", __name__, tag="User")
-
-
-@user_blueprint.post("/v1/user")
+@user_blueprint.post("/v1/users")
 @user_blueprint.input(user_schemas.UserSchema)
 @user_blueprint.output(user_schemas.UserSchema, status_code=201)
 @user_blueprint.auth_required(api_key_auth)
 @flask_db.with_db_session
 def user_post(db_session: db.Session, user_params: users.CreateUserParams) -> dict:
     """
-    POST /v1/user
+    POST /v1/users
     """
     user = user_service.create_user(db_session, user_params)
-
-    logger.info(
-        "Successfully inserted user",
-        extra=get_user_log_params(user),
-    )
-    print("Successfully inserted user", get_user_log_params(user))
-
+    logger.info("Successfully inserted user", extra=get_user_log_params(user))
     return response.ApiResponse(message="Success", data=user).asdict()
 
 
-@user_blueprint.patch("/v1/user/<uuid:user_id>")
+@user_blueprint.patch("/v1/users/<uuid:user_id>")
 # Allow partial updates. partial=true means requests that are missing
 # required fields will not be rejected.
 # https://marshmallow.readthedocs.io/en/stable/quickstart.html#partial-loading
@@ -50,29 +40,19 @@ def user_patch(
     db_session: db.Session, user_id: str, patch_user_params: users.PatchUserParams
 ) -> dict:
     user = user_service.patch_user(db_session, user_id, patch_user_params)
-
-    logger.info(
-        "Successfully patched user",
-        extra=get_user_log_params(user),
-    )
-
+    logger.info("Successfully patched user", extra=get_user_log_params(user))
     return response.ApiResponse(message="Success", data=user).asdict()
 
 
-@user_blueprint.get("/v1/user/<uuid:user_id>")
+@user_blueprint.get("/v1/users/<uuid:user_id>")
 @user_blueprint.output(user_schemas.UserSchema)
 @user_blueprint.auth_required(api_key_auth)
 @flask_db.with_db_session
 def user_get(db_session: db.Session, user_id: str) -> dict:
     user = user_service.get_user(db_session, user_id)
-
-    logger.info(
-        "Successfully fetched user",
-        extra=get_user_log_params(user),
-    )
-
+    logger.info("Successfully fetched user", extra=get_user_log_params(user))
     return response.ApiResponse(message="Success", data=user).asdict()
 
 
 def get_user_log_params(user: User) -> dict[str, Any]:
-    return {"user_id": user.id}
+    return {"user.id": user.id}

app/api/route/schemas/user_schemas.py → app/api/api/users/user_schemas.py

@@ -1,12 +1,8 @@
 from apiflask import fields
 from marshmallow import fields as marshmallow_fields
 
+from api.api.schemas import request_schema
 from api.db.models import user_models
-from api.route.schemas import request_schema
-
-##############
-# Role Models
-##############
 
 
 class RoleSchema(request_schema.OrderedSchema):
@@ -20,11 +16,6 @@ class RoleSchema(request_schema.OrderedSchema):
     # will always be a nested fields of the API user
 
 
-##############
-# User Models
-##############
-
-
 class UserSchema(request_schema.OrderedSchema):
     id = fields.UUID(dump_only=True)
     first_name = fields.String(metadata={"description": "The user's first name"}, required=True)

app/api/app.py

@@ -10,10 +10,10 @@
 import api.adapters.db.flask_db as flask_db
 import api.logging
 import api.logging.flask_logger as flask_logger
+from api.api.healthcheck import healthcheck_blueprint
+from api.api.schemas import response_schema
+from api.api.users import user_blueprint
 from api.auth.api_key_auth import User, get_app_security_scheme
-from api.route.healthcheck import healthcheck_blueprint
-from api.route.schemas import response_schema
-from api.route.user_route import user_blueprint
 
 logger = logging.getLogger(__name__)
 

app/api/db/migrations/versions/2023_02_21_cascade_on_delete.py

@@ -0,0 +1,30 @@
+"""cascade on delete
+
+Revision ID: 9fe657340f70
+Revises: 4ff1160282d1
+Create Date: 2023-02-21 18:16:56.052679
+
+"""
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "9fe657340f70"
+down_revision = "4ff1160282d1"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint("role_user_id_user_fkey", "role", type_="foreignkey")
+    op.create_foreign_key(
+        op.f("role_user_id_user_fkey"), "role", "user", ["user_id"], ["id"], ondelete="CASCADE"
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(op.f("role_user_id_user_fkey"), "role", type_="foreignkey")
+    op.create_foreign_key("role_user_id_user_fkey", "role", "user", ["user_id"], ["id"])
+    # ### end Alembic commands ###

app/api/db/models/user_models.py

@@ -28,13 +28,15 @@ class User(Base, IdMixin, TimestampMixin):
     date_of_birth: date = Column(Date, nullable=False)
     is_active: bool = Column(Boolean, nullable=False)
 
-    roles: list["Role"] = relationship("Role", back_populates="user", order_by="Role.type")
+    roles: list["Role"] = relationship(
+        "Role", back_populates="user", cascade="all, delete", order_by="Role.type"
+    )
 
 
 class Role(Base, TimestampMixin):
     __tablename__ = "role"
     user_id: Mapped[UUID] = Column(
-        postgresql.UUID(as_uuid=True), ForeignKey("user.id"), primary_key=True
+        postgresql.UUID(as_uuid=True), ForeignKey("user.id", ondelete="CASCADE"), primary_key=True
     )
 
     # Set native_enum=False to use store enum values as VARCHAR/TEXT