chore(engine): Run migration for 0.7.3 (TracecatHQ#345)

Author: daryllimyt

Dockerfile.dev

@@ -15,9 +15,16 @@ COPY ./tracecat /app/tracecat
 COPY ./pyproject.toml /app/pyproject.toml
 COPY ./README.md /app/README.md
 COPY ./LICENSE /app/LICENSE
+COPY ./alembic.ini /app/alembic.ini
+COPY ./alembic /app/alembic
+
+COPY scripts/entrypoint.sh /app/entrypoint.sh
+RUN chmod +x /app/entrypoint.sh
 
 # Install package
 RUN pip install --upgrade pip && pip install -e .
 
+ENTRYPOINT ["/app/entrypoint.sh"]
+
 # Command to run the application
 CMD ["sh", "-c", "python3 -m uvicorn tracecat.api.app:app --host $HOST --port $PORT --reload"]

alembic/versions/9331e7a72410_remove_caseaction_and_casecontext_and_.py

@@ -0,0 +1,68 @@
+"""Remove CaseAction and CaseContext and remove workspace ID from CaseEvent
+
+Revision ID: 9331e7a72410
+Revises: ebf7613506e0
+Create Date: 2024-08-22 21:22:39.732969
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision: str = '9331e7a72410'
+down_revision: Union[str, None] = 'ebf7613506e0'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index('ix_casecontext_id', table_name='casecontext')
+    op.drop_table('casecontext')
+    op.drop_index('ix_caseaction_id', table_name='caseaction')
+    op.drop_table('caseaction')
+    op.alter_column('caseevent', 'case_id',
+               existing_type=sa.VARCHAR(),
+               nullable=True)
+    op.create_foreign_key(None, 'caseevent', 'case', ['case_id'], ['id'], ondelete='CASCADE')
+    op.drop_column('caseevent', 'workflow_id')
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('caseevent', sa.Column('workflow_id', sa.VARCHAR(), autoincrement=False, nullable=False))
+    op.drop_constraint(None, 'caseevent', type_='foreignkey')
+    op.alter_column('caseevent', 'case_id',
+               existing_type=sa.VARCHAR(),
+               nullable=False)
+    op.create_table('caseaction',
+    sa.Column('surrogate_id', sa.INTEGER(), autoincrement=True, nullable=False),
+    sa.Column('owner_id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.Column('created_at', postgresql.TIMESTAMP(timezone=True), server_default=sa.text("(now() AT TIME ZONE 'utc'::text)"), autoincrement=False, nullable=False),
+    sa.Column('updated_at', postgresql.TIMESTAMP(timezone=True), server_default=sa.text("(now() AT TIME ZONE 'utc'::text)"), autoincrement=False, nullable=False),
+    sa.Column('id', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('tag', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('value', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('user_id', sa.UUID(), autoincrement=False, nullable=True),
+    sa.ForeignKeyConstraint(['user_id'], ['user.id'], name='caseaction_user_id_fkey'),
+    sa.PrimaryKeyConstraint('surrogate_id', name='caseaction_pkey')
+    )
+    op.create_index('ix_caseaction_id', 'caseaction', ['id'], unique=True)
+    op.create_table('casecontext',
+    sa.Column('surrogate_id', sa.INTEGER(), autoincrement=True, nullable=False),
+    sa.Column('owner_id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.Column('created_at', postgresql.TIMESTAMP(timezone=True), server_default=sa.text("(now() AT TIME ZONE 'utc'::text)"), autoincrement=False, nullable=False),
+    sa.Column('updated_at', postgresql.TIMESTAMP(timezone=True), server_default=sa.text("(now() AT TIME ZONE 'utc'::text)"), autoincrement=False, nullable=False),
+    sa.Column('id', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('tag', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('value', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('user_id', sa.UUID(), autoincrement=False, nullable=True),
+    sa.ForeignKeyConstraint(['user_id'], ['user.id'], name='casecontext_user_id_fkey'),
+    sa.PrimaryKeyConstraint('surrogate_id', name='casecontext_pkey')
+    )
+    op.create_index('ix_casecontext_id', 'casecontext', ['id'], unique=True)
+    # ### end Alembic commands ###

docker-compose.dev.yml

@@ -49,6 +49,8 @@ services:
       SMTP_AUTH_ENABLED: ${SMTP_AUTH_ENABLED}
       SMTP_USER: ${SMTP_USER}
       SMTP_PASS: ${SMTP_PASS}
+      # Migrations
+      RUN_MIGRATIONS: true
     volumes:
       - ./tracecat:/app/tracecat
 

docker-compose.yml

@@ -38,6 +38,7 @@ services:
       OAUTH_CLIENT_ID: ${OAUTH_CLIENT_ID}
       OAUTH_CLIENT_SECRET: ${OAUTH_CLIENT_SECRET}
       USER_AUTH_SECRET: ${USER_AUTH_SECRET}
+      RUN_MIGRATIONS: true
       # Temporal
       TEMPORAL__CLUSTER_URL: ${TEMPORAL__CLUSTER_URL}
       TEMPORAL__CLUSTER_QUEUE: ${TEMPORAL__CLUSTER_QUEUE}
@@ -148,4 +149,4 @@ networks:
     internal: true
   temporal:
   temporal-db:
-    internal: true
+    internal: true

scripts/entrypoint.sh

@@ -4,7 +4,7 @@ set -euo pipefail
 # Function to run migrations
 run_migrations() {
     echo "Running database migrations..."
-    if ! alembic upgrade head; then
+    if ! python3 -m alembic upgrade head; then
         echo "Migration failed!"
         return 1
     fi

tracecat/db/schemas.py

@@ -180,24 +180,6 @@ class Case(Resource, table=True):
     tags: dict[str, str] | None = Field(sa_column=Column(JSONB))
 
 
-class CaseAction(Resource, table=True):
-    id: str = Field(
-        default_factory=id_factory("case-act"), nullable=False, unique=True, index=True
-    )
-    tag: str
-    value: str
-    user_id: UUID4 | None = Field(sa_column=Column(UUID, ForeignKey("user.id")))
-
-
-class CaseContext(Resource, table=True):
-    id: str = Field(
-        default_factory=id_factory("case-ctx"), nullable=False, unique=True, index=True
-    )
-    tag: str
-    value: str
-    user_id: UUID4 | None = Field(sa_column=Column(UUID, ForeignKey("user.id")))
-
-
 class CaseEvent(Resource, table=True):
     id: str = Field(
         default_factory=id_factory("case-evt"), nullable=False, unique=True, index=True