nofusscomputing/centurion_erp
1
0
Fork 0
Code Issues Wiki Activity

refactor(assistance): ViewSet TestSuite re-written to pytest for model KnowledgeBase

Browse Source 
ref: #904 #900
This commit is contained in:
Jon Lockwood
2025-07-29 12:18:00 +09:30
parent 78cf8522e3
commit 1812746a02
2 changed files with 72 additions and 510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

485
app/assistance/tests/unit/knowledge_base/knowledge_base_api_v2.py
View File

@ -1,485 +0,0 @@
import django
import pytest
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
from django.shortcuts import reverse
from django.test import Client, TestCase
from rest_framework.relations import Hyperlink
from access.models.tenant import Tenant as Organization
from access.models.team import Team
from access.models.team_user import TeamUsers
from api.tests.abstract.api_fields import APITenancyObject
from assistance.models.knowledge_base import KnowledgeBase
from assistance.models.knowledge_base_category import KnowledgeBaseCategory
User = django.contrib.auth.get_user_model()
class KnowledgeBaseAPI(
TestCase,
APITenancyObject
):
model = KnowledgeBase
app_namespace = 'v2'
url_name = '_api_knowledgebase'
@classmethod
def setUpTestData(self):
"""Setup Test
1. Create the object
2. create view user
4. make api request
"""
organization = Organization.objects.create(name='test_org')
self.organization = organization
different_organization = Organization.objects.create(name='test_different_organization')
self.view_team = Team.objects.create(
organization=organization,
team_name = 'teamone',
model_notes = 'random note'
)
view_permissions = Permission.objects.get(
codename = 'view_' + self.model._meta.model_name,
content_type = ContentType.objects.get(
app_label = self.model._meta.app_label,
model = self.model._meta.model_name,
)
)
self.view_team.permissions.set([view_permissions])
self.view_user = User.objects.create_user(username="test_user_view", password="password")
self.item = self.model.objects.create(
organization=organization,
title = 'teamone',
content = 'random note',
summary = 'a summary',
target_user = self.view_user,
release_date = '2024-01-01 12:00:00',
expiry_date = '2024-01-01 12:00:01',
responsible_user = self.view_user,
category = KnowledgeBaseCategory.objects.create(
name='cat',
target_user = self.view_user,
organization=organization,
)
)
self.item.responsible_teams.set([self.view_team])
self.url_view_kwargs = {'pk': self.item.id}
teamuser = TeamUsers.objects.create(
team = self.view_team,
user = self.view_user
)
organization.manager = self.view_user
organization.save()
client = Client()
url = reverse(self.app_namespace + ':' + self.url_name + '-detail', kwargs=self.url_view_kwargs)
client.force_login(self.view_user)
response = client.get(url)
self.api_data = response.data
def test_api_field_exists_model_notes(self):
""" Test for existance of API Field
model_notes field does not exist for KB articles
"""
assert 'model_notes' not in self.api_data
def test_api_field_type_model_notes(self):
""" Test for type for API Field
model_notes does not exist for KB articles
"""
pass
def test_api_field_exists_category(self):
""" Test for existance of API Field
category field must exist
"""
assert 'category' in self.api_data
def test_api_field_type_category(self):
""" Test for type for API Field
category field must be dict
"""
assert type(self.api_data['category']) is dict
def test_api_field_exists_category_id(self):
""" Test for existance of API Field
category.id field must exist
"""
assert 'id' in self.api_data['category']
def test_api_field_type_category_id(self):
""" Test for type for API Field
category.id field must be int
"""
assert type(self.api_data['category']['id']) is int
def test_api_field_exists_category_display_name(self):
""" Test for existance of API Field
category.display_name field must exist
"""
assert 'display_name' in self.api_data['category']
def test_api_field_type_category_display_name(self):
""" Test for type for API Field
category.display_name field must be int
"""
assert type(self.api_data['category']['display_name']) is str
def test_api_field_exists_category_url(self):
""" Test for existance of API Field
category.url field must exist
"""
assert 'url' in self.api_data['category']
def test_api_field_type_category_url(self):
""" Test for type for API Field
category.url field must be int
"""
assert type(self.api_data['category']['url']) is str
def test_api_field_exists_summary(self):
""" Test for existance of API Field
summary field must exist
"""
assert 'summary' in self.api_data
def test_api_field_type_summary(self):
""" Test for type for API Field
summary field must be str
"""
assert type(self.api_data['summary']) is str
def test_api_field_exists_content(self):
""" Test for existance of API Field
content field must exist
"""
assert 'content' in self.api_data
def test_api_field_type_summary(self):
""" Test for type for API Field
content field must be str
"""
assert type(self.api_data['content']) is str
def test_api_field_exists_release_date(self):
""" Test for existance of API Field
release_date field must exist
"""
assert 'release_date' in self.api_data
def test_api_field_type_release_date(self):
""" Test for type for API Field
release_date field must be str
"""
assert type(self.api_data['release_date']) is str
def test_api_field_exists_expiry_date(self):
""" Test for existance of API Field
expiry_date field must exist
"""
assert 'expiry_date' in self.api_data
def test_api_field_type_expiry_date(self):
""" Test for type for API Field
expiry_date field must be str
"""
assert type(self.api_data['expiry_date']) is str
def test_api_field_exists_public(self):
""" Test for existance of API Field
public field must exist
"""
assert 'public' in self.api_data
def test_api_field_type_public(self):
""" Test for type for API Field
public field must be bool
"""
assert type(self.api_data['public']) is bool
def test_api_field_type_target_user(self):
""" Test for type for API Field
target_user field must be dict
"""
assert type(self.api_data['target_user']) is dict
def test_api_field_exists_target_user_id(self):
""" Test for existance of API Field
target_user.id field must exist
"""
assert 'id' in self.api_data['target_user']
def test_api_field_type_target_user_id(self):
""" Test for type for API Field
target_user.id field must be int
"""
assert type(self.api_data['target_user']['id']) is int
def test_api_field_exists_target_user_display_name(self):
""" Test for existance of API Field
target_user.display_name field must exist
"""
assert 'display_name' in self.api_data['target_user']
def test_api_field_type_target_user_display_name(self):
""" Test for type for API Field
target_user.display_name field must be int
"""
assert type(self.api_data['target_user']['display_name']) is str
def test_api_field_exists_target_user_url(self):
""" Test for existance of API Field
target_user.url field must exist
"""
assert 'url' in self.api_data['target_user']
def test_api_field_type_target_user_url(self):
""" Test for type for API Field
target_user.url field must be int
"""
assert type(self.api_data['target_user']['url']) is Hyperlink
def test_api_field_type_responsible_user(self):
""" Test for type for API Field
responsible_user field must be dict
"""
assert type(self.api_data['responsible_user']) is dict
def test_api_field_exists_responsible_user_id(self):
""" Test for existance of API Field
responsible_user.id field must exist
"""
assert 'id' in self.api_data['responsible_user']
def test_api_field_type_responsible_user_id(self):
""" Test for type for API Field
responsible_user.id field must be int
"""
assert type(self.api_data['responsible_user']['id']) is int
def test_api_field_exists_responsible_user_display_name(self):
""" Test for existance of API Field
responsible_user.display_name field must exist
"""
assert 'display_name' in self.api_data['responsible_user']
def test_api_field_type_responsible_user_display_name(self):
""" Test for type for API Field
responsible_user.display_name field must be int
"""
assert type(self.api_data['responsible_user']['display_name']) is str
def test_api_field_exists_responsible_user_url(self):
""" Test for existance of API Field
responsible_user.url field must exist
"""
assert 'url' in self.api_data['responsible_user']
def test_api_field_type_responsible_user_url(self):
""" Test for type for API Field
responsible_user.url field must be Hyperlink
"""
assert type(self.api_data['responsible_user']['url']) is Hyperlink
def test_api_field_type_responsible_teams(self):
""" Test for type for API Field
responsible_teams field must be list
"""
assert type(self.api_data['responsible_teams']) is list
def test_api_field_exists_responsible_teams_id(self):
""" Test for existance of API Field
responsible_teams.id field must exist
"""
assert 'id' in self.api_data['responsible_teams'][0]
def test_api_field_type_responsible_teams_id(self):
""" Test for type for API Field
responsible_teams.id field must be int
"""
assert type(self.api_data['responsible_teams'][0]['id']) is int
def test_api_field_exists_responsible_teams_display_name(self):
""" Test for existance of API Field
responsible_teams.display_name field must exist
"""
assert 'display_name' in self.api_data['responsible_teams'][0]
def test_api_field_type_responsible_teams_display_name(self):
""" Test for type for API Field
responsible_teams.display_name field must be int
"""
assert type(self.api_data['responsible_teams'][0]['display_name']) is str
def test_api_field_exists_responsible_teams_url(self):
""" Test for existance of API Field
responsible_teams.url field must exist
"""
assert 'url' in self.api_data['responsible_teams'][0]
def test_api_field_type_responsible_teams_url(self):
""" Test for type for API Field
responsible_teams.url field must be str
"""
assert type(self.api_data['responsible_teams'][0]['url']) is str

