bc30addfb9
fixing unit tests fixing merge error fixing xqueue submission issue with unicode url (trial 0.1) fixing fotmats as commented upon removing yaml file language selection Unicode changes to support QRF removed unnecessary pass in modulestore/init.py fixing merge error fixing fotmats as commented upon removing yaml file language selection fixing pep8 violations - fixing pylint violations pylint violation fixing line spaces and formats ignore pylint E1101 remove empty line fixing pylint violations pep8 violations bulk mail unicode/decode fix migration error fix pep8 just to push again more unicode/decode Final changes to comments and error messages.
255 lines
10 KiB
Python
255 lines
10 KiB
Python
from ast import literal_eval
|
|
import json
|
|
import unittest
|
|
|
|
from fs.memoryfs import MemoryFS
|
|
from mock import Mock, patch
|
|
|
|
from xblock.field_data import DictFieldData
|
|
from xblock.fields import ScopeIds
|
|
from xmodule.error_module import NonStaffErrorDescriptor
|
|
from xmodule.modulestore import Location
|
|
from xmodule.modulestore.xml import ImportSystem, XMLModuleStore, CourseLocationGenerator
|
|
from xmodule.conditional_module import ConditionalDescriptor
|
|
from xmodule.tests import DATA_DIR, get_test_system, get_test_descriptor_system
|
|
|
|
|
|
ORG = 'test_org'
|
|
COURSE = 'conditional' # name of directory with course data
|
|
|
|
|
|
class DummySystem(ImportSystem):
|
|
|
|
@patch('xmodule.modulestore.xml.OSFS', lambda directory: MemoryFS())
|
|
def __init__(self, load_error_modules):
|
|
|
|
xmlstore = XMLModuleStore("data_dir", course_dirs=[], load_error_modules=load_error_modules)
|
|
|
|
super(DummySystem, self).__init__(
|
|
xmlstore=xmlstore,
|
|
course_id='/'.join([ORG, COURSE, 'test_run']),
|
|
course_dir='test_dir',
|
|
error_tracker=Mock(),
|
|
parent_tracker=Mock(),
|
|
load_error_modules=load_error_modules,
|
|
)
|
|
|
|
def render_template(self, template, context):
|
|
raise Exception("Shouldn't be called")
|
|
|
|
|
|
class ConditionalFactory(object):
|
|
"""
|
|
A helper class to create a conditional module and associated source and child modules
|
|
to allow for testing.
|
|
"""
|
|
@staticmethod
|
|
def create(system, source_is_error_module=False):
|
|
"""
|
|
return a dict of modules: the conditional with a single source and a single child.
|
|
Keys are 'cond_module', 'source_module', and 'child_module'.
|
|
|
|
if the source_is_error_module flag is set, create a real ErrorModule for the source.
|
|
"""
|
|
descriptor_system = get_test_descriptor_system()
|
|
|
|
# construct source descriptor and module:
|
|
source_location = Location(["i4x", "edX", "conditional_test", "problem", "SampleProblem"])
|
|
if source_is_error_module:
|
|
# Make an error descriptor and module
|
|
source_descriptor = NonStaffErrorDescriptor.from_xml(
|
|
'some random xml data',
|
|
system,
|
|
id_generator=CourseLocationGenerator(source_location.org, source_location.course),
|
|
error_msg='random error message'
|
|
)
|
|
else:
|
|
source_descriptor = Mock()
|
|
source_descriptor.location = source_location
|
|
|
|
source_descriptor.runtime = descriptor_system
|
|
source_descriptor.render = lambda view, context=None: descriptor_system.render(source_descriptor, view, context)
|
|
|
|
# construct other descriptors:
|
|
child_descriptor = Mock()
|
|
child_descriptor._xmodule.student_view.return_value.content = u'<p>This is a secret</p>'
|
|
child_descriptor.student_view = child_descriptor._xmodule.student_view
|
|
child_descriptor.displayable_items.return_value = [child_descriptor]
|
|
child_descriptor.runtime = descriptor_system
|
|
child_descriptor.xmodule_runtime = get_test_system()
|
|
child_descriptor.render = lambda view, context=None: descriptor_system.render(child_descriptor, view, context)
|
|
|
|
descriptor_system.load_item = {'child': child_descriptor, 'source': source_descriptor}.get
|
|
|
|
# construct conditional module:
|
|
cond_location = Location(["i4x", "edX", "conditional_test", "conditional", "SampleConditional"])
|
|
field_data = DictFieldData({
|
|
'data': '<conditional/>',
|
|
'xml_attributes': {'attempted': 'true'},
|
|
'children': ['child'],
|
|
})
|
|
|
|
cond_descriptor = ConditionalDescriptor(
|
|
descriptor_system,
|
|
field_data,
|
|
ScopeIds(None, None, cond_location, cond_location)
|
|
)
|
|
cond_descriptor.xmodule_runtime = system
|
|
system.get_module = lambda desc: desc
|
|
cond_descriptor.get_required_module_descriptors = Mock(return_value=[source_descriptor])
|
|
|
|
# return dict:
|
|
return {'cond_module': cond_descriptor,
|
|
'source_module': source_descriptor,
|
|
'child_module': child_descriptor}
|
|
|
|
|
|
class ConditionalModuleBasicTest(unittest.TestCase):
|
|
"""
|
|
Make sure that conditional module works, using mocks for
|
|
other modules.
|
|
"""
|
|
|
|
def setUp(self):
|
|
self.test_system = get_test_system()
|
|
|
|
def test_icon_class(self):
|
|
'''verify that get_icon_class works independent of condition satisfaction'''
|
|
modules = ConditionalFactory.create(self.test_system)
|
|
for attempted in ["false", "true"]:
|
|
for icon_class in ['other', 'problem', 'video']:
|
|
modules['source_module'].is_attempted = attempted
|
|
modules['child_module'].get_icon_class = lambda: icon_class
|
|
self.assertEqual(modules['cond_module'].get_icon_class(), icon_class)
|
|
|
|
def test_get_html(self):
|
|
modules = ConditionalFactory.create(self.test_system)
|
|
# because get_test_system returns the repr of the context dict passed to render_template,
|
|
# we reverse it here
|
|
html = modules['cond_module'].render('student_view').content
|
|
expected = modules['cond_module'].xmodule_runtime.render_template('conditional_ajax.html', {
|
|
'ajax_url': modules['cond_module'].xmodule_runtime.ajax_url,
|
|
'element_id': u'i4x-edX-conditional_test-conditional-SampleConditional',
|
|
'id': u'i4x://edX/conditional_test/conditional/SampleConditional',
|
|
'depends': u'i4x-edX-conditional_test-problem-SampleProblem',
|
|
})
|
|
self.assertEquals(expected, html)
|
|
|
|
def test_handle_ajax(self):
|
|
modules = ConditionalFactory.create(self.test_system)
|
|
modules['source_module'].is_attempted = "false"
|
|
ajax = json.loads(modules['cond_module'].handle_ajax('', ''))
|
|
modules['cond_module'].save()
|
|
print "ajax: ", ajax
|
|
html = ajax['html']
|
|
self.assertFalse(any(['This is a secret' in item for item in html]))
|
|
|
|
# now change state of the capa problem to make it completed
|
|
modules['source_module'].is_attempted = "true"
|
|
ajax = json.loads(modules['cond_module'].handle_ajax('', ''))
|
|
modules['cond_module'].save()
|
|
print "post-attempt ajax: ", ajax
|
|
html = ajax['html']
|
|
self.assertTrue(any(['This is a secret' in item for item in html]))
|
|
|
|
def test_error_as_source(self):
|
|
'''
|
|
Check that handle_ajax works properly if the source is really an ErrorModule,
|
|
and that the condition is not satisfied.
|
|
'''
|
|
modules = ConditionalFactory.create(self.test_system, source_is_error_module=True)
|
|
ajax = json.loads(modules['cond_module'].handle_ajax('', ''))
|
|
modules['cond_module'].save()
|
|
html = ajax['html']
|
|
self.assertFalse(any(['This is a secret' in item for item in html]))
|
|
|
|
|
|
class ConditionalModuleXmlTest(unittest.TestCase):
|
|
"""
|
|
Make sure ConditionalModule works, by loading data in from an XML-defined course.
|
|
"""
|
|
@staticmethod
|
|
def get_system(load_error_modules=True):
|
|
'''Get a dummy system'''
|
|
return DummySystem(load_error_modules)
|
|
|
|
def setUp(self):
|
|
self.test_system = get_test_system()
|
|
|
|
def get_course(self, name):
|
|
"""Get a test course by directory name. If there's more than one, error."""
|
|
print "Importing {0}".format(name)
|
|
|
|
modulestore = XMLModuleStore(DATA_DIR, course_dirs=[name])
|
|
courses = modulestore.get_courses()
|
|
self.modulestore = modulestore
|
|
self.assertEquals(len(courses), 1)
|
|
return courses[0]
|
|
|
|
def test_conditional_module(self):
|
|
"""Make sure that conditional module works"""
|
|
|
|
print "Starting import"
|
|
course = self.get_course('conditional_and_poll')
|
|
|
|
print "Course: ", course
|
|
print "id: ", course.id
|
|
|
|
def inner_get_module(descriptor):
|
|
if isinstance(descriptor, Location):
|
|
location = descriptor
|
|
descriptor = self.modulestore.get_instance(course.id, location, depth=None)
|
|
descriptor.xmodule_runtime = get_test_system()
|
|
descriptor.xmodule_runtime.get_module = inner_get_module
|
|
return descriptor
|
|
|
|
# edx - HarvardX
|
|
# cond_test - ER22x
|
|
location = Location(["i4x", "HarvardX", "ER22x", "conditional", "condone"])
|
|
|
|
def replace_urls(text, staticfiles_prefix=None, replace_prefix='/static/', course_namespace=None):
|
|
return text
|
|
self.test_system.replace_urls = replace_urls
|
|
self.test_system.get_module = inner_get_module
|
|
|
|
module = inner_get_module(location)
|
|
print "module: ", module
|
|
print "module children: ", module.get_children()
|
|
print "module display items (children): ", module.get_display_items()
|
|
|
|
html = module.render('student_view').content
|
|
print "html type: ", type(html)
|
|
print "html: ", html
|
|
html_expect = module.xmodule_runtime.render_template(
|
|
'conditional_ajax.html',
|
|
{
|
|
# Test ajax url is just usage-id / handler_name
|
|
'ajax_url': 'i4x://HarvardX/ER22x/conditional/condone/xmodule_handler',
|
|
'element_id': u'i4x-HarvardX-ER22x-conditional-condone',
|
|
'id': u'i4x://HarvardX/ER22x/conditional/condone',
|
|
'depends': u'i4x-HarvardX-ER22x-problem-choiceprob'
|
|
}
|
|
)
|
|
self.assertEqual(html, html_expect)
|
|
|
|
gdi = module.get_display_items()
|
|
print "gdi=", gdi
|
|
|
|
ajax = json.loads(module.handle_ajax('', ''))
|
|
module.save()
|
|
print "ajax: ", ajax
|
|
html = ajax['html']
|
|
self.assertFalse(any(['This is a secret' in item for item in html]))
|
|
|
|
# Now change state of the capa problem to make it completed
|
|
inner_module = inner_get_module(Location('i4x://HarvardX/ER22x/problem/choiceprob'))
|
|
inner_module.attempts = 1
|
|
# Save our modifications to the underlying KeyValueStore so they can be persisted
|
|
inner_module.save()
|
|
|
|
ajax = json.loads(module.handle_ajax('', ''))
|
|
module.save()
|
|
print "post-attempt ajax: ", ajax
|
|
html = ajax['html']
|
|
self.assertTrue(any(['This is a secret' in item for item in html]))
|