afd19f0513
The only way to access the legacy courseware is now through the Studio preview feature (and at some point, when the MFE supports a preview mode, we can then remove even that). This drops the courseware.use_legacy_frontend waffle.
329 lines
10 KiB
Python
329 lines
10 KiB
Python
"""
|
|
Test for split test XModule
|
|
"""
|
|
|
|
|
|
from unittest.mock import MagicMock
|
|
from django.urls import reverse
|
|
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase
|
|
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
|
|
from xmodule.partitions.partitions import Group, UserPartition
|
|
|
|
from lms.djangoapps.courseware.model_data import FieldDataCache
|
|
from lms.djangoapps.courseware.module_render import get_module_for_descriptor
|
|
from openedx.core.djangoapps.user_api.tests.factories import UserCourseTagFactory
|
|
from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory
|
|
|
|
|
|
class SplitTestBase(ModuleStoreTestCase):
|
|
"""
|
|
Sets up a basic course and user for split test testing.
|
|
Also provides tests of rendered HTML for two user_tag conditions, 0 and 1.
|
|
"""
|
|
__test__ = False
|
|
COURSE_NUMBER = 'split-test-base'
|
|
ICON_CLASSES = None
|
|
TOOLTIPS = None
|
|
VISIBLE_CONTENT = None
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.partition = UserPartition(
|
|
0,
|
|
'first_partition',
|
|
'First Partition',
|
|
[
|
|
Group(0, 'alpha'),
|
|
Group(1, 'beta')
|
|
]
|
|
)
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
self.course = CourseFactory.create(
|
|
number=self.COURSE_NUMBER,
|
|
user_partitions=[self.partition]
|
|
)
|
|
self.chapter = ItemFactory.create(
|
|
parent_location=self.course.location,
|
|
category="chapter",
|
|
display_name="test chapter",
|
|
)
|
|
self.sequential = ItemFactory.create(
|
|
parent_location=self.chapter.location,
|
|
category="sequential",
|
|
display_name="Split Test Tests",
|
|
)
|
|
|
|
self.student = UserFactory.create()
|
|
CourseEnrollmentFactory.create(user=self.student, course_id=self.course.id)
|
|
self.client.login(username=self.student.username, password='test')
|
|
|
|
self.included_usage_keys = None
|
|
self.excluded_usage_keys = None
|
|
|
|
def _video(self, parent, group):
|
|
"""
|
|
Returns a video component with parent ``parent``
|
|
that is intended to be displayed to group ``group``.
|
|
"""
|
|
return ItemFactory.create(
|
|
parent_location=parent.location,
|
|
category="video",
|
|
display_name=f"Group {group} Sees This Video",
|
|
)
|
|
|
|
def _problem(self, parent, group):
|
|
"""
|
|
Returns a problem component with parent ``parent``
|
|
that is intended to be displayed to group ``group``.
|
|
"""
|
|
return ItemFactory.create(
|
|
parent_location=parent.location,
|
|
category="problem",
|
|
display_name=f"Group {group} Sees This Problem",
|
|
data="<h1>No Problem Defined Yet!</h1>",
|
|
)
|
|
|
|
def _html(self, parent, group):
|
|
"""
|
|
Returns an html component with parent ``parent``
|
|
that is intended to be displayed to group ``group``.
|
|
"""
|
|
return ItemFactory.create(
|
|
parent_location=parent.location,
|
|
category="html",
|
|
display_name=f"Group {group} Sees This HTML",
|
|
data=f"Some HTML for group {group}",
|
|
)
|
|
|
|
def test_split_test_0(self):
|
|
self._check_split_test(0)
|
|
|
|
def test_split_test_1(self):
|
|
self._check_split_test(1)
|
|
|
|
def _check_split_test(self, user_tag):
|
|
"""Checks that the right compentents are rendered for user with ``user_tag``"""
|
|
# This explicitly sets the user_tag for self.student to ``user_tag``
|
|
UserCourseTagFactory(
|
|
user=self.student,
|
|
course_id=self.course.id,
|
|
key=f'xblock.partition_service.partition_{self.partition.id}',
|
|
value=str(user_tag)
|
|
)
|
|
|
|
resp = self.client.get(reverse('render_xblock', args=[str(self.sequential.location)]))
|
|
unicode_content = resp.content.decode(resp.charset)
|
|
|
|
# Assert we see the proper icon in the top display
|
|
assert f'<button class="{self.ICON_CLASSES[user_tag]} inactive nav-item tab"' in unicode_content
|
|
|
|
# And proper tooltips
|
|
for tooltip in self.TOOLTIPS[user_tag]:
|
|
assert tooltip in unicode_content
|
|
|
|
for key in self.included_usage_keys[user_tag]:
|
|
assert str(key) in unicode_content
|
|
|
|
for key in self.excluded_usage_keys[user_tag]:
|
|
assert str(key) not in unicode_content
|
|
|
|
# Assert that we can see the data from the appropriate test condition
|
|
for visible in self.VISIBLE_CONTENT[user_tag]:
|
|
assert visible in unicode_content
|
|
|
|
|
|
class TestSplitTestVert(SplitTestBase):
|
|
"""
|
|
Tests a sequential whose top-level vertical is determined by a split test.
|
|
"""
|
|
__test__ = True
|
|
|
|
COURSE_NUMBER = 'test-split-test-vert-vert'
|
|
|
|
ICON_CLASSES = [
|
|
'seq_problem',
|
|
'seq_video',
|
|
]
|
|
TOOLTIPS = [
|
|
['Condition 0 vertical'],
|
|
['Condition 1 vertical'],
|
|
]
|
|
# Data is html encoded, because it's inactive inside the
|
|
# sequence until javascript is executed
|
|
VISIBLE_CONTENT = [
|
|
['class="problems-wrapper'],
|
|
['Some HTML for group 1']
|
|
]
|
|
|
|
def setUp(self):
|
|
# We define problem compenents that we need but don't explicitly call elsewhere.
|
|
super().setUp()
|
|
|
|
c0_url = self.course.id.make_usage_key("vertical", "split_test_cond0")
|
|
c1_url = self.course.id.make_usage_key("vertical", "split_test_cond1")
|
|
|
|
split_test = ItemFactory.create(
|
|
parent_location=self.sequential.location,
|
|
category="split_test",
|
|
display_name="Split test",
|
|
user_partition_id=0,
|
|
group_id_to_child={"0": c0_url, "1": c1_url},
|
|
)
|
|
|
|
cond0vert = ItemFactory.create(
|
|
parent_location=split_test.location,
|
|
category="vertical",
|
|
display_name="Condition 0 vertical",
|
|
location=c0_url,
|
|
)
|
|
video0 = self._video(cond0vert, 0)
|
|
problem0 = self._problem(cond0vert, 0)
|
|
|
|
cond1vert = ItemFactory.create(
|
|
parent_location=split_test.location,
|
|
category="vertical",
|
|
display_name="Condition 1 vertical",
|
|
location=c1_url,
|
|
)
|
|
video1 = self._video(cond1vert, 1)
|
|
html1 = self._html(cond1vert, 1)
|
|
|
|
self.included_usage_keys = [
|
|
[video0.location, problem0.location],
|
|
[video1.location, html1.location],
|
|
]
|
|
|
|
self.excluded_usage_keys = [
|
|
[video1.location, html1.location],
|
|
[video0.location, problem0.location],
|
|
]
|
|
|
|
|
|
class TestVertSplitTestVert(SplitTestBase):
|
|
"""
|
|
Tests a sequential whose top-level vertical contains a split test determining content within that vertical.
|
|
"""
|
|
__test__ = True
|
|
|
|
COURSE_NUMBER = 'test-vert-split-test-vert'
|
|
|
|
ICON_CLASSES = [
|
|
'seq_problem',
|
|
'seq_video',
|
|
]
|
|
TOOLTIPS = [
|
|
['Split test vertical'],
|
|
['Split test vertical'],
|
|
]
|
|
|
|
# Data is html encoded, because it's inactive inside the
|
|
# sequence until javascript is executed
|
|
VISIBLE_CONTENT = [
|
|
['class="problems-wrapper'],
|
|
['Some HTML for group 1']
|
|
]
|
|
|
|
def setUp(self):
|
|
# We define problem compenents that we need but don't explicitly call elsewhere.
|
|
super().setUp()
|
|
|
|
vert1 = ItemFactory.create(
|
|
parent_location=self.sequential.location,
|
|
category="vertical",
|
|
display_name="Split test vertical",
|
|
)
|
|
c0_url = self.course.id.make_usage_key("vertical", "split_test_cond0")
|
|
c1_url = self.course.id.make_usage_key("vertical", "split_test_cond1")
|
|
|
|
split_test = ItemFactory.create(
|
|
parent_location=vert1.location,
|
|
category="split_test",
|
|
display_name="Split test",
|
|
user_partition_id=0,
|
|
group_id_to_child={"0": c0_url, "1": c1_url},
|
|
)
|
|
|
|
cond0vert = ItemFactory.create(
|
|
parent_location=split_test.location,
|
|
category="vertical",
|
|
display_name="Condition 0 Vertical",
|
|
location=c0_url
|
|
)
|
|
video0 = self._video(cond0vert, 0)
|
|
problem0 = self._problem(cond0vert, 0)
|
|
|
|
cond1vert = ItemFactory.create(
|
|
parent_location=split_test.location,
|
|
category="vertical",
|
|
display_name="Condition 1 Vertical",
|
|
location=c1_url
|
|
)
|
|
video1 = self._video(cond1vert, 1)
|
|
html1 = self._html(cond1vert, 1)
|
|
|
|
self.included_usage_keys = [
|
|
[video0.location, problem0.location],
|
|
[video1.location, html1.location],
|
|
]
|
|
|
|
self.excluded_usage_keys = [
|
|
[video1.location, html1.location],
|
|
[video0.location, problem0.location],
|
|
]
|
|
|
|
|
|
class SplitTestPosition(SharedModuleStoreTestCase):
|
|
"""
|
|
Check that we can change positions in a course with partitions defined
|
|
"""
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.partition = UserPartition(
|
|
0,
|
|
'first_partition',
|
|
'First Partition',
|
|
[
|
|
Group(0, 'alpha'),
|
|
Group(1, 'beta')
|
|
]
|
|
)
|
|
|
|
cls.course = CourseFactory.create(
|
|
user_partitions=[cls.partition]
|
|
)
|
|
|
|
cls.chapter = ItemFactory.create(
|
|
parent_location=cls.course.location,
|
|
category="chapter",
|
|
display_name="test chapter",
|
|
)
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
self.student = UserFactory.create()
|
|
CourseEnrollmentFactory.create(user=self.student, course_id=self.course.id)
|
|
self.client.login(username=self.student.username, password='test')
|
|
|
|
def test_changing_position_works(self):
|
|
# Make a mock FieldDataCache for this course, so we can get the course module
|
|
mock_field_data_cache = FieldDataCache([self.course], self.course.id, self.student)
|
|
course = get_module_for_descriptor(
|
|
self.student,
|
|
MagicMock(name='request'),
|
|
self.course,
|
|
mock_field_data_cache,
|
|
self.course.id,
|
|
course=self.course
|
|
)
|
|
|
|
# Now that we have the course, change the position and save, nothing should explode!
|
|
course.position = 2
|
|
course.save()
|