From 1b0eff52edbf229d55eaa7f82a3e0de33a7bd0fd Mon Sep 17 00:00:00 2001
From: Chris Dodge <cdodge@edx.org>
Date: Fri, 10 May 2013 10:01:10 -0400
Subject: [PATCH 1/4] create test cases to simulate error exporting/importing
 textbooks

---
 cms/djangoapps/contentstore/tests/test_contentstore.py | 8 ++++++++
 common/test/data/full/course.xml                       | 2 +-
 common/test/data/full/course/6.002_Spring_2012.xml     | 5 +++--
 lms/djangoapps/courseware/tests/tests.py               | 8 ++++++++
 4 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py
index 07b7032e60..7879ae9222 100644
--- a/cms/djangoapps/contentstore/tests/test_contentstore.py
+++ b/cms/djangoapps/contentstore/tests/test_contentstore.py
@@ -220,6 +220,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase):
         num_drafts = self._get_draft_counts(course)
         self.assertEqual(num_drafts, 1)
 
+    def test_import_textbook_as_content_element(self):
+        import_from_xml(modulestore(), 'common/test/data/', ['full'])
+
+        module_store = modulestore('direct')
+        course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]))
+
+        self.assertGreater(len(course.textbooks), 0)
+
     def test_static_tab_reordering(self):
         import_from_xml(modulestore(), 'common/test/data/', ['full'])
 
diff --git a/common/test/data/full/course.xml b/common/test/data/full/course.xml
index 4f093a1128..7a05db42f2 100644
--- a/common/test/data/full/course.xml
+++ b/common/test/data/full/course.xml
@@ -1 +1 @@
-<course filename="6.002_Spring_2012" slug="6.002_Spring_2012" graceperiod="1 day 12 hours 59 minutes 59 seconds" showanswer="attempted" rerandomize="never" name="6.002 Spring 2012" start="2015-07-17T12:00" course="full" org="edX"/>
+<course filename="6.002_Spring_2012" slug="6.002_Spring_2012" graceperiod="1 day 12 hours 59 minutes 59 seconds" showanswer="attempted" rerandomize="never" name="6.002 Spring 2012" start="2015-07-17T12:00" course="full" org="edX" />
diff --git a/common/test/data/full/course/6.002_Spring_2012.xml b/common/test/data/full/course/6.002_Spring_2012.xml
index 0d22e96beb..e0beb5a3ee 100644
--- a/common/test/data/full/course/6.002_Spring_2012.xml
+++ b/common/test/data/full/course/6.002_Spring_2012.xml
@@ -1,4 +1,5 @@
-<sequential>
+<course>
+  <textbook title="Textbook" book_url="https://s3.amazonaws.com/edx-textbooks/guttag_computation_v3/"/>
   <chapter filename="Overview" slug="Overview" graceperiod="1 day 12 hours 59 minutes 59 seconds" showanswer="attempted" rerandomize="never" name="Overview"/>
   <chapter filename="Week_1" slug="Week_1" graceperiod="1 day 12 hours 59 minutes 59 seconds" showanswer="attempted" rerandomize="never" name="Week 1"/>
   <chapter slug="Midterm_Exam" graceperiod="1 day 12 hours 59 minutes 59 seconds" showanswer="attempted" rerandomize="never" name="Midterm Exam">
@@ -9,4 +10,4 @@
       <vertical filename="vertical_98" slug="vertical_1124" graceperiod="0 day 0 hours 5 minutes 0 seconds" showanswer="attempted" rerandomize="per_student" due="April 30, 12:00" graded="true"/>
     </sequential>
   </chapter>
-</sequential>
+</course>
diff --git a/lms/djangoapps/courseware/tests/tests.py b/lms/djangoapps/courseware/tests/tests.py
index d5064ec5e5..235f7d60bb 100644
--- a/lms/djangoapps/courseware/tests/tests.py
+++ b/lms/djangoapps/courseware/tests/tests.py
@@ -399,6 +399,14 @@ class TestCoursesLoadTestCase_MongoModulestore(PageLoaderTestCase):
         import_from_xml(module_store, TEST_DATA_DIR, ['toy'])
         self.check_random_page_loads(module_store)
 
+    def test_full_textbooks_loads(self):
+        module_store = modulestore()
+        import_from_xml(module_store, TEST_DATA_DIR, ['full'])
+
+        course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]))
+
+        self.assertGreater(len(course.textbooks), 0)
+
 
 @override_settings(MODULESTORE=TEST_DATA_XML_MODULESTORE)
 class TestNavigation(LoginEnrollmentTestCase):

