From ac7eceb636aed39769bc59a9bb3ca693958dc1d5 Mon Sep 17 00:00:00 2001 From: Chris Dodge Date: Mon, 14 Jan 2013 11:16:48 -0500 Subject: [PATCH 1/4] be sure to first import 'extra' course content from base folder as well as a special override folder for the course run --- common/lib/xmodule/xmodule/modulestore/xml.py | 54 ++++++++++--------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/common/lib/xmodule/xmodule/modulestore/xml.py b/common/lib/xmodule/xmodule/modulestore/xml.py index 47a9ec282e..e01084d231 100644 --- a/common/lib/xmodule/xmodule/modulestore/xml.py +++ b/common/lib/xmodule/xmodule/modulestore/xml.py @@ -442,33 +442,39 @@ class XMLModuleStore(ModuleStoreBase): log.debug('========> Done with course import from {0}'.format(course_dir)) return course_descriptor - def load_extra_content(self, system, course_descriptor, category, base_dir, course_dir, url_name): - if url_name: - path = base_dir / url_name - if not os.path.exists(path): - path = base_dir + def load_extra_content(self, system, course_descriptor, category, base_dir, course_dir, url_name): + + self._load_extra_content(system, course_descriptor, category, base_dir, course_dir) + + # then look in a override folder based on the course run + if os.path.isdir(base_dir / url_name): + self._load_extra_content(system, course_descriptor, category, base_dir / url_name, course_dir) + + + def _load_extra_content(self, system, course_descriptor, category, path, course_dir): for filepath in glob.glob(path/ '*'): - with open(filepath) as f: - try: - html = f.read().decode('utf-8') - # tabs are referenced in policy.json through a 'slug' which is just the filename without the .html suffix - slug = os.path.splitext(os.path.basename(filepath))[0] - loc = Location('i4x', course_descriptor.location.org, course_descriptor.location.course, category, slug) - module = HtmlDescriptor(system, definition={'data' : html}, **{'location' : loc}) - # VS[compat]: - # Hack because we need to pull in the 'display_name' for static tabs (because we need to edit them) - # from the course policy - if category == "static_tab": - for tab in course_descriptor.tabs or []: - if tab.get('url_slug') == slug: - module.metadata['display_name'] = tab['name'] - module.metadata['data_dir'] = course_dir - self.modules[course_descriptor.id][module.location] = module - except Exception, e: - logging.exception("Failed to load {0}. Skipping... Exception: {1}".format(filepath, str(e))) - system.error_tracker("ERROR: " + str(e)) + if not os.path.isdir(filepath): + with open(filepath) as f: + try: + html = f.read().decode('utf-8') + # tabs are referenced in policy.json through a 'slug' which is just the filename without the .html suffix + slug = os.path.splitext(os.path.basename(filepath))[0] + loc = Location('i4x', course_descriptor.location.org, course_descriptor.location.course, category, slug) + module = HtmlDescriptor(system, definition={'data' : html}, **{'location' : loc}) + # VS[compat]: + # Hack because we need to pull in the 'display_name' for static tabs (because we need to edit them) + # from the course policy + if category == "static_tab": + for tab in course_descriptor.tabs or []: + if tab.get('url_slug') == slug: + module.metadata['display_name'] = tab['name'] + module.metadata['data_dir'] = course_dir + self.modules[course_descriptor.id][module.location] = module + except Exception, e: + logging.exception("Failed to load {0}. Skipping... Exception: {1}".format(filepath, str(e))) + system.error_tracker("ERROR: " + str(e)) def get_instance(self, course_id, location, depth=0): """ From edb913f6ac360f434d962f1ddf7d6fdb7476e5da Mon Sep 17 00:00:00 2001 From: Chris Dodge Date: Mon, 14 Jan 2013 12:12:40 -0500 Subject: [PATCH 2/4] add tests for about content overrides --- cms/djangoapps/contentstore/tests/tests.py | 7 +++++++ common/test/data/full/about/6.002_Spring_2012/effort.html | 1 + common/test/data/full/about/effort.html | 1 + 3 files changed, 9 insertions(+) create mode 100644 common/test/data/full/about/6.002_Spring_2012/effort.html create mode 100644 common/test/data/full/about/effort.html diff --git a/cms/djangoapps/contentstore/tests/tests.py b/cms/djangoapps/contentstore/tests/tests.py index d0b8261908..5e1c364abd 100644 --- a/cms/djangoapps/contentstore/tests/tests.py +++ b/cms/djangoapps/contentstore/tests/tests.py @@ -350,6 +350,13 @@ class ContentStoreTest(TestCase): def test_edit_unit_full(self): self.check_edit_unit('full') + def test_about_overrides(self): + import_from_xml(modulestore(), 'common/test/data/', ['full']) + ms = modulestore('direct') + effort = ms.get_item(Location(['i4x','edX','full','about','effort', None])) + self.assertEqual(effort.definition['data'],'6 hours') + + def test_clone_course(self): import_from_xml(modulestore(), 'common/test/data/', ['full']) diff --git a/common/test/data/full/about/6.002_Spring_2012/effort.html b/common/test/data/full/about/6.002_Spring_2012/effort.html new file mode 100644 index 0000000000..3ef8bf8ce1 --- /dev/null +++ b/common/test/data/full/about/6.002_Spring_2012/effort.html @@ -0,0 +1 @@ +6 hours \ No newline at end of file diff --git a/common/test/data/full/about/effort.html b/common/test/data/full/about/effort.html new file mode 100644 index 0000000000..c983fdcb5c --- /dev/null +++ b/common/test/data/full/about/effort.html @@ -0,0 +1 @@ +12 hours \ No newline at end of file From b5776a775e4b52d93848069d5d3b07769fab4537 Mon Sep 17 00:00:00 2001 From: Chris Dodge Date: Mon, 14 Jan 2013 12:17:51 -0500 Subject: [PATCH 3/4] add another assert test --- cms/djangoapps/contentstore/tests/tests.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cms/djangoapps/contentstore/tests/tests.py b/cms/djangoapps/contentstore/tests/tests.py index 5e1c364abd..2597ac64fd 100644 --- a/cms/djangoapps/contentstore/tests/tests.py +++ b/cms/djangoapps/contentstore/tests/tests.py @@ -351,11 +351,19 @@ class ContentStoreTest(TestCase): self.check_edit_unit('full') def test_about_overrides(self): + ''' + This test case verifies that a course can use specialized override for about data, e.g. /about/Fall_2012/effort.html + while there is a base definition in /about/effort.html + ''' import_from_xml(modulestore(), 'common/test/data/', ['full']) ms = modulestore('direct') effort = ms.get_item(Location(['i4x','edX','full','about','effort', None])) self.assertEqual(effort.definition['data'],'6 hours') + # this one should be in a non-override folder + effort = ms.get_item(Location(['i4x','edX','full','about','end_date', None])) + self.assertEqual(effort.definition['data'],'TBD') + def test_clone_course(self): import_from_xml(modulestore(), 'common/test/data/', ['full']) From 9f73294959dd6b642e5ac5d2d26f016c489b1aa9 Mon Sep 17 00:00:00 2001 From: Chris Dodge Date: Mon, 14 Jan 2013 12:23:36 -0500 Subject: [PATCH 4/4] add end_date.html file --- common/test/data/full/about/end_date.html | 1 + 1 file changed, 1 insertion(+) create mode 100644 common/test/data/full/about/end_date.html diff --git a/common/test/data/full/about/end_date.html b/common/test/data/full/about/end_date.html new file mode 100644 index 0000000000..2fd9f95700 --- /dev/null +++ b/common/test/data/full/about/end_date.html @@ -0,0 +1 @@ +TBD \ No newline at end of file