# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Contain definition of backend configuration."""
from pathlib import Path
from typing import Dict
from typing import List
from typing import Literal
from typing import Optional
from typing import Tuple
from typing import TypedDict
from typing import Union


class UserParamConfig(TypedDict, total=False):
    """User parameter configuration."""

    name: Optional[str]
    default_value: str
    values: List[str]
    description: str
    alias: str


UserParamsConfig = Dict[str, List[UserParamConfig]]


class ExecutionConfig(TypedDict, total=False):
    """Execution configuration."""

    commands: Dict[str, List[str]]
    user_params: UserParamsConfig
    build_dir: str
    variables: Dict[str, str]
    lock: bool


class NamedExecutionConfig(ExecutionConfig):
    """Execution configuration with name."""

    name: str


class BaseBackendConfig(ExecutionConfig, total=False):
    """Base backend configuration."""

    name: str
    description: str
    config_location: Path
    annotations: Dict[str, Union[str, List[str]]]


class ApplicationConfig(BaseBackendConfig, total=False):
    """Application configuration."""

    supported_systems: List[str]
    deploy_data: List[Tuple[str, str]]


class ExtendedApplicationConfig(BaseBackendConfig, total=False):
    """Extended application configuration."""

    supported_systems: List[NamedExecutionConfig]
    deploy_data: List[Tuple[str, str]]


class ProtocolConfig(TypedDict, total=False):
    """Protocol config."""

    protocol: Literal["local", "ssh"]


class SSHConfig(ProtocolConfig, total=False):
    """SSH configuration."""

    username: str
    password: str
    hostname: str
    port: str


class LocalProtocolConfig(ProtocolConfig, total=False):
    """Local protocol config."""


class SystemConfig(BaseBackendConfig, total=False):
    """System configuration."""

    data_transfer: Union[SSHConfig, LocalProtocolConfig]
    reporting: Dict[str, Dict]


class ToolConfig(BaseBackendConfig, total=False):
    """Tool configuration."""

    supported_systems: List[str]


class ExtendedToolConfig(BaseBackendConfig, total=False):
    """Extended tool configuration."""

    supported_systems: List[NamedExecutionConfig]


BackendItemConfig = Union[ApplicationConfig, SystemConfig, ToolConfig]
BackendConfig = Union[
    List[ExtendedApplicationConfig], List[SystemConfig], List[ToolConfig]
]