97
app/assistance/tests/unit/knowledge_base/test_unit_knowledge_base_viewset.py
View File

@ -1,44 +1,91 @@
import pytest import pytest
from django.test import Client, TestCase
from rest_framework.reverse import reverse
from api.tests.unit.test_unit_common_viewset import ModelViewSetInheritedCases from api.tests.unit.test_unit_common_viewset import ModelViewSetInheritedCases
from assistance.viewsets.knowledge_base import ViewSet from assistance.viewsets.knowledge_base import (
KnowledgeBase,
ViewSet,
)
@pytest.mark.skip(reason = 'see #895, tests being refactored') @pytest.mark.model_knowledgebase
class KnowledgeBaseViewsetList( class ViewsetTestCases(
ModelViewSetInheritedCases, ModelViewSetInheritedCases,
TestCase,
): ):
viewset = ViewSet
route_name = 'v2:_api_knowledgebase' @pytest.fixture( scope = 'function' )
def viewset(self):
return ViewSet
@classmethod @property
def setUpTestData(self): def parameterized_class_attributes(self):
"""Setup Test return {
'_model_documentation': {
1. make list request 'type': type(None),
""" },
'back_url': {
'type': type(None),
},
'documentation': {
'type': type(None),
'value': None
},
'filterset_fields': {
'value': [
'organization',
'category',
'target_user',
'target_team',
'responsible_user',
'responsible_teams',
'public'
]
},
'model': {
'value': KnowledgeBase
},
'model_documentation': {
'type': type(None),
},
'queryset': {
'type': type(None),
},
'serializer_class': {
'type': type(None),
},
'search_fields': {
'value': [
'title',
'summary',
'content'
]
},
'view_description': {
'value': 'Information Management Knowledge Base Article(s)'
},
'view_name': {
'type': type(None),
},
'view_serializer_name': {
'type': type(None),
}
}
super().setUpTestData()
class KnowledgeBaseViewsetInheritedCases(
ViewsetTestCases,
):
pass
client = Client()
url = reverse( @pytest.mark.module_assistance
self.route_name + '-list', class KnowledgeBaseViewsetPyTest(
kwargs = self.kwargs ViewsetTestCases,
) ):
client.force_login(self.view_user) pass
self.http_options_response_list = client.options(url)