Merge branch 'master' into feature/diana/close-oe-problems

cms/djangoapps/contentstore/tests/factories.py

 from factory import Factory
-from xmodule.modulestore import Location
-from xmodule.modulestore.django import modulestore
-from time import gmtime
+from datetime import datetime
 from uuid import uuid4
-from xmodule.timeparse import stringify_time
+from student.models import (User, UserProfile, Registration,
+                            CourseEnrollmentAllowed)
+from django.contrib.auth.models import Group
 
+class UserProfileFactory(Factory):
+    FACTORY_FOR = UserProfile
 
-def XMODULE_COURSE_CREATION(class_to_create, **kwargs): 
-    return XModuleCourseFactory._create(class_to_create, **kwargs)
+    user = None
+    name = 'Robot Studio'
+    courseware = 'course.xml'
 
-def XMODULE_ITEM_CREATION(class_to_create, **kwargs):
-    return XModuleItemFactory._create(class_to_create, **kwargs)
+class RegistrationFactory(Factory):
+    FACTORY_FOR = Registration
 
-class XModuleCourseFactory(Factory):
-    """
-    Factory for XModule courses.
-    """
+    user = None
+    activation_key = uuid4().hex
 
-    ABSTRACT_FACTORY = True
-    _creation_function = (XMODULE_COURSE_CREATION,)
+class UserFactory(Factory):
+    FACTORY_FOR = User
 
-    @classmethod
-    def _create(cls, target_class, *args, **kwargs):
+    username = 'robot'
+    email = 'robot@edx.org'
+    password = 'test'
+    first_name = 'Robot'
+    last_name = 'Tester'
+    is_staff = False
+    is_active = True
+    is_superuser = False
+    last_login = datetime.now()
+    date_joined = datetime.now()
 
-        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))
+class GroupFactory(Factory):
+    FACTORY_FOR = Group
 
-        store = modulestore('direct')
+    name = 'test_group'
 
-        # Write the data to the mongo datastore
-        new_course = store.clone_item(template, location)
+class CourseEnrollmentAllowedFactory(Factory):
+    FACTORY_FOR = CourseEnrollmentAllowed
 
