#
# Copyright 2021 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
"""Base errors."""
from typing import Optional
from craft_providers.errors import ProviderError
[docs]class BaseConfigurationError(ProviderError):
"""Error configuring the base."""
[docs]class BaseCompatibilityError(ProviderError):
"""Base configuration compatibility error.
:param reason: Reason for incompatibility.
"""
def __init__(self, reason: str, *, details: Optional[str] = None) -> None:
self.reason = reason
brief = f"Incompatible base detected: {reason}."
resolution = "Clean incompatible instance and retry the requested operation."
super().__init__(brief=brief, details=details, resolution=resolution)
[docs]class NetworkError(ProviderError):
"""Network error when configuring the base."""
def __init__(self) -> None:
brief = "A network related operation failed in a context of no network access."
# XXX Facundo 2022-12-13: need to improve the URL here once
# we have the online docs updated
resolution = (
"Verify that the environment has internet connectivity; "
"see https://craft-providers.readthedocs.io/ for further reference."
)
super().__init__(brief=brief, resolution=resolution)