types.py

from __future__ import annotations

from typing import Generic, Literal, TypeVar
from pydantic.config import BaseConfig
from pydantic.generics import GenericModel
from pydantic import UUID4, BaseModel

from intent_deployer.state_track import ActiveIntent


class APIResponseStatus(BaseModel):
    code: int
    details: str


class APIResponse(BaseModel):
    status: APIResponseStatus


class CreatedIntentResponse(APIResponse):
    intent_id: UUID4

class ListIntentResponse(APIResponse):
    intents: list[ActiveIntent]

class GetIntentResponse(APIResponse):
    intent: ActiveIntent

class NileIntentRequest(BaseModel):
    type: Literal["nile"]
    intent: str


# @simmsb: I don't think this is acutually used any more
class Policy(BaseModel):
    """A policy with the onos-reroute-api"""
    api_key: str

    class Config(BaseConfig):
        allow_mutation = False

    # class Config:
    #     # needed, otherwise when we cast subclasses of 'Policy' to 'Policy' when
    #     # constructing a 'DeployResponse' we lose the extra fields
    #     extra = "allow"


# PolicyT is covariant, we can view a F[subtype(Policy)] as an F[Policy]
PolicyT = TypeVar("PolicyT", bound=Policy, covariant=True)


class DeployResponseOutput(GenericModel, Generic[PolicyT]):
    type: str
    policy: PolicyT


class DeployResponse(APIResponse, GenericModel, Generic[PolicyT]):
    input: NileIntentRequest
    output: DeployResponseOutput[PolicyT]


class IntentDeployException(Exception):
    """Exceptions raised by our application that are safe to expose to users."""

    pass