schema.py

# Copyright 2023 Canonical
# See LICENSE file for licensing details.
"""This file defines the schemas for the provider and requirer sides of the ingress interface.

It exposes two interfaces.schema_base.DataBagSchema subclasses called:
- ProviderSchema
- RequirerSchema

Examples:
    ProviderSchema:
        unit: <empty>
        app: {"ingress":
                 {"url":  "http://foo.bar:80/model_name-app_name"}
             }

    RequirerSchema:
        unit: {
              "name": "app-name",
              "host": "hostname"
              }
        app: {
              "port": 4242,
              "model": "model-name"
              }
"""
import json

import yaml
from pydantic import BaseModel, AnyHttpUrl, validator, Field, Json

from interface_tester.schema_base import DataBagSchema


class Url(BaseModel):
    url: AnyHttpUrl


class MyProviderData(BaseModel):
    ingress: Json[Url]


class ProviderSchema(DataBagSchema):
    """Provider schema for Ingress."""
    app: MyProviderData


class IngressRequirerAppData(BaseModel):
    model: Json[str] = Field(description="The model the application is in.")
    port: Json[int] = Field(description="The port the unit wishes to be exposed. Stringified int.")
    name: Json[str] = Field(description="The name of the application requesting ingress.")


class IngressRequirerUnitData(BaseModel):
    host: Json[str] = Field(description="Unit hostname to be exposed.")



class RequirerSchema(DataBagSchema):
    """Requirer schema for Ingress."""
    app: IngressRequirerAppData
    unit: IngressRequirerUnitData