Skip to content

C
course-discovery
Commit 17f51348 by Uman Shahzad
Options

Refactor serializer test code. 

This will make it x10 easier to add tests for the
serializers we introduced in this PR.
parent fc03460c
Showing with 143 additions and 114 deletions
course_discovery/apps/api/tests/test_serializers.py
# pylint: disable=no-member, test-inherits-tests # pylint: disable=no-member,test-inherits-tests
import datetime import datetime
import itertools import itertools
from urllib.parse import urlencode from urllib.parse import urlencode
...@@ -19,14 +19,15 @@ from waffle.testutils import override_switch ...@@ -19,14 +19,15 @@ from waffle.testutils import override_switch
from course_discovery.apps.api.fields import ImageField, StdImageSerializerField from course_discovery.apps.api.fields import ImageField, StdImageSerializerField
from course_discovery.apps.api.serializers import ( from course_discovery.apps.api.serializers import (
AffiliateWindowSerializer, CatalogSerializer, ContainedCourseRunsSerializer, ContainedCoursesSerializer, AffiliateWindowSerializer, CatalogSerializer, ContainedCourseRunsSerializer, ContainedCoursesSerializer,
CorporateEndorsementSerializer, CourseEntitlementSerializer, CourseRunSearchSerializer, CourseRunSerializer, ContentTypeSerializer, CorporateEndorsementSerializer, CourseEntitlementSerializer, CourseRunSearchModelSerializer,
CourseRunWithProgramsSerializer, CourseSearchSerializer, CourseSerializer, CourseWithProgramsSerializer, CourseRunSearchSerializer, CourseRunSerializer, CourseRunWithProgramsSerializer, CourseSearchModelSerializer,
EndorsementSerializer, FAQSerializer, FlattenedCourseRunWithCourseSerializer, ImageSerializer, CourseSearchSerializer, CourseSerializer, CourseWithProgramsSerializer, EndorsementSerializer, FAQSerializer,
MinimalCourseRunSerializer, MinimalCourseSerializer, MinimalOrganizationSerializer, MinimalProgramCourseSerializer, FlattenedCourseRunWithCourseSerializer, ImageSerializer, MinimalCourseRunSerializer, MinimalCourseSerializer,
MinimalProgramSerializer, NestedProgramSerializer, OrganizationSerializer, PersonSerializer, PositionSerializer, MinimalOrganizationSerializer, MinimalProgramCourseSerializer, MinimalProgramSerializer, NestedProgramSerializer,
PrerequisiteSerializer, ProgramSearchSerializer, ProgramSerializer, ProgramTypeSerializer, SeatSerializer, OrganizationSerializer, PersonSerializer, PositionSerializer, PrerequisiteSerializer, ProgramSearchModelSerializer,
SubjectSerializer, TopicSerializer, TypeaheadCourseRunSearchSerializer, TypeaheadProgramSearchSerializer, ProgramSearchSerializer, ProgramSerializer, ProgramTypeSerializer, SeatSerializer, SubjectSerializer,
VideoSerializer, get_utm_source_for_user TopicSerializer, TypeaheadCourseRunSearchSerializer, TypeaheadProgramSearchSerializer, VideoSerializer,
get_utm_source_for_user
) )
from course_discovery.apps.api.tests.mixins import SiteMixin from course_discovery.apps.api.tests.mixins import SiteMixin
from course_discovery.apps.catalogs.tests.factories import CatalogFactory from course_discovery.apps.catalogs.tests.factories import CatalogFactory
...@@ -109,7 +110,8 @@ class CatalogSerializerTests(ElasticsearchTestMixin, TestCase): ...@@ -109,7 +110,8 @@ class CatalogSerializerTests(ElasticsearchTestMixin, TestCase):
class MinimalCourseSerializerTests(SiteMixin, TestCase): class MinimalCourseSerializerTests(SiteMixin, TestCase):
serializer_class = MinimalCourseSerializer serializer_class = MinimalCourseSerializer
def get_expected_data(self, course, request): @classmethod
def get_expected_data(cls, course, request):
context = {'request': request} context = {'request': request}
return { return {
...@@ -136,7 +138,8 @@ class MinimalCourseSerializerTests(SiteMixin, TestCase): ...@@ -136,7 +138,8 @@ class MinimalCourseSerializerTests(SiteMixin, TestCase):
class CourseSerializerTests(MinimalCourseSerializerTests): class CourseSerializerTests(MinimalCourseSerializerTests):
serializer_class = CourseSerializer serializer_class = CourseSerializer
def get_expected_data(self, course, request): @classmethod
def get_expected_data(cls, course, request):
expected = super().get_expected_data(course, request) expected = super().get_expected_data(course, request)
expected.update({ expected.update({
'short_description': course.short_description, 'short_description': course.short_description,
...@@ -179,7 +182,8 @@ class CourseSerializerTests(MinimalCourseSerializerTests): ...@@ -179,7 +182,8 @@ class CourseSerializerTests(MinimalCourseSerializerTests):
class CourseWithProgramsSerializerTests(CourseSerializerTests): class CourseWithProgramsSerializerTests(CourseSerializerTests):
serializer_class = CourseWithProgramsSerializer serializer_class = CourseWithProgramsSerializer
def get_expected_data(self, course, request): @classmethod
def get_expected_data(cls, course, request):
expected = super().get_expected_data(course, request) expected = super().get_expected_data(course, request)
expected.update({ expected.update({
'programs': NestedProgramSerializer( 'programs': NestedProgramSerializer(
...@@ -224,7 +228,8 @@ class CourseWithProgramsSerializerTests(CourseSerializerTests): ...@@ -224,7 +228,8 @@ class CourseWithProgramsSerializerTests(CourseSerializerTests):
class MinimalCourseRunSerializerTests(TestCase): class MinimalCourseRunSerializerTests(TestCase):
serializer_class = MinimalCourseRunSerializer serializer_class = MinimalCourseRunSerializer
def get_expected_data(self, course_run, request): # pylint: disable=unused-argument @classmethod
def get_expected_data(cls, course_run, request): # pylint: disable=unused-argument
return { return {
'key': course_run.key, 'key': course_run.key,
'uuid': str(course_run.uuid), 'uuid': str(course_run.uuid),
...@@ -259,7 +264,8 @@ class MinimalCourseRunSerializerTests(TestCase): ...@@ -259,7 +264,8 @@ class MinimalCourseRunSerializerTests(TestCase):
class CourseRunSerializerTests(MinimalCourseRunSerializerTests): class CourseRunSerializerTests(MinimalCourseRunSerializerTests):
serializer_class = CourseRunSerializer serializer_class = CourseRunSerializer
def get_expected_data(self, course_run, request): @classmethod
def get_expected_data(cls, course_run, request):
expected = super().get_expected_data(course_run, request) expected = super().get_expected_data(course_run, request)
expected.update({ expected.update({
'course': course_run.course.key, 'course': course_run.course.key,
...@@ -308,17 +314,7 @@ class CourseRunWithProgramsSerializerTests(TestCase): ...@@ -308,17 +314,7 @@ class CourseRunWithProgramsSerializerTests(TestCase):
def test_data(self): def test_data(self):
serializer = CourseRunWithProgramsSerializer(self.course_run, context=self.serializer_context) serializer = CourseRunWithProgramsSerializer(self.course_run, context=self.serializer_context)
ProgramFactory(courses=[self.course_run.course]) ProgramFactory(courses=[self.course_run.course])
self.assertDictEqual(serializer.data, self.get_expected_data(self.course_run, self.request))
expected = CourseRunSerializer(self.course_run, context=self.serializer_context).data
expected.update({
'programs': NestedProgramSerializer(
self.course_run.course.programs,
many=True,
context=self.serializer_context
).data,
})
self.assertDictEqual(serializer.data, expected)
def test_data_excluded_course_run(self): def test_data_excluded_course_run(self):
""" """
...@@ -328,11 +324,8 @@ class CourseRunWithProgramsSerializerTests(TestCase): ...@@ -328,11 +324,8 @@ class CourseRunWithProgramsSerializerTests(TestCase):
serializer = CourseRunWithProgramsSerializer(self.course_run, context=self.serializer_context) serializer = CourseRunWithProgramsSerializer(self.course_run, context=self.serializer_context)
ProgramFactory(courses=[self.course_run.course], excluded_course_runs=[self.course_run]) ProgramFactory(courses=[self.course_run.course], excluded_course_runs=[self.course_run])
expected = CourseRunSerializer(self.course_run, context=self.serializer_context).data expected = CourseRunSerializer(self.course_run, context=self.serializer_context).data
expected.update({ expected.update({'programs': []})
'programs': [], assert serializer.data == expected
})
self.assertDictEqual(serializer.data, expected)
def test_exclude_deleted_programs(self): def test_exclude_deleted_programs(self):
""" """
...@@ -398,9 +391,22 @@ class CourseRunWithProgramsSerializerTests(TestCase): ...@@ -398,9 +391,22 @@ class CourseRunWithProgramsSerializerTests(TestCase):
NestedProgramSerializer([retired_program], many=True, context=self.serializer_context).data NestedProgramSerializer([retired_program], many=True, context=self.serializer_context).data
) )
@classmethod
def get_expected_data(cls, course_run, request):
expected = CourseRunSerializer(course_run, context={'request': request}).data
expected.update({
'programs': NestedProgramSerializer(
course_run.course.programs,
many=True,
context={'request': request},
).data,
})
return expected
class FlattenedCourseRunWithCourseSerializerTests(TestCase): # pragma: no cover class FlattenedCourseRunWithCourseSerializerTests(TestCase): # pragma: no cover
def serialize_seats(self, course_run): @classmethod
def serialize_seats(cls, course_run):
seats = { seats = {
'audit': { 'audit': {
'type': '' 'type': ''
...@@ -442,21 +448,23 @@ class FlattenedCourseRunWithCourseSerializerTests(TestCase): # pragma: no cover ...@@ -442,21 +448,23 @@ class FlattenedCourseRunWithCourseSerializerTests(TestCase): # pragma: no cover
return seats return seats
def serialize_items(self, organizations, attr): @classmethod
def serialize_items(cls, organizations, attr):
return ','.join([getattr(organization, attr) for organization in organizations]) return ','.join([getattr(organization, attr) for organization in organizations])
def get_expected_data(self, request, course_run): @classmethod
def get_expected_data(cls, request, course_run):
course = course_run.course course = course_run.course
serializer_context = {'request': request} serializer_context = {'request': request}
expected = dict(CourseRunSerializer(course_run, context=serializer_context).data) expected = dict(CourseRunSerializer(course_run, context=serializer_context).data)
expected.update({ expected.update({
'subjects': self.serialize_items(course.subjects.all(), 'name'), 'subjects': cls.serialize_items(course.subjects.all(), 'name'),
'seats': self.serialize_seats(course_run), 'seats': cls.serialize_seats(course_run),
'owners': self.serialize_items(course.authoring_organizations.all(), 'key'), 'owners': cls.serialize_items(course.authoring_organizations.all(), 'key'),
'sponsors': self.serialize_items(course.sponsoring_organizations.all(), 'key'), 'sponsors': cls.serialize_items(course.sponsoring_organizations.all(), 'key'),
'prerequisites': self.serialize_items(course.prerequisites.all(), 'name'), 'prerequisites': cls.serialize_items(course.prerequisites.all(), 'name'),
'level_type': course_run.level_type.name if course_run.level_type else None, 'level_type': course_run.level_type.name if course_run.level_type else None,
'expected_learning_items': self.serialize_items(course.expected_learning_items.all(), 'value'), 'expected_learning_items': cls.serialize_items(course.expected_learning_items.all(), 'value'),
'course_key': course.key, 'course_key': course.key,
'image': ImageField().to_representation(course_run.card_image_url), 'image': ImageField().to_representation(course_run.card_image_url),
}) })
...@@ -623,7 +631,8 @@ class MinimalProgramSerializerTests(TestCase): ...@@ -623,7 +631,8 @@ class MinimalProgramSerializerTests(TestCase):
order_courses_by_start_date=False, order_courses_by_start_date=False,
) )
def get_expected_data(self, program, request): @classmethod
def get_expected_data(cls, program, request):
image_field = StdImageSerializerField() image_field = StdImageSerializerField()
image_field._context = {'request': request} # pylint: disable=protected-access image_field._context = {'request': request} # pylint: disable=protected-access
...@@ -661,9 +670,9 @@ class MinimalProgramSerializerTests(TestCase): ...@@ -661,9 +670,9 @@ class MinimalProgramSerializerTests(TestCase):
class ProgramSerializerTests(MinimalProgramSerializerTests): class ProgramSerializerTests(MinimalProgramSerializerTests):
serializer_class = ProgramSerializer serializer_class = ProgramSerializer
def get_expected_data(self, program, request): @classmethod
def get_expected_data(cls, program, request):
expected = super().get_expected_data(program, request) expected = super().get_expected_data(program, request)
expected.update({ expected.update({
'authoring_organizations': OrganizationSerializer(program.authoring_organizations, many=True).data, 'authoring_organizations': OrganizationSerializer(program.authoring_organizations, many=True).data,
'video': VideoSerializer(program.video).data, 'video': VideoSerializer(program.video).data,
...@@ -698,7 +707,6 @@ class ProgramSerializerTests(MinimalProgramSerializerTests): ...@@ -698,7 +707,6 @@ class ProgramSerializerTests(MinimalProgramSerializerTests):
'subjects': SubjectSerializer(program.subjects, many=True).data, 'subjects': SubjectSerializer(program.subjects, many=True).data,
'transcript_languages': [serialize_language_to_code(l) for l in program.transcript_languages], 'transcript_languages': [serialize_language_to_code(l) for l in program.transcript_languages],
}) })
return expected return expected
def test_data_with_exclusions(self): def test_data_with_exclusions(self):
...@@ -900,7 +908,8 @@ class ProgramSerializerTests(MinimalProgramSerializerTests): ...@@ -900,7 +908,8 @@ class ProgramSerializerTests(MinimalProgramSerializerTests):
class ProgramTypeSerializerTests(TestCase): class ProgramTypeSerializerTests(TestCase):
serializer_class = ProgramTypeSerializer serializer_class = ProgramTypeSerializer
def get_expected_data(self, program_type, request): @classmethod
def get_expected_data(cls, program_type, request):
image_field = StdImageSerializerField() image_field = StdImageSerializerField()
image_field._context = {'request': request} # pylint: disable=protected-access image_field._context = {'request': request} # pylint: disable=protected-access
...@@ -1067,7 +1076,8 @@ class MinimalOrganizationSerializerTests(TestCase): ...@@ -1067,7 +1076,8 @@ class MinimalOrganizationSerializerTests(TestCase):
def create_organization(self): def create_organization(self):
return OrganizationFactory() return OrganizationFactory()
def get_expected_data(self, organization): @classmethod
def get_expected_data(cls, organization):
return { return {
'uuid': str(organization.uuid), 'uuid': str(organization.uuid),
'key': organization.key, 'key': organization.key,
...@@ -1090,14 +1100,15 @@ class OrganizationSerializerTests(MinimalOrganizationSerializerTests): ...@@ -1090,14 +1100,15 @@ class OrganizationSerializerTests(MinimalOrganizationSerializerTests):
organization.tags.add(self.TAG) organization.tags.add(self.TAG)
return organization return organization
def get_expected_data(self, organization): @classmethod
def get_expected_data(cls, organization):
expected = super().get_expected_data(organization) expected = super().get_expected_data(organization)
expected.update({ expected.update({
'certificate_logo_image_url': organization.certificate_logo_image_url, 'certificate_logo_image_url': organization.certificate_logo_image_url,
'description': organization.description, 'description': organization.description,
'homepage_url': organization.homepage_url, 'homepage_url': organization.homepage_url,
'logo_image_url': organization.logo_image_url, 'logo_image_url': organization.logo_image_url,
'tags': [self.TAG], 'tags': [cls.TAG],
'marketing_url': organization.marketing_url, 'marketing_url': organization.marketing_url,
}) })
...@@ -1215,11 +1226,23 @@ class AffiliateWindowSerializerTests(TestCase): ...@@ -1215,11 +1226,23 @@ class AffiliateWindowSerializerTests(TestCase):
class CourseSearchSerializerTests(TestCase): class CourseSearchSerializerTests(TestCase):
serializer_class = CourseSearchSerializer
def test_data(self): def test_data(self):
request = make_request()
course = CourseFactory() course = CourseFactory()
serializer = self.serialize_course(course) serializer = self.serialize_course(course, request)
assert serializer.data == self.get_expected_data(course, request)
expected = { def serialize_course(self, course, request):
""" Serializes the given `Course` as a search result. """
result = SearchQuerySet().models(Course).filter(key=course.key)[0]
serializer = self.serializer_class(result, context={'request': request})
return serializer
@classmethod
def get_expected_data(cls, course, request): # pylint: disable=unused-argument
return {
'key': course.key, 'key': course.key,
'title': course.title, 'title': course.title,
'short_description': course.short_description, 'short_description': course.short_description,
...@@ -1227,26 +1250,37 @@ class CourseSearchSerializerTests(TestCase): ...@@ -1227,26 +1250,37 @@ class CourseSearchSerializerTests(TestCase):
'content_type': 'course', 'content_type': 'course',
'aggregation_key': 'course:{}'.format(course.key), 'aggregation_key': 'course:{}'.format(course.key),
} }
assert serializer.data == expected
def serialize_course(self, course):
""" Serializes the given `Course` as a search result. """
result = SearchQuerySet().models(Course).filter(key=course.key)[0]
serializer = CourseSearchSerializer(result)
return serializer
class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase): class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase):
serializer_class = CourseRunSearchSerializer
def test_data(self): def test_data(self):
request = make_request()
course_run = CourseRunFactory(transcript_languages=LanguageTag.objects.filter(code__in=['en-us', 'zh-cn']), course_run = CourseRunFactory(transcript_languages=LanguageTag.objects.filter(code__in=['en-us', 'zh-cn']),
authoring_organizations=[OrganizationFactory()]) authoring_organizations=[OrganizationFactory()])
SeatFactory.create(course_run=course_run, type='verified', price=10, sku='ABCDEF') SeatFactory.create(course_run=course_run, type='verified', price=10, sku='ABCDEF')
program = ProgramFactory(courses=[course_run.course]) program = ProgramFactory(courses=[course_run.course])
self.reindex_courses(program) self.reindex_courses(program)
serializer = self.serialize_course_run(course_run) serializer = self.serialize_course_run(course_run, request)
course_run_key = CourseKey.from_string(course_run.key) assert serializer.data == self.get_expected_data(course_run, request)
orgs = course_run.authoring_organizations.all()
expected = { def test_data_without_serializers(self):
""" Verify a null `LevelType` is properly serialized as None. """
request = make_request()
course_run = CourseRunFactory(course__level_type=None)
serializer = self.serialize_course_run(course_run, request)
assert serializer.data['level_type'] is None
def serialize_course_run(self, course_run, request):
""" Serializes the given `CourseRun` as a search result. """
result = SearchQuerySet().models(CourseRun).filter(key=course_run.key)[0]
serializer = self.serializer_class(result, context={'request': request})
return serializer
@classmethod
def get_expected_data(cls, course_run, request): # pylint: disable=unused-argument
return {
'transcript_languages': [serialize_language(l) for l in course_run.transcript_languages.all()], 'transcript_languages': [serialize_language(l) for l in course_run.transcript_languages.all()],
'min_effort': course_run.min_effort, 'min_effort': course_run.min_effort,
'max_effort': course_run.max_effort, 'max_effort': course_run.max_effort,
...@@ -1264,8 +1298,8 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase): ...@@ -1264,8 +1298,8 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase):
'full_description': course_run.full_description, 'full_description': course_run.full_description,
'title': course_run.title, 'title': course_run.title,
'content_type': 'courserun', 'content_type': 'courserun',
'org': course_run_key.org, 'org': CourseKey.from_string(course_run.key).org,
'number': course_run_key.course, 'number': CourseKey.from_string(course_run.key).course,
'seat_types': course_run.seat_types, 'seat_types': course_run.seat_types,
'image_url': course_run.image_url, 'image_url': course_run.image_url,
'type': course_run.type, 'type': course_run.type,
...@@ -1274,7 +1308,7 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase): ...@@ -1274,7 +1308,7 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase):
'published': course_run.status == CourseRunStatus.Published, 'published': course_run.status == CourseRunStatus.Published,
'partner': course_run.course.partner.short_code, 'partner': course_run.course.partner.short_code,
'program_types': course_run.program_types, 'program_types': course_run.program_types,
'logo_image_urls': [org.logo_image_url for org in orgs], 'logo_image_urls': [org.logo_image_url for org in course_run.authoring_organizations.all()],
'authoring_organization_uuids': get_uuids(course_run.authoring_organizations.all()), 'authoring_organization_uuids': get_uuids(course_run.authoring_organizations.all()),
'subject_uuids': get_uuids(course_run.subjects.all()), 'subject_uuids': get_uuids(course_run.subjects.all()),
'staff_uuids': get_uuids(course_run.staff.all()), 'staff_uuids': get_uuids(course_run.staff.all()),
...@@ -1282,25 +1316,21 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase): ...@@ -1282,25 +1316,21 @@ class CourseRunSearchSerializerTests(ElasticsearchTestMixin, TestCase):
'has_enrollable_seats': course_run.has_enrollable_seats, 'has_enrollable_seats': course_run.has_enrollable_seats,
'first_enrollable_paid_seat_sku': course_run.first_enrollable_paid_seat_sku(), 'first_enrollable_paid_seat_sku': course_run.first_enrollable_paid_seat_sku(),
} }
assert serializer.data == expected
def serialize_course_run(self, course_run):
""" Serializes the given `CourseRun` as a search result. """
result = SearchQuerySet().models(CourseRun).filter(key=course_run.key)[0]
serializer = CourseRunSearchSerializer(result)
return serializer
def test_data_without_serializers(self):
""" Verify a null `LevelType` is properly serialized as None. """
course_run = CourseRunFactory(course__level_type=None)
serializer = self.serialize_course_run(course_run)
assert serializer.data['level_type'] is None
@pytest.mark.django_db @pytest.mark.django_db
@pytest.mark.usefixtures('haystack_default_connection') @pytest.mark.usefixtures('haystack_default_connection')
class TestProgramSearchSerializer: class TestProgramSearchSerializer(TestCase):
def _create_expected_data(self, program): serializer_class = ProgramSearchSerializer
def setUp(self):
super().setUp()
self.request = make_request()
@classmethod
def get_expected_data(cls, program, request): # pylint: disable=unused-argument
return { return {
'uuid': str(program.uuid), 'uuid': str(program.uuid),
'title': program.title, 'title': program.title,
...@@ -1330,81 +1360,80 @@ class TestProgramSearchSerializer: ...@@ -1330,81 +1360,80 @@ class TestProgramSearchSerializer:
'is_program_eligible_for_one_click_purchase': program.is_program_eligible_for_one_click_purchase 'is_program_eligible_for_one_click_purchase': program.is_program_eligible_for_one_click_purchase
} }
def serialize_program(self, program, request):
""" Serializes the given `Program` as a search result. """
result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0]
serializer = self.serializer_class(result, context={'request': request})
return serializer
def test_data(self): def test_data(self):
authoring_organization, crediting_organization = OrganizationFactory.create_batch(2) authoring_organization, crediting_organization = OrganizationFactory.create_batch(2)
program = ProgramFactory(authoring_organizations=[authoring_organization], program = ProgramFactory(authoring_organizations=[authoring_organization],
credit_backing_organizations=[crediting_organization]) credit_backing_organizations=[crediting_organization])
serializer = self.serialize_program(program, self.request)
# NOTE: This serializer expects SearchQuerySet results, so we run a search on the newly-created object expected = self.get_expected_data(program, self.request)
# to generate such a result.
result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0]
serializer = ProgramSearchSerializer(result)
expected = self._create_expected_data(program)
assert serializer.data == expected assert serializer.data == expected
def test_data_without_organizations(self): def test_data_without_organizations(self):
""" Verify the serializer serialized programs with no associated organizations. """ Verify the serializer serialized programs with no associated organizations.
In such cases the organizations value should be an empty array. """ In such cases the organizations value should be an empty array. """
program = ProgramFactory(authoring_organizations=[], credit_backing_organizations=[]) program = ProgramFactory(authoring_organizations=[], credit_backing_organizations=[])
serializer = self.serialize_program(program, self.request)
result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0] expected = self.get_expected_data(program, self.request)
serializer = ProgramSearchSerializer(result)
expected = self._create_expected_data(program)
assert serializer.data == expected assert serializer.data == expected
def test_data_with_languages(self): def test_data_with_languages(self):
""" """
Verify that program languages are serialized. Verify that program languages are serialized.
""" """
course_run = CourseRunFactory( course_run = CourseRunFactory(language=LanguageTag.objects.get(code='en-us'),
language=LanguageTag.objects.get(code='en-us'), authoring_organizations=[OrganizationFactory()])
authoring_organizations=[OrganizationFactory()] CourseRunFactory(course=course_run.course, language=LanguageTag.objects.get(code='zh-cmn'))
)
CourseRunFactory(
course=course_run.course,
language=LanguageTag.objects.get(code='zh-cmn')
)
program = ProgramFactory(courses=[course_run.course]) program = ProgramFactory(courses=[course_run.course])
serializer = self.serialize_program(program, self.request)
result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0] expected = self.get_expected_data(program, self.request)
serializer = ProgramSearchSerializer(result)
expected = self._create_expected_data(program)
assert serializer.data == expected assert serializer.data == expected
assert {'English', 'Chinese - Mandarin'} == {*expected['language']} if 'language' in expected:
assert {'English', 'Chinese - Mandarin'} == {*expected['language']}
else:
assert expected['languages'] == ['en-us', 'zh-cmn']
@pytest.mark.django_db @pytest.mark.django_db
@pytest.mark.usefixtures('haystack_default_connection') @pytest.mark.usefixtures('haystack_default_connection')
class TestTypeaheadCourseRunSearchSerializer: class TestTypeaheadCourseRunSearchSerializer:
def test_data(self): serializer_class = TypeaheadCourseRunSearchSerializer
authoring_organization = OrganizationFactory()
course_run = CourseRunFactory(authoring_organizations=[authoring_organization])
serialized_course = self.serialize_course_run(course_run)
expected = { @classmethod
def get_expected_data(cls, course_run):
return {
'key': course_run.key, 'key': course_run.key,
'title': course_run.title, 'title': course_run.title,
'orgs': [org.key for org in course_run.authoring_organizations.all()], 'orgs': [org.key for org in course_run.authoring_organizations.all()],
'marketing_url': course_run.marketing_url, 'marketing_url': course_run.marketing_url,
} }
assert serialized_course.data == expected
def test_data(self):
authoring_organization = OrganizationFactory()
course_run = CourseRunFactory(authoring_organizations=[authoring_organization])
serialized_course = self.serialize_course_run(course_run)
assert serialized_course.data == self.get_expected_data(course_run)
def serialize_course_run(self, course_run): def serialize_course_run(self, course_run):
""" Serializes the given `CourseRun` as a typeahead result. """ """ Serializes the given `CourseRun` as a typeahead result. """
result = SearchQuerySet().models(CourseRun).filter(key=course_run.key)[0] result = SearchQuerySet().models(CourseRun).filter(key=course_run.key)[0]
serializer = TypeaheadCourseRunSearchSerializer(result) serializer = self.serializer_class(result)
return serializer return serializer
@pytest.mark.django_db @pytest.mark.django_db
@pytest.mark.usefixtures('haystack_default_connection') @pytest.mark.usefixtures('haystack_default_connection')
class TestTypeaheadProgramSearchSerializer: class TestTypeaheadProgramSearchSerializer:
def _create_expected_data(self, program): serializer_class = TypeaheadProgramSearchSerializer
@classmethod
def get_expected_data(cls, program):
return { return {
'uuid': str(program.uuid), 'uuid': str(program.uuid),
'title': program.title, 'title': program.title,
...@@ -1417,7 +1446,7 @@ class TestTypeaheadProgramSearchSerializer: ...@@ -1417,7 +1446,7 @@ class TestTypeaheadProgramSearchSerializer:
authoring_organization = OrganizationFactory() authoring_organization = OrganizationFactory()
program = ProgramFactory(authoring_organizations=[authoring_organization]) program = ProgramFactory(authoring_organizations=[authoring_organization])
serialized_program = self.serialize_program(program) serialized_program = self.serialize_program(program)
expected = self._create_expected_data(program) expected = self.get_expected_data(program)
assert serialized_program.data == expected assert serialized_program.data == expected
def test_data_multiple_authoring_organizations(self): def test_data_multiple_authoring_organizations(self):
...@@ -1430,7 +1459,7 @@ class TestTypeaheadProgramSearchSerializer: ...@@ -1430,7 +1459,7 @@ class TestTypeaheadProgramSearchSerializer:
def serialize_program(self, program): def serialize_program(self, program):
""" Serializes the given `Program` as a typeahead result. """ """ Serializes the given `Program` as a typeahead result. """
result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0] result = SearchQuerySet().models(Program).filter(uuid=program.uuid)[0]
serializer = TypeaheadProgramSearchSerializer(result) serializer = self.serializer_class(result)
return serializer return serializer
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment