Move course and item factories to xmodule.modulestore.tests

common/djangoapps/student/tests/factories.py

@@ -3,12 +3,7 @@ from student.models import (User, UserProfile, Registration,
 from django.contrib.auth.models import Group
 from datetime import datetime
 from factory import Factory, SubFactory
-from xmodule.modulestore import Location
-from xmodule.modulestore.django import modulestore
-from time import gmtime
 from uuid import uuid4
-from xmodule.timeparse import stringify_time
-from xmodule.modulestore.inheritance import own_metadata
 
 
 class GroupFactory(Factory):
@@ -62,144 +57,3 @@ class CourseEnrollmentAllowedFactory(Factory):
 
     email = 'test@edx.org'
     course_id = 'edX/test/2012_Fall'
-
-
-def XMODULE_COURSE_CREATION(class_to_create, **kwargs):
-    return XModuleCourseFactory._create(class_to_create, **kwargs)
-
-
-def XMODULE_ITEM_CREATION(class_to_create, **kwargs):
-    return XModuleItemFactory._create(class_to_create, **kwargs)
-
-
-class XModuleCourseFactory(Factory):
-    """
-    Factory for XModule courses.
-    """
-
-    ABSTRACT_FACTORY = True
-    _creation_function = (XMODULE_COURSE_CREATION,)
-
-    @classmethod
-    def _create(cls, target_class, *args, **kwargs):
-
-        template = Location('i4x', 'edx', 'templates', 'course', 'Empty')
-        org = kwargs.get('org')
-        number = kwargs.get('number')
-        display_name = kwargs.get('display_name')
-        location = Location('i4x', org, number,
-                            'course', Location.clean(display_name))
-
-        store = modulestore('direct')
-
-        # Write the data to the mongo datastore
-        new_course = store.clone_item(template, location)
-
-        # This metadata code was copied from cms/djangoapps/contentstore/views.py
-        if display_name is not None:
-            new_course.display_name = display_name
-
-        new_course.lms.start = gmtime()
-        new_course.tabs = [{"type": "courseware"},
-                           {"type": "course_info", "name": "Course Info"},
-                           {"type": "discussion", "name": "Discussion"},
-                           {"type": "wiki", "name": "Wiki"},
-                           {"type": "progress", "name": "Progress"}]
-
-        # Update the data in the mongo datastore
-        store.update_metadata(new_course.location.url(), own_metadata(new_course))
-
-        return new_course
-
-
-class Course:
-    pass
-
-
-class CourseFactory(XModuleCourseFactory):
-    FACTORY_FOR = Course
-
-    template = 'i4x://edx/templates/course/Empty'
-    org = 'MITx'
-    number = '999'
-    display_name = 'Robot Super Course'
-
-
-class XModuleItemFactory(Factory):
-    """
-    Factory for XModule items.
-    """
-
-    ABSTRACT_FACTORY = True
-    _creation_function = (XMODULE_ITEM_CREATION,)
-
-    @classmethod
-    def _create(cls, target_class, *args, **kwargs):
-        """
-        Uses *kwargs*:
-
-        *parent_location* (required): the location of the parent module
-            (e.g. the parent course or section)
-
-        *template* (required): the template to create the item from
-            (e.g. i4x://templates/section/Empty)
-
-        *data* (optional): the data for the item
-            (e.g. XML problem definition for a problem item)
-
-        *display_name* (optional): the display name of the item
-
-        *metadata* (optional): dictionary of metadata attributes
-
-        *target_class* is ignored
-        """
-
-        DETACHED_CATEGORIES = ['about', 'static_tab', 'course_info']
-
-        parent_location = Location(kwargs.get('parent_location'))
-        template = Location(kwargs.get('template'))
-        data = kwargs.get('data')
-        display_name = kwargs.get('display_name')
-        metadata = kwargs.get('metadata', {})
-
-        store = modulestore('direct')
-
-        # This code was based off that in cms/djangoapps/contentstore/views.py
-        parent = store.get_item(parent_location)
-
-        # If a display name is set, use that
-        dest_name = display_name.replace(" ", "_") if display_name is not None else uuid4().hex
-        dest_location = parent_location._replace(category=template.category,
-                                                 name=dest_name)
-
-        new_item = store.clone_item(template, dest_location)
-
-        # replace the display name with an optional parameter passed in from the caller
-        if display_name is not None:
-            new_item.display_name = display_name
-
-        # Add additional metadata or override current metadata
-        item_metadata = own_metadata(new_item)
-        item_metadata.update(metadata)
-        store.update_metadata(new_item.location.url(), item_metadata)
-
-        # replace the data with the optional *data* parameter
-        if data is not None:
-            store.update_item(new_item.location, data)
-
-        if new_item.location.category not in DETACHED_CATEGORIES:
-            store.update_children(parent_location, parent.children + [new_item.location.url()])
-
-        return new_item
-
-
-class Item:
-    pass
-
-
-class ItemFactory(XModuleItemFactory):
-    FACTORY_FOR = Item
-
-    parent_location = 'i4x://MITx/999/course/Robot_Super_Course'
-    template = 'i4x://edx/templates/chapter/Empty'
-    display_name = 'Section One'

common/djangoapps/terrain/factories.py

@@ -2,11 +2,9 @@
 Factories are defined in other modules and absorbed here into the
 lettuce world so that they can be used by both unit tests
 and integration / BDD tests.
-
-TODO: move the course and item factories out of student and into
-xmodule/modulestore
 '''
 import student.tests.factories as sf
+import xmodule.modulestore.tests.factories as xf
 from lettuce import world
 
 
@@ -51,7 +49,7 @@ class CourseEnrollmentAllowedFactory(sf.CourseEnrollmentAllowed):
 
 
 @world.absorb
-class CourseFactory(sf.CourseFactory):
+class CourseFactory(xf.CourseFactory):
     """
     Courseware courses
     """
@@ -59,7 +57,7 @@ class CourseFactory(sf.CourseFactory):
 
 
 @world.absorb
-class ItemFactory(sf.ItemFactory):
+class ItemFactory(xf.ItemFactory):
     """
     Everything included inside a course
     """

common/lib/xmodule/xmodule/modulestore/tests/factories.py

@@ -25,8 +25,7 @@ class XModuleCourseFactory(Factory):
 
     @classmethod
     def _create(cls, target_class, *args, **kwargs):
-        # This logic was taken from the create_new_course method in
-        # cms/djangoapps/contentstore/views.py
+
         template = Location('i4x', 'edx', 'templates', 'course', 'Empty')
         org = kwargs.get('org')
         number = kwargs.get('number')
@@ -43,8 +42,7 @@ class XModuleCourseFactory(Factory):
         if display_name is not None:
             new_course.display_name = display_name
 
-        new_course.start = gmtime()
-
+        new_course.lms.start = gmtime()
         new_course.tabs = [{"type": "courseware"},
                            {"type": "course_info", "name": "Course Info"},
                            {"type": "discussion", "name": "Discussion"},
@@ -81,21 +79,41 @@ class XModuleItemFactory(Factory):
     @classmethod
     def _create(cls, target_class, *args, **kwargs):
         """
-        kwargs must include parent_location, template. Can contain display_name
-        target_class is ignored
+        Uses *kwargs*:
+
+        *parent_location* (required): the location of the parent module
+            (e.g. the parent course or section)
+
+        *template* (required): the template to create the item from
+            (e.g. i4x://templates/section/Empty)
+
+        *data* (optional): the data for the item
+            (e.g. XML problem definition for a problem item)
+
+        *display_name* (optional): the display name of the item
+
+        *metadata* (optional): dictionary of metadata attributes
+
+        *target_class* is ignored
         """
 
         DETACHED_CATEGORIES = ['about', 'static_tab', 'course_info']
 
         parent_location = Location(kwargs.get('parent_location'))
         template = Location(kwargs.get('template'))
+        data = kwargs.get('data')
         display_name = kwargs.get('display_name')
+        metadata = kwargs.get('metadata', {})
 
         store = modulestore('direct')
 
         # This code was based off that in cms/djangoapps/contentstore/views.py
         parent = store.get_item(parent_location)
-        dest_location = parent_location._replace(category=template.category, name=uuid4().hex)
+
+        # If a display name is set, use that
+        dest_name = display_name.replace(" ", "_") if display_name is not None else uuid4().hex
+        dest_location = parent_location._replace(category=template.category,
+                                                 name=dest_name)
 
         new_item = store.clone_item(template, dest_location)
 
@@ -103,7 +121,14 @@ class XModuleItemFactory(Factory):
         if display_name is not None:
             new_item.display_name = display_name
 
-        store.update_metadata(new_item.location.url(), own_metadata(new_item))
+        # Add additional metadata or override current metadata
+        item_metadata = own_metadata(new_item)
+        item_metadata.update(metadata)
+        store.update_metadata(new_item.location.url(), item_metadata)
+
+        # replace the data with the optional *data* parameter
+        if data is not None:
+            store.update_item(new_item.location, data)
 
         if new_item.location.category not in DETACHED_CATEGORIES:
             store.update_children(parent_location, parent.children + [new_item.location.url()])