Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4225 from edx/mathewpeterson/lms-opaque-keys-bugs

Browse Source 
Testing for bugs off master for opaque-keys deprecation
LMS-2753
This commit is contained in:
Mathew Peterson
2014-07-11 16:53:23 -04:00
parent 152b84432e cd82abae6c
commit cec09be006
61 changed files with 440 additions and 341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cms/djangoapps/contentstore/features/course-export.py
View File

@@ -54,6 +54,10 @@ def i_click_on_error_dialog(step):
course_key = SlashSeparatedCourseKey("MITx", "999", "Robot_Super_Course")
# we don't know the actual ID of the vertical. So just check that we did go to a
# vertical page in the course (there should only be one).
vertical_usage_key = course_key.make_usage_key("vertical", "")
vertical_usage_key = course_key.make_usage_key("vertical", None)
vertical_url = reverse_usage_url('unit_handler', vertical_usage_key)
# Remove the trailing "/None" from the URL - we don't know the course ID, so we just want to
# check that we visited a vertical URL.
if vertical_url.endswith("/None"):
vertical_url = vertical_url[:-5]
assert_equal(1, world.browser.url.count(vertical_url))

17
cms/djangoapps/contentstore/tests/test_clone_course.py
View File

@@ -8,25 +8,26 @@ from xmodule.modulestore import ModuleStoreEnum
from contentstore.tests.utils import CourseTestCase
@skipIf(
not 'run' in CourseLocator.KEY_FIELDS,
"Pending integration with latest opaque-keys library - need removal of offering, make_asset_key on CourseLocator, etc."
)
class CloneCourseTest(CourseTestCase):
"""
Unit tests for cloning a course
"""
# TODO Don is fixing this on his branch of split migrator
@skipIf(True, "Don is still working on split migrator")
def test_clone_course(self):
"""Tests cloning of a course as follows: XML -> Mongo (+ data) -> Mongo -> Split -> Split"""
# 1. import and populate test toy course
mongo_course1_id = self.import_and_populate_course()
self.check_populated_course(mongo_course1_id)
# 2. clone course (mongo -> mongo)
# TODO - This is currently failing since clone_course doesn't handle Private content - fails on Publish
mongo_course2_id = SlashSeparatedCourseKey('edX2', 'toy2', '2013_Fall')
self.store.clone_course(mongo_course1_id, mongo_course2_id, self.user.id)
self.assertCoursesEqual(mongo_course1_id, mongo_course2_id)
# mongo_course2_id = SlashSeparatedCourseKey('edX2', 'toy2', '2013_Fall')
# self.store.clone_course(mongo_course1_id, mongo_course2_id, self.user.id)
# self.assertCoursesEqual(mongo_course1_id, mongo_course2_id)
# self.check_populated_course(mongo_course2_id)
# NOTE: When the code above is uncommented this can be removed.
mongo_course2_id = mongo_course1_id
# 3. clone course (mongo -> split)
with self.store.default_store(ModuleStoreEnum.Type.split):

17
cms/djangoapps/contentstore/tests/test_contentstore.py
View File

