boardwalk (bug): add model field annotations (#60)

Missing annotations lead to runtime errors from Pydantic; also bump Pydantic to v2.

Author: asullivan-blze

VERSION

@@ -1 +1 @@
-0.8.14
+0.8.15

requirements.txt

@@ -3,5 +3,5 @@ ansible-runner >=2.3.0
 click >=8.1.3
 cryptography >=38.0.3
 email-validator >=1.3.0 # Required by pydantic to validate emails using EmailStr
-pydantic >=1.1.275
+pydantic >=2.4.2
 tornado >=6.2

src/boardwalk/host.py

@@ -28,12 +28,12 @@ class Host(BaseModel, extra=Extra.forbid):
     ansible_facts: dict[str, Any]
     name: str
     meta: dict[str, str | int | bool] = {}
-    remote_mutex_path = "/opt/boardwalk.mutex"
-    remote_alert_msg = "ALERT: Boardwalk is running a workflow against this host. Services may be interrupted"
-    remote_alert_string_formatted = f"$(tput -T xterm bold)$(tput -T xterm setaf 1)'{remote_alert_msg}'$(tput -T xterm sgr0)"
-    remote_alert_motd = f"#!/bin/sh\necho {remote_alert_string_formatted}"
-    remote_alert_motd_path = "/etc/update-motd.d/99-boardwalk-alert"
-    remote_alert_wall_cmd = f"wall {remote_alert_string_formatted}"
+    remote_mutex_path: str = "/opt/boardwalk.mutex"
+    remote_alert_msg: str = "ALERT: Boardwalk is running a workflow against this host. Services may be interrupted"
+    remote_alert_string_formatted: str = f"$(tput -T xterm bold)$(tput -T xterm setaf 1)'{remote_alert_msg}'$(tput -T xterm sgr0)"
+    remote_alert_motd: str = f"#!/bin/sh\necho {remote_alert_string_formatted}"
+    remote_alert_motd_path: str = "/etc/update-motd.d/99-boardwalk-alert"
+    remote_alert_wall_cmd: str = f"wall {remote_alert_string_formatted}"
 
     def ansible_run(
         self,

src/boardwalkd/protocol.py

@@ -15,7 +15,7 @@
 from pathlib import Path
 from urllib.parse import urljoin, urlparse
 
-from pydantic import BaseModel, Extra, validator
+from pydantic import BaseModel, Extra, field_validator
 from tornado.httpclient import (
     HTTPClient,
     HTTPClientError,
@@ -64,7 +64,8 @@ def __init__(self, **kwargs: str):
         if not self.create_time:
             self.create_time: datetime | None = datetime.utcnow()
 
-    @validator("severity")
+    @field_validator("severity")
+    @classmethod
     def severity_level(cls, v: str):
         if v not in ["info", "success", "error"]:
             raise ValueError(f"invalid severity level")

src/boardwalkd/state.py

@@ -6,7 +6,7 @@
 from datetime import datetime
 from pathlib import Path
 
-from pydantic import BaseModel, EmailStr, Extra, validator
+from pydantic import BaseModel, EmailStr, Extra, field_validator
 
 from boardwalkd.protocol import WorkspaceDetails, WorkspaceEvent, WorkspaceSemaphores
 
@@ -27,7 +27,8 @@ class User(StateBaseModel):
     email: EmailStr
     roles: set[str] = {"default"}
 
-    @validator("roles")
+    @field_validator("roles")
+    @classmethod
     def validate_roles(cls, input_roles: set[str]):
         for role in input_roles:
             if role not in valid_user_roles:
@@ -46,15 +47,19 @@ class WorkspaceState(StateBaseModel):
     events: deque[WorkspaceEvent] = deque([], maxlen=_max_workspace_events)
     semaphores: WorkspaceSemaphores = WorkspaceSemaphores()
 
-    @validator("events")
+    @field_validator("events")
+    @classmethod
     def validate_events(
         cls, input_events: deque[WorkspaceEvent]
     ) -> deque[WorkspaceEvent]:
         """
         Pydantic won't persist the maxlen argument for deque when cold loading
         from the statefile. This forces events to always be returned with maxlen
         """
-        return deque(input_events, maxlen=cls._max_workspace_events)
+        # TODO: Figure out how to access the value here without using `.default` and needing
+        # to ignore type errors; how do you extract an int from a ModelPrivateAttr?
+        _max_events = cls._max_workspace_events.default  # type: ignore
+        return deque(input_events, maxlen=_max_events)
 
 
 class State(StateBaseModel):