django-model-utils/tests/test_models/test_softdeletable_model.py

from __future__ import annotations

from django.test import TestCase
from django.utils.connection import ConnectionDoesNotExist

from tests.models import SoftDeletable


class SoftDeletableModelTests(TestCase):
    def test_can_only_see_not_removed_entries(self) -> None:
        SoftDeletable.available_objects.create(name='a', is_removed=True)  # type: ignore[misc]
        SoftDeletable.available_objects.create(name='b', is_removed=False)  # type: ignore[misc]

        queryset = SoftDeletable.available_objects.all()

        self.assertEqual(queryset.count(), 1)
        self.assertEqual(queryset[0].name, 'b')  # type: ignore[attr-defined]

    def test_instance_cannot_be_fully_deleted(self) -> None:
        instance = SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]

        instance.delete()

        self.assertEqual(SoftDeletable.available_objects.count(), 0)
        self.assertEqual(SoftDeletable.all_objects.count(), 1)

    def test_instance_cannot_be_fully_deleted_via_queryset(self) -> None:
        SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]

        SoftDeletable.available_objects.all().delete()

        self.assertEqual(SoftDeletable.available_objects.count(), 0)
        self.assertEqual(SoftDeletable.all_objects.count(), 1)

    def test_delete_instance_no_connection(self) -> None:
        obj = SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]

        self.assertRaises(ConnectionDoesNotExist, obj.delete, using='other')

    def test_instance_purge(self) -> None:
        instance = SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]

        instance.delete(soft=False)

        self.assertEqual(SoftDeletable.available_objects.count(), 0)
        self.assertEqual(SoftDeletable.all_objects.count(), 0)

    def test_instance_purge_no_connection(self) -> None:
        instance = SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]

        self.assertRaises(ConnectionDoesNotExist, instance.delete,
                          using='other', soft=False)

    def test_deprecation_warning(self) -> None:
        self.assertWarns(DeprecationWarning, SoftDeletable.objects.all)

    def test_delete_queryset_return(self) -> None:
        SoftDeletable.available_objects.create(name='a')  # type: ignore[misc]
        SoftDeletable.available_objects.create(name='b')  # type: ignore[misc]

        result = SoftDeletable.available_objects.filter(name="a").delete()  # type: ignore[misc]

        assert result == (
            1, {SoftDeletable._meta.label: 1}
        )