Merge pull request #526 from edx/dhm/yacibug

Yet another Course Info bug

cms/djangoapps/contentstore/course_info_model.py

 from xmodule.modulestore.exceptions import ItemNotFoundError
 from xmodule.modulestore import Location
 from xmodule.modulestore.django import modulestore
-from lxml import html
+from lxml import html, etree
 import re
 from django.http import HttpResponseBadRequest
 import logging
@@ -74,34 +74,44 @@ def update_course_updates(location, update, passed_id=None):
         escaped = django.utils.html.escape(course_updates.data)
         course_html_parsed = html.fromstring("<ol><li>" + escaped + "</li></ol>")
 
+    # if there's no ol, create it
+    if course_html_parsed.tag != 'ol':
+        # surround whatever's there w/ an ol
+        if course_html_parsed.tag != 'li':
+            # but first wrap in an li
+            li = etree.Element('li')
+            li.append(course_html_parsed)
+            course_html_parsed = li
+        ol = etree.Element('ol')
+        ol.append(course_html_parsed)
+        course_html_parsed = ol
+
     # No try/catch b/c failure generates an error back to client
     new_html_parsed = html.fromstring('<li><h2>' + update['date'] + '</h2>' + update['content'] + '</li>')
 
-    # Confirm that root is <ol>, iterate over <li>, pull out <h2> subs and then rest of val
-    if course_html_parsed.tag == 'ol':
-        # ??? Should this use the id in the json or in the url or does it matter?
-        if passed_id is not None:
-            idx = get_idx(passed_id)
-            # idx is count from end of list
-            course_html_parsed[-idx] = new_html_parsed
-        else:
-            course_html_parsed.insert(0, new_html_parsed)
+    # ??? Should this use the id in the json or in the url or does it matter?
+    if passed_id is not None:
+        idx = get_idx(passed_id)
+        # idx is count from end of list
+        course_html_parsed[-idx] = new_html_parsed
+    else:
+        course_html_parsed.insert(0, new_html_parsed)
 
-            idx = len(course_html_parsed)
-            passed_id = course_updates.location.url() + "/" + str(idx)
+        idx = len(course_html_parsed)
+        passed_id = course_updates.location.url() + "/" + str(idx)
 
-        # update db record
-        course_updates.data = html.tostring(course_html_parsed)
-        modulestore('direct').update_item(location, course_updates.data)
+    # update db record
+    course_updates.data = html.tostring(course_html_parsed)
+    modulestore('direct').update_item(location, course_updates.data)
 
-        if (len(new_html_parsed) == 1):
-            content = new_html_parsed[0].tail
-        else:
-            content = "\n".join([html.tostring(ele) for ele in new_html_parsed[1:]])
+    if (len(new_html_parsed) == 1):
+        content = new_html_parsed[0].tail
+    else:
+        content = "\n".join([html.tostring(ele) for ele in new_html_parsed[1:]])
 
-        return {"id": passed_id,
-                "date": update['date'],
-                "content": content}
+    return {"id": passed_id,
+            "date": update['date'],
+            "content": content}
 
 
 def delete_course_update(location, update, passed_id):

cms/djangoapps/contentstore/tests/test_course_updates.py

@@ -2,6 +2,7 @@
 from contentstore.tests.test_course_settings import CourseTestCase
 from django.core.urlresolvers import reverse
 import json
+from xmodule.modulestore.django import modulestore
 
 
 class CourseUpdateTest(CourseTestCase):
@@ -145,3 +146,36 @@ class CourseUpdateTest(CourseTestCase):
         resp = self.client.delete(url)
         payload = json.loads(resp.content)
         self.assertTrue(len(payload) == before_delete - 1)
+
+    def test_no_ol_course_update(self):
+        '''Test trying to add to a saved course_update which is not an ol.'''
+        # get the updates and set to something wrong
+        location = self.course.location.replace(category='course_info', name='updates')
+        modulestore('direct').create_and_save_xmodule(location)
+        course_updates = modulestore('direct').get_item(location)
+        course_updates.data = 'bad news'
+        modulestore('direct').update_item(location, course_updates.data)
+
+        init_content = '<iframe width="560" height="315" src="http://www.youtube.com/embed/RocY-Jd93XU" frameborder="0">'
+        content = init_content + '</iframe>'
+        payload = {'content': content,
+                   'date': 'January 8, 2013'}
+        url = reverse('course_info_json',
+                      kwargs={'org': self.course.location.org,
+                              'course': self.course.location.course,
+                              'provided_id': ''})
+
+        resp = self.client.post(url, json.dumps(payload), "application/json")
+
+        payload = json.loads(resp.content)
+
+        self.assertHTMLEqual(payload['content'], content)
+
+        # now confirm that the bad news and the iframe make up 2 updates
+        url = reverse('course_info_json',
+                      kwargs={'org': self.course.location.org,
+                              'course': self.course.location.course,
+                              'provided_id': ''})
+        resp = self.client.get(url)
+        payload = json.loads(resp.content)
+        self.assertTrue(len(payload) == 2)