From d95e87cf6734ae0eede773bdd61ccf4e5f24db65 Mon Sep 17 00:00:00 2001
From: Chris Dodge <cdodge@edx.org>
Date: Sat, 11 May 2013 10:34:36 -0400
Subject: [PATCH 2/4] insert the textbook XML element when writing definition
 to xml

---
 common/lib/xmodule/xmodule/course_module.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/common/lib/xmodule/xmodule/course_module.py b/common/lib/xmodule/xmodule/course_module.py
index 5efd7b4005..2a34b75a1f 100644
--- a/common/lib/xmodule/xmodule/course_module.py
+++ b/common/lib/xmodule/xmodule/course_module.py
@@ -382,6 +382,19 @@ class CourseDescriptor(CourseFields, SequenceDescriptor):
 
         return definition, children
 
+    def definition_to_xml(self, resource_fs):
+        xml_object = super(CourseDescriptor, self).definition_to_xml(resource_fs)
+
+        if len(self.textbooks) > 0:
+            textbook_xml_object = etree.Element('textbook')
+            for textbook in self.textbooks:
+                textbook_xml_object.set('title', textbook.title)
+                textbook_xml_object.set('book_url', textbook.book_url)
+
+            xml_object.append(textbook_xml_object)
+
+        return xml_object
+
     def has_ended(self):
         """
         Returns True if the current time is after the specified course end date.

From 3cf865a88f9a41022f7446a089bcc5627a89d489 Mon Sep 17 00:00:00 2001
From: Chris Dodge <cdodge@edx.org>
Date: Mon, 13 May 2013 10:16:18 -0400
Subject: [PATCH 3/4] added another unit test check point for export/import of
 classic textbooks

---
 cms/djangoapps/contentstore/tests/test_contentstore.py | 7 ++++++-
 common/lib/xmodule/xmodule/course_module.py            | 2 +-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py
index 273a276c00..927df009bf 100644
--- a/cms/djangoapps/contentstore/tests/test_contentstore.py
+++ b/cms/djangoapps/contentstore/tests/test_contentstore.py
@@ -226,7 +226,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase):
         module_store = modulestore('direct')
         course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]))
 
-        self.assertGreater(len(course.textbooks), 0)
+        self.assertGreater(len(course.textbooks), 0)     
 
     def test_static_tab_reordering(self):
         import_from_xml(modulestore(), 'common/test/data/', ['full'])
@@ -498,6 +498,11 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase):
 
         self.assertTrue(getattr(test_private_vertical, 'is_draft', False))
 
+        # make sure the textbook survived the export/import
+        course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]))
+
+        self.assertGreater(len(course.textbooks), 0)
+
         shutil.rmtree(root_dir)
 
     def test_course_handouts_rewrites(self):
diff --git a/common/lib/xmodule/xmodule/course_module.py b/common/lib/xmodule/xmodule/course_module.py
index 2a34b75a1f..063e53aef4 100644
--- a/common/lib/xmodule/xmodule/course_module.py
+++ b/common/lib/xmodule/xmodule/course_module.py
@@ -392,7 +392,7 @@ class CourseDescriptor(CourseFields, SequenceDescriptor):
                 textbook_xml_object.set('book_url', textbook.book_url)
 
             xml_object.append(textbook_xml_object)
-
+        
         return xml_object
 
     def has_ended(self):

From 4d197e10ec3f25225e4b8b02e78d52c5b2d27d56 Mon Sep 17 00:00:00 2001
From: Chris Dodge <cdodge@edx.org>
Date: Mon, 13 May 2013 11:10:11 -0400
Subject: [PATCH 4/4] fix some violations. Build up karma

---
 .../contentstore/tests/test_contentstore.py   |  3 +-
 .../contentstore/tests/test_course_updates.py | 75 +++++++++----------
 .../contentstore/tests/test_i18n.py           | 29 ++++---
 3 files changed, 52 insertions(+), 55 deletions(-)

diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py
index 927df009bf..c11b350349 100644
--- a/cms/djangoapps/contentstore/tests/test_contentstore.py
+++ b/cms/djangoapps/contentstore/tests/test_contentstore.py
@@ -226,7 +226,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase):
         module_store = modulestore('direct')
         course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]))
 
-        self.assertGreater(len(course.textbooks), 0)     
+        self.assertGreater(len(course.textbooks), 0)
 
     def test_static_tab_reordering(self):
         import_from_xml(modulestore(), 'common/test/data/', ['full'])
@@ -301,7 +301,6 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase):
         # make sure the parent no longer points to the child object which was deleted
         self.assertFalse(sequential.location.url() in chapter.children)
 
-
     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
diff --git a/cms/djangoapps/contentstore/tests/test_course_updates.py b/cms/djangoapps/contentstore/tests/test_course_updates.py
index 80d4f0bbc2..ae14555b32 100644
--- a/cms/djangoapps/contentstore/tests/test_course_updates.py
+++ b/cms/djangoapps/contentstore/tests/test_course_updates.py
@@ -10,9 +10,9 @@ class CourseUpdateTest(CourseTestCase):
         '''Go through each interface and ensure it works.'''
         # first get the update to force the creation
         url = reverse('course_info',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'name': self.course_location.name})
+                      kwargs={'org': self.course_location.org,
+                      'course': self.course_location.course,
+                      'name': self.course_location.name})
         self.client.get(url)
 
         init_content = '<iframe width="560" height="315" src="http://www.youtube.com/embed/RocY-Jd93XU" frameborder="0">'
@@ -20,9 +20,9 @@ class CourseUpdateTest(CourseTestCase):
         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': ''})
+                      kwargs={'org': self.course_location.org,
+                              'course': self.course_location.course,
+                              'provided_id': ''})
 
         resp = self.client.post(url, json.dumps(payload), "application/json")
 
@@ -31,25 +31,25 @@ class CourseUpdateTest(CourseTestCase):
         self.assertHTMLEqual(payload['content'], content)
 
         first_update_url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': payload['id']})
+                                   kwargs={'org': self.course_location.org,
+                                           'course': self.course_location.course,
+                                           'provided_id': payload['id']})
         content += '<div>div <p>p<br/></p></div>'
         payload['content'] = content
         resp = self.client.post(first_update_url, json.dumps(payload),
-            "application/json")
+                                "application/json")
 
         self.assertHTMLEqual(content, json.loads(resp.content)['content'],
-            "iframe w/ div")
+                             "iframe w/ div")
 
         # now put in an evil update
         content = '<ol/>'
         payload = {'content': content,
                    'date': 'January 11, 2013'}
         url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': ''})
+                      kwargs={'org': self.course_location.org,
+                              'course': self.course_location.course,
+                              'provided_id': ''})
 
         resp = self.client.post(url, json.dumps(payload), "application/json")
 
@@ -58,25 +58,24 @@ class CourseUpdateTest(CourseTestCase):
         self.assertHTMLEqual(content, payload['content'], "self closing ol")
 
         url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': ''})
+                      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)
 
         # can't test non-json paylod b/c expect_json throws error
         # try json w/o required fields
-        self.assertContains(
-            self.client.post(url, json.dumps({'garbage': 1}),
-                "application/json"),
-            'Failed to save', status_code=400)
+        self.assertContains(self.client.post(url, json.dumps({'garbage': 1}),
+                                             "application/json"),
+                            'Failed to save', status_code=400)
 
         # now try to update a non-existent update
         url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': '9'})
+                      kwargs={'org': self.course_location.org,
+                              'course': self.course_location.course,
+                              'provided_id': '9'})
         content = 'blah blah'
         payload = {'content': content,
                    'date': 'January 21, 2013'}
@@ -89,8 +88,8 @@ class CourseUpdateTest(CourseTestCase):
         payload = {'content': content,
                    'date': 'January 11, 2013'}
         url = reverse('course_info_json', kwargs={'org': self.course_location.org,
-            'course': self.course_location.course,
-            'provided_id': ''})
+                                                  'course': self.course_location.course,
+                                                  'provided_id': ''})
 
         self.assertContains(
             self.client.post(url, json.dumps(payload), "application/json"),
@@ -101,8 +100,8 @@ class CourseUpdateTest(CourseTestCase):
         payload = {'content': content,
                    'date': 'January 11, 2013'}
         url = reverse('course_info_json', kwargs={'org': self.course_location.org,
-            'course': self.course_location.course,
-            'provided_id': ''})
+                                                  'course': self.course_location.course,
+                                                  'provided_id': ''})
 
         resp = self.client.post(url, json.dumps(payload), "application/json")
         payload = json.loads(resp.content)
@@ -110,8 +109,8 @@ class CourseUpdateTest(CourseTestCase):
 
         # now try to delete a non-existent update
         url = reverse('course_info_json', kwargs={'org': self.course_location.org,
-            'course': self.course_location.course,
-            'provided_id': '19'})
+                                                  'course': self.course_location.course,
+                                                  'provided_id': '19'})
         payload = {'content': content,
                    'date': 'January 21, 2013'}
         self.assertContains(self.client.delete(url), "delete", status_code=400)
@@ -121,25 +120,25 @@ class CourseUpdateTest(CourseTestCase):
         payload = {'content': content,
                    'date': 'January 28, 2013'}
         url = reverse('course_info_json', kwargs={'org': self.course_location.org,
-            'course': self.course_location.course,
-            'provided_id': ''})
+                                                  'course': self.course_location.course,
+                                                  'provided_id': ''})
         resp = self.client.post(url, json.dumps(payload), "application/json")
         payload = json.loads(resp.content)
         this_id = payload['id']
         self.assertHTMLEqual(content, payload['content'], "single iframe")
         # first count the entries
         url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': ''})
+                      kwargs={'org': self.course_location.org,
+                              'course': self.course_location.course,
+                              'provided_id': ''})
         resp = self.client.get(url)
         payload = json.loads(resp.content)
         before_delete = len(payload)
 
         url = reverse('course_info_json',
-            kwargs={'org': self.course_location.org,
-                'course': self.course_location.course,
-                'provided_id': this_id})
+                      kwargs={'org': self.course_location.org,
+                              'course': self.course_location.course,
+                              'provided_id': this_id})
         resp = self.client.delete(url)
         payload = json.loads(resp.content)
         self.assertTrue(len(payload) == before_delete - 1)
diff --git a/cms/djangoapps/contentstore/tests/test_i18n.py b/cms/djangoapps/contentstore/tests/test_i18n.py
index e6d68ba004..4188b43857 100644
--- a/cms/djangoapps/contentstore/tests/test_i18n.py
+++ b/cms/djangoapps/contentstore/tests/test_i18n.py
@@ -6,6 +6,7 @@ from django.test.client import Client
 
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
 
+
 class InternationalizationTest(ModuleStoreTestCase):
     """
     Tests to validate Internationalization.