-        # This metadata code was copied from cms/djangoapps/contentstore/views.py
-        if display_name is not None:
-            new_course.metadata['display_name'] = display_name
-
-        new_course.metadata['data_dir'] = uuid4().hex
-        new_course.metadata['start'] = stringify_time(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(), new_course.own_metadata)   
-
-        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):
-        """
-        kwargs must include parent_location, template. Can contain display_name
-        target_class is ignored
-        """
-
-        DETACHED_CATEGORIES = ['about', 'static_tab', 'course_info']
-        
-        parent_location = Location(kwargs.get('parent_location'))
-        template = Location(kwargs.get('template'))
-        display_name = kwargs.get('display_name')
-
-        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)
-
-        new_item = store.clone_item(template, dest_location)
-
-        # TODO: This needs to be deleted when we have proper storage for static content
-        new_item.metadata['data_dir'] = parent.metadata['data_dir']
-
-        # replace the display name with an optional parameter passed in from the caller
-        if display_name is not None:
-            new_item.metadata['display_name'] = display_name
-
-        store.update_metadata(new_item.location.url(), new_item.own_metadata)
-
-        if new_item.location.category not in DETACHED_CATEGORIES:
-            store.update_children(parent_location, parent.definition.get('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'
+    email = 'test@edx.org'
+    course_id = 'edX/test/2012_Fall'
\ No newline at end of file

cms/djangoapps/contentstore/tests/test_core_caching.py

-from django.test.testcases import TestCase
 from cache_toolbox.core import get_cached_content, set_cached_content, del_cached_content
 from xmodule.modulestore import Location
 from xmodule.contentstore.content import StaticContent
+from django.test import TestCase
 
 class Content:
     def __init__(self, location, content):
@@ -32,7 +32,3 @@ class CachingTestCase(TestCase):
             'should not be stored in cache with unicodeLocation')
         self.assertEqual(None, get_cached_content(self.nonUnicodeLocation),
             'should not be stored in cache with nonUnicodeLocation')
-
-
-
-

cms/djangoapps/contentstore/tests/test_course_settings.py

-from django.test.testcases import TestCase
 import datetime
 import time
-from django.contrib.auth.models import User
-import xmodule
-from django.test.client import Client
-from django.core.urlresolvers import reverse
-from xmodule.modulestore import Location
-from cms.djangoapps.models.settings.course_details import CourseDetails,\
-    CourseSettingsEncoder
 import json
-from util import converters
 import calendar
+import copy
+from util import converters
 from util.converters import jsdate_to_time
+
+from django.contrib.auth.models import User
+from django.test.client import Client
+from django.core.urlresolvers import reverse
 from django.utils.timezone import UTC
+
+import xmodule
+from xmodule.modulestore import Location
+from cms.djangoapps.models.settings.course_details import (CourseDetails,
+                                                    CourseSettingsEncoder)
 from cms.djangoapps.models.settings.course_grading import CourseGradingModel
 from cms.djangoapps.contentstore.utils import get_modulestore
-import copy
+
+from django.test import TestCase
+from utils import ModuleStoreTestCase
+from xmodule.modulestore.tests.factories import CourseFactory
+
 
 # YYYY-MM-DDThh:mm:ss.s+/-HH:MM
 class ConvertersTestCase(TestCase):
@@ -36,8 +42,15 @@ class ConvertersTestCase(TestCase):
         self.compare_dates(converters.jsdate_to_time("2013-01-01T00:00:00"), converters.jsdate_to_time("2012-12-31T23:59:59"), datetime.timedelta(seconds=1))
     
     
-class CourseTestCase(TestCase):
+class CourseTestCase(ModuleStoreTestCase):
     def setUp(self):
+        """
+        These tests need a user in the DB so that the django Test Client
+        can log them in.
+        They inherit from the ModuleStoreTestCase class so that the mongodb collection
+        will be cleared out before each test case execution and deleted
+        afterwards.
+        """
         uname = 'testuser'
         email = 'test+courses@edx.org'
         password = 'foo'
@@ -52,36 +65,15 @@ class CourseTestCase(TestCase):
         self.user.is_staff = True
         self.user.save()
 
-        # Flush and initialize the module store
-        # It needs the templates because it creates new records
-        # by cloning from the template.
-        # Note that if your test module gets in some weird state
-        # (though it shouldn't), do this manually
-        # from the bash shell to drop it:
-        # $ mongo test_xmodule --eval "db.dropDatabase()"
-        xmodule.modulestore.django._MODULESTORES = {}
-        xmodule.modulestore.django.modulestore().collection.drop()
-        xmodule.templates.update_templates()
-
         self.client = Client()
         self.client.login(username=uname, password=password)
 
-        self.course_data = {
-            'template': 'i4x://edx/templates/course/Empty',
-            'org': 'MITx',
-            'number': '999',
-            'display_name': 'Robot Super Course',
-            }
-        self.course_location = Location('i4x', 'MITx', '999', 'course', 'Robot_Super_Course')
-        self.create_course()
-
-    def tearDown(self):
-        xmodule.modulestore.django._MODULESTORES = {}
-        xmodule.modulestore.django.modulestore().collection.drop()
-
-    def create_course(self):
-        """Create new course"""
-        self.client.post(reverse('create_new_course'), self.course_data)
+        t='i4x://edx/templates/course/Empty'
+        o='MITx'
+        n='999'
+        dn='Robot Super Course'
+        self.course_location = Location('i4x', o, n, 'course', 'Robot_Super_Course')
+        CourseFactory.create(template=t, org=o, number=n, display_name=dn)
 
 class CourseDetailsTestCase(CourseTestCase):
     def test_virgin_fetch(self):
@@ -146,7 +138,6 @@ class CourseDetailsViewTest(CourseTestCase):
         else:
             return None
         
-        
     def test_update_and_fetch(self):
         details = CourseDetails.fetch(self.course_location)
         
@@ -271,5 +262,3 @@ class CourseGradingTest(CourseTestCase):
         test_grader.graders[1]['drop_count'] = test_grader.graders[1].get('drop_count') + 1
         altered_grader = CourseGradingModel.update_grader_from_json(test_grader.course_location, test_grader.graders[1])
         self.assertDictEqual(test_grader.graders[1], altered_grader, "drop_count[1] + 2")
-        
-        

cms/djangoapps/contentstore/tests/test_utils.py

-from django.test.testcases import TestCase
 from  cms.djangoapps.contentstore import utils
 import mock
+from django.test import TestCase
 
 class LMSLinksTestCase(TestCase):
     def about_page_test(self):

cms/djangoapps/contentstore/tests/utils.py

+import json
+import copy
+from time import time
+from django.test import TestCase
+from override_settings import override_settings
+from django.conf import settings
+
+from student.models import Registration
+from django.contrib.auth.models import User
+
+import xmodule.modulestore.django
+from xmodule.templates import update_templates
+
+class ModuleStoreTestCase(TestCase):
+    """ Subclass for any test case that uses the mongodb 
+    module store. This populates a uniquely named modulestore
+    collection with templates before running the TestCase
+    and drops it they are finished. """
+
+    def _pre_setup(self):
+        super(ModuleStoreTestCase, self)._pre_setup()
+
+        # Use the current seconds since epoch to differentiate
+        # the mongo collections on jenkins.
+        sec_since_epoch = '%s' % int(time()*100)
+        self.orig_MODULESTORE = copy.deepcopy(settings.MODULESTORE)
+        self.test_MODULESTORE = self.orig_MODULESTORE
+        self.test_MODULESTORE['default']['OPTIONS']['collection'] = 'modulestore_%s' % sec_since_epoch
+        self.test_MODULESTORE['direct']['OPTIONS']['collection'] = 'modulestore_%s' % sec_since_epoch
+        settings.MODULESTORE = self.test_MODULESTORE
+
+        # Flush and initialize the module store
+        # It needs the templates because it creates new records
+        # by cloning from the template.
+        # Note that if your test module gets in some weird state
+        # (though it shouldn't), do this manually
+        # from the bash shell to drop it:
+        # $ mongo test_xmodule --eval "db.dropDatabase()"
+        xmodule.modulestore.django._MODULESTORES = {}
+        update_templates()
+
+    def _post_teardown(self):
+        # Make sure you flush out the modulestore.
+        # Drop the collection at the end of the test,
+        # otherwise there will be lingering collections leftover
+        # from executing the tests.
+        xmodule.modulestore.django._MODULESTORES = {}
+        xmodule.modulestore.django.modulestore().collection.drop()
+        settings.MODULESTORE = self.orig_MODULESTORE
+
+        super(ModuleStoreTestCase, self)._post_teardown()
+
+def parse_json(response):
+    """Parse response, which is assumed to be json"""
+    return json.loads(response.content)
+
+def user(email):
+    """look up a user by email"""
+    return User.objects.get(email=email)
+
+def registration(email):
+    """look up registration object by email"""
+    return Registration.objects.get(user__email=email)

cms/djangoapps/contentstore/views.py

@@ -1240,6 +1240,11 @@ def edge(request):
 @login_required
 @expect_json
 def create_new_course(request):
+    # This logic is repeated in xmodule/modulestore/tests/factories.py
+    # so if you change anything here, you need to also change it there.
+    # TODO: write a test that creates two courses, one with the factory and
+    # the other with this method, then compare them to make sure they are 
+    # equivalent.
     template = Location(request.POST['template'])
     org = request.POST.get('org')
     number = request.POST.get('number')
@@ -1289,6 +1294,9 @@ def initialize_course_tabs(course):
     # at least a list populated with the minimal times
     # @TODO: I don't like the fact that the presentation tier is away of these data related constraints, let's find a better
     # place for this. Also rather than using a simple list of dictionaries a nice class model would be helpful here
+
+    # This logic is repeated in xmodule/modulestore/tests/factories.py
+    # so if you change anything here, you need to also change it there.
     course.tabs = [{"type": "courseware"}, 
         {"type": "course_info", "name": "Course Info"}, 
         {"type": "discussion", "name": "Discussion"},

cms/envs/test.py

@@ -11,7 +11,6 @@ from .common import *
 import os
 from path import path
 
-
 # Nose Test Runner
 INSTALLED_APPS += ('django_nose',)
 NOSE_ARGS = ['--with-xunit']
@@ -72,17 +71,6 @@ DATABASES = {
         'ENGINE': 'django.db.backends.sqlite3',
         'NAME': ENV_ROOT / "db" / "cms.db",
     },
-
-    # The following are for testing purposes...
-    'edX/toy/2012_Fall': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': ENV_ROOT / "db" / "course1.db",
-    },
-    
-    'edx/full/6.002_Spring_2012': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': ENV_ROOT / "db" / "course2.db",
-    }
 }
 
 LMS_BASE = "localhost:8000"

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

