Fix code issues and add missing documentation
- Fix duplicate tenant_id parameter in seed.py (line 148) - Add security warning to SECRET_KEY in .env.example - Create comprehensive README.md with setup instructions - Add Alembic configuration files (alembic.ini, env.py, script.py.mako) - Create initial database migration for all tables - Document project structure, features, and deployment checklist
This commit is contained in:
drjones
84
backend/alembic/env.py
Normal file
84
backend/alembic/env.py
Normal file
@@ -0,0 +1,84 @@
|
||||
from logging.config import fileConfig
|
||||
|
||||
from sqlalchemy import engine_from_config
|
||||
from sqlalchemy import pool
|
||||
|
||||
from alembic import context
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# Add the parent directory to sys.path to import app modules
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
|
||||
|
||||
from app.core.config import settings
|
||||
from app.db.session import Base
|
||||
from app.models import models # Import all models
|
||||
|
||||
# this is the Alembic Config object, which provides
|
||||
# access to the values within the .ini file in use.
|
||||
config = context.config
|
||||
|
||||
# Interpret the config file for Python logging.
|
||||
# This line sets up loggers basically.
|
||||
if config.config_file_name is not None:
|
||||
fileConfig(config.config_file_name)
|
||||
|
||||
# add your model's MetaData object here
|
||||
# for 'autogenerate' support
|
||||
target_metadata = Base.metadata
|
||||
|
||||
# Override sqlalchemy.url with the one from settings
|
||||
config.set_main_option("sqlalchemy.url", settings.SYNC_DATABASE_URL)
|
||||
|
||||
|
||||
def run_migrations_offline() -> None:
|
||||
"""Run migrations in 'offline' mode.
|
||||
|
||||
This configures the context with just a URL
|
||||
and not an Engine, though an Engine is acceptable
|
||||
here as well. By skipping the Engine creation
|
||||
we don't even need a DBAPI to be available.
|
||||
|
||||
Calls to context.execute() here emit the given string to the
|
||||
script output.
|
||||
|
||||
"""
|
||||
url = config.get_main_option("sqlalchemy.url")
|
||||
context.configure(
|
||||
url=url,
|
||||
target_metadata=target_metadata,
|
||||
literal_binds=True,
|
||||
dialect_opts={"paramstyle": "named"},
|
||||
)
|
||||
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
|
||||
|
||||
def run_migrations_online() -> None:
|
||||
"""Run migrations in 'online' mode.
|
||||
|
||||
In this scenario we need to create an Engine
|
||||
and associate a connection with the context.
|
||||
|
||||
"""
|
||||
connectable = engine_from_config(
|
||||
config.get_section(config.config_ini_section, {}),
|
||||
prefix="sqlalchemy.",
|
||||
poolclass=pool.NullPool,
|
||||
)
|
||||
|
||||
with connectable.connect() as connection:
|
||||
context.configure(
|
||||
connection=connection, target_metadata=target_metadata
|
||||
)
|
||||
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
|
||||
|
||||
if context.is_offline_mode():
|
||||
run_migrations_offline()
|
||||
else:
|
||||
run_migrations_online()
|
||||
26
backend/alembic/script.py.mako
Normal file
26
backend/alembic/script.py.mako
Normal file
@@ -0,0 +1,26 @@
|
||||
"""${message}
|
||||
|
||||
Revision ID: ${up_revision}
|
||||
Revises: ${down_revision | comma,n}
|
||||
Create Date: ${create_date}
|
||||
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
${imports if imports else ""}
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = ${repr(up_revision)}
|
||||
down_revision: Union[str, None] = ${repr(down_revision)}
|
||||
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
|
||||
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
${upgrades if upgrades else "pass"}
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
${downgrades if downgrades else "pass"}
|
||||
@@ -0,0 +1,187 @@
|
||||
"""Initial migration - create all tables
|
||||
|
||||
Revision ID: 001
|
||||
Revises:
|
||||
Create Date: 2025-01-01 00:00:00.000000
|
||||
|
||||
"""
|
||||
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 = '001'
|
||||
down_revision: Union[str, None] = None
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
# Create tenants table
|
||||
op.create_table(
|
||||
'tenants',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('name', sa.String(255), nullable=False),
|
||||
sa.Column('slug', sa.String(100), unique=True, nullable=False),
|
||||
sa.Column('industry', sa.String(100), nullable=True),
|
||||
sa.Column('size_range', sa.String(50), nullable=True),
|
||||
sa.Column('contact_email', sa.String(255), nullable=True),
|
||||
sa.Column('is_active', sa.Boolean(), default=True),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
sa.Column('updated_at', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
# Create users table
|
||||
op.create_table(
|
||||
'users',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('email', sa.String(255), unique=True, nullable=False),
|
||||
sa.Column('hashed_password', sa.String(255), nullable=False),
|
||||
sa.Column('full_name', sa.String(255), nullable=False),
|
||||
sa.Column('role', sa.String(50), nullable=False),
|
||||
sa.Column('is_active', sa.Boolean(), default=True),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
sa.Column('last_login', sa.DateTime(), nullable=True),
|
||||
)
|
||||
|
||||
# Create authorized_assets table
|
||||
op.create_table(
|
||||
'authorized_assets',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('value', sa.String(500), nullable=False),
|
||||
sa.Column('asset_type', sa.String(50), nullable=False),
|
||||
sa.Column('description', sa.Text(), nullable=True),
|
||||
sa.Column('scope_agreement_ref', sa.String(255), nullable=True),
|
||||
sa.Column('authorized_by', sa.String(255), nullable=True),
|
||||
sa.Column('authorized_at', sa.DateTime(), nullable=False),
|
||||
sa.Column('is_active', sa.Boolean(), default=True),
|
||||
)
|
||||
|
||||
# Create assets table
|
||||
op.create_table(
|
||||
'assets',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('name', sa.String(500), nullable=False),
|
||||
sa.Column('asset_type', sa.String(50), nullable=False),
|
||||
sa.Column('value', sa.String(500), nullable=False),
|
||||
sa.Column('owner_name', sa.String(255), nullable=True),
|
||||
sa.Column('owner_email', sa.String(255), nullable=True),
|
||||
sa.Column('tags', sa.Text(), nullable=True),
|
||||
sa.Column('notes', sa.Text(), nullable=True),
|
||||
sa.Column('is_active', sa.Boolean(), default=True),
|
||||
sa.Column('first_seen', sa.DateTime(), nullable=False),
|
||||
sa.Column('last_seen', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
# Create executives table
|
||||
op.create_table(
|
||||
'executives',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('full_name', sa.String(255), nullable=False),
|
||||
sa.Column('title', sa.String(255), nullable=True),
|
||||
sa.Column('corporate_email', sa.String(255), nullable=True),
|
||||
sa.Column('is_enrolled', sa.Boolean(), default=True),
|
||||
sa.Column('notes', sa.Text(), nullable=True),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
# Create findings table
|
||||
op.create_table(
|
||||
'findings',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('asset_id', sa.String(36), sa.ForeignKey('assets.id'), nullable=True),
|
||||
sa.Column('executive_id', sa.String(36), sa.ForeignKey('executives.id'), nullable=True),
|
||||
sa.Column('title', sa.String(500), nullable=False),
|
||||
sa.Column('severity', sa.String(50), nullable=False),
|
||||
sa.Column('status', sa.String(50), nullable=False),
|
||||
sa.Column('category', sa.String(50), nullable=False),
|
||||
sa.Column('technical_description', sa.Text(), nullable=True),
|
||||
sa.Column('cve_id', sa.String(30), nullable=True),
|
||||
sa.Column('cvss_score', sa.Float(), nullable=True),
|
||||
sa.Column('affected_component', sa.String(500), nullable=True),
|
||||
sa.Column('evidence', sa.Text(), nullable=True),
|
||||
sa.Column('ai_summary', sa.Text(), nullable=True),
|
||||
sa.Column('ai_business_impact', sa.Text(), nullable=True),
|
||||
sa.Column('ai_impact_level', sa.String(20), nullable=True),
|
||||
sa.Column('ai_remediation_steps', sa.Text(), nullable=True),
|
||||
sa.Column('ai_fix_priority', sa.String(20), nullable=True),
|
||||
sa.Column('ai_generated_at', sa.DateTime(), nullable=True),
|
||||
sa.Column('assignee_email', sa.String(255), nullable=True),
|
||||
sa.Column('due_date', sa.DateTime(), nullable=True),
|
||||
sa.Column('resolution_note', sa.Text(), nullable=True),
|
||||
sa.Column('resolved_at', sa.DateTime(), nullable=True),
|
||||
sa.Column('verified_at', sa.DateTime(), nullable=True),
|
||||
sa.Column('source', sa.String(100), nullable=True),
|
||||
sa.Column('is_top_risk', sa.Boolean(), default=False),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
sa.Column('updated_at', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
# Create risk_scores table
|
||||
op.create_table(
|
||||
'risk_scores',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('score_date', sa.DateTime(), nullable=False),
|
||||
sa.Column('overall_score', sa.Float(), nullable=False),
|
||||
sa.Column('score_identity', sa.Float(), nullable=True),
|
||||
sa.Column('score_cloud', sa.Float(), nullable=True),
|
||||
sa.Column('score_network', sa.Float(), nullable=True),
|
||||
sa.Column('score_web', sa.Float(), nullable=True),
|
||||
sa.Column('score_credential', sa.Float(), nullable=True),
|
||||
sa.Column('score_digital_footprint', sa.Float(), nullable=True),
|
||||
sa.Column('score_third_party', sa.Float(), nullable=True),
|
||||
sa.Column('critical_count', sa.Integer(), default=0),
|
||||
sa.Column('high_count', sa.Integer(), default=0),
|
||||
sa.Column('medium_count', sa.Integer(), default=0),
|
||||
sa.Column('low_count', sa.Integer(), default=0),
|
||||
sa.Column('notes', sa.Text(), nullable=True),
|
||||
)
|
||||
|
||||
# Create attack_paths table
|
||||
op.create_table(
|
||||
'attack_paths',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('finding_id', sa.String(36), sa.ForeignKey('findings.id'), nullable=False),
|
||||
sa.Column('title', sa.String(500), nullable=False),
|
||||
sa.Column('ai_narrative', sa.Text(), nullable=True),
|
||||
sa.Column('nodes_json', sa.Text(), nullable=True),
|
||||
sa.Column('edges_json', sa.Text(), nullable=True),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
# Create audit_reports table
|
||||
op.create_table(
|
||||
'audit_reports',
|
||||
sa.Column('id', sa.String(36), primary_key=True),
|
||||
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
|
||||
sa.Column('title', sa.String(500), nullable=False),
|
||||
sa.Column('report_date', sa.DateTime(), nullable=False),
|
||||
sa.Column('baseline_score', sa.Float(), nullable=True),
|
||||
sa.Column('executive_summary', sa.Text(), nullable=True),
|
||||
sa.Column('scope_description', sa.Text(), nullable=True),
|
||||
sa.Column('key_findings_json', sa.Text(), nullable=True),
|
||||
sa.Column('pdf_path', sa.String(500), nullable=True),
|
||||
sa.Column('is_baseline', sa.Boolean(), default=True),
|
||||
sa.Column('generated_by', sa.String(255), nullable=True),
|
||||
sa.Column('created_at', sa.DateTime(), nullable=False),
|
||||
)
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_table('audit_reports')
|
||||
op.drop_table('attack_paths')
|
||||
op.drop_table('risk_scores')
|
||||
op.drop_table('findings')
|
||||
op.drop_table('executives')
|
||||
op.drop_table('assets')
|
||||
op.drop_table('authorized_assets')
|
||||
op.drop_table('users')
|
||||
op.drop_table('tenants')
|
||||
Reference in New Issue
Block a user