Modernize MOTD app

Update API code to use viewsets. Update links and URLs to use
keyword arguments.

Signed-off-by: Roberto Rosario <Roberto.Rosario@mayan-edms.com>
This commit is contained in:
Roberto Rosario
2019-01-19 01:00:58 -04:00
parent 9ed93b54af
commit 16d8fb9fea
13 changed files with 281 additions and 120 deletions
+4 -4
View File
@@ -1,6 +1,6 @@
from __future__ import unicode_literals
TEST_LABEL = 'test label'
TEST_LABEL_EDITED = 'test label edited'
TEST_MESSAGE = 'test message'
TEST_MESSAGE_EDITED = 'test message edited'
TEST_MESSAGE_LABEL = 'test label'
TEST_MESSAGE_LABEL_EDITED = '{} edited'.format(TEST_MESSAGE_LABEL)
TEST_MESSAGE_TEXT = 'test message'
TEST_MESSAGE_TEXT_EDITED = '{} edited'.format(TEST_MESSAGE_TEXT)
+41
View File
@@ -0,0 +1,41 @@
from __future__ import unicode_literals
from ..models import Message
from .literals import (
TEST_MESSAGE_LABEL, TEST_MESSAGE_LABEL_EDITED, TEST_MESSAGE_TEXT,
TEST_MESSAGE_TEXT_EDITED
)
class MOTDTestMixin(object):
def _create_test_message(self):
self.test_message = Message.objects.create(
label=TEST_MESSAGE_LABEL, message=TEST_MESSAGE_TEXT
)
def _request_message_create_view(self):
return self.post(
viewname='motd:message_create', data={
'label': TEST_MESSAGE_LABEL, 'message': TEST_MESSAGE_TEXT
}
)
def _request_message_delete_view(self):
return self.post(
viewname='motd:message_delete',
kwargs={'message_id': self.test_message.pk}
)
def _request_message_edit_view(self):
return self.post(
viewname='motd:message_edit',
kwargs={'message_id': self.test_message.pk},
data={
'label': TEST_MESSAGE_LABEL_EDITED,
'message': TEST_MESSAGE_TEXT_EDITED
}
)
def _request_message_list_view(self):
return self.get(viewname='motd:message_list')
+47 -49
View File
@@ -11,24 +11,18 @@ from ..permissions import (
)
from .literals import (
TEST_LABEL, TEST_LABEL_EDITED, TEST_MESSAGE, TEST_MESSAGE_EDITED
TEST_MESSAGE_LABEL, TEST_MESSAGE_LABEL_EDITED, TEST_MESSAGE_TEXT,
TEST_MESSAGE_TEXT_EDITED
)
from .mixins import MOTDTestMixin
class MOTDAPITestCase(BaseAPITestCase):
def setUp(self):
super(MOTDAPITestCase, self).setUp()
self.login_user()
def _create_message(self):
return Message.objects.create(
label=TEST_LABEL, message=TEST_MESSAGE
)
class MOTDAPITestCase(MOTDTestMixin, BaseAPITestCase):
def _request_message_create_view(self):
return self.post(
viewname='rest_api:message-list', data={
'label': TEST_LABEL, 'message': TEST_MESSAGE
'label': TEST_MESSAGE_LABEL,
'message': TEST_MESSAGE_TEXT
}
)
@@ -44,103 +38,107 @@ class MOTDAPITestCase(BaseAPITestCase):
message = Message.objects.first()
self.assertEqual(response.data['id'], message.pk)
self.assertEqual(response.data['label'], TEST_LABEL)
self.assertEqual(response.data['message'], TEST_MESSAGE)
self.assertEqual(response.data['label'], TEST_MESSAGE_LABEL)
self.assertEqual(response.data['message'], TEST_MESSAGE_TEXT)
self.assertEqual(Message.objects.count(), 1)
self.assertEqual(message.label, TEST_LABEL)
self.assertEqual(message.message, TEST_MESSAGE)
self.assertEqual(message.label, TEST_MESSAGE_LABEL)
self.assertEqual(message.message, TEST_MESSAGE_TEXT)
def _request_message_delete_view(self):
return self.delete(
viewname='rest_api:message-detail', args=(self.message.pk,)
viewname='rest_api:message-detail',
kwargs={'message_id': self.test_message.pk},
)
def test_message_delete_view_no_access(self):
self.message = self._create_message()
self._create_test_message()
response = self._request_message_delete_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
self.assertEqual(Message.objects.count(), 1)
def test_message_delete_view_with_access(self):
self.message = self._create_message()
self.grant_access(permission=permission_message_delete, obj=self.message)
self._create_test_message()
self.grant_access(permission=permission_message_delete, obj=self.test_message)
response = self._request_message_delete_view()
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
self.assertEqual(Message.objects.count(), 0)
def _request_message_detail_view(self):
return self.get(
viewname='rest_api:message-detail', args=(self.message.pk,)
viewname='rest_api:message-detail',
kwargs={'message_id': self.test_message.pk},
)
def test_message_detail_view_no_access(self):
self.message = self._create_message()
self._create_test_message()
response = self._request_message_detail_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
def test_message_detail_view_with_access(self):
self.message = self._create_message()
self.grant_access(permission=permission_message_view, obj=self.message)
self._create_test_message()
self.grant_access(permission=permission_message_view, obj=self.test_message)
response = self._request_message_detail_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data['label'], TEST_LABEL)
self.assertEqual(response.data['label'], TEST_MESSAGE_LABEL)
def _request_message_edit_via_patch_view(self):
return self.patch(
viewname='rest_api:message-detail', args=(self.message.pk,),
viewname='rest_api:message-detail',
kwargs={'message_id': self.test_message.pk},
data={
'label': TEST_LABEL_EDITED,
'message': TEST_MESSAGE_EDITED
'label': TEST_MESSAGE_LABEL_EDITED,
'message': TEST_MESSAGE_TEXT_EDITED
}
)
def test_message_edit_via_patch_view_no_access(self):
self.message = self._create_message()
self._create_test_message()
response = self._request_message_edit_via_patch_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
self.message.refresh_from_db()
self.test_message.refresh_from_db()
self.assertEqual(self.message.label, TEST_LABEL)
self.assertEqual(self.message.message, TEST_MESSAGE)
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL)
self.assertEqual(self.test_message.message, TEST_MESSAGE_TEXT)
def test_message_edit_via_patch_view_with_access(self):
self.message = self._create_message()
self.grant_access(permission=permission_message_edit, obj=self.message)
self._create_test_message()
self.grant_access(permission=permission_message_edit, obj=self.test_message)
response = self._request_message_edit_via_patch_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.message.refresh_from_db()
self.assertEqual(self.message.label, TEST_LABEL_EDITED)
self.assertEqual(self.message.message, TEST_MESSAGE_EDITED)
self.test_message.refresh_from_db()
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL_EDITED)
self.assertEqual(self.test_message.message, TEST_MESSAGE_TEXT_EDITED)
def _request_message_edit_via_put_view(self):
return self.put(
viewname='rest_api:message-detail', args=(self.message.pk,),
viewname='rest_api:message-detail',
kwargs={'message_id': self.test_message.pk},
data={
'label': TEST_LABEL_EDITED,
'message': TEST_MESSAGE_EDITED
'label': TEST_MESSAGE_LABEL_EDITED,
'message': TEST_MESSAGE_TEXT_EDITED
}
)
def test_message_edit_via_put_view_no_access(self):
self.message = self._create_message()
self._create_test_message()
response = self._request_message_edit_via_put_view()
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
self.message.refresh_from_db()
self.test_message.refresh_from_db()
self.assertEqual(self.message.label, TEST_LABEL)
self.assertEqual(self.message.message, TEST_MESSAGE)
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL)
self.assertEqual(self.test_message.message, TEST_MESSAGE_TEXT)
def test_message_edit_via_put_view_with_access(self):
self.message = self._create_message()
self.grant_access(permission=permission_message_edit, obj=self.message)
self._create_test_message()
self.grant_access(permission=permission_message_edit, obj=self.test_message)
response = self._request_message_edit_via_put_view()
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.message.refresh_from_db()
self.assertEqual(self.message.label, TEST_LABEL_EDITED)
self.assertEqual(self.message.message, TEST_MESSAGE_EDITED)
self.test_message.refresh_from_db()
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL_EDITED)
self.assertEqual(self.test_message.message, TEST_MESSAGE_TEXT_EDITED)
+11 -13
View File
@@ -7,14 +7,12 @@ from django.utils import timezone
from ..models import Message
from .literals import TEST_LABEL, TEST_MESSAGE
from .mixins import MOTDTestMixin
class MOTDTestCase(TestCase):
class MOTDTestCase(MOTDTestMixin, TestCase):
def setUp(self):
self.motd = Message.objects.create(
label=TEST_LABEL, message=TEST_MESSAGE
)
self._create_test_message()
def test_basic(self):
queryset = Message.objects.get_for_now()
@@ -22,25 +20,25 @@ class MOTDTestCase(TestCase):
self.assertEqual(queryset.exists(), True)
def test_start_datetime(self):
self.motd.start_datetime = timezone.now() - timedelta(days=1)
self.motd.save()
self.test_message.start_datetime = timezone.now() - timedelta(days=1)
self.test_message.save()
queryset = Message.objects.get_for_now()
self.assertEqual(queryset.first(), self.motd)
self.assertEqual(queryset.first(), self.test_message)
def test_end_datetime(self):
self.motd.start_datetime = timezone.now() - timedelta(days=2)
self.motd.end_datetime = timezone.now() - timedelta(days=1)
self.motd.save()
self.test_message.start_datetime = timezone.now() - timedelta(days=2)
self.test_message.end_datetime = timezone.now() - timedelta(days=1)
self.test_message.save()
queryset = Message.objects.get_for_now()
self.assertEqual(queryset.exists(), False)
def test_enable(self):
self.motd.enabled = False
self.motd.save()
self.test_message.enabled = False
self.test_message.save()
queryset = Message.objects.get_for_now()
+100
View File
@@ -0,0 +1,100 @@
from __future__ import unicode_literals
from django.utils.encoding import force_text
from mayan.apps.common.tests import GenericViewTestCase
from ..models import Message
from ..permissions import (
permission_message_create, permission_message_delete,
permission_message_edit, permission_message_view
)
from .literals import (
TEST_MESSAGE_LABEL, TEST_MESSAGE_LABEL_EDITED, TEST_MESSAGE_TEXT,
TEST_MESSAGE_TEXT_EDITED
)
from .mixins import MOTDTestMixin
class MOTDViewTestCase(MOTDTestMixin, GenericViewTestCase):
def test_message_create_view_no_permissions(self):
response = self._request_message_create_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(Message.objects.count(), 0)
def test_message_create_view_with_permissions(self):
self.grant_permission(permission=permission_message_create)
response = self._request_message_create_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(Message.objects.count(), 1)
message = Message.objects.first()
self.assertEqual(message.label, TEST_MESSAGE_LABEL)
self.assertEqual(message.message, TEST_MESSAGE_TEXT)
def test_message_delete_view_no_permissions(self):
self._create_test_message()
response = self._request_message_delete_view()
self.assertEqual(response.status_code, 404)
self.assertEqual(Message.objects.count(), 1)
def test_message_delete_view_with_access(self):
self._create_test_message()
self.grant_access(
obj=self.test_message, permission=permission_message_delete
)
response = self._request_message_delete_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(Message.objects.count(), 0)
def test_message_edit_view_no_permissions(self):
self._create_test_message()
response = self._request_message_edit_view()
self.assertEqual(response.status_code, 404)
self.test_message.refresh_from_db()
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL)
self.assertEqual(self.test_message.message, TEST_MESSAGE_TEXT)
def test_message_edit_view_with_access(self):
self._create_test_message()
self.grant_access(
obj=self.test_message, permission=permission_message_edit
)
response = self._request_message_edit_view()
self.assertEqual(response.status_code, 302)
self.test_message.refresh_from_db()
self.assertEqual(self.test_message.label, TEST_MESSAGE_LABEL_EDITED)
self.assertEqual(
self.test_message.message, TEST_MESSAGE_TEXT_EDITED
)
def test_message_list_view_no_permissions(self):
self._create_test_message()
response = self._request_message_list_view()
self.assertNotContains(
response=response, text=force_text(self.test_message),
status_code=200
)
def test_message_list_view_with_access(self):
self._create_test_message()
self.grant_access(
obj=self.test_message, permission=permission_message_view
)
response = self._request_message_list_view()
self.assertContains(
response=response, text=force_text(self.test_message),
status_code=200
)