@@ -311,7 +311,6 @@ class ContentStoreToyCourseTest(ContentStoreTestCase):
direct_store = self.store
_, course_items = import_from_xml(direct_store, self.user.id, 'common/test/data/', ['toy'])
usage_key = course_items[0].id.make_usage_key('vertical', 'vertical_test')
# also try a custom response which will trigger the 'is this course in whitelist' logic
resp = self.client.get_json(
get_url('xblock_view_handler', usage_key, kwargs={'view_name': 'container_preview'})
@@ -319,10 +318,10 @@ class ContentStoreToyCourseTest(ContentStoreTestCase):
self.assertEqual(resp.status_code, 200)
# These are the data-ids of the xblocks contained in the vertical.
self.assertContains(resp, 'edX+toy+2012_Fall+video+sample_video')
self.assertContains(resp, 'edX+toy+2012_Fall+video+separate_file_video')
self.assertContains(resp, 'edX+toy+2012_Fall+video+video_with_end_time')
self.assertContains(resp, 'edX+toy+2012_Fall+poll_question+T1_changemind_poll_foo_2')
self.assertContains(resp, 'edX/toy/video/sample_video')
self.assertContains(resp, 'edX/toy/video/separate_file_video')
self.assertContains(resp, 'edX/toy/video/video_with_end_time')
self.assertContains(resp, 'edX/toy/poll_question/T1_changemind_poll_foo_2')
def test_delete(self):
store = self.store
@@ -1217,7 +1216,7 @@ class ContentStoreTest(ContentStoreTestCase):
resp = self._show_course_overview(course.id)
self.assertContains(
resp,
'<article class="courseware-overview" data-locator="location:MITx+999+Robot_Super_Course+course+Robot_Super_Course" data-course-key="slashes:MITx+999+Robot_Super_Course">',
'<article class="courseware-overview" data-locator="i4x://MITx/999/course/Robot_Super_Course" data-course-key="MITx/999/Robot_Super_Course">',
status_code=200,
html=True
)
@@ -1238,7 +1237,7 @@ class ContentStoreTest(ContentStoreTestCase):
data = parse_json(resp)
self.assertRegexpMatches(
data['locator'],
r"location:MITx\+999\+Robot_Super_Course\+chapter\+([0-9]|[a-f]){3,}$"
r"MITx/999/chapter/([0-9]|[a-f]){3,}$"
)
def test_capa_module(self):
@@ -1480,7 +1479,7 @@ class ContentStoreTest(ContentStoreTestCase):
content_store = contentstore()
# Use conditional_and_poll, as it's got an image already
import_from_xml(
__, courses = import_from_xml(
self.store,
self.user.id,
'common/test/data/',
@@ -1488,7 +1487,7 @@ class ContentStoreTest(ContentStoreTestCase):
static_content_store=content_store
)
course = self.store.get_courses()[0]
course = courses[0]
# Make sure the course image is set to the right place
self.assertEqual(course.course_image, 'images_course_image.jpg')

15
cms/djangoapps/contentstore/tests/test_crud.py
View File

@@ -57,14 +57,15 @@ class TemplateTests(unittest.TestCase):
def test_factories(self):
test_course = persistent_factories.PersistentCourseFactory.create(
offering='tempcourse', org='testx',
course='course', run='2014', org='testx',
display_name='fun test course', user_id='testbot'
)
self.assertIsInstance(test_course, CourseDescriptor)
self.assertEqual(test_course.display_name, 'fun test course')
index_info = self.split_store.get_course_index_info(test_course.id)
self.assertEqual(index_info['org'], 'testx')
self.assertEqual(index_info['offering'], 'tempcourse')
self.assertEqual(index_info['course'], 'course')
self.assertEqual(index_info['run'], '2014')
test_chapter = persistent_factories.ItemFactory.create(display_name='chapter 1',
parent_location=test_course.location)
@@ -75,7 +76,7 @@ class TemplateTests(unittest.TestCase):
with self.assertRaises(DuplicateCourseError):
persistent_factories.PersistentCourseFactory.create(
offering='tempcourse', org='testx',
course='course', run='2014', org='testx',
display_name='fun test course', user_id='testbot'
)
@@ -84,7 +85,7 @@ class TemplateTests(unittest.TestCase):
Test create_xblock to create non persisted xblocks
"""
test_course = persistent_factories.PersistentCourseFactory.create(
offering='tempcourse', org='testx',
course='course', run='2014', org='testx',
display_name='fun test course', user_id='testbot'
)
@@ -111,7 +112,7 @@ class TemplateTests(unittest.TestCase):
try saving temporary xblocks
"""
test_course = persistent_factories.PersistentCourseFactory.create(
offering='tempcourse', org='testx',
course='course', run='2014', org='testx',
display_name='fun test course', user_id='testbot'
)
test_chapter = self.split_store.create_xblock(
@@ -150,7 +151,7 @@ class TemplateTests(unittest.TestCase):
def test_delete_course(self):
test_course = persistent_factories.PersistentCourseFactory.create(
offering='history.doomed', org='edu.harvard',
course='history', run='doomed', org='edu.harvard',
display_name='doomed test course',
user_id='testbot')
persistent_factories.ItemFactory.create(display_name='chapter 1',
@@ -173,7 +174,7 @@ class TemplateTests(unittest.TestCase):
Test get_block_generations
"""
test_course = persistent_factories.PersistentCourseFactory.create(
offering='history.hist101', org='edu.harvard',
course='history', run='hist101', org='edu.harvard',
display_name='history test course',
user_id='testbot'
)

17
cms/djangoapps/contentstore/tests/utils.py
View File

@@ -293,7 +293,6 @@ class CourseTestCase(ModuleStoreTestCase):
for descriptor in items:
resp = self.client.get_html(get_url('unit_handler', descriptor.location))
self.assertEqual(resp.status_code, 200)
test_no_locations(self, resp)
def assertAssetsEqual(self, asset_key, course1_id, course2_id):
"""Verifies the asset of the given key has the same attributes in both given courses."""
@@ -310,22 +309,6 @@ class CourseTestCase(ModuleStoreTestCase):
self.assertEqual(value, course2_asset_attrs[key])
def test_no_locations(test, resp, status_code=200, html=True):
"""
Verifies that "i4x", which appears in old locations, but not
new locators, does not appear in the HTML response output.
Used to verify that database refactoring is complete.
"""
test.assertNotContains(resp, 'i4x', status_code=status_code, html=html)
if html:
# For HTML pages, it is nice to call the method with html=True because
# it checks that the HTML properly parses. However, it won't find i4x usages
# in JavaScript blocks.
content = resp.content
hits = len(re.findall(r"(?<!jump_to/)i4x://", content))
test.assertEqual(hits, 0, "i4x found outside of LMS jump-to links")
def get_url(handler_name, key_value, key_name='usage_key_string', kwargs=None):
"""
Helper function for getting HTML for a page in Studio and checking that it does not error.

6
cms/djangoapps/contentstore/utils.py
View File

@@ -14,7 +14,7 @@ from xmodule.contentstore.content import StaticContent
from xmodule.modulestore import ModuleStoreEnum
from xmodule.modulestore.django import modulestore
from xmodule.modulestore.exceptions import ItemNotFoundError
from opaque_keys.edx.locations import SlashSeparatedCourseKey, Location
from opaque_keys.edx.keys import UsageKey, CourseKey
from student.roles import CourseInstructorRole, CourseStaffRole
@@ -54,7 +54,7 @@ def get_lms_link_for_item(location, preview=False):
:param location: the location to jump to
:param preview: True if the preview version of LMS should be returned. Default value is false.
"""
assert(isinstance(location, Location))
assert(isinstance(location, UsageKey))
if settings.LMS_BASE is None:
return None
@@ -76,7 +76,7 @@ def get_lms_link_for_about_page(course_id):
Returns the url to the course about page from the location tuple.
"""
assert(isinstance(course_id, SlashSeparatedCourseKey))
assert(isinstance(course_id, CourseKey))
if settings.FEATURES.get('ENABLE_MKTG_SITE', False):
if not hasattr(settings, 'MKTG_URLS'):

3
cms/djangoapps/contentstore/views/component.py
View File

@@ -409,6 +409,9 @@ def _get_item_in_course(request, usage_key):
Verifies that the caller has permission to access this item.
"""
# usage_key's course_key may have an empty run property
usage_key = usage_key.replace(course_key=modulestore().fill_in_run(usage_key.course_key))
course_key = usage_key.course_key
if not has_course_access(request.user, course_key):

3
cms/djangoapps/contentstore/views/course.py
View File

@@ -336,7 +336,8 @@ def create_new_course(request):
# Creating the course raises InvalidLocationError if an existing course with this org/name is found
new_course = modulestore().create_course(
course_key.org,
course_key.offering,
course_key.course,
course_key.run,
request.user.id,
fields=fields,
)

25
cms/djangoapps/contentstore/views/item.py
View File

@@ -101,6 +101,9 @@ def xblock_handler(request, usage_key_string):
"""
if usage_key_string:
usage_key = UsageKey.from_string(usage_key_string)
# usage_key's course_key may have an empty run property
usage_key = usage_key.replace(course_key=modulestore().fill_in_run(usage_key.course_key))
if not has_course_access(request.user, usage_key.course_key):
raise PermissionDenied()
@@ -135,7 +138,15 @@ def xblock_handler(request, usage_key_string):
elif request.method in ('PUT', 'POST'):
if 'duplicate_source_locator' in request.json:
parent_usage_key = UsageKey.from_string(request.json['parent_locator'])
# usage_key's course_key may have an empty run property
parent_usage_key = parent_usage_key.replace(
course_key=modulestore().fill_in_run(parent_usage_key.course_key)
)
duplicate_source_usage_key = UsageKey.from_string(request.json['duplicate_source_locator'])
# usage_key's course_key may have an empty run property
duplicate_source_usage_key = duplicate_source_usage_key.replace(
course_key=modulestore().fill_in_run(duplicate_source_usage_key.course_key)
)
dest_usage_key = _duplicate_item(
parent_usage_key,
@@ -167,6 +178,8 @@ def xblock_view_handler(request, usage_key_string, view_name):
the second is the resource description
"""
usage_key = UsageKey.from_string(usage_key_string)
# usage_key's course_key may have an empty run property
usage_key = usage_key.replace(course_key=modulestore().fill_in_run(usage_key.course_key))
if not has_course_access(request.user, usage_key.course_key):
raise PermissionDenied()
@@ -305,11 +318,11 @@ def _save_item(user, usage_key, data=None, children=None, metadata=None, nullout
data = old_content['data'] if 'data' in old_content else None
if children is not None:
children_usage_keys = [
UsageKey.from_string(child)
for child
in children
]
children_usage_keys = []
for child in children:
child_usage_key = UsageKey.from_string(child)
child_usage_key = child_usage_key.replace(course_key=modulestore().fill_in_run(child_usage_key.course_key))
children_usage_keys.append(child_usage_key)
existing_item.children = children_usage_keys
# also commit any metadata which might have been passed along
@@ -376,6 +389,8 @@ def _save_item(user, usage_key, data=None, children=None, metadata=None, nullout
def _create_item(request):
"""View for create items."""
usage_key = UsageKey.from_string(request.json['parent_locator'])
# usage_key's course_key may have an empty run property
usage_key = usage_key.replace(course_key=modulestore().fill_in_run(usage_key.course_key))
category = request.json['category']
display_name = request.json.get('display_name')

6
cms/djangoapps/contentstore/views/tests/test_checklists.py
View File

@@ -43,7 +43,7 @@ class ChecklistTestCase(CourseTestCase):
response = self.client.get(self.checklists_url)
self.assertContains(response, "Getting Started With Studio")
# Verify expansion of action URL happened.
self.assertContains(response, 'course_team/slashes:mitX+333+Checklists_Course')
self.assertContains(response, 'course_team/mitX/333/Checklists_Course')
# Verify persisted checklist does NOT have expanded URL.
checklist_0 = self.get_persisted_checklists()[0]
self.assertEqual('ManageUsers', get_action_url(checklist_0, 0))
@@ -136,8 +136,8 @@ class ChecklistTestCase(CourseTestCase):
# Verify no side effect in the original list.
self.assertEqual(get_action_url(checklist, index), stored)
test_expansion(self.course.checklists[0], 0, 'ManageUsers', '/course_team/slashes:mitX+333+Checklists_Course/')
test_expansion(self.course.checklists[1], 1, 'CourseOutline', '/course/slashes:mitX+333+Checklists_Course')
test_expansion(self.course.checklists[0], 0, 'ManageUsers', '/course_team/mitX/333/Checklists_Course/')
test_expansion(self.course.checklists[1], 1, 'CourseOutline', '/course/mitX/333/Checklists_Course')
test_expansion(self.course.checklists[2], 0, 'http://help.edge.edx.org/', 'http://help.edge.edx.org/')

4
cms/djangoapps/contentstore/views/tests/test_course_index.py
View File

@@ -96,7 +96,7 @@ class TestCourseIndex(CourseTestCase):
# First spot check some values in the root response
self.assertEqual(json_response['category'], 'course')
self.assertEqual(json_response['id'], 'location:MITx+999+Robot_Super_Course+course+Robot_Super_Course')
self.assertEqual(json_response['id'], 'i4x://MITx/999/course/Robot_Super_Course')
self.assertEqual(json_response['display_name'], 'Robot Super Course')
self.assertTrue(json_response['is_container'])
self.assertFalse(json_response['is_draft'])
@@ -106,7 +106,7 @@ class TestCourseIndex(CourseTestCase):
self.assertTrue(len(children) > 0)
first_child_response = children[0]
self.assertEqual(first_child_response['category'], 'chapter')
self.assertEqual(first_child_response['id'], 'location:MITx+999+Robot_Super_Course+chapter+Week_1')
self.assertEqual(first_child_response['id'], 'i4x://MITx/999/chapter/Week_1')
self.assertEqual(first_child_response['display_name'], 'Week 1')
self.assertTrue(first_child_response['is_container'])
self.assertFalse(first_child_response['is_draft'])

5
cms/djangoapps/contentstore/views/tests/test_course_updates.py
View File

@@ -5,7 +5,8 @@ import json
from contentstore.tests.test_course_settings import CourseTestCase
from contentstore.utils import reverse_course_url, reverse_usage_url
from opaque_keys.edx.locations import Location, SlashSeparatedCourseKey
from opaque_keys.edx.locations import SlashSeparatedCourseKey
from opaque_keys.edx.keys import UsageKey
from xmodule.modulestore.django import modulestore
@@ -246,7 +247,7 @@ class CourseUpdateTest(CourseTestCase):
self.assertHTMLEqual(payload['content'], content)
updates_location = self.course.id.make_usage_key('course_info', 'updates')
self.assertTrue(isinstance(updates_location, Location))
self.assertTrue(isinstance(updates_location, UsageKey))
self.assertEqual(updates_location.name, block)
# check posting on handouts

6
cms/djangoapps/contentstore/views/tests/test_helpers.py
View File

@@ -15,7 +15,7 @@ class HelpersTestCase(CourseTestCase):
# Verify course URL
self.assertEqual(xblock_studio_url(self.course),
u'/course/slashes:MITx+999+Robot_Super_Course')
u'/course/MITx/999/Robot_Super_Course')
# Verify chapter URL
chapter = ItemFactory.create(parent_location=self.course.location, category='chapter',
@@ -31,13 +31,13 @@ class HelpersTestCase(CourseTestCase):
vertical = ItemFactory.create(parent_location=sequential.location, category='vertical',
display_name='Unit')
self.assertEqual(xblock_studio_url(vertical),
u'/unit/location:MITx+999+Robot_Super_Course+vertical+Unit')
u'/unit/i4x://MITx/999/vertical/Unit')
# Verify child vertical URL
child_vertical = ItemFactory.create(parent_location=vertical.location, category='vertical',
display_name='Child Vertical')
self.assertEqual(xblock_studio_url(child_vertical),
u'/container/location:MITx+999+Robot_Super_Course+vertical+Child_Vertical')
u'/container/i4x://MITx/999/vertical/Child_Vertical')
# Verify video URL
video = ItemFactory.create(parent_location=child_vertical.location, category="video",

4
cms/djangoapps/contentstore/views/tests/test_import_export.py
View File

@@ -296,7 +296,7 @@ class ExportTestCase(CourseTestCase):
"""
fake_xblock = ItemFactory.create(parent_location=self.course.location, category='aawefawef')
self.store.publish(fake_xblock.location, self.user.id)
self._verify_export_failure(u'/unit/location:MITx+999+Robot_Super_Course+course+Robot_Super_Course')
self._verify_export_failure(u'/unit/i4x://MITx/999/course/Robot_Super_Course')
def test_export_failure_subsection_level(self):
"""
@@ -308,7 +308,7 @@ class ExportTestCase(CourseTestCase):
category='aawefawef'
)
self._verify_export_failure(u'/unit/location:MITx+999+Robot_Super_Course+vertical+foo')
self._verify_export_failure(u'/unit/i4x://MITx/999/vertical/foo')
def _verify_export_failure(self, expectedText):
""" Export failure helper method. """

2
cms/djangoapps/contentstore/views/tests/test_item.py
View File

@@ -158,7 +158,7 @@ class GetItem(ItemTest):
html,
# The instance of the wrapper class will have an auto-generated ID. Allow any
# characters after wrapper.
(r'"/container/location:MITx\+999\+Robot_Super_Course\+wrapper\+\w+" class="action-button">\s*'
(r'"/container/i4x://MITx/999/wrapper/\w+" class="action-button">\s*'
'<span class="action-button-text">View</span>')
)

2
cms/djangoapps/contentstore/views/tests/test_preview.py
View File

@@ -43,6 +43,6 @@ class GetPreviewHtmlTestCase(TestCase):
# Verify student view html is returned, and the usage ID is as expected.
self.assertRegexpMatches(
html,
'data-usage-id="location:MITx\+999\+Robot_Super_Course\+html\+html_[0-9]*"'
'data-usage-id="i4x://MITx/999/html/html_[0-9]*"'
)
self.assertRegexpMatches(html, '<html>foobar</html>')

4
cms/djangoapps/contentstore/views/transcripts_ajax.py
View File

@@ -532,12 +532,12 @@ def _get_item(request, data):
Returns the item.
"""
usage_key = UsageKey.from_string(data.get('locator'))
# This is placed before has_course_access() to validate the location,
# because has_course_access() raises r if location is invalid.
item = modulestore().get_item(usage_key)
if not has_course_access(request.user, usage_key.course_key):
# use the item's course_key, because the usage_key might not have the run
if not has_course_access(request.user, item.location.course_key):
raise PermissionDenied()
return item

5
cms/envs/common.py
View File

@@ -33,6 +33,7 @@ from lms.envs.common import (
USE_TZ, TECH_SUPPORT_EMAIL, PLATFORM_NAME, BUGS_EMAIL, DOC_STORE_CONFIG, ALL_LANGUAGES, WIKI_ENABLED, MODULESTORE
)
from path import path
from warnings import simplefilter
from lms.envs.modulestore_settings import *
from lms.lib.xblock.mixin import LmsBlockMixin
@@ -182,6 +183,10 @@ XQUEUE_INTERFACE = {
'basic_auth': None,
}
################################# Deprecation warnings #####################
# Ignore deprecation warnings (so we don't clutter Jenkins builds/production)
simplefilter('ignore')
################################# Middleware ###################################
# List of finder classes that know how to find static files in

6
cms/envs/test.py
View File

@@ -15,7 +15,7 @@ sessions. Assumes structure:
from .common import *
import os
from path import path
from warnings import filterwarnings
from warnings import filterwarnings, simplefilter
from uuid import uuid4
# import settings from LMS for consistent behavior with CMS
@@ -149,6 +149,10 @@ INSTALLED_APPS += ('external_auth', )
# hide ratelimit warnings while running tests
filterwarnings('ignore', message='No request passed to the backend, unable to rate-limit')
# Ignore deprecation warnings (so we don't clutter Jenkins builds/production)
# https://docs.python.org/2/library/warnings.html#the-warnings-filter
simplefilter('ignore') # Change to "default" to see the first instance of each hit
# or "error" to convert all into errors
################################# CELERY ######################################

4
common/djangoapps/student/models.py
View File

@@ -738,7 +738,7 @@ class CourseEnrollment(models.Model):
try:
context = contexts.course_context_from_course_id(self.course_id)
assert(isinstance(self.course_id, SlashSeparatedCourseKey))
assert(isinstance(self.course_id, CourseKey))
data = {
'user_id': self.user.id,
'course_id': self.course_id.to_deprecated_string(),
@@ -884,7 +884,7 @@ class CourseEnrollment(models.Model):
`course_id_partial` (CourseKey) is missing the run component
"""
assert isinstance(course_id_partial, SlashSeparatedCourseKey)
assert isinstance(course_id_partial, CourseKey)
assert not course_id_partial.run # None or empty string
course_key = SlashSeparatedCourseKey(course_id_partial.org, course_id_partial.course, '')
querystring = unicode(course_key.to_deprecated_string())

3
common/djangoapps/track/contexts.py
View File

@@ -2,6 +2,7 @@
import logging
from opaque_keys.edx.locations import SlashSeparatedCourseKey
from opaque_keys.edx.keys import CourseKey
from opaque_keys import InvalidKeyError
from util.request import COURSE_REGEX
@@ -48,7 +49,7 @@ def course_context_from_course_id(course_id):
return {'course_id': '', 'org_id': ''}
# TODO: Make this accept any CourseKey, and serialize it using .to_string
assert(isinstance(course_id, SlashSeparatedCourseKey))
assert(isinstance(course_id, CourseKey))
return {
'course_id': course_id.to_deprecated_string(),
'org_id': course_id.org,

9
common/djangoapps/xmodule_django/models.py
View File

@@ -1,6 +1,7 @@
from django.db import models
from django.core.exceptions import ValidationError
from opaque_keys.edx.locations import SlashSeparatedCourseKey, Location
from opaque_keys.edx.keys import CourseKey, UsageKey
from south.modelsinspector import add_introspection_rules
add_introspection_rules([], ["^xmodule_django\.models\.CourseKeyField"])
@@ -54,7 +55,7 @@ class CourseKeyField(models.CharField):
if value is self.Empty or value is None:
return None
assert isinstance(value, (basestring, SlashSeparatedCourseKey))
assert isinstance(value, (basestring, CourseKey))
if value == '':
# handle empty string for models being created w/o fields populated
return None
@@ -74,7 +75,7 @@ class CourseKeyField(models.CharField):
if value is self.Empty or value is None:
return '' # CharFields should use '' as their empty value, rather than None
assert isinstance(value, SlashSeparatedCourseKey)
assert isinstance(value, CourseKey)
return value.to_deprecated_string()
def validate(self, value, model_instance):
@@ -104,7 +105,7 @@ class LocationKeyField(models.CharField):
if value is self.Empty or value is None:
return value
assert isinstance(value, (basestring, Location))
assert isinstance(value, (basestring, UsageKey))
if value == '':
return None
@@ -124,7 +125,7 @@ class LocationKeyField(models.CharField):
if value is self.Empty:
return ''
assert isinstance(value, Location)
assert isinstance(value, UsageKey)
return value.to_deprecated_string()
def validate(self, value, model_instance):

2
common/lib/xmodule/xmodule/contentstore/content.py
View File

@@ -111,7 +111,7 @@ class StaticContent(object):
"""
Generate an AssetKey for the given path (old c4x/org/course/asset/name syntax)
"""
# TODO OpaqueKey - change to from_string once opaque keys lands
# TODO OpaqueKeys after opaque keys deprecation is working
# return AssetLocation.from_string(path)
return AssetLocation.from_deprecated_string(path)

19
common/lib/xmodule/xmodule/contentstore/mongo.py
View File

@@ -12,7 +12,8 @@ from fs.osfs import OSFS
import os
import json
from bson.son import SON
from opaque_keys.edx.locations import AssetLocation, SlashSeparatedCourseKey
from opaque_keys.edx.locator import AssetLocator
from opaque_keys.edx.locations import AssetLocation
class MongoContentStore(ContentStore):
@@ -42,11 +43,6 @@ class MongoContentStore(ContentStore):
self.fs_files = _db[bucket + ".files"] # the underlying collection GridFS uses
# TODO OpaqueKey - remove after merge of opaque urls
if not hasattr(AssetLocation, 'deprecated'):
setattr(AssetLocation, 'deprecated', True)
setattr(SlashSeparatedCourseKey, 'deprecated', True)
def drop_database(self):
"""
Only for use by test code. Removes the database!
@@ -78,9 +74,8 @@ class MongoContentStore(ContentStore):
return content
def delete(self, location_or_id):
if isinstance(location_or_id, AssetLocation):
location_or_id, __ = self.asset_db_key(location_or_id)
if isinstance(location_or_id, AssetLocator):
location_or_id, _ = self.asset_db_key(location_or_id)
# Deletes of non-existent files are considered successful
self.fs.delete(location_or_id)
@@ -151,12 +146,12 @@ class MongoContentStore(ContentStore):
# TODO: On 6/19/14, I had to put a try/except around this
# to export a course. The course failed on JSON files in
# the /static/ directory placed in it with an import.
#
# If this hasn't been looked at in a while, remove this comment.
#
# If this hasn't been looked at in a while, remove this comment.
#
# When debugging course exports, this might be a good place
# to look. -- pmitros
self.export(asset_location, output_directory)
self.export(asset_location, output_directory)
for attr, value in asset.iteritems():
if attr not in ['_id', 'md5', 'uploadDate', 'length', 'chunkSize']:
policy.setdefault(asset_location.name, {})[attr] = value

3
common/lib/xmodule/xmodule/course_module.py
View File

@@ -9,6 +9,7 @@ import dateutil.parser
from lazy import lazy
from opaque_keys.edx.locations import Location
from opaque_keys.edx.locator import UsageKey
from xmodule.seq_module import SequenceDescriptor, SequenceModule
from xmodule.graders import grader_from_conf
from xmodule.tabs import CourseTabList
@@ -550,7 +551,7 @@ class CourseDescriptor(CourseFields, SequenceDescriptor):
_ = self.runtime.service(self, "i18n").ugettext
if self.wiki_slug is None:
if isinstance(self.location, Location):
if isinstance(self.location, UsageKey):
self.wiki_slug = self.location.course
elif isinstance(self.location, CourseLocator):
self.wiki_slug = self.id.offering or self.display_name

2
common/lib/xmodule/xmodule/error_module.py
View File

@@ -99,7 +99,7 @@ class ErrorDescriptor(ErrorFields, XModuleDescriptor):
# real metadata stays in the content, but add a display name
field_data = DictFieldData({
'error_msg': str(error_msg),
'error_msg': unicode(error_msg),
'contents': contents,
'location': location,
'category': 'error'

17
common/lib/xmodule/xmodule/modulestore/__init__.py
View File

@@ -317,7 +317,7 @@ class ModuleStoreWrite(ModuleStoreRead):
:param force: fork the structure and don't update the course draftVersion if there's a version
conflict (only applicable to version tracking and conflict detecting persistence stores)
:raises VersionConflictError: if org, offering, and version_guid given and the current
:raises VersionConflictError: if org, course, run, and version_guid given and the current
version head != version_guid and force is not True. (only applicable to version tracking stores)
"""
pass
@@ -336,19 +336,20 @@ class ModuleStoreWrite(ModuleStoreRead):
:param force: fork the structure and don't update the course draftVersion if there's a version
conflict (only applicable to version tracking and conflict detecting persistence stores)
:raises VersionConflictError: if org, offering, and version_guid given and the current
:raises VersionConflictError: if org, course, run, and version_guid given and the current
version head != version_guid and force is not True. (only applicable to version tracking stores)
"""
pass
@abstractmethod
def create_course(self, org, offering, user_id, fields=None, **kwargs):
def create_course(self, org, course, run, user_id, fields=None, **kwargs):
"""
Creates and returns the course.
Args:
org (str): the organization that owns the course
offering (str): the name of the course offering
course (str): the name of the course
run (str): the name of the run
user_id: id of the user creating the course
fields (dict): Fields to set on the course at initialization
kwargs: Any optional arguments understood by a subset of modulestores to customize instantiation
@@ -458,7 +459,9 @@ class ModuleStoreReadBase(ModuleStoreRead):
return next(
(
c.id for c in self.get_courses()
if c.id.org.lower() == course_id.org.lower() and c.id.offering.lower() == course_id.offering.lower()
if c.id.org.lower() == course_id.org.lower() and
c.id.course.lower() == course_id.course.lower() and
c.id.run.lower() == course_id.run.lower()
),
None
)
@@ -542,7 +545,7 @@ class ModuleStoreWriteBase(ModuleStoreReadBase, ModuleStoreWrite):
:param force: fork the structure and don't update the course draftVersion if there's a version
conflict (only applicable to version tracking and conflict detecting persistence stores)
:raises VersionConflictError: if org, offering, and version_guid given and the current
:raises VersionConflictError: if org, course, run, and version_guid given and the current
version head != version_guid and force is not True. (only applicable to version tracking stores)
"""
raise NotImplementedError
@@ -556,7 +559,7 @@ class ModuleStoreWriteBase(ModuleStoreReadBase, ModuleStoreWrite):
:param force: fork the structure and don't update the course draftVersion if there's a version
conflict (only applicable to version tracking and conflict detecting persistence stores)
:raises VersionConflictError: if org, offering, and version_guid given and the current
:raises VersionConflictError: if org, course, run, and version_guid given and the current
version head != version_guid and force is not True. (only applicable to version tracking stores)
"""
raise NotImplementedError

60
common/lib/xmodule/xmodule/modulestore/loc_mapper_store.py
View File

@@ -11,6 +11,7 @@ from xmodule.modulestore import ModuleStoreEnum
from xmodule.modulestore.exceptions import InvalidLocationError, ItemNotFoundError
from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator
from opaque_keys.edx.locations import SlashSeparatedCourseKey
from opaque_keys.edx.keys import CourseKey
class LocMapperStore(object):
@@ -54,13 +55,13 @@ class LocMapperStore(object):
self.cache = cache
# location_map functions
def create_map_entry(self, course_key, org=None, offering=None,
def create_map_entry(self, course_key, org=None, course=None, run=None,
draft_branch=ModuleStoreEnum.BranchName.draft,
prod_branch=ModuleStoreEnum.BranchName.published,
block_map=None):
"""
Add a new entry to map this SlashSeparatedCourseKey to the new style CourseLocator.org & offering. If
org and offering are not provided, it defaults them based on course_key.
Add a new entry to map this SlashSeparatedCourseKey to the new style CourseLocator.org & course & run. If
org and course and run are not provided, it defaults them based on course_key.
WARNING: Exactly 1 CourseLocator key should index a given SlashSeparatedCourseKey.
We provide no mechanism to enforce this assertion.
@@ -70,7 +71,8 @@ class LocMapperStore(object):
:param course_key (SlashSeparatedCourseKey): a SlashSeparatedCourseKey
:param org (string): the CourseLocator style org
:param offering (string): the CourseLocator offering
:param course (string): the CourseLocator course number
:param run (string): the CourseLocator run of this course
:param draft_branch: the branch name to assign for drafts. This is hardcoded because old mongo had
a fixed notion that there was 2 and only 2 versions for modules: draft and production. The old mongo
did not, however, require that a draft version exist. The new one, however, does require a draft to
@@ -85,15 +87,16 @@ class LocMapperStore(object):
:class:`CourseLocator` representing the new id for the course
Raises:
ValueError if one and only one of org and offering is provided. Provide either both or neither.
ValueError if one and only one of org and course and run is provided. Provide all of them or none of them.
"""
if org is None and offering is None:
assert(isinstance(course_key, SlashSeparatedCourseKey))
if org is None and course is None and run is None:
assert(isinstance(course_key, CourseKey))
org = course_key.org
offering = u"{0.course}.{0.run}".format(course_key)
elif org is None or offering is None:
course = course_key.course
run = course_key.run
elif org is None or course is None or run is None:
raise ValueError(
u"Either supply both org and offering or neither. Not just one: {}, {}".format(org, offering)
u"Either supply org, course and run or none of them. Not just some of them: {}, {}, {}".format(org, course, run)
)
# very like _interpret_location_id but using mongo subdoc lookup (more performant)
@@ -102,14 +105,15 @@ class LocMapperStore(object):
self.location_map.insert({
'_id': course_son,
'org': org,
'offering': offering,
'course': course,
'run': run,
'draft_branch': draft_branch,
'prod_branch': prod_branch,
'block_map': block_map or {},
'schema': self.SCHEMA_VERSION,
})
return CourseLocator(org, offering)
return CourseLocator(org, course, run)
def translate_location(self, location, published=True,
add_entry_if_missing=True, passed_block_id=None):
@@ -176,7 +180,8 @@ class LocMapperStore(object):
prod_course_locator = CourseLocator(
org=entry['org'],
offering=entry['offering'],
course=entry['course'],
run=entry['run'],
branch=entry['prod_branch']
)
published_usage = BlockUsageLocator(
@@ -222,7 +227,7 @@ class LocMapperStore(object):
if cached_value:
return cached_value
# migrate any records which don't have the org and offering fields as
# migrate any records which don't have the org and course and run fields as
# this won't be able to find what it wants. (only needs to be run once ever per db,
# I'm not sure how to control that, but I'm putting some check here for once per launch)
if not getattr(self, 'offering_migrated', False):
@@ -234,7 +239,8 @@ class LocMapperStore(object):
entry = self.location_map.find_one(bson.son.SON([
('org', locator.org),
('offering', locator.offering),
('course', locator.course),
('run', locator.run),
]))
# look for one which maps to this block block_id
@@ -256,11 +262,14 @@ class LocMapperStore(object):
)
entry_org = "org"
entry_offering = "offering"
entry_course = "course"
entry_run = "run"
published_locator = BlockUsageLocator(
CourseLocator(
org=entry[entry_org], offering=entry[entry_offering],
org=entry[entry_org],
course=entry[entry_course],
run=entry[entry_run],
branch=entry['prod_branch']
),
block_type=category,
@@ -268,7 +277,7 @@ class LocMapperStore(object):
)
draft_locator = BlockUsageLocator(
CourseLocator(
org=entry[entry_org], offering=entry[entry_offering],
org=entry[entry_org], course=entry[entry_course], run=entry[entry_run],
branch=entry['draft_branch']
),
block_type=category,
@@ -302,10 +311,10 @@ class LocMapperStore(object):
raise ItemNotFoundError(course_key)
published_course_locator = CourseLocator(
org=entry['org'], offering=entry['offering'], branch=entry['prod_branch']
org=entry['org'], course=entry['course'], run=entry['run'], branch=entry['prod_branch']
)
draft_course_locator = CourseLocator(
org=entry['org'], offering=entry['offering'], branch=entry['draft_branch']
org=entry['org'], course=entry['course'], run=entry['run'], branch=entry['draft_branch']
)
self._cache_course_locator(course_key, published_course_locator, draft_course_locator)
if published:
@@ -349,7 +358,7 @@ class LocMapperStore(object):
"""
Construct the SON needed to repr the course_key for either a query or an insertion
"""
assert(isinstance(course_key, SlashSeparatedCourseKey))
assert(isinstance(course_key, CourseKey))
return bson.son.SON([
('org', course_key.org),
('course', course_key.course),
@@ -440,7 +449,7 @@ class LocMapperStore(object):
"""
Return the string used to cache the course key
"""
return u'{0.org}+{0.offering}'.format(course_key)
return u'{0.org}+{0.course}+{0.run}'.format(course_key)
def _cache_course_locator(self, old_course_id, published_course_locator, draft_course_locator):
"""
@@ -533,7 +542,7 @@ class LocMapperStore(object):
"""
If entry had an '_id' without a run, remove the whole record.
Add fields: schema, org, offering
Add fields: schema, org, course, run
Remove: course_id, lower_course_id
:param entry:
"""
@@ -546,13 +555,14 @@ class LocMapperStore(object):
self.location_map.remove({'_id': entry_id})
return None
# add schema, org, offering, etc, remove old fields
# add schema, org, course, run, etc, remove old fields
entry['schema'] = 0
entry.pop('course_id', None)
entry.pop('lower_course_id', None)
old_course_id = SlashSeparatedCourseKey(entry['_id']['org'], entry['_id']['course'], entry['_id']['name'])
entry['org'] = old_course_id.org
entry['offering'] = old_course_id.offering.replace('/', '+')
entry['course'] = old_course_id.course
entry['run'] = old_course_id.run
return self._migrate_1(entry, True)
# insert new migrations just before _migrate_top. _migrate_top sets the schema version and

23
common/lib/xmodule/xmodule/modulestore/mixed.py
View File

@@ -118,6 +118,17 @@ class MixedModuleStore(ModuleStoreWriteBase):
return store
return None
def fill_in_run(self, course_key):
"""
Some course_keys are used without runs. This function calls the corresponding
fill_in_run function on the appropriate modulestore.
"""
store = self._get_modulestore_for_courseid(course_key)
if not hasattr(store, 'fill_in_run'):
return course_key
return store.fill_in_run(course_key)
def has_item(self, usage_key, **kwargs):
"""
Does the course include the xblock who's id is reference?
@@ -184,7 +195,7 @@ class MixedModuleStore(ModuleStoreWriteBase):
for course in store.get_courses():
course_id = self._clean_course_id_for_mapping(course.id)
if course_id not in courses:
if has_locators and isinstance(course_id, SlashSeparatedCourseKey):
if has_locators and isinstance(course_id, CourseKey):
# see if a locator version of course is in the result
try:
@@ -273,13 +284,14 @@ class MixedModuleStore(ModuleStoreWriteBase):
errs.update(store.get_errored_courses())
return errs
def create_course(self, org, offering, user_id, fields=None, **kwargs):
def create_course(self, org, course, run, user_id, fields=None, **kwargs):
"""
Creates and returns the course.
Args:
org (str): the organization that owns the course
offering (str): the name of the course offering
course (str): the name of the course
run (str): the name of the run
user_id: id of the user creating the course
fields (dict): Fields to set on the course at initialization
kwargs: Any optional arguments understood by a subset of modulestores to customize instantiation
@@ -287,7 +299,10 @@ class MixedModuleStore(ModuleStoreWriteBase):
Returns: a CourseDescriptor
"""
store = self._get_modulestore_for_courseid(None)
return store.create_course(org, offering, user_id, fields, **kwargs)
if not hasattr(store, 'create_course'):
raise NotImplementedError(u"Cannot create a course on store {}".format(store))
return store.create_course(org, course, run, user_id, fields, **kwargs)
def clone_course(self, source_course_id, dest_course_id, user_id):
"""

48
common/lib/xmodule/xmodule/modulestore/mongo/base.py
View File

@@ -39,6 +39,7 @@ from xmodule.modulestore.exceptions import ItemNotFoundError, InvalidLocationErr
from xmodule.modulestore.inheritance import own_metadata, InheritanceMixin, inherit_metadata, InheritanceKeyValueStore
from xblock.core import XBlock
from opaque_keys.edx.locations import SlashSeparatedCourseKey
from opaque_keys.edx.keys import UsageKey, CourseKey
from xmodule.exceptions import HeartbeatFailure
log = logging.getLogger(__name__)
@@ -174,7 +175,7 @@ class CachingDescriptorSystem(MakoDescriptorSystem):
"""
Return an XModule instance for the specified location
"""
assert isinstance(location, Location)
assert isinstance(location, UsageKey)
json_data = self.module_data.get(location)
if json_data is None:
module = self.modulestore.get_item(location)
@@ -262,7 +263,10 @@ class CachingDescriptorSystem(MakoDescriptorSystem):
Convert a single serialized UsageKey string in a ReferenceField into a UsageKey.
"""
key = Location.from_deprecated_string(ref_string)
return key.replace(run=self.modulestore._fill_in_run(key.course_key).run)
return key.replace(run=self.modulestore.fill_in_run(key.course_key).run)
def __setattr__(self, name, value):
return super(CachingDescriptorSystem, self).__setattr__(name, value)
def _convert_reference_fields_to_keys(self, class_, course_key, jsonfields):
"""
@@ -405,7 +409,11 @@ class MongoModuleStore(ModuleStoreWriteBase):
self.ignore_write_events_on_courses.remove(course_id)
self.refresh_cached_metadata_inheritance_tree(course_id)
def _fill_in_run(self, course_key):
def fill_in_run(self, course_key):
"""
In mongo some course_keys are used without runs. This helper function returns
a course_key with the run filled in, if the course does actually exist.
"""
if course_key.run is not None:
return course_key
@@ -433,7 +441,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
# get all collections in the course, this query should not return any leaf nodes
# note this is a bit ugly as when we add new categories of containers, we have to add it here
course_id = self._fill_in_run(course_id)
course_id = self.fill_in_run(course_id)
block_types_with_children = set(
name for name, class_ in XBlock.load_classes() if getattr(class_, 'has_children', False)
)
@@ -509,7 +517,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
'''
tree = {}
course_id = self._fill_in_run(course_id)
course_id = self.fill_in_run(course_id)
if not force_refresh:
# see if we are first in the request cache (if present)
if self.request_cache is not None and course_id in self.request_cache.data.get('metadata_inheritance', {}):
@@ -588,7 +596,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
data = {}
to_process = list(items)
course_key = self._fill_in_run(course_key)
course_key = self.fill_in_run(course_key)
while to_process and depth is None or depth >= 0:
children = []
for item in to_process:
@@ -616,7 +624,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
"""
Load an XModuleDescriptor from item, using the children stored in data_cache
"""
course_key = self._fill_in_run(course_key)
course_key = self.fill_in_run(course_key)
location = Location._from_deprecated_son(item['location'], course_key.run)
data_dir = getattr(item, 'data_dir', location.course)
root = self.fs_root / data_dir
@@ -653,7 +661,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
Load a list of xmodules from the data in items, with children cached up
to specified depth
"""
course_key = self._fill_in_run(course_key)
course_key = self.fill_in_run(course_key)
data_cache = self._cache_children(course_key, items, depth)
# if we are loading a course object, if we're not prefetching children (depth != 0) then don't
@@ -693,7 +701,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
'''Look for a given location in the collection. If the item is not present, raise
ItemNotFoundError.
'''
assert isinstance(location, Location)
assert isinstance(location, UsageKey)
item = self.collection.find_one(
{'_id': location.to_deprecated_son()}
)
@@ -705,8 +713,8 @@ class MongoModuleStore(ModuleStoreWriteBase):
"""
Get the course with the given courseid (org/course/run)
"""
assert(isinstance(course_key, SlashSeparatedCourseKey))
course_key = self._fill_in_run(course_key)
assert(isinstance(course_key, CourseKey))
course_key = self.fill_in_run(course_key)
location = course_key.make_usage_key('course', course_key.run)
try:
return self.get_item(location, depth=depth)
@@ -722,8 +730,8 @@ class MongoModuleStore(ModuleStoreWriteBase):
If ignore_case is True, do a case insensitive search,
otherwise, do a case sensitive search
"""
assert(isinstance(course_key, SlashSeparatedCourseKey))
course_key = self._fill_in_run(course_key)
assert(isinstance(course_key, CourseKey))
course_key = self.fill_in_run(course_key)
location = course_key.make_usage_key('course', course_key.run)
if ignore_case:
course_query = location.to_deprecated_son('_id.')
@@ -841,13 +849,14 @@ class MongoModuleStore(ModuleStoreWriteBase):
modules = self._load_items(course_id, list(items))
return modules
def create_course(self, org, offering, user_id, fields=None, **kwargs):
def create_course(self, org, course, run, user_id, fields=None, **kwargs):
"""
Creates and returns the course.
Args:
org (str): the organization that owns the course
offering (str): the name of the course offering
course (str): the name of the course
run (str): the name of the run
user_id: id of the user creating the course
fields (dict): Fields to set on the course at initialization
kwargs: Any optional arguments understood by a subset of modulestores to customize instantiation
@@ -855,9 +864,8 @@ class MongoModuleStore(ModuleStoreWriteBase):
Returns: a CourseDescriptor
Raises:
InvalidLocationError: If a course with the same org and offering already exists
InvalidLocationError: If a course with the same org, course, and run already exists
"""
course, _, run = offering.partition('/')
course_id = SlashSeparatedCourseKey(org, course, run)
# Check if a course with this org/course has been defined before (case-insensitive)
@@ -902,7 +910,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
:param runtime: if you already have an xblock from the course, the xblock.runtime value
:param fields: a dictionary of field names and values for the new xmodule
"""
location = location.replace(run=self._fill_in_run(location.course_key).run)
location = location.replace(run=self.fill_in_run(location.course_key).run)
# differs from split mongo in that I believe most of this logic should be above the persistence
# layer but added it here to enable quick conversion. I'll need to reconcile these.
if metadata is None:
@@ -1056,7 +1064,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
]
elif isinstance(xblock.fields[field_name], ReferenceValueDict):
for key, subvalue in value.iteritems():
assert isinstance(subvalue, Location)
assert isinstance(subvalue, UsageKey)
value[key] = subvalue.to_deprecated_string()
return jsonfields
@@ -1135,7 +1143,7 @@ class MongoModuleStore(ModuleStoreWriteBase):
"""
Return an array of all of the locations (deprecated string format) for orphans in the course.
"""
course_key = self._fill_in_run(course_key)
course_key = self.fill_in_run(course_key)
detached_categories = [name for name, __ in XBlock.load_tagged_classes("detached")]
query = self._course_key_to_son(course_key)
query['_id.category'] = {'$nin': detached_categories}

2
common/lib/xmodule/xmodule/modulestore/mongo/draft.py
View File

@@ -184,7 +184,7 @@ class DraftModuleStore(MongoModuleStore):
new_course = self.get_course(dest_course_id)
if new_course is None:
# create_course creates the about overview
new_course = self.create_course(dest_course_id.org, dest_course_id.offering, user_id)
new_course = self.create_course(dest_course_id.org, dest_course_id.course, dest_course_id.run, user_id)
# Get all modules under this namespace which is (tag, org, course) tuple
modules = self.get_items(source_course_id, revision=ModuleStoreEnum.RevisionOption.published_only)

16
common/lib/xmodule/xmodule/modulestore/mongoengine_fields.py
View File

@@ -4,7 +4,7 @@ Custom field types for mongoengine
import mongoengine
from opaque_keys.edx.locations import SlashSeparatedCourseKey, Location
from types import NoneType
from opaque_keys.edx.keys import CourseKey
from opaque_keys.edx.keys import CourseKey, UsageKey
class CourseKeyField(mongoengine.StringField):
@@ -19,7 +19,7 @@ class CourseKeyField(mongoengine.StringField):
"""
For now saves the course key in the deprecated form
"""
assert isinstance(course_key, (NoneType, SlashSeparatedCourseKey))
assert isinstance(course_key, (NoneType, CourseKey))
if course_key:
# don't call super as base.BaseField.to_mongo calls to_python() for some odd reason
return course_key.to_deprecated_string()
@@ -32,7 +32,7 @@ class CourseKeyField(mongoengine.StringField):
"""
# calling super b/c it decodes utf (and doesn't have circularity of from_python)
course_key = super(CourseKeyField, self).to_python(course_key)
assert isinstance(course_key, (NoneType, basestring, SlashSeparatedCourseKey))
assert isinstance(course_key, (NoneType, basestring, CourseKey))
if course_key == '':
return None
if isinstance(course_key, basestring):
@@ -41,7 +41,7 @@ class CourseKeyField(mongoengine.StringField):
return course_key
def validate(self, value):
assert isinstance(value, (NoneType, basestring, SlashSeparatedCourseKey))
assert isinstance(value, (NoneType, basestring, CourseKey))
if isinstance(value, CourseKey):
return super(CourseKeyField, self).validate(value.to_deprecated_string())
else:
@@ -59,7 +59,7 @@ class UsageKeyField(mongoengine.StringField):
"""
For now saves the usage key in the deprecated location i4x/c4x form
"""
assert isinstance(location, (NoneType, Location))
assert isinstance(location, (NoneType, UsageKey))
if location is None:
return None
return super(UsageKeyField, self).to_mongo(location.to_deprecated_string())
@@ -68,7 +68,7 @@ class UsageKeyField(mongoengine.StringField):
"""
Deserialize to a UsageKey instance: for now it's a location missing the run
"""
assert isinstance(location, (NoneType, basestring, Location))
assert isinstance(location, (NoneType, basestring, UsageKey))
if location == '':
return None
if isinstance(location, basestring):
@@ -78,8 +78,8 @@ class UsageKeyField(mongoengine.StringField):
return location
def validate(self, value):
assert isinstance(value, (NoneType, basestring, Location))
if isinstance(value, Location):
assert isinstance(value, (NoneType, basestring, UsageKey))
if isinstance(value, UsageKey):
return super(UsageKeyField, self).validate(value.to_deprecated_string())
else:
return super(UsageKeyField, self).validate(value)

4
common/lib/xmodule/xmodule/modulestore/search.py
View File

@@ -56,7 +56,7 @@ def path_to_location(modulestore, usage_key):
parent = modulestore.get_parent_location(next_usage)
# print 'Processing loc={0}, path={1}'.format(next_usage, path)
if next_usage.definition_key.block_type == "course":
if next_usage.block_type == "course":
# Found it!
path = (next_usage, path)
return flatten(path)
@@ -92,7 +92,7 @@ def path_to_location(modulestore, usage_key):
if n > 3:
position_list = []
for path_index in range(2, n - 1):
category = path[path_index].definition_key.block_type
category = path[path_index].block_type
if category == 'sequential' or category == 'videosequence':
section_desc = modulestore.get_item(path[path_index])
child_locs = [c.location for c in section_desc.get_children()]

5
common/lib/xmodule/xmodule/modulestore/split_migrator.py
View File

@@ -45,7 +45,10 @@ class SplitMigrator(object):
original_course = self.draft_modulestore.get_course(course_key)
new_course_root_locator = self.loc_mapper.translate_location(original_course.location)
new_course = self.split_modulestore.create_course(
new_course_root_locator.org, new_course_root_locator.offering, user.id,
new_course_root_locator.org,
new_course_root_locator.course,
new_course_root_locator.run,
user.id,
fields=self._get_json_fields_translate_references(original_course, course_key, True),
root_block_id=new_course_root_locator.block_id,
master_branch=new_course_root_locator.branch

8
common/lib/xmodule/xmodule/modulestore/split_mongo/caching_descriptor_system.py
View File

@@ -68,7 +68,7 @@ class CachingDescriptorSystem(MakoDescriptorSystem):
# deeper than initial descendant fetch or doesn't exist
course_info = course_entry_override or self.course_entry
course_key = CourseLocator(
course_info.get('org'), course_info.get('offering'), course_info.get('branch'),
course_info.get('org'), course_info.get('course'), course_info.get('run'), course_info.get('branch'),
course_info['structure']['_id']
)
self.modulestore.cache_items(self, [block_id], course_key, lazy=self.lazy)
@@ -97,7 +97,8 @@ class CachingDescriptorSystem(MakoDescriptorSystem):
# most recent retrieval is most likely the right one for next caller (see comment above fn)
self.course_entry['branch'] = course_entry_override['branch']
self.course_entry['org'] = course_entry_override['org']
self.course_entry['offering'] = course_entry_override['offering']
self.course_entry['course'] = course_entry_override['course']
self.course_entry['run'] = course_entry_override['run']
# most likely a lazy loader or the id directly
definition = json_data.get('definition', {})
definition_id = self.modulestore.definition_locator(definition)
@@ -110,7 +111,8 @@ class CachingDescriptorSystem(MakoDescriptorSystem):
CourseLocator(
version_guid=course_entry_override['structure']['_id'],
org=course_entry_override.get('org'),
offering=course_entry_override.get('offering'),
course=course_entry_override.get('course'),
run=course_entry_override.get('run'),
branch=course_entry_override.get('branch'),
),
block_type=json_data.get('category'),

12
common/lib/xmodule/xmodule/modulestore/split_mongo/mongo_connection.py
View File

@@ -80,11 +80,11 @@ class MongoConnection(object):
"""
Get the course_index from the persistence mechanism whose id is the given key
"""
case_regex = r"(?i)^{}$" if ignore_case else r"{}"
case_regex = ur"(?i)^{}$" if ignore_case else ur"{}"
return self.course_index.find_one(
son.SON([
(key_attr, re.compile(case_regex.format(getattr(key, key_attr))))
for key_attr in ('org', 'offering')
for key_attr in ('org', 'course', 'run')
])
)
@@ -106,7 +106,7 @@ class MongoConnection(object):
Update the db record for course_index
"""
self.course_index.update(
son.SON([('org', course_index['org']), ('offering', course_index['offering'])]),
son.SON([('org', course_index['org']), ('course', course_index['course']), ('run', course_index['run'])]),
course_index
)
@@ -114,7 +114,11 @@ class MongoConnection(object):
"""
Delete the course_index from the persistence mechanism whose id is the given course_index
"""
return self.course_index.remove(son.SON([('org', course_index['org']), ('offering', course_index['offering'])]))
return self.course_index.remove(son.SON([
('org', course_index['org']),
('course', course_index['course']),
('run', course_index['run'])
]))
def get_definition(self, key):
"""

53
common/lib/xmodule/xmodule/modulestore/split_mongo/split.py
View File

@@ -5,7 +5,8 @@ Representation:
* course_index: a dictionary:
** '_id': a unique id which cannot change,
** 'org': the org's id. Only used for searching not identity,
** 'offering': the course's catalog number and run id or whatever user decides,
** 'course': the course's catalog number
** 'run': the course's run id or whatever user decides,
** 'edited_by': user_id of user who created the original entry,
** 'edited_on': the datetime of the original creation,
** 'versions': versions_dict: {branch_id: structure_id, ...}
@@ -215,7 +216,8 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
course_key = CourseLocator(
version_guid=course_entry['structure']['_id'],
org=course_entry.get('org'),
offering=course_entry.get('offering'),
course=course_entry.get('course'),
run=course_entry.get('run'),
branch=course_entry.get('branch'),
)
self.cache_items(system, block_ids, course_key, depth, lazy)
@@ -265,7 +267,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
:param course_locator: any subclass of CourseLocator
'''
if course_locator.org and course_locator.offering and course_locator.branch:
if course_locator.org and course_locator.course and course_locator.run and course_locator.branch:
# use the course id
index = self.db_connection.get_course_index(course_locator)
if index is None:
@@ -286,12 +288,14 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
version_guid = course_locator.as_object_id(version_guid)
entry = self.db_connection.get_structure(version_guid)
# b/c more than one course can use same structure, the 'org', 'offering', and 'branch' are not intrinsic to structure
# b/c more than one course can use same structure, the 'org', 'course',
# 'run', and 'branch' are not intrinsic to structure
# and the one assoc'd w/ it by another fetch may not be the one relevant to this fetch; so,
# add it in the envelope for the structure.
envelope = {
'org': course_locator.org,
'offering': course_locator.offering,
'course': course_locator.course,
'run': course_locator.run,
'branch': course_locator.branch,
'structure': entry,
}
@@ -331,7 +335,8 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
course_info = id_version_map[entry['_id']]
envelope = {
'org': course_info['org'],
'offering': course_info['offering'],
'course': course_info['course'],
'run': course_info['run'],
'branch': branch,
'structure': entry,
}
@@ -362,7 +367,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
'''
assert(isinstance(course_id, CourseLocator))
course_index = self.db_connection.get_course_index(course_id, ignore_case)
return CourseLocator(course_index['org'], course_index['offering'], course_id.branch) if course_index else None
return CourseLocator(course_index['org'], course_index['course'], course_index['run'], course_id.branch) if course_index else None
def has_item(self, usage_key):
"""
@@ -514,7 +519,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
The index records the initial creation of the indexed course and tracks the current version
heads. This function is primarily for test verification but may serve some
more general purpose.
:param course_locator: must have a org and offering set
:param course_locator: must have a org, course, and run set
:return {'org': string,
versions: {'draft': the head draft version id,
'published': the head published version id if any,
@@ -523,7 +528,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
'edited_on': when the course was originally created
}
"""
if not (course_locator.offering and course_locator.org):
if not (course_locator.course and course_locator.run and course_locator.org):
return None
index = self.db_connection.get_course_index(course_locator)
return index
@@ -749,7 +754,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
:param course_or_parent_locator: If BlockUsageLocator, then it's assumed to be the parent.
If it's a CourseLocator, then it's
merely the containing course. If it has a version_guid and a course org + offering + branch, this
merely the containing course. If it has a version_guid and a course org + course + run + branch, this
method ensures that the version is the head of the given course branch before making the change.
raises InsufficientSpecificationError if there is no course locator.
@@ -779,11 +784,11 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
Rules for course locator:
* If the course locator specifies a org and offering and either it doesn't
* If the course locator specifies a org and course and run and either it doesn't
specify version_guid or the one it specifies == the current head of the branch,
it progresses the course to point
to the new head and sets the active version to point to the new head
* If the locator has a org and offering but its version_guid != current head, it raises VersionConflictError.
* If the locator has a org and course and run but its version_guid != current head, it raises VersionConflictError.
NOTE: using a version_guid will end up creating a new version of the course. Your new item won't be in
the course id'd by version_guid but instead in one w/ a new version_guid. Ensure in this case that you get
@@ -886,7 +891,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
)
def create_course(
self, org, offering, user_id, fields=None,
self, org, course, run, user_id, fields=None,
master_branch=ModuleStoreEnum.BranchName.draft, versions_dict=None, root_category='course',
root_block_id='course', **kwargs
):
@@ -897,12 +902,13 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
Arguments:
org (str): the organization that owns the course
offering (str): the name of the course offering
course (str): the course number of the course
run (str): the particular run of the course (e.g. 2013_T1)
user_id: id of the user creating the course
fields (dict): Fields to set on the course at initialization
kwargs: Any optional arguments understood by a subset of modulestores to customize instantiation
offering: If it's already taken, this method will raise DuplicateCourseError
course + run: If there are duplicates, this method will raise DuplicateCourseError
fields: if scope.settings fields provided, will set the fields of the root course object in the
new course. If both
@@ -928,8 +934,8 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
provide any fields overrides, see above). if not provided, will create a mostly empty course
structure with just a category course root xblock.
"""
# check offering's uniqueness
locator = CourseLocator(org=org, offering=offering, branch=master_branch)
# check course and run's uniqueness
locator = CourseLocator(org=org, course=course, run=run, branch=master_branch)
index = self.db_connection.get_course_index(locator)
if index is not None:
raise DuplicateCourseError(locator, index)
@@ -1003,7 +1009,8 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
index_entry = {
'_id': ObjectId(),
'org': org,
'offering': offering,
'course': course,
'run': run,
'edited_by': user_id,
'edited_on': datetime.datetime.now(UTC),
'versions': versions_dict,
@@ -1019,7 +1026,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
raises ItemNotFoundError if the location does not exist.
Creates a new course version. If the descriptor's location has a org and offering, it moves the course head
Creates a new course version. If the descriptor's location has a org and course and run, it moves the course head
pointer. If the version_guid of the descriptor points to a non-head version and there's been an intervening
change to this item, it raises a VersionConflictError unless force is True. In the force case, it forks
the course but leaves the head pointer where it is (this change will not be in the course head).
@@ -1067,7 +1074,9 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
if index_entry is not None:
self._update_head(index_entry, descriptor.location.branch, new_id)
course_key = CourseLocator(
org=index_entry['org'], offering=index_entry['offering'],
org=index_entry['org'],
course=index_entry['course'],
run=index_entry['run'],
branch=descriptor.location.branch,
version_guid=new_id
)
@@ -1336,7 +1345,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
raises ItemNotFoundError if the location does not exist.
raises ValueError if usage_locator points to the structure root
Creates a new course version. If the descriptor's location has a org and offering, it moves the course head
Creates a new course version. If the descriptor's location has a org, a course, and a run, it moves the course head
pointer. If the version_guid of the descriptor points to a non-head version and there's been an intervening
change to this item, it raises a VersionConflictError unless force is True. In the force case, it forks
the course but leaves the head pointer where it is (this change will not be in the course head).
@@ -1560,7 +1569,7 @@ class SplitMongoModuleStore(ModuleStoreWriteBase):
:param continue_version: if True, assumes this operation requires a head version and will not create a new
version but instead continue an existing transaction on this version. This flag cannot be True if force is True.
"""
if locator.org is None or locator.offering is None or locator.branch is None:
if locator.org is None or locator.course is None or locator. run is None or locator.branch is None:
if continue_version:
raise InsufficientSpecificationError(
"To continue a version, the locator must point to one ({}).".format(locator)

3
common/lib/xmodule/xmodule/modulestore/tests/factories.py
View File

@@ -4,6 +4,7 @@ from uuid import uuid4
from xmodule.modulestore import prefer_xmodules, ModuleStoreEnum
from opaque_keys.edx.locations import Location
from opaque_keys.edx.keys import UsageKey
from xblock.core import XBlock
from xmodule.tabs import StaticTab
from decorator import contextmanager
@@ -150,7 +151,7 @@ class ItemFactory(XModuleFactory):
user_id = kwargs.pop('user_id', ModuleStoreEnum.UserID.test)
publish_item = kwargs.pop('publish_item', True)
assert isinstance(location, Location)
assert isinstance(location, UsageKey)
assert location != parent_location
store = kwargs.pop('modulestore')

8
common/lib/xmodule/xmodule/modulestore/tests/persistent_factories.py
View File

@@ -1,9 +1,11 @@
"""Provides factories for Split."""
from xmodule.modulestore import ModuleStoreEnum
from xmodule.course_module import CourseDescriptor
from xmodule.x_module import XModuleDescriptor
import factory
from factory.helpers import lazy_attribute
# Factories don't have __init__ methods, and are self documenting
# pylint: disable=W0232, C0111
class SplitFactory(factory.Factory):
"""
@@ -33,14 +35,14 @@ class PersistentCourseFactory(SplitFactory):
# pylint: disable=W0613
@classmethod
def _create(cls, target_class, offering='999', org='testX', user_id=ModuleStoreEnum.UserID.test,
def _create(cls, target_class, course='999', run='run', org='testX', user_id=ModuleStoreEnum.UserID.test,
master_branch=ModuleStoreEnum.BranchName.draft, **kwargs):
modulestore = kwargs.pop('modulestore')
root_block_id = kwargs.pop('root_block_id', 'course')
# Write the data to the mongo datastore
new_course = modulestore.create_course(
org, offering, user_id, fields=kwargs,
org, course, run, user_id, fields=kwargs,
master_branch=master_branch, root_block_id=root_block_id
)

8
common/lib/xmodule/xmodule/modulestore/tests/test_location_mapper.py
View File

@@ -42,6 +42,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
"""
Test the location to locator mapper
"""
@unittest.skip("getting rid of loc_mapper")
def test_create_map(self):
def _construct_course_son(org, course, run):
"""
@@ -88,6 +89,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
self.assertEqual(entry['prod_branch'], 'live')
self.assertEqual(entry['block_map'], block_map)
@unittest.skip("getting rid of loc_mapper")
def test_delete_course_map(self):
"""
Test that course location is properly remove from loc_mapper and cache when course is deleted
@@ -119,6 +121,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
cached_value = loc_mapper()._get_course_location_from_cache(course_location)
self.assertIsNone(cached_value, 'Entry found in cache')
@unittest.skip("getting rid of loc_mapper")
def translate_n_check(self, location, org, offering, block_id, branch, add_entry=False):
"""
Request translation, check org, offering, block_id, and branch
@@ -141,6 +144,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
self.assertEqual(course_locator.offering, offering)
self.assertEqual(course_locator.branch, branch)
@unittest.skip("getting rid of loc_mapper")
def test_translate_location_read_only(self):
"""
Test the variants of translate_location which don't create entries, just decode
@@ -213,6 +217,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
'problem3', ModuleStoreEnum.BranchName.published
)
@unittest.skip("getting rid of loc_mapper")
def test_translate_location_dwim(self):
"""
Test the location translation mechanisms which try to do-what-i-mean by creating new
@@ -254,6 +259,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
new_prob_locn, delta_new_org, delta_new_offering, new_usage_id, ModuleStoreEnum.BranchName.published, True
)
@unittest.skip("getting rid of loc_mapper")
def test_translate_locator(self):
"""
tests translate_locator_to_location(BlockUsageLocator)
@@ -340,6 +346,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
prob_location = loc_mapper().translate_locator_to_location(prob_locator)
self.assertEqual(prob_location, Location(org, course, run, 'problem', 'abc123', MongoRevisionKey.published))
@unittest.skip("getting rid of loc_mapper")
def test_special_chars(self):
"""
Test locations which have special characters
@@ -356,6 +363,7 @@ class TestLocationMapper(LocMapperSetupSansDjango):
reverted_location = loc_mapper().translate_locator_to_location(prob_locator)
self.assertEqual(location, reverted_location)
@unittest.skip("getting rid of loc_mapper")
def test_name_collision(self):
"""
Test dwim translation when the old name was not unique

8
common/lib/xmodule/xmodule/modulestore/tests/test_mixed_modulestore.py
View File

@@ -123,11 +123,7 @@ class TestMixedModuleStore(LocMapperSetupSansDjango):
"""
Create a course w/ one item in the persistence store using the given course & item location.
"""
if default == 'split':
offering = course_key.offering.replace('/', '.')
else:
offering = course_key.offering
course = self.store.create_course(course_key.org, offering, self.user_id)
course = self.store.create_course(course_key.org, course_key.course, course_key.run, self.user_id)
category = self.writable_chapter_location.category
block_id = self.writable_chapter_location.name
chapter = self.store.create_item(
@@ -367,7 +363,7 @@ class TestMixedModuleStore(LocMapperSetupSansDjango):
xml_store = self.store._get_modulestore_by_type(ModuleStoreEnum.Type.xml)
# the important thing is not which exception it raises but that it raises an exception
with self.assertRaises(AttributeError):
xml_store.create_course("org", "course/run", self.user_id)
xml_store.create_course("org", "course", "run", self.user_id)
@ddt.data('draft', 'split')
def test_get_course(self, default_ms):

59
common/lib/xmodule/xmodule/modulestore/tests/test_modulestore.py
View File

@@ -40,33 +40,34 @@ def check_has_course_method(modulestore, locator, locator_key_fields):
assert_true(modulestore.has_course(locator, ignore_case))
for key_field in locator_key_fields:
locator_changes_that_should_not_be_found = [ # pylint: disable=invalid-name
# replace value for one of the keys
{key_field: 'fake'},
# add a character at the end
{key_field: getattr(locator, key_field) + 'X'},
# add a character in the beginning
{key_field: 'X' + getattr(locator, key_field)},
]
for changes in locator_changes_that_should_not_be_found:
search_locator = locator.replace(**changes)
assert_false(
modulestore.has_course(search_locator),
error_message.format(search_locator, ignore_case)
)
if getattr(locator, key_field):
locator_changes_that_should_not_be_found = [ # pylint: disable=invalid-name
# replace value for one of the keys
{key_field: 'fake'},
# add a character at the end
{key_field: getattr(locator, key_field) + 'X'},
# add a character in the beginning
{key_field: 'X' + getattr(locator, key_field)},
]
for changes in locator_changes_that_should_not_be_found:
search_locator = locator.replace(**changes)
assert_false(
modulestore.has_course(search_locator),
error_message.format(search_locator, ignore_case)
)
# test case [in]sensitivity
locator_case_changes = [
{key_field: getattr(locator, key_field).upper()},
{key_field: getattr(locator, key_field).capitalize()},
{key_field: getattr(locator, key_field).capitalize().swapcase()},
]
for changes in locator_case_changes:
search_locator = locator.replace(**changes)
# if ignore_case is true, the course would be found with a different-cased course locator.
# if ignore_case is false, the course should NOT found given an incorrectly-cased locator.
assert_equals(
modulestore.has_course(search_locator, ignore_case) is not None,
ignore_case,
error_message.format(search_locator, ignore_case)
)
# test case [in]sensitivity
locator_case_changes = [
{key_field: getattr(locator, key_field).upper()},
{key_field: getattr(locator, key_field).capitalize()},
{key_field: getattr(locator, key_field).capitalize().swapcase()},
]
for changes in locator_case_changes:
search_locator = locator.replace(**changes)
# if ignore_case is true, the course would be found with a different-cased course locator.
# if ignore_case is false, the course should NOT found given an incorrectly-cased locator.
assert_equals(
modulestore.has_course(search_locator, ignore_case) is not None,
ignore_case,
error_message.format(search_locator, ignore_case)
)

9
common/lib/xmodule/xmodule/modulestore/tests/test_mongo.py
View File

@@ -26,6 +26,7 @@ from xmodule.modulestore import ModuleStoreEnum
from xmodule.modulestore.mongo import MongoModuleStore, MongoKeyValueStore
from xmodule.modulestore.draft import DraftModuleStore
from opaque_keys.edx.locations import SlashSeparatedCourseKey, AssetLocation
from opaque_keys.edx.keys import UsageKey
from xmodule.modulestore.xml_exporter import export_to_xml
from xmodule.modulestore.xml_importer import import_from_xml, perform_xlint
from xmodule.contentstore.mongo import MongoContentStore
@@ -407,20 +408,20 @@ class TestMongoModuleStore(unittest.TestCase):
def check_xblock_fields():
def check_children(xblock):
for child in xblock.children:
assert_is_instance(child, Location)
assert_is_instance(child, UsageKey)
course = self.draft_store.get_course(course_key)
check_children(course)
refele = self.draft_store.get_item(self.refloc)
check_children(refele)
assert_is_instance(refele.reference_link, Location)
assert_is_instance(refele.reference_link, UsageKey)
assert_greater(len(refele.reference_list), 0)
for ref in refele.reference_list:
assert_is_instance(ref, Location)
assert_is_instance(ref, UsageKey)
assert_greater(len(refele.reference_dict), 0)
for ref in refele.reference_dict.itervalues():
assert_is_instance(ref, Location)
assert_is_instance(ref, UsageKey)
def check_mongo_fields():
def get_item(location):

4
common/lib/xmodule/xmodule/modulestore/tests/test_orphan.py
View File

@@ -31,9 +31,9 @@ class TestOrphan(SplitWMongoCourseBoostrapper):
"""
orphans = self.old_mongo.get_orphans(self.old_course_key)
self.assertEqual(len(orphans), 3, "Wrong # {}".format(orphans))
location = self.old_course_key.make_usage_key('chapter', name='OrphanChapter')
location = self.old_course_key.make_usage_key('chapter', 'OrphanChapter')
self.assertIn(location.to_deprecated_string(), orphans)
location = self.old_course_key.make_usage_key('vertical', name='OrphanVert')
location = self.old_course_key.make_usage_key('vertical', 'OrphanVert')
self.assertIn(location.to_deprecated_string(), orphans)
location = self.old_course_key.make_usage_key('html', 'OrphanHtml')
self.assertIn(location.to_deprecated_string(), orphans)

18
common/lib/xmodule/xmodule/modulestore/tests/test_publish.py
View File

@@ -63,14 +63,14 @@ class TestPublish(SplitWMongoCourseBoostrapper):
To reproduce a bug (STUD-811) publish a vertical, convert to draft, delete a child, move a child, publish.
See if deleted and moved children still is connected or exists in db (bug was disconnected but existed)
"""
vert_location = self.old_course_key.make_usage_key('vertical', name='Vert1')
vert_location = self.old_course_key.make_usage_key('vertical', block_id='Vert1')
item = self.draft_mongo.get_item(vert_location, 2)
# Vert1 has 3 children; so, publishes 4 nodes which may mean 4 inserts & 1 bulk remove
# 25-June-2014 find calls are 19. Probably due to inheritance recomputation?
# 02-July-2014 send calls are 7. 5 from above, plus 2 for updating subtree edit info for Chapter1 and course
# find calls are 22. 19 from above, plus 3 for finding the parent of Vert1, Chapter1, and course
with check_mongo_calls(self.draft_mongo, 22, 7):
self.draft_mongo.publish(item.location, self.userid)
self.draft_mongo.publish(item.location, self.user_id)
# verify status
item = self.draft_mongo.get_item(vert_location, 0)
@@ -78,21 +78,21 @@ class TestPublish(SplitWMongoCourseBoostrapper):
# however, children are still draft, but I'm not sure that's by design
# delete the draft version of the discussion
location = self.old_course_key.make_usage_key('discussion', name='Discussion1')
self.draft_mongo.delete_item(location, self.userid)
location = self.old_course_key.make_usage_key('discussion', block_id='Discussion1')
self.draft_mongo.delete_item(location, self.user_id)
draft_vert = self.draft_mongo.get_item(vert_location, 0)
self.assertTrue(getattr(draft_vert, 'is_draft', False), "Deletion didn't convert parent to draft")
self.assertNotIn(location, draft_vert.children)
# move the other child
other_child_loc = self.old_course_key.make_usage_key('html', name='Html2')
other_child_loc = self.old_course_key.make_usage_key('html', block_id='Html2')
draft_vert.children.remove(other_child_loc)
other_vert = self.draft_mongo.get_item(self.old_course_key.make_usage_key('vertical', name='Vert2'), 0)
other_vert = self.draft_mongo.get_item(self.old_course_key.make_usage_key('vertical', block_id='Vert2'), 0)
other_vert.children.append(other_child_loc)
self.draft_mongo.update_item(draft_vert, self.userid)
self.draft_mongo.update_item(other_vert, self.userid)
self.draft_mongo.update_item(draft_vert, self.user_id)
self.draft_mongo.update_item(other_vert, self.user_id)
# publish
self.draft_mongo.publish(vert_location, self.userid)
self.draft_mongo.publish(vert_location, self.user_id)
item = self.old_mongo.get_item(vert_location, 0)
self.assertNotIn(location, item.children)
self.assertIsNone(self.draft_mongo.get_parent_location(location))

149
common/lib/xmodule/xmodule/modulestore/tests/test_split_modulestore.py
View File

@@ -61,7 +61,8 @@ class SplitModuleTest(unittest.TestCase):
COURSE_CONTENT = {
"testx.GreekHero": {
"org": "testx",
"offering": "GreekHero",
"course": "GreekHero",
"run": "run",
"root_block_id": "head12345",
"user_id": "test@edx.org",
"fields": {
@@ -281,7 +282,8 @@ class SplitModuleTest(unittest.TestCase):
},
"testx.wonderful": {
"org": "testx",
"offering": "wonderful",
"course": "wonderful",
"run": "run",
"root_block_id": "head23456",
"user_id": "test@edx.org",
"fields": {
@@ -387,7 +389,8 @@ class SplitModuleTest(unittest.TestCase):
},
"guestx.contender": {
"org": "guestx",
"offering": "contender",
"course": "contender",
"run": "run",
"root_block_id": "head345679",
"user_id": "test@guestx.edu",
"fields": {
@@ -450,7 +453,10 @@ class SplitModuleTest(unittest.TestCase):
split_store = modulestore()
for _course_id, course_spec in SplitModuleTest.COURSE_CONTENT.iteritems():
course = split_store.create_course(
course_spec['org'], course_spec['offering'], course_spec['user_id'],
course_spec['org'],
course_spec['course'],
course_spec['run'],
course_spec['user_id'],
fields=course_spec['fields'],
root_block_id=course_spec['root_block_id']
)
@@ -483,11 +489,11 @@ class SplitModuleTest(unittest.TestCase):
course = split_store.persist_xblock_dag(course, revision['user_id'])
# publish "testx.wonderful"
to_publish = BlockUsageLocator(
CourseLocator(org="testx", offering="wonderful", branch=BRANCH_NAME_DRAFT),
CourseLocator(org="testx", course="wonderful", run="run", branch=BRANCH_NAME_DRAFT),
block_type='course',
block_id="head23456"
)
destination = CourseLocator(org="testx", offering="wonderful", branch=BRANCH_NAME_PUBLISHED)
destination = CourseLocator(org="testx", course="wonderful", run="run", branch=BRANCH_NAME_PUBLISHED)
split_store.xblock_publish("test@edx.org", to_publish, destination, [to_publish], None)
def setUp(self):
@@ -520,7 +526,7 @@ class TestHasChildrenAtDepth(SplitModuleTest):
def test_has_children_at_depth(self):
course_locator = CourseLocator(
org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT
org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT
)
block_locator = BlockUsageLocator(
course_locator, 'course', 'head12345'
@@ -586,7 +592,7 @@ class SplitModuleCourseTests(SplitModuleTest):
course = self.findByIdInResult(courses_published, "head23456")
self.assertIsNotNone(course, "published courses")
self.assertEqual(course.location.course_key.org, "testx")
self.assertEqual(course.location.course_key.offering, "wonderful")
self.assertEqual(course.location.course_key.course, "wonderful")
self.assertEqual(course.category, 'course', 'wrong category')
self.assertEqual(len(course.tabs), 4, "wrong number of tabs")
self.assertEqual(course.display_name, "The most wonderful course",
@@ -611,15 +617,15 @@ class SplitModuleCourseTests(SplitModuleTest):
check_has_course_method(
modulestore(),
CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_DRAFT),
locator_key_fields=['org', 'offering']
CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_DRAFT),
locator_key_fields=['org', 'course', 'run']
)
def test_get_course(self):
'''
Test the various calling forms for get_course
'''
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
head_course = modulestore().get_course(locator)
self.assertNotEqual(head_course.location.version_guid, head_course.previous_version)
locator = CourseLocator(version_guid=head_course.previous_version)
@@ -637,10 +643,11 @@ class SplitModuleCourseTests(SplitModuleTest):
self.assertEqual(course.edited_by, "testassist@edx.org")
self.assertDictEqual(course.grade_cutoffs, {"Pass": 0.55})
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(locator)
self.assertEqual(course.location.course_key.org, "testx")
self.assertEqual(course.location.course_key.offering, "GreekHero")
self.assertEqual(course.location.course_key.course, "GreekHero")
self.assertEqual(course.location.course_key.run, "run")
self.assertEqual(course.category, 'course')
self.assertEqual(len(course.tabs), 6)
self.assertEqual(course.display_name, "The Ancient Greek Hero")
@@ -650,28 +657,28 @@ class SplitModuleCourseTests(SplitModuleTest):
self.assertEqual(course.edited_by, "testassist@edx.org")
self.assertDictEqual(course.grade_cutoffs, {"Pass": 0.45})
locator = CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_PUBLISHED)
locator = CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_PUBLISHED)
course = modulestore().get_course(locator)
published_version = course.location.version_guid
locator = CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(locator)
self.assertNotEqual(course.location.version_guid, published_version)
def test_get_course_negative(self):
# Now negative testing
with self.assertRaises(InsufficientSpecificationError):
modulestore().get_course(CourseLocator(org='edu', offering='meh.blah'))
modulestore().get_course(CourseLocator(org='edu', course='meh', run='blah'))
with self.assertRaises(ItemNotFoundError):
modulestore().get_course(CourseLocator(org='edu', offering='nosuchthing', branch=BRANCH_NAME_DRAFT))
modulestore().get_course(CourseLocator(org='edu', course='nosuchthing', run="run", branch=BRANCH_NAME_DRAFT))
with self.assertRaises(ItemNotFoundError):
modulestore().get_course(CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_PUBLISHED))
modulestore().get_course(CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_PUBLISHED))
def test_cache(self):
"""
Test that the mechanics of caching work.
"""
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(locator)
block_map = modulestore().cache_items(
course.system, [child.block_id for child in course.children], course.id, depth=3
@@ -683,7 +690,7 @@ class SplitModuleCourseTests(SplitModuleTest):
"""
get_course_successors(course_locator, version_history_depth=1)
"""
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(locator)
versions = [course.location.version_guid, course.previous_version]
locator = CourseLocator(version_guid=course.previous_version)
@@ -720,8 +727,9 @@ class SplitModuleItemTests(SplitModuleTest):
has_item(BlockUsageLocator)
'''
org = 'testx'
offering = 'GreekHero'
course_locator = CourseLocator(org=org, offering=offering, branch=BRANCH_NAME_DRAFT)
course = 'GreekHero'
run = 'run'
course_locator = CourseLocator(org=org, course=course, run=run, branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(course_locator)
previous_version = course.previous_version
# positive tests of various forms
@@ -754,7 +762,7 @@ class SplitModuleItemTests(SplitModuleTest):
# in published course
locator = BlockUsageLocator(
CourseLocator(org="testx", offering="wonderful", branch=BRANCH_NAME_DRAFT),
CourseLocator(org="testx", course="wonderful", run="run", branch=BRANCH_NAME_DRAFT),
block_type="course",
block_id="head23456"
)
@@ -766,13 +774,13 @@ class SplitModuleItemTests(SplitModuleTest):
# negative tests--not found
# no such course or block
locator = BlockUsageLocator(
CourseLocator(org="foo", offering="doesnotexist", branch=BRANCH_NAME_DRAFT),
CourseLocator(org="foo", course="doesnotexist", run="run", branch=BRANCH_NAME_DRAFT),
block_type="course",
block_id="head23456"
)
self.assertFalse(modulestore().has_item(locator))
locator = BlockUsageLocator(
CourseLocator(org="testx", offering="wonderful", branch=BRANCH_NAME_DRAFT),
CourseLocator(org="testx", course="wonderful", run="run", branch=BRANCH_NAME_DRAFT),
block_type="vertical",
block_id="doesnotexist"
)
@@ -782,7 +790,7 @@ class SplitModuleItemTests(SplitModuleTest):
'''
get_item(blocklocator)
'''
hero_locator = CourseLocator(org="testx", offering="GreekHero", branch=BRANCH_NAME_DRAFT)
hero_locator = CourseLocator(org="testx", course="GreekHero", run="run", branch=BRANCH_NAME_DRAFT)
course = modulestore().get_course(hero_locator)
previous_version = course.previous_version
@@ -797,7 +805,8 @@ class SplitModuleItemTests(SplitModuleTest):
Check contents of block
"""
self.assertEqual(block.location.org, "testx")
self.assertEqual(block.location.offering, "GreekHero")
self.assertEqual(block.location.course, "GreekHero")
self.assertEqual(block.location.run, "run")
self.assertEqual(len(block.tabs), 6, "wrong number of tabs")
self.assertEqual(block.display_name, "The Ancient Greek Hero")
self.assertEqual(block.advertised_start, "Fall 2013")
@@ -818,8 +827,8 @@ class SplitModuleItemTests(SplitModuleTest):
"""
Tests that has_changes() only returns true when changes are present
"""
draft_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
published_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_PUBLISHED)
draft_course = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
published_course = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_PUBLISHED)
head = draft_course.make_usage_key('course', 'head12345')
dummy_user = ModuleStoreEnum.UserID.test
@@ -843,18 +852,18 @@ class SplitModuleItemTests(SplitModuleTest):
def test_get_non_root(self):
# not a course obj
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'chapter', 'chapter1'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'chapter', 'chapter1'
)
block = modulestore().get_item(locator)
self.assertEqual(block.location.org, "testx")
self.assertEqual(block.location.offering, "GreekHero")
self.assertEqual(block.location.course, "GreekHero")
self.assertEqual(block.category, 'chapter')
self.assertEqual(block.display_name, "Hercules")
self.assertEqual(block.edited_by, "testassist@edx.org")
# in published course
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_PUBLISHED), 'course', 'head23456'
CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_PUBLISHED), 'course', 'head23456'
)
self.assertIsInstance(
modulestore().get_item(locator),
@@ -864,12 +873,12 @@ class SplitModuleItemTests(SplitModuleTest):
# negative tests--not found
# no such course or block
locator = BlockUsageLocator(
CourseLocator(org='doesnotexist', offering='doesnotexist', branch=BRANCH_NAME_DRAFT), 'course', 'head23456'
CourseLocator(org='doesnotexist', course='doesnotexist', run="run", branch=BRANCH_NAME_DRAFT), 'course', 'head23456'
)
with self.assertRaises(ItemNotFoundError):
modulestore().get_item(locator)
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_DRAFT), 'html', 'doesnotexist'
CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_DRAFT), 'html', 'doesnotexist'
)
with self.assertRaises(ItemNotFoundError):
modulestore().get_item(locator)
@@ -903,7 +912,7 @@ class SplitModuleItemTests(SplitModuleTest):
'''
get_items(locator, qualifiers, [branch])
'''
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
# get all modules
matches = modulestore().get_items(locator)
self.assertEqual(len(matches), 6)
@@ -929,14 +938,14 @@ class SplitModuleItemTests(SplitModuleTest):
get_parent_location(locator): BlockUsageLocator
'''
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT),
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT),
'chapter', block_id='chapter1'
)
parent = modulestore().get_parent_location(locator)
self.assertIsNotNone(parent)
self.assertEqual(parent.block_id, 'head12345')
self.assertEqual(parent.org, "testx")
self.assertEqual(parent.offering, "GreekHero")
self.assertEqual(parent.course, "GreekHero")
locator = locator.course_key.make_usage_key('Chapter', 'chapter2')
parent = modulestore().get_parent_location(locator)
self.assertEqual(parent.block_id, 'head12345')
@@ -949,7 +958,7 @@ class SplitModuleItemTests(SplitModuleTest):
Test the existing get_children method on xdescriptors
"""
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'course', 'head12345'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'course', 'head12345'
)
block = modulestore().get_item(locator)
children = block.get_children()
@@ -996,7 +1005,7 @@ class TestItemCrud(SplitModuleTest):
create_item(course_or_parent_locator, category, user, definition_locator=None, fields): new_desciptor
"""
# grab link to course to ensure new versioning works
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
premod_course = modulestore().get_course(locator)
premod_history = modulestore().get_course_history_info(premod_course.location)
# add minimal one w/o a parent
@@ -1006,7 +1015,7 @@ class TestItemCrud(SplitModuleTest):
fields={'display_name': 'new sequential'}
)
# check that course version changed and course's previous is the other one
self.assertEqual(new_module.location.offering, "GreekHero")
self.assertEqual(new_module.location.course, "GreekHero")
self.assertNotEqual(new_module.location.version_guid, premod_course.location.version_guid)
self.assertIsNone(locator.version_guid, "Version inadvertently filled in")
current_course = modulestore().get_course(locator)
@@ -1032,13 +1041,13 @@ class TestItemCrud(SplitModuleTest):
Test create_item w/ specifying the parent of the new item
"""
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT),
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT),
'chapter', block_id='chapter2'
)
original = modulestore().get_item(locator)
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_DRAFT), 'course', 'head23456'
CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_DRAFT), 'course', 'head23456'
)
premod_course = modulestore().get_course(locator.course_key)
category = 'chapter'
@@ -1061,13 +1070,13 @@ class TestItemCrud(SplitModuleTest):
Actually, this tries to test all create_item features not tested above.
"""
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT),
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT),
'problem', block_id='problem1'
)
original = modulestore().get_item(locator)
locator = BlockUsageLocator(
CourseLocator(org='guestx', offering='contender', branch=BRANCH_NAME_DRAFT), 'course', 'head345679'
CourseLocator(org='guestx', course='contender', run="run", branch=BRANCH_NAME_DRAFT), 'course', 'head345679'
)
category = 'problem'
new_payload = "<problem>empty</problem>"
@@ -1100,7 +1109,7 @@ class TestItemCrud(SplitModuleTest):
"""
Check that using odd characters in block id don't break ability to add and retrieve block.
"""
course_key = CourseLocator(org='guestx', offering='contender', branch=BRANCH_NAME_DRAFT)
course_key = CourseLocator(org='guestx', course='contender', run="run", branch=BRANCH_NAME_DRAFT)
parent_locator = BlockUsageLocator(course_key, 'course', block_id="head345679")
chapter_locator = BlockUsageLocator(course_key, 'chapter', block_id="foo.bar_-~:0")
modulestore().create_item(
@@ -1131,7 +1140,7 @@ class TestItemCrud(SplitModuleTest):
"""
# start transaction w/ simple creation
user = random.getrandbits(32)
new_course = modulestore().create_course('test_org', 'test_transaction', user)
new_course = modulestore().create_course('test_org', 'test_transaction', 'test_run', user)
new_course_locator = new_course.id
index_history_info = modulestore().get_course_history_info(new_course.location)
course_block_prev_version = new_course.previous_version
@@ -1209,7 +1218,7 @@ class TestItemCrud(SplitModuleTest):
test updating an items metadata ensuring the definition doesn't version but the course does if it should
"""
locator = BlockUsageLocator(
CourseLocator(org="testx", offering="GreekHero", branch=BRANCH_NAME_DRAFT),
CourseLocator(org="testx", course="GreekHero", run="run", branch=BRANCH_NAME_DRAFT),
'problem', block_id="problem3_2"
)
problem = modulestore().get_item(locator)
@@ -1243,7 +1252,7 @@ class TestItemCrud(SplitModuleTest):
test updating an item's children ensuring the definition doesn't version but the course does if it should
"""
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'chapter', 'chapter3'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'chapter', 'chapter3'
)
block = modulestore().get_item(locator)
pre_def_id = block.definition_locator.definition_id
@@ -1270,7 +1279,7 @@ class TestItemCrud(SplitModuleTest):
test updating an item's definition: ensure it gets versioned as well as the course getting versioned
"""
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'course', 'head12345'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'course', 'head12345'
)
block = modulestore().get_item(locator)
pre_def_id = block.definition_locator.definition_id
@@ -1289,13 +1298,13 @@ class TestItemCrud(SplitModuleTest):
Test updating metadata, children, and definition in a single call ensuring all the versioning occurs
"""
locator = BlockUsageLocator(
CourseLocator('testx', 'GreekHero', branch=BRANCH_NAME_DRAFT),
CourseLocator('testx', 'GreekHero', 'run', branch=BRANCH_NAME_DRAFT),
'problem', block_id='problem1'
)
original = modulestore().get_item(locator)
# first add 2 children to the course for the update to manipulate
locator = BlockUsageLocator(
CourseLocator('guestx', 'contender', branch=BRANCH_NAME_DRAFT),
CourseLocator('guestx', 'contender', 'run', branch=BRANCH_NAME_DRAFT),
'course', block_id="head345679"
)
category = 'problem'
@@ -1373,7 +1382,7 @@ class TestItemCrud(SplitModuleTest):
"""
Create a course we can delete
"""
course = modulestore().create_course('nihilx', 'deletion', 'deleting_user')
course = modulestore().create_course('nihilx', 'deletion', 'run', 'deleting_user')
root = course.location.version_agnostic().for_branch(BRANCH_NAME_DRAFT)
for _ in range(4):
self.create_subtree_for_deletion(root, ['chapter', 'vertical', 'problem'])
@@ -1400,7 +1409,7 @@ class TestCourseCreation(SplitModuleTest):
The simplest case but probing all expected results from it.
"""
# Oddly getting differences of 200nsec
new_course = modulestore().create_course('test_org', 'test_course', 'create_user')
new_course = modulestore().create_course('test_org', 'test_course', 'test_run', 'create_user')
new_locator = new_course.location
# check index entry
index_info = modulestore().get_course_index_info(new_locator)
@@ -1425,10 +1434,10 @@ class TestCourseCreation(SplitModuleTest):
"""
Test making a course which points to an existing draft and published but not making any changes to either.
"""
original_locator = CourseLocator(org='testx', offering='wonderful', branch=BRANCH_NAME_DRAFT)
original_locator = CourseLocator(org='testx', course='wonderful', run="run", branch=BRANCH_NAME_DRAFT)
original_index = modulestore().get_course_index_info(original_locator)
new_draft = modulestore().create_course(
'best', 'leech', 'leech_master',
'best', 'leech', 'leech_run', 'leech_master',
versions_dict=original_index['versions'])
new_draft_locator = new_draft.location
self.assertRegexpMatches(new_draft_locator.org, 'best')
@@ -1467,7 +1476,7 @@ class TestCourseCreation(SplitModuleTest):
"""
Create a new course which overrides metadata and course_data
"""
original_locator = CourseLocator(org='guestx', offering='contender', branch=BRANCH_NAME_DRAFT)
original_locator = CourseLocator(org='guestx', course='contender', run="run", branch=BRANCH_NAME_DRAFT)
original = modulestore().get_course(original_locator)
original_index = modulestore().get_course_index_info(original_locator)
fields = {}
@@ -1484,7 +1493,7 @@ class TestCourseCreation(SplitModuleTest):
fields['grading_policy']['GRADE_CUTOFFS'] = {'A': .9, 'B': .8, 'C': .65}
fields['display_name'] = 'Derivative'
new_draft = modulestore().create_course(
'counter', 'leech', 'leech_master',
'counter', 'leech', 'leech_run', 'leech_master',
versions_dict={BRANCH_NAME_DRAFT: original_index['versions'][BRANCH_NAME_DRAFT]},
fields=fields
)
@@ -1504,11 +1513,11 @@ class TestCourseCreation(SplitModuleTest):
def test_update_course_index(self):
"""
Test the versions pointers. NOTE: you can change the org, offering, or other things, but
Test the versions pointers. NOTE: you can change the org, course, or other things, but
it's not clear how you'd find them again or associate them w/ existing student history since
we use course_key so many places as immutable.
"""
locator = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
locator = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
course_info = modulestore().get_course_index_info(locator)
# an allowed but not necessarily recommended way to revert the draft version
@@ -1531,7 +1540,7 @@ class TestCourseCreation(SplitModuleTest):
"""
user = random.getrandbits(32)
new_course = modulestore().create_course(
'test_org', 'test_transaction', user,
'test_org', 'test_transaction', 'test_run', user,
root_block_id='top', root_category='chapter'
)
self.assertEqual(new_course.location.block_id, 'top')
@@ -1553,7 +1562,7 @@ class TestCourseCreation(SplitModuleTest):
courses = modulestore().get_courses()
with self.assertRaises(DuplicateCourseError):
dupe_course_key = courses[0].location.course_key
modulestore().create_course(dupe_course_key.org, dupe_course_key.offering, user)
modulestore().create_course(dupe_course_key.org, dupe_course_key.course, dupe_course_key.run, user)
class TestInheritance(SplitModuleTest):
@@ -1567,13 +1576,13 @@ class TestInheritance(SplitModuleTest):
# Note, not testing value where defined (course) b/c there's no
# defined accessor for it on CourseDescriptor.
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'problem', 'problem3_2'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'problem', 'problem3_2'
)
node = modulestore().get_item(locator)
# inherited
self.assertEqual(node.graceperiod, datetime.timedelta(hours=2))
locator = BlockUsageLocator(
CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT), 'problem', 'problem1'
CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT), 'problem', 'problem1'
)
node = modulestore().get_item(locator)
# overridden
@@ -1594,8 +1603,8 @@ class TestPublish(SplitModuleTest):
"""
Test the standard patterns: publish to new branch, revise and publish
"""
source_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
dest_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_PUBLISHED)
source_course = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
dest_course = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_PUBLISHED)
head = source_course.make_usage_key('course', "head12345")
chapter1 = source_course.make_usage_key('chapter', 'chapter1')
chapter2 = source_course.make_usage_key('chapter', 'chapter2')
@@ -1640,16 +1649,16 @@ class TestPublish(SplitModuleTest):
"""
Test the exceptions which preclude successful publication
"""
source_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
source_course = CourseLocator(org='testx', course='GreekHero', run="run", branch=BRANCH_NAME_DRAFT)
# destination does not exist
destination_course = CourseLocator(org='fake', offering='Unknown', branch=BRANCH_NAME_PUBLISHED)
destination_course = CourseLocator(org='fake', course='Unknown', run="run", branch=BRANCH_NAME_PUBLISHED)
head = source_course.make_usage_key('course', "head12345")
chapter3 = source_course.make_usage_key('chapter', 'chapter3')
problem1 = source_course.make_usage_key('problem', 'problem1')
with self.assertRaises(ItemNotFoundError):
modulestore().xblock_publish(self.user_id, source_course, destination_course, [chapter3], None)
# publishing into a new branch w/o publishing the root
destination_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_PUBLISHED)
destination_course = CourseLocator(org='testx', course='GreekHero', run='run', branch=BRANCH_NAME_PUBLISHED)
with self.assertRaises(ItemNotFoundError):
modulestore().xblock_publish(self.user_id, source_course, destination_course, [chapter3], None)
# publishing a subdag w/o the parent already in course
@@ -1661,8 +1670,8 @@ class TestPublish(SplitModuleTest):
"""
Test publishing moves and deletes.
"""
source_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_DRAFT)
dest_course = CourseLocator(org='testx', offering='GreekHero', branch=BRANCH_NAME_PUBLISHED)
source_course = CourseLocator(org='testx', course='GreekHero', run='run', branch=BRANCH_NAME_DRAFT)
dest_course = CourseLocator(org='testx', course='GreekHero', run='run', branch=BRANCH_NAME_PUBLISHED)
head = source_course.make_usage_key('course', "head12345")
chapter2 = source_course.make_usage_key('chapter', 'chapter2')
problem1 = source_course.make_usage_key('problem', 'problem1')

