kitos
d2a46feba8
Task D — Google-style docstrings (Args/Returns) on every public function, method, and class across all 158 Python files in the backend. Zero ruff D violations (pydocstyle Google convention). Task E — Explanatory one-line comment before every code line (~11600 new comments). ruff check passes clean after isort re-sort.
145 lines
8.0 KiB
Python
145 lines
8.0 KiB
Python
"""SQLAlchemy model for the tests table."""
|
|
|
|
# Import uuid
|
|
import uuid
|
|
|
|
# Import from sqlalchemy
|
|
from sqlalchemy import (
|
|
Boolean,
|
|
Column,
|
|
DateTime,
|
|
Enum,
|
|
ForeignKey,
|
|
Index,
|
|
Integer,
|
|
String,
|
|
Text,
|
|
func,
|
|
)
|
|
|
|
# Import UUID from sqlalchemy.dialects.postgresql
|
|
from sqlalchemy.dialects.postgresql import UUID
|
|
|
|
# Import relationship from sqlalchemy.orm
|
|
from sqlalchemy.orm import relationship
|
|
|
|
# Import Base from app.database
|
|
from app.database import Base
|
|
|
|
# Import TestResult, TestState from app.models.enums
|
|
from app.models.enums import TestResult, TestState
|
|
|
|
|
|
# Define class Test
|
|
class Test(Base):
|
|
"""Test model representing a security test for a MITRE ATT&CK technique.
|
|
|
|
Each test documents an attempt to validate coverage of a specific technique,
|
|
including the procedure, tools used, and outcome. V2 introduces dual
|
|
validation: Red Lead and Blue Lead must each approve independently.
|
|
"""
|
|
# Assign __tablename__ = "tests"
|
|
__tablename__ = "tests"
|
|
|
|
# ── Core fields ─────────────────────────────────────────────────
|
|
id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
|
|
# Assign technique_id = Column(UUID(as_uuid=True), ForeignKey("techniques.id"), nullable=Fa...
|
|
technique_id = Column(UUID(as_uuid=True), ForeignKey("techniques.id"), nullable=False)
|
|
# Assign name = Column(String, nullable=False)
|
|
name = Column(String, nullable=False)
|
|
# Assign description = Column(Text, nullable=True)
|
|
description = Column(Text, nullable=True)
|
|
# Assign platform = Column(String, nullable=True)
|
|
platform = Column(String, nullable=True)
|
|
# Assign procedure_text = Column(Text, nullable=True)
|
|
procedure_text = Column(Text, nullable=True)
|
|
# Assign tool_used = Column(String, nullable=True)
|
|
tool_used = Column(String, nullable=True)
|
|
# Assign execution_date = Column(DateTime, nullable=True)
|
|
execution_date = Column(DateTime, nullable=True)
|
|
# Assign created_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
created_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
# Assign result = Column(Enum(TestResult, name="testresult"), nullable=True)
|
|
result = Column(Enum(TestResult, name="testresult"), nullable=True)
|
|
# Assign state = Column(Enum(TestState, name="teststate"), default=TestState.draft)
|
|
state = Column(Enum(TestState, name="teststate"), default=TestState.draft)
|
|
# Assign created_at = Column(DateTime(timezone=True), server_default=func.now())
|
|
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
|
|
|
# ── Red Team fields ─────────────────────────────────────────────
|
|
red_summary = Column(Text, nullable=True)
|
|
# Assign attack_success = Column(Boolean, nullable=True)
|
|
attack_success = Column(Boolean, nullable=True)
|
|
# Assign red_validated_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
red_validated_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
# Assign red_validated_at = Column(DateTime, nullable=True)
|
|
red_validated_at = Column(DateTime, nullable=True)
|
|
# Assign red_validation_status = Column(String, nullable=True) # pending / approved / rejected
|
|
red_validation_status = Column(String, nullable=True) # pending / approved / rejected
|
|
# Assign red_validation_notes = Column(Text, nullable=True)
|
|
red_validation_notes = Column(Text, nullable=True)
|
|
|
|
# ── Blue Team fields ────────────────────────────────────────────
|
|
blue_summary = Column(Text, nullable=True)
|
|
# Assign detection_result = Column(Enum(TestResult, name="testresult"), nullable=True)
|
|
detection_result = Column(Enum(TestResult, name="testresult"), nullable=True)
|
|
# Assign blue_validated_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
blue_validated_by = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
# Assign blue_validated_at = Column(DateTime, nullable=True)
|
|
blue_validated_at = Column(DateTime, nullable=True)
|
|
# Assign blue_validation_status = Column(String, nullable=True) # pending / approved / rejected
|
|
blue_validation_status = Column(String, nullable=True) # pending / approved / rejected
|
|
# Assign blue_validation_notes = Column(Text, nullable=True)
|
|
blue_validation_notes = Column(Text, nullable=True)
|
|
|
|
# ── Phase timing fields (for automatic Tempo worklogs) ──────────
|
|
red_started_at = Column(DateTime, nullable=True)
|
|
# Assign blue_started_at = Column(DateTime, nullable=True)
|
|
blue_started_at = Column(DateTime, nullable=True)
|
|
# Assign paused_at = Column(DateTime, nullable=True)
|
|
paused_at = Column(DateTime, nullable=True)
|
|
# Assign red_paused_seconds = Column(Integer, default=0)
|
|
red_paused_seconds = Column(Integer, default=0)
|
|
# Assign blue_paused_seconds = Column(Integer, default=0)
|
|
blue_paused_seconds = Column(Integer, default=0)
|
|
|
|
# ── Remediation fields ───────────────────────────────────────────
|
|
remediation_steps = Column(Text, nullable=True)
|
|
# Assign remediation_status = Column(String, nullable=True) # pending / in_progress / completed ...
|
|
remediation_status = Column(String, nullable=True) # pending / in_progress / completed / not_applicable
|
|
# Assign remediation_assignee = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
remediation_assignee = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=True)
|
|
|
|
# ── Re-test fields ────────────────────────────────────────────
|
|
retest_of = Column(UUID(as_uuid=True), ForeignKey("tests.id"), nullable=True)
|
|
# Assign retest_count = Column(Integer, default=0)
|
|
retest_count = Column(Integer, default=0)
|
|
# Assign data_classification = Column(String(20), nullable=False, server_default="internal")
|
|
data_classification = Column(String(20), nullable=False, server_default="internal")
|
|
|
|
# ── Relationships ───────────────────────────────────────────────
|
|
technique = relationship("Technique", back_populates="tests")
|
|
# Assign evidences = relationship("Evidence", back_populates="test")
|
|
evidences = relationship("Evidence", back_populates="test")
|
|
# Assign creator = relationship("User", foreign_keys=[created_by])
|
|
creator = relationship("User", foreign_keys=[created_by])
|
|
# Assign red_validator = relationship("User", foreign_keys=[red_validated_by])
|
|
red_validator = relationship("User", foreign_keys=[red_validated_by])
|
|
# Assign blue_validator = relationship("User", foreign_keys=[blue_validated_by])
|
|
blue_validator = relationship("User", foreign_keys=[blue_validated_by])
|
|
# Assign remediation_user = relationship("User", foreign_keys=[remediation_assignee])
|
|
remediation_user = relationship("User", foreign_keys=[remediation_assignee])
|
|
# Assign original_test = relationship("Test", remote_side="Test.id", foreign_keys=[retest_of])
|
|
original_test = relationship("Test", remote_side="Test.id", foreign_keys=[retest_of])
|
|
# Assign retests = relationship("Test", foreign_keys=[retest_of], back_populates="orig...
|
|
retests = relationship("Test", foreign_keys=[retest_of], back_populates="original_test")
|
|
|
|
# Assign __table_args__ = (
|
|
__table_args__ = (
|
|
Index("ix_tests_technique_id", "technique_id"),
|
|
Index("ix_tests_state", "state"),
|
|
Index("ix_tests_created_at", "created_at"),
|
|
Index("ix_tests_technique_state", "technique_id", "state"),
|
|
Index("ix_tests_state_created_at", "state", "created_at"),
|
|
)
|