Merge pull request #16 from GabrielSalla/use-pydantic-dataclass-validation

Use pydantic for dataclass validation

Author: GabrielSalla

Dockerfile

@@ -8,13 +8,15 @@ WORKDIR /app
 RUN apk add curl \
     && python3 -m venv $VIRTUAL_ENV \
     && pip install --upgrade pip \
-    && pip3 install poetry
+    && pip install poetry --no-cache-dir
 
 COPY . /app/
 
-RUN poetry install --no-root --only main
+RUN poetry install --no-root --only main \
+    && poetry cache clear --no-interaction --all .
 
 
 FROM sentinela AS sentinela_dev
 
-RUN poetry install --no-root
+RUN poetry install --no-root \
+    && poetry cache clear --no-interaction --all .

poetry.lock

@@ -17,8 +17,8 @@ alembic = "^1.14.0"
 asyncpg = "^0.30.0"
 certifi = "*"
 croniter = "^5.0.1"
-dataclass-type-validator = "^0.1.2"
 prometheus-client = "^0.21.1"
+pydantic = "^2.10.4"
 python = "^3.12"
 pytz = "*"
 pyyaml = "^6.0.2"

pyproject.toml

@@ -1,8 +1,8 @@
 import logging
 import traceback
 
+import pydantic
 from aiohttp import web
-from dataclass_type_validator import TypeValidationError
 
 import external_requests as external_requests
 from components.monitors_loader import MonitorValidationError
@@ -68,6 +68,8 @@ async def monitor_register(request):
     monitor_code = request_data.get("monitor_code")
     additional_files = request_data.get("additional_files", {})
 
+    error_response: dict[str, str | list]
+
     if monitor_code is None:
         error_response = {
             "status": "error",
@@ -82,11 +84,18 @@ async def monitor_register(request):
         monitor = await external_requests.monitor_register(
             monitor_name, monitor_code, additional_files
         )
-    except TypeValidationError as e:
+    except pydantic.ValidationError as e:
         error_response = {
             "status": "error",
             "message": "Type validation error",
-            "error": e.errors,
+            "error": [
+                {
+                    "loc": list(error["loc"]),
+                    "type": error["type"],
+                    "msg": error["msg"],
+                }
+                for error in e.errors()
+            ],
         }
         return web.json_response(error_response, status=400)
     except MonitorValidationError as e:

src/components/http_server/monitor_routes.py

@@ -1,11 +1,12 @@
 import asyncio
 import logging
 import shutil
-from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
 from typing import Generator, cast
 
+from pydantic.dataclasses import dataclass
+
 import module_loader as module_loader
 import registry as registry
 import utils.app as app

src/components/monitors_loader/monitors_loader.py

@@ -1,12 +1,10 @@
 import os
-from dataclasses import dataclass
 from typing import Any
 
 import yaml
-from dataclass_type_validator import dataclass_validate
+from pydantic.dataclasses import dataclass
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class Configs:
     load_sample_monitors: bool

src/configs/configs.py

@@ -140,14 +140,6 @@ def _check_reaction_functions(reaction_options: ReactionOptions) -> list[str]:
     errors: list[str] = []
 
     for field in ReactionOptions.__dataclass_fields__:
-        if not isinstance(reaction_options[field], list):
-            errors.append(
-                ERROR_FIELD_WRONG_TYPE.format(
-                    display_name=f"reaction_options.{field}", expected_type="list[Coroutine]"
-                )
-            )
-            continue
-
         # Check each item in the reactions list
         for item in reaction_options[field]:
             try:

src/module_loader/checker.py

@@ -1,12 +1,11 @@
-from dataclasses import dataclass, field
+from dataclasses import field
 from typing import Any, Callable, Coroutine
 
-from dataclass_type_validator import dataclass_validate
+from pydantic.dataclasses import dataclass
 
 from configs import configs
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class MonitorOptions:
     """
@@ -24,7 +23,6 @@ class MonitorOptions:
     execution_timeout: int = configs.executor_monitor_timeout
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class IssueOptions:
     """
@@ -42,7 +40,6 @@ class IssueOptions:
     unique: bool = False
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class PriorityLevels:
     """
@@ -64,7 +61,6 @@ def __getitem__(self, name: str):
         return getattr(self, name)
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class AgeRule:
     """
@@ -77,7 +73,6 @@ class AgeRule:
     priority_levels: PriorityLevels
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class CountRule:
     """
@@ -91,7 +86,6 @@ class CountRule:
     priority_levels: PriorityLevels
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class ValueRule:
     """
@@ -110,7 +104,6 @@ class ValueRule:
     priority_levels: PriorityLevels
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class AlertOptions:
     """
@@ -128,7 +121,6 @@ class AlertOptions:
 reaction_function_type = Callable[[dict[str, Any]], Coroutine[Any, Any, Any]]
 
 
-@dataclass_validate(strict=True)
 @dataclass
 class ReactionOptions:
     """

src/options/options.py

@@ -1,11 +1,10 @@
 import json
 import logging
 import os
-from dataclasses import dataclass
 from functools import partial
 from typing import Any, Coroutine
 
-from dataclass_type_validator import dataclass_validate
+from pydantic.dataclasses import dataclass
 from pytz import timezone
 from tabulate import tabulate
 
@@ -31,7 +30,6 @@
 }
 
 
-@dataclass_validate(strict=True)
 @dataclass(kw_only=True)
 class SlackNotification:
     """

src/plugins/slack/notifications/slack_notification.py

@@ -1,7 +1,7 @@
 import os
-from dataclasses import dataclass
 from typing import Any, cast
 
+from pydantic.dataclasses import dataclass
 from slack_sdk.errors import SlackApiError
 from slack_sdk.web.async_client import AsyncSlackResponse, AsyncWebClient