authentik/passbook/policies/dummy/models.py

"""Dummy policy"""
from random import SystemRandom
from time import sleep
from typing import Type

from django.db import models
from django.forms import ModelForm
from django.utils.translation import gettext_lazy as _
from rest_framework.serializers import BaseSerializer
from structlog import get_logger

from passbook.policies.models import Policy
from passbook.policies.types import PolicyRequest, PolicyResult

LOGGER = get_logger()


class DummyPolicy(Policy):
    """Policy used for debugging the PolicyEngine. Returns a fixed result,
    but takes a random time to process."""

    __debug_only__ = True

    result = models.BooleanField(default=False)
    wait_min = models.IntegerField(default=5)
    wait_max = models.IntegerField(default=30)

    @property
    def serializer(self) -> BaseSerializer:
        from passbook.policies.dummy.api import DummyPolicySerializer

        return DummyPolicySerializer

    def form(self) -> Type[ModelForm]:
        from passbook.policies.dummy.forms import DummyPolicyForm

        return DummyPolicyForm

    def passes(self, request: PolicyRequest) -> PolicyResult:
        """Wait random time then return result"""
        wait = SystemRandom().randrange(self.wait_min, self.wait_max)
        LOGGER.debug("Policy waiting", policy=self, delay=wait)
        sleep(wait)
        return PolicyResult(self.result, "dummy")

    class Meta:

        verbose_name = _("Dummy Policy")
        verbose_name_plural = _("Dummy Policies")