Source code for web.mixins.TestActionMixin

# SPDX-License-Identifier: AGPL-3.0-or-later
#
# Eonvelope - a open-source self-hostable email archiving server
# Copyright (C) 2024 David Aderbauer & The Eonvelope Contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

"""Module with :class:`web.mixins.TestActionMixin`."""

from __future__ import annotations

from typing import TYPE_CHECKING

from django.contrib import messages
from django.utils.translation import gettext as _

from core.utils.fetchers.exceptions import FetcherError

if TYPE_CHECKING:
    from django.http import HttpRequest, HttpResponse




class TestActionMixin:
    """Mixin to provide test button handling for views."""



    def handle_test(self, request: HttpRequest) -> HttpResponse:
        """Handler function for the `test` action.

        Args:
            request: The action request to handle.

        Returns:
            A template response with the updated view after the action.
        """
        self.object = self.get_object()
        try:
            self.object.test()
        except ValueError as error:
            messages.error(
                request,
                _(
                    "Test failed, there is something wrong with this objects setup: %(error)s"
                )
                % {"error": str(error)},
            )
        except FetcherError as error:
            messages.error(request, _("Test failed: %(error)s") % {"error": str(error)})
        except Exception as error:
            messages.error(
                request,
                _("Test failed due to an unexpected error: %(error)s")
                % {"error": str(error)},
            )
        else:
            messages.success(request, _("Test was successful"))
        self.object.refresh_from_db()
        return self.get(request)