@@ -38,34 +39,33 @@ class InternationalizationTest(ModuleStoreTestCase):
             'org': 'MITx',
             'number': '999',
             'display_name': 'Robot Super Course',
-            }
+        }
 
     def test_course_plain_english(self):
         """Test viewing the index page with no courses"""
         self.client = Client()
         self.client.login(username=self.uname, password=self.password)
-        
+
         resp = self.client.get(reverse('index'))
         self.assertContains(resp,
-            '<h1 class="title-1">My Courses</h1>',
-            status_code=200,
-            html=True)
+                            '<h1 class="title-1">My Courses</h1>',
+                            status_code=200,
+                            html=True)
 
     def test_course_explicit_english(self):
         """Test viewing the index page with no courses"""
         self.client = Client()
         self.client.login(username=self.uname, password=self.password)
-        
+
         resp = self.client.get(reverse('index'),
                                {},
                                HTTP_ACCEPT_LANGUAGE='en'
                                )
 
         self.assertContains(resp,
-            '<h1 class="title-1">My Courses</h1>',
-            status_code=200,
-            html=True)        
-
+                            '<h1 class="title-1">My Courses</h1>',
+                            status_code=200,
+                            html=True)
 
     # ****
     # NOTE:
@@ -74,14 +74,13 @@ class InternationalizationTest(ModuleStoreTestCase):
     # This test will break when we replace this fake 'test' language
     # with actual French. This test will need to be updated with
     # actual French at that time.
-    
     # Test temporarily disable since it depends on creation of dummy strings
     @skip
-    def test_course_with_accents (self):
+    def test_course_with_accents(self):
         """Test viewing the index page with no courses"""
         self.client = Client()
         self.client.login(username=self.uname, password=self.password)
-        
+
         resp = self.client.get(reverse('index'),
                                {},
                                HTTP_ACCEPT_LANGUAGE='fr'
@@ -90,8 +89,8 @@ class InternationalizationTest(ModuleStoreTestCase):
         TEST_STRING = u'<h1 class="title-1">' \
                       + u'My \xc7\xf6\xfcrs\xe9s L#' \
                       + u'</h1>'
-        
+
         self.assertContains(resp,
                             TEST_STRING,
                             status_code=200,
-                            html=True)        
+                            html=True)