#######################################################################################
# Copyright ETSI Contributors and Others.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#######################################################################################

from abc import abstractmethod
from dataclasses import dataclass

from osm_common.temporal.workflows.base import BaseWorkflow


class VnfInstantiateWorkflow(BaseWorkflow):
    """Instantiate a VNF.

    Workflow Identifier:
        It is recommended that the ID for the VNF is referred as a workflow
        ID when invoking this workflow.
    """

    @dataclass
    class Input:
        """
        Input dataclass for workflow that instantiates a VNF.

        Attributes:
        -----------
        vnfr_uuid : str
            The UUID of the VNF which is stored in the OSM vnfrs
            collection in Mongo.

        model_name: str

        instantiation_config: dict
            The instantiation configuration of the VNF

        """

        vnfr_uuid: str
        model_name: str
        instantiation_config: dict

    @abstractmethod
    async def run(self, workflow_input: Input) -> None:
        pass


class VnfPrepareWorkflow(BaseWorkflow):
    """Prepare a VNF.

    Workflow Identifier:
        It is recommended that the ID for the VNF is referred as a workflow
        ID when invoking this workflow.
    """

    @dataclass
    class Input:
        """
        Input dataclass for workflow that instantiates a VNF.

        Attributes:
        -----------
        vnfr_uuid : str
            The UUID of the VNF which is stored in the OSM vnfrs
            collection in Mongo.

        model_name: str

        """

        vnfr_uuid: str
        model_name: str

    @abstractmethod
    async def run(self, workflow_input: Input) -> None:
        pass


class VnfTerminateWorkflow(BaseWorkflow):
    @dataclass
    class Input:
        """

        Attributes:
        -----------
        vnfr_uuid : str
            The UUID of the VNF which is stored in the OSM vnfrs
            collection in Mongo.
        """

        vnfr_uuid: str

    @abstractmethod
    async def run(self, workflow_input: Input) -> None:
        pass


class VnfDeleteWorkflow(BaseWorkflow):
    """Delete a VNF.

    Workflow Identifier:
        It is recommended that the ID for the VNF is referred as a workflow
        ID when invoking this workflow.
    """

    @dataclass
    class Input:
        """
        Input dataclass for workflow that deletes a VNF.

        Attributes:
        -----------
        vnfr_uuid : str
            The UUID of the VNF which is stored in the OSM vnfrs
            collection in Mongo.

        """

        vnfr_uuid: str

    @abstractmethod
    async def run(self, workflow_input: Input) -> None:
        pass
