2735fdc2d4
TNL-4115. Previously, course updates (which are intended to be posted with
dates, for sorting in the LMS) could be authored in studio with a valid
date, nothing, or a random string as the "date" for the update. As there
is no validation for this in studio, everything succeeded with no warning.
However, the LMS has problems parsing some of these values, and barfs when
loaded by learners.
The fix does two big things:
- gracefully handles invalid dates in LMS. These updates are now treated as
having a date of today, for sorting purposes.
- turns on validation in studio. Now, it is not only impossible to enter
invalid dates in studio, but notifications will draw the course author's
eye if any invalid updates were previously saved.
Test additions for this commit:
Adds:
- unit test for LMS parsing
- Jasmine test to confirm invalid dates cannot be set by the user
-also adds event to setAndValidate instead of using a global object
- fix for lettuce test
-It is no longer valid to enter the string "January 1, 2013" as this test
had been doing. Keyed-in entries must use MM/DD/YY format.
184 lines
6.7 KiB
Python
184 lines
6.7 KiB
Python
import unittest
|
|
|
|
from mock import Mock
|
|
|
|
from xblock.field_data import DictFieldData
|
|
from xmodule.html_module import HtmlModule, HtmlDescriptor, CourseInfoModule
|
|
|
|
from . import get_test_system, get_test_descriptor_system
|
|
from opaque_keys.edx.locations import SlashSeparatedCourseKey
|
|
from xblock.fields import ScopeIds
|
|
|
|
|
|
def instantiate_descriptor(**field_data):
|
|
"""
|
|
Instantiate descriptor with most properties.
|
|
"""
|
|
system = get_test_descriptor_system()
|
|
course_key = SlashSeparatedCourseKey('org', 'course', 'run')
|
|
usage_key = course_key.make_usage_key('html', 'SampleHtml')
|
|
return system.construct_xblock_from_class(
|
|
HtmlDescriptor,
|
|
scope_ids=ScopeIds(None, None, usage_key, usage_key),
|
|
field_data=DictFieldData(field_data),
|
|
)
|
|
|
|
|
|
class HtmlModuleSubstitutionTestCase(unittest.TestCase):
|
|
descriptor = Mock()
|
|
|
|
def test_substitution_works(self):
|
|
sample_xml = '''%%USER_ID%%'''
|
|
field_data = DictFieldData({'data': sample_xml})
|
|
module_system = get_test_system()
|
|
module = HtmlModule(self.descriptor, module_system, field_data, Mock())
|
|
self.assertEqual(module.get_html(), str(module_system.anonymous_student_id))
|
|
|
|
def test_substitution_without_magic_string(self):
|
|
sample_xml = '''
|
|
<html>
|
|
<p>Hi USER_ID!11!</p>
|
|
</html>
|
|
'''
|
|
field_data = DictFieldData({'data': sample_xml})
|
|
module_system = get_test_system()
|
|
module = HtmlModule(self.descriptor, module_system, field_data, Mock())
|
|
self.assertEqual(module.get_html(), sample_xml)
|
|
|
|
def test_substitution_without_anonymous_student_id(self):
|
|
sample_xml = '''%%USER_ID%%'''
|
|
field_data = DictFieldData({'data': sample_xml})
|
|
module_system = get_test_system()
|
|
module_system.anonymous_student_id = None
|
|
module = HtmlModule(self.descriptor, module_system, field_data, Mock())
|
|
self.assertEqual(module.get_html(), sample_xml)
|
|
|
|
|
|
class HtmlDescriptorIndexingTestCase(unittest.TestCase):
|
|
"""
|
|
Make sure that HtmlDescriptor can format data for indexing as expected.
|
|
"""
|
|
|
|
def test_index_dictionary_simple_html_module(self):
|
|
sample_xml = '''
|
|
<html>
|
|
<p>Hello World!</p>
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " Hello World! ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
def test_index_dictionary_cdata_html_module(self):
|
|
sample_xml_cdata = '''
|
|
<html>
|
|
<p>This has CDATA in it.</p>
|
|
<![CDATA[This is just a CDATA!]]>
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml_cdata)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " This has CDATA in it. ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
def test_index_dictionary_multiple_spaces_html_module(self):
|
|
sample_xml_tab_spaces = '''
|
|
<html>
|
|
<p> Text has spaces :) </p>
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml_tab_spaces)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " Text has spaces :) ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
def test_index_dictionary_html_module_with_comment(self):
|
|
sample_xml_comment = '''
|
|
<html>
|
|
<p>This has HTML comment in it.</p>
|
|
<!-- Html Comment -->
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml_comment)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " This has HTML comment in it. ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
def test_index_dictionary_html_module_with_both_comments_and_cdata(self):
|
|
sample_xml_mix_comment_cdata = '''
|
|
<html>
|
|
<!-- Beginning of the html -->
|
|
<p>This has HTML comment in it.<!-- Commenting Content --></p>
|
|
<!-- Here comes CDATA -->
|
|
<![CDATA[This is just a CDATA!]]>
|
|
<p>HTML end.</p>
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml_mix_comment_cdata)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " This has HTML comment in it. HTML end. ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
def test_index_dictionary_html_module_with_script_and_style_tags(self):
|
|
sample_xml_style_script_tags = '''
|
|
<html>
|
|
<style>p {color: green;}</style>
|
|
<!-- Beginning of the html -->
|
|
<p>This has HTML comment in it.<!-- Commenting Content --></p>
|
|
<!-- Here comes CDATA -->
|
|
<![CDATA[This is just a CDATA!]]>
|
|
<p>HTML end.</p>
|
|
<script>
|
|
var message = "Hello world!"
|
|
</script>
|
|
</html>
|
|
'''
|
|
descriptor = instantiate_descriptor(data=sample_xml_style_script_tags)
|
|
self.assertEqual(descriptor.index_dictionary(), {
|
|
"content": {"html_content": " This has HTML comment in it. HTML end. ", "display_name": "Text"},
|
|
"content_type": "Text"
|
|
})
|
|
|
|
|
|
class CourseInfoModuleTestCase(unittest.TestCase):
|
|
"""
|
|
Make sure that CourseInfoModule renders updates properly
|
|
"""
|
|
def test_updates_render(self):
|
|
"""
|
|
Tests that a course info module will render its updates, even if they are malformed.
|
|
"""
|
|
sample_update_data = [
|
|
{
|
|
"id": i,
|
|
"date": data,
|
|
"content": "This is a very important update!",
|
|
"status": CourseInfoModule.STATUS_VISIBLE,
|
|
} for i, data in enumerate(
|
|
[
|
|
'January 1, 1970',
|
|
'Marchtober 45, -1963',
|
|
'Welcome!',
|
|
'Date means "title", right?'
|
|
]
|
|
)
|
|
]
|
|
info_module = CourseInfoModule(
|
|
Mock(),
|
|
get_test_system(),
|
|
DictFieldData({'items': sample_update_data, 'data': ""}),
|
|
Mock()
|
|
)
|
|
|
|
# Prior to TNL-4115, an exception would be raised when trying to parse invalid dates in this method
|
|
try:
|
|
info_module.get_html()
|
|
except ValueError:
|
|
self.fail("CourseInfoModule could not parse an invalid date!")
|