# Copyright 2015 Huawei Technologies Co., Ltd.
# Copyright 2015 Ericsson AB.
# All Rights Reserved.
#
#    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.
#
# Copyright (c) 2020-2023 Wind River Systems, Inc.
#

"""
DC Orchestrator base exception handling.
"""
import six

from oslo_utils import encodeutils
from oslo_utils import excutils

from dcorch.common.i18n import _


class DCCommonException(Exception):
    """Base Commond Driver Exception.

    To correctly use this class, inherit from it and define
    a 'message' property. That message will get printf'd
    with the keyword arguments provided to the constructor.
    """

    message = _("An unknown exception occurred.")

    def __init__(self, **kwargs):
        try:
            super(DCCommonException, self).__init__(self.message % kwargs)  # pylint: disable=W1645
            self.msg = self.message % kwargs  # pylint: disable=W1645
        except Exception:
            with excutils.save_and_reraise_exception() as ctxt:
                if not self.use_fatal_exceptions():
                    ctxt.reraise = False
                    # at least get the core message out if something happened
                    super(DCCommonException, self).__init__(self.message)  # pylint: disable=W1645

    if six.PY2:
        def __unicode__(self):
            return encodeutils.exception_to_unicode(self.msg)

    def use_fatal_exceptions(self):
        return False


class NotFound(DCCommonException):
    pass


class Forbidden(DCCommonException):
    message = _("Requested API is forbidden")


class Conflict(DCCommonException):
    pass


class ServiceUnavailable(DCCommonException):
    message = _("The service is unavailable")


class InvalidInputError(DCCommonException):
    message = _("An invalid value was provided")


class InternalError(DCCommonException):
    message = _("Error when performing operation")


class ProjectNotFound(NotFound):
    message = _("Project %(project_id)s doesn't exist")


class OAMAddressesNotFound(NotFound):
    message = _("OAM Addresses Not Found")


class CertificateNotFound(NotFound):
    message = _("Certificate in region=%(region_name)s with signature "
                "%(signature)s not found")


class LoadNotFound(NotFound):
    message = _("Load in region=%(region_name)s with id %(load_id)s not found")


class LoadNotInVault(NotFound):
    message = _("Load at path %(path)s not found")


class LoadMaxReached(Conflict):
    message = _("Load in region=%(region_name)s at maximum number of loads")


class PlaybookExecutionFailed(DCCommonException):
    message = _("Playbook execution failed, command=%(playbook_cmd)s")


class PlaybookExecutionTimeout(PlaybookExecutionFailed):
    message = _("Playbook execution failed [TIMEOUT (%(timeout)s)], "
                "command=%(playbook_cmd)s")


class ImageNotInLocalRegistry(NotFound):
    message = _("Image %(image_name)s:%(image_tag)s not found in the local registry. "
                "Please check with command: system registry-image-list or "
                "system registry-image-tags %(image_name)s")


class ApiException(DCCommonException):
    message = _("%(endpoint)s failed with status code: %(rc)d")


class SubcloudNotFound(NotFound):
    message = _("Subcloud %(subcloud_ref)s not found")


class SubcloudPeerGroupNotFound(NotFound):
    message = _("Subcloud Peer Group %(peer_group_ref)s not found")


class SubcloudPeerGroupDeleteFailedAssociated(DCCommonException):
    message = _("Subcloud Peer Group %(peer_group_ref)s delete failed "
                "cause it is associated with a system peer.")


class RvmcException(Exception):
    def __init__(self, message=None):
        super(RvmcException, self).__init__(message)


class RvmcExit(DCCommonException):
    message = _("Rvmc failed with status code: %(rc)d")