+from factory import Factory
+from time import gmtime
+from uuid import uuid4
+from xmodule.modulestore import Location
+from xmodule.modulestore.django import modulestore
+from xmodule.timeparse import stringify_time
+
+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):
+        # 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')
+        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.metadata['display_name'] = display_name
+
+        new_course.metadata['data_dir'] = uuid4().hex
+        new_course.metadata['start'] = stringify_time(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(), new_course.own_metadata)   
+
+        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):
+        """
+        kwargs must include parent_location, template. Can contain display_name
+        target_class is ignored
+        """
+
+        DETACHED_CATEGORIES = ['about', 'static_tab', 'course_info']
+        
+        parent_location = Location(kwargs.get('parent_location'))
+        template = Location(kwargs.get('template'))
+        display_name = kwargs.get('display_name')
+
+        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)
+
+        new_item = store.clone_item(template, dest_location)
+
+        # TODO: This needs to be deleted when we have proper storage for static content
+        new_item.metadata['data_dir'] = parent.metadata['data_dir']
+
+        # replace the display name with an optional parameter passed in from the caller
+        if display_name is not None:
+            new_item.metadata['display_name'] = display_name
+
+        store.update_metadata(new_item.location.url(), new_item.own_metadata)
+
+        if new_item.location.category not in DETACHED_CATEGORIES:
+            store.update_children(parent_location, parent.definition.get('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'