doccano/backend/examples/tests/test_document.py

from django.conf import settings
from django.utils.http import urlencode
from rest_framework import status
from rest_framework.reverse import reverse

from api.tests.utils import CRUDMixin
from users.tests.utils import make_user
from projects.models import DOCUMENT_CLASSIFICATION
from projects.tests.utils import assign_user_to_role, prepare_project
from .utils import make_doc, make_example_state


class TestExampleListAPI(CRUDMixin):
    def setUp(self):
        self.project = prepare_project(task=DOCUMENT_CLASSIFICATION)
        self.non_member = make_user()
        self.example = make_doc(self.project.item)
        self.data = {"text": "example"}
        self.url = reverse(viewname="example_list", args=[self.project.item.id])

    def test_allows_project_member_to_list_docs(self):
        for member in self.project.members:
            response = self.assert_fetch(member, status.HTTP_200_OK)
            self.assertEqual(response.data["count"], 1)
            self.assertIn("results", response.data)
            for item in response.data["results"]:
                self.assertIn("text", item)

    def test_denies_non_project_member_to_list_docs(self):
        self.assert_fetch(self.non_member, status.HTTP_403_FORBIDDEN)

    def test_denies_unauthenticated_user_to_list_docs(self):
        self.assert_fetch(expected=status.HTTP_403_FORBIDDEN)

    def test_allows_project_admin_to_create_doc(self):
        response = self.assert_create(self.project.admin, status.HTTP_201_CREATED)
        self.assertEqual(response.data["text"], self.data["text"])

    def test_denies_project_staff_to_create_doc(self):
        for member in self.project.staffs:
            self.assert_create(member, status.HTTP_403_FORBIDDEN)

    def test_denies_unauthenticated_user_to_create_doc(self):
        self.assert_create(expected=status.HTTP_403_FORBIDDEN)

    def test_is_confirmed(self):
        make_example_state(self.example, self.project.admin)
        response = self.assert_fetch(self.project.admin, status.HTTP_200_OK)
        self.assertTrue(response.data["results"][0]["is_confirmed"])

    def test_is_not_confirmed(self):
        response = self.assert_fetch(self.project.admin, status.HTTP_200_OK)
        self.assertFalse(response.data["results"][0]["is_confirmed"])

    def test_does_not_share_another_user_confirmed(self):
        make_example_state(self.example, self.project.admin)
        response = self.assert_fetch(self.project.annotator, status.HTTP_200_OK)
        self.assertFalse(response.data["results"][0]["is_confirmed"])


class TestExampleListCollaborative(CRUDMixin):
    def setUp(self):
        self.project = prepare_project(task=DOCUMENT_CLASSIFICATION)
        self.example = make_doc(self.project.item)
        self.url = reverse(viewname="example_list", args=[self.project.item.id])

    def test_shares_confirmed_in_same_role(self):
        annotator1 = make_user()
        assign_user_to_role(annotator1, self.project.item, settings.ROLE_ANNOTATOR)
        annotator2 = make_user()
        assign_user_to_role(annotator2, self.project.item, settings.ROLE_ANNOTATOR)

        make_example_state(self.example, annotator1)
        response = self.assert_fetch(annotator1, status.HTTP_200_OK)
        self.assertTrue(response.data["results"][0]["is_confirmed"])
        response = self.assert_fetch(annotator2, status.HTTP_200_OK)
        self.assertTrue(response.data["results"][0]["is_confirmed"])

    def test_does_not_share_confirmed_in_other_role(self):
        admin = self.project.admin
        approver = self.project.approver

        make_example_state(self.example, admin)
        response = self.assert_fetch(admin, status.HTTP_200_OK)
        self.assertTrue(response.data["results"][0]["is_confirmed"])
        response = self.assert_fetch(approver, status.HTTP_200_OK)
        self.assertFalse(response.data["results"][0]["is_confirmed"])


class TestExampleListFilter(CRUDMixin):
    def setUp(self):
        self.project = prepare_project(task=DOCUMENT_CLASSIFICATION)
        self.example = make_doc(self.project.item)
        make_example_state(self.example, self.project.admin)

    def reverse(self, query_kwargs=None):
        base_url = reverse(viewname="example_list", args=[self.project.item.id])
        self.url = "{}?{}".format(base_url, urlencode(query_kwargs))

    def assert_filter(self, data, user, expected):
        self.reverse(query_kwargs=data)
        response = self.assert_fetch(user, status.HTTP_200_OK)
        self.assertEqual(response.data["count"], expected)

    def test_returns_example_if_confirmed_is_true(self):
        user = self.project.admin
        self.assert_filter(data={"confirmed": "True"}, user=user, expected=1)

    def test_does_not_return_example_if_confirmed_is_false(self):
        user = self.project.admin
        self.assert_filter(data={"confirmed": "False"}, user=user, expected=0)

    def test_returns_example_if_confirmed_is_empty(self):
        user = self.project.admin
        self.assert_filter(data={"confirmed": ""}, user=user, expected=1)

    def test_does_not_return_example_if_user_is_different(self):
        user = self.project.approver
        self.assert_filter(data={"confirmed": "True"}, user=user, expected=0)

    def test_returns_example_if_user_is_different(self):
        user = self.project.approver
        self.assert_filter(data={"confirmed": "False"}, user=user, expected=1)

    def test_returns_example_if_user_is_different_and_confirmed_is_empty(self):
        user = self.project.approver
        self.assert_filter(data={"confirmed": ""}, user=user, expected=1)


class TestExampleDetail(CRUDMixin):
    def setUp(self):
        self.project = prepare_project(task=DOCUMENT_CLASSIFICATION)
        self.non_member = make_user()
        doc = make_doc(self.project.item)
        self.data = {"text": "example"}
        self.url = reverse(viewname="example_detail", args=[self.project.item.id, doc.id])

    def test_allows_project_member_to_get_doc(self):
        for member in self.project.members:
            response = self.assert_fetch(member, status.HTTP_200_OK)
            self.assertIn("text", response.data)

    def test_denies_non_project_member_to_get_doc(self):
        self.assert_fetch(self.non_member, status.HTTP_403_FORBIDDEN)

    def test_denies_unauthenticated_user_to_get_doc(self):
        self.assert_fetch(expected=status.HTTP_403_FORBIDDEN)

    def test_allows_project_admin_to_update_doc(self):
        response = self.assert_update(self.project.admin, status.HTTP_200_OK)
        self.assertEqual(response.data["text"], self.data["text"])

    def test_denies_project_staff_to_update_doc(self):
        for member in self.project.staffs:
            self.assert_update(member, status.HTTP_403_FORBIDDEN)

    def test_denies_non_project_member_to_update_doc(self):
        self.assert_update(self.non_member, status.HTTP_403_FORBIDDEN)

    def test_allows_project_admin_to_delete_doc(self):
        self.assert_delete(self.project.admin, status.HTTP_204_NO_CONTENT)

    def test_denies_project_staff_to_delete_doc(self):
        for member in self.project.staffs:
            self.assert_delete(member, status.HTTP_403_FORBIDDEN)

    def test_denies_non_project_member_to_delete_doc(self):
        self.assert_delete(self.non_member, status.HTTP_403_FORBIDDEN)