From cb3d244f908a6a953c86d2d6f4fa529ae3093b8f Mon Sep 17 00:00:00 2001 From: Iurii Tatishchev Date: Wed, 19 May 2021 11:37:33 -0700 Subject: [PATCH 1/5] Update requirements --- requirements/common.txt | 15 +++------------ requirements/dev.txt | 6 ++++++ requirements/prod.txt | 2 +- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/requirements/common.txt b/requirements/common.txt index 0bbb21b..7452fc5 100644 --- a/requirements/common.txt +++ b/requirements/common.txt @@ -1,19 +1,10 @@ # Contains requirements common to all environments # Engine -Django==3.1.6 -Pillow==8.1.0 +Django==3.2.3 zenpy~=2.0.24 -django_registration==3.1.1 -djangorestframework==3.12.2 - - -# Documentation -Sphinx==3.4.3 -sphinx-rtd-theme==0.5.1 -sphinx-autodoc-typehints==1.11.1 -pyenchant==3.2.0 -sphinxcontrib-spelling==7.1.0 +django_registration==3.1.2 +djangorestframework==3.12.4 # Misc python-dotenv==0.17.1 diff --git a/requirements/dev.txt b/requirements/dev.txt index 73c27d0..be32176 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -1,3 +1,9 @@ # Development specific dependencies -r common.txt +# Documentation +Sphinx==3.5.4 +sphinx-rtd-theme==0.5.2 +sphinx-autodoc-typehints==1.12.0 +pyenchant==3.2.0 +sphinxcontrib-spelling==7.2.1 diff --git a/requirements/prod.txt b/requirements/prod.txt index b0e6925..479c608 100644 --- a/requirements/prod.txt +++ b/requirements/prod.txt @@ -1,5 +1,5 @@ # Production specific dependencies -r common.txt -daphne==3.0.1 +daphne==3.0.2 Twisted[tls,http2]==21.2.0 From 0a9f57155c51995dc432301184725345766c1e42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A2=D0=B0=D1=82=D0=B8=D1=89=D0=B5=D0=B2=20=D0=AE=D1=80?= =?UTF-8?q?=D0=B8=D0=B9?= Date: Wed, 19 May 2021 22:16:58 +0000 Subject: [PATCH 2/5] =?UTF-8?q?#71=20|=20=D0=A2=D0=B5=D1=81=D1=82=D1=8B=20?= =?UTF-8?q?=D0=9F=D0=BE=D0=BB=D1=83=D1=87=D0=B5=D0=BD=D0=B8=D1=8F=20=D0=9F?= =?UTF-8?q?=D1=80=D0=B0=D0=B2=20=D0=9B=D0=B5=D0=B3=D0=BA=D0=BE=D0=B3=D0=BE?= =?UTF-8?q?=20=D0=90=D0=B3=D0=B5=D0=BD=D1=82=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...est_make_engineer.json => test_users.json} | 2 +- main/tests.py | 263 +++++++++++------- 2 files changed, 170 insertions(+), 95 deletions(-) rename fixtures/{test_make_engineer.json => test_users.json} (98%) diff --git a/fixtures/test_make_engineer.json b/fixtures/test_users.json similarity index 98% rename from fixtures/test_make_engineer.json rename to fixtures/test_users.json index 1154342..d9e164d 100644 --- a/fixtures/test_make_engineer.json +++ b/fixtures/test_users.json @@ -51,7 +51,7 @@ "name": "UserForAccessTest", "user": 2, "role": "agent", - "custom_role_id": "360005209000" + "custom_role_id": "360005208980" } }, { diff --git a/main/tests.py b/main/tests.py index b086488..d1ce390 100644 --- a/main/tests.py +++ b/main/tests.py @@ -13,6 +13,23 @@ import access_controller.settings as sets from main.zendesk_admin import zenpy +class UsersBaseTestCase(TestCase): + """Базовый класс загружения данных для тестов с пользователями""" + fixtures = ['fixtures/test_users.json'] + + def setUp(self): + """Добавление в переменные почт и клиентов для пользователей""" + self.light_agent = '123@test.ru' + self.admin = 'admin@gmail.com' + self.engineer = 'customer@example.com' + self.agent_client = Client() + self.agent_client.force_login(User.objects.get(email=self.light_agent)) + self.admin_client = Client() + self.admin_client.force_login(User.objects.get(email=self.admin)) + self.engineer_client = Client() + self.engineer_client.force_login(User.objects.get(email=self.engineer)) + + class RegistrationTestCase(TestCase): fixtures = ['fixtures/data.json'] @@ -67,55 +84,43 @@ class RegistrationTestCase(TestCase): self.assertTrue(user.has_perm('main.has_control_access')) -class MakeEngineerTestCase(TestCase): - fixtures = ['fixtures/test_make_engineer.json'] - - def setUp(self): - self.light_agent = '123@test.ru' - self.admin = 'admin@gmail.com' - self.engineer = 'customer@example.com' - self.client = Client() - self.client.force_login(User.objects.get(email=self.light_agent)) - self.admin_client = Client() - self.admin_client.force_login(User.objects.get(email=self.admin)) +class MakeEngineerTestCase(UsersBaseTestCase): @patch('main.extra_func.zenpy') - def test_redirect(self, ZenpyMock): + def test_become_engineer_redirect(self, _zenpy_mock): user = User.objects.get(email=self.light_agent) - resp = self.client.post(reverse_lazy('work_become_engineer')) + resp = self.agent_client.post(reverse_lazy('work_become_engineer')) self.assertRedirects(resp, reverse('work', args=[user.id])) self.assertEqual(resp.status_code, 302) @patch('main.extra_func.zenpy') - def test_light_agent_make_engineer(self, ZenpyMock): - self.client.post(reverse_lazy('work_become_engineer')) - self.assertEqual(ZenpyMock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) + def test_light_agent_make_engineer(self, zenpy_mock): + self.agent_client.post(reverse_lazy('work_become_engineer')) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) @patch('main.extra_func.zenpy') - def test_admin_make_engineer(self, ZenpyMock): + def test_admin_make_engineer(self, zenpy_mock): self.admin_client.post(reverse_lazy('work_become_engineer')) - self.assertEqual(ZenpyMock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) @patch('main.extra_func.zenpy') - def test_engineer_make_engineer(self, ZenpyMock): - client = Client() - client.force_login(User.objects.get(email=self.engineer)) - client.post(reverse_lazy('work_become_engineer')) - self.assertEqual(ZenpyMock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) + def test_engineer_make_engineer(self, zenpy_mock): + self.engineer_client.post(reverse_lazy('work_become_engineer')) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) @patch('main.extra_func.zenpy') - def test_control_page_make_one(self, ZenpyMock): + def test_control_page_make_engineer_one(self, zenpy_mock): self.admin_client.post( reverse_lazy('control'), data={'users': [User.objects.get(email=self.light_agent).userprofile.id], 'engineer': 'engineer'} ) - call_list = ZenpyMock.update_user.call_args_list + call_list = zenpy_mock.update_user.call_args_list mock_object = call_list[0][0][0] self.assertEqual(len(call_list), 1) self.assertEqual(mock_object.custom_role_id, sets.ZENDESK_ROLES['engineer']) @patch('main.extra_func.zenpy') - def test_control_page_make_many(self, ZenpyMock): + def test_control_page_make_engineer_many(self, zenpy_mock): self.admin_client.post( reverse_lazy('control'), data={ @@ -126,35 +131,120 @@ class MakeEngineerTestCase(TestCase): 'engineer': 'engineer' } ) - call_list = ZenpyMock.update_user.call_args_list + call_list = zenpy_mock.update_user.call_args_list mock_objects = list(call_list) self.assertEqual(len(call_list), 2) for obj in mock_objects: self.assertEqual(obj[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer']) -class PasswordResetTestCase(TestCase): - fixtures = ['fixtures/test_make_engineer.json'] +class MakeLightAgentTestCase(UsersBaseTestCase): + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]) + @patch('main.extra_func.zenpy') + def test_hand_over_redirect(self, _zenpy_mock, _user_tickets_mock): + user = User.objects.get(email=self.engineer) + resp = self.engineer_client.post(reverse_lazy('work_hand_over')) + self.assertRedirects(resp, reverse('work', args=[user.id])) + self.assertEqual(resp.status_code, 302) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]) + @patch('main.extra_func.zenpy') + def test_engineer_make_light_agent_no_tickets(self, zenpy_mock, _user_tickets_mock): + self.engineer_client.post(reverse_lazy('work_hand_over')) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[ + [Mock(id=1, status='solved'), Mock(id=2, status='open'), Mock(id=3, status='open')] + ]) + @patch('main.extra_func.zenpy') + def test_engineer_make_light_agent_with_tickets(self, zenpy_mock, _user_tickets_mock): + zenpy_mock.solved_tickets_user_id = Mock() + self.engineer_client.post(reverse_lazy('work_hand_over')) + + tickets_update = zenpy_mock.admin.tickets.update.call_args[0][0] + self.assertEqual(tickets_update[0].assignee_id, zenpy_mock.solved_tickets_user_id) + self.assertIsNone(tickets_update[1].assignee) + self.assertIsNone(tickets_update[2].assignee) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]) + @patch('main.extra_func.zenpy') + def test_admin_make_light_agent_no_tickets(self, zenpy_mock, _user_tickets_mock): + self.admin_client.post(reverse_lazy('work_hand_over')) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[ + [Mock(id=1, status='solved'), Mock(id=2, status='open'), Mock(id=3, status='open')] + ]) + @patch('main.extra_func.zenpy') + def test_admin_make_light_agent_with_tickets(self, zenpy_mock, _user_tickets_mock): + zenpy_mock.solved_tickets_user_id = Mock() + self.admin_client.post(reverse_lazy('work_hand_over')) + + tickets_update = zenpy_mock.admin.tickets.update.call_args[0][0] + self.assertEqual(tickets_update[0].assignee_id, zenpy_mock.solved_tickets_user_id) + self.assertIsNone(tickets_update[1].assignee) + self.assertIsNone(tickets_update[2].assignee) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]) + @patch('main.extra_func.zenpy') + def test_light_agent_make_light_agent(self, zenpy_mock, _user_tickets_mock): + self.agent_client.post(reverse_lazy('work_hand_over')) + self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]) + @patch('main.extra_func.zenpy') + def test_control_page_make_light_agent_one(self, zenpy_mock, _user_tickets_mock): + self.admin_client.post( + reverse_lazy('control'), + data={'users': [User.objects.get(email=self.engineer).userprofile.id], 'light_agent': 'light_agent'} + ) + call_list = zenpy_mock.update_user.call_args_list + mock_object = call_list[0][0][0] + self.assertEqual(len(call_list), 1) + self.assertEqual(mock_object.custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[], []]) + @patch('main.extra_func.zenpy') + def test_control_page_make_light_agent_many(self, zenpy_mock, _user_tickets_mock): + self.admin_client.post( + reverse_lazy('control'), + data={ + 'users': [ + User.objects.get(email=self.light_agent).userprofile.id, + User.objects.get(email=self.engineer).userprofile.id, + ], + 'light_agent': 'light_agent' + } + ) + call_list = zenpy_mock.update_user.call_args_list + mock_objects = list(call_list) + self.assertEqual(len(call_list), 2) + for obj in mock_objects: + self.assertEqual(obj[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent']) + + +class PasswordResetTestCase(UsersBaseTestCase): def setUp(self): - self.user = '123@test.ru' + super().setUp() self.email_backend = 'django.core.mail.backends.locmem.EmailBackend' - self.client = Client() - self.client.force_login(User.objects.get(email=self.user)) def test_redirect(self): with self.settings(EMAIL_BACKEND=self.email_backend): - resp = self.client.post(reverse_lazy('password_reset'), data={'email': self.user}) + resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent}) self.assertRedirects(resp, reverse('password_reset_done')) self.assertEqual(resp.status_code, 302) def test_send_email(self): with self.settings(EMAIL_BACKEND=self.email_backend): response: HttpResponseRedirect = \ - self.client.post(reverse_lazy('password_reset'), data={'email': self.user}) + self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent}) self.assertEqual(response.status_code, 302) self.assertEqual(len(mail.outbox), 1) - self.assertEqual(mail.outbox[0].to, [self.user]) + self.assertEqual(mail.outbox[0].to, [self.light_agent]) # context that the email template was rendered with email_context = response.context[0].dicts[1] @@ -165,34 +255,31 @@ class PasswordResetTestCase(TestCase): def test_email_invalid(self): with self.settings(EMAIL_BACKEND=self.email_backend) and translation.override('ru'): - resp = self.client.post(reverse_lazy('password_reset'), data={'email': 1}) + resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': 1}) self.assertContains(resp, 'Введите правильный адрес электронной почты.', count=1, status_code=200) def test_user_does_not_exist(self): with self.settings(EMAIL_BACKEND=self.email_backend): - resp = self.client.post(reverse_lazy('password_reset'), data={'email': self.user + str(random.random())}) + resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent + str(random.random())}) self.assertRedirects(resp, reverse('password_reset_done')) self.assertEqual(resp.status_code, 302) self.assertEqual(len(mail.outbox), 0) -class PasswordChangeTestCase(TestCase): - fixtures = ['fixtures/test_make_engineer.json'] +class PasswordChangeTestCase(UsersBaseTestCase): def setUp(self): - self.user = '123@test.ru' - self.client = Client() - self.client.force_login(User.objects.get(email=self.user)) + super().setUp() self.set_password() def set_password(self): - user: User = User.objects.get(email=self.user) + user: User = User.objects.get(email=self.light_agent) user.set_password('ImpossiblyHardPassword') user.save() - self.client.force_login(User.objects.get(email=self.user)) + self.agent_client.force_login(User.objects.get(email=self.light_agent)) def test_change_successful(self): - self.client.post( + self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'ImpossiblyHardPassword', @@ -200,12 +287,12 @@ class PasswordChangeTestCase(TestCase): 'new_password2': 'EasyPassword', } ) - user = User.objects.get(email=self.user) + user = User.objects.get(email=self.light_agent) self.assertTrue(user.check_password('EasyPassword')) def test_invalid_old_password(self): with translation.override('ru'): - resp = self.client.post( + resp = self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'EasyPassword', @@ -217,7 +304,7 @@ class PasswordChangeTestCase(TestCase): def test_different_new_passwords(self): with translation.override('ru'): - resp = self.client.post( + resp = self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'ImpossiblyHardPassword', @@ -229,7 +316,7 @@ class PasswordChangeTestCase(TestCase): def test_invalid_new_password1(self): with translation.override('ru'): - resp = self.client.post( + resp = self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'ImpossiblyHardPassword', @@ -241,7 +328,7 @@ class PasswordChangeTestCase(TestCase): def test_invalid_new_password2(self): with translation.override('ru'): - resp = self.client.post( + resp = self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'ImpossiblyHardPassword', @@ -253,104 +340,92 @@ class PasswordChangeTestCase(TestCase): def test_invalid_new_password3(self): with translation.override('ru'): - resp = self.client.post( + resp = self.agent_client.post( reverse_lazy('password_change'), data={ 'old_password': 'ImpossiblyHardPassword', - 'new_password1': self.user, - 'new_password2': self.user, + 'new_password1': self.light_agent, + 'new_password2': self.light_agent, } ) self.assertContains(resp, 'Введённый пароль слишком похож на имя пользователя', count=1, status_code=200) -class GetTicketsTestCase(TestCase): +class GetTicketsTestCase(UsersBaseTestCase): """ Класс тестов для проверки функции получения тикетов. """ - fixtures = ['fixtures/test_make_engineer.json'] - - def setUp(self): - """ - Предустановленные значения для проведения тестов. - """ - self.light_agent = '123@test.ru' - self.engineer = 'customer@example.com' - self.client = Client() - self.client.force_login(User.objects.get(email=self.engineer)) - self.light_agent_client = Client() - self.light_agent_client.force_login(User.objects.get(email=self.light_agent)) @patch('main.views.zenpy.get_user') @patch('main.extra_func.zenpy') - def test_redirect(self, ZenpyMock, GetUserMock): + def test_redirect(self, _zenpy_mock, get_user_mock): """ Функция проверки переадресации пользователя на рабочую страницу. """ - GetUserMock.return_value = Mock() + get_user_mock.return_value = Mock() user = User.objects.get(email=self.engineer) - resp = self.client.post(reverse('work_get_tickets')) + resp = self.engineer_client.post(reverse('work_get_tickets')) self.assertRedirects(resp, reverse('work', args=[user.id])) self.assertEqual(resp.status_code, 302) @patch('main.views.zenpy') @patch('main.views.get_tickets_list_for_group') - def test_take_one_ticket(self, TicketsMock, ZenpyViewsMock): + def test_take_one_ticket(self, group_tickets_mock, zenpy_mock): """ Функция проверки назначения одного тикета на engineer. """ - TicketsMock.return_value = [Mock()] - ZenpyViewsMock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) - self.client.post(reverse('work_get_tickets'), data={'count_tickets': 1}) - tickets = ZenpyViewsMock.update_tickets.call_args - self.assertEqual(tickets[0][0][0].assignee, ZenpyViewsMock.get_user.return_value) + group_tickets_mock.return_value = [Mock()] + zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) + self.engineer_client.post(reverse('work_get_tickets'), data={'count_tickets': 1}) + tickets = zenpy_mock.update_tickets.call_args + self.assertEqual(tickets[0][0][0].assignee, zenpy_mock.get_user.return_value) @patch('main.views.get_tickets_list_for_group') @patch('main.views.zenpy') - def test_take_many_tickets(self, ZenpyMock, TicketsMock): + def test_take_many_tickets(self, zenpy_mock, group_tickets_mock): """ Функция проверки назначения нескольких тикетов на engineer. """ - TicketsMock.return_value = [Mock()] * 3 - ZenpyMock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) - self.client.post(reverse('work_get_tickets'), data={'count_tickets': 3}) - tickets = ZenpyMock.update_tickets.call_args + group_tickets_mock.return_value = [Mock()] * 3 + zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) + self.engineer_client.post(reverse('work_get_tickets'), data={'count_tickets': 3}) + tickets = zenpy_mock.update_tickets.call_args for ticket in tickets[0][0]: - self.assertEqual(ticket.assignee, ZenpyMock.get_user.return_value) + self.assertEqual(ticket.assignee, zenpy_mock.get_user.return_value) @patch('main.views.zenpy.get_user') @patch('main.views.zenpy') - def test_light_agent_take_ticket(self, ZenpyMock, GetUserMock): + def test_light_agent_take_ticket(self, zenpy_mock, get_user_mock): """ Функция проверки попытки назначения тикета на light_agent. """ - GetUserMock.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['light_agent']) - self.light_agent_client.post(reverse('work_get_tickets'), data={'count_tickets': 3}) - tickets = ZenpyMock.update_tickets.call_args + get_user_mock.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['light_agent']) + self.agent_client.post(reverse('work_get_tickets'), data={'count_tickets': 3}) + tickets = zenpy_mock.update_tickets.call_args self.assertIsNone(tickets) @patch('main.views.zenpy') @patch('main.views.get_tickets_list_for_group') - def test_take_zero_tickets(self, TicketsMock, ZenpyMock): + def test_take_zero_tickets(self, TicketsMock, zenpy_mock): """ Функция проверки попытки назначения нуля тикета на engineer. """ TicketsMock.return_value = [Mock()] * 3 - ZenpyMock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) - self.client.post(reverse('work_get_tickets'), data={'count_tickets': 0}) - tickets = ZenpyMock.update_tickets.call_args[0][0] + zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) + self.engineer_client.post(reverse('work_get_tickets'), data={'count_tickets': 0}) + tickets = zenpy_mock.update_tickets.call_args[0][0] self.assertListEqual(tickets, []) @patch('main.views.get_tickets_list_for_group') @patch('main.views.zenpy') - def test_take_invalid_count_tickets(self, ZenpyMock, TicketsMock, ): + def test_take_invalid_count_tickets(self, zenpy_mock, group_tickets_mock): """ Функция проверки попытки назначения нуля тикетов на engineer. """ - TicketsMock.return_value = [Mock()] * 3 - ZenpyMock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) - self.client.post(reverse('work_get_tickets'), data={'count_tickets': 'asd'}) - tickets = ZenpyMock.update_tickets.call_args + group_tickets_mock.return_value = [Mock()] * 3 + zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer']) + self.engineer_client.post(reverse('work_get_tickets'), data={'count_tickets': 'asd'}) + tickets = zenpy_mock.update_tickets.call_args self.assertIsNone(tickets) From e0ca38cd6deea3776583b0d73c6fb6bf917fe7e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9C=D0=B0=D0=B7=D1=83=D1=80=D0=BE=D0=B2=20=D0=A2=D0=B8?= =?UTF-8?q?=D0=BC=D0=BE=D1=84=D0=B5=D0=B9?= Date: Wed, 19 May 2021 22:57:37 +0000 Subject: [PATCH 3/5] Issue #75 --- main/tests.py | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/main/tests.py b/main/tests.py index d1ce390..60f31ed 100644 --- a/main/tests.py +++ b/main/tests.py @@ -7,11 +7,13 @@ from django.http import HttpResponseRedirect from django.template.loader import render_to_string from django.test import TestCase, Client from django.urls import reverse, reverse_lazy -from django.utils import translation +from django.utils import translation, timezone import access_controller.settings as sets from main.zendesk_admin import zenpy +from main.extra_func import log + class UsersBaseTestCase(TestCase): """Базовый класс загружения данных для тестов с пользователями""" @@ -487,3 +489,43 @@ class ProfileTestCase(TestCase): resp = self.client.get(reverse('profile')) user = zenpy.get_user(self.zendesk_agent_email) self.assertEqual(resp.context['profile'].image, user.photo['content_url'] if user.photo else None) + + +class LoggingTestCase(UsersBaseTestCase): + + def setUp(self): + super().setUp() + self.admin_profile = User.objects.get(email=self.admin).userprofile + self.agent_profile = User.objects.get(email=self.light_agent).userprofile + self.engineer_profile = User.objects.get(email=self.engineer).userprofile + + @staticmethod + def get_file_output(): + file = open('logs/logs.csv', 'r') + file_output = file.readlines()[-1] + file.close() + return file_output + + def test_engineer_with_admin(self): + log(self.engineer_profile, self.admin_profile) + file_output = self.get_file_output() + self.assertEqual(file_output, f'UserForAccessTest,engineer,' + f'{str(timezone.now().today())[:16]},ZendeskAdmin\n') + + def test_engineer_without_admin(self): + log(self.engineer_profile) + file_output = self.get_file_output() + self.assertEqual(file_output, f'UserForAccessTest,engineer,' + f'{str(timezone.now().today())[:16]},UserForAccessTest\n') + + def test_light_agent_with_admin(self): + log(self.agent_profile, self.admin_profile) + file_output = self.get_file_output() + self.assertEqual(file_output, f'UserForAccessTest,light_agent,' + f'{str(timezone.now().today())[:16]},ZendeskAdmin\n') + + def test_light_agent_without_admin(self): + log(self.agent_profile) + file_output = self.get_file_output() + self.assertEqual(file_output, f'UserForAccessTest,light_agent,' + f'{str(timezone.now().today())[:16]},UserForAccessTest\n') From c95c0fe00b30b6d2c3be06ade572599a72e07b6c Mon Sep 17 00:00:00 2001 From: Iurii Tatishchev Date: Wed, 19 May 2021 21:46:30 -0700 Subject: [PATCH 4/5] Delete unused `main/apiauth.py` --- docs/source/code.rst | 8 -------- main/apiauth.py | 49 -------------------------------------------- 2 files changed, 57 deletions(-) delete mode 100644 main/apiauth.py diff --git a/docs/source/code.rst b/docs/source/code.rst index 7479081..ac37e3d 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -33,14 +33,6 @@ Serializers :members: -*************** -API functions -*************** - -.. automodule:: main.apiauth - :members: - - ***** Views ***** diff --git a/main/apiauth.py b/main/apiauth.py deleted file mode 100644 index 08a018c..0000000 --- a/main/apiauth.py +++ /dev/null @@ -1,49 +0,0 @@ -import os - -from zenpy import Zenpy -from zenpy.lib.api_objects import User as ZenpyUser - -from access_controller.settings import ACTRL_ZENDESK_SUBDOMAIN, ACTRL_API_EMAIL, ACTRL_API_TOKEN, ACTRL_API_PASSWORD - - -def api_auth() -> dict: - """ - Функция создания пользователя с использованием Zendesk API. - - Получает из env Zendesk - email, token, password пользователя. - Если данные валидны и пользователь Zendesk с указанным email и токеном или паролем существует, - создается словарь данных пользователя, полученных через API c Zendesk. - - :return: данные пользователя - """ - credentials = { - 'subdomain': ACTRL_ZENDESK_SUBDOMAIN - } - email = ACTRL_API_EMAIL - token = ACTRL_API_TOKEN - password = ACTRL_API_PASSWORD - - if email is None: - raise ValueError('access_controller email not in env') - credentials['email'] = email - - # prefer token, use password if token not provided - if token: - credentials['token'] = token - elif password: - credentials['password'] = password - else: - raise ValueError('access_controller token or password not in env') - - zenpy_client = Zenpy(**credentials) - zenpy_user: ZenpyUser = zenpy_client.users.search(email).values[0] - - user = { - 'id': zenpy_user.id, - 'name': zenpy_user.name, # Zendesk doesn't have separate first and last name fields - 'email': zenpy_user.email, - 'role': zenpy_user.role, # str like 'admin' or 'agent', not id - 'photo': zenpy_user.photo['content_url'] if zenpy_user.photo is not None else None, - } - - return user From de0da89f0a00dd6f5bf5897ad0bd59d54d0390a1 Mon Sep 17 00:00:00 2001 From: Iurii Tatishchev Date: Wed, 19 May 2021 23:27:46 -0700 Subject: [PATCH 5/5] Add coverage, set up CI. --- .coveragerc | 14 ++++++++++++++ .gitlab-ci.yml | 23 +++++++++++++++++++++++ requirements/dev.txt | 3 +++ 3 files changed, 40 insertions(+) create mode 100644 .coveragerc create mode 100644 .gitlab-ci.yml diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..8499040 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,14 @@ +[run] +command_line = manage.py test + +branch = true + +source = + main/ + + +omit = + main/migrations/* + main/apps.py + main/tests.py + diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..ef3bf26 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,23 @@ +image: python:3-alpine + +stages: + - test + +django_test: + stage: test + before_script: + - pip install -r requirements/dev.txt + script: + - python manage.py test + +coverage: + stage: test + before_script: + - pip install -r requirements/dev.txt + script: + - coverage run + - coverage report -m + - coverage html -d public/coverage + artifacts: + paths: + - public/coverage diff --git a/requirements/dev.txt b/requirements/dev.txt index be32176..64a12ad 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -7,3 +7,6 @@ sphinx-rtd-theme==0.5.2 sphinx-autodoc-typehints==1.12.0 pyenchant==3.2.0 sphinxcontrib-spelling==7.2.1 + +# Tests +coverage==5.5