744047234

Build Type

push

github

Committed by Dylan Verheul

Commit Message

Add tests for messages

Run Details

20 of 28 branches covered (71.43%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 1 file covered. (100.0%)

10 existing lines in 2 files now uncovered.

119 of 130 relevant lines covered (91.54%)

3.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.0

/src/django_marina/db/models.py

from django.core.exceptions import PermissionDenied
from django.utils.translation import gettext_lazy


class ProtectedModelMixin:
    """
    Add checks to update and delete methods of an instance.

    The use case is to protect against changes when update or delete is allowed for a user (superuser, admin or
    otherwise), but should not be executed because of objects that depend on this instance. In such a case, the foreign
    key relation to the model might benefit from `on_delete=models.PROTECT`.
    """

    # Default message shown to user when object has update protection.
    update_protection_message = gettext_lazy("This object has update protection.")

    # Default message shown to user when object has delete protection.
    delete_protection_message = gettext_lazy("This object has delete protection.")

    @property
    def has_update_protection(self):
        """Return whether this object has update protection."""
        return False

    def get_update_protection_message(self):
        """Return message shown to user when object has update protection."""
        return self.update_protection_message

    def update(self, *args, **kwargs):
        """Update the instance, unless it has update protection."""
        if self.has_update_protection:
            raise PermissionDenied(self.get_update_protection_message())
        return super().update(*args, **kwargs)

    @property
    def has_delete_protection(self):
        """Return whether this object has delete protection."""
        return False

    def get_delete_protection_message(self):
        """Return message shown to user when object has delete protection."""
        return self.delete_protection_message

    def delete(self, *args, **kwargs):
        """Delete the instance, unlessit has delete protection."""
        if self.has_delete_protection:
            raise PermissionDenied(self.get_delete_protection_message())
        return super().delete(*args, **kwargs)

1	from django.core.exceptions import PermissionDenied	4✔
2	from django.utils.translation import gettext_lazy	4✔
3
4
5	class ProtectedModelMixin:	4✔
6	"""
7	Add checks to update and delete methods of an instance.
8
9	The use case is to protect against changes when update or delete is allowed for a user (superuser, admin or
10	otherwise), but should not be executed because of objects that depend on this instance. In such a case, the foreign
11	key relation to the model might benefit from `on_delete=models.PROTECT`.
12	"""
13
14	# Default message shown to user when object has update protection.
15	update_protection_message = gettext_lazy("This object has update protection.")	4✔
16
17	# Default message shown to user when object has delete protection.
18	delete_protection_message = gettext_lazy("This object has delete protection.")	4✔
19
20	@property	4✔
21	def has_update_protection(self):	2✔
22	"""Return whether this object has update protection."""
UNCOV 23	return False	×
24
25	def get_update_protection_message(self):	4✔
26	"""Return message shown to user when object has update protection."""
UNCOV 27	return self.update_protection_message	×
28
29	def update(self, args, *kwargs):	4✔
30	"""Update the instance, unless it has update protection."""
UNCOV 31	if self.has_update_protection:	×
UNCOV 32	raise PermissionDenied(self.get_update_protection_message())	×
UNCOV 33	return super().update(args, *kwargs)	×
34
35	@property	4✔
36	def has_delete_protection(self):	2✔
37	"""Return whether this object has delete protection."""
38	return False	4✔
39
40	def get_delete_protection_message(self):	4✔
41	"""Return message shown to user when object has delete protection."""
42	return self.delete_protection_message	4✔
43
44	def delete(self, args, *kwargs):	4✔
45	"""Delete the instance, unlessit has delete protection."""
46	if self.has_delete_protection:	4✔
47	raise PermissionDenied(self.get_delete_protection_message())	4✔
48	return super().delete(args, *kwargs)	4✔

zostera / django-marina / 744047234

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous