Write restful service to find all orphans

To help fix recent bugs re orphaned discussions and
to prototype a more restful json oriented api.

cms/djangoapps/contentstore/tests/test_orphan.py

@@ -0,0 +1,58 @@
+"""
+Test finding orphans via the view and django config
+"""
+import json
+from contentstore.tests.utils import CourseTestCase
+from xmodule.modulestore.django import editable_modulestore
+from django.core.urlresolvers import reverse
+
+class TestOrphan(CourseTestCase):
+    """
+    Test finding orphans via view and django config
+    """
+    def setUp(self):
+        super(TestOrphan, self).setUp()
+
+        runtime = self.course.runtime
+
+        self._create_item('chapter', 'Chapter1', {}, {'display_name': 'Chapter 1'}, 'course', self.course.location.name, runtime)
+        self._create_item('chapter', 'Chapter2', {}, {'display_name': 'Chapter 2'}, 'course', self.course.location.name, runtime)
+        self._create_item('chapter', 'OrphanChapter', {}, {'display_name': 'Orphan Chapter'}, None, None, runtime)
+        self._create_item('vertical', 'Vert1', {}, {'display_name': 'Vertical 1'}, 'chapter', 'Chapter1', runtime)
+        self._create_item('vertical', 'OrphanVert', {}, {'display_name': 'Orphan Vertical'}, None, None, runtime)
+        self._create_item('html', 'Html1', "<p>Goodbye</p>", {'display_name': 'Parented Html'}, 'vertical', 'Vert1', runtime)
+        self._create_item('html', 'OrphanHtml', "<p>Hello</p>", {'display_name': 'Orphan html'}, None, None, runtime)
+        self._create_item('static_tab', 'staticuno', "<p>tab</p>", {'display_name': 'Tab uno'}, None, None, runtime)
+        self._create_item('about', 'overview', "<p>overview</p>", {}, None, None, runtime)
+        self._create_item('course_info', 'updates', "<ol><li><h2>Sep 22</h2><p>test</p></li></ol>", {}, None, None, runtime)
+
+    def _create_item(self, category, name, data, metadata, parent_category, parent_name, runtime):
+        location = self.course.location.replace(category=category, name=name)
+        editable_modulestore('direct').create_and_save_xmodule(location, data, metadata, runtime)
+        if parent_name:
+            # add child to parent in mongo
+            parent_location = self.course.location.replace(category=parent_category, name=parent_name)
+            parent = editable_modulestore('direct').get_item(parent_location)
+            parent.children.append(location.url())
+            editable_modulestore('direct').update_children(parent_location, parent.children)
+
+    def test_mongo_orphan(self):
+        """
+        Test that old mongo finds the orphans
+        """
+        orphans = json.loads(
+            self.client.get(
+                reverse(
+                    'orphan',
+                    kwargs={'course_id': '{}.{}'.format(self.course.location.org, self.course.location.course)}
+                ),
+                HTTP_ACCEPT='application/json'
+            ).content
+        )
+        self.assertEqual(len(orphans), 3, "Wrong # {}".format(orphans))
+        location = self.course.location.replace(category='chapter', name='OrphanChapter')
+        self.assertIn(location.url(), orphans)
+        location = self.course.location.replace(category='vertical', name='OrphanVert')
+        self.assertIn(location.url(), orphans)
+        location = self.course.location.replace(category='html', name='OrphanHtml')
+        self.assertIn(location.url(), orphans)

cms/djangoapps/contentstore/views/item.py

@@ -21,7 +21,7 @@ from .access import has_access
 from .helpers import _xmodule_recurse
 from xmodule.x_module import XModuleDescriptor
 
-__all__ = ['save_item', 'create_item', 'delete_item']
+__all__ = ['save_item', 'create_item', 'delete_item', 'orphan']
 
 log = logging.getLogger(__name__)
 
@@ -200,3 +200,20 @@ def delete_item(request):
                 modulestore('direct').update_children(parent.location, parent.children)
 
     return JsonResponse()
+
+
+@login_required
+def orphan(request, course_id):
+    """
+    View for handling orphan related requests. A get gets all of the current orphans.
+    DELETE, PUT and POST are meaningless for now.
+
+    An orphan is a block whose category is not in the DETACHED_CATEGORY list, is not the root, and is not reachable
+    from the root via children
+
+    :param request:
+    :param course_id: Locator syntax course_id
+    """
+    # dhm: I'd add DELETE but I'm not sure what type of authentication/authorization we'd need
+    if request.method == 'GET':
+        return JsonResponse(modulestore().get_orphans(course_id, DETACHED_CATEGORIES, 'draft'))