Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #23174 from open-craft/agrendalath/add_course_id_to_html_block

Browse Source 
[BB-2088] Add %%COURSE_ID%% to html block
This commit is contained in:
David Ormsbee
2020-10-07 12:36:36 -04:00
committed by GitHub
parent 2667d8766e 87997d0975
commit 8b2b9b5c74
2 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
common/lib/xmodule/xmodule/html_module.py
View File

@@ -116,8 +116,12 @@ class HtmlBlock(
def get_html(self):
""" Returns html required for rendering the block. """
if self.data is not None and getattr(self.system, 'anonymous_student_id', None) is not None:
return self.data.replace("%%USER_ID%%", self.system.anonymous_student_id)
if self.data:
data = self.data
if getattr(self.runtime, 'anonymous_student_id', None):
data = data.replace("%%USER_ID%%", self.runtime.anonymous_student_id)
data = data.replace("%%COURSE_ID%%", str(self.scope_ids.usage_id.context_key))
return data
return self.data
def studio_view(self, _context):
@@ -459,10 +463,9 @@ class CourseInfoBlock(CourseInfoFields, HtmlBlock):
# When we switch this to an XBlock, we can merge this with student_view,
# but for now the XModule mixin requires that this method be defined.
if self.data != "":
if self.system.anonymous_student_id:
return self.data.replace("%%USER_ID%%", self.system.anonymous_student_id)
return self.data
data = super().get_html()
if data != "":
return data
else:
# This should no longer be called on production now that we are using a separate updates page
# and using a fragment HTML file - it will be called in tests until those are removed.

22
common/lib/xmodule/xmodule/tests/test_html_module.py
View File

@@ -5,7 +5,7 @@ import unittest
import ddt
from django.test.utils import override_settings
from mock import Mock
from opaque_keys.edx.locator import CourseLocator
from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator
from xblock.field_data import DictFieldData
from xblock.fields import ScopeIds
@@ -98,13 +98,31 @@ class HtmlBlockCourseApiTestCase(unittest.TestCase):
class HtmlBlockSubstitutionTestCase(unittest.TestCase):
def test_substitution_works(self):
def test_substitution_user_id(self):
sample_xml = '''%%USER_ID%%'''
field_data = DictFieldData({'data': sample_xml})
module_system = get_test_system()
module = HtmlBlock(module_system, field_data, Mock())
self.assertEqual(module.get_html(), str(module_system.anonymous_student_id))
def test_substitution_course_id(self):
sample_xml = '''%%COURSE_ID%%'''
field_data = DictFieldData({'data': sample_xml})
module_system = get_test_system()
module = HtmlBlock(module_system, field_data, Mock())
course_key = CourseLocator(
org='some_org',
course='some_course',
run='some_run'
)
usage_key = BlockUsageLocator(
course_key=course_key,
block_type='problem',
block_id='block_id'
)
module.scope_ids.usage_id = usage_key
self.assertEqual(module.get_html(), str(course_key))
def test_substitution_without_magic_string(self):
sample_xml = '''
<html>