16
common/lib/xmodule/xmodule/modulestore/tests/test_split_w_old_mongo.py
View File

@@ -20,7 +20,7 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
This class ensures the db gets created, opened, and cleaned up in addition to creating the course
Defines the following attrs on self:
* userid: a random non-registered mock user id
* user_id: a random non-registered mock user id
* split_mongo: a pointer to the split mongo instance
* old_mongo: a pointer to the old_mongo instance
* draft_mongo: a pointer to the old draft instance
@@ -40,12 +40,12 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
'xblock_mixins': (InheritanceMixin,)
}
split_course_key = CourseLocator('test_org', 'test_course.runid', branch=ModuleStoreEnum.BranchName.draft)
split_course_key = CourseLocator('test_org', 'test_course', 'runid', branch=ModuleStoreEnum.BranchName.draft)
def setUp(self):
self.db_config['collection'] = 'modulestore{0}'.format(uuid.uuid4().hex[:5])
self.userid = random.getrandbits(32)
self.user_id = random.getrandbits(32)
super(SplitWMongoCourseBoostrapper, self).setUp()
self.split_mongo = SplitMongoModuleStore(
None,
@@ -90,7 +90,7 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
mongo = self.old_mongo
else:
mongo = self.draft_mongo
mongo.create_and_save_xmodule(location, self.userid, definition_data=data, metadata=metadata, runtime=self.runtime)
mongo.create_and_save_xmodule(location, self.user_id, definition_data=data, metadata=metadata, runtime=self.runtime)
if isinstance(data, basestring):
fields = {'data': data}
else:
@@ -105,7 +105,7 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
mongo = self.draft_mongo
parent = mongo.get_item(parent_location)
parent.children.append(location)
mongo.update_item(parent, self.userid)
mongo.update_item(parent, self.user_id)
# create pointer for split
course_or_parent_locator = BlockUsageLocator(
course_key=self.split_course_key,
@@ -115,7 +115,7 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
else:
course_or_parent_locator = self.split_course_key
if split:
self.split_mongo.create_item(course_or_parent_locator, category, self.userid, block_id=name, fields=fields)
self.split_mongo.create_item(course_or_parent_locator, category, self.user_id, block_id=name, fields=fields)
def _create_course(self, split=True):
"""
@@ -135,8 +135,8 @@ class SplitWMongoCourseBoostrapper(unittest.TestCase):
if split:
# split requires the course to be created separately from creating items
self.split_mongo.create_course(
self.split_course_key.org, self.split_course_key.offering, self.userid, fields=fields, root_block_id='runid'
self.split_course_key.org, self.split_course_key.course, self.split_course_key.run, self.user_id, fields=fields, root_block_id='runid'
)
old_course = self.old_mongo.create_course(self.split_course_key.org, 'test_course/runid', self.userid, fields=fields)
old_course = self.old_mongo.create_course(self.split_course_key.org, 'test_course', 'runid', self.user_id, fields=fields)
self.old_course_key = old_course.id
self.runtime = old_course.runtime

2
common/lib/xmodule/xmodule/modulestore/xml_importer.py
View File

@@ -172,7 +172,7 @@ def import_from_xml(
# Creates a new course if it doesn't already exist
if create_new_course_if_not_present and not store.has_course(dest_course_id, ignore_case=True):
try:
store.create_course(dest_course_id.org, dest_course_id.offering, user_id)
store.create_course(dest_course_id.org, dest_course_id.course, dest_course_id.run, user_id)
except InvalidLocationError:
# course w/ same org and course exists
log.debug(

2
common/lib/xmodule/xmodule/tests/test_import.py
View File

@@ -438,7 +438,7 @@ class ImportTestCase(BaseCourseTestCase):
print("course errors:")
# Expect to find an error/exception about characters in "®esources"
expect = "Invalid characters"
expect = "InvalidKeyError"
errors = [
(msg.encode("utf-8"), err.encode("utf-8"))
for msg, err

2
common/lib/xmodule/xmodule/x_module.py
View File

@@ -605,7 +605,7 @@ def policy_key(location):
Get the key for a location in a policy file. (Since the policy file is
specific to a course, it doesn't need the full location url).
"""
return '{cat}/{name}'.format(cat=location.category, name=location.name)
return u'{cat}/{name}'.format(cat=location.category, name=location.name)
Template = namedtuple("Template", "metadata data children")

6
common/test/acceptance/fixtures/course.py
View File

@@ -266,14 +266,14 @@ class CourseFixture(StudioApiFixture):
"""
Return the locator string for the course.
"""
return "slashes:{org}+{number}+{run}".format(**self._course_dict)
return "{org}/{number}/{run}".format(**self._course_dict)
@property
def _course_location(self):
"""
Return the locator string for the course.
"""
return "location:{org}+{number}+{run}+course+{run}".format(**self._course_dict)
return "i4x://{org}/{number}/course/{run}".format(**self._course_dict)
@property
def _assets_url(self):
@@ -287,7 +287,7 @@ class CourseFixture(StudioApiFixture):
"""
Return the locator string for the course handouts
"""
return "location:{org}+{number}+{run}+course_info+handouts".format(**self._course_dict)
return "i4x://{org}/{number}/course_info/handouts".format(**self._course_dict)
def _create_course(self):
"""

2
common/test/acceptance/pages/studio/course_page.py
View File

@@ -34,5 +34,5 @@ class CoursePage(PageObject):
"""
Construct a URL to the page within the course.
"""
course_key = "slashes:{course_org}+{course_num}+{course_run}".format(**self.course_info)
course_key = "{course_org}/{course_num}/{course_run}".format(**self.course_info)
return "/".join([BASE_URL, self.url_path, course_key])

2
lms/djangoapps/bulk_email/tests/test_forms.py
View File

@@ -78,7 +78,7 @@ class CourseAuthorizationFormTest(ModuleStoreTestCase):
@patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True})
def test_form_typo(self):
# Munge course id
bad_id = SlashSeparatedCourseKey(u'Broken{}'.format(self.course.id.org), '', self.course.id.run + '_typo')
bad_id = SlashSeparatedCourseKey(u'Broken{}'.format(self.course.id.org), 'hello', self.course.id.run + '_typo')
form_data = {'course_id': bad_id.to_deprecated_string(), 'email_enabled': True}
form = CourseAuthorizationAdminForm(data=form_data)

5
lms/djangoapps/courseware/access.py
View File

@@ -9,7 +9,6 @@ from django.contrib.auth.models import AnonymousUser
from xmodule.course_module import CourseDescriptor
from xmodule.error_module import ErrorDescriptor
from opaque_keys.edx.locations import Location
from xmodule.x_module import XModule
from xblock.core import XBlock
@@ -23,7 +22,7 @@ from student.roles import (
GlobalStaff, CourseStaffRole, CourseInstructorRole,
OrgStaffRole, OrgInstructorRole, CourseBetaTesterRole
)
from opaque_keys.edx.keys import CourseKey
from opaque_keys.edx.keys import CourseKey, UsageKey
DEBUG_ACCESS = False
log = logging.getLogger(__name__)
@@ -85,7 +84,7 @@ def has_access(user, action, obj, course_key=None):
if isinstance(obj, CourseKey):
return _has_access_course_key(user, action, obj)
if isinstance(obj, Location):
if isinstance(obj, UsageKey):
return _has_access_location(user, action, obj, course_key)
if isinstance(obj, basestring):

5
lms/djangoapps/courseware/model_data.py
View File

@@ -13,6 +13,7 @@ from .models import (
)
import logging
from opaque_keys.edx.locations import SlashSeparatedCourseKey, Location
from opaque_keys.edx.keys import CourseKey, UsageKey
from django.db import DatabaseError
from django.contrib.auth.models import User
@@ -61,7 +62,7 @@ class FieldDataCache(object):
self.descriptors = descriptors
self.select_for_update = select_for_update
assert isinstance(course_id, SlashSeparatedCourseKey)
assert isinstance(course_id, CourseKey)
self.course_id = course_id
self.user = user
@@ -238,7 +239,7 @@ class FieldDataCache(object):
if key.scope == Scope.user_state:
# When we start allowing block_scope_ids to be either Locations or Locators,
# this assertion will fail. Fix the code here when that happens!
assert(isinstance(key.block_scope_id, Location))
assert(isinstance(key.block_scope_id, UsageKey))
field_object, _ = StudentModule.objects.get_or_create(
course_id=self.course_id,
student=User.objects.get(id=key.user_id),

4
lms/djangoapps/courseware/tests/test_courses.py
View File

@@ -39,9 +39,9 @@ class CoursesTest(ModuleStoreTestCase):
org='org', number='num', display_name='name'
)
cms_url = u"//{}/course/slashes:org+num+name".format(CMS_BASE_TEST)
cms_url = u"//{}/course/org/num/name".format(CMS_BASE_TEST)
self.assertEqual(cms_url, get_cms_course_link(self.course))
cms_url = u"//{}/course/location:org+num+name+course+name".format(CMS_BASE_TEST)
cms_url = u"//{}/course/i4x://org/num/course/name".format(CMS_BASE_TEST)
self.assertEqual(cms_url, get_cms_block_link(self.course, 'course'))

5
lms/djangoapps/django_comment_client/utils.py
View File

@@ -16,7 +16,8 @@ import pystache_custom as pystache
from xmodule.modulestore.django import modulestore
from django.utils.timezone import UTC
from opaque_keys.edx.locations import i4xEncoder, SlashSeparatedCourseKey
from opaque_keys.edx.locations import i4xEncoder
from opaque_keys.edx.keys import CourseKey
import json
log = logging.getLogger(__name__)
@@ -314,7 +315,7 @@ def render_mustache(template_name, dictionary, *args, **kwargs):
def permalink(content):
if isinstance(content['course_id'], SlashSeparatedCourseKey):
if isinstance(content['course_id'], CourseKey):
course_id = content['course_id'].to_deprecated_string()
else:
course_id = content['course_id']

4
lms/djangoapps/instructor_task/api_helper.py
View File

@@ -14,7 +14,7 @@ from celery.states import READY_STATES, SUCCESS, FAILURE, REVOKED
from courseware.module_render import get_xqueue_callback_url_prefix
from xmodule.modulestore.django import modulestore
from opaque_keys.edx.locations import Location
from opaque_keys.edx.keys import UsageKey
from instructor_task.models import InstructorTask, PROGRESS
@@ -262,7 +262,7 @@ def encode_problem_and_student_input(usage_key, student=None): # pylint: disabl
student (User): the student affected
"""
assert isinstance(usage_key, Location)
assert isinstance(usage_key, UsageKey)
if student is not None:
task_input = {'problem_url': usage_key.to_deprecated_string(), 'student': student.username}
task_key_stub = "{student}_{problem}".format(student=student.id, problem=usage_key.to_deprecated_string())

8
lms/envs/common.py
View File

@@ -30,6 +30,7 @@ import imp
import json
from path import path
from warnings import simplefilter
from .discussionsettings import *
from .modulestore_settings import *
@@ -760,9 +761,14 @@ MOCK_PEER_GRADING = False
# Used for testing, debugging staff grading
MOCK_STAFF_GRADING = False
################################# Jasmine ###################################
################################# Jasmine ##################################
JASMINE_TEST_DIRECTORY = PROJECT_ROOT + '/static/coffee'
################################# Deprecation warnings #####################
# Ignore deprecation warnings (so we don't clutter Jenkins builds/production)
simplefilter('ignore')
################################# Waffle ###################################
# Name prepended to cookies set by Waffle

7
lms/envs/test.py
View File

@@ -15,7 +15,7 @@ sessions. Assumes structure:
from .common import *
import os
from path import path
from warnings import filterwarnings
from warnings import filterwarnings, simplefilter
from uuid import uuid4
os.environ['DJANGO_LIVE_TEST_SERVER_ADDRESS'] = 'localhost:8000-9000'
@@ -179,6 +179,11 @@ SECRET_KEY = '85920908f28904ed733fe576320db18cabd7b6cd'
# hide ratelimit warnings while running tests
filterwarnings('ignore', message='No request passed to the backend, unable to rate-limit')
# Ignore deprecation warnings (so we don't clutter Jenkins builds/production)
# https://docs.python.org/2/library/warnings.html#the-warnings-filter
simplefilter('ignore') # Change to "default" to see the first instance of each hit
# or "error" to convert all into errors
######### Third-party auth ##########
FEATURES['ENABLE_THIRD_PARTY_AUTH'] = True

2
requirements/edx/github.txt
View File

@@ -28,6 +28,6 @@
-e git+https://github.com/edx-solutions/django-splash.git@9965a53c269666a30bb4e2b3f6037c138aef2a55#egg=django-splash
-e git+https://github.com/edx/acid-block.git@459aff7b63db8f2c5decd1755706c1a64fb4ebb1#egg=acid-xblock
-e git+https://github.com/edx/edx-ora2.git@release-2014-07-07T19.28#egg=edx-ora2
-e git+https://github.com/edx/opaque-keys.git@5929789900b3d0a354ce7274bde74edfd0430f03#egg=opaque-keys
-e git+https://github.com/edx/opaque-keys.git@3f6ea9984b8a084d1a1f5a3bd50f3cdb5ff44440#egg=opaque-keys
-e git+https://github.com/edx/ease.git@97de68448e5495385ba043d3091f570a699d5b5f#egg=ease
-e git+https://github.com/edx/i18n-tools.git@f5303e82dff368c7595884d9325aeea1d802da25#egg=i18n-tools