164 lines
6.7 KiB
Python
164 lines
6.7 KiB
Python
"""
|
|
Tests for sequence module.
|
|
"""
|
|
# pylint: disable=no-member
|
|
from mock import Mock
|
|
from xblock.reference.user_service import XBlockUser, UserService
|
|
from xmodule.tests import get_test_system
|
|
from xmodule.tests.xml import XModuleXmlImportTest
|
|
from xmodule.tests.xml import factories as xml
|
|
from xmodule.x_module import STUDENT_VIEW
|
|
from xmodule.seq_module import _compute_next_url, _compute_previous_url, SequenceModule
|
|
|
|
|
|
class StubUserService(UserService):
|
|
"""
|
|
Stub UserService for testing the sequence module.
|
|
"""
|
|
def get_current_user(self):
|
|
"""
|
|
Implements abstract method for getting the current user.
|
|
"""
|
|
user = XBlockUser()
|
|
user.opt_attrs['edx-platform.username'] = 'test user'
|
|
return user
|
|
|
|
|
|
class SequenceBlockTestCase(XModuleXmlImportTest):
|
|
"""
|
|
Tests for the Sequence Module.
|
|
"""
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super(SequenceBlockTestCase, cls).setUpClass()
|
|
|
|
course_xml = cls._set_up_course_xml()
|
|
cls.course = cls.process_xml(course_xml)
|
|
cls._set_up_module_system(cls.course)
|
|
|
|
for chapter_index in range(len(cls.course.get_children())):
|
|
chapter = cls._set_up_block(cls.course, chapter_index)
|
|
setattr(cls, 'chapter_{}'.format(chapter_index + 1), chapter)
|
|
|
|
for sequence_index in range(len(chapter.get_children())):
|
|
sequence = cls._set_up_block(chapter, sequence_index)
|
|
setattr(cls, 'sequence_{}_{}'.format(chapter_index + 1, sequence_index + 1), sequence)
|
|
|
|
@classmethod
|
|
def _set_up_course_xml(cls):
|
|
"""
|
|
Sets up and returns XML course structure.
|
|
"""
|
|
course = xml.CourseFactory.build()
|
|
|
|
chapter_1 = xml.ChapterFactory.build(parent=course) # has 2 child sequences
|
|
xml.ChapterFactory.build(parent=course) # has 0 child sequences
|
|
chapter_3 = xml.ChapterFactory.build(parent=course) # has 1 child sequence
|
|
chapter_4 = xml.ChapterFactory.build(parent=course) # has 2 child sequences
|
|
|
|
xml.SequenceFactory.build(parent=chapter_1)
|
|
xml.SequenceFactory.build(parent=chapter_1)
|
|
sequence_3_1 = xml.SequenceFactory.build(parent=chapter_3) # has 3 verticals
|
|
xml.SequenceFactory.build(parent=chapter_4)
|
|
xml.SequenceFactory.build(parent=chapter_4)
|
|
|
|
for _ in range(3):
|
|
xml.VerticalFactory.build(parent=sequence_3_1)
|
|
|
|
return course
|
|
|
|
@classmethod
|
|
def _set_up_block(cls, parent, index_in_parent):
|
|
"""
|
|
Sets up the stub sequence module for testing.
|
|
"""
|
|
block = parent.get_children()[index_in_parent]
|
|
|
|
cls._set_up_module_system(block)
|
|
|
|
block.xmodule_runtime._services['bookmarks'] = Mock() # pylint: disable=protected-access
|
|
block.xmodule_runtime._services['user'] = StubUserService() # pylint: disable=protected-access
|
|
block.xmodule_runtime.xmodule_instance = getattr(block, '_xmodule', None) # pylint: disable=protected-access
|
|
block.parent = parent.location
|
|
return block
|
|
|
|
@classmethod
|
|
def _set_up_module_system(cls, block):
|
|
"""
|
|
Sets up the test module system for the given block.
|
|
"""
|
|
module_system = get_test_system()
|
|
module_system.descriptor_runtime = block._runtime # pylint: disable=protected-access
|
|
block.xmodule_runtime = module_system
|
|
|
|
def test_student_view_init(self):
|
|
seq_module = SequenceModule(runtime=Mock(position=2), descriptor=Mock(), scope_ids=Mock())
|
|
self.assertEquals(seq_module.position, 2) # matches position set in the runtime
|
|
|
|
def test_render_student_view(self):
|
|
html = self._get_rendered_student_view(self.sequence_3_1, requested_child=None)
|
|
self._assert_view_at_position(html, expected_position=1)
|
|
self.assertIn(unicode(self.sequence_3_1.location), html)
|
|
self.assertIn("'next_url': u'{}'".format(unicode(self.chapter_4.location)), html)
|
|
self.assertIn("'prev_url': u'{}'".format(unicode(self.chapter_2.location)), html)
|
|
|
|
def test_student_view_first_child(self):
|
|
html = self._get_rendered_student_view(self.sequence_3_1, requested_child='first')
|
|
self._assert_view_at_position(html, expected_position=1)
|
|
|
|
def test_student_view_last_child(self):
|
|
html = self._get_rendered_student_view(self.sequence_3_1, requested_child='last')
|
|
self._assert_view_at_position(html, expected_position=3)
|
|
|
|
def _get_rendered_student_view(self, sequence, requested_child):
|
|
"""
|
|
Returns the rendered student view for the given sequence and the
|
|
requested_child parameter.
|
|
"""
|
|
return sequence.xmodule_runtime.render(
|
|
sequence,
|
|
STUDENT_VIEW,
|
|
{
|
|
'redirect_url_func': lambda course_key, block_location, child: unicode(block_location),
|
|
'requested_child': requested_child,
|
|
},
|
|
).content
|
|
|
|
def _assert_view_at_position(self, rendered_html, expected_position):
|
|
"""
|
|
Verifies that the rendered view contains the expected position.
|
|
"""
|
|
self.assertIn("'position': {}".format(expected_position), rendered_html)
|
|
|
|
def test_compute_next_url(self):
|
|
|
|
for sequence, parent, expected_next_sequence_location in [
|
|
(self.sequence_1_1, self.chapter_1, self.sequence_1_2.location),
|
|
(self.sequence_1_2, self.chapter_1, self.chapter_2.location),
|
|
(self.sequence_3_1, self.chapter_3, self.chapter_4.location),
|
|
(self.sequence_4_1, self.chapter_4, self.sequence_4_2.location),
|
|
(self.sequence_4_2, self.chapter_4, None),
|
|
]:
|
|
actual_next_sequence_location = _compute_next_url(
|
|
sequence.location,
|
|
parent,
|
|
lambda course_key, block_location, child: block_location,
|
|
)
|
|
self.assertEquals(actual_next_sequence_location, expected_next_sequence_location)
|
|
|
|
def test_compute_previous_url(self):
|
|
|
|
for sequence, parent, expected_prev_sequence_location in [
|
|
(self.sequence_1_1, self.chapter_1, None),
|
|
(self.sequence_1_2, self.chapter_1, self.sequence_1_1.location),
|
|
(self.sequence_3_1, self.chapter_3, self.chapter_2.location),
|
|
(self.sequence_4_1, self.chapter_4, self.chapter_3.location),
|
|
(self.sequence_4_2, self.chapter_4, self.sequence_4_1.location),
|
|
]:
|
|
actual_next_sequence_location = _compute_previous_url(
|
|
sequence.location,
|
|
parent,
|
|
lambda course_key, block_location, child: block_location,
|
|
)
|
|
self.assertEquals(actual_next_sequence_location, expected_prev_sequence_location)
|