matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Move add_to_class functions to their own module

Browse Source 
* The new module is called methods.py and found on each app.
* Add keyword arguments to add_to_class instances.
* Remove catch all exception handling for the check in and
  check out views.
* Improve checkouts tests code reducing redundant code.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-04-11 18:03:53 -04:00
parent a12c90268f
commit 456c322c19
33 changed files with 375 additions and 338 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mayan/apps/checkouts/tests/mixins.py
+6 -4
View File
@@ -8,11 +8,13 @@ from ..models import DocumentCheckout
class DocumentCheckoutTestMixin(object):
def _checkout_document(self):
def _check_out_document(self, user=None):
if not user:
user = self.user
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
self.test_check_out = DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.user, block_new_version=True
user=user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
mayan/apps/checkouts/tests/test_api.py
+18 -27
View File
@@ -1,10 +1,7 @@
from __future__ import unicode_literals
import datetime
from django.test import override_settings
from django.utils.encoding import force_text
from django.utils.timezone import now
from rest_framework import status
@@ -14,12 +11,14 @@ from mayan.apps.rest_api.tests import BaseAPITestCase
from ..models import DocumentCheckout
from ..permissions import (
permission_document_checkout, permission_document_checkout_detail_view
permission_document_check_out, permission_document_check_out_detail_view
)
from .mixins import DocumentCheckoutTestMixin
@override_settings(OCR_AUTO_OCR=False)
class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
class CheckoutsAPITestCase(DocumentCheckoutTestMixin, DocumentTestMixin, BaseAPITestCase):
def setUp(self):
super(CheckoutsAPITestCase, self).setUp()
self.login_user()
@@ -27,32 +26,24 @@ class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
def _request_checkedout_document_view(self):
return self.get(
viewname='rest_api:checkedout-document-view',
args=(self.checkout.pk,)
)
def _checkout_document(self):
expiration_datetime = now() + datetime.timedelta(days=1)
self.checkout = DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
args=(self.test_check_out.pk,)
)
def test_checkedout_document_view_no_access(self):
self._checkout_document()
self._check_out_document()
response = self._request_checkedout_document_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
def test_checkedout_document_view_with_checkout_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_checkout_detail_view, obj=self.document
permission=permission_document_check_out_detail_view, obj=self.document
)
response = self._request_checkedout_document_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
def test_checkedout_document_view_with_document_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_view, obj=self.document
)
@@ -60,12 +51,12 @@ class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
def test_checkedout_document_view_with_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_view, obj=self.document
)
self.grant_access(
permission=permission_document_checkout_detail_view, obj=self.document
permission=permission_document_check_out_detail_view, obj=self.document
)
response = self._request_checkedout_document_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
@@ -85,7 +76,7 @@ class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
self.assertEqual(DocumentCheckout.objects.count(), 0)
def test_document_checkout_with_access(self):
self.grant_access(permission=permission_document_checkout, obj=self.document)
self.grant_access(permission=permission_document_check_out, obj=self.document)
response = self._request_document_checkout_view()
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
self.assertEqual(
@@ -96,13 +87,13 @@ class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
return self.get(viewname='rest_api:checkout-document-list')
def test_checkout_list_view_no_access(self):
self._checkout_document()
self._check_out_document()
response = self._request_checkout_list_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertNotContains(response=response, text=self.document.uuid)
def test_checkout_list_view_with_document_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_view, obj=self.document
)
@@ -111,21 +102,21 @@ class CheckoutsAPITestCase(DocumentTestMixin, BaseAPITestCase):
self.assertNotContains(response=response, text=self.document.uuid)
def test_checkout_list_view_with_checkout_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_checkout_detail_view, obj=self.document
permission=permission_document_check_out_detail_view, obj=self.document
)
response = self._request_checkout_list_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertNotContains(response=response, text=self.document.uuid)
def test_checkout_list_view_with_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
permission=permission_document_view, obj=self.document
)
self.grant_access(
permission=permission_document_checkout_detail_view, obj=self.document
permission=permission_document_check_out_detail_view, obj=self.document
)
response = self._request_checkout_list_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
mayan/apps/checkouts/tests/test_links.py
+6 -6
View File
@@ -2,9 +2,9 @@ from __future__ import unicode_literals
from mayan.apps.documents.tests import GenericDocumentViewTestCase
from ..links import link_checkout_document, link_checkout_info
from ..links import link_check_out_document, link_check_out_info
from ..permissions import (
permission_document_checkout, permission_document_checkout_detail_view
permission_document_check_out, permission_document_check_out_detail_view
)
from .mixins import DocumentCheckoutTestMixin
@@ -19,7 +19,7 @@ class CheckoutLinksTestCase(DocumentCheckoutTestMixin, GenericDocumentViewTestCa
self.add_test_view(test_object=self.document)
context = self.get_test_view()
context['user'] = self.user
return link_checkout_document.resolve(context=context)
return link_check_out_document.resolve(context=context)
def test_checkout_link_no_access(self):
resolved_link = self._resolve_checkout_link()
@@ -27,7 +27,7 @@ class CheckoutLinksTestCase(DocumentCheckoutTestMixin, GenericDocumentViewTestCa
def test_checkout_link_with_access(self):
self.grant_access(
obj=self.document, permission=permission_document_checkout
obj=self.document, permission=permission_document_check_out
)
resolved_link = self._resolve_checkout_link()
self.assertNotEqual(resolved_link, None)
@@ -36,7 +36,7 @@ class CheckoutLinksTestCase(DocumentCheckoutTestMixin, GenericDocumentViewTestCa
self.add_test_view(test_object=self.document)
context = self.get_test_view()
context['user'] = self.user
return link_checkout_info.resolve(context=context)
return link_check_out_info.resolve(context=context)
def test_checkout_info_link_no_access(self):
resolved_link = self._resolve_checkout_info_link()
@@ -44,7 +44,7 @@ class CheckoutLinksTestCase(DocumentCheckoutTestMixin, GenericDocumentViewTestCa
def test_checkout_info_link_with_access(self):
self.grant_access(
obj=self.document, permission=permission_document_checkout_detail_view
obj=self.document, permission=permission_document_check_out_detail_view
)
resolved_link = self._resolve_checkout_info_link()
self.assertNotEqual(resolved_link, None)
mayan/apps/checkouts/tests/test_models.py
+11 -11
View File
@@ -20,17 +20,17 @@ from ..models import DocumentCheckout, NewVersionBlock
@override_settings(OCR_AUTO_OCR=False)
class DocumentCheckoutTestCase(DocumentTestMixin, BaseTestCase):
def test_document_checkout(self):
def test_document_check_out(self):
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
self.assertTrue(
DocumentCheckout.objects.is_document_checked_out(
DocumentCheckout.objects.is_checked_out(
document=self.document
)
)
@@ -38,7 +38,7 @@ class DocumentCheckoutTestCase(DocumentTestMixin, BaseTestCase):
def test_checkin_in(self):
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
@@ -47,21 +47,21 @@ class DocumentCheckoutTestCase(DocumentTestMixin, BaseTestCase):
self.assertFalse(self.document.is_checked_out())
self.assertFalse(
DocumentCheckout.objects.is_document_checked_out(
DocumentCheckout.objects.is_checked_out(
document=self.document
)
)
def test_double_checkout(self):
def test_double_check_out(self):
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
with self.assertRaises(DocumentAlreadyCheckedOut):
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document,
expiration_datetime=expiration_datetime, user=self.admin_user,
block_new_version=True
@@ -71,10 +71,10 @@ class DocumentCheckoutTestCase(DocumentTestMixin, BaseTestCase):
with self.assertRaises(DocumentNotCheckedOut):
self.document.check_in()
def test_auto_checkin(self):
def test_auto_check_in(self):
expiration_datetime = now() + datetime.timedelta(seconds=.1)
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
@@ -132,7 +132,7 @@ class NewVersionBlockTestCase(DocumentTestMixin, BaseTestCase):
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
DocumentCheckout.objects.check_out_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
mayan/apps/checkouts/tests/test_views.py
+74 -109
View File
@@ -1,23 +1,16 @@
from __future__ import unicode_literals
import datetime
import logging
from django.utils.timezone import now
from mayan.apps.common.literals import TIME_DELTA_UNIT_DAYS
from mayan.apps.documents.tests import GenericDocumentViewTestCase
from mayan.apps.sources.links import link_upload_version
from mayan.apps.user_management.tests.literals import (
TEST_USER_PASSWORD, TEST_USER_USERNAME, TEST_ADMIN_PASSWORD,
TEST_ADMIN_USERNAME,
)
from ..literals import STATE_CHECKED_OUT, STATE_LABELS
from ..models import DocumentCheckout
from ..permissions import (
permission_document_checkin, permission_document_checkin_override,
permission_document_checkout, permission_document_checkout_detail_view
permission_document_check_in, permission_document_check_in_override,
permission_document_check_out, permission_document_check_out_detail_view
)
from .mixins import DocumentCheckoutTestMixin
@@ -28,55 +21,68 @@ class DocumentCheckoutViewTestCase(DocumentCheckoutTestMixin, GenericDocumentVie
super(DocumentCheckoutViewTestCase, self).setUp()
self.login_user()
def _request_document_check_in_view(self):
def _request_document_check_in_get_view(self):
return self.get(
viewname='checkouts:check_in_document', args=(self.document.pk,),
)
def test_check_in_document_get_view_no_permission(self):
self._check_out_document()
response = self._request_document_check_in_get_view()
self.assertContains(
response=response, text=self.document.label, status_code=200
)
self.assertTrue(self.document.is_checked_out())
def test_check_in_document_get_view_with_access(self):
self._check_out_document()
self.grant_access(
obj=self.document, permission=permission_document_check_in
)
response = self._request_document_check_in_get_view()
self.assertContains(
response=response, text=self.document.label, status_code=200
)
self.assertTrue(self.document.is_checked_out())
def _request_document_check_in_post_view(self):
return self.post(
viewname='checkouts:checkin_document', args=(self.document.pk,),
viewname='checkouts:check_in_document', args=(self.document.pk,),
)
def test_checkin_document_view_no_permission(self):
expiration_datetime = now() + datetime.timedelta(days=1)
def test_check_in_document_post_view_no_permission(self):
self._check_out_document()
DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
response = self._request_document_check_in_view()
response = self._request_document_check_in_post_view()
self.assertEquals(response.status_code, 403)
self.assertTrue(self.document.is_checked_out())
def test_checkin_document_view_with_access(self):
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
def test_check_in_document_post_view_with_access(self):
self._check_out_document()
self.grant_access(
obj=self.document, permission=permission_document_checkin
)
self.grant_access(
obj=self.document,
permission=permission_document_checkout_detail_view
obj=self.document, permission=permission_document_check_in
)
response = self._request_document_check_in_view()
response = self._request_document_check_in_post_view()
self.assertEquals(response.status_code, 302)
self.assertFalse(self.document.is_checked_out())
self.assertFalse(
DocumentCheckout.objects.is_document_checked_out(
DocumentCheckout.objects.is_checked_out(
document=self.document
)
)
def _request_document_checkout_view(self):
return self.post(
viewname='checkouts:checkout_document', args=(self.document.pk,),
viewname='checkouts:check_out_document', args=(self.document.pk,),
data={
'expiration_datetime_0': 2,
'expiration_datetime_1': TIME_DELTA_UNIT_DAYS,
@@ -84,55 +90,57 @@ class DocumentCheckoutViewTestCase(DocumentCheckoutTestMixin, GenericDocumentVie
}
)
def test_checkout_document_view_no_permission(self):
def test_check_out_document_view_no_permission(self):
response = self._request_document_checkout_view()
self.assertEquals(response.status_code, 403)
self.assertFalse(self.document.is_checked_out())
def test_checkout_document_view_with_access(self):
def test_check_out_document_view_with_access(self):
self.grant_access(
obj=self.document, permission=permission_document_checkout
obj=self.document, permission=permission_document_check_out
)
self.grant_access(
obj=self.document,
permission=permission_document_checkout_detail_view
permission=permission_document_check_out_detail_view
)
response = self._request_document_checkout_view()
self.assertEquals(response.status_code, 302)
self.assertTrue(self.document.is_checked_out())
def _request_checkout_detail_view(self):
def _request_check_out_detail_view(self):
return self.get(
viewname='checkouts:checkout_info', args=(self.document.pk,),
viewname='checkouts:check_out_info', args=(self.document.pk,),
)
def test_checkout_detail_view_no_permission(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
obj=self.document,
permission=permission_document_checkout
permission=permission_document_check_out
)
response = self._request_checkout_detail_view()
response = self._request_check_out_detail_view()
self.assertNotContains(
response, text=STATE_LABELS[STATE_CHECKED_OUT], status_code=403
)
def test_checkout_detail_view_with_access(self):
self._checkout_document()
self._check_out_document()
self.grant_access(
obj=self.document,
permission=permission_document_checkout_detail_view
permission=permission_document_check_out_detail_view
)
response = self._request_checkout_detail_view()
response = self._request_check_out_detail_view()
self.assertContains(response, text=STATE_LABELS[STATE_CHECKED_OUT], status_code=200)
self.assertContains(
response, text=STATE_LABELS[STATE_CHECKED_OUT], status_code=200
)
def test_document_new_version_after_checkout(self):
def test_document_new_version_after_check_out(self):
"""
Gitlab issue #231
User shown option to upload new version of a document even though it
@@ -142,18 +150,9 @@ class DocumentCheckoutViewTestCase(DocumentCheckoutTestMixin, GenericDocumentVie
- Link to upload version view should not resolve
- Upload version view should reject request
"""
self.login(
username=TEST_ADMIN_USERNAME, password=TEST_ADMIN_PASSWORD
)
self._check_out_document()
expiration_datetime = now() + datetime.timedelta(days=1)
DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
self.login_admin_user()
response = self.post(
'sources:upload_version', args=(self.document.pk,),
@@ -184,30 +183,15 @@ class DocumentCheckoutViewTestCase(DocumentCheckoutTestMixin, GenericDocumentVie
# Silence unrelated logging
logging.getLogger('navigation.classes').setLevel(logging.CRITICAL)
expiration_datetime = now() + datetime.timedelta(days=1)
self._check_out_document(user=self.admin_user)
DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
)
self.assertTrue(self.document.is_checked_out())
self.login(
username=TEST_USER_USERNAME, password=TEST_USER_PASSWORD
)
self.role.permissions.add(
permission_document_checkin.stored_permission
)
self.role.permissions.add(
permission_document_checkout.stored_permission
self.grant_access(
obj=self.document, permission=permission_document_check_in
)
response = self.post(
'checkouts:checkin_document', args=(self.document.pk,), follow=True
'checkouts:check_in_document', args=(self.document.pk,)
)
self.assertContains(
response, text='Insufficient permissions', status_code=403
)
@@ -215,37 +199,18 @@ class DocumentCheckoutViewTestCase(DocumentCheckoutTestMixin, GenericDocumentVie
self.assertTrue(self.document.is_checked_out())
def test_forcefull_check_in_document_view_with_permission(self):
expiration_datetime = now() + datetime.timedelta(days=1)
self._check_out_document(user=self.admin_user)
DocumentCheckout.objects.checkout_document(
document=self.document, expiration_datetime=expiration_datetime,
user=self.admin_user, block_new_version=True
self.grant_access(
obj=self.document, permission=permission_document_check_in
)
self.grant_access(
obj=self.document, permission=permission_document_check_in_override
)
self.assertTrue(self.document.is_checked_out())
self.login(
username=TEST_USER_USERNAME, password=TEST_USER_PASSWORD
)
self.role.permissions.add(
permission_document_checkin.stored_permission
)
self.role.permissions.add(
permission_document_checkin.stored_permission
)
self.role.permissions.add(
permission_document_checkin_override.stored_permission
)
self.role.permissions.add(
permission_document_checkout_detail_view.stored_permission
)
response = self.post(
'checkouts:checkin_document', args=(self.document.pk,), follow=True
)
self.assertContains(
response, text='hecked in successfully', status_code=200
'checkouts:check_in_document', args=(self.document.pk,)
)
self.assertEqual(response.status_code, 302)
self.assertFalse(self.document.is_checked_out())