From 7852906ce00482eb735ee0698b82f29c1ec61562 Mon Sep 17 00:00:00 2001 From: Jay Zoldak Date: Mon, 28 Apr 2014 14:12:34 -0400 Subject: [PATCH 001/117] Reset the jenkins python virtualenv before test runs. --- jenkins/acceptance.sh | 7 +++++++ jenkins/all-tests.sh | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/jenkins/acceptance.sh b/jenkins/acceptance.sh index 52a29bcdd5..8bcaa209ff 100755 --- a/jenkins/acceptance.sh +++ b/jenkins/acceptance.sh @@ -54,6 +54,13 @@ git fetch origin master:refs/remotes/origin/master # Bootstrap Ruby requirements so we can run the tests bundle install +# Reset the jenkins worker's virtualenv back to the +# state it was in when the instance was spun up. +if [ -e $HOME/edx-venv_clean.tar.gz ]; then + rm -rf $HOME/edx-venv + tar -C $HOME -xf $HOME/edx-venv_clean.tar.gz +fi + # Activate the Python virtualenv source $HOME/edx-venv/bin/activate diff --git a/jenkins/all-tests.sh b/jenkins/all-tests.sh index b4706229f4..7d0bf8720c 100755 --- a/jenkins/all-tests.sh +++ b/jenkins/all-tests.sh @@ -62,6 +62,13 @@ git fetch origin master:refs/remotes/origin/master # Bootstrap Ruby requirements so we can run the tests bundle install +# Reset the jenkins worker's virtualenv back to the +# state it was in when the instance was spun up. +if [ -e $HOME/edx-venv_clean.tar.gz ]; then + rm -rf $HOME/edx-venv + tar -C $HOME -xf $HOME/edx-venv_clean.tar.gz +fi + # Activate the Python virtualenv source $HOME/edx-venv/bin/activate From afde40ad138202991dbf9dbcba1f5213ccb41aa9 Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:39 -0400 Subject: [PATCH 002/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit makes the embargo.tests module a real python module. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- common/djangoapps/embargo/tests/__init__.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 common/djangoapps/embargo/tests/__init__.py diff --git a/common/djangoapps/embargo/tests/__init__.py b/common/djangoapps/embargo/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 From c056891332c1baba01c990cda2f93b69cd2c588f Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:41 -0400 Subject: [PATCH 003/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit adds base classes for CourseKeys and UsageKeys, and Location and SlashSeparatedCourseKey implementations of both. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- .../lib/xmodule/xmodule/modulestore/keys.py | 153 +++++++++ .../xmodule/xmodule/modulestore/locations.py | 320 ++++++++++++++++++ 2 files changed, 473 insertions(+) create mode 100644 common/lib/xmodule/xmodule/modulestore/keys.py create mode 100644 common/lib/xmodule/xmodule/modulestore/locations.py diff --git a/common/lib/xmodule/xmodule/modulestore/keys.py b/common/lib/xmodule/xmodule/modulestore/keys.py new file mode 100644 index 0000000000..b1fe2277d2 --- /dev/null +++ b/common/lib/xmodule/xmodule/modulestore/keys.py @@ -0,0 +1,153 @@ +""" +OpaqueKey abstract classes for edx-platform object types (courses, definitions, usages, and assets). +""" +from abc import abstractmethod, abstractproperty + +from opaque_keys import OpaqueKey +from xblock.runtime import IdReader + + +class CourseKey(OpaqueKey): + """ + An :class:`opaque_keys.OpaqueKey` identifying a particular Course object. + """ + KEY_TYPE = 'course_key' + __slots__ = () + + @abstractproperty + def org(self): + """ + The organization that this course belongs to. + """ + raise NotImplementedError() + + @abstractproperty + def offering(self): + """ + The offering identifier for this course. + + This is complement of the org; in old-style IDs, "course/run" + """ + raise NotImplementedError() + + @abstractmethod + def make_usage_key(self, block_type, block_id): + """ + Return a usage key, given the given the specified block_type and block_id. + + This function should not actually create any new ids, but should simply + return one that already exists. + """ + raise NotImplementedError() + + @abstractmethod + def make_asset_key(self, asset_type, path): + """ + Return an asset key, given the given the specified path. + + This function should not actually create any new ids, but should simply + return one that already exists. + """ + raise NotImplementedError() + + +class DefinitionKey(OpaqueKey): + """ + An :class:`opaque_keys.OpaqueKey` identifying an XBlock definition. + """ + KEY_TYPE = 'definition_key' + __slots__ = () + + @abstractmethod + def block_type(self): + """ + The XBlock type of this definition. + """ + raise NotImplementedError() + + +class CourseObjectMixin(object): + """ + An abstract :class:`opaque_keys.OpaqueKey` mixin + for keys that belong to courses. + """ + __slots__ = () + + @abstractproperty + def course_key(self): + """ + Return the :class:`CourseKey` for the course containing this usage. + """ + raise NotImplementedError() + + @abstractmethod + def map_into_course(self, course_key): + """ + Return a new :class:`UsageKey` or :class:`AssetKey` representing this usage inside the + course identified by the supplied :class:`CourseKey`. It returns the same type as + `self` + + Args: + course_key (:class:`CourseKey`): The course to map this object into. + + Returns: + A new :class:`CourseObjectMixin` instance. + """ + raise NotImplementedError() + + +class AssetKey(CourseObjectMixin, OpaqueKey): + """ + An :class:`opaque_keys.OpaqueKey` identifying a course asset. + """ + KEY_TYPE = 'asset_key' + __slots__ = () + + @abstractproperty + def path(self): + """ + Return the path for this asset. + """ + raise NotImplementedError() + + +class UsageKey(CourseObjectMixin, OpaqueKey): + """ + An :class:`opaque_keys.OpaqueKey` identifying an XBlock usage. + """ + KEY_TYPE = 'usage_key' + __slots__ = () + + @abstractproperty + def definition_key(self): + """ + Return the :class:`DefinitionKey` for the XBlock containing this usage. + """ + raise NotImplementedError() + + +class OpaqueKeyReader(IdReader): + """ + IdReader for :class:`DefinitionKey` and :class:`UsageKey`s. + """ + def get_definition_id(self, usage_id): + """Retrieve the definition that a usage is derived from. + + Args: + usage_id: The id of the usage to query + + Returns: + The `definition_id` the usage is derived from + """ + return usage_id.definition_key + + def get_block_type(self, def_id): + """Retrieve the block_type of a particular definition + + Args: + def_id: The id of the definition to query + + Returns: + The `block_type` of the definition + """ + return def_id.block_type diff --git a/common/lib/xmodule/xmodule/modulestore/locations.py b/common/lib/xmodule/xmodule/modulestore/locations.py new file mode 100644 index 0000000000..bdd13c932c --- /dev/null +++ b/common/lib/xmodule/xmodule/modulestore/locations.py @@ -0,0 +1,320 @@ +"""OpaqueKey implementations used by XML and Mongo modulestores""" + +import logging +import re + +from opaque_keys import InvalidKeyError, OpaqueKey + +from xmodule.modulestore.keys import CourseKey, UsageKey, DefinitionKey, AssetKey +import json + +log = logging.getLogger(__name__) + +URL_RE = re.compile(""" + ([^:/]+://?|/[^/]+) + (?P[^/]+)/ + (?P[^/]+)/ + (?P[^/]+)/ + (?P[^@]+) + (@(?P[^/]+))? + """, re.VERBOSE) + +# TODO (cpennington): We should decide whether we want to expand the +# list of valid characters in a location +INVALID_CHARS = re.compile(r"[^\w.%-]", re.UNICODE) +# Names are allowed to have colons. +INVALID_CHARS_NAME = re.compile(r"[^\w.:%-]", re.UNICODE) + +# html ids can contain word chars and dashes +INVALID_HTML_CHARS = re.compile(r"[^\w-]", re.UNICODE) + + +class SlashSeparatedCourseKey(CourseKey): + """Course key for old style org/course/run course identifiers""" + + CANONICAL_NAMESPACE = 'slashes' + KEY_FIELDS = ('org', 'course', 'run') + __slots__ = KEY_FIELDS + + @classmethod + def _from_string(cls, serialized): + serialized = serialized.replace("+", "/") + if serialized.count('/') != 2: + raise InvalidKeyError(cls, serialized) + + # Turns encoded slashes into actual slashes + return cls(*serialized.split('/')) + + def _to_string(self): + # Turns slashes into pluses + return u'+'.join([self.org, self.course, self.run]) + + @property + def offering(self): + return u'/'.join([self.course, self.run]) + + def make_asset_key(self, asset_type, path): + return AssetLocation(self.org, self.course, self.run, asset_type, path, None) + + def make_usage_key(self, block_type, name): + return Location(self.org, self.course, self.run, block_type, name, None) + + def to_deprecated_string(self): + return u'/'.join([self.org, self.course, self.run]) + + @classmethod + def from_deprecated_string(cls, serialized): + return cls._from_string(serialized) + + def make_usage_key_from_deprecated_string(self, location_url): + """ + Temporary mechanism for creating a UsageKey given a CourseKey and a serialized Location. NOTE: + this prejudicially takes the tag, org, and course from the url not self. + + Raises: + InvalidKeyError: if the url does not parse + """ + match = URL_RE.match(location_url) + if match is None: + raise InvalidKeyError(Location, location_url) + groups = match.groupdict() + return Location(run=self.run, **groups) + + +class LocationBase(object): + """ + Encodes a type of Location, which identifies a piece of + content situated in a course. + """ + KEY_FIELDS = ('org', 'course', 'run', 'category', 'name', 'revision') + + SERIALIZED_PATTERN = re.compile(""" + (?P[^/]+)\+ + (?P[^/]+)\+ + (?P[^/]+)\+ + (?P[^/]+)\+ + (?P[^@/]+) + (@(?P[^/]+))? + """, re.VERBOSE) + + @classmethod + def _check_location_part(cls, val, regexp): + """ + Check that `regexp` doesn't match inside `val`. If it does, raise an exception + + Args: + val (string): The value to check + regexp (re.RegexObject): The regular expression specifying invalid characters + + Raises: + InvalidKeyError: Raised if any invalid character is found in `val` + """ + if val is None: + return + + if not isinstance(val, basestring): + raise InvalidKeyError(cls, "{!r} is not a string".format(val)) + + if regexp.search(val) is not None: + raise InvalidKeyError(cls, "Invalid characters in {!r}.".format(val)) + + @classmethod + def _clean(cls, value, invalid): + """ + invalid should be a compiled regexp of chars to replace with '_' + """ + return re.sub('_+', '_', invalid.sub('_', value)) + + @classmethod + def clean(cls, value): + """ + Return value, made into a form legal for locations + """ + return cls._clean(value, INVALID_CHARS) + + @classmethod + def clean_keeping_underscores(cls, value): + """ + Return value, replacing INVALID_CHARS, but not collapsing multiple '_' chars. + This for cleaning asset names, as the YouTube ID's may have underscores in them, and we need the + transcript asset name to match. In the future we may want to change the behavior of _clean. + """ + return INVALID_CHARS.sub('_', value) + + @classmethod + def clean_for_url_name(cls, value): + """ + Convert value into a format valid for location names (allows colons). + """ + return cls._clean(value, INVALID_CHARS_NAME) + + @classmethod + def clean_for_html(cls, value): + """ + Convert a string into a form that's safe for use in html ids, classes, urls, etc. + Replaces all INVALID_HTML_CHARS with '_', collapses multiple '_' chars + """ + return cls._clean(value, INVALID_HTML_CHARS) + + def __init__(self, org, course, run, category, name, revision=None): + """ + Create a new Location that is a clone of the specifed one. + + Components must be composed of alphanumeric characters, or the + characters '_', '-', and '.'. The name component is additionally allowed to have ':', + which is interpreted specially for xml storage. + + Components may be set to None, which may be interpreted in some contexts + to mean wildcard selection. + """ + # check that the values are syntactically valid before creating object + for part in (org, course, run, category, revision): + self._check_location_part(part, INVALID_CHARS) + self._check_location_part(name, INVALID_CHARS_NAME) + + # call the OpaqueKey constructor ensuring the args in the same order as KEY_FIELDS above + super(LocationBase, self).__init__(org, course, run, category, name, revision) + + @property + def tag(self): + return self.DEPRECATED_TAG + + @property + def definition_key(self): + # Locations are both UsageKeys and DefinitionKeys + return self + + @property + def block_type(self): + return self.category + + @classmethod + def from_deprecated_string(cls, serialized): + match = URL_RE.match(serialized) + if match is None: + raise InvalidKeyError(Location, serialized) + groups = match.groupdict() + return cls(run=None, **groups) + + def to_deprecated_string(self): + url = u"{0.DEPRECATED_TAG}://{0.org}/{0.course}/{0.category}/{0.name}".format(self) + if self.revision: + url += u"@{rev}".format(rev=self.revision) # pylint: disable=E1101 + return url + + def _to_string(self): + output = u"+".join( + unicode(val) + for val in (self.org, self.course, self.run, self.category, self.name) + ) + if self.revision: + output += u'@{}'.format(self.revision) + return output + + @classmethod + def _from_string(cls, serialized): + match = cls.SERIALIZED_PATTERN.match(serialized) + if not match: + raise InvalidKeyError(cls, serialized) + + return cls(**match.groupdict()) + + def html_id(self): + """ + Return a string with a version of the location that is safe for use in + html id attributes + """ + id_fields = [self.DEPRECATED_TAG, self.org, self.course, self.category, self.name, self.revision] + id_string = u"-".join([v for v in id_fields if v is not None]) + return Location.clean_for_html(id_string) + + @property + def course_key(self): + return SlashSeparatedCourseKey(self.org, self.course, self.run) + + +class Location(LocationBase, UsageKey, DefinitionKey): + """ + UsageKey and DefinitionKey implementation class for use with + XML and Mongo modulestores. + """ + + CANONICAL_NAMESPACE = 'location' + DEPRECATED_TAG = 'i4x' + __slots__ = LocationBase.KEY_FIELDS + + def map_into_course(self, course_key): + """ + Return a new :class:`UsageKey` representing this usage inside the + course identified by the supplied :class:`CourseKey`. + + Args: + course_key (CourseKey): The course to map this object into. + + Returns: + A new :class:`CourseObjectMixin` instance. + """ + return Location(course_key.org, course_key.course, course_key.run, self.category, self.name, self.revision) + + +class AssetLocation(LocationBase, AssetKey): + """ + An AssetKey implementation class. + """ + CANONICAL_NAMESPACE = 'asset-location' + DEPRECATED_TAG = 'c4x' + __slots__ = LocationBase.KEY_FIELDS + + def __init__(self, org, course, run, category, name, revision=None): + super(AssetLocation, self).__init__(org, course, run, category, name, revision) + + @property + def path(self): + return self.name + + def to_deprecated_string(self): + url = u"/{0.DEPRECATED_TAG}/{0.org}/{0.course}/{0.category}/{0.name}".format(self) + return url + + ASSET_URL_RE = re.compile(r""" + /?c4x/ + (?P[^/]+)/ + (?P[^/]+)/ + (?P[^/]+)/ + (?P[^/]+) + """, re.VERBOSE | re.IGNORECASE) + + @classmethod + def from_deprecated_string(cls, serialized): + match = cls.ASSET_URL_RE.match(serialized) + if match is None: + raise InvalidKeyError(Location, serialized) + groups = match.groupdict() + return cls(run=None, **groups) + + def map_into_course(self, course_key): + """ + Return a new :class:`UsageKey` representing this usage inside the + course identified by the supplied :class:`CourseKey`. + + Args: + course_key (CourseKey): The course to map this object into. + + Returns: + A new :class:`CourseObjectMixin` instance. + """ + return AssetLocation(course_key.org, course_key.course, course_key.run, self.category, self.name, self.revision) + + +class i4xEncoder(json.JSONEncoder): + """ + If provided as the cls to json.dumps, will serialize and Locations as i4x strings and other + keys using the unicode strings. + """ + def default(self, key): + if isinstance(key, OpaqueKey): + if isinstance(key, (LocationBase, SlashSeparatedCourseKey)): + return key.to_deprecated_string() + else: + return unicode(key) + super(i4xEncoder, self).default(key) From 2248968c57ec9a2d1a075a59db66089c6d1a01bf Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:59 -0400 Subject: [PATCH 004/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit adds updated requirements. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- requirements/edx/github.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/edx/github.txt b/requirements/edx/github.txt index 4128728ca0..85051a9407 100644 --- a/requirements/edx/github.txt +++ b/requirements/edx/github.txt @@ -17,7 +17,7 @@ -e git+https://github.com/appliedsec/pygeoip.git@95e69341cebf5a6a9fbf7c4f5439d458898bdc3b#egg=pygeoip # Our libraries: --e git+https://github.com/edx/XBlock.git@cfe5c37f98febd9a215d23cb206a25711056a142#egg=XBlock +-e git+https://github.com/edx/XBlock.git@fc5fea25c973ec66d8db63cf69a817ce624f5ef5#egg=XBlock -e git+https://github.com/edx/codejail.git@71f5c5616e2a73ae8cecd1ff2362774a773d3665#egg=codejail -e git+https://github.com/edx/diff-cover.git@v0.2.9#egg=diff_cover -e git+https://github.com/edx/js-test-tool.git@v0.1.5#egg=js_test_tool From 9811926d972242d66647e1dcf4b0741720c04bac Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:50 -0400 Subject: [PATCH 005/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit updates lms/djangoapps/courseware. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- common/djangoapps/terrain/course_helpers.py | 8 +- common/djangoapps/terrain/steps.py | 5 +- lms/djangoapps/courseware/access.py | 123 +++++------ lms/djangoapps/courseware/courses.py | 89 ++++---- .../courseware/features/annotatable.py | 2 +- lms/djangoapps/courseware/features/common.py | 16 +- .../courseware/features/conditional.py | 6 +- lms/djangoapps/courseware/features/lti.py | 18 +- .../courseware/features/navigation.py | 3 +- .../courseware/features/openended.py | 4 +- .../courseware/features/registration.py | 2 +- lms/djangoapps/courseware/features/video.py | 4 +- lms/djangoapps/courseware/grades.py | 94 ++++----- .../management/commands/clean_xml.py | 2 +- .../management/commands/dump_course_ids.py | 8 +- .../commands/dump_course_structure.py | 18 +- .../management/commands/export_course.py | 11 +- .../management/commands/metadata_to_json.py | 2 +- .../commands/tests/test_dump_course.py | 25 +-- lms/djangoapps/courseware/model_data.py | 30 ++- lms/djangoapps/courseware/models.py | 37 +++- lms/djangoapps/courseware/module_render.py | 96 +++++---- lms/djangoapps/courseware/tests/__init__.py | 4 +- lms/djangoapps/courseware/tests/factories.py | 31 +-- lms/djangoapps/courseware/tests/helpers.py | 8 +- lms/djangoapps/courseware/tests/test_about.py | 13 +- .../courseware/tests/test_access.py | 127 +++++++----- .../courseware/tests/test_course_info.py | 4 +- .../courseware/tests/test_courses.py | 45 ++-- .../tests/test_draft_modulestore.py | 5 +- .../courseware/tests/test_grades.py | 3 +- .../courseware/tests/test_lti_integration.py | 7 +- .../courseware/tests/test_masquerade.py | 29 +-- .../courseware/tests/test_model_data.py | 16 +- .../courseware/tests/test_module_render.py | 108 +++++----- .../courseware/tests/test_navigation.py | 40 ++-- .../courseware/tests/test_split_module.py | 15 +- .../tests/test_submitting_problems.py | 35 ++-- lms/djangoapps/courseware/tests/test_tabs.py | 16 +- .../courseware/tests/test_video_handlers.py | 18 +- .../courseware/tests/test_video_mongo.py | 6 +- .../tests/test_view_authentication.py | 66 +++--- lms/djangoapps/courseware/tests/test_views.py | 81 ++++---- lms/djangoapps/courseware/tests/tests.py | 35 ++-- lms/djangoapps/courseware/views.py | 195 +++++++++--------- 45 files changed, 812 insertions(+), 698 deletions(-) diff --git a/common/djangoapps/terrain/course_helpers.py b/common/djangoapps/terrain/course_helpers.py index 274530a965..5881debb5b 100644 --- a/common/djangoapps/terrain/course_helpers.py +++ b/common/djangoapps/terrain/course_helpers.py @@ -43,7 +43,7 @@ def log_in(username='robot', password='test', email='robot@edx.org', name="Robot @world.absorb -def register_by_course_id(course_id, username='robot', password='test', is_staff=False): +def register_by_course_key(course_key, username='robot', password='test', is_staff=False): create_user(username, password) user = User.objects.get(username=username) # Note: this flag makes the user global staff - that is, an edX employee - not a course staff. @@ -51,17 +51,17 @@ def register_by_course_id(course_id, username='robot', password='test', is_staff if is_staff: user.is_staff = True user.save() - CourseEnrollment.enroll(user, course_id) + CourseEnrollment.enroll(user, course_key) @world.absorb -def enroll_user(user, course_id): +def enroll_user(user, course_key): # Activate user registration = world.RegistrationFactory(user=user) registration.register(user) registration.activate() # Enroll them in the course - CourseEnrollment.enroll(user, course_id) + CourseEnrollment.enroll(user, course_key) @world.absorb diff --git a/common/djangoapps/terrain/steps.py b/common/djangoapps/terrain/steps.py index 64f1a5e3ba..d96e093e67 100644 --- a/common/djangoapps/terrain/steps.py +++ b/common/djangoapps/terrain/steps.py @@ -21,6 +21,8 @@ from .course_helpers import * from .ui_helpers import * from nose.tools import assert_equals # pylint: disable=E0611 +from xmodule.modulestore.locations import SlashSeparatedCourseKey + from logging import getLogger logger = getLogger(__name__) @@ -110,7 +112,8 @@ def i_am_not_logged_in(step): @step('I am staff for course "([^"]*)"$') def i_am_staff_for_course_by_id(step, course_id): - world.register_by_course_id(course_id, True) + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) + world.register_by_course_key(course_key, True) @step(r'click (?:the|a) link (?:called|with the text) "([^"]*)"$') diff --git a/lms/djangoapps/courseware/access.py b/lms/djangoapps/courseware/access.py index c30c5566dc..f6543323ed 100644 --- a/lms/djangoapps/courseware/access.py +++ b/lms/djangoapps/courseware/access.py @@ -34,7 +34,7 @@ def debug(*args, **kwargs): log.debug(*args, **kwargs) -def has_access(user, obj, action, course_context=None): +def has_access(user, action, obj, course_key=None): """ Check whether a user has the access to do action on obj. Handles any magic switching based on various settings. @@ -55,7 +55,7 @@ def has_access(user, obj, action, course_context=None): actions depend on the obj type, but include e.g. 'enroll' for courses. See the type-specific functions below for the known actions for that type. - course_context: A course_id specifying which course run this access is for. + course_key: A course_key specifying which course run this access is for. Required when accessing anything other than a CourseDescriptor, 'global', or a location with category 'course' @@ -69,23 +69,23 @@ def has_access(user, obj, action, course_context=None): # delegate the work to type-specific functions. # (start with more specific types, then get more general) if isinstance(obj, CourseDescriptor): - return _has_access_course_desc(user, obj, action) + return _has_access_course_desc(user, action, obj) if isinstance(obj, ErrorDescriptor): - return _has_access_error_desc(user, obj, action, course_context) + return _has_access_error_desc(user, action, obj, course_key) if isinstance(obj, XModule): - return _has_access_xmodule(user, obj, action, course_context) + return _has_access_xmodule(user, action, obj, course_key) # NOTE: any descriptor access checkers need to go above this if isinstance(obj, XBlock): - return _has_access_descriptor(user, obj, action, course_context) + return _has_access_descriptor(user, action, obj, course_key) if isinstance(obj, Location): - return _has_access_location(user, obj, action, course_context) + return _has_access_location(user, action, obj, course_key) if isinstance(obj, basestring): - return _has_access_string(user, obj, action, course_context) + return _has_access_string(user, action, obj, course_key) # Passing an unknown object here is a coding error, so rather than # returning a default, complain. @@ -94,7 +94,7 @@ def has_access(user, obj, action, course_context=None): # ================ Implementation helpers ================================ -def _has_access_course_desc(user, course, action): +def _has_access_course_desc(user, action, course): """ Check if user has access to a course descriptor. @@ -114,16 +114,19 @@ def _has_access_course_desc(user, course, action): NOTE: this is not checking whether user is actually enrolled in the course. """ # delegate to generic descriptor check to check start dates - return _has_access_descriptor(user, course, 'load') + return _has_access_descriptor(user, 'load', course, course.id) def can_load_forum(): """ Can this user access the forums in this course? """ - return (can_load() and \ - (CourseEnrollment.is_enrolled(user, course.id) or \ - _has_staff_access_to_descriptor(user, course) - )) + return ( + can_load() and + ( + CourseEnrollment.is_enrolled(user, course.id) or + _has_staff_access_to_descriptor(user, course, course.id) + ) + ) def can_enroll(): """ @@ -158,13 +161,16 @@ def _has_access_course_desc(user, course, action): debug("Allow: in enrollment period") return True - # if user is in CourseEnrollmentAllowed with right course_id then can also enroll + # if user is in CourseEnrollmentAllowed with right course key then can also enroll + # (note that course.id actually points to a CourseKey) + # (the filter call uses course_id= since that's the legacy database schema) + # (sorry that it's confusing :( ) if user is not None and user.is_authenticated() and CourseEnrollmentAllowed: if CourseEnrollmentAllowed.objects.filter(email=user.email, course_id=course.id): return True # otherwise, need staff access - return _has_staff_access_to_descriptor(user, course) + return _has_staff_access_to_descriptor(user, course, course.id) def see_exists(): """ @@ -184,7 +190,7 @@ def _has_access_course_desc(user, course, action): if course.ispublic: debug("Allow: ACCESS_REQUIRE_STAFF_FOR_COURSE and ispublic") return True - return _has_staff_access_to_descriptor(user, course) + return _has_staff_access_to_descriptor(user, course, course.id) return can_enroll() or can_load() @@ -193,14 +199,14 @@ def _has_access_course_desc(user, course, action): 'load_forum': can_load_forum, 'enroll': can_enroll, 'see_exists': see_exists, - 'staff': lambda: _has_staff_access_to_descriptor(user, course), - 'instructor': lambda: _has_instructor_access_to_descriptor(user, course), - } + 'staff': lambda: _has_staff_access_to_descriptor(user, course, course.id), + 'instructor': lambda: _has_instructor_access_to_descriptor(user, course, course.id), + } return _dispatch(checkers, action, user, course) -def _has_access_error_desc(user, descriptor, action, course_context): +def _has_access_error_desc(user, action, descriptor, course_key): """ Only staff should see error descriptors. @@ -209,17 +215,17 @@ def _has_access_error_desc(user, descriptor, action, course_context): 'staff' -- staff access to descriptor. """ def check_for_staff(): - return _has_staff_access_to_descriptor(user, descriptor, course_context) + return _has_staff_access_to_descriptor(user, descriptor, course_key) checkers = { 'load': check_for_staff, 'staff': check_for_staff - } + } return _dispatch(checkers, action, user, descriptor) -def _has_access_descriptor(user, descriptor, action, course_context=None): +def _has_access_descriptor(user, action, descriptor, course_key=None): """ Check if user has access to this descriptor. @@ -249,14 +255,14 @@ def _has_access_descriptor(user, descriptor, action, course_context=None): effective_start = _adjust_start_date_for_beta_testers( user, descriptor, - course_context=course_context + course_key=course_key ) if now > effective_start: # after start date, everyone can see it debug("Allow: now > effective start date") return True # otherwise, need staff access - return _has_staff_access_to_descriptor(user, descriptor, course_context) + return _has_staff_access_to_descriptor(user, descriptor, course_key) # No start date, so can always load. debug("Allow: no start date") @@ -264,13 +270,13 @@ def _has_access_descriptor(user, descriptor, action, course_context=None): checkers = { 'load': can_load, - 'staff': lambda: _has_staff_access_to_descriptor(user, descriptor, course_context) + 'staff': lambda: _has_staff_access_to_descriptor(user, descriptor, course_key) } return _dispatch(checkers, action, user, descriptor) -def _has_access_xmodule(user, xmodule, action, course_context): +def _has_access_xmodule(user, action, xmodule, course_key): """ Check if user has access to this xmodule. @@ -278,10 +284,10 @@ def _has_access_xmodule(user, xmodule, action, course_context): - same as the valid actions for xmodule.descriptor """ # Delegate to the descriptor - return has_access(user, xmodule.descriptor, action, course_context) + return has_access(user, action, xmodule.descriptor, course_key) -def _has_access_location(user, location, action, course_context): +def _has_access_location(user, action, location, course_key): """ Check if user has access to this location. @@ -295,13 +301,13 @@ def _has_access_location(user, location, action, course_context): And in general, prefer checking access on loaded items, rather than locations. """ checkers = { - 'staff': lambda: _has_staff_access_to_location(user, location, course_context) - } + 'staff': lambda: _has_staff_access_to_location(user, location, course_key) + } return _dispatch(checkers, action, user, location) -def _has_access_string(user, perm, action, course_context): +def _has_access_string(user, action, perm, course_key): """ Check if user has certain special access, specified as string. Valid strings: @@ -338,7 +344,7 @@ def _dispatch(table, action, user, obj): debug("%s user %s, object %s, action %s", 'ALLOWED' if result else 'DENIED', user, - obj.location.url() if isinstance(obj, XBlock) else str(obj)[:60], + obj.location.to_deprecated_string() if isinstance(obj, XBlock) else str(obj), action) return result @@ -346,7 +352,7 @@ def _dispatch(table, action, user, obj): type(obj), action)) -def _adjust_start_date_for_beta_testers(user, descriptor, course_context=None): +def _adjust_start_date_for_beta_testers(user, descriptor, course_key=None): # pylint: disable=invalid-name """ If user is in a beta test group, adjust the start date by the appropriate number of days. @@ -373,7 +379,7 @@ def _adjust_start_date_for_beta_testers(user, descriptor, course_context=None): # bail early if no beta testing is set up return descriptor.start - if CourseBetaTesterRole(descriptor.location, course_context=course_context).has_user(user): + if CourseBetaTesterRole(course_key).has_user(user): debug("Adjust start time: user in beta role for %s", descriptor) delta = timedelta(descriptor.days_early_for_beta) effective = descriptor.start - delta @@ -382,15 +388,15 @@ def _adjust_start_date_for_beta_testers(user, descriptor, course_context=None): return descriptor.start -def _has_instructor_access_to_location(user, location, course_context=None): - return _has_access_to_location(user, location, 'instructor', course_context) +def _has_instructor_access_to_location(user, location, course_key=None): # pylint: disable=invalid-name + return _has_access_to_location(user, 'instructor', location, course_key) -def _has_staff_access_to_location(user, location, course_context=None): - return _has_access_to_location(user, location, 'staff', course_context) +def _has_staff_access_to_location(user, location, course_key=None): + return _has_access_to_location(user, 'staff', location, course_key) -def _has_access_to_location(user, location, access_level, course_context): +def _has_access_to_location(user, access_level, location, course_key): ''' Returns True if the given user has access_level (= staff or instructor) access to a location. For now this is equivalent to @@ -398,7 +404,7 @@ def _has_access_to_location(user, location, access_level, course_context): This means that user is in the staff_* group or instructor_* group, or is an overall admin. - TODO (vshnayder): this needs to be changed to allow per-course_id permissions, not per-course + TODO (vshnayder): this needs to be changed to allow per-course_key permissions, not per-course (e.g. staff in 2012 is different from 2013, but maybe some people always have access) course is a string: the course field of the location being accessed. @@ -422,8 +428,8 @@ def _has_access_to_location(user, location, access_level, course_context): return False staff_access = ( - CourseStaffRole(location, course_context).has_user(user) or - OrgStaffRole(location).has_user(user) + CourseStaffRole(course_key).has_user(user) or + OrgStaffRole(course_key.org).has_user(user) ) if staff_access and access_level == 'staff': @@ -431,8 +437,8 @@ def _has_access_to_location(user, location, access_level, course_context): return True instructor_access = ( - CourseInstructorRole(location, course_context).has_user(user) or - OrgInstructorRole(location).has_user(user) + CourseInstructorRole(course_key).has_user(user) or + OrgInstructorRole(course_key.org).has_user(user) ) if instructor_access and access_level in ('staff', 'instructor'): @@ -443,42 +449,43 @@ def _has_access_to_location(user, location, access_level, course_context): return False -def _has_staff_access_to_course_id(user, course_id): - """Helper method that takes a course_id instead of a course name""" - loc = CourseDescriptor.id_to_location(course_id) - return _has_staff_access_to_location(user, loc, course_id) +# TODO Please change this function signature to _has_staff_access_to_course_key at next opportunity! +def _has_staff_access_to_course_id(user, course_key): + """Helper method that takes a course_key instead of a course name""" + loc = CourseDescriptor.id_to_location(course_key) + return _has_staff_access_to_location(user, loc, course_key) -def _has_instructor_access_to_descriptor(user, descriptor, course_context=None): +def _has_instructor_access_to_descriptor(user, descriptor, course_key): # pylint: disable=invalid-name """Helper method that checks whether the user has staff access to the course of the location. descriptor: something that has a location attribute """ - return _has_instructor_access_to_location(user, descriptor.location, course_context) + return _has_instructor_access_to_location(user, descriptor.location, course_key) -def _has_staff_access_to_descriptor(user, descriptor, course_context=None): +def _has_staff_access_to_descriptor(user, descriptor, course_key): """Helper method that checks whether the user has staff access to the course of the location. descriptor: something that has a location attribute """ - return _has_staff_access_to_location(user, descriptor.location, course_context) + return _has_staff_access_to_location(user, descriptor.location, course_key) -def get_user_role(user, course_id): +def get_user_role(user, course_key): """ Return corresponding string if user has staff, instructor or student course role in LMS. """ from courseware.courses import get_course - course = get_course(course_id) + course = get_course(course_key) if is_masquerading_as_student(user): return 'student' - elif has_access(user, course, 'instructor'): + elif has_access(user, 'instructor', course): return 'instructor' - elif has_access(user, course, 'staff'): + elif has_access(user, 'staff', course): return 'staff' else: return 'student' diff --git a/lms/djangoapps/courseware/courses.py b/lms/djangoapps/courseware/courses.py index d5cfc47977..bbce3ac6e1 100644 --- a/lms/djangoapps/courseware/courses.py +++ b/lms/djangoapps/courseware/courses.py @@ -8,12 +8,13 @@ from django.http import Http404 from django.conf import settings from edxmako.shortcuts import render_to_string -from xmodule.course_module import CourseDescriptor -from xmodule.modulestore import Location, XML_MODULESTORE_TYPE, MONGO_MODULESTORE_TYPE -from xmodule.modulestore.django import modulestore, loc_mapper +from xmodule.modulestore import XML_MODULESTORE_TYPE +from xmodule.modulestore.keys import CourseKey +from xmodule.modulestore.django import modulestore from xmodule.contentstore.content import StaticContent from xmodule.modulestore.exceptions import ItemNotFoundError, InvalidLocationError from static_replace import replace_static_urls +from xmodule.modulestore import MONGO_MODULESTORE_TYPE from courseware.access import has_access from courseware.model_data import FieldDataCache @@ -49,15 +50,15 @@ def get_course(course_id, depth=0): None means infinite depth. Default is to fetch no children. """ try: - course_loc = CourseDescriptor.id_to_location(course_id) - return modulestore().get_instance(course_id, course_loc, depth=depth) + return modulestore().get_course(course_id, depth=depth) except (KeyError, ItemNotFoundError): raise ValueError(u"Course not found: {0}".format(course_id)) except InvalidLocationError: raise ValueError(u"Invalid location: {0}".format(course_id)) -def get_course_by_id(course_id, depth=0): +# TODO please rename this function to get_course_by_key at next opportunity! +def get_course_by_id(course_key, depth=0): """ Given a course id, return the corresponding course descriptor. @@ -66,50 +67,55 @@ def get_course_by_id(course_id, depth=0): depth: The number of levels of children for the modulestore to cache. None means infinite depth """ try: - course_loc = CourseDescriptor.id_to_location(course_id) - return modulestore().get_instance(course_id, course_loc, depth=depth) + course = modulestore().get_course(course_key, depth=depth) + if course: + return course + else: + raise Http404("Course not found.") except (KeyError, ItemNotFoundError): raise Http404("Course not found.") except InvalidLocationError: raise Http404("Invalid location") -def get_course_with_access(user, course_id, action, depth=0): +def get_course_with_access(user, action, course_key, depth=0): """ - Given a course_id, look up the corresponding course descriptor, + Given a course_key, look up the corresponding course descriptor, check that the user has the access to perform the specified action on the course, and return the descriptor. - Raises a 404 if the course_id is invalid, or the user doesn't have access. + Raises a 404 if the course_key is invalid, or the user doesn't have access. depth: The number of levels of children for the modulestore to cache. None means infinite depth """ - course = get_course_by_id(course_id, depth=depth) - if not has_access(user, course, action): + assert isinstance(course_key, CourseKey) + course = get_course_by_id(course_key, depth=depth) + + if not has_access(user, action, course, course_key): # Deliberately return a non-specific error message to avoid # leaking info about access control settings raise Http404("Course not found.") + return course -def get_opt_course_with_access(user, course_id, action): +def get_opt_course_with_access(user, action, course_key): """ - Same as get_course_with_access, except that if course_id is None, + Same as get_course_with_access, except that if course_key is None, return None without performing any access checks. """ - if course_id is None: + if course_key is None: return None - return get_course_with_access(user, course_id, action) + return get_course_with_access(user, action, course_key) def course_image_url(course): - """Try to look up the image url for the course. If it's not found, - log an error and return the dead link""" - if course.static_asset_path or modulestore().get_modulestore_type(course.location.course_id) == XML_MODULESTORE_TYPE: + """ Determine whether this is an XML or Studio-backed course, and return the appropriate course_image URL """ + if course.static_asset_path or modulestore().get_modulestore_type(course.id) == XML_MODULESTORE_TYPE: return '/static/' + (course.static_asset_path or getattr(course, 'data_dir', '')) + "/images/course_image.jpg" else: - loc = StaticContent.compute_location(course.location.org, course.location.course, course.course_image) - _path = StaticContent.get_url_path_from_location(loc) + loc = StaticContent.compute_location(course.location.course_key, course.course_image) + _path = loc.to_deprecated_string() return _path @@ -158,7 +164,7 @@ def get_course_about_section(course, section_key): # markup. This can change without effecting this interface when we find a # good format for defining so many snippets of text/html. -# TODO: Remove number, instructors from this list + # TODO: Remove number, instructors from this list if section_key in ['short_description', 'description', 'key_dates', 'video', 'course_staff_short', 'course_staff_extended', 'requirements', 'syllabus', 'textbook', 'faq', 'more_info', @@ -199,7 +205,7 @@ def get_course_about_section(course, section_key): except ItemNotFoundError: log.warning( - u"Missing about section {key} in course {url}".format(key=section_key, url=course.location.url()) + u"Missing about section {key} in course {url}".format(key=section_key, url=course.location.to_deprecated_string()) ) return None elif section_key == "title": @@ -223,14 +229,14 @@ def get_course_info_section(request, course, section_key): - updates - guest_updates """ - loc = Location(course.location.tag, course.location.org, course.location.course, 'course_info', section_key) + usage_key = course.id.make_usage_key('course_info', section_key) # Use an empty cache field_data_cache = FieldDataCache([], course.id, request.user) info_module = get_module( request.user, request, - loc, + usage_key, field_data_cache, course.id, wrap_xmodule_display=False, @@ -279,12 +285,12 @@ def get_course_syllabus_section(course, section_key): return replace_static_urls( html_file.read().decode('utf-8'), getattr(course, 'data_dir', None), - course_id=course.location.course_id, + course_id=course.id, static_asset_path=course.static_asset_path, ) except ResourceNotFoundError: log.exception( - u"Missing syllabus section {key} in course {url}".format(key=section_key, url=course.location.url()) + u"Missing syllabus section {key} in course {url}".format(key=section_key, url=course.location.to_deprecated_string()) ) return "! Syllabus missing !" @@ -312,7 +318,7 @@ def get_courses(user, domain=None): Returns a list of courses available, sorted by course.number ''' courses = branding.get_visible_courses() - courses = [c for c in courses if has_access(user, c, 'see_exists')] + courses = [c for c in courses if has_access(user, 'see_exists', c)] courses = sorted(courses, key=lambda course: course.number) @@ -332,15 +338,14 @@ def sort_by_announcement(courses): return courses -def get_cms_course_link(course): +def get_cms_course_link(course, page='course'): """ Returns a link to course_index for editing the course in cms, assuming that the course is actually cms-backed. """ - locator = loc_mapper().translate_location( - course.location.course_id, course.location, False, True - ) - return "//" + settings.CMS_BASE + locator.url_reverse('course/', '') + # This is fragile, but unfortunately the problem is that within the LMS we + # can't use the reverse calls from the CMS + return u"//{}/{}/{}".format(settings.CMS_BASE, page, unicode(course.id)) def get_cms_block_link(block, page): @@ -348,20 +353,20 @@ def get_cms_block_link(block, page): Returns a link to block_index for editing the course in cms, assuming that the block is actually cms-backed. """ - locator = loc_mapper().translate_location( - block.location.course_id, block.location, False, True - ) - return "//" + settings.CMS_BASE + locator.url_reverse(page, '') + # This is fragile, but unfortunately the problem is that within the LMS we + # can't use the reverse calls from the CMS + return u"//{}/{}/{}".format(settings.CMS_BASE, page, block.location) -def get_studio_url(course_id, page): +def get_studio_url(course_key, page): """ Get the Studio URL of the page that is passed in. """ - course = get_course_by_id(course_id) + assert(isinstance(course_key, CourseKey)) + course = get_course_by_id(course_key) is_studio_course = course.course_edit_method == "Studio" - is_mongo_course = modulestore().get_modulestore_type(course_id) == MONGO_MODULESTORE_TYPE + is_mongo_course = modulestore().get_modulestore_type(course_key) == MONGO_MODULESTORE_TYPE studio_link = None if is_studio_course and is_mongo_course: - studio_link = get_cms_block_link(course, page) + studio_link = get_cms_course_link(course, page) return studio_link diff --git a/lms/djangoapps/courseware/features/annotatable.py b/lms/djangoapps/courseware/features/annotatable.py index b5552c1b5a..db82a750df 100644 --- a/lms/djangoapps/courseware/features/annotatable.py +++ b/lms/djangoapps/courseware/features/annotatable.py @@ -140,7 +140,7 @@ class AnnotatableSteps(object): def active_problem_selector(self, subselector): return 'div[data-problem-id="{}"] {}'.format( - world.scenario_dict['PROBLEMS'][self.active_problem].location.url(), + world.scenario_dict['PROBLEMS'][self.active_problem].location.to_deprecated_string(), subselector, ) diff --git a/lms/djangoapps/courseware/features/common.py b/lms/djangoapps/courseware/features/common.py index 1cdec7629b..2ede62a84c 100644 --- a/lms/djangoapps/courseware/features/common.py +++ b/lms/djangoapps/courseware/features/common.py @@ -12,6 +12,7 @@ from django.core.urlresolvers import reverse from student.models import CourseEnrollment from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.course_module import CourseDescriptor from courseware.courses import get_course_by_id from xmodule import seq_module, vertical_module @@ -119,16 +120,19 @@ def go_into_course(step): def course_id(course_num): - return "%s/%s/%s" % (world.scenario_dict['COURSE'].org, course_num, - world.scenario_dict['COURSE'].url_name) + return SlashSeparatedCourseKey( + world.scenario_dict['COURSE'].org, + course_num, + world.scenario_dict['COURSE'].url_name + ) def course_location(course_num): - return world.scenario_dict['COURSE'].location._replace(course=course_num) + return world.scenario_dict['COURSE'].location.replace(course=course_num) def section_location(course_num): - return world.scenario_dict['SECTION'].location._replace(course=course_num) + return world.scenario_dict['SECTION'].location.replace(course=course_num) def visit_scenario_item(item_key): @@ -140,8 +144,8 @@ def visit_scenario_item(item_key): url = django_url(reverse( 'jump_to', kwargs={ - 'course_id': world.scenario_dict['COURSE'].id, - 'location': str(world.scenario_dict[item_key].location), + 'course_id': world.scenario_dict['COURSE'].id.to_deprecated_string(), + 'location': world.scenario_dict[item_key].location.to_deprecated_string(), } )) diff --git a/lms/djangoapps/courseware/features/conditional.py b/lms/djangoapps/courseware/features/conditional.py index 665cfbcd07..db6b0436cd 100644 --- a/lms/djangoapps/courseware/features/conditional.py +++ b/lms/djangoapps/courseware/features/conditional.py @@ -46,16 +46,16 @@ class ConditionalSteps(object): metadata = { 'xml_attributes': { - 'sources': world.scenario_dict['CONDITION_SOURCE'].location.url() + condition: cond_value } } - metadata['xml_attributes'][condition] = cond_value world.scenario_dict['CONDITIONAL'] = world.ItemFactory( parent_location=world.scenario_dict['WRAPPER'].location, category='conditional', display_name="Test Conditional", - metadata=metadata + metadata=metadata, + sources_list=[world.scenario_dict['CONDITION_SOURCE'].location], ) world.ItemFactory( diff --git a/lms/djangoapps/courseware/features/lti.py b/lms/djangoapps/courseware/features/lti.py index e32118f421..c5fcb974da 100644 --- a/lms/djangoapps/courseware/features/lti.py +++ b/lms/djangoapps/courseware/features/lti.py @@ -201,26 +201,24 @@ def i_am_registered_for_the_course(coursenum, metadata, user='Instructor'): metadata.update({'days_early_for_beta': 5, 'start': tomorrow}) create_course_for_lti(coursenum, metadata) course_descriptor = world.scenario_dict['COURSE'] - course_location = world.scenario_dict['COURSE'].location # create beta tester - user = BetaTesterFactory(course=course_location) + user = BetaTesterFactory(course=course_descriptor.id) normal_student = UserFactory() - instructor = InstructorFactory(course=course_location) + instructor = InstructorFactory(course=course_descriptor.id) - assert not has_access(normal_student, course_descriptor, 'load') - assert has_access(user, course_descriptor, 'load') - assert has_access(instructor, course_descriptor, 'load') + assert not has_access(normal_student, 'load', course_descriptor) + assert has_access(user, 'load', course_descriptor) + assert has_access(instructor, 'load', course_descriptor) else: metadata.update({'start': datetime.datetime(1970, 1, 1, tzinfo=UTC)}) create_course_for_lti(coursenum, metadata) course_descriptor = world.scenario_dict['COURSE'] - course_location = world.scenario_dict['COURSE'].location - user = InstructorFactory(course=course_location) + user = InstructorFactory(course=course_descriptor.id) # Enroll the user in the course and log them in - if has_access(user, course_descriptor, 'load'): - world.enroll_user(user, course_id(coursenum)) + if has_access(user, 'load', course_descriptor): + world.enroll_user(user, course_descriptor.id) world.log_in(username=user.username, password='test') diff --git a/lms/djangoapps/courseware/features/navigation.py b/lms/djangoapps/courseware/features/navigation.py index 24dc031b39..10997b44ac 100644 --- a/lms/djangoapps/courseware/features/navigation.py +++ b/lms/djangoapps/courseware/features/navigation.py @@ -5,6 +5,7 @@ from lettuce import world, step from common import course_id, course_location from problems_setup import PROBLEM_DICT from nose.tools import assert_in +from xmodule.modulestore.locations import SlashSeparatedCourseKey @step(u'I am viewing a course with multiple sections') @@ -148,7 +149,7 @@ def create_course(): def create_user_and_visit_course(): - world.register_by_course_id('edx/999/Test_Course') + world.register_by_course_key(SlashSeparatedCourseKey('edx', '999', 'Test_Course')) world.log_in() world.visit('/courses/edx/999/Test_Course/courseware/') diff --git a/lms/djangoapps/courseware/features/openended.py b/lms/djangoapps/courseware/features/openended.py index 08d892b5c2..15122b7855 100644 --- a/lms/djangoapps/courseware/features/openended.py +++ b/lms/djangoapps/courseware/features/openended.py @@ -10,7 +10,7 @@ logger = getLogger(__name__) @step('I navigate to an openended question$') def navigate_to_an_openended_question(step): - world.register_by_course_id('MITx/3.091x/2012_Fall') + world.register_by_course_key('MITx/3.091x/2012_Fall') world.log_in(email='robot@edx.org', password='test') problem = '/courses/MITx/3.091x/2012_Fall/courseware/Week_10/Polymer_Synthesis/' world.browser.visit(django_url(problem)) @@ -20,7 +20,7 @@ def navigate_to_an_openended_question(step): @step('I navigate to an openended question as staff$') def navigate_to_an_openended_question_as_staff(step): - world.register_by_course_id('MITx/3.091x/2012_Fall', True) + world.register_by_course_key('MITx/3.091x/2012_Fall', True) world.log_in(email='robot@edx.org', password='test') problem = '/courses/MITx/3.091x/2012_Fall/courseware/Week_10/Polymer_Synthesis/' world.browser.visit(django_url(problem)) diff --git a/lms/djangoapps/courseware/features/registration.py b/lms/djangoapps/courseware/features/registration.py index d773afdba4..72db89e3e1 100644 --- a/lms/djangoapps/courseware/features/registration.py +++ b/lms/djangoapps/courseware/features/registration.py @@ -7,7 +7,7 @@ from lettuce.django import django_url @step('I register for the course "([^"]*)"$') def i_register_for_the_course(_step, course): - url = django_url('courses/%s/about' % world.scenario_dict['COURSE'].id) + url = django_url('courses/%s/about' % world.scenario_dict['COURSE'].id.to_deprecated_string()) world.browser.visit(url) world.css_click('section.intro a.register') diff --git a/lms/djangoapps/courseware/features/video.py b/lms/djangoapps/courseware/features/video.py index f979d72fc6..217a4106b2 100644 --- a/lms/djangoapps/courseware/features/video.py +++ b/lms/djangoapps/courseware/features/video.py @@ -195,7 +195,7 @@ def add_vertical_to_course(course_num): def last_vertical_location(course_num): - return world.scenario_dict['LAST_VERTICAL'].location._replace(course=course_num) + return world.scenario_dict['LAST_VERTICAL'].location.replace(course=course_num) def upload_file(filename, location): @@ -204,7 +204,7 @@ def upload_file(filename, location): mime_type = "application/json" content_location = StaticContent.compute_location( - location.org, location.course, filename + location.course_key, filename ) content = StaticContent(content_location, filename, mime_type, f.read()) contentstore().save(content) diff --git a/lms/djangoapps/courseware/grades.py b/lms/djangoapps/courseware/grades.py index 2617b789db..432451371a 100644 --- a/lms/djangoapps/courseware/grades.py +++ b/lms/djangoapps/courseware/grades.py @@ -23,6 +23,7 @@ from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.util.duedate import get_extended_due_date from .models import StudentModule from .module_render import get_module_for_descriptor +from opaque_keys import InvalidKeyError log = logging.getLogger("edx.courseware") @@ -50,9 +51,9 @@ def yield_dynamic_descriptor_descendents(descriptor, module_creator): yield next_descriptor -def answer_distributions(course_id): +def answer_distributions(course_key): """ - Given a course_id, return answer distributions in the form of a dictionary + Given a course_key, return answer distributions in the form of a dictionary mapping: (problem url_name, problem display_name, problem_id) -> {dict: answer -> count} @@ -82,67 +83,60 @@ def answer_distributions(course_id): # dict: { module.module_state_key : (url_name, display_name) } state_keys_to_problem_info = {} # For caching, used by url_and_display_name - def url_and_display_name(module_state_key): + def url_and_display_name(usage_key): """ - For a given module_state_key, return the problem's url and display_name. + For a given usage_key, return the problem's url and display_name. Handle modulestore access and caching. This method ignores permissions. - May throw an ItemNotFoundError if there is no content that corresponds - to this module_state_key. + + Raises: + InvalidKeyError: if the usage_key does not parse + ItemNotFoundError: if there is no content that corresponds + to this usage_key. """ problem_store = modulestore() - if module_state_key not in state_keys_to_problem_info: - problems = problem_store.get_items(module_state_key, course_id=course_id, depth=1) - if not problems: - # Likely means that the problem was deleted from the course - # after the student had answered. We log this suspicion where - # this exception is caught. - raise ItemNotFoundError( - "Answer Distribution: Module {} not found for course {}" - .format(module_state_key, course_id) - ) - problem = problems[0] + if usage_key not in state_keys_to_problem_info: + problem = problem_store.get_item(usage_key) problem_info = (problem.url_name, problem.display_name_with_default) - state_keys_to_problem_info[module_state_key] = problem_info + state_keys_to_problem_info[usage_key] = problem_info - return state_keys_to_problem_info[module_state_key] + return state_keys_to_problem_info[usage_key] # Iterate through all problems submitted for this course in no particular # order, and build up our answer_counts dict that we will eventually return answer_counts = defaultdict(lambda: defaultdict(int)) - for module in StudentModule.all_submitted_problems_read_only(course_id): + for module in StudentModule.all_submitted_problems_read_only(course_key): try: state_dict = json.loads(module.state) if module.state else {} raw_answers = state_dict.get("student_answers", {}) except ValueError: log.error( "Answer Distribution: Could not parse module state for " + - "StudentModule id={}, course={}".format(module.id, course_id) + "StudentModule id={}, course={}".format(module.id, course_key) ) continue - # Each problem part has an ID that is derived from the - # module.module_state_key (with some suffix appended) - for problem_part_id, raw_answer in raw_answers.items(): - # Convert whatever raw answers we have (numbers, unicode, None, etc.) - # to be unicode values. Note that if we get a string, it's always - # unicode and not str -- state comes from the json decoder, and that - # always returns unicode for strings. - answer = unicode(raw_answer) + try: + url, display_name = url_and_display_name(module.module_id.map_into_course(course_key)) + # Each problem part has an ID that is derived from the + # module.module_state_key (with some suffix appended) + for problem_part_id, raw_answer in raw_answers.items(): + # Convert whatever raw answers we have (numbers, unicode, None, etc.) + # to be unicode values. Note that if we get a string, it's always + # unicode and not str -- state comes from the json decoder, and that + # always returns unicode for strings. + answer = unicode(raw_answer) + answer_counts[(url, display_name, problem_part_id)][answer] += 1 - try: - url, display_name = url_and_display_name(module.module_state_key) - except ItemNotFoundError: - msg = "Answer Distribution: Item {} referenced in StudentModule {} " + \ - "for user {} in course {} not found; " + \ - "This can happen if a student answered a question that " + \ - "was later deleted from the course. This answer will be " + \ - "omitted from the answer distribution CSV." - log.warning( - msg.format(module.module_state_key, module.id, module.student_id, course_id) - ) - continue - - answer_counts[(url, display_name, problem_part_id)][answer] += 1 + except (ItemNotFoundError, InvalidKeyError): + msg = "Answer Distribution: Item {} referenced in StudentModule {} " + \ + "for user {} in course {} not found; " + \ + "This can happen if a student answered a question that " + \ + "was later deleted from the course. This answer will be " + \ + "omitted from the answer distribution CSV." + log.warning( + msg.format(module.module_state_key, module.id, module.student_id, course_key) + ) + continue return answer_counts @@ -183,7 +177,9 @@ def _grade(student, request, course, keep_raw_scores): # Dict of item_ids -> (earned, possible) point tuples. This *only* grabs # scores that were registered with the submissions API, which for the moment # means only openassessment (edx-ora2) - submissions_scores = sub_api.get_scores(course.id, anonymous_id_for_user(student, course.id)) + submissions_scores = sub_api.get_scores( + course.id.to_deprecated_string(), anonymous_id_for_user(student, course.id) + ) totaled_scores = {} # This next complicated loop is just to collect the totaled_scores, which is @@ -206,7 +202,7 @@ def _grade(student, request, course, keep_raw_scores): # API. If scores exist, we have to calculate grades for this section. if not should_grade_section: should_grade_section = any( - descriptor.location.url() in submissions_scores + descriptor.location.to_deprecated_string() in submissions_scores for descriptor in section['xmoduledescriptors'] ) @@ -214,7 +210,7 @@ def _grade(student, request, course, keep_raw_scores): with manual_transaction(): should_grade_section = StudentModule.objects.filter( student=student, - module_state_key__in=[ + module_id__in=[ descriptor.location for descriptor in section['xmoduledescriptors'] ] ).exists() @@ -350,7 +346,7 @@ def _progress_summary(student, request, course): # This student must not have access to the course. return None - submissions_scores = sub_api.get_scores(course.id, anonymous_id_for_user(student, course.id)) + submissions_scores = sub_api.get_scores(course.id.to_deprecated_string(), anonymous_id_for_user(student, course.id)) chapters = [] # Don't include chapters that aren't displayable (e.g. due to error) @@ -427,7 +423,7 @@ def get_score(course_id, user, problem_descriptor, module_creator, scores_cache= if not user.is_authenticated(): return (None, None) - location_url = problem_descriptor.location.url() + location_url = problem_descriptor.location.to_deprecated_string() if location_url in scores_cache: return scores_cache[location_url] @@ -451,7 +447,7 @@ def get_score(course_id, user, problem_descriptor, module_creator, scores_cache= student_module = StudentModule.objects.get( student=user, course_id=course_id, - module_state_key=problem_descriptor.location + module_id=problem_descriptor.location ) except StudentModule.DoesNotExist: student_module = None diff --git a/lms/djangoapps/courseware/management/commands/clean_xml.py b/lms/djangoapps/courseware/management/commands/clean_xml.py index dd61ff36a2..bd9bf5e68e 100644 --- a/lms/djangoapps/courseware/management/commands/clean_xml.py +++ b/lms/djangoapps/courseware/management/commands/clean_xml.py @@ -73,7 +73,7 @@ def import_with_checks(course_dir, verbose=True): return (False, None) course = courses[0] - errors = modulestore.get_item_errors(course.location) + errors = modulestore.get_course_errors(course.id) if len(errors) != 0: all_ok = False print '\n' diff --git a/lms/djangoapps/courseware/management/commands/dump_course_ids.py b/lms/djangoapps/courseware/management/commands/dump_course_ids.py index 8cba528bb1..874174641e 100644 --- a/lms/djangoapps/courseware/management/commands/dump_course_ids.py +++ b/lms/djangoapps/courseware/management/commands/dump_course_ids.py @@ -24,18 +24,12 @@ class Command(BaseCommand): ) def handle(self, *args, **options): - results = [] - try: name = options['modulestore'] store = modulestore(name) except KeyError: raise CommandError("Unknown modulestore {}".format(name)) - for course in store.get_courses(): - course_id = course.location.course_id - results.append(course_id) - - output = '\n'.join(results) + '\n' + output = u'\n'.join(course.id.to_deprecated_string() for course in store.get_courses()) + '\n' return output.encode('utf-8') diff --git a/lms/djangoapps/courseware/management/commands/dump_course_structure.py b/lms/djangoapps/courseware/management/commands/dump_course_structure.py index 6814b3cfe4..27e2658ad1 100644 --- a/lms/djangoapps/courseware/management/commands/dump_course_structure.py +++ b/lms/djangoapps/courseware/management/commands/dump_course_structure.py @@ -25,6 +25,8 @@ from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.django import modulestore from xmodule.modulestore.inheritance import own_metadata, compute_inherited_metadata from xblock.fields import Scope +from opaque_keys import InvalidKeyError +from xmodule.modulestore.locations import SlashSeparatedCourseKey FILTER_LIST = ['xml_attributes', 'checklists'] INHERITED_FILTER_LIST = ['children', 'xml_attributes', 'checklists'] @@ -66,7 +68,11 @@ class Command(BaseCommand): # Get the course data - course_id = args[0] + try: + course_id = SlashSeparatedCourseKey.from_deprecated_string(args[0]) + except InvalidKeyError: + raise CommandError("Invalid course_id") + course = store.get_course(course_id) if course is None: raise CommandError("Invalid course_id") @@ -90,12 +96,12 @@ def dump_module(module, destination=None, inherited=False, defaults=False): destination = destination if destination else {} - items = own_metadata(module).iteritems() - filtered_metadata = {k: v for k, v in items if k not in FILTER_LIST} + items = own_metadata(module) + filtered_metadata = {k: v for k, v in items.iteritems() if k not in FILTER_LIST} - destination[module.location.url()] = { + destination[module.location.to_deprecated_string()] = { 'category': module.location.category, - 'children': [str(child) for child in getattr(module, 'children', [])], + 'children': [child.to_deprecated_string() for child in getattr(module, 'children', [])], 'metadata': filtered_metadata, } @@ -116,7 +122,7 @@ def dump_module(module, destination=None, inherited=False, defaults=False): return field.values != field.default inherited_metadata = {field.name: field.read_json(module) for field in module.fields.values() if is_inherited(field)} - destination[module.location.url()]['inherited_metadata'] = inherited_metadata + destination[module.location.to_deprecated_string()]['inherited_metadata'] = inherited_metadata for child in module.get_children(): dump_module(child, destination, inherited, defaults) diff --git a/lms/djangoapps/courseware/management/commands/export_course.py b/lms/djangoapps/courseware/management/commands/export_course.py index cb7d6150f1..090143c9d9 100644 --- a/lms/djangoapps/courseware/management/commands/export_course.py +++ b/lms/djangoapps/courseware/management/commands/export_course.py @@ -17,6 +17,8 @@ from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.django import modulestore from xmodule.modulestore.xml_exporter import export_to_xml +from opaque_keys import InvalidKeyError +from xmodule.modulestore.locations import SlashSeparatedCourseKey class Command(BaseCommand): @@ -39,8 +41,10 @@ class Command(BaseCommand): def _parse_arguments(self, args): """Parse command line arguments""" try: - course_id = args[0] + course_id = SlashSeparatedCourseKey.from_deprecated_string(args[0]) filename = args[1] + except InvalidKeyError: + raise CommandError("Unparsable course_id") except IndexError: raise CommandError("Insufficient arguments") @@ -54,7 +58,6 @@ class Command(BaseCommand): def _get_results(self, filename): """Load results from file""" - results = None with open(filename) as f: results = f.read() os.remove(filename) @@ -78,8 +81,8 @@ def export_course_to_directory(course_id, root_dir): if course is None: raise CommandError("Invalid course_id") - course_name = course.location.course_id.replace('/', '-') - export_to_xml(store, None, course.location, root_dir, course_name) + course_name = course.id.to_deprecated_string().replace('/', '-') + export_to_xml(store, None, course.id, root_dir, course_name) course_dir = path(root_dir) / course_name return course_dir diff --git a/lms/djangoapps/courseware/management/commands/metadata_to_json.py b/lms/djangoapps/courseware/management/commands/metadata_to_json.py index a910db7028..a52b7ad5dc 100644 --- a/lms/djangoapps/courseware/management/commands/metadata_to_json.py +++ b/lms/djangoapps/courseware/management/commands/metadata_to_json.py @@ -38,7 +38,7 @@ def import_course(course_dir, verbose=True): return None course = courses[0] - errors = modulestore.get_item_errors(course.location) + errors = modulestore.get_course_errors(course.id) if len(errors) != 0: sys.stderr.write('ERRORs during import: {0}\n'.format('\n'.join(map(str_of_err, errors)))) diff --git a/lms/djangoapps/courseware/management/commands/tests/test_dump_course.py b/lms/djangoapps/courseware/management/commands/tests/test_dump_course.py index cc247cf6f6..4d33b88f26 100644 --- a/lms/djangoapps/courseware/management/commands/tests/test_dump_course.py +++ b/lms/djangoapps/courseware/management/commands/tests/test_dump_course.py @@ -22,6 +22,7 @@ from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.xml_importer import import_from_xml +from xmodule.modulestore.locations import SlashSeparatedCourseKey DATA_DIR = 'common/test/data/' @@ -53,7 +54,8 @@ class CommandsTestBase(TestCase): modulestore=store) courses = store.get_courses() - if TEST_COURSE_ID not in [c.id for c in courses]: + # NOTE: if xml store owns these, it won't import them into mongo + if SlashSeparatedCourseKey.from_deprecated_string(TEST_COURSE_ID) not in [c.id for c in courses]: import_from_xml(store, DATA_DIR, ['toy', 'simple']) return [course.id for course in store.get_courses()] @@ -70,7 +72,9 @@ class CommandsTestBase(TestCase): output = self.call_command('dump_course_ids', **kwargs) dumped_courses = output.decode('utf-8').strip().split('\n') - self.assertEqual(self.loaded_courses, dumped_courses) + course_ids = {course_id.to_deprecated_string() for course_id in self.loaded_courses} + dumped_ids = set(dumped_courses) + self.assertEqual(course_ids, dumped_ids) def test_dump_course_structure(self): args = [TEST_COURSE_ID] @@ -81,16 +85,15 @@ class CommandsTestBase(TestCase): # check that all elements in the course structure have metadata, # but not inherited metadata: - for element_name in dump: - element = dump[element_name] + for element in dump.itervalues(): self.assertIn('metadata', element) self.assertIn('children', element) self.assertIn('category', element) self.assertNotIn('inherited_metadata', element) # Check a few elements in the course dump - - parent_id = 'i4x://edX/simple/chapter/Overview' + test_course_key = SlashSeparatedCourseKey.from_deprecated_string(TEST_COURSE_ID) + parent_id = test_course_key.make_usage_key('chapter', 'Overview').to_deprecated_string() self.assertEqual(dump[parent_id]['category'], 'chapter') self.assertEqual(len(dump[parent_id]['children']), 3) @@ -98,7 +101,7 @@ class CommandsTestBase(TestCase): self.assertEqual(dump[child_id]['category'], 'videosequence') self.assertEqual(len(dump[child_id]['children']), 2) - video_id = 'i4x://edX/simple/video/Welcome' + video_id = test_course_key.make_usage_key('video', 'Welcome').to_deprecated_string() self.assertEqual(dump[video_id]['category'], 'video') self.assertEqual(len(dump[video_id]['metadata']), 4) self.assertIn('youtube_id_1_0', dump[video_id]['metadata']) @@ -114,8 +117,7 @@ class CommandsTestBase(TestCase): dump = json.loads(output) # check that all elements in the course structure have inherited metadata, # and that it contains a particular value as well: - for element_name in dump: - element = dump[element_name] + for element in dump.itervalues(): self.assertIn('metadata', element) self.assertIn('children', element) self.assertIn('category', element) @@ -131,8 +133,7 @@ class CommandsTestBase(TestCase): dump = json.loads(output) # check that all elements in the course structure have inherited metadata, # and that it contains a particular value as well: - for element_name in dump: - element = dump[element_name] + for element in dump.itervalues(): self.assertIn('metadata', element) self.assertIn('children', element) self.assertIn('category', element) @@ -158,7 +159,7 @@ class CommandsTestBase(TestCase): self.check_export_file(tar_file) def run_export_course(self, filename): # pylint: disable=missing-docstring - args = ['edX/simple/2012_Fall', filename] + args = [TEST_COURSE_ID, filename] kwargs = {'modulestore': 'default'} return self.call_command('export_course', *args, **kwargs) diff --git a/lms/djangoapps/courseware/model_data.py b/lms/djangoapps/courseware/model_data.py index b204c59551..31cfcea381 100644 --- a/lms/djangoapps/courseware/model_data.py +++ b/lms/djangoapps/courseware/model_data.py @@ -12,6 +12,7 @@ from .models import ( XModuleStudentInfoField ) import logging +from xmodule.modulestore.locations import SlashSeparatedCourseKey, Location from django.db import DatabaseError from django.contrib.auth.models import User @@ -59,6 +60,8 @@ class FieldDataCache(object): self.cache = {} self.descriptors = descriptors self.select_for_update = select_for_update + + assert isinstance(course_id, SlashSeparatedCourseKey) self.course_id = course_id self.user = user @@ -141,8 +144,8 @@ class FieldDataCache(object): if scope == Scope.user_state: return self._chunked_query( StudentModule, - 'module_state_key__in', - (str(descriptor.scope_ids.usage_id) for descriptor in self.descriptors), + 'module_id__in', + (descriptor.scope_ids.usage_id for descriptor in self.descriptors), course_id=self.course_id, student=self.user.pk, ) @@ -150,7 +153,7 @@ class FieldDataCache(object): return self._chunked_query( XModuleUserStateSummaryField, 'usage_id__in', - (str(descriptor.scope_ids.usage_id) for descriptor in self.descriptors), + (descriptor.scope_ids.usage_id for descriptor in self.descriptors), field_name__in=set(field.name for field in fields), ) elif scope == Scope.preferences: @@ -185,9 +188,9 @@ class FieldDataCache(object): Return the key used in the FieldDataCache for the specified KeyValueStore key """ if key.scope == Scope.user_state: - return (key.scope, key.block_scope_id.url()) + return (key.scope, key.block_scope_id) elif key.scope == Scope.user_state_summary: - return (key.scope, key.block_scope_id.url(), key.field_name) + return (key.scope, key.block_scope_id, key.field_name) elif key.scope == Scope.preferences: return (key.scope, key.block_scope_id, key.field_name) elif key.scope == Scope.user_info: @@ -199,9 +202,15 @@ class FieldDataCache(object): field """ if scope == Scope.user_state: - return (scope, field_object.module_state_key) + assert (field_object.module_state_key.org == self.course_id.org and + field_object.module_state_key.course == self.course_id.course) + + return (scope, field_object.module_state_key.map_into_course(self.course_id)) elif scope == Scope.user_state_summary: - return (scope, field_object.usage_id, field_object.field_name) + assert (field_object.usage_id.org == self.course_id.org and + field_object.usage_id.course == self.course_id.course) + + return (scope, field_object.usage_id.map_into_course(self.course_id), field_object.field_name) elif scope == Scope.preferences: return (scope, field_object.module_type, field_object.field_name) elif scope == Scope.user_info: @@ -233,10 +242,13 @@ class FieldDataCache(object): return field_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)) field_object, _ = StudentModule.objects.get_or_create( course_id=self.course_id, student=User.objects.get(id=key.user_id), - module_state_key=key.block_scope_id.url(), + module_id=key.block_scope_id.replace(run=None), defaults={ 'state': json.dumps({}), 'module_type': key.block_scope_id.category, @@ -245,7 +257,7 @@ class FieldDataCache(object): elif key.scope == Scope.user_state_summary: field_object, _ = XModuleUserStateSummaryField.objects.get_or_create( field_name=key.field_name, - usage_id=key.block_scope_id.url() + usage_id=key.block_scope_id ) elif key.scope == Scope.preferences: field_object, _ = XModuleStudentPrefsField.objects.get_or_create( diff --git a/lms/djangoapps/courseware/models.py b/lms/djangoapps/courseware/models.py index 01a91c691e..4880b93306 100644 --- a/lms/djangoapps/courseware/models.py +++ b/lms/djangoapps/courseware/models.py @@ -18,6 +18,8 @@ from django.db import models from django.db.models.signals import post_save from django.dispatch import receiver +from xmodule_django.models import CourseKeyField, LocationKeyField + class StudentModule(models.Model): """ @@ -38,12 +40,31 @@ class StudentModule(models.Model): # but for abtests and the like, this can be set to a shared value # for many instances of the module. # Filename for homeworks, etc. - module_state_key = models.CharField(max_length=255, db_index=True, db_column='module_id') + module_id = LocationKeyField(max_length=255, db_index=True, db_column='module_id') student = models.ForeignKey(User, db_index=True) - course_id = models.CharField(max_length=255, db_index=True) + # TODO: This is a lie; course_id now represents something more like a course_key. We may + # or may not want to change references to this to something like course_key or course_key_field in + # this file. (Certain changes would require a DB migration which is probably not what we want.) + # Someone should look at this and reevaluate before the final merge into master. + course_id = CourseKeyField(max_length=255, db_index=True) + + @property + def module_state_key(self): + """ + Returns a Location based on module_id and course_id + """ + return self.course_id.make_usage_key(self.module_id.category, self.module_id.name) + + @module_state_key.setter + def module_state_key(self, usage_key): + """ + Set the module_id and course_id from the passed UsageKey + """ + self.course_id = usage_key.course_key + self.module_id = usage_key class Meta: - unique_together = (('student', 'module_state_key', 'course_id'),) + unique_together = (('student', 'module_id', 'course_id'),) ## Internal state of the object state = models.TextField(null=True, blank=True) @@ -110,7 +131,7 @@ class StudentModuleHistory(models.Model): max_grade = models.FloatField(null=True, blank=True) @receiver(post_save, sender=StudentModule) - def save_history(sender, instance, **kwargs): + def save_history(sender, instance, **kwargs): # pylint: disable=no-self-argument if instance.module_type in StudentModuleHistory.HISTORY_SAVING_TYPES: history_entry = StudentModuleHistory(student_module=instance, version=None, @@ -133,7 +154,7 @@ class XModuleUserStateSummaryField(models.Model): field_name = models.CharField(max_length=64, db_index=True) # The definition id for the module - usage_id = models.CharField(max_length=255, db_index=True) + usage_id = LocationKeyField(max_length=255, db_index=True) # The value of the field. Defaults to None dumped as json value = models.TextField(default='null') @@ -221,7 +242,7 @@ class OfflineComputedGrade(models.Model): Table of grades computed offline for a given user and course. """ user = models.ForeignKey(User, db_index=True) - course_id = models.CharField(max_length=255, db_index=True) + course_id = CourseKeyField(max_length=255, db_index=True) created = models.DateTimeField(auto_now_add=True, null=True, db_index=True) updated = models.DateTimeField(auto_now=True, db_index=True) @@ -244,10 +265,10 @@ class OfflineComputedGradeLog(models.Model): ordering = ["-created"] get_latest_by = "created" - course_id = models.CharField(max_length=255, db_index=True) + course_id = CourseKeyField(max_length=255, db_index=True) created = models.DateTimeField(auto_now_add=True, null=True, db_index=True) seconds = models.IntegerField(default=0) # seconds elapsed for computation nstudents = models.IntegerField(default=0) def __unicode__(self): - return "[OCGLog] %s: %s" % (self.course_id, self.created) + return "[OCGLog] %s: %s" % (self.course_id.to_deprecated_string(), self.created) # pylint: disable=no-member diff --git a/lms/djangoapps/courseware/module_render.py b/lms/djangoapps/courseware/module_render.py index 704247acaf..bdef5c14ab 100644 --- a/lms/djangoapps/courseware/module_render.py +++ b/lms/djangoapps/courseware/module_render.py @@ -7,6 +7,7 @@ import static_replace from functools import partial from requests.auth import HTTPBasicAuth from dogapi import dog_stats_api +from opaque_keys import InvalidKeyError from django.conf import settings from django.contrib.auth.models import User @@ -21,7 +22,7 @@ from courseware.access import has_access, get_user_role from courseware.masquerade import setup_masquerade from courseware.model_data import FieldDataCache, DjangoKeyValueStore from lms.lib.xblock.field_data import LmsFieldData -from lms.lib.xblock.runtime import LmsModuleSystem, unquote_slashes +from lms.lib.xblock.runtime import LmsModuleSystem, unquote_slashes, quote_slashes from edxmako.shortcuts import render_to_string from eventtracking import tracker from psychometrics.psychoanalyze import make_psychometrics_data_update_handler @@ -33,7 +34,7 @@ from xblock.exceptions import NoSuchHandlerError from xblock.django.request import django_to_webob_request, webob_to_django_response from xmodule.error_module import ErrorDescriptor, NonStaffErrorDescriptor from xmodule.exceptions import NotFoundError, ProcessingError -from xmodule.modulestore import Location +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.modulestore.django import modulestore, ModuleI18nService from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.util.duedate import get_extended_due_date @@ -49,16 +50,20 @@ log = logging.getLogger(__name__) if settings.XQUEUE_INTERFACE.get('basic_auth') is not None: - requests_auth = HTTPBasicAuth(*settings.XQUEUE_INTERFACE['basic_auth']) + REQUESTS_AUTH = HTTPBasicAuth(*settings.XQUEUE_INTERFACE['basic_auth']) else: - requests_auth = None + REQUESTS_AUTH = None -xqueue_interface = XQueueInterface( +XQUEUE_INTERFACE = XQueueInterface( settings.XQUEUE_INTERFACE['url'], settings.XQUEUE_INTERFACE['django_auth'], - requests_auth, + REQUESTS_AUTH, ) +# TODO basically all instances of course_id in this file *should* be changed to course_key, but +# there's a couple tricky ones I'm too afraid to change before we merge the jellyfish branches. +# This should be fixed after the jellyfish merge, before merge into master. + def make_track_function(request): ''' @@ -127,7 +132,7 @@ def toc_for_course(user, request, course, active_chapter, active_section, field_ return chapters -def get_module(user, request, location, field_data_cache, course_id, +def get_module(user, request, usage_key, field_data_cache, position=None, not_found_ok=False, wrap_xmodule_display=True, grade_bucket_type=None, depth=0, static_asset_path=''): @@ -157,9 +162,8 @@ def get_module(user, request, location, field_data_cache, course_id, if possible. If not possible, return None. """ try: - location = Location(location) - descriptor = modulestore().get_instance(course_id, location, depth=depth) - return get_module_for_descriptor(user, request, descriptor, field_data_cache, course_id, + descriptor = modulestore().get_item(usage_key, depth=depth) + return get_module_for_descriptor(user, request, descriptor, field_data_cache, usage_key.course_key, position=position, wrap_xmodule_display=wrap_xmodule_display, grade_bucket_type=grade_bucket_type, @@ -198,7 +202,7 @@ def get_module_for_descriptor(user, request, descriptor, field_data_cache, cours See get_module() docstring for further details. """ # allow course staff to masquerade as student - if has_access(user, descriptor, 'staff', course_id): + if has_access(user, 'staff', descriptor, course_id): setup_masquerade(request, True) track_function = make_track_function(request) @@ -223,7 +227,7 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours # Do not check access when it's a noauth request. if getattr(user, 'known', True): # Short circuit--if the user shouldn't have access, bail without doing any work - if not has_access(user, descriptor, 'load', course_id): + if not has_access(user, 'load', descriptor, course_id): return None student_data = KvsFieldData(DjangoKeyValueStore(field_data_cache)) @@ -234,9 +238,9 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours relative_xqueue_callback_url = reverse( 'xqueue_callback', kwargs=dict( - course_id=course_id, + course_id=course_id.to_deprecated_string(), userid=str(user.id), - mod_id=descriptor.location.url(), + mod_id=descriptor.location.to_deprecated_string(), dispatch=dispatch ), ) @@ -248,7 +252,7 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours xqueue_default_queuename = descriptor.location.org + '-' + descriptor.location.course xqueue = { - 'interface': xqueue_interface, + 'interface': XQUEUE_INTERFACE, 'construct_callback': make_xqueue_callback, 'default_queuename': xqueue_default_queuename.replace(' ', '_'), 'waittime': settings.XQUEUE_WAITTIME_BETWEEN_REQUESTS @@ -312,12 +316,10 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours # Bin score into range and increment stats score_bucket = get_score_bucket(student_module.grade, student_module.max_grade) - course_id_dict = Location.parse_course_id(course_id) tags = [ - u"org:{org}".format(**course_id_dict), - u"course:{course}".format(**course_id_dict), - u"run:{name}".format(**course_id_dict), + u"org:{}".format(course_id.org), + u"course:{}".format(course_id), u"score_bucket:{0}".format(score_bucket) ] @@ -340,7 +342,11 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours # Wrap the output display in a single div to allow for the XModule # javascript to be bound correctly if wrap_xmodule_display is True: - block_wrappers.append(partial(wrap_xblock, 'LmsRuntime', extra_data={'course-id': course_id})) + block_wrappers.append(partial( + wrap_xblock, 'LmsRuntime', + extra_data={'course-id': course_id.to_deprecated_string()}, + usage_id_serializer=lambda usage_id: quote_slashes(usage_id.to_deprecated_string()) + )) # TODO (cpennington): When modules are shared between courses, the static # prefix is going to have to be specific to the module, not the directory @@ -366,11 +372,11 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours block_wrappers.append(partial( replace_jump_to_id_urls, course_id, - reverse('jump_to_id', kwargs={'course_id': course_id, 'module_id': ''}), + reverse('jump_to_id', kwargs={'course_id': course_id.to_deprecated_string(), 'module_id': ''}), )) if settings.FEATURES.get('DISPLAY_DEBUG_INFO_TO_STAFF'): - if has_access(user, descriptor, 'staff', course_id): + if has_access(user, 'staff', descriptor, course_id): block_wrappers.append(partial(add_staff_markup, user)) # These modules store data using the anonymous_student_id as a key. @@ -385,7 +391,7 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours if is_pure_xblock or is_lti_module: anonymous_student_id = anonymous_id_for_user(user, course_id) else: - anonymous_student_id = anonymous_id_for_user(user, '') + anonymous_student_id = anonymous_id_for_user(user, None) system = LmsModuleSystem( track_function=track_function, @@ -409,12 +415,12 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours ), replace_course_urls=partial( static_replace.replace_course_urls, - course_id=course_id + course_key=course_id ), replace_jump_to_id_urls=partial( static_replace.replace_jump_to_id_urls, course_id=course_id, - jump_to_id_base_url=reverse('jump_to_id', kwargs={'course_id': course_id, 'module_id': ''}) + jump_to_id_base_url=reverse('jump_to_id', kwargs={'course_id': course_id.to_deprecated_string(), 'module_id': ''}) ), node_path=settings.NODE_PATH, publish=publish, @@ -440,13 +446,13 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours if settings.FEATURES.get('ENABLE_PSYCHOMETRICS'): system.set( 'psychometrics_handler', # set callback for updating PsychometricsData - make_psychometrics_data_update_handler(course_id, user, descriptor.location.url()) + make_psychometrics_data_update_handler(course_id, user, descriptor.location.to_deprecated_string()) ) - system.set(u'user_is_staff', has_access(user, descriptor.location, u'staff', course_id)) + system.set(u'user_is_staff', has_access(user, u'staff', descriptor.location, course_id)) # make an ErrorDescriptor -- assuming that the descriptor's system is ok - if has_access(user, descriptor.location, 'staff', course_id): + if has_access(user, u'staff', descriptor.location, course_id): system.error_descriptor_class = ErrorDescriptor else: system.error_descriptor_class = NonStaffErrorDescriptor @@ -460,15 +466,17 @@ def find_target_student_module(request, user_id, course_id, mod_id): """ Retrieve target StudentModule """ + course_id = SlashSeparatedCourseKey.from_deprecated_string(course_id) + usage_key = course_id.make_usage_key_from_deprecated_string(mod_id) user = User.objects.get(id=user_id) field_data_cache = FieldDataCache.cache_for_descriptor_descendents( course_id, user, - modulestore().get_instance(course_id, mod_id), + modulestore().get_item(usage_key), depth=0, select_for_update=True ) - instance = get_module(user, request, mod_id, field_data_cache, course_id, grade_bucket_type='xqueue') + instance = get_module(user, request, usage_key, field_data_cache, grade_bucket_type='xqueue') if instance is None: msg = "No module {0} for user {1}--access denied?".format(mod_id, user) log.debug(msg) @@ -566,11 +574,19 @@ def _invoke_xblock_handler(request, course_id, usage_id, handler, suffix, user): """ Invoke an XBlock handler, either authenticated or not. - """ - location = unquote_slashes(usage_id) + Arguments: + request (HttpRequest): the current request + course_id (str): A string of the form org/course/run + usage_id (str): A string of the form i4x://org/course/category/name@revision + handler (str): The name of the handler to invoke + suffix (str): The suffix to pass to the handler when invoked + user (User): The currently logged in user - # Check parameters and fail fast if there's a problem - if not Location.is_valid(location): + """ + try: + course_id = SlashSeparatedCourseKey.from_deprecated_string(course_id) + usage_key = course_id.make_usage_key_from_deprecated_string(unquote_slashes(usage_id)) + except InvalidKeyError: raise Http404("Invalid location") # Check submitted files @@ -580,12 +596,12 @@ def _invoke_xblock_handler(request, course_id, usage_id, handler, suffix, user): return HttpResponse(json.dumps({'success': error_msg})) try: - descriptor = modulestore().get_instance(course_id, location) + descriptor = modulestore().get_item(usage_key) except ItemNotFoundError: log.warn( - "Invalid location for course id {course_id}: {location}".format( - course_id=course_id, - location=location + "Invalid location for course id {course_id}: {usage_key}".format( + course_id=usage_key.course_key, + usage_key=usage_key ) ) raise Http404 @@ -602,11 +618,11 @@ def _invoke_xblock_handler(request, course_id, usage_id, handler, suffix, user): user, descriptor ) - instance = get_module(user, request, location, field_data_cache, course_id, grade_bucket_type='ajax') + instance = get_module(user, request, usage_key, field_data_cache, grade_bucket_type='ajax') if instance is None: # Either permissions just changed, or someone is trying to be clever # and load something they shouldn't have access to. - log.debug("No module %s for user %s -- access denied?", location, user) + log.debug("No module %s for user %s -- access denied?", usage_key, user) raise Http404 req = django_to_webob_request(request) diff --git a/lms/djangoapps/courseware/tests/__init__.py b/lms/djangoapps/courseware/tests/__init__.py index 6271024483..a8a1d21f10 100644 --- a/lms/djangoapps/courseware/tests/__init__.py +++ b/lms/djangoapps/courseware/tests/__init__.py @@ -94,7 +94,7 @@ class BaseTestXmodule(ModuleStoreTestCase): #self.item_module = self.item_descriptor.xmodule_runtime.xmodule_instance #self.item_module is None at this time - self.item_url = Location(self.item_descriptor.location).url() + self.item_url = self.item_descriptor.location.to_deprecated_string() def setup_course(self): self.course = CourseFactory.create(data=self.COURSE_DATA) @@ -139,7 +139,7 @@ class BaseTestXmodule(ModuleStoreTestCase): """Return item url with dispatch.""" return reverse( 'xblock_handler', - args=(self.course.id, quote_slashes(self.item_url), 'xmodule_handler', dispatch) + args=(self.course.id.to_deprecated_string(), quote_slashes(self.item_url), 'xmodule_handler', dispatch) ) diff --git a/lms/djangoapps/courseware/tests/factories.py b/lms/djangoapps/courseware/tests/factories.py index 163f83e6a3..3140bb3afb 100644 --- a/lms/djangoapps/courseware/tests/factories.py +++ b/lms/djangoapps/courseware/tests/factories.py @@ -6,9 +6,6 @@ from factory.django import DjangoModelFactory # Imported to re-export # pylint: disable=unused-import from student.tests.factories import UserFactory # Imported to re-export -from student.tests.factories import GroupFactory # Imported to re-export -from student.tests.factories import CourseEnrollmentAllowedFactory # Imported to re-export -from student.tests.factories import RegistrationFactory # Imported to re-export # pylint: enable=unused-import from student.tests.factories import UserProfileFactory as StudentUserProfileFactory @@ -23,10 +20,11 @@ from student.roles import ( OrgInstructorRole, ) -from xmodule.modulestore import Location +from xmodule.modulestore.locations import SlashSeparatedCourseKey -location = partial(Location, 'i4x', 'edX', 'test_course', 'problem') +course_id = SlashSeparatedCourseKey(u'edX', u'test_course', u'test') +location = partial(course_id.make_usage_key, u'problem') class UserProfileFactory(StudentUserProfileFactory): @@ -41,9 +39,10 @@ class InstructorFactory(UserFactory): last_name = "Instructor" @factory.post_generation + # TODO Change this from course to course_key at next opportunity def course(self, create, extracted, **kwargs): if extracted is None: - raise ValueError("Must specify a course location for a course instructor user") + raise ValueError("Must specify a CourseKey for a course instructor user") CourseInstructorRole(extracted).add_users(self) @@ -55,9 +54,10 @@ class StaffFactory(UserFactory): last_name = "Staff" @factory.post_generation + # TODO Change this from course to course_key at next opportunity def course(self, create, extracted, **kwargs): if extracted is None: - raise ValueError("Must specify a course location for a course staff user") + raise ValueError("Must specify a CourseKey for a course staff user") CourseStaffRole(extracted).add_users(self) @@ -69,9 +69,10 @@ class BetaTesterFactory(UserFactory): last_name = "Beta-Tester" @factory.post_generation + # TODO Change this from course to course_key at next opportunity def course(self, create, extracted, **kwargs): if extracted is None: - raise ValueError("Must specify a course location for a beta-tester user") + raise ValueError("Must specify a CourseKey for a beta-tester user") CourseBetaTesterRole(extracted).add_users(self) @@ -83,10 +84,11 @@ class OrgStaffFactory(UserFactory): last_name = "Org-Staff" @factory.post_generation + # TODO Change this from course to course_key at next opportunity def course(self, create, extracted, **kwargs): if extracted is None: - raise ValueError("Must specify a course location for an org-staff user") - OrgStaffRole(extracted).add_users(self) + raise ValueError("Must specify a CourseKey for an org-staff user") + OrgStaffRole(extracted.org).add_users(self) class OrgInstructorFactory(UserFactory): @@ -97,10 +99,11 @@ class OrgInstructorFactory(UserFactory): last_name = "Org-Instructor" @factory.post_generation + # TODO Change this from course to course_key at next opportunity def course(self, create, extracted, **kwargs): if extracted is None: - raise ValueError("Must specify a course location for an org-instructor user") - OrgInstructorRole(extracted).add_users(self) + raise ValueError("Must specify a CourseKey for an org-instructor user") + OrgInstructorRole(extracted.org).add_users(self) class GlobalStaffFactory(UserFactory): @@ -119,7 +122,7 @@ class StudentModuleFactory(DjangoModelFactory): module_type = "problem" student = factory.SubFactory(UserFactory) - course_id = "MITx/999/Robot_Super_Course" + course_id = SlashSeparatedCourseKey("MITx", "999", "Robot_Super_Course") state = None grade = None max_grade = None @@ -131,7 +134,7 @@ class UserStateSummaryFactory(DjangoModelFactory): field_name = 'existing_field' value = json.dumps('old_value') - usage_id = location('usage_id').url() + usage_id = location('usage_id') class StudentPrefsFactory(DjangoModelFactory): diff --git a/lms/djangoapps/courseware/tests/helpers.py b/lms/djangoapps/courseware/tests/helpers.py index 53eb4499a1..fb4fc60d64 100644 --- a/lms/djangoapps/courseware/tests/helpers.py +++ b/lms/djangoapps/courseware/tests/helpers.py @@ -130,7 +130,7 @@ class LoginEnrollmentTestCase(TestCase): """ resp = self.client.post(reverse('change_enrollment'), { 'enrollment_action': 'enroll', - 'course_id': course.id, + 'course_id': course.id.to_deprecated_string(), }) result = resp.status_code == 200 if verify: @@ -142,5 +142,7 @@ class LoginEnrollmentTestCase(TestCase): Unenroll the currently logged-in user, and check that it worked. `course` is an instance of CourseDescriptor. """ - check_for_post_code(self, 200, reverse('change_enrollment'), {'enrollment_action': 'unenroll', - 'course_id': course.id}) + check_for_post_code(self, 200, reverse('change_enrollment'), { + 'enrollment_action': 'unenroll', + 'course_id': course.id.to_deprecated_string() + }) diff --git a/lms/djangoapps/courseware/tests/test_about.py b/lms/djangoapps/courseware/tests/test_about.py index c38eac5995..165e03cee1 100644 --- a/lms/djangoapps/courseware/tests/test_about.py +++ b/lms/djangoapps/courseware/tests/test_about.py @@ -9,6 +9,7 @@ from .helpers import LoginEnrollmentTestCase from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory +from xmodule.modulestore.locations import SlashSeparatedCourseKey @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) @@ -22,13 +23,13 @@ class AboutTestCase(LoginEnrollmentTestCase, ModuleStoreTestCase): def test_logged_in(self): self.setup_user() - url = reverse('about_course', args=[self.course.id]) + url = reverse('about_course', args=[self.course.id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn("OOGIE BLOOGIE", resp.content) def test_anonymous_user(self): - url = reverse('about_course', args=[self.course.id]) + url = reverse('about_course', args=[self.course.id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn("OOGIE BLOOGIE", resp.content) @@ -39,7 +40,7 @@ class AboutTestCaseXML(LoginEnrollmentTestCase, ModuleStoreTestCase): # The following XML test course (which lives at common/test/data/2014) # is closed; we're testing that an about page still appears when # the course is already closed - xml_course_id = 'edX/detached_pages/2014' + xml_course_id = SlashSeparatedCourseKey('edX', 'detached_pages', '2014') # this text appears in that course's about page # common/test/data/2014/about/overview.html @@ -48,14 +49,14 @@ class AboutTestCaseXML(LoginEnrollmentTestCase, ModuleStoreTestCase): @mock.patch.dict('django.conf.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_logged_in_xml(self): self.setup_user() - url = reverse('about_course', args=[self.xml_course_id]) + url = reverse('about_course', args=[self.xml_course_id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn(self.xml_data, resp.content) @mock.patch.dict('django.conf.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_anonymous_user_xml(self): - url = reverse('about_course', args=[self.xml_course_id]) + url = reverse('about_course', args=[self.xml_course_id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn(self.xml_data, resp.content) @@ -82,7 +83,7 @@ class AboutWithCappedEnrollmentsTestCase(LoginEnrollmentTestCase, ModuleStoreTes This test will make sure that enrollment caps are enforced """ self.setup_user() - url = reverse('about_course', args=[self.course.id]) + url = reverse('about_course', args=[self.course.id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn('', resp.content) diff --git a/lms/djangoapps/courseware/tests/test_access.py b/lms/djangoapps/courseware/tests/test_access.py index 29ef87b22d..51225f389d 100644 --- a/lms/djangoapps/courseware/tests/test_access.py +++ b/lms/djangoapps/courseware/tests/test_access.py @@ -6,11 +6,12 @@ from mock import Mock from django.test import TestCase from django.test.utils import override_settings -from courseware.tests.factories import UserFactory, CourseEnrollmentAllowedFactory, StaffFactory, InstructorFactory -from student.tests.factories import AnonymousUserFactory +from courseware.tests.factories import UserFactory, StaffFactory, InstructorFactory +from student.tests.factories import AnonymousUserFactory, CourseEnrollmentAllowedFactory from xmodule.modulestore import Location from courseware.tests.tests import TEST_DATA_MIXED_MODULESTORE import pytz +from xmodule.modulestore.locations import SlashSeparatedCourseKey # pylint: disable=protected-access @@ -21,129 +22,161 @@ class AccessTestCase(TestCase): """ def setUp(self): - self.course = Location('i4x://edX/toy/course/2012_Fall') + course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + self.course = course_key.make_usage_key('course', course_key.run) self.anonymous_user = AnonymousUserFactory() self.student = UserFactory() self.global_staff = UserFactory(is_staff=True) - self.course_staff = StaffFactory(course=self.course) - self.course_instructor = InstructorFactory(course=self.course) + # TODO please change the StaffFactory and InstructorFactory parameters ASAP! + self.course_staff = StaffFactory(course=self.course.course_key) + self.course_instructor = InstructorFactory(course=self.course.course_key) def test__has_access_to_location(self): - self.assertFalse(access._has_access_to_location(None, self.course, 'staff', None)) + self.assertFalse(access._has_access_to_location( + None, 'staff', self.course, self.course.course_key + )) - self.assertFalse(access._has_access_to_location(self.anonymous_user, self.course, 'staff', None)) - self.assertFalse(access._has_access_to_location(self.anonymous_user, self.course, 'instructor', None)) + self.assertFalse(access._has_access_to_location( + self.anonymous_user, 'staff', self.course, self.course.course_key + )) + self.assertFalse(access._has_access_to_location( + self.anonymous_user, 'instructor', self.course, self.course.course_key + )) - self.assertTrue(access._has_access_to_location(self.global_staff, self.course, 'staff', None)) - self.assertTrue(access._has_access_to_location(self.global_staff, self.course, 'instructor', None)) + self.assertTrue(access._has_access_to_location( + self.global_staff, 'staff', self.course, self.course.course_key + )) + self.assertTrue(access._has_access_to_location( + self.global_staff, 'instructor', self.course, self.course.course_key + )) # A user has staff access if they are in the staff group - self.assertTrue(access._has_access_to_location(self.course_staff, self.course, 'staff', None)) - self.assertFalse(access._has_access_to_location(self.course_staff, self.course, 'instructor', None)) + self.assertTrue(access._has_access_to_location( + self.course_staff, 'staff', self.course, self.course.course_key + )) + self.assertFalse(access._has_access_to_location( + self.course_staff, 'instructor', self.course, self.course.course_key + )) # A user has staff and instructor access if they are in the instructor group - self.assertTrue(access._has_access_to_location(self.course_instructor, self.course, 'staff', None)) - self.assertTrue(access._has_access_to_location(self.course_instructor, self.course, 'instructor', None)) + self.assertTrue(access._has_access_to_location( + self.course_instructor, 'staff', self.course, self.course.course_key + )) + self.assertTrue(access._has_access_to_location( + self.course_instructor, 'instructor', self.course, self.course.course_key + )) # A user does not have staff or instructor access if they are # not in either the staff or the the instructor group - self.assertFalse(access._has_access_to_location(self.student, self.course, 'staff', None)) - self.assertFalse(access._has_access_to_location(self.student, self.course, 'instructor', None)) + self.assertFalse(access._has_access_to_location( + self.student, 'staff', self.course, self.course.course_key + )) + self.assertFalse(access._has_access_to_location( + self.student, 'instructor', self.course, self.course.course_key + )) def test__has_access_string(self): - u = Mock(is_staff=True) - self.assertFalse(access._has_access_string(u, 'not_global', 'staff', None)) + user = Mock(is_staff=True) + self.assertFalse(access._has_access_string(user, 'staff', 'not_global', self.course.course_key)) - u._has_global_staff_access.return_value = True - self.assertTrue(access._has_access_string(u, 'global', 'staff', None)) + user._has_global_staff_access.return_value = True + self.assertTrue(access._has_access_string(user, 'staff', 'global', self.course.course_key)) - self.assertRaises(ValueError, access._has_access_string, u, 'global', 'not_staff', None) + self.assertRaises(ValueError, access._has_access_string, user, 'not_staff', 'global', self.course.course_key) def test__has_access_descriptor(self): # TODO: override DISABLE_START_DATES and test the start date branch of the method - u = Mock() - d = Mock() - d.start = datetime.datetime.now(pytz.utc) - datetime.timedelta(days=1) # make sure the start time is in the past + user = Mock() + date = Mock() + date.start = datetime.datetime.now(pytz.utc) - datetime.timedelta(days=1) # make sure the start time is in the past # Always returns true because DISABLE_START_DATES is set in test.py - self.assertTrue(access._has_access_descriptor(u, d, 'load')) - self.assertRaises(ValueError, access._has_access_descriptor, u, d, 'not_load_or_staff') + self.assertTrue(access._has_access_descriptor(user, 'load', date)) + with self.assertRaises(ValueError): + access._has_access_descriptor(user, 'not_load_or_staff', date) def test__has_access_course_desc_can_enroll(self): - u = Mock() + user = Mock() yesterday = datetime.datetime.now(pytz.utc) - datetime.timedelta(days=1) tomorrow = datetime.datetime.now(pytz.utc) + datetime.timedelta(days=1) - c = Mock(enrollment_start=yesterday, enrollment_end=tomorrow, enrollment_domain='') + course = Mock(enrollment_start=yesterday, enrollment_end=tomorrow, enrollment_domain='') # User can enroll if it is between the start and end dates - self.assertTrue(access._has_access_course_desc(u, c, 'enroll')) + self.assertTrue(access._has_access_course_desc(user, 'enroll', course)) # User can enroll if authenticated and specifically allowed for that course # even outside the open enrollment period - u = Mock(email='test@edx.org', is_staff=False) - u.is_authenticated.return_value = True + user = Mock(email='test@edx.org', is_staff=False) + user.is_authenticated.return_value = True - c = Mock(enrollment_start=tomorrow, enrollment_end=tomorrow, id='edX/test/2012_Fall', enrollment_domain='') + course = Mock( + enrollment_start=tomorrow, enrollment_end=tomorrow, + id=SlashSeparatedCourseKey('edX', 'test', '2012_Fall'), enrollment_domain='' + ) - allowed = CourseEnrollmentAllowedFactory(email=u.email, course_id=c.id) + CourseEnrollmentAllowedFactory(email=user.email, course_id=course.id) - self.assertTrue(access._has_access_course_desc(u, c, 'enroll')) + self.assertTrue(access._has_access_course_desc(user, 'enroll', course)) # Staff can always enroll even outside the open enrollment period - u = Mock(email='test@edx.org', is_staff=True) - u.is_authenticated.return_value = True + user = Mock(email='test@edx.org', is_staff=True) + user.is_authenticated.return_value = True - c = Mock(enrollment_start=tomorrow, enrollment_end=tomorrow, id='edX/test/Whenever', enrollment_domain='') - self.assertTrue(access._has_access_course_desc(u, c, 'enroll')) + course = Mock( + enrollment_start=tomorrow, enrollment_end=tomorrow, + id=SlashSeparatedCourseKey('edX', 'test', 'Whenever'), enrollment_domain='', + ) + self.assertTrue(access._has_access_course_desc(user, 'enroll', course)) # TODO: # Non-staff cannot enroll outside the open enrollment period if not specifically allowed def test__user_passed_as_none(self): """Ensure has_access handles a user being passed as null""" - access.has_access(None, 'global', 'staff', None) + access.has_access(None, 'staff', 'global', None) + class UserRoleTestCase(TestCase): """ Tests for user roles. """ def setUp(self): - self.course = Location('i4x://edX/toy/course/2012_Fall') + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') self.anonymous_user = AnonymousUserFactory() self.student = UserFactory() self.global_staff = UserFactory(is_staff=True) - self.course_staff = StaffFactory(course=self.course) - self.course_instructor = InstructorFactory(course=self.course) + self.course_staff = StaffFactory(course=self.course_key) + self.course_instructor = InstructorFactory(course=self.course_key) def test_user_role_staff(self): """Ensure that user role is student for staff masqueraded as student.""" self.assertEqual( 'staff', - access.get_user_role(self.course_staff, self.course.course_id) + access.get_user_role(self.course_staff, self.course_key) ) # Masquerade staff self.course_staff.masquerade_as_student = True self.assertEqual( 'student', - access.get_user_role(self.course_staff, self.course.course_id) + access.get_user_role(self.course_staff, self.course_key) ) def test_user_role_instructor(self): """Ensure that user role is student for instructor masqueraded as student.""" self.assertEqual( 'instructor', - access.get_user_role(self.course_instructor, self.course.course_id) + access.get_user_role(self.course_instructor, self.course_key) ) # Masquerade instructor self.course_instructor.masquerade_as_student = True self.assertEqual( 'student', - access.get_user_role(self.course_instructor, self.course.course_id) + access.get_user_role(self.course_instructor, self.course_key) ) def test_user_role_anonymous(self): """Ensure that user role is student for anonymous user.""" self.assertEqual( 'student', - access.get_user_role(self.anonymous_user, self.course.course_id) + access.get_user_role(self.anonymous_user, self.course_key) ) diff --git a/lms/djangoapps/courseware/tests/test_course_info.py b/lms/djangoapps/courseware/tests/test_course_info.py index 07b5d97ca7..ba69b94166 100644 --- a/lms/djangoapps/courseware/tests/test_course_info.py +++ b/lms/djangoapps/courseware/tests/test_course_info.py @@ -22,13 +22,13 @@ class CourseInfoTestCase(LoginEnrollmentTestCase, ModuleStoreTestCase): def test_logged_in(self): self.setup_user() - url = reverse('info', args=[self.course.id]) + url = reverse('info', args=[self.course.id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn("OOGIE BLOOGIE", resp.content) def test_anonymous_user(self): - url = reverse('info', args=[self.course.id]) + url = reverse('info', args=[self.course.id.to_deprecated_string()]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertNotIn("OOGIE BLOOGIE", resp.content) diff --git a/lms/djangoapps/courseware/tests/test_courses.py b/lms/djangoapps/courseware/tests/test_courses.py index 32eb3c242f..340221b03c 100644 --- a/lms/djangoapps/courseware/tests/test_courses.py +++ b/lms/djangoapps/courseware/tests/test_courses.py @@ -4,7 +4,6 @@ Tests for course access """ import mock -from django.http import Http404 from django.test.utils import override_settings from student.tests.factories import UserFactory from xmodule.modulestore.django import get_default_store_name_for_current_request @@ -14,16 +13,12 @@ from xmodule.tests.xml import factories as xml from xmodule.tests.xml import XModuleXmlImportTest from courseware.courses import ( - get_course_by_id, - get_course, - get_cms_course_link, - get_cms_block_link, - course_image_url, - get_course_info_section, - get_course_about_section + get_course_by_id, get_cms_course_link, course_image_url, + get_course_info_section, get_course_about_section, get_course ) from courseware.tests.helpers import get_request_for_user from courseware.tests.tests import TEST_DATA_MONGO_MODULESTORE, TEST_DATA_MIXED_MODULESTORE +from xmodule.modulestore.locations import SlashSeparatedCourseKey CMS_BASE_TEST = 'testcms' @@ -34,25 +29,29 @@ class CoursesTest(ModuleStoreTestCase): def test_get_course_by_id_invalid_chars(self): """ - Test that `get_course_by_id` throws a 404, rather than - an exception, when faced with unexpected characters - (such as unicode characters, and symbols such as = and ' ') + Test that `get_course` throws a 404, rather than an exception, + when faced with unexpected characters (such as unicode characters, + and symbols such as = and ' ') """ with self.assertRaises(Http404): - get_course_by_id('MITx/foobar/statistics=introduction') - get_course_by_id('MITx/foobar/business and management') - get_course_by_id('MITx/foobar/NiñøJoséMaríáßç') + get_course_by_id(SlashSeparatedCourseKey('MITx', 'foobar', 'business and management')) + with self.assertRaises(Http404): + get_course_by_id(SlashSeparatedCourseKey('MITx', 'foobar' 'statistics=introduction')) + with self.assertRaises(Http404): + get_course_by_id(SlashSeparatedCourseKey('MITx', 'foobar', 'NiñøJoséMaríáßç')) def test_get_course_invalid_chars(self): """ - Test that `get_course` throws a ValueError, rather than - a 404, when faced with unexpected characters - (such as unicode characters, and symbols such as = and ' ') + Test that `get_course` throws a ValueError, rather than a 404, + when faced with unexpected characters (such as unicode characters, + and symbols such as = and ' ') """ with self.assertRaises(ValueError): - get_course('MITx/foobar/statistics=introduction') - get_course('MITx/foobar/business and management') - get_course('MITx/foobar/NiñøJoséMaríáßç') + get_course(SlashSeparatedCourseKey('MITx', 'foobar', 'business and management')) + with self.assertRaises(ValueError): + get_course(SlashSeparatedCourseKey('MITx', 'foobar', 'statistics=introduction')) + with self.assertRaises(ValueError): + get_course(SlashSeparatedCourseKey('MITx', 'foobar', 'NiñøJoséMaríáßç')) @override_settings( MODULESTORE=TEST_DATA_MONGO_MODULESTORE, CMS_BASE=CMS_BASE_TEST @@ -67,6 +66,7 @@ class CoursesTest(ModuleStoreTestCase): org='org', number='num', display_name='name' ) + cms_url = u"//{}/course/slashes:org+num+name".format(CMS_BASE_TEST) self.assertEqual(cms_url, get_cms_course_link(self.course)) self.assertEqual(cms_url, get_cms_block_link(self.course, 'course')) @@ -146,10 +146,11 @@ class XmlCourseImageTestCase(XModuleXmlImportTest): class CoursesRenderTest(ModuleStoreTestCase): """Test methods related to rendering courses content.""" + toy_course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) def test_get_course_info_section_render(self): - course = get_course_by_id('edX/toy/2012_Fall') + course = get_course_by_id(self.toy_course_key) request = get_request_for_user(UserFactory.create()) # Test render works okay @@ -167,7 +168,7 @@ class CoursesRenderTest(ModuleStoreTestCase): @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) @mock.patch('courseware.courses.get_request_for_thread') def test_get_course_about_section_render(self, mock_get_request): - course = get_course_by_id('edX/toy/2012_Fall') + course = get_course_by_id(self.toy_course_key) request = get_request_for_user(UserFactory.create()) mock_get_request.return_value = request diff --git a/lms/djangoapps/courseware/tests/test_draft_modulestore.py b/lms/djangoapps/courseware/tests/test_draft_modulestore.py index db6d4c45b5..3d5f9f471c 100644 --- a/lms/djangoapps/courseware/tests/test_draft_modulestore.py +++ b/lms/djangoapps/courseware/tests/test_draft_modulestore.py @@ -2,7 +2,7 @@ from django.test import TestCase from django.test.utils import override_settings from xmodule.modulestore.django import modulestore -from xmodule.modulestore import Location +from xmodule.modulestore.locations import SlashSeparatedCourseKey from modulestore_config import TEST_DATA_DRAFT_MONGO_MODULESTORE @@ -13,8 +13,7 @@ class TestDraftModuleStore(TestCase): store = modulestore() # fix was to allow get_items() to take the course_id parameter - store.get_items(Location(None, None, 'vertical', None, None), - course_id='abc', depth=0) + store.get_items(SlashSeparatedCourseKey('a', 'b', 'c'), category='vertical') # test success is just getting through the above statement. # The bug was that 'course_id' argument was diff --git a/lms/djangoapps/courseware/tests/test_grades.py b/lms/djangoapps/courseware/tests/test_grades.py index 5ee6953161..805c5d2e35 100644 --- a/lms/djangoapps/courseware/tests/test_grades.py +++ b/lms/djangoapps/courseware/tests/test_grades.py @@ -9,6 +9,7 @@ from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE from student.tests.factories import UserFactory from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.locations import SlashSeparatedCourseKey from courseware.grades import grade, iterate_grades_for @@ -62,7 +63,7 @@ class TestGradeIteration(ModuleStoreTestCase): should be raised. This is a horrible crossing of abstraction boundaries and should be fixed, but for now we're just testing the behavior. :-(""" with self.assertRaises(Http404): - gradeset_results = iterate_grades_for("I/dont/exist", []) + gradeset_results = iterate_grades_for(SlashSeparatedCourseKey("I", "dont", "exist"), []) gradeset_results.next() def test_all_empty_grades(self): diff --git a/lms/djangoapps/courseware/tests/test_lti_integration.py b/lms/djangoapps/courseware/tests/test_lti_integration.py index 0686767668..0ddb8dd3f8 100644 --- a/lms/djangoapps/courseware/tests/test_lti_integration.py +++ b/lms/djangoapps/courseware/tests/test_lti_integration.py @@ -27,7 +27,8 @@ class TestLTI(BaseTestXmodule): mocked_signature_after_sign = u'my_signature%3D' mocked_decoded_signature = u'my_signature=' - context_id = self.item_descriptor.course_id + # TODO this course_id is actually a course_key; please change this ASAP! + context_id = self.item_descriptor.course_id.to_deprecated_string() user_id = unicode(self.item_descriptor.xmodule_runtime.anonymous_student_id) hostname = self.item_descriptor.xmodule_runtime.hostname resource_link_id = unicode(urllib.quote('{}-{}'.format(hostname, self.item_descriptor.location.html_id()))) @@ -38,10 +39,6 @@ class TestLTI(BaseTestXmodule): user_id=user_id ) - lis_outcome_service_url = 'https://{host}{path}'.format( - host=hostname, - path=self.item_descriptor.xmodule_runtime.handler_url(self.item_descriptor, 'grade_handler', thirdparty=True).rstrip('/?') - ) self.correct_headers = { u'user_id': user_id, u'oauth_callback': u'about:blank', diff --git a/lms/djangoapps/courseware/tests/test_masquerade.py b/lms/djangoapps/courseware/tests/test_masquerade.py index 8767186f34..45413f1ab5 100644 --- a/lms/djangoapps/courseware/tests/test_masquerade.py +++ b/lms/djangoapps/courseware/tests/test_masquerade.py @@ -12,14 +12,14 @@ import json from django.test.utils import override_settings from django.core.urlresolvers import reverse -from django.contrib.auth.models import User +from courseware.tests.factories import StaffFactory from courseware.tests.helpers import LoginEnrollmentTestCase from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE -from student.roles import CourseStaffRole from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.django import modulestore, clear_existing_modulestores from lms.lib.xblock.runtime import quote_slashes +from xmodule.modulestore.locations import SlashSeparatedCourseKey @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) @@ -33,26 +33,19 @@ class TestStaffMasqueradeAsStudent(ModuleStoreTestCase, LoginEnrollmentTestCase) # Clear out the modulestores, causing them to reload clear_existing_modulestores() - self.graded_course = modulestore().get_course("edX/graded/2012_Fall") + self.graded_course = modulestore().get_course(SlashSeparatedCourseKey("edX", "graded", "2012_Fall")) # Create staff account - self.instructor = 'view2@test.com' - self.password = 'foo' - self.create_account('u2', self.instructor, self.password) - self.activate_user(self.instructor) - - def make_instructor(course): - CourseStaffRole(course.location).add_users(User.objects.get(email=self.instructor)) - - make_instructor(self.graded_course) + self.staff = StaffFactory(course=self.graded_course.id) self.logout() - self.login(self.instructor, self.password) + # self.staff.password is the sha hash but login takes the plain text + self.login(self.staff.email, 'test') self.enroll(self.graded_course) def get_cw_section(self): url = reverse('courseware_section', - kwargs={'course_id': self.graded_course.id, + kwargs={'course_id': self.graded_course.id.to_deprecated_string(), 'chapter': 'GradedChapter', 'section': 'Homework1'}) @@ -64,7 +57,7 @@ class TestStaffMasqueradeAsStudent(ModuleStoreTestCase, LoginEnrollmentTestCase) def test_staff_debug_for_staff(self): resp = self.get_cw_section() sdebug = 'Staff Debug Info' - + print resp.content self.assertTrue(sdebug in resp.content) def toggle_masquerade(self): @@ -88,11 +81,11 @@ class TestStaffMasqueradeAsStudent(ModuleStoreTestCase, LoginEnrollmentTestCase) def get_problem(self): pun = 'H1P1' - problem_location = "i4x://edX/graded/problem/%s" % pun + problem_location = self.graded_course.id.make_usage_key("problem", pun) modx_url = reverse('xblock_handler', - kwargs={'course_id': self.graded_course.id, - 'usage_id': quote_slashes(problem_location), + kwargs={'course_id': self.graded_course.id.to_deprecated_string(), + 'usage_id': quote_slashes(problem_location.to_deprecated_string()), 'handler': 'xmodule_handler', 'suffix': 'problem_get'}) diff --git a/lms/djangoapps/courseware/tests/test_model_data.py b/lms/djangoapps/courseware/tests/test_model_data.py index 148dcc0e72..ba13af385a 100644 --- a/lms/djangoapps/courseware/tests/test_model_data.py +++ b/lms/djangoapps/courseware/tests/test_model_data.py @@ -11,12 +11,11 @@ from courseware.models import StudentModule, XModuleUserStateSummaryField from courseware.models import XModuleStudentInfoField, XModuleStudentPrefsField from student.tests.factories import UserFactory -from courseware.tests.factories import StudentModuleFactory as cmfStudentModuleFactory +from courseware.tests.factories import StudentModuleFactory as cmfStudentModuleFactory, location, course_id from courseware.tests.factories import UserStateSummaryFactory from courseware.tests.factories import StudentPrefsFactory, StudentInfoFactory from xblock.fields import Scope, BlockScope, ScopeIds -from xmodule.modulestore import Location from django.test import TestCase from django.db import DatabaseError from xblock.core import KeyValueMultiSaveError @@ -37,9 +36,6 @@ def mock_descriptor(fields=[]): descriptor.module_class.__name__ = 'MockProblemModule' return descriptor -location = partial(Location, 'i4x', 'edX', 'test_course', 'problem') -course_id = 'edX/test_course/test' - # The user ids here are 1 because we make a student in the setUp functions, and # they get an id of 1. There's an assertion in setUp to ensure that assumption # is still true. @@ -51,7 +47,7 @@ user_info_key = partial(DjangoKeyValueStore.Key, Scope.user_info, 1, None) class StudentModuleFactory(cmfStudentModuleFactory): - module_state_key = location('usage_id').url() + module_state_key = location('usage_id') course_id = course_id @@ -204,7 +200,7 @@ class TestMissingStudentModule(TestCase): student_module = StudentModule.objects.all()[0] self.assertEquals({'a_field': 'a_value'}, json.loads(student_module.state)) self.assertEquals(self.user, student_module.student) - self.assertEquals(location('usage_id').url(), student_module.module_state_key) + self.assertEquals(location('usage_id'), student_module.module_state_key) self.assertEquals(course_id, student_module.course_id) def test_delete_field_from_missing_student_module(self): @@ -317,12 +313,12 @@ class StorageTestBase(object): self.assertEquals(exception.saved_field_names[0], 'existing_field') -class TestContentStorage(StorageTestBase, TestCase): - """Tests for ContentStorage""" +class TestUserStateSummaryStorage(StorageTestBase, TestCase): + """Tests for UserStateSummaryStorage""" factory = UserStateSummaryFactory scope = Scope.user_state_summary key_factory = user_state_summary_key - storage_class = XModuleUserStateSummaryField + storage_class = factory.FACTORY_FOR class TestStudentPrefsStorage(OtherUserFailureTestMixin, StorageTestBase, TestCase): diff --git a/lms/djangoapps/courseware/tests/test_module_render.py b/lms/djangoapps/courseware/tests/test_module_render.py index 55e26619fb..ddf98a7a7f 100644 --- a/lms/djangoapps/courseware/tests/test_module_render.py +++ b/lms/djangoapps/courseware/tests/test_module_render.py @@ -18,11 +18,11 @@ from xblock.field_data import FieldData from xblock.runtime import Runtime from xblock.fields import ScopeIds from xmodule.lti_module import LTIDescriptor -from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import ItemFactory, CourseFactory from xmodule.x_module import XModuleDescriptor +from xmodule.modulestore.locations import SlashSeparatedCourseKey from courseware import module_render as render from courseware.courses import get_course_with_access, course_image_url, get_course_info_section @@ -43,9 +43,9 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): Tests of courseware.module_render """ def setUp(self): - self.location = Location('i4x', 'edX', 'toy', 'chapter', 'Overview') - self.course_id = 'edX/toy/2012_Fall' - self.toy_course = modulestore().get_course(self.course_id) + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + self.location = self.course_key.make_usage_key('chapter', 'Overview') + self.toy_course = modulestore().get_course(self.course_key) self.mock_user = UserFactory() self.mock_user.id = 1 self.request_factory = RequestFactory() @@ -56,7 +56,7 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): self.dispatch = 'score_update' # Construct a 'standard' xqueue_callback url - self.callback_url = reverse('xqueue_callback', kwargs=dict(course_id=self.course_id, + self.callback_url = reverse('xqueue_callback', kwargs=dict(course_id=self.course_key.to_deprecated_string(), userid=str(self.mock_user.id), mod_id=self.mock_module.id, dispatch=self.dispatch)) @@ -76,17 +76,17 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): mock_request = MagicMock() mock_request.user = self.mock_user - course = get_course_with_access(self.mock_user, self.course_id, 'load') + course = get_course_with_access(self.mock_user, 'load', self.course_key) field_data_cache = FieldDataCache.cache_for_descriptor_descendents( - self.course_id, self.mock_user, course, depth=2) + self.course_key, self.mock_user, course, depth=2) module = render.get_module( self.mock_user, mock_request, - Location('i4x', 'edX', 'toy', 'html', 'toyjumpto'), + self.course_key.make_usage_key('html', 'toyjumpto'), field_data_cache, - self.course_id + self.course_key ) # get the rendered HTML output which should have the rewritten link @@ -94,7 +94,7 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): # See if the url got rewritten to the target link # note if the URL mapping changes then this assertion will break - self.assertIn('/courses/' + self.course_id + '/jump_to_id/vertical_test', html) + self.assertIn('/courses/' + self.course_key.to_deprecated_string() + '/jump_to_id/vertical_test', html) def test_xqueue_callback_success(self): @@ -113,7 +113,7 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): get_fake_module.return_value = self.mock_module # call xqueue_callback with our mocked information request = self.request_factory.post(self.callback_url, data) - render.xqueue_callback(request, self.course_id, self.mock_user.id, self.mock_module.id, self.dispatch) + render.xqueue_callback(request, self.course_key, self.mock_user.id, self.mock_module.id, self.dispatch) # Verify that handle ajax is called with the correct data request.POST['queuekey'] = fake_key @@ -130,12 +130,12 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): # Test with missing xqueue data with self.assertRaises(Http404): request = self.request_factory.post(self.callback_url, {}) - render.xqueue_callback(request, self.course_id, self.mock_user.id, self.mock_module.id, self.dispatch) + render.xqueue_callback(request, self.course_key, self.mock_user.id, self.mock_module.id, self.dispatch) # Test with missing xqueue_header with self.assertRaises(Http404): request = self.request_factory.post(self.callback_url, data) - render.xqueue_callback(request, self.course_id, self.mock_user.id, self.mock_module.id, self.dispatch) + render.xqueue_callback(request, self.course_key, self.mock_user.id, self.mock_module.id, self.dispatch) def test_get_score_bucket(self): self.assertEquals(render.get_score_bucket(0, 10), 'incorrect') @@ -149,8 +149,8 @@ class ModuleRenderTestCase(ModuleStoreTestCase, LoginEnrollmentTestCase): dispatch_url = reverse( 'xblock_handler', args=[ - 'edX/toy/2012_Fall', - quote_slashes('i4x://edX/toy/videosequence/Toy_Videos'), + self.course_key.to_deprecated_string(), + quote_slashes(self.course_key.make_usage_key('videosequence', 'Toy_Videos').to_deprecated_string()), 'xmodule_handler', 'goto_position' ] @@ -166,9 +166,9 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): """ def setUp(self): - self.location = Location('i4x', 'edX', 'toy', 'chapter', 'Overview') - self.course_id = 'edX/toy/2012_Fall' - self.toy_course = modulestore().get_course(self.course_id) + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + self.location = self.course_key.make_usage_key('chapter', 'Overview') + self.toy_course = modulestore().get_course(self.course_key) self.mock_user = UserFactory() self.mock_user.id = 1 self.request_factory = RequestFactory() @@ -179,10 +179,14 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): self.dispatch = 'score_update' # Construct a 'standard' xqueue_callback url - self.callback_url = reverse('xqueue_callback', kwargs=dict(course_id=self.course_id, - userid=str(self.mock_user.id), - mod_id=self.mock_module.id, - dispatch=self.dispatch)) + self.callback_url = reverse( + 'xqueue_callback', kwargs={ + 'course_id': self.course_key.to_deprecated_string(), + 'userid': str(self.mock_user.id), + 'mod_id': self.mock_module.id, + 'dispatch': self.dispatch + } + ) def _mock_file(self, name='file', size=10): """Create a mock file object for testing uploads""" @@ -201,7 +205,7 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): with self.assertRaises(Http404): render.handle_xblock_callback( request, - 'dummy/course/id', + self.course_key.to_deprecated_string(), 'invalid Location', 'dummy_handler' 'dummy_dispatch' @@ -216,8 +220,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): self.assertEquals( render.handle_xblock_callback( request, - 'dummy/course/id', - quote_slashes(str(self.location)), + self.course_key.to_deprecated_string(), + quote_slashes(self.location.to_deprecated_string()), 'dummy_handler' ).content, json.dumps({ @@ -236,8 +240,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): self.assertEquals( render.handle_xblock_callback( request, - 'dummy/course/id', - quote_slashes(str(self.location)), + self.course_key.to_deprecated_string(), + quote_slashes(self.location.to_deprecated_string()), 'dummy_handler' ).content, json.dumps({ @@ -251,8 +255,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): request.user = self.mock_user response = render.handle_xblock_callback( request, - self.course_id, - quote_slashes(str(self.location)), + self.course_key.to_deprecated_string(), + quote_slashes(self.location.to_deprecated_string()), 'xmodule_handler', 'goto_position', ) @@ -265,7 +269,7 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): render.handle_xblock_callback( request, 'bad_course_id', - quote_slashes(str(self.location)), + quote_slashes(self.location.to_deprecated_string()), 'xmodule_handler', 'goto_position', ) @@ -276,8 +280,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): with self.assertRaises(Http404): render.handle_xblock_callback( request, - self.course_id, - quote_slashes(str(Location('i4x', 'edX', 'toy', 'chapter', 'bad_location'))), + self.course_key.to_deprecated_string(), + quote_slashes(self.course_key.make_usage_key('chapter', 'bad_location').to_deprecated_string()), 'xmodule_handler', 'goto_position', ) @@ -288,8 +292,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): with self.assertRaises(Http404): render.handle_xblock_callback( request, - self.course_id, - quote_slashes(str(self.location)), + self.course_key.to_deprecated_string(), + quote_slashes(self.location.to_deprecated_string()), 'xmodule_handler', 'bad_dispatch', ) @@ -300,8 +304,8 @@ class TestHandleXBlockCallback(ModuleStoreTestCase, LoginEnrollmentTestCase): with self.assertRaises(Http404): render.handle_xblock_callback( request, - self.course_id, - quote_slashes(str(self.location)), + self.course_key.to_deprecated_string(), + quote_slashes(self.location.to_deprecated_string()), 'bad_handler', 'bad_dispatch', ) @@ -313,13 +317,13 @@ class TestTOC(TestCase): def setUp(self): # Toy courses should be loaded - self.course_name = 'edX/toy/2012_Fall' - self.toy_course = modulestore().get_course(self.course_name) + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + self.toy_course = modulestore().get_course(self.course_key) self.portal_user = UserFactory() def test_toc_toy_from_chapter(self): chapter = 'Overview' - chapter_url = '%s/%s/%s' % ('/courses', self.course_name, chapter) + chapter_url = '%s/%s/%s' % ('/courses', self.course_key, chapter) factory = RequestFactory() request = factory.get(chapter_url) field_data_cache = FieldDataCache.cache_for_descriptor_descendents( @@ -346,7 +350,7 @@ class TestTOC(TestCase): def test_toc_toy_from_section(self): chapter = 'Overview' - chapter_url = '%s/%s/%s' % ('/courses', self.course_name, chapter) + chapter_url = '%s/%s/%s' % ('/courses', self.course_key, chapter) section = 'Welcome' factory = RequestFactory() request = factory.get(chapter_url) @@ -506,7 +510,7 @@ class TestHtmlModifiers(ModuleStoreTestCase): self.assertIn( '/courses/{course_id}/bar/content'.format( - course_id=self.course.id + course_id=self.course.id.to_deprecated_string() ), result_fragment.content ) @@ -558,11 +562,11 @@ class ViewInStudioTest(ModuleStoreTestCase): Define the XML backed course to use. Toy courses are already loaded in XML and mixed modulestores. """ - course_id = 'edX/toy/2012_Fall' - location = Location('i4x', 'edX', 'toy', 'chapter', 'Overview') - descriptor = modulestore().get_instance(course_id, location) + course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + location = course_key.make_usage_key('chapter', 'Overview') + descriptor = modulestore().get_item(location) - self._get_module(course_id, descriptor, location) + self._get_module(course_key, descriptor, location) @override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) @@ -722,7 +726,7 @@ class TestStaffDebugInfo(ModuleStoreTestCase): StudentModuleFactory.create( course_id=self.course.id, - module_state_key=self.location, + module_id=self.location, student=UserFactory(), grade=1, max_grade=1, @@ -761,7 +765,7 @@ class TestAnonymousStudentId(ModuleStoreTestCase, LoginEnrollmentTestCase): @patch('courseware.module_render.has_access', Mock(return_value=True)) def _get_anonymous_id(self, course_id, xblock_class): - location = Location('dummy_org', 'dummy_course', 'dummy_category', 'dummy_name') + location = course_id.make_usage_key('dummy_category', 'dummy_name') descriptor = Mock( spec=xblock_class, _field_data=Mock(spec=FieldData), @@ -796,7 +800,7 @@ class TestAnonymousStudentId(ModuleStoreTestCase, LoginEnrollmentTestCase): # This value is set by observation, so that later changes to the student # id computation don't break old data '5afe5d9bb03796557ee2614f5c9611fb', - self._get_anonymous_id(course_id, descriptor_class) + self._get_anonymous_id(SlashSeparatedCourseKey.from_deprecated_string(course_id), descriptor_class) ) @data(*PER_COURSE_ANONYMIZED_DESCRIPTORS) @@ -805,14 +809,14 @@ class TestAnonymousStudentId(ModuleStoreTestCase, LoginEnrollmentTestCase): # This value is set by observation, so that later changes to the student # id computation don't break old data 'e3b0b940318df9c14be59acb08e78af5', - self._get_anonymous_id('MITx/6.00x/2012_Fall', descriptor_class) + self._get_anonymous_id(SlashSeparatedCourseKey('MITx', '6.00x', '2012_Fall'), descriptor_class) ) self.assertEquals( # This value is set by observation, so that later changes to the student # id computation don't break old data 'f82b5416c9f54b5ce33989511bb5ef2e', - self._get_anonymous_id('MITx/6.00x/2013_Spring', descriptor_class) + self._get_anonymous_id(SlashSeparatedCourseKey('MITx', '6.00x', '2013_Spring'), descriptor_class) ) @@ -858,8 +862,8 @@ class TestModuleTrackingContext(ModuleStoreTestCase): render.handle_xblock_callback( self.request, - self.course.id, - quote_slashes(str(descriptor.location)), + self.course.id.to_deprecated_string(), + quote_slashes(descriptor.location.to_deprecated_string()), 'xmodule_handler', 'problem_check', ) diff --git a/lms/djangoapps/courseware/tests/test_navigation.py b/lms/djangoapps/courseware/tests/test_navigation.py index fb9cf95f27..13b69d1958 100644 --- a/lms/djangoapps/courseware/tests/test_navigation.py +++ b/lms/djangoapps/courseware/tests/test_navigation.py @@ -75,10 +75,10 @@ class TestNavigation(ModuleStoreTestCase, LoginEnrollmentTestCase): self.enroll(self.test_course, True) resp = self.client.get(reverse('courseware', - kwargs={'course_id': self.course.id})) + kwargs={'course_id': self.course.id.to_deprecated_string()})) self.assertRedirects(resp, reverse( - 'courseware_section', kwargs={'course_id': self.course.id, + 'courseware_section', kwargs={'course_id': self.course.id.to_deprecated_string(), 'chapter': 'Overview', 'section': 'Welcome'})) @@ -92,16 +92,22 @@ class TestNavigation(ModuleStoreTestCase, LoginEnrollmentTestCase): self.enroll(self.course, True) self.enroll(self.test_course, True) - self.client.get(reverse('courseware_section', kwargs={'course_id': self.course.id, - 'chapter': 'Overview', - 'section': 'Welcome'})) + self.client.get(reverse('courseware_section', kwargs={ + 'course_id': self.course.id.to_deprecated_string(), + 'chapter': 'Overview', + 'section': 'Welcome', + })) resp = self.client.get(reverse('courseware', - kwargs={'course_id': self.course.id})) + kwargs={'course_id': self.course.id.to_deprecated_string()})) - self.assertRedirects(resp, reverse('courseware_chapter', - kwargs={'course_id': self.course.id, - 'chapter': 'Overview'})) + self.assertRedirects(resp, reverse( + 'courseware_chapter', + kwargs={ + 'course_id': self.course.id.to_deprecated_string(), + 'chapter': 'Overview' + } + )) def test_accordion_state(self): """ @@ -113,15 +119,19 @@ class TestNavigation(ModuleStoreTestCase, LoginEnrollmentTestCase): self.enroll(self.test_course, True) # Now we directly navigate to a section in a chapter other than 'Overview'. - check_for_get_code(self, 200, reverse('courseware_section', - kwargs={'course_id': self.course.id, - 'chapter': 'factory_chapter', - 'section': 'factory_section'})) + check_for_get_code(self, 200, reverse( + 'courseware_section', + kwargs={ + 'course_id': self.course.id.to_deprecated_string(), + 'chapter': 'factory_chapter', + 'section': 'factory_section' + } + )) # And now hitting the courseware tab should redirect to 'factory_chapter' resp = self.client.get(reverse('courseware', - kwargs={'course_id': self.course.id})) + kwargs={'course_id': self.course.id.to_deprecated_string()})) self.assertRedirects(resp, reverse('courseware_chapter', - kwargs={'course_id': self.course.id, + kwargs={'course_id': self.course.id.to_deprecated_string(), 'chapter': 'factory_chapter'})) diff --git a/lms/djangoapps/courseware/tests/test_split_module.py b/lms/djangoapps/courseware/tests/test_split_module.py index 6c7731fa23..ccdc863d51 100644 --- a/lms/djangoapps/courseware/tests/test_split_module.py +++ b/lms/djangoapps/courseware/tests/test_split_module.py @@ -113,11 +113,10 @@ class SplitTestBase(ModuleStoreTestCase): resp = self.client.get(reverse( 'courseware_section', - kwargs={'course_id': self.course.id, + kwargs={'course_id': self.course.id.to_deprecated_string(), 'chapter': self.chapter.url_name, 'section': self.sequential.url_name} )) - content = resp.content # Assert we see the proper icon in the top display @@ -176,15 +175,15 @@ class TestVertSplitTestVert(SplitTestBase): display_name="Split test vertical", ) # pylint: disable=protected-access - c0_url = self.course.location._replace(category="vertical", name="split_test_cond0") - c1_url = self.course.location._replace(category="vertical", name="split_test_cond1") + c0_url = self.course.id.make_usage_key("vertical", "split_test_cond0") + c1_url = self.course.id.make_usage_key("vertical", "split_test_cond1") split_test = ItemFactory.create( parent_location=vert1.location, category="split_test", display_name="Split test", user_partition_id='0', - group_id_to_child={"0": c0_url.url(), "1": c1_url.url()}, + group_id_to_child={"0": c0_url, "1": c1_url}, ) cond0vert = ItemFactory.create( @@ -242,15 +241,15 @@ class TestSplitTestVert(SplitTestBase): # split_test cond 0 = vert <- {video, problem} # split_test cond 1 = vert <- {video, html} # pylint: disable=protected-access - c0_url = self.course.location._replace(category="vertical", name="split_test_cond0") - c1_url = self.course.location._replace(category="vertical", name="split_test_cond1") + c0_url = self.course.id.make_usage_key("vertical", "split_test_cond0") + c1_url = self.course.id.make_usage_key("vertical", "split_test_cond1") split_test = ItemFactory.create( parent_location=self.sequential.location, category="split_test", display_name="Split test", user_partition_id='0', - group_id_to_child={"0": c0_url.url(), "1": c1_url.url()}, + group_id_to_child={"0": c0_url, "1": c1_url}, ) cond0vert = ItemFactory.create( diff --git a/lms/djangoapps/courseware/tests/test_submitting_problems.py b/lms/djangoapps/courseware/tests/test_submitting_problems.py index 871da3a263..f3cc5e337a 100644 --- a/lms/djangoapps/courseware/tests/test_submitting_problems.py +++ b/lms/djangoapps/courseware/tests/test_submitting_problems.py @@ -46,6 +46,7 @@ class TestSubmittingProblems(ModuleStoreTestCase, LoginEnrollmentTestCase): def setUp(self): + super(TestSubmittingProblems, self).setUp() # Create course self.course = CourseFactory.create(display_name=self.COURSE_NAME, number=self.COURSE_SLUG) assert self.course, "Couldn't load course %r" % self.COURSE_NAME @@ -63,14 +64,14 @@ class TestSubmittingProblems(ModuleStoreTestCase, LoginEnrollmentTestCase): """ Re-fetch the course from the database so that the object being dealt with has everything added to it. """ - self.course = modulestore().get_instance(self.course.id, self.course.location) + self.course = modulestore().get_course(self.course.id) def problem_location(self, problem_url_name): """ Returns the url of the problem given the problem's name """ - return "i4x://" + self.course.org + "/{}/problem/{}".format(self.COURSE_SLUG, problem_url_name) + return self.course.id.make_usage_key('problem', problem_url_name) def modx_url(self, problem_location, dispatch): """ @@ -84,8 +85,8 @@ class TestSubmittingProblems(ModuleStoreTestCase, LoginEnrollmentTestCase): return reverse( 'xblock_handler', kwargs={ - 'course_id': self.course.id, - 'usage_id': quote_slashes(problem_location), + 'course_id': self.course.id.to_deprecated_string(), + 'usage_id': quote_slashes(problem_location.to_deprecated_string()), 'handler': 'xmodule_handler', 'suffix': dispatch, } @@ -247,7 +248,7 @@ class TestCourseGrader(TestSubmittingProblems): """ fake_request = self.factory.get( - reverse('progress', kwargs={'course_id': self.course.id}) + reverse('progress', kwargs={'course_id': self.course.id.to_deprecated_string()}) ) return grades.grade(self.student_user, fake_request, self.course) @@ -265,7 +266,7 @@ class TestCourseGrader(TestSubmittingProblems): """ fake_request = self.factory.get( - reverse('progress', kwargs={'course_id': self.course.id}) + reverse('progress', kwargs={'course_id': self.course.id.to_deprecated_string()}) ) progress_summary = grades.progress_summary( @@ -493,7 +494,7 @@ class TestCourseGrader(TestSubmittingProblems): # score read from StudentModule and our student gets an A instead. with patch('submissions.api.get_scores') as mock_get_scores: mock_get_scores.return_value = { - self.problem_location('p3'): (1, 1) + self.problem_location('p3').to_deprecated_string(): (1, 1) } self.check_grade_percent(1.0) self.assertEqual(self.get_grade_summary()['grade'], 'A') @@ -509,12 +510,14 @@ class TestCourseGrader(TestSubmittingProblems): with patch('submissions.api.get_scores') as mock_get_scores: mock_get_scores.return_value = { - self.problem_location('p3'): (1, 1) + self.problem_location('p3').to_deprecated_string(): (1, 1) } self.get_grade_summary() # Verify that the submissions API was sent an anonymized student ID - mock_get_scores.assert_called_with(self.course.id, '99ac6730dc5f900d69fd735975243b31') + mock_get_scores.assert_called_with( + self.course.id.to_deprecated_string(), '99ac6730dc5f900d69fd735975243b31' + ) def test_weighted_homework(self): """ @@ -631,7 +634,7 @@ class ProblemWithUploadedFilesTest(TestSubmittingProblems): self.addCleanup(fileobj.close) self.problem_setup("the_problem", filenames) - with patch('courseware.module_render.xqueue_interface.session') as mock_session: + with patch('courseware.module_render.XQUEUE_INTERFACE.session') as mock_session: resp = self.submit_question_answer("the_problem", {'2_1': fileobjs}) self.assertEqual(resp.status_code, 200) @@ -946,7 +949,7 @@ class TestAnswerDistributions(TestSubmittingProblems): user2 = UserFactory.create() problems = StudentModule.objects.filter( course_id=self.course.id, - student_id=self.student_user.id + student=self.student_user ) for problem in problems: problem.student_id = user2.id @@ -981,7 +984,7 @@ class TestAnswerDistributions(TestSubmittingProblems): # Now fetch the state entry for that problem. student_module = StudentModule.objects.get( course_id=self.course.id, - student_id=self.student_user.id + student=self.student_user ) for val in ('Correct', True, False, 0, 0.0, 1, 1.0, None): state = json.loads(student_module.state) @@ -1008,9 +1011,11 @@ class TestAnswerDistributions(TestSubmittingProblems): # to a non-existent problem. student_module = StudentModule.objects.get( course_id=self.course.id, - student_id=self.student_user.id + student=self.student_user + ) + student_module.module_state_key = student_module.module_state_key.replace( + name=student_module.module_state_key.name + "_fake" ) - student_module.module_state_key += "_fake" student_module.save() # It should be empty (ignored) @@ -1027,7 +1032,7 @@ class TestAnswerDistributions(TestSubmittingProblems): # Now fetch the StudentModule entry for p1 so we can corrupt its state prb1 = StudentModule.objects.get( course_id=self.course.id, - student_id=self.student_user.id + student=self.student_user ) # Submit p2 diff --git a/lms/djangoapps/courseware/tests/test_tabs.py b/lms/djangoapps/courseware/tests/test_tabs.py index f69c1a83eb..0192e0bec5 100644 --- a/lms/djangoapps/courseware/tests/test_tabs.py +++ b/lms/djangoapps/courseware/tests/test_tabs.py @@ -15,6 +15,7 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory from courseware.tests.helpers import get_request_for_user, LoginEnrollmentTestCase from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE +from xmodule.modulestore.locations import SlashSeparatedCourseKey @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) @@ -27,29 +28,30 @@ class StaticTabDateTestCase(LoginEnrollmentTestCase, ModuleStoreTestCase): category="static_tab", parent_location=self.course.location, data="OOGIE BLOOGIE", display_name="new_tab" ) + self.toy_course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') def test_logged_in(self): self.setup_user() - url = reverse('static_tab', args=[self.course.id, 'new_tab']) + url = reverse('static_tab', args=[self.course.id.to_deprecated_string(), 'new_tab']) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn("OOGIE BLOOGIE", resp.content) def test_anonymous_user(self): - url = reverse('static_tab', args=[self.course.id, 'new_tab']) + url = reverse('static_tab', args=[self.course.id.to_deprecated_string(), 'new_tab']) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn("OOGIE BLOOGIE", resp.content) @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) def test_get_static_tab_contents(self): - course = get_course_by_id('edX/toy/2012_Fall') + course = get_course_by_id(self.toy_course_key) request = get_request_for_user(UserFactory.create()) tab = CourseTabList.get_tab_by_slug(course.tabs, 'resources') # Test render works okay tab_content = get_static_tab_contents(request, course, tab) - self.assertIn('edX/toy/2012_Fall', tab_content) + self.assertIn(self.toy_course_key.to_deprecated_string(), tab_content) self.assertIn('static_tab', tab_content) # Test when render raises an exception @@ -66,7 +68,7 @@ class StaticTabDateTestCaseXML(LoginEnrollmentTestCase, ModuleStoreTestCase): # The following XML test course (which lives at common/test/data/2014) # is closed; we're testing that tabs still appear when # the course is already closed - xml_course_id = 'edX/detached_pages/2014' + xml_course_key = SlashSeparatedCourseKey('edX', 'detached_pages', '2014') # this text appears in the test course's tab # common/test/data/2014/tabs/8e4cce2b4aaf4ba28b1220804619e41f.html @@ -76,14 +78,14 @@ class StaticTabDateTestCaseXML(LoginEnrollmentTestCase, ModuleStoreTestCase): @patch.dict('django.conf.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_logged_in_xml(self): self.setup_user() - url = reverse('static_tab', args=[self.xml_course_id, self.xml_url]) + url = reverse('static_tab', args=[self.xml_course_key.to_deprecated_string(), self.xml_url]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn(self.xml_data, resp.content) @patch.dict('django.conf.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_anonymous_user_xml(self): - url = reverse('static_tab', args=[self.xml_course_id, self.xml_url]) + url = reverse('static_tab', args=[self.xml_course_key.to_deprecated_string(), self.xml_url]) resp = self.client.get(url) self.assertEqual(resp.status_code, 200) self.assertIn(self.xml_data, resp.content) diff --git a/lms/djangoapps/courseware/tests/test_video_handlers.py b/lms/djangoapps/courseware/tests/test_video_handlers.py index 5598e5a3b4..535c9b1c85 100644 --- a/lms/djangoapps/courseware/tests/test_video_handlers.py +++ b/lms/djangoapps/courseware/tests/test_video_handlers.py @@ -10,7 +10,6 @@ from datetime import timedelta from webob import Request from xmodule.contentstore.content import StaticContent -from xmodule.modulestore import Location from xmodule.contentstore.django import contentstore from . import BaseTestXmodule from .test_video_xml import SOURCE_XML @@ -21,6 +20,7 @@ from xmodule.video_module.transcripts_utils import ( TranscriptException, TranscriptsGenerationException, ) +from xmodule.modulestore.mongo.base import MongoModuleStore SRT_content = textwrap.dedent(""" 0 @@ -46,7 +46,7 @@ def _check_asset(location, asset_name): Check that asset with asset_name exists in assets. """ content_location = StaticContent.compute_location( - location.org, location.course, asset_name + location.course_key, asset_name ) try: contentstore().find(content_location) @@ -61,16 +61,12 @@ def _clear_assets(location): """ store = contentstore() - content_location = StaticContent.compute_location( - location.org, location.course, location.name - ) - - assets, __ = store.get_all_content_for_course(content_location) + assets, __ = store.get_all_content_for_course(location.course_key) for asset in assets: - asset_location = Location(asset["_id"]) + asset_location = MongoModuleStore._location_from_id(asset["_id"], location.course_key.run) del_cached_content(asset_location) - id = StaticContent.get_id_from_location(asset_location) - store.delete(id) + mongo_id = StaticContent.get_id_from_location(asset_location) + store.delete(mongo_id) def _get_subs_id(filename): @@ -97,7 +93,7 @@ def _upload_sjson_file(subs_file, location, default_filename='subs_{}.srt.sjson' def _upload_file(subs_file, location, filename): mime_type = subs_file.content_type content_location = StaticContent.compute_location( - location.org, location.course, filename + location.course_key, filename ) content = StaticContent(content_location, filename, mime_type, subs_file.read()) contentstore().save(content) diff --git a/lms/djangoapps/courseware/tests/test_video_mongo.py b/lms/djangoapps/courseware/tests/test_video_mongo.py index 6054b23153..9e1f69e2fd 100644 --- a/lms/djangoapps/courseware/tests/test_video_mongo.py +++ b/lms/djangoapps/courseware/tests/test_video_mongo.py @@ -14,6 +14,7 @@ from xmodule.video_module import create_youtube_string from xmodule.tests import get_test_descriptor_system from xmodule.modulestore import Location from xmodule.video_module import VideoDescriptor +from xmodule.modulestore.locations import SlashSeparatedCourseKey from . import BaseTestXmodule from .test_video_xml import SOURCE_XML @@ -511,10 +512,11 @@ class VideoDescriptorTest(unittest.TestCase): def setUp(self): system = get_test_descriptor_system() - location = Location('i4x://org/course/video/name') + course_key = SlashSeparatedCourseKey('org', 'course', 'run') + usage_key = course_key.make_usage_key('video', 'name') self.descriptor = system.construct_xblock_from_class( VideoDescriptor, - scope_ids=ScopeIds(None, None, location, location), + scope_ids=ScopeIds(None, None, usage_key, usage_key), field_data=DictFieldData({}), ) self.descriptor.runtime.handler_url = MagicMock() diff --git a/lms/djangoapps/courseware/tests/test_view_authentication.py b/lms/djangoapps/courseware/tests/test_view_authentication.py index 6d92a1a1c2..8a64a289b2 100644 --- a/lms/djangoapps/courseware/tests/test_view_authentication.py +++ b/lms/djangoapps/courseware/tests/test_view_authentication.py @@ -48,7 +48,7 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): Returns a list URLs corresponding to section in the passed in course. """ - return [reverse(name, kwargs={'course_id': course.id}) + return [reverse(name, kwargs={'course_id': course.id.to_deprecated_string()}) for name in names] def _check_non_staff_light(self, course): @@ -57,7 +57,8 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): `course` is an instance of CourseDescriptor. """ - urls = [reverse('about_course', kwargs={'course_id': course.id}), reverse('courses')] + urls = [reverse('about_course', kwargs={'course_id': course.id.to_deprecated_string()}), + reverse('courses')] for url in urls: check_for_get_code(self, 200, url) @@ -69,7 +70,7 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): names = ['courseware', 'instructor_dashboard', 'progress'] urls = self._reverse_urls(names, course) urls.extend([ - reverse('book', kwargs={'course_id': course.id, + reverse('book', kwargs={'course_id': course.id.to_deprecated_string(), 'book_index': index}) for index, book in enumerate(course.textbooks) ]) @@ -83,7 +84,7 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): names = ['about_course', 'instructor_dashboard', 'progress'] urls = self._reverse_urls(names, course) urls.extend([ - reverse('book', kwargs={'course_id': course.id, + reverse('book', kwargs={'course_id': course.id.to_deprecated_string(), 'book_index': index}) for index in xrange(len(course.textbooks)) ]) @@ -97,7 +98,7 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): # to make access checking smarter and understand both the effective # user (the student), and the requesting user (the prof) url = reverse('student_progress', - kwargs={'course_id': course.id, + kwargs={'course_id': course.id.to_deprecated_string(), 'student_id': self.enrolled_user.id}) check_for_get_code(self, 404, url) @@ -137,12 +138,11 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): CourseEnrollmentFactory(user=self.enrolled_user, course_id=self.course.id) CourseEnrollmentFactory(user=self.enrolled_user, course_id=self.test_course.id) - self.staff_user = StaffFactory(course=self.course.location) + self.staff_user = StaffFactory(course=self.course.id) self.instructor_user = InstructorFactory( - course=self.course.location) - self.org_staff_user = OrgStaffFactory(course=self.course.location) - self.org_instructor_user = OrgInstructorFactory( - course=self.course.location) + course=self.course.id) + self.org_staff_user = OrgStaffFactory(course=self.course.id) + self.org_instructor_user = OrgInstructorFactory(course=self.course.id) def test_redirection_unenrolled(self): """ @@ -151,10 +151,10 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): """ self.login(self.unenrolled_user) response = self.client.get(reverse('courseware', - kwargs={'course_id': self.course.id})) + kwargs={'course_id': self.course.id.to_deprecated_string()})) self.assertRedirects(response, reverse('about_course', - args=[self.course.id])) + args=[self.course.id.to_deprecated_string()])) def test_redirection_enrolled(self): """ @@ -164,11 +164,11 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): self.login(self.enrolled_user) response = self.client.get(reverse('courseware', - kwargs={'course_id': self.course.id})) + kwargs={'course_id': self.course.id.to_deprecated_string()})) self.assertRedirects(response, reverse('courseware_section', - kwargs={'course_id': self.course.id, + kwargs={'course_id': self.course.id.to_deprecated_string(), 'chapter': 'Overview', 'section': 'Welcome'})) @@ -179,8 +179,8 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): """ self.login(self.enrolled_user) - urls = [reverse('instructor_dashboard', kwargs={'course_id': self.course.id}), - reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id})] + urls = [reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}), + reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()})] # Shouldn't be able to get to the instructor pages for url in urls: @@ -194,10 +194,10 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): self.login(self.staff_user) # Now should be able to get to self.course, but not self.test_course - url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()}) check_for_get_code(self, 404, url) def test_instructor_course_access(self): @@ -208,10 +208,10 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): self.login(self.instructor_user) # Now should be able to get to self.course, but not self.test_course - url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()}) check_for_get_code(self, 404, url) def test_org_staff_access(self): @@ -220,13 +220,13 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): and student profile pages for course in their org. """ self.login(self.org_staff_user) - url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.other_org_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.other_org_course.id.to_deprecated_string()}) check_for_get_code(self, 404, url) def test_org_instructor_access(self): @@ -235,13 +235,13 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): and student profile pages for course in their org. """ self.login(self.org_instructor_user) - url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()}) check_for_get_code(self, 200, url) - url = reverse('instructor_dashboard', kwargs={'course_id': self.other_org_course.id}) + url = reverse('instructor_dashboard', kwargs={'course_id': self.other_org_course.id.to_deprecated_string()}) check_for_get_code(self, 404, url) def test_global_staff_access(self): @@ -251,8 +251,8 @@ class TestViewAuth(ModuleStoreTestCase, LoginEnrollmentTestCase): self.login(self.global_staff_user) # and now should be able to load both - urls = [reverse('instructor_dashboard', kwargs={'course_id': self.course.id}), - reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id})] + urls = [reverse('instructor_dashboard', kwargs={'course_id': self.course.id.to_deprecated_string()}), + reverse('instructor_dashboard', kwargs={'course_id': self.test_course.id.to_deprecated_string()})] for url in urls: check_for_get_code(self, 200, url) @@ -374,7 +374,7 @@ class TestBetatesterAccess(ModuleStoreTestCase): self.content = ItemFactory(parent=self.course) self.normal_student = UserFactory() - self.beta_tester = BetaTesterFactory(course=self.course.location) + self.beta_tester = BetaTesterFactory(course=self.course.id) @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_course_beta_period(self): @@ -384,10 +384,10 @@ class TestBetatesterAccess(ModuleStoreTestCase): self.assertFalse(self.course.has_started()) # student user shouldn't see it - self.assertFalse(has_access(self.normal_student, self.course, 'load')) + self.assertFalse(has_access(self.normal_student, 'load', self.course)) # now the student should see it - self.assertTrue(has_access(self.beta_tester, self.course, 'load')) + self.assertTrue(has_access(self.beta_tester, 'load', self.course)) @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_content_beta_period(self): @@ -395,7 +395,7 @@ class TestBetatesterAccess(ModuleStoreTestCase): Check that beta-test access works for content. """ # student user shouldn't see it - self.assertFalse(has_access(self.normal_student, self.content, 'load', self.course.id)) + self.assertFalse(has_access(self.normal_student, 'load', self.content, self.course.id)) # now the student should see it - self.assertTrue(has_access(self.beta_tester, self.content, 'load', self.course.id)) + self.assertTrue(has_access(self.beta_tester, 'load', self.content, self.course.id)) diff --git a/lms/djangoapps/courseware/tests/test_views.py b/lms/djangoapps/courseware/tests/test_views.py index f005074282..830b69e83e 100644 --- a/lms/djangoapps/courseware/tests/test_views.py +++ b/lms/djangoapps/courseware/tests/test_views.py @@ -24,6 +24,7 @@ from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.locations import SlashSeparatedCourseKey from student.tests.factories import UserFactory import courseware.views as views @@ -42,31 +43,32 @@ class TestJumpTo(TestCase): def setUp(self): # Use toy course from XML - self.course_name = 'edX/toy/2012_Fall' + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') def test_jumpto_invalid_location(self): - location = Location('i4x', 'edX', 'toy', 'NoSuchPlace', None) - jumpto_url = '{0}/{1}/jump_to/{2}'.format('/courses', self.course_name, location) + location = self.course_key.make_usage_key(None, 'NoSuchPlace') + # This is fragile, but unfortunately the problem is that within the LMS we + # can't use the reverse calls from the CMS + jumpto_url = '{0}/{1}/jump_to/{2}'.format('/courses', self.course_key.to_deprecated_string(), location.to_deprecated_string()) response = self.client.get(jumpto_url) self.assertEqual(response.status_code, 404) def test_jumpto_from_chapter(self): - location = Location('i4x', 'edX', 'toy', 'chapter', 'Overview') - jumpto_url = '{0}/{1}/jump_to/{2}'.format('/courses', self.course_name, location) + location = self.course_key.make_usage_key('chapter', 'Overview') + jumpto_url = '{0}/{1}/jump_to/{2}'.format('/courses', self.course_key.to_deprecated_string(), location.to_deprecated_string()) expected = 'courses/edX/toy/2012_Fall/courseware/Overview/' response = self.client.get(jumpto_url) self.assertRedirects(response, expected, status_code=302, target_status_code=302) def test_jumpto_id(self): - location = Location('i4x', 'edX', 'toy', 'chapter', 'Overview') - jumpto_url = '{0}/{1}/jump_to_id/{2}'.format('/courses', self.course_name, location.name) + jumpto_url = '{0}/{1}/jump_to_id/{2}'.format('/courses', self.course_key.to_deprecated_string(), 'Overview') expected = 'courses/edX/toy/2012_Fall/courseware/Overview/' response = self.client.get(jumpto_url) self.assertRedirects(response, expected, status_code=302, target_status_code=302) def test_jumpto_id_invalid_location(self): - location = Location('i4x', 'edX', 'toy', 'NoSuchPlace', None) - jumpto_url = '{0}/{1}/jump_to_id/{2}'.format('/courses', self.course_name, location.name) + location = Location('edX', 'toy', 'NoSuchPlace', None, None, None) + jumpto_url = '{0}/{1}/jump_to_id/{2}'.format('/courses', self.course_key.to_deprecated_string(), location.to_deprecated_string()) response = self.client.get(jumpto_url) self.assertEqual(response.status_code, 404) @@ -80,15 +82,15 @@ class ViewsTestCase(TestCase): self.user = User.objects.create(username='dummy', password='123456', email='test@mit.edu') self.date = datetime(2013, 1, 22, tzinfo=UTC) - self.course_id = 'edX/toy/2012_Fall' - self.enrollment = CourseEnrollment.enroll(self.user, self.course_id) + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + self.enrollment = CourseEnrollment.enroll(self.user, self.course_key) self.enrollment.created = self.date self.enrollment.save() self.location = ['tag', 'org', 'course', 'category', 'name'] self.request_factory = RequestFactory() chapter = 'Overview' - self.chapter_url = '%s/%s/%s' % ('/courses', self.course_id, chapter) + self.chapter_url = '%s/%s/%s' % ('/courses', self.course_key, chapter) @unittest.skipUnless(settings.FEATURES.get('ENABLE_SHOPPING_CART'), "Shopping Cart not enabled in settings") @patch.dict(settings.FEATURES, {'ENABLE_PAID_COURSE_REGISTRATION': True}) @@ -96,22 +98,22 @@ class ViewsTestCase(TestCase): in_cart_span = '' # don't mock this course due to shopping cart existence checking course = CourseFactory.create(org="new", number="unenrolled", display_name="course") - request = self.request_factory.get(reverse('about_course', args=[course.id])) + request = self.request_factory.get(reverse('about_course', args=[course.id.to_deprecated_string()])) request.user = AnonymousUser() - response = views.course_about(request, course.id) + response = views.course_about(request, course.id.to_deprecated_string()) self.assertEqual(response.status_code, 200) self.assertNotIn(in_cart_span, response.content) # authenticated user with nothing in cart request.user = self.user - response = views.course_about(request, course.id) + response = views.course_about(request, course.id.to_deprecated_string()) self.assertEqual(response.status_code, 200) self.assertNotIn(in_cart_span, response.content) # now add the course to the cart cart = shoppingcart.models.Order.get_cart_for_user(self.user) shoppingcart.models.PaidCourseRegistration.add_to_order(cart, course.id) - response = views.course_about(request, course.id) + response = views.course_about(request, course.id.to_deprecated_string()) self.assertEqual(response.status_code, 200) self.assertIn(in_cart_span, response.content) @@ -146,15 +148,15 @@ class ViewsTestCase(TestCase): mock_user.is_authenticated.return_value = False self.assertFalse(views.registered_for_course('dummy', mock_user)) mock_course = MagicMock() - mock_course.id = self.course_id + mock_course.id = self.course_key self.assertTrue(views.registered_for_course(mock_course, self.user)) def test_jump_to_invalid(self): + # TODO add a test for invalid location + # TODO add a test for no data * request = self.request_factory.get(self.chapter_url) - self.assertRaisesRegexp(Http404, 'Invalid location', views.jump_to, + self.assertRaisesRegexp(Http404, 'Invalid course_key or usage_key', views.jump_to, request, 'bar', ()) - self.assertRaisesRegexp(Http404, 'No data*', views.jump_to, request, - 'dummy', self.location) def test_no_end_on_about_page(self): # Toy course has no course end date or about/end_date blob @@ -170,6 +172,13 @@ class ViewsTestCase(TestCase): self.verify_end_date("edX/test_about_blob_end_date/2012_Fall", "Learning never ends") def verify_end_date(self, course_id, expected_end_text=None): + """ + Visits the about page for `course_id` and tests that both the text "Classes End", as well + as the specified `expected_end_text`, is present on the page. + + If `expected_end_text` is None, verifies that the about page *does not* contain the text + "Classes End". + """ request = self.request_factory.get("foo") request.user = self.user @@ -214,7 +223,7 @@ class ViewsTestCase(TestCase): def test_course_mktg_register(self): admin = AdminFactory() self.client.login(username=admin.username, password='test') - url = reverse('mktg_about_course', kwargs={'course_id': self.course_id}) + url = reverse('mktg_about_course', kwargs={'course_id': self.course_key.to_deprecated_string()}) response = self.client.get(url) self.assertIn('Register for', response.content) self.assertNotIn('and choose your student track', response.content) @@ -223,12 +232,12 @@ class ViewsTestCase(TestCase): admin = AdminFactory() CourseMode.objects.get_or_create(mode_slug='honor', mode_display_name='Honor Code Certificate', - course_id=self.course_id) + course_id=self.course_key) CourseMode.objects.get_or_create(mode_slug='verified', mode_display_name='Verified Certificate', - course_id=self.course_id) + course_id=self.course_key) self.client.login(username=admin.username, password='test') - url = reverse('mktg_about_course', kwargs={'course_id': self.course_id}) + url = reverse('mktg_about_course', kwargs={'course_id': self.course_key.to_deprecated_string()}) response = self.client.get(url) self.assertIn('Register for', response.content) self.assertIn('and choose your student track', response.content) @@ -243,7 +252,7 @@ class ViewsTestCase(TestCase): # try it with an existing user and a malicious location url = reverse('submission_history', kwargs={ - 'course_id': self.course_id, + 'course_id': self.course_key.to_deprecated_string(), 'student_username': 'dummy', 'location': '' }) @@ -252,13 +261,14 @@ class ViewsTestCase(TestCase): # try it with a malicious user and a non-existent location url = reverse('submission_history', kwargs={ - 'course_id': self.course_id, + 'course_id': self.course_key.to_deprecated_string(), 'student_username': '', 'location': 'dummy' }) response = self.client.get(url) self.assertFalse('
- +

${_("Loading the latest graphs for you; depending on your class size, this may take a few minutes.")}

%for i in range(0,len(metrics_results['section_display_name'])): @@ -817,16 +814,16 @@ function goto( mode)

${datatable['title'] | h}

- %for hname in datatable['header']: - - %endfor - + %for hname in datatable['header']: + + %endfor + %for row in datatable['data']: - %for value in row: - - %endfor - + %for value in row: + + %endfor + %endfor
${hname | h}
${hname | h}
${value | h}
${value | h}

@@ -851,8 +848,8 @@ function goto( mode) %for tasknum, instructor_task in enumerate(instructor_tasks): + data-task-id="${instructor_task.task_id}" + data-in-progress="true"> ${instructor_task.task_type} ${instructor_task.task_input} ${instructor_task.task_id} @@ -880,16 +877,16 @@ function goto( mode)

${course_stats['title'] | h}

- %for hname in course_stats['header']: - - %endfor - + %for hname in course_stats['header']: + + %endfor + %for row in course_stats['data']: - %for value in row: - - %endfor - + %for value in row: + + %endfor + %endfor
${hname | h}
${hname | h}
${value | h}
${value | h}

diff --git a/lms/templates/courseware/mktg_coming_soon.html b/lms/templates/courseware/mktg_coming_soon.html index 78cf52d88d..f1e1d97241 100644 --- a/lms/templates/courseware/mktg_coming_soon.html +++ b/lms/templates/courseware/mktg_coming_soon.html @@ -2,7 +2,6 @@ <%! from django.core.urlresolvers import reverse from courseware.courses import course_image_url, get_course_about_section - from courseware.access import has_access %> <%namespace name='static' file='../static_content.html'/> diff --git a/lms/templates/courseware/mktg_course_about.html b/lms/templates/courseware/mktg_course_about.html index 3e1bb61e3d..3eecc0011d 100644 --- a/lms/templates/courseware/mktg_course_about.html +++ b/lms/templates/courseware/mktg_course_about.html @@ -2,7 +2,6 @@ <%! from django.core.urlresolvers import reverse from courseware.courses import course_image_url, get_course_about_section - from courseware.access import has_access %> <%namespace name='static' file='../static_content.html'/> @@ -34,7 +33,7 @@ window.top.location.href = "${reverse('dashboard')}"; } } else if (xhr.status == 403) { - window.top.location.href = "${reverse('register_user')}?course_id=${course.id}&enrollment_action=enroll"; + window.top.location.href = "${reverse('register_user')}?course_id=${course.id.to_deprecated_string()}&enrollment_action=enroll"; } else { $('#register_error').html( (xhr.responseText ? xhr.responseText : "${_("An error occurred. Please try again later.")}") @@ -74,7 +73,7 @@ % endif - +

${_("Course Progress for Student '{username}' ({email})").format(username=student.username, email=student.email)}

@@ -51,7 +51,7 @@ from django.conf import settings %if settings.FEATURES.get("SHOW_PROGRESS_SUCCESS_BUTTON"): <% SUCCESS_BUTTON_URL = settings.PROGRESS_SUCCESS_BUTTON_URL.format( - course_id=course.id, student_id=student.id) + course_id=course.id.to_deprecated_string(), student_id=student.id) nonzero_cutoffs = [cutoff for cutoff in course.grade_cutoffs.values() if cutoff > 0] success_cutoff = min(nonzero_cutoffs) if nonzero_cutoffs else None %> @@ -83,7 +83,7 @@ from django.conf import settings percentageString = "{0:.0%}".format( float(earned)/total) if earned > 0 and total > 0 else "" %> -

+

${ section['display_name'] } %if total > 0 or earned > 0: diff --git a/lms/templates/dashboard/_dashboard_course_listing.html b/lms/templates/dashboard/_dashboard_course_listing.html index 0e8e749e69..72bc1fe6b6 100644 --- a/lms/templates/dashboard/_dashboard_course_listing.html +++ b/lms/templates/dashboard/_dashboard_course_listing.html @@ -23,7 +23,7 @@
  • <% - course_target = reverse('info', args=[course.id]) + course_target = reverse('info', args=[course.id.to_deprecated_string()]) %> % if show_courseware_link: @@ -91,10 +91,10 @@
    • - + ID Verified Ribbon/Badge - ${_("Upgrade to Verified Track")} + ${_("Upgrade to Verified Track")}
      • @@ -113,25 +113,25 @@ % if enrollment.mode != "verified": ## Translators: The course's name will be added to the end of this sentence. - + ${_('Unregister')} % elif show_refund_option: ## Translators: The course's name will be added to the end of this sentence. - + ${_('Unregister')} % else: ## Translators: The course's name will be added to the end of this sentence. - ${_('Unregister')} % endif % if show_email_settings: - + % endif diff --git a/lms/templates/discussion/user_profile.html b/lms/templates/discussion/user_profile.html index 03b3aa71f3..e0a01d573d 100644 --- a/lms/templates/discussion/user_profile.html +++ b/lms/templates/discussion/user_profile.html @@ -32,7 +32,7 @@ -
      +
      diff --git a/lms/templates/help_modal.html b/lms/templates/help_modal.html index 195cb9d903..d39ca20eba 100644 --- a/lms/templates/help_modal.html +++ b/lms/templates/help_modal.html @@ -99,7 +99,7 @@ % if course: - + % endif
      diff --git a/lms/templates/instructor/instructor_dashboard_2/course_info.html b/lms/templates/instructor/instructor_dashboard_2/course_info.html index 57333c8dba..7c710037b8 100644 --- a/lms/templates/instructor/instructor_dashboard_2/course_info.html +++ b/lms/templates/instructor/instructor_dashboard_2/course_info.html @@ -16,17 +16,17 @@
      • - ${ section_data['course_org'] } + ${ section_data['course_id'].org }
      • - ${ section_data['course_num'] } + ${ section_data['course_id'].course }
      • - ${ section_data['course_name'] } + ${ section_data['course_id'].run }
      • diff --git a/lms/templates/instructor/instructor_dashboard_2/student_admin.html b/lms/templates/instructor/instructor_dashboard_2/student_admin.html index 1ff3e2727c..64c35a853f 100644 --- a/lms/templates/instructor/instructor_dashboard_2/student_admin.html +++ b/lms/templates/instructor/instructor_dashboard_2/student_admin.html @@ -30,16 +30,13 @@


        -

        ${_('Specify a particular problem in the course here by its url:')} - +

        ${_('Specify a particular problem in the course here by its location:')} +

        - ${_('You may use just the "urlname" if a problem, or "modulename/urlname" if not. (For example, if the location is {location1}, then just provide the {urlname1}. If the location is {location2}, then provide {urlname2}.)').format( - location1="i4x://university/course/problem/problemname", - urlname1="problemname", - location2="i4x://university/course/notaproblem/someothername", - urlname2="notaproblem/someothername") + ${_("You should provide the full location of a problem. A location will look like this: {location}").format( + location="location:edX+Open_DemoX+problem+78c98390884243b89f6023745231c525") }

        @@ -81,15 +78,12 @@

        - ${_("Specify a particular problem in the course here by its url:")} - + ${_("Specify a particular problem in the course here by its location:")} +

        - ${_('You may use just the "urlname" if a problem, or "modulename/urlname" if not. (For example, if the location is {location1}, then just provide the {urlname1}. If the location is {location2}, then provide {urlname2}.)').format( - location1="i4x://university/course/problem/problemname", - urlname1="problemname", - location2="i4x://university/course/notaproblem/someothername", - urlname2="notaproblem/someothername") + ${_("You should provide the full location of a problem. A location will look like this: {location}").format( + location="location:edX+Open_DemoX+problem+78c98390884243b89f6023745231c525") }

        diff --git a/lms/templates/navigation.html b/lms/templates/navigation.html index f54a897440..3f8a07347d 100644 --- a/lms/templates/navigation.html +++ b/lms/templates/navigation.html @@ -20,7 +20,7 @@ from status.status import get_site_status_msg <%block cached="False"> <% try: - course_id = course.id + course_id = course.id.to_deprecated_string() except: # can't figure out a better way to get at a possibly-defined course var course_id = None @@ -104,7 +104,7 @@ site_status_msg = get_site_status_msg(course_id) % if not settings.FEATURES['DISABLE_LOGIN_BUTTON']: % if course and settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain:

      • - ${_("Register Now")} + ${_("Register Now")}
        • % else:
      • @@ -118,7 +118,7 @@ site_status_msg = get_site_status_msg(course_id)
      • % if not settings.FEATURES['DISABLE_LOGIN_BUTTON']: % if course and settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: - + % else: % endif diff --git a/lms/templates/notes.html b/lms/templates/notes.html index d896725581..0922bba174 100644 --- a/lms/templates/notes.html +++ b/lms/templates/notes.html @@ -59,140 +59,138 @@
        -

        ${_('My Notes')}

        -
        +

        ${_('My Notes')}

        +
        -
        ${_('You do not have any notes.')}
        +
        ${_('You do not have any notes.')}
        -
        diff --git a/lms/templates/peer_grading/peer_grading.html b/lms/templates/peer_grading/peer_grading.html index feff1248aa..4315a8a5d1 100644 --- a/lms/templates/peer_grading/peer_grading.html +++ b/lms/templates/peer_grading/peer_grading.html @@ -41,7 +41,7 @@ criteria.{end_li_tag} %if problem['closed']: ${problem['problem_name']} %else: - ${problem['problem_name']} + ${problem['problem_name']} %endif diff --git a/lms/templates/shoppingcart/verified_cert_receipt.html b/lms/templates/shoppingcart/verified_cert_receipt.html index 294651b0f5..aa9f8e220a 100644 --- a/lms/templates/shoppingcart/verified_cert_receipt.html +++ b/lms/templates/shoppingcart/verified_cert_receipt.html @@ -1,5 +1,4 @@ <%! from django.utils.translation import ugettext as _ %> -<%! from django.core.urlresolvers import reverse %> <%! from student.views import course_from_id %> <%inherit file="../main.html" /> @@ -113,7 +112,7 @@ %if course_has_started: - ${_("Go to Course")} + ${_("Go to Course")} %else: %endif @@ -123,7 +122,7 @@ - ${_("Go to your Dashboard")} + ${_("Go to your Dashboard")} diff --git a/lms/templates/sysadmin_dashboard_gitlogs.html b/lms/templates/sysadmin_dashboard_gitlogs.html index d7709c675d..5c2b72f051 100644 --- a/lms/templates/sysadmin_dashboard_gitlogs.html +++ b/lms/templates/sysadmin_dashboard_gitlogs.html @@ -76,9 +76,10 @@ textarea { %for cil in cilset[:10]: + <% course_id_string = cil.course_id.to_deprecated_string() if cil.course_id else None %> ${cil.created} - ${cil.course_id} + ${course_id_string} ${cil.git_log} %endfor @@ -103,9 +104,10 @@ textarea { % for cil in cilset[:2]: + <% course_id_string = cil.course_id.to_deprecated_string() if cil.course_id else None %> ${cil.created} - ${cil.course_id} + ${course_id_string} ${cil.git_log} diff --git a/lms/templates/verify_student/_verification_support.html b/lms/templates/verify_student/_verification_support.html index a4d2196958..b7263603ae 100644 --- a/lms/templates/verify_student/_verification_support.html +++ b/lms/templates/verify_student/_verification_support.html @@ -19,7 +19,7 @@ %else:

        ${_("Change your mind?")}

        -

        ${_("You can always {a_start} audit the course for free {a_end} without verifying.").format(a_start='', a_end="")}

        +

        ${_("You can always {a_start} audit the course for free {a_end} without verifying.").format(a_start=''.format(course_modes_choose_url), a_end="")}

        %endif
        • @@ -27,7 +27,7 @@

      • ${_("Technical Requirements")}

        -

        ${_("Please make sure your browser is updated to the {a_start}most recent version possible{a_end}. Also, please make sure your web cam is plugged in, turned on, and allowed to function in your web browser (commonly adjustable in your browser settings).").format(a_start='', a_end="")}

        +

        ${_("Please make sure your browser is updated to the {a_start}most recent version possible{a_end}. Also, please make sure your web cam is plugged in, turned on, and allowed to function in your web browser (commonly adjustable in your browser settings).").format(a_start='', a_end="")}

      diff --git a/lms/templates/verify_student/midcourse_reverify_dash.html b/lms/templates/verify_student/midcourse_reverify_dash.html index 3bed7ef7d3..9c0b0aae10 100644 --- a/lms/templates/verify_student/midcourse_reverify_dash.html +++ b/lms/templates/verify_student/midcourse_reverify_dash.html @@ -25,7 +25,9 @@

      ${item.course_name} (${item.course_number})

      ${_('Re-verify by {date}').format(date="" + item.date + "")}

      -

      Re-verify for ${item.course_number}

      +

      + ${_("Re-verify for {course_number}").format(course_number=item.course_number)} +

      % endfor
    @@ -42,7 +44,9 @@

    ${item.course_name} (${item.course_number})

    ${_('Re-verify by {date}').format(date="" + item.date + "")}

    -

    Re-verify for ${item.course_number}

    +

    + ${_("Re-verify for {course_number}").format(course_number=item.course_number)} +

    • % endfor diff --git a/lms/templates/verify_student/photo_verification.html b/lms/templates/verify_student/photo_verification.html index f683ff905f..17170d04ef 100644 --- a/lms/templates/verify_student/photo_verification.html +++ b/lms/templates/verify_student/photo_verification.html @@ -27,7 +27,7 @@

    ${_("No Webcam Detected")}

    -

    ${_("You don't seem to have a webcam connected. Double-check that your webcam is connected and working to continue registering, or select to {a_start} audit the course for free {a_end} without verifying.").format(a_start='', a_end="")}

    +

    ${_("You don't seem to have a webcam connected. Double-check that your webcam is connected and working to continue registering, or select to {a_start} audit the course for free {a_end} without verifying.").format(a_start=''.format(course_modes_choose_url), a_end="")}

    @@ -182,7 +182,7 @@ %if upgrade:
    ${_("You can always continue to audit the course without verifying.")}
    %else: -
    ${_("You can always {a_start} audit the course for free {a_end} without verifying.").format(a_start='', a_end="")}
    +
    ${_("You can always {a_start} audit the course for free {a_end} without verifying.").format(a_start=''.format(course_modes_choose_url), a_end="")}
    %endif diff --git a/lms/templates/verify_student/show_requirements.html b/lms/templates/verify_student/show_requirements.html index 8660db36aa..7b8caf70c2 100644 --- a/lms/templates/verify_student/show_requirements.html +++ b/lms/templates/verify_student/show_requirements.html @@ -168,12 +168,12 @@ %if upgrade: ${_("Missing something? You can always continue to audit this course instead.")} %else: - ${_("Missing something? You can always {a_start}audit this course instead{a_end}").format(a_start='', a_end="")} + ${_("Missing something? You can always {a_start}audit this course instead{a_end}").format(a_start=''.format(course_modes_choose_url), a_end="")} %endif
    1. - +
    diff --git a/lms/templates/verify_student/verified.html b/lms/templates/verify_student/verified.html index 965fe498f1..cb61684493 100644 --- a/lms/templates/verify_student/verified.html +++ b/lms/templates/verify_student/verified.html @@ -12,7 +12,7 @@ var submitToPaymentProcessing = function(event) { event.preventDefault(); var xhr = $.post( - "/verify_student/create_order", + "${create_order_url}", { "course_id" : "${course_id}", }, From 3b03627872e0b877b93da853a28a54575eeba39b Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:35 -0400 Subject: [PATCH 010/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit adds custom django fields for CourseKeys and UsageKeys. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- common/djangoapps/xmodule_django/__init__.py | 0 common/djangoapps/xmodule_django/models.py | 143 +++++++++++++++++++ 2 files changed, 143 insertions(+) create mode 100644 common/djangoapps/xmodule_django/__init__.py create mode 100644 common/djangoapps/xmodule_django/models.py diff --git a/common/djangoapps/xmodule_django/__init__.py b/common/djangoapps/xmodule_django/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/common/djangoapps/xmodule_django/models.py b/common/djangoapps/xmodule_django/models.py new file mode 100644 index 0000000000..4ea96442fa --- /dev/null +++ b/common/djangoapps/xmodule_django/models.py @@ -0,0 +1,143 @@ +from django.db import models +from django.core.exceptions import ValidationError +from xmodule.modulestore.locations import SlashSeparatedCourseKey, Location + +from south.modelsinspector import add_introspection_rules +add_introspection_rules([], ["^xmodule_django\.models\.CourseKeyField"]) +add_introspection_rules([], ["^xmodule_django\.models\.LocationKeyField"]) + + +class NoneToEmptyManager(models.Manager): + """ + A :class:`django.db.models.Manager` that has a :class:`NoneToEmptyQuerySet` + as its `QuerySet`, initialized with a set of specified `field_names`. + """ + def __init__(self): + """ + Args: + field_names: The list of field names to initialize the :class:`NoneToEmptyQuerySet` with. + """ + super(NoneToEmptyManager, self).__init__() + + def get_query_set(self): + return NoneToEmptyQuerySet(self.model, using=self._db) + + +class NoneToEmptyQuerySet(models.query.QuerySet): + """ + A :class:`django.db.query.QuerySet` that replaces `None` values passed to `filter` and `exclude` + with the corresponding `Empty` value for all fields with an `Empty` attribute. + + This is to work around Django automatically converting `exact` queries for `None` into + `isnull` queries before the field has a chance to convert them to queries for it's own + empty value. + """ + def _filter_or_exclude(self, *args, **kwargs): + for name in self.model._meta.get_all_field_names(): + field_object, _model, direct, _m2m = self.model._meta.get_field_by_name(name) + if direct and hasattr(field_object, 'Empty'): + for suffix in ('', '_exact'): + key = '{}{}'.format(name, suffix) + if key in kwargs and kwargs[key] is None: + kwargs[key] = field_object.Empty + return super(NoneToEmptyQuerySet, self)._filter_or_exclude(*args, **kwargs) + + +class CourseKeyField(models.CharField): + description = "A SlashSeparatedCourseKey object, saved to the DB in the form of a string" + + __metaclass__ = models.SubfieldBase + + Empty = object() + + def to_python(self, value): + if value is self.Empty or value is None: + return None + + assert isinstance(value, (basestring, SlashSeparatedCourseKey)) + if value == '': + # handle empty string for models being created w/o fields populated + return None + + if isinstance(value, basestring): + return SlashSeparatedCourseKey.from_deprecated_string(value) + else: + return value + + def get_prep_lookup(self, lookup, value): + if lookup == 'isnull': + raise TypeError('Use CourseKeyField.Empty rather than None to query for a missing CourseKeyField') + + return super(CourseKeyField, self).get_prep_lookup(lookup, value) + + def get_prep_value(self, value): + if value is self.Empty or value is None: + return '' # CharFields should use '' as their empty value, rather than None + + assert isinstance(value, SlashSeparatedCourseKey) + return value.to_deprecated_string() + + def validate(self, value, model_instance): + """Validate Empty values, otherwise defer to the parent""" + # raise validation error if the use of this field says it can't be blank but it is + if not self.blank and value is self.Empty: + raise ValidationError(self.error_messages['blank']) + else: + return super(CourseKeyField, self).validate(value, model_instance) + + def run_validators(self, value): + """Validate Empty values, otherwise defer to the parent""" + if value is self.Empty: + return + + return super(CourseKeyField, self).run_validators(value) + + +class LocationKeyField(models.CharField): + description = "A Location object, saved to the DB in the form of a string" + + __metaclass__ = models.SubfieldBase + + Empty = object() + + def to_python(self, value): + if value is self.Empty or value is None: + return value + + assert isinstance(value, (basestring, Location)) + + if value == '': + return None + + if isinstance(value, basestring): + return Location.from_deprecated_string(value) + else: + return value + + def get_prep_lookup(self, lookup, value): + if lookup == 'isnull': + raise TypeError('Use LocationKeyField.Empty rather than None to query for a missing LocationKeyField') + + return super(LocationKeyField, self).get_prep_lookup(lookup, value) + + def get_prep_value(self, value): + if value is self.Empty: + return '' + + assert isinstance(value, Location) + return value.to_deprecated_string() + + def validate(self, value, model_instance): + """Validate Empty values, otherwise defer to the parent""" + # raise validation error if the use of this field says it can't be blank but it is + if not self.blank and value is self.Empty: + raise ValidationError(self.error_messages['blank']) + else: + return super(LocationKeyField, self).validate(value, model_instance) + + def run_validators(self, value): + """Validate Empty values, otherwise defer to the parent""" + if value is self.Empty: + return + + return super(LocationKeyField, self).run_validators(value) From e2bfcf2a36fb56fcbcd1f099aeef3debc19c9952 Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:43 -0400 Subject: [PATCH 011/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit updates common/djangoapps. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- common/djangoapps/contentserver/middleware.py | 10 +- common/djangoapps/contentserver/tests/test.py | 29 ++- common/djangoapps/course_groups/cohorts.py | 112 ++++++----- common/djangoapps/course_groups/models.py | 4 +- .../course_groups/tests/test_cohorts.py | 26 +-- common/djangoapps/course_groups/views.py | 62 +++--- common/djangoapps/course_modes/models.py | 4 +- .../course_modes/tests/test_models.py | 35 ++-- common/djangoapps/course_modes/views.py | 34 ++-- .../django_comment_common/models.py | 16 +- .../djangoapps/django_comment_common/tests.py | 9 +- .../djangoapps/django_comment_common/utils.py | 20 +- common/djangoapps/embargo/forms.py | 18 +- common/djangoapps/embargo/models.py | 8 +- common/djangoapps/embargo/tests/test_forms.py | 8 +- .../embargo/tests/test_middleware.py | 4 +- .../djangoapps/embargo/tests/test_models.py | 3 +- .../external_auth/tests/test_shib.py | 13 +- .../external_auth/tests/test_ssl.py | 22 +- common/djangoapps/external_auth/views.py | 17 +- common/djangoapps/heartbeat/views.py | 2 +- common/djangoapps/reverification/models.py | 3 +- .../reverification/tests/factories.py | 3 +- common/djangoapps/static_replace/__init__.py | 4 +- .../test/test_static_replace.py | 15 +- common/djangoapps/student/auth.py | 4 +- .../commands/anonymized_id_mapping.py | 2 +- .../management/commands/create_user.py | 14 +- .../0034_auto__add_courseaccessrole.py | 189 ++++++++++++++++++ common/djangoapps/student/tests/test_authz.py | 46 ++--- .../student/tests/test_auto_auth.py | 27 ++- .../student/tests/test_bulk_email_settings.py | 6 +- common/djangoapps/student/tests/test_login.py | 12 +- .../student/tests/test_userstanding.py | 2 +- common/djangoapps/student/views.py | 51 ++--- common/djangoapps/track/contexts.py | 43 ++-- common/djangoapps/user_api/middleware.py | 4 +- common/djangoapps/user_api/models.py | 4 +- common/djangoapps/user_api/tests/factories.py | 3 +- .../user_api/tests/test_user_service.py | 3 +- common/djangoapps/util/request.py | 17 +- common/djangoapps/xmodule_modifiers.py | 25 ++- 42 files changed, 603 insertions(+), 330 deletions(-) create mode 100644 common/djangoapps/student/migrations/0034_auto__add_courseaccessrole.py diff --git a/common/djangoapps/contentserver/middleware.py b/common/djangoapps/contentserver/middleware.py index b9c14cd537..056a1ce459 100644 --- a/common/djangoapps/contentserver/middleware.py +++ b/common/djangoapps/contentserver/middleware.py @@ -4,10 +4,12 @@ from student.models import CourseEnrollment from xmodule.contentstore.django import contentstore from xmodule.contentstore.content import StaticContent, XASSET_LOCATION_TAG -from xmodule.modulestore import InvalidLocationError +from xmodule.modulestore import InvalidLocationError, InvalidKeyError from cache_toolbox.core import get_cached_content, set_cached_content from xmodule.exceptions import NotFoundError +# TODO: Soon as we have a reasonable way to serialize/deserialize AssetKeys, we need +# to change this file so instead of using course_id_partial, we're just using asset keys class StaticContentServer(object): def process_request(self, request): @@ -15,7 +17,7 @@ class StaticContentServer(object): if request.path.startswith('/' + XASSET_LOCATION_TAG + '/'): try: loc = StaticContent.get_location_from_path(request.path) - except InvalidLocationError: + except (InvalidLocationError, InvalidKeyError): # return a 'Bad Request' to browser as we have a malformed Location response = HttpResponse() response.status_code = 400 @@ -47,9 +49,9 @@ class StaticContentServer(object): if getattr(content, "locked", False): if not hasattr(request, "user") or not request.user.is_authenticated(): return HttpResponseForbidden('Unauthorized') - course_partial_id = "/".join([loc.org, loc.course]) if not request.user.is_staff and not CourseEnrollment.is_enrolled_by_partial( - request.user, course_partial_id): + request.user, loc.course_key + ): return HttpResponseForbidden('Unauthorized') # convert over the DB persistent last modified timestamp to a HTTP compatible diff --git a/common/djangoapps/contentserver/tests/test.py b/common/djangoapps/contentserver/tests/test.py index 334b10ca00..21666b6f23 100644 --- a/common/djangoapps/contentserver/tests/test.py +++ b/common/djangoapps/contentserver/tests/test.py @@ -15,9 +15,9 @@ from django.test.utils import override_settings from student.models import CourseEnrollment from xmodule.contentstore.django import contentstore, _CONTENTSTORE -from xmodule.modulestore import Location from xmodule.contentstore.content import StaticContent from xmodule.modulestore.django import modulestore +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.modulestore.tests.django_utils import (studio_store_config, ModuleStoreTestCase) from xmodule.modulestore.xml_importer import import_from_xml @@ -47,18 +47,20 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.client = Client() self.contentstore = contentstore() - # A locked asset - self.loc_locked = Location('c4x', 'edX', 'toy', 'asset', 'sample_static.txt') - self.url_locked = StaticContent.get_url_path_from_location(self.loc_locked) - - # An unlocked asset - self.loc_unlocked = Location('c4x', 'edX', 'toy', 'asset', 'another_static.txt') - self.url_unlocked = StaticContent.get_url_path_from_location(self.loc_unlocked) + self.course_key = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') import_from_xml(modulestore('direct'), 'common/test/data/', ['toy'], static_content_store=self.contentstore, verbose=True) - self.contentstore.set_attr(self.loc_locked, 'locked', True) + # A locked asset + self.locked_asset = self.course_key.make_asset_key('asset', 'sample_static.txt') + self.url_locked = self.locked_asset.to_deprecated_string() + + # An unlocked asset + self.unlocked_asset = self.course_key.make_asset_key('asset', 'another_static.txt') + self.url_unlocked = self.unlocked_asset.to_deprecated_string() + + self.contentstore.set_attr(self.locked_asset, 'locked', True) # Create user self.usr = 'testuser' @@ -114,10 +116,8 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): Test that locked assets behave appropriately in case user is logged in and registered for the course. """ - # pylint: disable=E1101 - course_id = "/".join([self.loc_locked.org, self.loc_locked.course, '2012_Fall']) - CourseEnrollment.enroll(self.user, course_id) - self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_id)) + CourseEnrollment.enroll(self.user, self.course_key) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_key)) self.client.login(username=self.usr, password=self.pwd) resp = self.client.get(self.url_locked) @@ -127,9 +127,6 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): """ Test that locked assets behave appropriately in case user is staff. """ - # pylint: disable=E1101 - course_id = "/".join([self.loc_locked.org, self.loc_locked.course, '2012_Fall']) - self.client.login(username=self.staff_usr, password=self.staff_pwd) resp = self.client.get(self.url_locked) self.assertEqual(resp.status_code, 200) # pylint: disable=E1103 diff --git a/common/djangoapps/course_groups/cohorts.py b/common/djangoapps/course_groups/cohorts.py index 7e6925879f..380bc30c5f 100644 --- a/common/djangoapps/course_groups/cohorts.py +++ b/common/djangoapps/course_groups/cohorts.py @@ -32,30 +32,30 @@ def local_random(): return _local_random -def is_course_cohorted(course_id): +def is_course_cohorted(course_key): """ - Given a course id, return a boolean for whether or not the course is + Given a course key, return a boolean for whether or not the course is cohorted. Raises: Http404 if the course doesn't exist. """ - return courses.get_course_by_id(course_id).is_cohorted + return courses.get_course_by_id(course_key).is_cohorted -def get_cohort_id(user, course_id): +def get_cohort_id(user, course_key): """ - Given a course id and a user, return the id of the cohort that user is + Given a course key and a user, return the id of the cohort that user is assigned to in that course. If they don't have a cohort, return None. """ - cohort = get_cohort(user, course_id) + cohort = get_cohort(user, course_key) return None if cohort is None else cohort.id -def is_commentable_cohorted(course_id, commentable_id): +def is_commentable_cohorted(course_key, commentable_id): """ Args: - course_id: string + course_key: CourseKey commentable_id: string Returns: @@ -64,7 +64,7 @@ def is_commentable_cohorted(course_id, commentable_id): Raises: Http404 if the course doesn't exist. """ - course = courses.get_course_by_id(course_id) + course = courses.get_course_by_id(course_key) if not course.is_cohorted: # this is the easy case :) @@ -77,18 +77,18 @@ def is_commentable_cohorted(course_id, commentable_id): # inline discussions are cohorted by default ans = True - log.debug(u"is_commentable_cohorted({0}, {1}) = {2}".format(course_id, - commentable_id, - ans)) + log.debug(u"is_commentable_cohorted({0}, {1}) = {2}".format( + course_key, commentable_id, ans + )) return ans -def get_cohorted_commentables(course_id): +def get_cohorted_commentables(course_key): """ - Given a course_id return a list of strings representing cohorted commentables + Given a course_key return a list of strings representing cohorted commentables """ - course = courses.get_course_by_id(course_id) + course = courses.get_course_by_id(course_key) if not course.is_cohorted: # this is the easy case :) @@ -99,34 +99,34 @@ def get_cohorted_commentables(course_id): return ans -def get_cohort(user, course_id): +def get_cohort(user, course_key): """ - Given a django User and a course_id, return the user's cohort in that + Given a django User and a CourseKey, return the user's cohort in that cohort. Arguments: user: a Django User object. - course_id: string in the format 'org/course/run' + course_key: CourseKey Returns: A CourseUserGroup object if the course is cohorted and the User has a cohort, else None. Raises: - ValueError if the course_id doesn't exist. + ValueError if the CourseKey doesn't exist. """ # First check whether the course is cohorted (users shouldn't be in a cohort # in non-cohorted courses, but settings can change after course starts) try: - course = courses.get_course_by_id(course_id) + course = courses.get_course_by_id(course_key) except Http404: - raise ValueError("Invalid course_id") + raise ValueError("Invalid course_key") if not course.is_cohorted: return None try: - return CourseUserGroup.objects.get(course_id=course_id, + return CourseUserGroup.objects.get(course_id=course_key, group_type=CourseUserGroup.COHORT, users__id=user.id) except CourseUserGroup.DoesNotExist: @@ -142,72 +142,81 @@ def get_cohort(user, course_id): # Nowhere to put user log.warning("Course %s is auto-cohorted, but there are no" " auto_cohort_groups specified", - course_id) + course_key) return None # Put user in a random group, creating it if needed group_name = local_random().choice(choices) group, created = CourseUserGroup.objects.get_or_create( - course_id=course_id, + course_id=course_key, group_type=CourseUserGroup.COHORT, - name=group_name) + name=group_name + ) user.course_groups.add(group) return group -def get_course_cohorts(course_id): +def get_course_cohorts(course_key): """ Get a list of all the cohorts in the given course. Arguments: - course_id: string in the format 'org/course/run' + course_key: CourseKey Returns: A list of CourseUserGroup objects. Empty if there are no cohorts. Does not check whether the course is cohorted. """ - return list(CourseUserGroup.objects.filter(course_id=course_id, - group_type=CourseUserGroup.COHORT)) + return list(CourseUserGroup.objects.filter( + course_id=course_key, + group_type=CourseUserGroup.COHORT + )) ### Helpers for cohort management views -def get_cohort_by_name(course_id, name): +def get_cohort_by_name(course_key, name): """ Return the CourseUserGroup object for the given cohort. Raises DoesNotExist it isn't present. """ - return CourseUserGroup.objects.get(course_id=course_id, - group_type=CourseUserGroup.COHORT, - name=name) + return CourseUserGroup.objects.get( + course_id=course_key, + group_type=CourseUserGroup.COHORT, + name=name + ) -def get_cohort_by_id(course_id, cohort_id): +def get_cohort_by_id(course_key, cohort_id): """ Return the CourseUserGroup object for the given cohort. Raises DoesNotExist - it isn't present. Uses the course_id for extra validation... + it isn't present. Uses the course_key for extra validation... """ - return CourseUserGroup.objects.get(course_id=course_id, - group_type=CourseUserGroup.COHORT, - id=cohort_id) + return CourseUserGroup.objects.get( + course_id=course_key, + group_type=CourseUserGroup.COHORT, + id=cohort_id + ) -def add_cohort(course_id, name): +def add_cohort(course_key, name): """ Add a cohort to a course. Raises ValueError if a cohort of the same name already exists. """ - log.debug("Adding cohort %s to %s", name, course_id) - if CourseUserGroup.objects.filter(course_id=course_id, + log.debug("Adding cohort %s to %s", name, course_key) + if CourseUserGroup.objects.filter(course_id=course_key, group_type=CourseUserGroup.COHORT, name=name).exists(): raise ValueError("Can't create two cohorts with the same name") - return CourseUserGroup.objects.create(course_id=course_id, - group_type=CourseUserGroup.COHORT, - name=name) + return CourseUserGroup.objects.create( + course_id=course_key, + group_type=CourseUserGroup.COHORT, + name=name + ) class CohortConflict(Exception): @@ -237,9 +246,10 @@ def add_user_to_cohort(cohort, username_or_email): previous_cohort = None course_cohorts = CourseUserGroup.objects.filter( - course_id=cohort.course_id, + course_id=cohort.course_key, users__id=user.id, - group_type=CourseUserGroup.COHORT) + group_type=CourseUserGroup.COHORT + ) if course_cohorts.exists(): if course_cohorts[0] == cohort: raise ValueError("User {0} already present in cohort {1}".format( @@ -253,21 +263,21 @@ def add_user_to_cohort(cohort, username_or_email): return (user, previous_cohort) -def get_course_cohort_names(course_id): +def get_course_cohort_names(course_key): """ Return a list of the cohort names in a course. """ - return [c.name for c in get_course_cohorts(course_id)] + return [c.name for c in get_course_cohorts(course_key)] -def delete_empty_cohort(course_id, name): +def delete_empty_cohort(course_key, name): """ Remove an empty cohort. Raise ValueError if cohort is not empty. """ - cohort = get_cohort_by_name(course_id, name) + cohort = get_cohort_by_name(course_key, name) if cohort.users.exists(): raise ValueError( "Can't delete non-empty cohort {0} in course {1}".format( - name, course_id)) + name, course_key)) cohort.delete() diff --git a/common/djangoapps/course_groups/models.py b/common/djangoapps/course_groups/models.py index 8bab17493b..52c22b6e9a 100644 --- a/common/djangoapps/course_groups/models.py +++ b/common/djangoapps/course_groups/models.py @@ -2,6 +2,7 @@ import logging from django.contrib.auth.models import User from django.db import models +from xmodule_django.models import CourseKeyField log = logging.getLogger(__name__) @@ -23,7 +24,8 @@ class CourseUserGroup(models.Model): # Note: groups associated with particular runs of a course. E.g. Fall 2012 and Spring # 2013 versions of 6.00x will have separate groups. - course_id = models.CharField(max_length=255, db_index=True, + # TODO change field name to course_key + course_id = CourseKeyField(max_length=255, db_index=True, help_text="Which course is this group associated with?") # For now, only have group type 'cohort', but adding a type field to support diff --git a/common/djangoapps/course_groups/tests/test_cohorts.py b/common/djangoapps/course_groups/tests/test_cohorts.py index a17df56a71..4901bdc94a 100644 --- a/common/djangoapps/course_groups/tests/test_cohorts.py +++ b/common/djangoapps/course_groups/tests/test_cohorts.py @@ -9,6 +9,7 @@ from course_groups.cohorts import (get_cohort, get_course_cohorts, is_commentable_cohorted, get_cohort_by_name) from xmodule.modulestore.django import modulestore, clear_existing_modulestores +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.modulestore.tests.django_utils import mixed_store_config @@ -84,13 +85,14 @@ class TestCohorts(django.test.TestCase): Make sure that course is reloaded every time--clear out the modulestore. """ clear_existing_modulestores() + self.toy_course_key = SlashSeparatedCourseKey("edX", "toy", "2012_Fall") def test_get_cohort(self): """ Make sure get_cohort() does the right thing when the course is cohorted """ - course = modulestore().get_course("edX/toy/2012_Fall") - self.assertEqual(course.id, "edX/toy/2012_Fall") + course = modulestore().get_course(self.toy_course_key) + self.assertEqual(course.id, self.toy_course_key) self.assertFalse(course.is_cohorted) user = User.objects.create(username="test", email="a@b.com") @@ -120,8 +122,7 @@ class TestCohorts(django.test.TestCase): """ Make sure get_cohort() does the right thing when the course is auto_cohorted """ - course = modulestore().get_course("edX/toy/2012_Fall") - self.assertEqual(course.id, "edX/toy/2012_Fall") + course = modulestore().get_course(self.toy_course_key) self.assertFalse(course.is_cohorted) user1 = User.objects.create(username="test", email="a@b.com") @@ -168,8 +169,7 @@ class TestCohorts(django.test.TestCase): """ Make sure get_cohort() randomizes properly. """ - course = modulestore().get_course("edX/toy/2012_Fall") - self.assertEqual(course.id, "edX/toy/2012_Fall") + course = modulestore().get_course(self.toy_course_key) self.assertFalse(course.is_cohorted) groups = ["group_{0}".format(n) for n in range(5)] @@ -194,26 +194,26 @@ class TestCohorts(django.test.TestCase): self.assertLess(num_users, 50) def test_get_course_cohorts(self): - course1_id = 'a/b/c' - course2_id = 'e/f/g' + course1_key = SlashSeparatedCourseKey('a', 'b', 'c') + course2_key = SlashSeparatedCourseKey('e', 'f', 'g') # add some cohorts to course 1 cohort = CourseUserGroup.objects.create(name="TestCohort", - course_id=course1_id, + course_id=course1_key, group_type=CourseUserGroup.COHORT) cohort = CourseUserGroup.objects.create(name="TestCohort2", - course_id=course1_id, + course_id=course1_key, group_type=CourseUserGroup.COHORT) # second course should have no cohorts - self.assertEqual(get_course_cohorts(course2_id), []) + self.assertEqual(get_course_cohorts(course2_key), []) - cohorts = sorted([c.name for c in get_course_cohorts(course1_id)]) + cohorts = sorted([c.name for c in get_course_cohorts(course1_key)]) self.assertEqual(cohorts, ['TestCohort', 'TestCohort2']) def test_is_commentable_cohorted(self): - course = modulestore().get_course("edX/toy/2012_Fall") + course = modulestore().get_course(self.toy_course_key) self.assertFalse(course.is_cohorted) def to_id(name): diff --git a/common/djangoapps/course_groups/views.py b/common/djangoapps/course_groups/views.py index 9dc9cf523c..a9a058a539 100644 --- a/common/djangoapps/course_groups/views.py +++ b/common/djangoapps/course_groups/views.py @@ -33,25 +33,25 @@ def split_by_comma_and_whitespace(s): @ensure_csrf_cookie -def list_cohorts(request, course_id): +def list_cohorts(request, course_key): """ Return json dump of dict: {'success': True, 'cohorts': [{'name': name, 'id': id}, ...]} """ - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) all_cohorts = [{'name': c.name, 'id': c.id} - for c in cohorts.get_course_cohorts(course_id)] + for c in cohorts.get_course_cohorts(course_key)] return json_http_response({'success': True, - 'cohorts': all_cohorts}) + 'cohorts': all_cohorts}) @ensure_csrf_cookie @require_POST -def add_cohort(request, course_id): +def add_cohort(request, course_key): """ Return json of dict: {'success': True, @@ -63,7 +63,7 @@ def add_cohort(request, course_id): {'success': False, 'msg': error_msg} if there's an error """ - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) name = request.POST.get("name") if not name: @@ -71,7 +71,7 @@ def add_cohort(request, course_id): 'msg': "No name specified"}) try: - cohort = cohorts.add_cohort(course_id, name) + cohort = cohorts.add_cohort(course_key, name) except ValueError as err: return json_http_response({'success': False, 'msg': str(err)}) @@ -84,7 +84,7 @@ def add_cohort(request, course_id): @ensure_csrf_cookie -def users_in_cohort(request, course_id, cohort_id): +def users_in_cohort(request, course_key, cohort_id): """ Return users in the cohort. Show up to 100 per page, and page using the 'page' GET attribute in the call. Format: @@ -97,11 +97,11 @@ def users_in_cohort(request, course_id, cohort_id): 'users': [{'username': ..., 'email': ..., 'name': ...}] } """ - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) # this will error if called with a non-int cohort_id. That's ok--it # shoudn't happen for valid clients. - cohort = cohorts.get_cohort_by_id(course_id, int(cohort_id)) + cohort = cohorts.get_cohort_by_id(course_key, int(cohort_id)) paginator = Paginator(cohort.users.all(), 100) page = request.GET.get('page') @@ -119,17 +119,17 @@ def users_in_cohort(request, course_id, cohort_id): user_info = [{'username': u.username, 'email': u.email, 'name': '{0} {1}'.format(u.first_name, u.last_name)} - for u in users] + for u in users] return json_http_response({'success': True, - 'page': page, - 'num_pages': paginator.num_pages, - 'users': user_info}) + 'page': page, + 'num_pages': paginator.num_pages, + 'users': user_info}) @ensure_csrf_cookie @require_POST -def add_users_to_cohort(request, course_id, cohort_id): +def add_users_to_cohort(request, course_key, cohort_id): """ Return json dict of: @@ -144,9 +144,9 @@ def add_users_to_cohort(request, course_id, cohort_id): 'present': [str1, str2, ...], # already there 'unknown': [str1, str2, ...]} """ - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) - cohort = cohorts.get_cohort_by_id(course_id, cohort_id) + cohort = cohorts.get_cohort_by_id(course_key, cohort_id) users = request.POST.get('users', '') added = [] @@ -175,15 +175,15 @@ def add_users_to_cohort(request, course_id, cohort_id): unknown.append(username_or_email) return json_http_response({'success': True, - 'added': added, - 'changed': changed, - 'present': present, - 'unknown': unknown}) + 'added': added, + 'changed': changed, + 'present': present, + 'unknown': unknown}) @ensure_csrf_cookie @require_POST -def remove_user_from_cohort(request, course_id, cohort_id): +def remove_user_from_cohort(request, course_key, cohort_id): """ Expects 'username': username in POST data. @@ -193,14 +193,14 @@ def remove_user_from_cohort(request, course_id, cohort_id): {'success': False, 'msg': error_msg} """ - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) username = request.POST.get('username') if username is None: return json_http_response({'success': False, - 'msg': 'No username specified'}) + 'msg': 'No username specified'}) - cohort = cohorts.get_cohort_by_id(course_id, cohort_id) + cohort = cohorts.get_cohort_by_id(course_key, cohort_id) try: user = User.objects.get(username=username) cohort.users.remove(user) @@ -208,16 +208,18 @@ def remove_user_from_cohort(request, course_id, cohort_id): except User.DoesNotExist: log.debug('no user') return json_http_response({'success': False, - 'msg': "No user '{0}'".format(username)}) + 'msg': "No user '{0}'".format(username)}) -def debug_cohort_mgmt(request, course_id): +def debug_cohort_mgmt(request, course_key): """ Debugging view for dev. """ # add staff check to make sure it's safe if it's accidentally deployed. - get_course_with_access(request.user, course_id, 'staff') + get_course_with_access(request.user, 'staff', course_key) - context = {'cohorts_ajax_url': reverse('cohorts', - kwargs={'course_id': course_id})} + context = {'cohorts_ajax_url': reverse( + 'cohorts', + kwargs={'course_id': course_key.to_deprecated_string()} + )} return render_to_response('/course_groups/debug.html', context) diff --git a/common/djangoapps/course_modes/models.py b/common/djangoapps/course_modes/models.py index ae9fac5ed4..2657f877f6 100644 --- a/common/djangoapps/course_modes/models.py +++ b/common/djangoapps/course_modes/models.py @@ -9,6 +9,8 @@ from collections import namedtuple from django.utils.translation import ugettext as _ from django.db.models import Q +from xmodule_django.models import CourseKeyField + Mode = namedtuple('Mode', ['slug', 'name', 'min_price', 'suggested_prices', 'currency', 'expiration_datetime']) class CourseMode(models.Model): @@ -17,7 +19,7 @@ class CourseMode(models.Model): """ # the course that this mode is attached to - course_id = models.CharField(max_length=255, db_index=True) + course_id = CourseKeyField(max_length=255, db_index=True) # the reference to this mode that can be used by Enrollments to generate # similar behavior for the same slug across courses diff --git a/common/djangoapps/course_modes/tests/test_models.py b/common/djangoapps/course_modes/tests/test_models.py index 5336b3e5fa..c29a9e7ec3 100644 --- a/common/djangoapps/course_modes/tests/test_models.py +++ b/common/djangoapps/course_modes/tests/test_models.py @@ -8,6 +8,7 @@ Replace this with more appropriate tests for your application. from datetime import datetime, timedelta import pytz +from xmodule.modulestore.locations import SlashSeparatedCourseKey from django.test import TestCase from course_modes.models import CourseMode, Mode @@ -18,7 +19,7 @@ class CourseModeModelTest(TestCase): """ def setUp(self): - self.course_id = 'TestCourse' + self.course_key = SlashSeparatedCourseKey('Test', 'TestCourse', 'TestCourseRun') CourseMode.objects.all().delete() def create_mode(self, mode_slug, mode_name, min_price=0, suggested_prices='', currency='usd'): @@ -26,7 +27,7 @@ class CourseModeModelTest(TestCase): Create a new course mode """ return CourseMode.objects.get_or_create( - course_id=self.course_id, + course_id=self.course_key, mode_display_name=mode_name, mode_slug=mode_slug, min_price=min_price, @@ -39,7 +40,7 @@ class CourseModeModelTest(TestCase): If we can't find any modes, we should get back the default mode """ # shouldn't be able to find a corresponding course - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) self.assertEqual([CourseMode.DEFAULT_MODE], modes) def test_nodes_for_course_single(self): @@ -48,13 +49,13 @@ class CourseModeModelTest(TestCase): """ self.create_mode('verified', 'Verified Certificate') - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) mode = Mode(u'verified', u'Verified Certificate', 0, '', 'usd', None) self.assertEqual([mode], modes) - modes_dict = CourseMode.modes_for_course_dict(self.course_id) + modes_dict = CourseMode.modes_for_course_dict(self.course_key) self.assertEqual(modes_dict['verified'], mode) - self.assertEqual(CourseMode.mode_for_course(self.course_id, 'verified'), + self.assertEqual(CourseMode.mode_for_course(self.course_key, 'verified'), mode) def test_modes_for_course_multiple(self): @@ -67,18 +68,18 @@ class CourseModeModelTest(TestCase): for mode in set_modes: self.create_mode(mode.slug, mode.name, mode.min_price, mode.suggested_prices) - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) self.assertEqual(modes, set_modes) - self.assertEqual(mode1, CourseMode.mode_for_course(self.course_id, u'honor')) - self.assertEqual(mode2, CourseMode.mode_for_course(self.course_id, u'verified')) - self.assertIsNone(CourseMode.mode_for_course(self.course_id, 'DNE')) + self.assertEqual(mode1, CourseMode.mode_for_course(self.course_key, u'honor')) + self.assertEqual(mode2, CourseMode.mode_for_course(self.course_key, u'verified')) + self.assertIsNone(CourseMode.mode_for_course(self.course_key, 'DNE')) def test_min_course_price_for_currency(self): """ Get the min course price for a course according to currency """ # no modes, should get 0 - self.assertEqual(0, CourseMode.min_course_price_for_currency(self.course_id, 'usd')) + self.assertEqual(0, CourseMode.min_course_price_for_currency(self.course_key, 'usd')) # create some modes mode1 = Mode(u'honor', u'Honor Code Certificate', 10, '', 'usd', None) @@ -88,27 +89,27 @@ class CourseModeModelTest(TestCase): for mode in set_modes: self.create_mode(mode.slug, mode.name, mode.min_price, mode.suggested_prices, mode.currency) - self.assertEqual(10, CourseMode.min_course_price_for_currency(self.course_id, 'usd')) - self.assertEqual(80, CourseMode.min_course_price_for_currency(self.course_id, 'cny')) + self.assertEqual(10, CourseMode.min_course_price_for_currency(self.course_key, 'usd')) + self.assertEqual(80, CourseMode.min_course_price_for_currency(self.course_key, 'cny')) def test_modes_for_course_expired(self): expired_mode, _status = self.create_mode('verified', 'Verified Certificate') expired_mode.expiration_datetime = datetime.now(pytz.UTC) + timedelta(days=-1) expired_mode.save() - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) self.assertEqual([CourseMode.DEFAULT_MODE], modes) mode1 = Mode(u'honor', u'Honor Code Certificate', 0, '', 'usd', None) self.create_mode(mode1.slug, mode1.name, mode1.min_price, mode1.suggested_prices) - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) self.assertEqual([mode1], modes) expiration_datetime = datetime.now(pytz.UTC) + timedelta(days=1) expired_mode.expiration_datetime = expiration_datetime expired_mode.save() expired_mode_value = Mode(u'verified', u'Verified Certificate', 0, '', 'usd', expiration_datetime) - modes = CourseMode.modes_for_course(self.course_id) + modes = CourseMode.modes_for_course(self.course_key) self.assertEqual([expired_mode_value, mode1], modes) - modes = CourseMode.modes_for_course('second_test_course') + modes = CourseMode.modes_for_course(SlashSeparatedCourseKey('TestOrg', 'TestCourse', 'TestRun')) self.assertEqual([CourseMode.DEFAULT_MODE], modes) diff --git a/common/djangoapps/course_modes/views.py b/common/djangoapps/course_modes/views.py index 8ca43a17bb..14bbac3036 100644 --- a/common/djangoapps/course_modes/views.py +++ b/common/djangoapps/course_modes/views.py @@ -20,6 +20,7 @@ from courseware.access import has_access from student.models import CourseEnrollment from student.views import course_from_id from verify_student.models import SoftwareSecurePhotoVerification +from xmodule.modulestore.locations import SlashSeparatedCourseKey class ChooseModeView(View): @@ -35,7 +36,9 @@ class ChooseModeView(View): def get(self, request, course_id, error=None): """ Displays the course mode choice page """ - enrollment_mode = CourseEnrollment.enrollment_mode_for_user(request.user, course_id) + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) + + enrollment_mode = CourseEnrollment.enrollment_mode_for_user(request.user, course_key) upgrade = request.GET.get('upgrade', False) request.session['attempting_upgrade'] = upgrade @@ -47,13 +50,13 @@ class ChooseModeView(View): if enrollment_mode is not None and upgrade is False: return redirect(reverse('dashboard')) - modes = CourseMode.modes_for_course_dict(course_id) + modes = CourseMode.modes_for_course_dict(course_key) donation_for_course = request.session.get("donation_for_course", {}) - chosen_price = donation_for_course.get(course_id, None) + chosen_price = donation_for_course.get(course_key, None) - course = course_from_id(course_id) + course = course_from_id(course_key) context = { - "course_id": course_id, + "course_modes_choose_url": reverse("course_modes_choose", kwargs={'course_id': course_key.to_deprecated_string()}), "modes": modes, "course_name": course.display_name_with_default, "course_org": course.display_org_with_default, @@ -72,25 +75,26 @@ class ChooseModeView(View): @method_decorator(login_required) def post(self, request, course_id): """ Takes the form submission from the page and parses it """ + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) user = request.user # This is a bit redundant with logic in student.views.change_enrollement, # but I don't really have the time to refactor it more nicely and test. - course = course_from_id(course_id) - if not has_access(user, course, 'enroll'): + course = course_from_id(course_key) + if not has_access(user, 'enroll', course): error_msg = _("Enrollment is closed") - return self.get(request, course_id, error=error_msg) + return self.get(request, course_key, error=error_msg) upgrade = request.GET.get('upgrade', False) requested_mode = self.get_requested_mode(request.POST) - allowed_modes = CourseMode.modes_for_course_dict(course_id) + allowed_modes = CourseMode.modes_for_course_dict(course_key) if requested_mode not in allowed_modes: return HttpResponseBadRequest(_("Enrollment mode not supported")) if requested_mode in ("audit", "honor"): - CourseEnrollment.enroll(user, course_id, requested_mode) + CourseEnrollment.enroll(user, course_key, requested_mode) return redirect('dashboard') mode_info = allowed_modes[requested_mode] @@ -104,25 +108,25 @@ class ChooseModeView(View): amount_value = decimal.Decimal(amount).quantize(decimal.Decimal('.01'), rounding=decimal.ROUND_DOWN) except decimal.InvalidOperation: error_msg = _("Invalid amount selected.") - return self.get(request, course_id, error=error_msg) + return self.get(request, course_key, error=error_msg) # Check for minimum pricing if amount_value < mode_info.min_price: error_msg = _("No selected price or selected price is too low.") - return self.get(request, course_id, error=error_msg) + return self.get(request, course_key, error=error_msg) donation_for_course = request.session.get("donation_for_course", {}) - donation_for_course[course_id] = amount_value + donation_for_course[course_key] = amount_value request.session["donation_for_course"] = donation_for_course if SoftwareSecurePhotoVerification.user_has_valid_or_pending(request.user): return redirect( reverse('verify_student_verified', - kwargs={'course_id': course_id}) + "?upgrade={}".format(upgrade) + kwargs={'course_id': course_key.to_deprecated_string()}) + "?upgrade={}".format(upgrade) ) return redirect( reverse('verify_student_show_requirements', - kwargs={'course_id': course_id}) + "?upgrade={}".format(upgrade)) + kwargs={'course_id': course_key.to_deprecated_string()}) + "?upgrade={}".format(upgrade)) def get_requested_mode(self, request_dict): """ diff --git a/common/djangoapps/django_comment_common/models.py b/common/djangoapps/django_comment_common/models.py index 0479b7ab28..67e33fb9eb 100644 --- a/common/djangoapps/django_comment_common/models.py +++ b/common/djangoapps/django_comment_common/models.py @@ -9,7 +9,8 @@ from django.utils.translation import ugettext_noop from student.models import CourseEnrollment from xmodule.modulestore.django import modulestore -from xmodule.course_module import CourseDescriptor +from xmodule.modulestore.exceptions import ItemNotFoundError +from xmodule_django.models import CourseKeyField, NoneToEmptyManager FORUM_ROLE_ADMINISTRATOR = ugettext_noop('Administrator') FORUM_ROLE_MODERATOR = ugettext_noop('Moderator') @@ -48,16 +49,20 @@ def assign_default_role(course_id, user): class Role(models.Model): + + objects = NoneToEmptyManager() + name = models.CharField(max_length=30, null=False, blank=False) users = models.ManyToManyField(User, related_name="roles") - course_id = models.CharField(max_length=255, blank=True, db_index=True) + course_id = CourseKeyField(max_length=255, blank=True, db_index=True) class Meta: # use existing table that was originally created from django_comment_client app db_table = 'django_comment_client_role' def __unicode__(self): - return self.name + " for " + (self.course_id if self.course_id else "all courses") + # pylint: disable=no-member + return self.name + " for " + (self.course_id.to_deprecated_string() if self.course_id else "all courses") def inherit_permissions(self, role): # TODO the name of this method is a little bit confusing, # since it's one-off and doesn't handle inheritance later @@ -71,8 +76,9 @@ class Role(models.Model): self.permissions.add(Permission.objects.get_or_create(name=permission)[0]) def has_permission(self, permission): - course_loc = CourseDescriptor.id_to_location(self.course_id) - course = modulestore().get_instance(self.course_id, course_loc) + course = modulestore().get_course(self.course_id) + if course is None: + raise ItemNotFoundError(self.course_id) if self.name == FORUM_ROLE_STUDENT and \ (permission.startswith('edit') or permission.startswith('update') or permission.startswith('create')) and \ (not course.forum_posts_allowed): diff --git a/common/djangoapps/django_comment_common/tests.py b/common/djangoapps/django_comment_common/tests.py index fd776c75d3..308a1c9390 100644 --- a/common/djangoapps/django_comment_common/tests.py +++ b/common/djangoapps/django_comment_common/tests.py @@ -1,5 +1,6 @@ from django.test import TestCase +from xmodule.modulestore.locations import SlashSeparatedCourseKey from django_comment_common.models import Role from student.models import CourseEnrollment, User @@ -21,13 +22,13 @@ class RoleAssignmentTest(TestCase): "hacky", "hacky@fake.edx.org" ) - self.course_id = "edX/Fake101/2012" - CourseEnrollment.enroll(self.staff_user, self.course_id) - CourseEnrollment.enroll(self.student_user, self.course_id) + self.course_key = SlashSeparatedCourseKey("edX", "Fake101", "2012") + CourseEnrollment.enroll(self.staff_user, self.course_key) + CourseEnrollment.enroll(self.student_user, self.course_key) def test_enrollment_auto_role_creation(self): student_role = Role.objects.get( - course_id=self.course_id, + course_id=self.course_key, name="Student" ) diff --git a/common/djangoapps/django_comment_common/utils.py b/common/djangoapps/django_comment_common/utils.py index 75da2453dc..9650401b65 100644 --- a/common/djangoapps/django_comment_common/utils.py +++ b/common/djangoapps/django_comment_common/utils.py @@ -10,27 +10,27 @@ _MODERATOR_ROLE_PERMISSIONS = ["edit_content", "delete_thread", "openclose_threa _ADMINISTRATOR_ROLE_PERMISSIONS = ["manage_moderator"] -def _save_forum_role(course_id, name): +def _save_forum_role(course_key, name): """ - Save and Update 'course_id' for all roles which are already created to keep course_id same - as actual passed course id + Save and Update 'course_key' for all roles which are already created to keep course_id same + as actual passed course key """ - role, created = Role.objects.get_or_create(name=name, course_id=course_id) + role, created = Role.objects.get_or_create(name=name, course_id=course_key) if created is False: - role.course_id = course_id + role.course_id = course_key role.save() return role -def seed_permissions_roles(course_id): +def seed_permissions_roles(course_key): """ Create and assign permissions for forum roles """ - administrator_role = _save_forum_role(course_id, "Administrator") - moderator_role = _save_forum_role(course_id, "Moderator") - community_ta_role = _save_forum_role(course_id, "Community TA") - student_role = _save_forum_role(course_id, "Student") + administrator_role = _save_forum_role(course_key, "Administrator") + moderator_role = _save_forum_role(course_key, "Moderator") + community_ta_role = _save_forum_role(course_key, "Community TA") + student_role = _save_forum_role(course_key, "Student") for per in _STUDENT_ROLE_PERMISSIONS: student_role.add_permission(per) diff --git a/common/djangoapps/embargo/forms.py b/common/djangoapps/embargo/forms.py index 09ea11445b..ce7a6a00da 100644 --- a/common/djangoapps/embargo/forms.py +++ b/common/djangoapps/embargo/forms.py @@ -10,6 +10,8 @@ from embargo.fixtures.country_codes import COUNTRY_CODES import socket from xmodule.modulestore.django import modulestore +from opaque_keys import InvalidKeyError +from xmodule.modulestore.locations import SlashSeparatedCourseKey class EmbargoedCourseForm(forms.ModelForm): # pylint: disable=incomplete-protocol @@ -20,19 +22,29 @@ class EmbargoedCourseForm(forms.ModelForm): # pylint: disable=incomplete-protoc def clean_course_id(self): """Validate the course id""" - course_id = self.cleaned_data["course_id"] + + cleaned_id = self.cleaned_data["course_id"] + + try: + course_id = SlashSeparatedCourseKey.from_deprecated_string(cleaned_id) + + except InvalidKeyError: + msg = 'COURSE NOT FOUND' + msg += u' --- Entered course id was: "{0}". '.format(cleaned_id) + msg += 'Please recheck that you have supplied a valid course id.' + raise forms.ValidationError(msg) # Try to get the course. If this returns None, it's not a real course try: course = modulestore().get_course(course_id) except ValueError: msg = 'COURSE NOT FOUND' - msg += u' --- Entered course id was: "{0}". '.format(course_id) + msg += u' --- Entered course id was: "{0}". '.format(course_id.to_deprecated_string()) msg += 'Please recheck that you have supplied a valid course id.' raise forms.ValidationError(msg) if not course: msg = 'COURSE NOT FOUND' - msg += u' --- Entered course id was: "{0}". '.format(course_id) + msg += u' --- Entered course id was: "{0}". '.format(course_id.to_deprecated_string()) msg += 'Please recheck that you have supplied a valid course id.' raise forms.ValidationError(msg) diff --git a/common/djangoapps/embargo/models.py b/common/djangoapps/embargo/models.py index 4ee6613859..fb85c34713 100644 --- a/common/djangoapps/embargo/models.py +++ b/common/djangoapps/embargo/models.py @@ -13,14 +13,17 @@ file and check it in at the same time as your model changes. To do that, from django.db import models from config_models.models import ConfigurationModel +from xmodule_django.models import CourseKeyField, NoneToEmptyManager class EmbargoedCourse(models.Model): """ Enable course embargo on a course-by-course basis. """ + objects = NoneToEmptyManager() + # The course to embargo - course_id = models.CharField(max_length=255, db_index=True, unique=True) + course_id = CourseKeyField(max_length=255, db_index=True, unique=True) # Whether or not to embargo embargoed = models.BooleanField(default=False) @@ -42,7 +45,8 @@ class EmbargoedCourse(models.Model): not_em = "Not " if self.embargoed: not_em = "" - return u"Course '{}' is {}Embargoed".format(self.course_id, not_em) + # pylint: disable=no-member + return u"Course '{}' is {}Embargoed".format(self.course_id.to_deprecated_string(), not_em) class EmbargoedState(ConfigurationModel): diff --git a/common/djangoapps/embargo/tests/test_forms.py b/common/djangoapps/embargo/tests/test_forms.py index cea030c23d..8dc5dbbb80 100644 --- a/common/djangoapps/embargo/tests/test_forms.py +++ b/common/djangoapps/embargo/tests/test_forms.py @@ -22,8 +22,8 @@ class EmbargoCourseFormTest(ModuleStoreTestCase): def setUp(self): self.course = CourseFactory.create() - self.true_form_data = {'course_id': self.course.id, 'embargoed': True} - self.false_form_data = {'course_id': self.course.id, 'embargoed': False} + self.true_form_data = {'course_id': self.course.id.to_deprecated_string(), 'embargoed': True} + self.false_form_data = {'course_id': self.course.id.to_deprecated_string(), 'embargoed': False} def test_embargo_course(self): self.assertFalse(EmbargoedCourse.is_embargoed(self.course.id)) @@ -62,7 +62,7 @@ class EmbargoCourseFormTest(ModuleStoreTestCase): def test_form_typo(self): # Munge course id - bad_id = self.course.id + '_typo' + bad_id = self.course.id.to_deprecated_string() + '_typo' form_data = {'course_id': bad_id, 'embargoed': True} form = EmbargoedCourseForm(data=form_data) @@ -79,7 +79,7 @@ class EmbargoCourseFormTest(ModuleStoreTestCase): def test_invalid_location(self): # Munge course id - bad_id = self.course.id.split('/')[-1] + bad_id = self.course.id.to_deprecated_string().split('/')[-1] form_data = {'course_id': bad_id, 'embargoed': True} form = EmbargoedCourseForm(data=form_data) diff --git a/common/djangoapps/embargo/tests/test_middleware.py b/common/djangoapps/embargo/tests/test_middleware.py index c3f418c905..cd09b2cbd9 100644 --- a/common/djangoapps/embargo/tests/test_middleware.py +++ b/common/djangoapps/embargo/tests/test_middleware.py @@ -32,8 +32,8 @@ class EmbargoMiddlewareTests(TestCase): self.embargo_course.save() self.regular_course = CourseFactory.create(org="Regular") self.regular_course.save() - self.embargoed_page = '/courses/' + self.embargo_course.id + '/info' - self.regular_page = '/courses/' + self.regular_course.id + '/info' + self.embargoed_page = '/courses/' + self.embargo_course.id.to_deprecated_string() + '/info' + self.regular_page = '/courses/' + self.regular_course.id.to_deprecated_string() + '/info' EmbargoedCourse(course_id=self.embargo_course.id, embargoed=True).save() EmbargoedState( embargoed_countries="cu, ir, Sy, SD", diff --git a/common/djangoapps/embargo/tests/test_models.py b/common/djangoapps/embargo/tests/test_models.py index 12c66295b8..37a8d48a2e 100644 --- a/common/djangoapps/embargo/tests/test_models.py +++ b/common/djangoapps/embargo/tests/test_models.py @@ -1,13 +1,14 @@ """Test of models for embargo middleware app""" from django.test import TestCase +from xmodule.modulestore.locations import SlashSeparatedCourseKey from embargo.models import EmbargoedCourse, EmbargoedState, IPFilter class EmbargoModelsTest(TestCase): """Test each of the 3 models in embargo.models""" def test_course_embargo(self): - course_id = 'abc/123/doremi' + course_id = SlashSeparatedCourseKey('abc', '123', 'doremi') # Test that course is not authorized by default self.assertFalse(EmbargoedCourse.is_embargoed(course_id)) diff --git a/common/djangoapps/external_auth/tests/test_shib.py b/common/djangoapps/external_auth/tests/test_shib.py index c8f38563de..0250ecc1a0 100644 --- a/common/djangoapps/external_auth/tests/test_shib.py +++ b/common/djangoapps/external_auth/tests/test_shib.py @@ -19,6 +19,7 @@ from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, mixed_store_config from xmodule.modulestore.inheritance import own_metadata from xmodule.modulestore.django import editable_modulestore +from xmodule.modulestore.locations import SlashSeparatedCourseKey from external_auth.models import ExternalAuthMap from external_auth.views import shib_login, course_specific_login, course_specific_register, _flatten_to_ascii @@ -340,8 +341,8 @@ class ShibSPTest(ModuleStoreTestCase): '?course_id=MITx/999/course/Robot_Super_Course' + '&enrollment_action=enroll') - login_response = course_specific_login(login_request, 'MITx/999/Robot_Super_Course') - reg_response = course_specific_register(login_request, 'MITx/999/Robot_Super_Course') + login_response = course_specific_login(login_request, SlashSeparatedCourseKey('MITx', '999', 'Robot_Super_Course')) + reg_response = course_specific_register(login_request, SlashSeparatedCourseKey('MITx', '999', 'Robot_Super_Course')) if "shib" in domain: self.assertIsInstance(login_response, HttpResponseRedirect) @@ -375,8 +376,8 @@ class ShibSPTest(ModuleStoreTestCase): '?course_id=DNE/DNE/DNE/Robot_Super_Course' + '&enrollment_action=enroll') - login_response = course_specific_login(login_request, 'DNE/DNE/DNE') - reg_response = course_specific_register(login_request, 'DNE/DNE/DNE') + login_response = course_specific_login(login_request, SlashSeparatedCourseKey('DNE', 'DNE', 'DNE')) + reg_response = course_specific_register(login_request, SlashSeparatedCourseKey('DNE', 'DNE', 'DNE')) self.assertIsInstance(login_response, HttpResponseRedirect) self.assertEqual(login_response['Location'], @@ -436,7 +437,7 @@ class ShibSPTest(ModuleStoreTestCase): for student in [shib_student, other_ext_student, int_student]: request = self.request_factory.post('/change_enrollment') request.POST.update({'enrollment_action': 'enroll', - 'course_id': course.id}) + 'course_id': course.id.to_deprecated_string()}) request.user = student response = change_enrollment(request) # If course is not limited or student has correct shib extauth then enrollment should be allowed @@ -476,7 +477,7 @@ class ShibSPTest(ModuleStoreTestCase): self.assertFalse(CourseEnrollment.is_enrolled(student, course.id)) self.client.logout() request_kwargs = {'path': '/shib-login/', - 'data': {'enrollment_action': 'enroll', 'course_id': course.id, 'next': '/testredirect'}, + 'data': {'enrollment_action': 'enroll', 'course_id': course.id.to_deprecated_string(), 'next': '/testredirect'}, 'follow': False, 'REMOTE_USER': 'testuser@stanford.edu', 'Shib-Identity-Provider': 'https://idp.stanford.edu/'} diff --git a/common/djangoapps/external_auth/tests/test_ssl.py b/common/djangoapps/external_auth/tests/test_ssl.py index cd9940bf7e..24d4dc3bd6 100644 --- a/common/djangoapps/external_auth/tests/test_ssl.py +++ b/common/djangoapps/external_auth/tests/test_ssl.py @@ -3,8 +3,6 @@ Provides unit tests for SSL based authentication portions of the external_auth app. """ -import logging -import StringIO import unittest from django.conf import settings @@ -22,7 +20,7 @@ from edxmako.middleware import MakoMiddleware from external_auth.models import ExternalAuthMap import external_auth.views from student.tests.factories import UserFactory -from xmodule.modulestore.exceptions import InsufficientSpecificationError +from opaque_keys import InvalidKeyError FEATURES_WITH_SSL_AUTH = settings.FEATURES.copy() FEATURES_WITH_SSL_AUTH['AUTH_USE_CERTIFICATES'] = True @@ -193,18 +191,23 @@ class SSLClientTest(TestCase): This tests to make sure when immediate signup is on that the user doesn't get presented with the registration page. """ - # Expect a NotImplementError from course page as we don't have anything else built - with self.assertRaisesRegexp(InsufficientSpecificationError, - 'Must provide one of url, version_guid, package_id'): + # Expect an InvalidKeyError from course page as we don't have anything else built + with self.assertRaisesRegexp( + InvalidKeyError, + ": None" + ): self.client.get( reverse('signup'), follow=True, - SSL_CLIENT_S_DN=self.AUTH_DN.format(self.USER_NAME, self.USER_EMAIL)) + SSL_CLIENT_S_DN=self.AUTH_DN.format(self.USER_NAME, self.USER_EMAIL) + ) # assert that we are logged in self.assertIn(SESSION_KEY, self.client.session) # Now that we are logged in, make sure we don't see the registration page - with self.assertRaisesRegexp(InsufficientSpecificationError, - 'Must provide one of url, version_guid, package_id'): + with self.assertRaisesRegexp( + InvalidKeyError, + ": None" + ): self.client.get(reverse('signup'), follow=True) @unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms') @@ -228,7 +231,6 @@ class SSLClientTest(TestCase): self.assertIn(reverse('dashboard'), response['location']) self.assertIn(SESSION_KEY, self.client.session) - @unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms') @override_settings(FEATURES=FEATURES_WITH_SSL_AUTH_IMMEDIATE_SIGNUP) def test_ssl_bad_eamap(self): diff --git a/common/djangoapps/external_auth/views.py b/common/djangoapps/external_auth/views.py index 0f3baf7b92..5a88a5a019 100644 --- a/common/djangoapps/external_auth/views.py +++ b/common/djangoapps/external_auth/views.py @@ -576,9 +576,8 @@ def course_specific_login(request, course_id): Dispatcher function for selecting the specific login method required by the course """ - try: - course = course_from_id(course_id) - except ItemNotFoundError: + course = student.views.course_from_id(course_id) + if not course: # couldn't find the course, will just return vanilla signin page return _redirect_with_get_querydict('signin_user', request.GET) @@ -595,9 +594,9 @@ def course_specific_register(request, course_id): Dispatcher function for selecting the specific registration method required by the course """ - try: - course = course_from_id(course_id) - except ItemNotFoundError: + course = student.views.course_from_id(course_id) + + if not course: # couldn't find the course, will just return vanilla registration page return _redirect_with_get_querydict('register_user', request.GET) @@ -934,9 +933,3 @@ def provider_xrds(request): # custom XRDS header necessary for discovery process response['X-XRDS-Location'] = get_xrds_url('xrds', request) return response - - -def course_from_id(course_id): - """Return the CourseDescriptor corresponding to this course_id""" - course_loc = CourseDescriptor.id_to_location(course_id) - return modulestore().get_instance(course_id, course_loc) diff --git a/common/djangoapps/heartbeat/views.py b/common/djangoapps/heartbeat/views.py index 0cee7116b4..9825436e7e 100644 --- a/common/djangoapps/heartbeat/views.py +++ b/common/djangoapps/heartbeat/views.py @@ -13,6 +13,6 @@ def heartbeat(request): """ output = { 'date': datetime.now(UTC).isoformat(), - 'courses': [course.location.url() for course in modulestore().get_courses()], + 'courses': [course.location.to_deprecated_string() for course in modulestore().get_courses()], } return HttpResponse(json.dumps(output, indent=4)) diff --git a/common/djangoapps/reverification/models.py b/common/djangoapps/reverification/models.py index 53b2b659c9..c7a07ee19a 100644 --- a/common/djangoapps/reverification/models.py +++ b/common/djangoapps/reverification/models.py @@ -7,6 +7,7 @@ import pytz from django.core.exceptions import ValidationError from django.db import models from util.validate_on_save import ValidateOnSaveMixin +from xmodule_django.models import CourseKeyField class MidcourseReverificationWindow(ValidateOnSaveMixin, models.Model): @@ -17,7 +18,7 @@ class MidcourseReverificationWindow(ValidateOnSaveMixin, models.Model): overlapping time ranges. This is enforced by this class's clean() method. """ # the course that this window is attached to - course_id = models.CharField(max_length=255, db_index=True) + course_id = CourseKeyField(max_length=255, db_index=True) start_date = models.DateTimeField(default=None, null=True, blank=True) end_date = models.DateTimeField(default=None, null=True, blank=True) diff --git a/common/djangoapps/reverification/tests/factories.py b/common/djangoapps/reverification/tests/factories.py index 5a0452b7f7..65669c6b08 100644 --- a/common/djangoapps/reverification/tests/factories.py +++ b/common/djangoapps/reverification/tests/factories.py @@ -5,6 +5,7 @@ from reverification.models import MidcourseReverificationWindow from factory.django import DjangoModelFactory import pytz from datetime import timedelta, datetime +from xmodule.modulestore.locations import SlashSeparatedCourseKey # Factories don't have __init__ methods, and are self documenting @@ -13,7 +14,7 @@ class MidcourseReverificationWindowFactory(DjangoModelFactory): """ Creates a generic MidcourseReverificationWindow. """ FACTORY_FOR = MidcourseReverificationWindow - course_id = u'MITx/999/Robot_Super_Course' + course_id = SlashSeparatedCourseKey.from_deprecated_string(u'MITx/999/Robot_Super_Course') # By default this factory creates a window that is currently open start_date = datetime.now(pytz.UTC) - timedelta(days=100) end_date = datetime.now(pytz.UTC) + timedelta(days=100) diff --git a/common/djangoapps/static_replace/__init__.py b/common/djangoapps/static_replace/__init__.py index 29dcf7455b..56f31b2e36 100644 --- a/common/djangoapps/static_replace/__init__.py +++ b/common/djangoapps/static_replace/__init__.py @@ -72,7 +72,7 @@ def replace_jump_to_id_urls(text, course_id, jump_to_id_base_url): return re.sub(_url_replace_regex('/jump_to_id/'), replace_jump_to_id_url, text) -def replace_course_urls(text, course_id): +def replace_course_urls(text, course_key): """ Replace /course/$stuff urls with /courses/$course_id/$stuff urls @@ -82,6 +82,8 @@ def replace_course_urls(text, course_id): returns: text with the links replaced """ + course_id = course_key.to_deprecated_string() + def replace_course_url(match): quote = match.group('quote') rest = match.group('rest') diff --git a/common/djangoapps/static_replace/test/test_static_replace.py b/common/djangoapps/static_replace/test/test_static_replace.py index 1e7521c3a9..d631b1ffe8 100644 --- a/common/djangoapps/static_replace/test/test_static_replace.py +++ b/common/djangoapps/static_replace/test/test_static_replace.py @@ -4,12 +4,13 @@ from nose.tools import assert_equals, assert_true, assert_false # pylint: disab from static_replace import (replace_static_urls, replace_course_urls, _url_replace_regex) from mock import patch, Mock -from xmodule.modulestore import Location + +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.modulestore.mongo import MongoModuleStore from xmodule.modulestore.xml import XMLModuleStore DATA_DIRECTORY = 'data_dir' -COURSE_ID = 'org/course/run' +COURSE_KEY = SlashSeparatedCourseKey('org', 'course', 'run') STATIC_SOURCE = '"/static/file.png"' @@ -21,8 +22,8 @@ def test_multi_replace(): replace_static_urls(replace_static_urls(STATIC_SOURCE, DATA_DIRECTORY), DATA_DIRECTORY) ) assert_equals( - replace_course_urls(course_source, COURSE_ID), - replace_course_urls(replace_course_urls(course_source, COURSE_ID), COURSE_ID) + replace_course_urls(course_source, COURSE_KEY), + replace_course_urls(replace_course_urls(course_source, COURSE_KEY), COURSE_KEY) ) @@ -59,10 +60,10 @@ def test_mongo_filestore(mock_modulestore, mock_static_content): # Namespace => content url assert_equals( '"' + mock_static_content.convert_legacy_static_url_with_course_id.return_value + '"', - replace_static_urls(STATIC_SOURCE, DATA_DIRECTORY, course_id=COURSE_ID) + replace_static_urls(STATIC_SOURCE, DATA_DIRECTORY, course_id=COURSE_KEY) ) - mock_static_content.convert_legacy_static_url_with_course_id.assert_called_once_with('file.png', COURSE_ID) + mock_static_content.convert_legacy_static_url_with_course_id.assert_called_once_with('file.png', COURSE_KEY) @patch('static_replace.settings') @@ -101,7 +102,7 @@ def test_static_url_with_query(mock_modulestore, mock_storage): pre_text = 'EMBED src ="/static/LAlec04_controller.swf?csConfigFile=/c4x/org/course/asset/LAlec04_config.xml"' post_text = 'EMBED src ="/c4x/org/course/asset/LAlec04_controller.swf?csConfigFile=/c4x/org/course/asset/LAlec04_config.xml"' - assert_equals(post_text, replace_static_urls(pre_text, DATA_DIRECTORY, COURSE_ID)) + assert_equals(post_text, replace_static_urls(pre_text, DATA_DIRECTORY, COURSE_KEY)) def test_regex(): diff --git a/common/djangoapps/student/auth.py b/common/djangoapps/student/auth.py index 97583f69dc..505ad9d4da 100644 --- a/common/djangoapps/student/auth.py +++ b/common/djangoapps/student/auth.py @@ -35,7 +35,7 @@ def has_access(user, role): return True # if not, then check inferred permissions if (isinstance(role, (CourseStaffRole, CourseBetaTesterRole)) and - CourseInstructorRole(role.location).has_user(user)): + CourseInstructorRole(role.course_key).has_user(user)): return True return False @@ -81,6 +81,6 @@ def _check_caller_authority(caller, role): if isinstance(role, (GlobalStaff, CourseCreatorRole)): raise PermissionDenied elif isinstance(role, CourseRole): # instructors can change the roles w/in their course - if not has_access(caller, CourseInstructorRole(role.location)): + if not has_access(caller, CourseInstructorRole(role.course_key)): raise PermissionDenied diff --git a/common/djangoapps/student/management/commands/anonymized_id_mapping.py b/common/djangoapps/student/management/commands/anonymized_id_mapping.py index d27c306d8d..75b61e45ba 100644 --- a/common/djangoapps/student/management/commands/anonymized_id_mapping.py +++ b/common/djangoapps/student/management/commands/anonymized_id_mapping.py @@ -59,7 +59,7 @@ class Command(BaseCommand): for student in students: csv_writer.writerow(( student.id, - anonymous_id_for_user(student, ''), + anonymous_id_for_user(student, None), anonymous_id_for_user(student, course_id) )) except IOError: diff --git a/common/djangoapps/student/management/commands/create_user.py b/common/djangoapps/student/management/commands/create_user.py index bf848004ce..9ba00cabda 100644 --- a/common/djangoapps/student/management/commands/create_user.py +++ b/common/djangoapps/student/management/commands/create_user.py @@ -5,6 +5,9 @@ from django.contrib.auth.models import User from django.core.management.base import BaseCommand from django.utils import translation +from opaque_keys import InvalidKeyError +from xmodule.modulestore.keys import CourseKey +from xmodule.modulestore.locations import SlashSeparatedCourseKey from student.models import CourseEnrollment, Registration, create_comments_service_user from student.views import _do_create_account, AccountValidationError from track.management.tracked_command import TrackedCommand @@ -68,6 +71,15 @@ class Command(TrackedCommand): if not name: name = options['email'].split('@')[0] + # parse out the course into a coursekey + if options['course']: + try: + course = CourseKey.from_string(options['course']) + # if it's not a new-style course key, parse it from an old-style + # course key + except InvalidKeyError: + course = SlashSeparatedCourseKey.from_deprecated_string(options['course']) + post_data = { 'username': username, 'email': options['email'], @@ -93,5 +105,5 @@ class Command(TrackedCommand): print e.message user = User.objects.get(email=options['email']) if options['course']: - CourseEnrollment.enroll(user, options['course'], mode=options['mode']) + CourseEnrollment.enroll(user, course, mode=options['mode']) translation.deactivate() diff --git a/common/djangoapps/student/migrations/0034_auto__add_courseaccessrole.py b/common/djangoapps/student/migrations/0034_auto__add_courseaccessrole.py new file mode 100644 index 0000000000..d6267ecb01 --- /dev/null +++ b/common/djangoapps/student/migrations/0034_auto__add_courseaccessrole.py @@ -0,0 +1,189 @@ +# -*- coding: utf-8 -*- +import datetime +from south.db import db +from south.v2 import SchemaMigration +from django.db import models + + +class Migration(SchemaMigration): + + def forwards(self, orm): + # Adding model 'CourseAccessRole' + db.create_table('student_courseaccessrole', ( + ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)), + ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['auth.User'])), + ('org', self.gf('django.db.models.fields.CharField')(db_index=True, max_length=64, blank=True)), + ('course_id', self.gf('xmodule_django.models.CourseKeyField')(db_index=True, max_length=255, blank=True)), + ('role', self.gf('django.db.models.fields.CharField')(max_length=64, db_index=True)), + )) + db.send_create_signal('student', ['CourseAccessRole']) + + # Adding unique constraint on 'CourseAccessRole', fields ['user', 'org', 'course_id', 'role'] + db.create_unique('student_courseaccessrole', ['user_id', 'org', 'course_id', 'role']) + + + # Changing field 'AnonymousUserId.course_id' + db.alter_column('student_anonymoususerid', 'course_id', self.gf('xmodule_django.models.CourseKeyField')(max_length=255)) + + # Changing field 'CourseEnrollment.course_id' + db.alter_column('student_courseenrollment', 'course_id', self.gf('xmodule_django.models.CourseKeyField')(max_length=255)) + + # Changing field 'CourseEnrollmentAllowed.course_id' + db.alter_column('student_courseenrollmentallowed', 'course_id', self.gf('xmodule_django.models.CourseKeyField')(max_length=255)) + + def backwards(self, orm): + # Removing unique constraint on 'CourseAccessRole', fields ['user', 'org', 'course_id', 'role'] + db.delete_unique('student_courseaccessrole', ['user_id', 'org', 'course_id', 'role']) + + # Deleting model 'CourseAccessRole' + db.delete_table('student_courseaccessrole') + + + # Changing field 'AnonymousUserId.course_id' + db.alter_column('student_anonymoususerid', 'course_id', self.gf('django.db.models.fields.CharField')(max_length=255)) + + # Changing field 'CourseEnrollment.course_id' + db.alter_column('student_courseenrollment', 'course_id', self.gf('django.db.models.fields.CharField')(max_length=255)) + + # Changing field 'CourseEnrollmentAllowed.course_id' + db.alter_column('student_courseenrollmentallowed', 'course_id', self.gf('django.db.models.fields.CharField')(max_length=255)) + + models = { + 'auth.group': { + 'Meta': {'object_name': 'Group'}, + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}), + 'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}) + }, + 'auth.permission': { + 'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'}, + 'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '50'}) + }, + 'auth.user': { + 'Meta': {'object_name': 'User'}, + 'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}), + 'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}), + 'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}), + 'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'}) + }, + 'contenttypes.contenttype': { + 'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"}, + 'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}) + }, + 'student.anonymoususerid': { + 'Meta': {'object_name': 'AnonymousUserId'}, + 'anonymous_user_id': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '32'}), + 'course_id': ('xmodule_django.models.CourseKeyField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}) + }, + 'student.courseaccessrole': { + 'Meta': {'unique_together': "(('user', 'org', 'course_id', 'role'),)", 'object_name': 'CourseAccessRole'}, + 'course_id': ('xmodule_django.models.CourseKeyField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'org': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '64', 'blank': 'True'}), + 'role': ('django.db.models.fields.CharField', [], {'max_length': '64', 'db_index': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}) + }, + 'student.courseenrollment': { + 'Meta': {'ordering': "('user', 'course_id')", 'unique_together': "(('user', 'course_id'),)", 'object_name': 'CourseEnrollment'}, + 'course_id': ('xmodule_django.models.CourseKeyField', [], {'max_length': '255', 'db_index': 'True'}), + 'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'null': 'True', 'db_index': 'True', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'mode': ('django.db.models.fields.CharField', [], {'default': "'honor'", 'max_length': '100'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}) + }, + 'student.courseenrollmentallowed': { + 'Meta': {'unique_together': "(('email', 'course_id'),)", 'object_name': 'CourseEnrollmentAllowed'}, + 'auto_enroll': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'course_id': ('xmodule_django.models.CourseKeyField', [], {'max_length': '255', 'db_index': 'True'}), + 'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'null': 'True', 'db_index': 'True', 'blank': 'True'}), + 'email': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}) + }, + 'student.loginfailures': { + 'Meta': {'object_name': 'LoginFailures'}, + 'failure_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'lockout_until': ('django.db.models.fields.DateTimeField', [], {'null': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}) + }, + 'student.passwordhistory': { + 'Meta': {'object_name': 'PasswordHistory'}, + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}), + 'time_set': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}) + }, + 'student.pendingemailchange': { + 'Meta': {'object_name': 'PendingEmailChange'}, + 'activation_key': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '32', 'db_index': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'new_email': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'user': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['auth.User']", 'unique': 'True'}) + }, + 'student.pendingnamechange': { + 'Meta': {'object_name': 'PendingNameChange'}, + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'new_name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}), + 'rationale': ('django.db.models.fields.CharField', [], {'max_length': '1024', 'blank': 'True'}), + 'user': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['auth.User']", 'unique': 'True'}) + }, + 'student.registration': { + 'Meta': {'object_name': 'Registration', 'db_table': "'auth_registration'"}, + 'activation_key': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '32', 'db_index': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']", 'unique': 'True'}) + }, + 'student.userprofile': { + 'Meta': {'object_name': 'UserProfile', 'db_table': "'auth_userprofile'"}, + 'allow_certificate': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'city': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}), + 'country': ('django_countries.fields.CountryField', [], {'max_length': '2', 'null': 'True', 'blank': 'True'}), + 'courseware': ('django.db.models.fields.CharField', [], {'default': "'course.xml'", 'max_length': '255', 'blank': 'True'}), + 'gender': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '6', 'null': 'True', 'blank': 'True'}), + 'goals': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'language': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'level_of_education': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '6', 'null': 'True', 'blank': 'True'}), + 'location': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'mailing_address': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}), + 'meta': ('django.db.models.fields.TextField', [], {'blank': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'user': ('django.db.models.fields.related.OneToOneField', [], {'related_name': "'profile'", 'unique': 'True', 'to': "orm['auth.User']"}), + 'year_of_birth': ('django.db.models.fields.IntegerField', [], {'db_index': 'True', 'null': 'True', 'blank': 'True'}) + }, + 'student.userstanding': { + 'Meta': {'object_name': 'UserStanding'}, + 'account_status': ('django.db.models.fields.CharField', [], {'max_length': '31', 'blank': 'True'}), + 'changed_by': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']", 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'standing_last_changed_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'standing'", 'unique': 'True', 'to': "orm['auth.User']"}) + }, + 'student.usertestgroup': { + 'Meta': {'object_name': 'UserTestGroup'}, + 'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '32', 'db_index': 'True'}), + 'users': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.User']", 'db_index': 'True', 'symmetrical': 'False'}) + } + } + + complete_apps = ['student'] \ No newline at end of file diff --git a/common/djangoapps/student/tests/test_authz.py b/common/djangoapps/student/tests/test_authz.py index dee2eb84f4..0d6929c190 100644 --- a/common/djangoapps/student/tests/test_authz.py +++ b/common/djangoapps/student/tests/test_authz.py @@ -5,12 +5,12 @@ import mock from django.test import TestCase from django.contrib.auth.models import User, AnonymousUser -from xmodule.modulestore import Location from django.core.exceptions import PermissionDenied from student.roles import CourseInstructorRole, CourseStaffRole, CourseCreatorRole from student.tests.factories import AdminFactory from student.auth import has_access, add_users, remove_users +from xmodule.modulestore.locations import SlashSeparatedCourseKey class CreatorGroupTest(TestCase): @@ -137,54 +137,54 @@ class CourseGroupTest(TestCase): self.global_admin = AdminFactory() self.creator = User.objects.create_user('testcreator', 'testcreator+courses@edx.org', 'foo') self.staff = User.objects.create_user('teststaff', 'teststaff+courses@edx.org', 'foo') - self.location = Location('i4x', 'mitX', '101', 'course', 'test') + self.course_key = SlashSeparatedCourseKey('mitX', '101', 'test') def test_add_user_to_course_group(self): """ Tests adding user to course group (happy path). """ # Create groups for a new course (and assign instructor role to the creator). - self.assertFalse(has_access(self.creator, CourseInstructorRole(self.location))) - add_users(self.global_admin, CourseInstructorRole(self.location), self.creator) - add_users(self.global_admin, CourseStaffRole(self.location), self.creator) - self.assertTrue(has_access(self.creator, CourseInstructorRole(self.location))) + self.assertFalse(has_access(self.creator, CourseInstructorRole(self.course_key))) + add_users(self.global_admin, CourseInstructorRole(self.course_key), self.creator) + add_users(self.global_admin, CourseStaffRole(self.course_key), self.creator) + self.assertTrue(has_access(self.creator, CourseInstructorRole(self.course_key))) # Add another user to the staff role. - self.assertFalse(has_access(self.staff, CourseStaffRole(self.location))) - add_users(self.creator, CourseStaffRole(self.location), self.staff) - self.assertTrue(has_access(self.staff, CourseStaffRole(self.location))) + self.assertFalse(has_access(self.staff, CourseStaffRole(self.course_key))) + add_users(self.creator, CourseStaffRole(self.course_key), self.staff) + self.assertTrue(has_access(self.staff, CourseStaffRole(self.course_key))) def test_add_user_to_course_group_permission_denied(self): """ Verifies PermissionDenied if caller of add_user_to_course_group is not instructor role. """ - add_users(self.global_admin, CourseInstructorRole(self.location), self.creator) - add_users(self.global_admin, CourseStaffRole(self.location), self.creator) + add_users(self.global_admin, CourseInstructorRole(self.course_key), self.creator) + add_users(self.global_admin, CourseStaffRole(self.course_key), self.creator) with self.assertRaises(PermissionDenied): - add_users(self.staff, CourseStaffRole(self.location), self.staff) + add_users(self.staff, CourseStaffRole(self.course_key), self.staff) def test_remove_user_from_course_group(self): """ Tests removing user from course group (happy path). """ - add_users(self.global_admin, CourseInstructorRole(self.location), self.creator) - add_users(self.global_admin, CourseStaffRole(self.location), self.creator) + add_users(self.global_admin, CourseInstructorRole(self.course_key), self.creator) + add_users(self.global_admin, CourseStaffRole(self.course_key), self.creator) - add_users(self.creator, CourseStaffRole(self.location), self.staff) - self.assertTrue(has_access(self.staff, CourseStaffRole(self.location))) + add_users(self.creator, CourseStaffRole(self.course_key), self.staff) + self.assertTrue(has_access(self.staff, CourseStaffRole(self.course_key))) - remove_users(self.creator, CourseStaffRole(self.location), self.staff) - self.assertFalse(has_access(self.staff, CourseStaffRole(self.location))) + remove_users(self.creator, CourseStaffRole(self.course_key), self.staff) + self.assertFalse(has_access(self.staff, CourseStaffRole(self.course_key))) - remove_users(self.creator, CourseInstructorRole(self.location), self.creator) - self.assertFalse(has_access(self.creator, CourseInstructorRole(self.location))) + remove_users(self.creator, CourseInstructorRole(self.course_key), self.creator) + self.assertFalse(has_access(self.creator, CourseInstructorRole(self.course_key))) def test_remove_user_from_course_group_permission_denied(self): """ Verifies PermissionDenied if caller of remove_user_from_course_group is not instructor role. """ - add_users(self.global_admin, CourseInstructorRole(self.location), self.creator) + add_users(self.global_admin, CourseInstructorRole(self.course_key), self.creator) another_staff = User.objects.create_user('another', 'teststaff+anothercourses@edx.org', 'foo') - add_users(self.global_admin, CourseStaffRole(self.location), self.creator, self.staff, another_staff) + add_users(self.global_admin, CourseStaffRole(self.course_key), self.creator, self.staff, another_staff) with self.assertRaises(PermissionDenied): - remove_users(self.staff, CourseStaffRole(self.location), another_staff) + remove_users(self.staff, CourseStaffRole(self.course_key), another_staff) diff --git a/common/djangoapps/student/tests/test_auto_auth.py b/common/djangoapps/student/tests/test_auto_auth.py index 6783412743..6228962d0b 100644 --- a/common/djangoapps/student/tests/test_auto_auth.py +++ b/common/djangoapps/student/tests/test_auto_auth.py @@ -6,6 +6,7 @@ from django_comment_common.models import ( from django_comment_common.utils import seed_permissions_roles from student.models import CourseEnrollment, UserProfile from util.testing import UrlResetMixin +from xmodule.modulestore.locations import SlashSeparatedCourseKey from mock import patch @@ -23,6 +24,8 @@ class AutoAuthEnabledTestCase(UrlResetMixin, TestCase): super(AutoAuthEnabledTestCase, self).setUp() self.url = '/auto_auth' self.client = Client() + self.course_id = 'edX/Test101/2014_Spring' + self.course_key = SlashSeparatedCourseKey.from_deprecated_string(self.course_id) def test_create_user(self): """ @@ -83,43 +86,39 @@ class AutoAuthEnabledTestCase(UrlResetMixin, TestCase): def test_course_enrollment(self): # Create a user and enroll in a course - course_id = "edX/Test101/2014_Spring" - self._auto_auth(username='test', course_id=course_id) + self._auto_auth(username='test', course_id=self.course_id) # Check that a course enrollment was created for the user self.assertEqual(CourseEnrollment.objects.count(), 1) - enrollment = CourseEnrollment.objects.get(course_id=course_id) + enrollment = CourseEnrollment.objects.get(course_id=self.course_key) self.assertEqual(enrollment.user.username, "test") def test_double_enrollment(self): # Create a user and enroll in a course - course_id = "edX/Test101/2014_Spring" - self._auto_auth(username='test', course_id=course_id) + self._auto_auth(username='test', course_id=self.course_id) # Make the same call again, re-enrolling the student in the same course - self._auto_auth(username='test', course_id=course_id) + self._auto_auth(username='test', course_id=self.course_id) # Check that only one course enrollment was created for the user self.assertEqual(CourseEnrollment.objects.count(), 1) - enrollment = CourseEnrollment.objects.get(course_id=course_id) + enrollment = CourseEnrollment.objects.get(course_id=self.course_key) self.assertEqual(enrollment.user.username, "test") def test_set_roles(self): - - course_id = "edX/Test101/2014_Spring" - seed_permissions_roles(course_id) - course_roles = dict((r.name, r) for r in Role.objects.filter(course_id=course_id)) + seed_permissions_roles(self.course_key) + course_roles = dict((r.name, r) for r in Role.objects.filter(course_id=self.course_key)) self.assertEqual(len(course_roles), 4) # sanity check # Student role is assigned by default on course enrollment. - self._auto_auth(username='a_student', course_id=course_id) + self._auto_auth(username='a_student', course_id=self.course_id) user = User.objects.get(username='a_student') user_roles = user.roles.all() self.assertEqual(len(user_roles), 1) self.assertEqual(user_roles[0], course_roles[FORUM_ROLE_STUDENT]) - self._auto_auth(username='a_moderator', course_id=course_id, roles='Moderator') + self._auto_auth(username='a_moderator', course_id=self.course_id, roles='Moderator') user = User.objects.get(username='a_moderator') user_roles = user.roles.all() self.assertEqual( @@ -128,7 +127,7 @@ class AutoAuthEnabledTestCase(UrlResetMixin, TestCase): course_roles[FORUM_ROLE_MODERATOR]])) # check multiple roles work. - self._auto_auth(username='an_admin', course_id=course_id, + self._auto_auth(username='an_admin', course_id=self.course_id, roles='{},{}'.format(FORUM_ROLE_MODERATOR, FORUM_ROLE_ADMINISTRATOR)) user = User.objects.get(username='an_admin') user_roles = user.roles.all() diff --git a/common/djangoapps/student/tests/test_bulk_email_settings.py b/common/djangoapps/student/tests/test_bulk_email_settings.py index 6b903d9979..f164aea761 100644 --- a/common/djangoapps/student/tests/test_bulk_email_settings.py +++ b/common/djangoapps/student/tests/test_bulk_email_settings.py @@ -15,6 +15,7 @@ from student.tests.factories import UserFactory, CourseEnrollmentFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE +from xmodule.modulestore.locations import SlashSeparatedCourseKey from bulk_email.models import CourseAuthorization @@ -100,7 +101,10 @@ class TestStudentDashboardEmailViewXMLBacked(ModuleStoreTestCase): # Create student account student = UserFactory.create() - CourseEnrollmentFactory.create(user=student, course_id=self.course_name) + CourseEnrollmentFactory.create( + user=student, + course_id=SlashSeparatedCourseKey.from_deprecated_string(self.course_name) + ) self.client.login(username=student.username, password="test") try: diff --git a/common/djangoapps/student/tests/test_login.py b/common/djangoapps/student/tests/test_login.py index 34083c90b4..00fc67282a 100644 --- a/common/djangoapps/student/tests/test_login.py +++ b/common/djangoapps/student/tests/test_login.py @@ -20,6 +20,7 @@ from xmodule.modulestore.inheritance import own_metadata from xmodule.modulestore.django import editable_modulestore from external_auth.models import ExternalAuthMap +from xmodule.modulestore.locations import SlashSeparatedCourseKey TEST_DATA_MIXED_MODULESTORE = mixed_store_config(settings.COMMON_TEST_DATA_ROOT, {}) @@ -275,7 +276,10 @@ class UtilFnTest(TestCase): COURSE_ID = u'org/num/run' # pylint: disable=C0103 COURSE_URL = u'/courses/{}/otherstuff'.format(COURSE_ID) # pylint: disable=C0103 NON_COURSE_URL = u'/blahblah' # pylint: disable=C0103 - self.assertEqual(_parse_course_id_from_string(COURSE_URL), COURSE_ID) + self.assertEqual( + _parse_course_id_from_string(COURSE_URL), + SlashSeparatedCourseKey.from_deprecated_string(COURSE_ID) + ) self.assertIsNone(_parse_course_id_from_string(NON_COURSE_URL)) @@ -320,7 +324,7 @@ class ExternalAuthShibTest(ModuleStoreTestCase): """ Tests the _get_course_enrollment_domain utility function """ - self.assertIsNone(_get_course_enrollment_domain("I/DONT/EXIST")) + self.assertIsNone(_get_course_enrollment_domain(SlashSeparatedCourseKey("I", "DONT", "EXIST"))) self.assertIsNone(_get_course_enrollment_domain(self.course.id)) self.assertEqual(self.shib_course.enrollment_domain, _get_course_enrollment_domain(self.shib_course.id)) @@ -340,7 +344,7 @@ class ExternalAuthShibTest(ModuleStoreTestCase): Tests the redirects when visiting course-specific URL with @login_required. Should vary by course depending on its enrollment_domain """ - TARGET_URL = reverse('courseware', args=[self.course.id]) # pylint: disable=C0103 + TARGET_URL = reverse('courseware', args=[self.course.id.to_deprecated_string()]) # pylint: disable=C0103 noshib_response = self.client.get(TARGET_URL, follow=True) self.assertEqual(noshib_response.redirect_chain[-1], ('http://testserver/accounts/login?next={url}'.format(url=TARGET_URL), 302)) @@ -348,7 +352,7 @@ class ExternalAuthShibTest(ModuleStoreTestCase): .format(platform_name=settings.PLATFORM_NAME))) self.assertEqual(noshib_response.status_code, 200) - TARGET_URL_SHIB = reverse('courseware', args=[self.shib_course.id]) # pylint: disable=C0103 + TARGET_URL_SHIB = reverse('courseware', args=[self.shib_course.id.to_deprecated_string()]) # pylint: disable=C0103 shib_response = self.client.get(**{'path': TARGET_URL_SHIB, 'follow': True, 'REMOTE_USER': self.extauth.external_id, diff --git a/common/djangoapps/student/tests/test_userstanding.py b/common/djangoapps/student/tests/test_userstanding.py index 19fe957ab7..c6f9cdcbc7 100644 --- a/common/djangoapps/student/tests/test_userstanding.py +++ b/common/djangoapps/student/tests/test_userstanding.py @@ -53,7 +53,7 @@ class UserStandingTest(TestCase): try: self.some_url = reverse('dashboard') except NoReverseMatch: - self.some_url = '/course' + self.some_url = '/course/' # since it's only possible to disable accounts from lms, we're going # to skip tests for cms diff --git a/common/djangoapps/student/views.py b/common/djangoapps/student/views.py index 34c30c4503..61affc3d1f 100644 --- a/common/djangoapps/student/views.py +++ b/common/djangoapps/student/views.py @@ -55,6 +55,7 @@ from dark_lang.models import DarkLangConfig from xmodule.course_module import CourseDescriptor from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.modulestore.django import modulestore +from xmodule.modulestore.locations import SlashSeparatedCourseKey from xmodule.modulestore import XML_MODULESTORE_TYPE, Location from collections import namedtuple @@ -132,8 +133,7 @@ def index(request, extra_context={}, user=AnonymousUser()): def course_from_id(course_id): """Return the CourseDescriptor corresponding to this course_id""" - course_loc = CourseDescriptor.id_to_location(course_id) - return modulestore().get_instance(course_id, course_loc) + return modulestore().get_course(course_id) day_pattern = re.compile(r'\s\d+,\s') multimonth_pattern = re.compile(r'\s?\-\s?\S+\s') @@ -269,8 +269,8 @@ def get_course_enrollment_pairs(user, course_org_filter, org_filter_out_set): a student's dashboard. """ for enrollment in CourseEnrollment.enrollments_for_user(user): - try: - course = course_from_id(enrollment.course_id) + course = course_from_id(enrollment.course_id) + if course: # if we are in a Microsite, then filter out anything that is not # attributed (by ORG) to that Microsite @@ -282,7 +282,7 @@ def get_course_enrollment_pairs(user, course_org_filter, org_filter_out_set): continue yield (course, enrollment) - except ItemNotFoundError: + else: log.error("User {0} enrolled in non-existent course {1}" .format(user.username, enrollment.course_id)) @@ -478,13 +478,13 @@ def dashboard(request): # Global staff can see what courses errored on their dashboard staff_access = False errored_courses = {} - if has_access(user, 'global', 'staff'): + if has_access(user, 'staff', 'global'): # Show any courses that errored on load staff_access = True errored_courses = modulestore().get_errored_courses() show_courseware_links_for = frozenset(course.id for course, _enrollment in course_enrollment_pairs - if has_access(request.user, course, 'load')) + if has_access(request.user, 'load', course)) course_modes = {course.id: complete_course_mode_info(course.id, enrollment) for course, enrollment in course_enrollment_pairs} cert_statuses = {course.id: cert_info(request.user, course) for course, _enrollment in course_enrollment_pairs} @@ -617,10 +617,11 @@ def change_enrollment(request): user = request.user action = request.POST.get("enrollment_action") - course_id = request.POST.get("course_id") - if course_id is None: + if 'course_id' not in request.POST: return HttpResponseBadRequest(_("Course id not specified")) + course_id = SlashSeparatedCourseKey.from_deprecated_string(request.POST.get("course_id")) + if not user.is_authenticated(): return HttpResponseForbidden() @@ -634,7 +635,7 @@ def change_enrollment(request): .format(user.username, course_id)) return HttpResponseBadRequest(_("Course id is invalid")) - if not has_access(user, course, 'enroll'): + if not has_access(user, 'enroll', course): return HttpResponseBadRequest(_("Enrollment is closed")) # see if we have already filled up all allowed enrollments @@ -648,7 +649,7 @@ def change_enrollment(request): available_modes = CourseMode.modes_for_course(course_id) if len(available_modes) > 1: return HttpResponse( - reverse("course_modes_choose", kwargs={'course_id': course_id}) + reverse("course_modes_choose", kwargs={'course_id': course_id.to_deprecated_string()}) ) current_mode = available_modes[0] @@ -664,7 +665,7 @@ def change_enrollment(request): # the user to the shopping cart page always, where they can reasonably discern the status of their cart, # whether things got added, etc - shoppingcart.views.add_course_to_cart(request, course_id) + shoppingcart.views.add_course_to_cart(request, course_id.to_deprecated_string()) return HttpResponse( reverse("shoppingcart.views.show_cart") ) @@ -686,7 +687,7 @@ def _parse_course_id_from_string(input_str): """ m_obj = re.match(r'^/courses/(?P[^/]+/[^/]+/[^/]+)', input_str) if m_obj: - return m_obj.group('course_id') + return SlashSeparatedCourseKey.from_deprecated_string(m_obj.group('course_id')) return None @@ -696,12 +697,12 @@ def _get_course_enrollment_domain(course_id): @param course_id: @return: """ - try: - course = course_from_id(course_id) - return course.enrollment_domain - except ItemNotFoundError: + course = course_from_id(course_id) + if course is None: return None + return course.enrollment_domain + @ensure_csrf_cookie def accounts_login(request): @@ -1378,6 +1379,9 @@ def auto_auth(request): full_name = request.GET.get('full_name', username) is_staff = request.GET.get('staff', None) course_id = request.GET.get('course_id', None) + course_key = None + if course_id: + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) role_names = [v.strip() for v in request.GET.get('roles', '').split(',') if v.strip()] # Get or create the user object @@ -1413,12 +1417,12 @@ def auto_auth(request): reg.save() # Enroll the user in a course - if course_id is not None: - CourseEnrollment.enroll(user, course_id) + if course_key is not None: + CourseEnrollment.enroll(user, course_key) # Apply the roles for role_name in role_names: - role = Role.objects.get(name=role_name, course_id=course_id) + role = Role.objects.get(name=role_name, course_id=course_key) user.roles.add(role) # Log in as the user @@ -1865,15 +1869,16 @@ def change_email_settings(request): user = request.user course_id = request.POST.get("course_id") + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) receive_emails = request.POST.get("receive_emails") if receive_emails: - optout_object = Optout.objects.filter(user=user, course_id=course_id) + optout_object = Optout.objects.filter(user=user, course_id=course_key) if optout_object: optout_object.delete() log.info(u"User {0} ({1}) opted in to receive emails from course {2}".format(user.username, user.email, course_id)) track.views.server_track(request, "change-email-settings", {"receive_emails": "yes", "course": course_id}, page='dashboard') else: - Optout.objects.get_or_create(user=user, course_id=course_id) + Optout.objects.get_or_create(user=user, course_id=course_key) log.info(u"User {0} ({1}) opted out of receiving emails from course {2}".format(user.username, user.email, course_id)) track.views.server_track(request, "change-email-settings", {"receive_emails": "no", "course": course_id}, page='dashboard') @@ -1889,7 +1894,7 @@ def token(request): the token was issued. This will be stored with the user along with the id for identification purposes in the backend. ''' - course_id = request.GET.get("course_id") + course_id = SlashSeparatedCourseKey.from_deprecated_string(request.GET.get("course_id")) course = course_from_id(course_id) dtnow = datetime.datetime.now() dtutcnow = datetime.datetime.utcnow() diff --git a/common/djangoapps/track/contexts.py b/common/djangoapps/track/contexts.py index 070ac10ebd..bb8673480e 100644 --- a/common/djangoapps/track/contexts.py +++ b/common/djangoapps/track/contexts.py @@ -1,7 +1,8 @@ """Generates common contexts""" import logging -from xmodule.course_module import CourseDescriptor +from xmodule.modulestore.locations import SlashSeparatedCourseKey +from opaque_keys import InvalidKeyError from util.request import COURSE_REGEX log = logging.getLogger(__name__) @@ -9,15 +10,24 @@ log = logging.getLogger(__name__) def course_context_from_url(url): """ - Extracts the course_id from the given `url` and passes it on to + Extracts the course_context from the given `url` and passes it on to `course_context_from_course_id()`. """ url = url or '' match = COURSE_REGEX.match(url) - course_id = '' + course_id = None if match: - course_id = match.group('course_id') or '' + course_id_string = match.group('course_id') + try: + course_id = SlashSeparatedCourseKey.from_deprecated_string(course_id_string) + except InvalidKeyError: + log.warning( + 'unable to parse course_id "{course_id}"'.format( + course_id=course_id_string + ), + exc_info=True + ) return course_context_from_course_id(course_id) @@ -34,23 +44,12 @@ def course_context_from_course_id(course_id): } """ + if course_id is None: + return {'course_id': '', 'org_id': ''} - course_id = course_id or '' - context = { - 'course_id': course_id, - 'org_id': '' + # TODO: Make this accept any CourseKey, and serialize it using .to_string + assert(isinstance(course_id, SlashSeparatedCourseKey)) + return { + 'course_id': course_id.to_deprecated_string(), + 'org_id': course_id.org, } - - if course_id: - try: - location = CourseDescriptor.id_to_location(course_id) - context['org_id'] = location.org - except ValueError: - log.warning( - 'Unable to parse course_id "{course_id}"'.format( - course_id=course_id - ), - exc_info=True - ) - - return context diff --git a/common/djangoapps/user_api/middleware.py b/common/djangoapps/user_api/middleware.py index 3a33db7143..97387e5007 100644 --- a/common/djangoapps/user_api/middleware.py +++ b/common/djangoapps/user_api/middleware.py @@ -5,6 +5,7 @@ Adds user's tags to tracking event context. from track.contexts import COURSE_REGEX from eventtracking import tracker from user_api.models import UserCourseTag +from xmodule.modulestore.locations import SlashSeparatedCourseKey class UserTagsEventContextMiddleware(object): @@ -19,6 +20,7 @@ class UserTagsEventContextMiddleware(object): course_id = None if match: course_id = match.group('course_id') + course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id) context = {} @@ -29,7 +31,7 @@ class UserTagsEventContextMiddleware(object): context['course_user_tags'] = dict( UserCourseTag.objects.filter( user=request.user.pk, - course_id=course_id + course_id=course_key, ).values_list('key', 'value') ) else: diff --git a/common/djangoapps/user_api/models.py b/common/djangoapps/user_api/models.py index 76b8cd5053..e5a31db820 100644 --- a/common/djangoapps/user_api/models.py +++ b/common/djangoapps/user_api/models.py @@ -2,6 +2,8 @@ from django.contrib.auth.models import User from django.core.validators import RegexValidator from django.db import models +from xmodule_django.models import CourseKeyField + class UserPreference(models.Model): """A user's preference, stored as generic text to be processed by client""" @@ -44,7 +46,7 @@ class UserCourseTag(models.Model): """ user = models.ForeignKey(User, db_index=True, related_name="+") key = models.CharField(max_length=255, db_index=True) - course_id = models.CharField(max_length=255, db_index=True) + course_id = CourseKeyField(max_length=255, db_index=True) value = models.TextField() class Meta: # pylint: disable=missing-docstring diff --git a/common/djangoapps/user_api/tests/factories.py b/common/djangoapps/user_api/tests/factories.py index 535e888a59..e5bd4debac 100644 --- a/common/djangoapps/user_api/tests/factories.py +++ b/common/djangoapps/user_api/tests/factories.py @@ -3,6 +3,7 @@ from factory.django import DjangoModelFactory from factory import SubFactory from student.tests.factories import UserFactory from user_api.models import UserPreference, UserCourseTag +from xmodule.modulestore.locations import SlashSeparatedCourseKey # Factories don't have __init__ methods, and are self documenting # pylint: disable=W0232, C0111 @@ -18,6 +19,6 @@ class UserCourseTagFactory(DjangoModelFactory): FACTORY_FOR = UserCourseTag user = SubFactory(UserFactory) - course_id = 'org/course/run' + course_id = SlashSeparatedCourseKey('org', 'course', 'run') key = None value = None diff --git a/common/djangoapps/user_api/tests/test_user_service.py b/common/djangoapps/user_api/tests/test_user_service.py index f63f702bcb..63be81b049 100644 --- a/common/djangoapps/user_api/tests/test_user_service.py +++ b/common/djangoapps/user_api/tests/test_user_service.py @@ -5,6 +5,7 @@ from django.test import TestCase from student.tests.factories import UserFactory from user_api import user_service +from xmodule.modulestore.locations import SlashSeparatedCourseKey class TestUserService(TestCase): @@ -13,7 +14,7 @@ class TestUserService(TestCase): """ def setUp(self): self.user = UserFactory.create() - self.course_id = 'test_org/test_course_number/test_run' + self.course_id = SlashSeparatedCourseKey('test_org', 'test_course_number', 'test_run') self.test_key = 'test_key' def test_get_set_course_tag(self): diff --git a/common/djangoapps/util/request.py b/common/djangoapps/util/request.py index 813a3347d3..b3b369cff4 100644 --- a/common/djangoapps/util/request.py +++ b/common/djangoapps/util/request.py @@ -3,6 +3,7 @@ import re from django.conf import settings from microsite_configuration import microsite +from xmodule.modulestore.locations import SlashSeparatedCourseKey COURSE_REGEX = re.compile(r'^.*?/courses/(?P[^/]+/[^/]+/[^/]+)') @@ -26,11 +27,17 @@ def course_id_from_url(url): """ Extracts the course_id from the given `url`. """ - url = url or '' + if not url: + return None match = COURSE_REGEX.match(url) - course_id = '' - if match: - course_id = match.group('course_id') or '' - return course_id + if match is None: + return None + + course_id = match.group('course_id') + + if course_id is None: + return None + + return SlashSeparatedCourseKey.from_deprecated_string(course_id) diff --git a/common/djangoapps/xmodule_modifiers.py b/common/djangoapps/xmodule_modifiers.py index 77d590777f..be9b98e4ba 100644 --- a/common/djangoapps/xmodule_modifiers.py +++ b/common/djangoapps/xmodule_modifiers.py @@ -18,7 +18,7 @@ from xmodule.vertical_module import VerticalModule from xmodule.x_module import shim_xmodule_js, XModuleDescriptor, XModule from lms.lib.xblock.runtime import quote_slashes from xmodule.modulestore import MONGO_MODULESTORE_TYPE -from xmodule.modulestore.django import modulestore, loc_mapper +from xmodule.modulestore.django import modulestore log = logging.getLogger(__name__) @@ -33,7 +33,7 @@ def wrap_fragment(fragment, new_content): return wrapper_frag -def wrap_xblock(runtime_class, block, view, frag, context, display_name_only=False, extra_data=None): # pylint: disable=unused-argument +def wrap_xblock(runtime_class, block, view, frag, context, usage_id_serializer, display_name_only=False, extra_data=None): # pylint: disable=unused-argument """ Wraps the results of rendering an XBlock view in a standard
    with identifying data so that the appropriate javascript module can be loaded onto it. @@ -43,6 +43,8 @@ def wrap_xblock(runtime_class, block, view, frag, context, display_name_only=Fal :param view: The name of the view that rendered the fragment being wrapped :param frag: The :class:`Fragment` to be wrapped :param context: The context passed to the view being rendered + :param usage_id_serializer: A function to serialize the block's usage_id for use by the + front-end Javascript Runtime. :param display_name_only: If true, don't render the fragment content at all. Instead, just render the `display_name` of `block` :param extra_data: A dictionary with extra data values to be set on the wrapper @@ -74,13 +76,14 @@ def wrap_xblock(runtime_class, block, view, frag, context, display_name_only=Fal data['runtime-class'] = runtime_class data['runtime-version'] = frag.js_init_version data['block-type'] = block.scope_ids.block_type - data['usage-id'] = quote_slashes(unicode(block.scope_ids.usage_id)) + data['usage-id'] = usage_id_serializer(block.scope_ids.usage_id) template_context = { 'content': block.display_name if display_name_only else frag.content, 'classes': css_classes, 'display_name': block.display_name_with_default, - 'data_attributes': u' '.join(u'data-{}="{}"'.format(key, value) for key, value in data.items()), + 'data_attributes': u' '.join(u'data-{}="{}"'.format(key, value) + for key, value in data.iteritems()), } return wrap_fragment(frag, render_to_string('xblock_wrapper.html', template_context)) @@ -145,7 +148,7 @@ def grade_histogram(module_id): WHERE courseware_studentmodule.module_id=%s GROUP BY courseware_studentmodule.grade""" # Passing module_id this way prevents sql-injection. - cursor.execute(q, [module_id]) + cursor.execute(q, [module_id.to_deprecated_string()]) grades = list(cursor.fetchall()) grades.sort(key=lambda x: x[0]) # Add ORDER BY to sql query? @@ -167,14 +170,14 @@ def add_staff_markup(user, block, view, frag, context): # pylint: disable=unuse # TODO: make this more general, eg use an XModule attribute instead if isinstance(block, VerticalModule): # check that the course is a mongo backed Studio course before doing work - is_mongo_course = modulestore().get_modulestore_type(block.course_id) == MONGO_MODULESTORE_TYPE + is_mongo_course = modulestore().get_modulestore_type(block.location.course_key) == MONGO_MODULESTORE_TYPE is_studio_course = block.course_edit_method == "Studio" if is_studio_course and is_mongo_course: - # get relative url/location of unit in Studio - locator = loc_mapper().translate_location(block.course_id, block.location, False, True) - # build edit link to unit in CMS - edit_link = "//" + settings.CMS_BASE + locator.url_reverse('unit', '') + # build edit link to unit in CMS. Can't use reverse here as lms doesn't load cms's urls.py + # reverse for contentstore.views.unit_handler + edit_link = "//" + settings.CMS_BASE + '/unit/' + unicode(block.location) + # return edit link in rendered HTML for display return wrap_fragment(frag, render_to_string("edit_unit_link.html", {'frag_content': frag.content, 'edit_link': edit_link})) else: @@ -183,7 +186,7 @@ def add_staff_markup(user, block, view, frag, context): # pylint: disable=unuse if isinstance(block, SequenceModule): return frag - block_id = block.id + block_id = block.location if block.has_score and settings.FEATURES.get('DISPLAY_HISTOGRAMS_TO_STAFF'): histogram = grade_histogram(block_id) render_histogram = len(histogram) > 0 From 0d88379eeb5d722c20c2f81e1b35494e5df687c7 Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 30 Apr 2014 10:17:56 -0400 Subject: [PATCH 012/117] Make course ids and usage ids opaque to LMS and Studio [partial commit] This commit adds all of cms. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong Co-Author: Christina Roberts Co-Author: David Baumgold Co-Author: Diana Huang Co-Author: Don Mitchell Co-Author: Julia Hansbrough Co-Author: Nimisha Asthagiri Co-Author: Sarina Canelake [LMS-2370] --- .../contentstore/context_processors.py | 1 + .../contentstore/features/common.py | 12 +- .../contentstore/features/course-export.py | 9 +- .../contentstore/features/grading.py | 14 +- .../contentstore/features/signup.feature | 8 +- .../contentstore/features/transcripts.py | 3 +- .../contentstore/features/upload.py | 2 +- cms/djangoapps/contentstore/features/video.py | 6 +- .../contentstore/git_export_utils.py | 13 +- .../management/commands/check_course.py | 29 +- .../management/commands/clone_course.py | 26 +- .../management/commands/delete_course.py | 5 +- .../management/commands/edit_course_tabs.py | 9 +- .../commands/empty_asset_trashcan.py | 14 +- .../management/commands/export.py | 9 +- .../management/commands/export_all_courses.py | 3 +- .../management/commands/git_export.py | 14 +- .../management/commands/import.py | 7 +- .../commands/map_courses_location_lower.py | 22 - .../management/commands/migrate_to_split.py | 25 +- .../commands/rollback_split_course.py | 14 +- .../commands/tests/test_course_id_clash.py | 16 +- .../commands/tests/test_git_export.py | 35 +- .../management/commands/tests/test_import.py | 26 +- .../commands/tests/test_migrate_to_split.py | 14 +- .../tests/test_rollback_split_course.py | 16 +- .../contentstore/tests/test_contentstore.py | 968 +++++++----------- .../contentstore/tests/test_core_caching.py | 4 +- .../contentstore/tests/test_course_listing.py | 145 +-- .../tests/test_course_settings.py | 125 ++- .../contentstore/tests/test_crud.py | 19 +- .../contentstore/tests/test_export_git.py | 11 +- .../contentstore/tests/test_i18n.py | 6 +- .../contentstore/tests/test_import.py | 71 +- .../tests/test_import_draft_order.py | 32 +- .../tests/test_import_pure_xblock.py | 16 +- .../contentstore/tests/test_orphan.py | 32 +- .../contentstore/tests/test_permissions.py | 63 +- .../tests/test_transcripts_utils.py | 22 +- .../tests/test_users_default_role.py | 60 +- .../contentstore/tests/test_utils.py | 26 +- cms/djangoapps/contentstore/tests/tests.py | 15 +- cms/djangoapps/contentstore/tests/utils.py | 7 +- cms/djangoapps/contentstore/utils.py | 187 ++-- cms/djangoapps/contentstore/views/access.py | 25 +- cms/djangoapps/contentstore/views/assets.py | 98 +- .../contentstore/views/checklist.py | 36 +- .../contentstore/views/component.py | 76 +- cms/djangoapps/contentstore/views/course.py | 469 ++++----- .../contentstore/views/export_git.py | 11 +- cms/djangoapps/contentstore/views/helpers.py | 19 +- .../contentstore/views/import_export.py | 83 +- cms/djangoapps/contentstore/views/item.py | 203 ++-- cms/djangoapps/contentstore/views/preview.py | 32 +- cms/djangoapps/contentstore/views/public.py | 6 +- cms/djangoapps/contentstore/views/tabs.py | 26 +- .../contentstore/views/tests/test_access.py | 35 +- .../contentstore/views/tests/test_assets.py | 43 +- .../views/tests/test_checklists.py | 24 +- .../views/tests/test_container.py | 69 +- .../views/tests/test_course_index.py | 21 +- .../views/tests/test_course_updates.py | 103 +- .../contentstore/views/tests/test_helpers.py | 16 +- .../views/tests/test_import_export.py | 29 +- .../contentstore/views/tests/test_item.py | 380 ++++--- .../contentstore/views/tests/test_preview.py | 29 +- .../contentstore/views/tests/test_tabs.py | 9 +- .../views/tests/test_textbooks.py | 26 +- .../views/tests/test_transcripts.py | 106 +- .../contentstore/views/tests/test_user.py | 81 +- .../contentstore/views/transcripts_ajax.py | 42 +- cms/djangoapps/contentstore/views/user.py | 63 +- .../models/settings/course_details.py | 62 +- .../models/settings/course_grading.py | 66 +- cms/lib/xblock/runtime.py | 4 +- cms/lib/xblock/test/test_runtime.py | 1 - .../coffee/src/views/module_edit.coffee | 3 +- cms/static/js/index.js | 2 +- cms/static/js/spec/utils/module_spec.js | 2 +- cms/static/js/spec/views/unit_spec.js | 2 +- cms/static/js/utils/module.js | 2 +- cms/static/js/views/metadata.js | 6 +- cms/static/js/views/modals/edit_xblock.js | 1 + cms/templates/container.html | 4 +- cms/templates/container_xblock_component.html | 2 +- cms/templates/edit-tabs.html | 4 +- cms/templates/edit_subsection.html | 4 +- cms/templates/export.html | 1 - cms/templates/export_git.html | 2 +- cms/templates/js/edit-xblock-modal.underscore | 2 +- cms/templates/manage_users.html | 17 +- cms/templates/overview.html | 23 +- cms/templates/register.html | 2 +- cms/templates/settings.html | 8 +- cms/templates/settings_advanced.html | 9 +- cms/templates/settings_graders.html | 7 +- cms/templates/studio_vertical_wrapper.html | 2 +- cms/templates/studio_xblock_wrapper.html | 2 +- cms/templates/unit.html | 16 +- cms/templates/widgets/header.html | 30 +- cms/templates/widgets/metadata-edit.html | 2 +- cms/templates/widgets/segment-io.html | 7 +- cms/templates/widgets/sequence-edit.html | 2 +- cms/templates/widgets/source-edit.html | 2 +- cms/templates/widgets/units.html | 20 +- cms/urls.py | 52 +- mongo_indexes.md | 64 +- 107 files changed, 2068 insertions(+), 2688 deletions(-) delete mode 100644 cms/djangoapps/contentstore/management/commands/map_courses_location_lower.py diff --git a/cms/djangoapps/contentstore/context_processors.py b/cms/djangoapps/contentstore/context_processors.py index 66ba685661..b6046caec4 100644 --- a/cms/djangoapps/contentstore/context_processors.py +++ b/cms/djangoapps/contentstore/context_processors.py @@ -1,3 +1,4 @@ + import ConfigParser from django.conf import settings diff --git a/cms/djangoapps/contentstore/features/common.py b/cms/djangoapps/contentstore/features/common.py index 37f0e8eac4..aabbe9928b 100644 --- a/cms/djangoapps/contentstore/features/common.py +++ b/cms/djangoapps/contentstore/features/common.py @@ -1,13 +1,12 @@ # pylint: disable=C0111 # pylint: disable=W0621 -import time import os from lettuce import world, step from nose.tools import assert_true, assert_in # pylint: disable=no-name-in-module from django.conf import settings -from student.roles import CourseRole, CourseStaffRole, CourseInstructorRole +from student.roles import CourseStaffRole, CourseInstructorRole, GlobalStaff from student.models import get_user from selenium.webdriver.common.keys import Keys @@ -162,7 +161,7 @@ def add_course_author(user, course): """ global_admin = AdminFactory() for role in (CourseStaffRole, CourseInstructorRole): - auth.add_users(global_admin, role(course.location), user) + auth.add_users(global_admin, role(course.id), user) def create_a_course(): @@ -379,18 +378,17 @@ def create_other_user(_step, name, has_extra_perms, role_name): user = create_studio_user(uname=name, password="test", email=email) if has_extra_perms: if role_name == "is_staff": - user.is_staff = True - user.save() + GlobalStaff().add_users(user) else: if role_name == "admin": # admins get staff privileges, as well roles = (CourseStaffRole, CourseInstructorRole) else: roles = (CourseStaffRole,) - location = world.scenario_dict["COURSE"].location + course_key = world.scenario_dict["COURSE"].id global_admin = AdminFactory() for role in roles: - auth.add_users(global_admin, role(location), user) + auth.add_users(global_admin, role(course_key), user) @step('I log out') diff --git a/cms/djangoapps/contentstore/features/course-export.py b/cms/djangoapps/contentstore/features/course-export.py index e9d2a78c82..a889f292df 100644 --- a/cms/djangoapps/contentstore/features/course-export.py +++ b/cms/djangoapps/contentstore/features/course-export.py @@ -4,6 +4,8 @@ from lettuce import world, step from component_settings_editor_helpers import enter_xml_in_advanced_problem from nose.tools import assert_true, assert_equal +from xmodule.modulestore.locations import SlashSeparatedCourseKey +from contentstore.utils import reverse_usage_url @step('I export the course$') @@ -43,4 +45,9 @@ def get_an_error_dialog(step): def i_click_on_error_dialog(step): world.click_link_by_text('Correct failed component') assert_true(world.css_html("span.inline-error").startswith("Problem i4x://MITx/999/problem")) - assert_equal(1, world.browser.url.count("unit/MITx.999.Robot_Super_Course/branch/draft/block/vertical")) + 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_url = reverse_usage_url('unit_handler', vertical_usage_key) + assert_equal(1, world.browser.url.count(vertical_url)) diff --git a/cms/djangoapps/contentstore/features/grading.py b/cms/djangoapps/contentstore/features/grading.py index 5aa659d12f..14a11b7965 100644 --- a/cms/djangoapps/contentstore/features/grading.py +++ b/cms/djangoapps/contentstore/features/grading.py @@ -4,8 +4,9 @@ from lettuce import world, step from common import * from terrain.steps import reload_the_page -from selenium.common.exceptions import ( - InvalidElementStateException, WebDriverException) +from selenium.common.exceptions import InvalidElementStateException +from xmodule.modulestore.locations import SlashSeparatedCourseKey +from contentstore.utils import reverse_course_url from nose.tools import assert_in, assert_not_in, assert_equal, assert_not_equal # pylint: disable=E0611 @@ -68,11 +69,12 @@ def change_assignment_name(step, old_name, new_name): @step(u'I go back to the main course page') def main_course_page(step): course_name = world.scenario_dict['COURSE'].display_name.replace(' ', '_') - main_page_link = '/course/{org}.{number}.{name}/branch/draft/block/{name}'.format( - org=world.scenario_dict['COURSE'].org, - number=world.scenario_dict['COURSE'].number, - name=course_name + course_key = SlashSeparatedCourseKey( + world.scenario_dict['COURSE'].org, + world.scenario_dict['COURSE'].number, + course_name ) + main_page_link = reverse_course_url('course_handler', course_key) world.visit(main_page_link) assert_in('Course Outline', world.css_text('h1.page-header')) diff --git a/cms/djangoapps/contentstore/features/signup.feature b/cms/djangoapps/contentstore/features/signup.feature index 16cd550295..92ff0d393d 100644 --- a/cms/djangoapps/contentstore/features/signup.feature +++ b/cms/djangoapps/contentstore/features/signup.feature @@ -14,11 +14,11 @@ Feature: CMS.Sign in Scenario: Login with a valid redirect Given I have opened a new course in Studio And I am not logged in - And I visit the url "/course/MITx.999.Robot_Super_Course/branch/draft/block/Robot_Super_Course" - And I should see that the path is "/signin?next=/course/MITx.999.Robot_Super_Course/branch/draft/block/Robot_Super_Course" + And I visit the url "/course/slashes:MITx+999+Robot_Super_Course" + And I should see that the path is "/signin?next=/course/slashes%3AMITx%2B999%2BRobot_Super_Course" When I fill in and submit the signin form And I wait for "2" seconds - Then I should see that the path is "/course/MITx.999.Robot_Super_Course/branch/draft/block/Robot_Super_Course" + Then I should see that the path is "/course/slashes:MITx+999+Robot_Super_Course" Scenario: Login with an invalid redirect Given I have opened a new course in Studio @@ -26,4 +26,4 @@ Feature: CMS.Sign in And I visit the url "/signin?next=http://www.google.com/" When I fill in and submit the signin form And I wait for "2" seconds - Then I should see that the path is "/course" + Then I should see that the path is "/course/" diff --git a/cms/djangoapps/contentstore/features/transcripts.py b/cms/djangoapps/contentstore/features/transcripts.py index 4a864b6026..651d551701 100644 --- a/cms/djangoapps/contentstore/features/transcripts.py +++ b/cms/djangoapps/contentstore/features/transcripts.py @@ -165,8 +165,7 @@ def remove_transcripts_from_store(_step, subs_id): """Remove from store, if transcripts content exists.""" filename = 'subs_{0}.srt.sjson'.format(subs_id.strip()) content_location = StaticContent.compute_location( - world.scenario_dict['COURSE'].org, - world.scenario_dict['COURSE'].number, + world.scenario_dict['COURSE'].id, filename ) try: diff --git a/cms/djangoapps/contentstore/features/upload.py b/cms/djangoapps/contentstore/features/upload.py index 6330f571a2..75572dac18 100644 --- a/cms/djangoapps/contentstore/features/upload.py +++ b/cms/djangoapps/contentstore/features/upload.py @@ -146,7 +146,7 @@ def user_foo_is_enrolled_in_the_course(step, name): world.create_user(name, 'test') user = User.objects.get(username=name) - course_id = world.scenario_dict['COURSE'].location.course_id + course_id = world.scenario_dict['COURSE'].id CourseEnrollment.enroll(user, course_id) diff --git a/cms/djangoapps/contentstore/features/video.py b/cms/djangoapps/contentstore/features/video.py index 9e7b2f3151..16ca144afe 100644 --- a/cms/djangoapps/contentstore/features/video.py +++ b/cms/djangoapps/contentstore/features/video.py @@ -140,10 +140,10 @@ def xml_only_video(step): # Wait for the new unit to be created and to load the page world.wait(1) - location = world.scenario_dict['COURSE'].location - store = get_modulestore(location) + course = world.scenario_dict['COURSE'] + store = get_modulestore(course.location) - parent_location = store.get_items(Location(category='vertical', revision='draft'))[0].location + parent_location = store.get_items(course.id, category='vertical', revision='draft')[0].location youtube_id = 'ABCDEFG' world.scenario_dict['YOUTUBE_ID'] = youtube_id diff --git a/cms/djangoapps/contentstore/git_export_utils.py b/cms/djangoapps/contentstore/git_export_utils.py index e94b10d94c..8cb938af75 100644 --- a/cms/djangoapps/contentstore/git_export_utils.py +++ b/cms/djangoapps/contentstore/git_export_utils.py @@ -14,7 +14,6 @@ from django.utils import timezone from django.utils.translation import ugettext_lazy as _ from xmodule.contentstore.django import contentstore -from xmodule.course_module import CourseDescriptor from xmodule.modulestore.django import modulestore from xmodule.modulestore.xml_exporter import export_to_xml @@ -64,13 +63,10 @@ def cmd_log(cmd, cwd): return output -def export_to_git(course_loc, repo, user='', rdir=None): +def export_to_git(course_id, repo, user='', rdir=None): """Export a course to git.""" # pylint: disable=R0915 - if course_loc.startswith('i4x://'): - course_loc = course_loc[6:] - if not GIT_REPO_EXPORT_DIR: raise GitExportError(GitExportError.NO_EXPORT_DIR) @@ -129,15 +125,10 @@ def export_to_git(course_loc, repo, user='', rdir=None): raise GitExportError(GitExportError.CANNOT_PULL) # export course as xml before commiting and pushing - try: - location = CourseDescriptor.id_to_location(course_loc) - except ValueError: - raise GitExportError(GitExportError.BAD_COURSE) - root_dir = os.path.dirname(rdirp) course_dir = os.path.splitext(os.path.basename(rdirp))[0] try: - export_to_xml(modulestore('direct'), contentstore(), location, + export_to_xml(modulestore('direct'), contentstore(), course_id, root_dir, course_dir, modulestore()) except (EnvironmentError, AttributeError): log.exception('Failed export to xml') diff --git a/cms/djangoapps/contentstore/management/commands/check_course.py b/cms/djangoapps/contentstore/management/commands/check_course.py index c3f1b97a5e..b7d5606bb0 100644 --- a/cms/djangoapps/contentstore/management/commands/check_course.py +++ b/cms/djangoapps/contentstore/management/commands/check_course.py @@ -1,8 +1,7 @@ from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.django import modulestore from xmodule.modulestore.xml_importer import check_module_metadata_editability -from xmodule.course_module import CourseDescriptor -from xmodule.modulestore import Location +from xmodule.modulestore.keys import CourseKey class Command(BaseCommand): @@ -10,14 +9,13 @@ class Command(BaseCommand): def handle(self, *args, **options): if len(args) != 1: - raise CommandError("check_course requires one argument: ") + raise CommandError("check_course requires one argument: ") - loc_str = args[0] + course_key = CourseKey.from_string(args[0]) - loc = CourseDescriptor.id_to_location(loc_str) store = modulestore() - course = store.get_item(loc, depth=3) + course = store.get_course(course_key, depth=3) err_cnt = 0 @@ -33,7 +31,7 @@ class Command(BaseCommand): def _check_xml_attributes_field(module): err_cnt = 0 if hasattr(module, 'xml_attributes') and isinstance(module.xml_attributes, basestring): - print 'module = {0} has xml_attributes as a string. It should be a dict'.format(module.location.url()) + print 'module = {0} has xml_attributes as a string. It should be a dict'.format(module.location) err_cnt = err_cnt + 1 for child in module.get_children(): err_cnt = err_cnt + _check_xml_attributes_field(child) @@ -45,7 +43,7 @@ class Command(BaseCommand): def _get_discussion_items(module): discussion_items = [] if module.location.category == 'discussion': - discussion_items = discussion_items + [module.location.url()] + discussion_items = discussion_items + [module.location] for child in module.get_children(): discussion_items = discussion_items + _get_discussion_items(child) @@ -55,17 +53,8 @@ class Command(BaseCommand): discussion_items = _get_discussion_items(course) # now query all discussion items via get_items() and compare with the tree-traversal - queried_discussion_items = store.get_items( - Location( - 'i4x', - course.location.org, - course.location.course, - 'discussion', - None, - None - ) - ) + queried_discussion_items = store.get_items(course_key=course_key, category='discussion',) for item in queried_discussion_items: - if item.location.url() not in discussion_items: - print 'Found dangling discussion module = {0}'.format(item.location.url()) + if item.location not in discussion_items: + print 'Found dangling discussion module = {0}'.format(item.location) diff --git a/cms/djangoapps/contentstore/management/commands/clone_course.py b/cms/djangoapps/contentstore/management/commands/clone_course.py index 77daeaa975..07cae77f9a 100644 --- a/cms/djangoapps/contentstore/management/commands/clone_course.py +++ b/cms/djangoapps/contentstore/management/commands/clone_course.py @@ -5,9 +5,8 @@ from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.store_utilities import clone_course from xmodule.modulestore.django import modulestore from xmodule.contentstore.django import contentstore -from xmodule.course_module import CourseDescriptor from student.roles import CourseInstructorRole, CourseStaffRole -from xmodule.modulestore import Location +from xmodule.modulestore.keys import CourseKey # @@ -22,29 +21,22 @@ class Command(BaseCommand): if len(args) != 2: raise CommandError("clone requires 2 arguments: ") - source_course_id = args[0] - dest_course_id = args[1] + source_course_id = CourseKey.from_string(args[0]) + dest_course_id = CourseKey.from_string(args[1]) mstore = modulestore('direct') cstore = contentstore() - course_id_dict = Location.parse_course_id(dest_course_id) - mstore.ignore_write_events_on_courses.append('{org}/{course}'.format(**course_id_dict)) + mstore.ignore_write_events_on_courses.add(dest_course_id) print("Cloning course {0} to {1}".format(source_course_id, dest_course_id)) - source_location = CourseDescriptor.id_to_location(source_course_id) - dest_location = CourseDescriptor.id_to_location(dest_course_id) - - if clone_course(mstore, cstore, source_location, dest_location): - # be sure to recompute metadata inheritance after all those updates - mstore.refresh_cached_metadata_inheritance_tree(dest_location) - + if clone_course(mstore, cstore, source_course_id, dest_course_id): print("copying User permissions...") # purposely avoids auth.add_user b/c it doesn't have a caller to authorize - CourseInstructorRole(dest_location).add_users( - *CourseInstructorRole(source_location).users_with_role() + CourseInstructorRole(dest_course_id).add_users( + *CourseInstructorRole(source_course_id).users_with_role() ) - CourseStaffRole(dest_location).add_users( - *CourseStaffRole(source_location).users_with_role() + CourseStaffRole(dest_course_id).add_users( + *CourseStaffRole(source_course_id).users_with_role() ) diff --git a/cms/djangoapps/contentstore/management/commands/delete_course.py b/cms/djangoapps/contentstore/management/commands/delete_course.py index 6b147082d4..981044cd32 100644 --- a/cms/djangoapps/contentstore/management/commands/delete_course.py +++ b/cms/djangoapps/contentstore/management/commands/delete_course.py @@ -4,6 +4,7 @@ from django.core.management.base import BaseCommand, CommandError from .prompt import query_yes_no from contentstore.utils import delete_course_and_groups +from xmodule.modulestore.keys import CourseKey class Command(BaseCommand): @@ -11,9 +12,9 @@ class Command(BaseCommand): def handle(self, *args, **options): if len(args) != 1 and len(args) != 2: - raise CommandError("delete_course requires one or more arguments: |commit|") + raise CommandError("delete_course requires one or more arguments: |commit|") - course_id = args[0] + course_id = CourseKey.from_string(args[0]) commit = False if len(args) == 2: diff --git a/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py b/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py index cc85a6e867..d8b011a1c5 100644 --- a/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py +++ b/cms/djangoapps/contentstore/management/commands/edit_course_tabs.py @@ -13,6 +13,9 @@ from .prompt import query_yes_no from courseware.courses import get_course_by_id from contentstore.views import tabs +from opaque_keys import InvalidKeyError +from xmodule.modulestore.locations import SlashSeparatedCourseKey +from xmodule.modulestore.keys import CourseKey def print_course(course): @@ -64,7 +67,11 @@ command again, adding --insert or --delete to edit the list. if not options['course']: raise CommandError(Command.course_option.help) - course = get_course_by_id(options['course']) + try: + course_key = CourseKey.from_string(options['course']) + except InvalidKeyError: + course_key = SlashSeparatedCourseKey.from_deprecated_string(options['course']) + course = get_course_by_id(course_key) print 'Warning: this command directly edits the list of course tabs in mongo.' print 'Tabs before any changes:' diff --git a/cms/djangoapps/contentstore/management/commands/empty_asset_trashcan.py b/cms/djangoapps/contentstore/management/commands/empty_asset_trashcan.py index 9af3277a2b..85cb8d2f87 100644 --- a/cms/djangoapps/contentstore/management/commands/empty_asset_trashcan.py +++ b/cms/djangoapps/contentstore/management/commands/empty_asset_trashcan.py @@ -1,7 +1,7 @@ from django.core.management.base import BaseCommand, CommandError -from xmodule.course_module import CourseDescriptor from xmodule.contentstore.utils import empty_asset_trashcan from xmodule.modulestore.django import modulestore +from xmodule.modulestore.keys import CourseKey from .prompt import query_yes_no @@ -10,16 +10,12 @@ class Command(BaseCommand): def handle(self, *args, **options): if len(args) != 1 and len(args) != 0: - raise CommandError("empty_asset_trashcan requires one or no arguments: ||") - - locs = [] + raise CommandError("empty_asset_trashcan requires one or no arguments: ||") if len(args) == 1: - locs.append(CourseDescriptor.id_to_location(args[0])) + course_ids = [CourseKey.from_string(args[0])] else: - courses = modulestore('direct').get_courses() - for course in courses: - locs.append(course.location) + course_ids = [course.id for course in modulestore('direct').get_courses()] if query_yes_no("Emptying trashcan. Confirm?", default="no"): - empty_asset_trashcan(locs) + empty_asset_trashcan(course_ids) diff --git a/cms/djangoapps/contentstore/management/commands/export.py b/cms/djangoapps/contentstore/management/commands/export.py index efeb5dc339..07639d5072 100644 --- a/cms/djangoapps/contentstore/management/commands/export.py +++ b/cms/djangoapps/contentstore/management/commands/export.py @@ -6,6 +6,7 @@ import os from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.xml_exporter import export_to_xml from xmodule.modulestore.django import modulestore +from xmodule.modulestore.keys import CourseKey from xmodule.contentstore.django import contentstore from xmodule.course_module import CourseDescriptor @@ -19,16 +20,14 @@ class Command(BaseCommand): def handle(self, *args, **options): "Execute the command" if len(args) != 2: - raise CommandError("export requires two arguments: ") + raise CommandError("export requires two arguments: ") - course_id = args[0] + course_id = CourseKey.from_string(args[0]) output_path = args[1] print("Exporting course id = {0} to {1}".format(course_id, output_path)) - location = CourseDescriptor.id_to_location(course_id) - root_dir = os.path.dirname(output_path) course_dir = os.path.splitext(os.path.basename(output_path))[0] - export_to_xml(modulestore('direct'), contentstore(), location, root_dir, course_dir, modulestore()) + export_to_xml(modulestore('direct'), contentstore(), course_id, root_dir, course_dir, modulestore()) diff --git a/cms/djangoapps/contentstore/management/commands/export_all_courses.py b/cms/djangoapps/contentstore/management/commands/export_all_courses.py index 2118551138..c03e80287f 100644 --- a/cms/djangoapps/contentstore/management/commands/export_all_courses.py +++ b/cms/djangoapps/contentstore/management/commands/export_all_courses.py @@ -35,9 +35,8 @@ class Command(BaseCommand): if 1: try: - location = CourseDescriptor.id_to_location(course_id) course_dir = course_id.replace('/', '...') - export_to_xml(ms, cs, location, root_dir, course_dir, modulestore()) + export_to_xml(ms, cs, course_id, root_dir, course_dir, modulestore()) except Exception as err: print("="*30 + "> Oops, failed to export %s" % course_id) print("Error:") diff --git a/cms/djangoapps/contentstore/management/commands/git_export.py b/cms/djangoapps/contentstore/management/commands/git_export.py index 848ef832e7..066b7b8cbc 100644 --- a/cms/djangoapps/contentstore/management/commands/git_export.py +++ b/cms/djangoapps/contentstore/management/commands/git_export.py @@ -20,6 +20,10 @@ from django.core.management.base import BaseCommand, CommandError from django.utils.translation import ugettext as _ import contentstore.git_export_utils as git_export_utils +from xmodule.modulestore.locations import SlashSeparatedCourseKey +from opaque_keys import InvalidKeyError +from contentstore.git_export_utils import GitExportError +from xmodule.modulestore.keys import CourseKey log = logging.getLogger(__name__) @@ -52,9 +56,17 @@ class Command(BaseCommand): 'course_loc and git_url') # Rethrow GitExportError as CommandError for SystemExit + try: + course_key = CourseKey.from_string(args[0]) + except InvalidKeyError: + try: + course_key = SlashSeparatedCourseKey.from_deprecated_string(args[0]) + except InvalidKeyError: + raise CommandError(GitExportError.BAD_COURSE) + try: git_export_utils.export_to_git( - args[0], + course_key, args[1], options.get('user', ''), options.get('rdir', None) diff --git a/cms/djangoapps/contentstore/management/commands/import.py b/cms/djangoapps/contentstore/management/commands/import.py index 724886621d..ce828f4859 100644 --- a/cms/djangoapps/contentstore/management/commands/import.py +++ b/cms/djangoapps/contentstore/management/commands/import.py @@ -47,11 +47,12 @@ class Command(BaseCommand): _, course_items = import_from_xml( mstore, data_dir, course_dirs, load_error_modules=False, static_content_store=contentstore(), verbose=True, - do_import_static=do_import_static + do_import_static=do_import_static, + create_new_course=True, ) - for module in course_items: - course_id = module.location.course_id + for course in course_items: + course_id = course.id if not are_permissions_roles_seeded(course_id): self.stdout.write('Seeding forum roles for course {0}\n'.format(course_id)) seed_permissions_roles(course_id) diff --git a/cms/djangoapps/contentstore/management/commands/map_courses_location_lower.py b/cms/djangoapps/contentstore/management/commands/map_courses_location_lower.py deleted file mode 100644 index a08d7195f7..0000000000 --- a/cms/djangoapps/contentstore/management/commands/map_courses_location_lower.py +++ /dev/null @@ -1,22 +0,0 @@ -""" -Script for traversing all courses and add/modify mapping with 'lower_id' and 'lower_course_id' -""" -from django.core.management.base import BaseCommand -from xmodule.modulestore.django import modulestore, loc_mapper - - -# -# To run from command line: ./manage.py cms --settings dev map_courses_location_lower -# -class Command(BaseCommand): - """ - Create or modify map entry for each course in 'loc_mapper' with 'lower_id' and 'lower_course_id' - """ - help = "Create or modify map entry for each course in 'loc_mapper' with 'lower_id' and 'lower_course_id'" - - def handle(self, *args, **options): - # get all courses - courses = modulestore('direct').get_courses() - for course in courses: - # create/modify map_entry in 'loc_mapper' with 'lower_id' and 'lower_course_id' - loc_mapper().create_map_entry(course.location) diff --git a/cms/djangoapps/contentstore/management/commands/migrate_to_split.py b/cms/djangoapps/contentstore/management/commands/migrate_to_split.py index 3ef8dd79fb..f205954ba4 100644 --- a/cms/djangoapps/contentstore/management/commands/migrate_to_split.py +++ b/cms/djangoapps/contentstore/management/commands/migrate_to_split.py @@ -4,10 +4,8 @@ to the new split-Mongo modulestore. """ from django.core.management.base import BaseCommand, CommandError from django.contrib.auth.models import User -from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore from xmodule.modulestore.split_migrator import SplitMigrator -from xmodule.modulestore import InvalidLocationError from xmodule.modulestore.django import loc_mapper @@ -30,13 +28,12 @@ class Command(BaseCommand): "Migrate a course from old-Mongo to split-Mongo" help = "Migrate a course from old-Mongo to split-Mongo" - args = "location email " + args = "location email " def parse_args(self, *args): """ - Return a three-tuple of (location, user, locator_string). - If the user didn't specify a locator string, the third return value - will be None. + Return a 4-tuple of (location, user, org, offering). + If the user didn't specify an org & offering, those will be None. """ if len(args) < 2: raise CommandError( @@ -44,10 +41,7 @@ class Command(BaseCommand): "a location and a user identifier (email or ID)" ) - try: - location = Location(args[0]) - except InvalidLocationError: - raise CommandError("Invalid location string {}".format(args[0])) + location = args[0] try: user = user_from_str(args[1]) @@ -55,14 +49,15 @@ class Command(BaseCommand): raise CommandError("No user found identified by {}".format(args[1])) try: - package_id = args[2] + org = args[2] + offering = args[3] except IndexError: - package_id = None + org = offering = None - return location, user, package_id + return location, user, org, offering def handle(self, *args, **options): - location, user, package_id = self.parse_args(*args) + location, user, org, offering = self.parse_args(*args) migrator = SplitMigrator( draft_modulestore=modulestore('default'), @@ -71,4 +66,4 @@ class Command(BaseCommand): loc_mapper=loc_mapper(), ) - migrator.migrate_mongo_course(location, user, package_id) + migrator.migrate_mongo_course(location, user, org, offering) diff --git a/cms/djangoapps/contentstore/management/commands/rollback_split_course.py b/cms/djangoapps/contentstore/management/commands/rollback_split_course.py index 3681ebf282..3c191427d4 100644 --- a/cms/djangoapps/contentstore/management/commands/rollback_split_course.py +++ b/cms/djangoapps/contentstore/management/commands/rollback_split_course.py @@ -4,7 +4,7 @@ is to delete the course from the split mongo datastore. """ from django.core.management.base import BaseCommand, CommandError from xmodule.modulestore.django import modulestore, loc_mapper -from xmodule.modulestore.exceptions import ItemNotFoundError, InsufficientSpecificationError +from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.modulestore.locator import CourseLocator @@ -12,18 +12,18 @@ class Command(BaseCommand): "Rollback a course that was migrated to the split Mongo datastore" help = "Rollback a course that was migrated to the split Mongo datastore" - args = "locator" + args = "org offering" def handle(self, *args, **options): - if len(args) < 1: + if len(args) < 2: raise CommandError( - "rollback_split_course requires at least one argument (locator)" + "rollback_split_course requires 2 arguments (org offering)" ) try: - locator = CourseLocator(url=args[0]) + locator = CourseLocator(org=args[0], offering=args[1]) except ValueError: - raise CommandError("Invalid locator string {}".format(args[0])) + raise CommandError("Invalid org or offering string {}, {}".format(*args)) location = loc_mapper().translate_locator_to_location(locator, get_course=True) if not location: @@ -41,7 +41,7 @@ class Command(BaseCommand): ) try: - modulestore('split').delete_course(locator.package_id) + modulestore('split').delete_course(locator) except ItemNotFoundError: raise CommandError("No course found with locator {}".format(locator)) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_course_id_clash.py b/cms/djangoapps/contentstore/management/commands/tests/test_course_id_clash.py index 5ef5756ad6..dfe3339ad3 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_course_id_clash.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_course_id_clash.py @@ -15,19 +15,19 @@ class ClashIdTestCase(TestCase): expected = [] # clashing courses course = CourseFactory.create(org="test", course="courseid", display_name="run1") - expected.append(course.location.course_id) + expected.append(course.id) course = CourseFactory.create(org="TEST", course="courseid", display_name="RUN12") - expected.append(course.location.course_id) + expected.append(course.id) course = CourseFactory.create(org="test", course="CourseId", display_name="aRUN123") - expected.append(course.location.course_id) + expected.append(course.id) # not clashing courses not_expected = [] course = CourseFactory.create(org="test", course="course2", display_name="run1") - not_expected.append(course.location.course_id) + not_expected.append(course.id) course = CourseFactory.create(org="test1", course="courseid", display_name="run1") - not_expected.append(course.location.course_id) + not_expected.append(course.id) course = CourseFactory.create(org="test", course="courseid0", display_name="run1") - not_expected.append(course.location.course_id) + not_expected.append(course.id) old_stdout = sys.stdout sys.stdout = mystdout = StringIO() @@ -35,6 +35,6 @@ class ClashIdTestCase(TestCase): sys.stdout = old_stdout result = mystdout.getvalue() for courseid in expected: - self.assertIn(courseid, result) + self.assertIn(courseid.to_deprecated_string(), result) for courseid in not_expected: - self.assertNotIn(courseid, result) + self.assertNotIn(courseid.to_deprecated_string(), result) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py b/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py index 9b7f4a7665..33eee8a958 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_git_export.py @@ -18,6 +18,7 @@ from django.test.utils import override_settings from contentstore.tests.utils import CourseTestCase import contentstore.git_export_utils as git_export_utils from contentstore.git_export_utils import GitExportError +from xmodule.modulestore.locations import SlashSeparatedCourseKey FEATURES_WITH_EXPORT_GIT = settings.FEATURES.copy() FEATURES_WITH_EXPORT_GIT['ENABLE_EXPORT_GIT'] = True @@ -52,7 +53,7 @@ class TestGitExport(CourseTestCase): def test_command(self): """ - Test that the command interface works. Ignore stderr fo clean + Test that the command interface works. Ignore stderr for clean test output. """ with self.assertRaises(SystemExit) as ex: @@ -69,7 +70,13 @@ class TestGitExport(CourseTestCase): # Send bad url to get course not exported with self.assertRaises(SystemExit) as ex: with self.assertRaisesRegexp(CommandError, GitExportError.URL_BAD): - call_command('git_export', 'foo', 'silly', + call_command('git_export', 'foo/bar/baz', 'silly', + stderr=StringIO.StringIO()) + self.assertEqual(ex.exception.code, 1) + # Send bad course_id to get course not exported + with self.assertRaises(SystemExit) as ex: + with self.assertRaisesRegexp(CommandError, GitExportError.BAD_COURSE): + call_command('git_export', 'foo/bar:baz', 'silly', stderr=StringIO.StringIO()) self.assertEqual(ex.exception.code, 1) @@ -77,15 +84,16 @@ class TestGitExport(CourseTestCase): """ Test several bad URLs for validation """ + course_key = SlashSeparatedCourseKey('org', 'course', 'run') with self.assertRaisesRegexp(GitExportError, str(GitExportError.URL_BAD)): - git_export_utils.export_to_git('', 'Sillyness') + git_export_utils.export_to_git(course_key, 'Sillyness') with self.assertRaisesRegexp(GitExportError, str(GitExportError.URL_BAD)): - git_export_utils.export_to_git('', 'example.com:edx/notreal') + git_export_utils.export_to_git(course_key, 'example.com:edx/notreal') with self.assertRaisesRegexp(GitExportError, str(GitExportError.URL_NO_AUTH)): - git_export_utils.export_to_git('', 'http://blah') + git_export_utils.export_to_git(course_key, 'http://blah') def test_bad_git_repos(self): """ @@ -93,11 +101,12 @@ class TestGitExport(CourseTestCase): """ test_repo_path = '{}/test_repo'.format(git_export_utils.GIT_REPO_EXPORT_DIR) self.assertFalse(os.path.isdir(test_repo_path)) + course_key = SlashSeparatedCourseKey('foo', 'blah', '100-') # Test bad clones with self.assertRaisesRegexp(GitExportError, str(GitExportError.CANNOT_PULL)): git_export_utils.export_to_git( - 'foo/blah/100', + course_key, 'https://user:blah@example.com/test_repo.git') self.assertFalse(os.path.isdir(test_repo_path)) @@ -105,24 +114,16 @@ class TestGitExport(CourseTestCase): with self.assertRaisesRegexp(GitExportError, str(GitExportError.XML_EXPORT_FAIL)): git_export_utils.export_to_git( - 'foo/blah/100', + course_key, 'file://{0}'.format(self.bare_repo_dir)) # Test bad git remote after successful clone with self.assertRaisesRegexp(GitExportError, str(GitExportError.CANNOT_PULL)): git_export_utils.export_to_git( - 'foo/blah/100', + course_key, 'https://user:blah@example.com/r.git') - def test_bad_course_id(self): - """ - Test valid git url, but bad course. - """ - with self.assertRaisesRegexp(GitExportError, str(GitExportError.BAD_COURSE)): - git_export_utils.export_to_git( - '', 'file://{0}'.format(self.bare_repo_dir), '', '/blah') - @unittest.skipIf(os.environ.get('GIT_CONFIG') or os.environ.get('GIT_AUTHOR_EMAIL') or os.environ.get('GIT_AUTHOR_NAME') or @@ -170,7 +171,7 @@ class TestGitExport(CourseTestCase): Test response if there are no changes """ git_export_utils.export_to_git( - 'i4x://{0}'.format(self.course.id), + self.course.id, 'file://{0}'.format(self.bare_repo_dir) ) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_import.py b/cms/djangoapps/contentstore/management/commands/tests/test_import.py index 055d132f12..09cb87043e 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_import.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_import.py @@ -14,6 +14,7 @@ from contentstore.tests.modulestore_config import TEST_MODULESTORE from django_comment_common.utils import are_permissions_roles_seeded from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.locations import SlashSeparatedCourseKey @override_settings(MODULESTORE=TEST_MODULESTORE) @@ -22,8 +23,8 @@ class TestImport(ModuleStoreTestCase): Unit tests for importing a course from command line """ - COURSE_ID = ['EDx', '0.00x', '2013_Spring', ] - DIFF_RUN = ['EDx', '0.00x', '2014_Spring', ] + COURSE_KEY = SlashSeparatedCourseKey(u'edX', u'test_import_course', u'2013_Spring') + DIFF_KEY = SlashSeparatedCourseKey(u'edX', u'test_import_course', u'2014_Spring') def setUp(self): """ @@ -37,29 +38,29 @@ class TestImport(ModuleStoreTestCase): self.good_dir = tempfile.mkdtemp(dir=self.content_dir) os.makedirs(os.path.join(self.good_dir, "course")) with open(os.path.join(self.good_dir, "course.xml"), "w+") as f: - f.write(''.format(self.COURSE_ID)) + f.write(''.format(self.COURSE_KEY)) - with open(os.path.join(self.good_dir, "course", "{0[2]}.xml".format(self.COURSE_ID)), "w+") as f: + with open(os.path.join(self.good_dir, "course", "{0.run}.xml".format(self.COURSE_KEY)), "w+") as f: f.write('') # Create run changed course xml self.dupe_dir = tempfile.mkdtemp(dir=self.content_dir) os.makedirs(os.path.join(self.dupe_dir, "course")) with open(os.path.join(self.dupe_dir, "course.xml"), "w+") as f: - f.write(''.format(self.DIFF_RUN)) + f.write(''.format(self.DIFF_KEY)) - with open(os.path.join(self.dupe_dir, "course", "{0[2]}.xml".format(self.DIFF_RUN)), "w+") as f: + with open(os.path.join(self.dupe_dir, "course", "{0.run}.xml".format(self.DIFF_KEY)), "w+") as f: f.write('') def test_forum_seed(self): """ Tests that forum roles were created with import. """ - self.assertFalse(are_permissions_roles_seeded('/'.join(self.COURSE_ID))) + self.assertFalse(are_permissions_roles_seeded(self.COURSE_KEY)) call_command('import', self.content_dir, self.good_dir) - self.assertTrue(are_permissions_roles_seeded('/'.join(self.COURSE_ID))) + self.assertTrue(are_permissions_roles_seeded(self.COURSE_KEY)) def test_duplicate_with_url(self): """ @@ -70,8 +71,9 @@ class TestImport(ModuleStoreTestCase): # Load up base course and verify it is available call_command('import', self.content_dir, self.good_dir) store = modulestore() - self.assertIsNotNone(store.get_course('/'.join(self.COURSE_ID))) + self.assertIsNotNone(store.get_course(self.COURSE_KEY)) # Now load up duped course and verify it doesn't load call_command('import', self.content_dir, self.dupe_dir) - self.assertIsNone(store.get_course('/'.join(self.DIFF_RUN))) + self.assertIsNone(store.get_course(self.DIFF_KEY)) + self.assertTrue(are_permissions_roles_seeded(self.COURSE_KEY)) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_migrate_to_split.py b/cms/djangoapps/contentstore/management/commands/tests/test_migrate_to_split.py index 306ccabd2b..cbdcde47aa 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_migrate_to_split.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_migrate_to_split.py @@ -10,11 +10,12 @@ from contentstore.management.commands.migrate_to_split import Command from contentstore.tests.modulestore_config import TEST_MODULESTORE from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory -from xmodule.modulestore.django import modulestore, loc_mapper, clear_existing_modulestores +from xmodule.modulestore.django import modulestore, clear_existing_modulestores from xmodule.modulestore.locator import CourseLocator # pylint: disable=E1101 +@unittest.skip("Not fixing split mongo until we land this long branch") class TestArgParsing(unittest.TestCase): """ Tests for parsing arguments for the `migrate_to_split` management command @@ -43,6 +44,7 @@ class TestArgParsing(unittest.TestCase): self.command.handle("i4x://org/course/category/name", "fake@example.com") +@unittest.skip("Not fixing split mongo until we land this long branch") @override_settings(MODULESTORE=TEST_MODULESTORE) class TestMigrateToSplit(ModuleStoreTestCase): """ @@ -65,8 +67,7 @@ class TestMigrateToSplit(ModuleStoreTestCase): str(self.course.location), str(self.user.email), ) - locator = loc_mapper().translate_location(self.course.id, self.course.location) - course_from_split = modulestore('split').get_course(locator) + course_from_split = modulestore('split').get_course(self.course.id) self.assertIsNotNone(course_from_split) def test_user_id(self): @@ -75,8 +76,7 @@ class TestMigrateToSplit(ModuleStoreTestCase): str(self.course.location), str(self.user.id), ) - locator = loc_mapper().translate_location(self.course.id, self.course.location) - course_from_split = modulestore('split').get_course(locator) + course_from_split = modulestore('split').get_course(self.course.id) self.assertIsNotNone(course_from_split) def test_locator_string(self): @@ -84,8 +84,8 @@ class TestMigrateToSplit(ModuleStoreTestCase): "migrate_to_split", str(self.course.location), str(self.user.id), - "org.dept.name.run", + "org.dept+name.run", ) - locator = CourseLocator(package_id="org.dept.name.run", branch="published") + locator = CourseLocator(org="org.dept", offering="name.run", branch="published") course_from_split = modulestore('split').get_course(locator) self.assertIsNotNone(course_from_split) diff --git a/cms/djangoapps/contentstore/management/commands/tests/test_rollback_split_course.py b/cms/djangoapps/contentstore/management/commands/tests/test_rollback_split_course.py index 98b1ea807e..c7e66bccea 100644 --- a/cms/djangoapps/contentstore/management/commands/tests/test_rollback_split_course.py +++ b/cms/djangoapps/contentstore/management/commands/tests/test_rollback_split_course.py @@ -19,6 +19,7 @@ from xmodule.modulestore.split_migrator import SplitMigrator # pylint: disable=E1101 +@unittest.skip("Not fixing split mongo until we land opaque-keys 0.9") class TestArgParsing(unittest.TestCase): """ Tests for parsing arguments for the `rollback_split_course` management command @@ -37,6 +38,7 @@ class TestArgParsing(unittest.TestCase): self.command.handle("!?!") +@unittest.skip("Not fixing split mongo until we land opaque-keys 0.9") @override_settings(MODULESTORE=TEST_MODULESTORE) class TestRollbackSplitCourseNoOldMongo(ModuleStoreTestCase): """ @@ -54,6 +56,8 @@ class TestRollbackSplitCourseNoOldMongo(ModuleStoreTestCase): with self.assertRaisesRegexp(CommandError, errstring): Command().handle(str(locator)) + +@unittest.skip("Not fixing split mongo until we land opaque-keys 0.9") @override_settings(MODULESTORE=TEST_MODULESTORE) class TestRollbackSplitCourseNoSplitMongo(ModuleStoreTestCase): """ @@ -66,12 +70,13 @@ class TestRollbackSplitCourseNoSplitMongo(ModuleStoreTestCase): self.old_course = CourseFactory() def test_nonexistent_locator(self): - locator = loc_mapper().translate_location(self.old_course.id, self.old_course.location) + locator = loc_mapper().translate_location(self.old_course.location) errstring = "No course found with locator" with self.assertRaisesRegexp(CommandError, errstring): Command().handle(str(locator)) +@unittest.skip("Not fixing split mongo until we land opaque-keys 0.9") @override_settings(MODULESTORE=TEST_MODULESTORE) class TestRollbackSplitCourse(ModuleStoreTestCase): """ @@ -93,18 +98,17 @@ class TestRollbackSplitCourse(ModuleStoreTestCase): loc_mapper=loc_mapper(), ) migrator.migrate_mongo_course(self.old_course.location, self.user) - locator = loc_mapper().translate_location(self.old_course.id, self.old_course.location) - self.course = modulestore('split').get_course(locator) + self.course = modulestore('split').get_course(self.old_course.id) @patch("sys.stdout", new_callable=StringIO) def test_happy_path(self, mock_stdout): - locator = self.course.location + course_id = self.course.id call_command( "rollback_split_course", - str(locator), + str(course_id), ) with self.assertRaises(ItemNotFoundError): - modulestore('split').get_course(locator) + modulestore('split').get_course(course_id) self.assertIn("Course rolled back successfully", mock_stdout.getvalue()) diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py index 2539a4efbf..5d1ca5ffaf 100644 --- a/cms/djangoapps/contentstore/tests/test_contentstore.py +++ b/cms/djangoapps/contentstore/tests/test_contentstore.py @@ -16,8 +16,7 @@ from textwrap import dedent from uuid import uuid4 from django.conf import settings -from django.contrib.auth.models import User, Group -from django.dispatch import Signal +from django.contrib.auth.models import User from django.test import TestCase from django.test.utils import override_settings @@ -30,11 +29,12 @@ from xmodule.contentstore.content import StaticContent from xmodule.contentstore.django import contentstore, _CONTENTSTORE from xmodule.contentstore.utils import restore_asset_from_trashcan, empty_asset_trashcan from xmodule.exceptions import NotFoundError, InvalidVersionError -from xmodule.modulestore import Location, mongo -from xmodule.modulestore.django import modulestore, loc_mapper +from xmodule.modulestore import mongo +from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError from xmodule.modulestore.inheritance import own_metadata -from xmodule.modulestore.locator import BlockUsageLocator +from xmodule.modulestore.keys import UsageKey +from xmodule.modulestore.locations import SlashSeparatedCourseKey, AssetLocation from xmodule.modulestore.store_utilities import clone_course, delete_course from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory @@ -45,11 +45,14 @@ from xmodule.capa_module import CapaDescriptor from xmodule.course_module import CourseDescriptor from xmodule.seq_module import SequenceDescriptor -from contentstore.utils import delete_course_and_groups +from contentstore.utils import delete_course_and_groups, reverse_url, reverse_course_url from django_comment_common.utils import are_permissions_roles_seeded + from student import auth from student.models import CourseEnrollment from student.roles import CourseCreatorRole, CourseInstructorRole +from opaque_keys import InvalidKeyError + TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE) TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex @@ -65,6 +68,12 @@ class MongoCollectionFindWrapper(object): return self.original(query, *args, **kwargs) +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. + return reverse_url(handler_name, key_name, key_value, kwargs) + + @override_settings(CONTENTSTORE=TEST_DATA_CONTENTSTORE, MODULESTORE=TEST_MODULESTORE) class ContentStoreToyCourseTest(ModuleStoreTestCase): """ @@ -111,19 +120,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): component_types should cause 'Video' to be present. """ store = modulestore('direct') - import_from_xml(store, 'common/test/data/', ['simple']) - - course = store.get_item(Location(['i4x', 'edX', 'simple', - 'course', '2012_Fall', None]), depth=None) - + _, course_items = import_from_xml(store, 'common/test/data/', ['simple']) + course = course_items[0] course.advanced_modules = component_types - store.update_item(course, self.user.id) # just pick one vertical - descriptor = store.get_items(Location('i4x', 'edX', 'simple', 'vertical', None, None))[0] - locator = loc_mapper().translate_location(course.location.course_id, descriptor.location, True, True) - resp = self.client.get_html(locator.url_reverse('unit')) + descriptor = store.get_items(course.id, category='vertical',) + resp = self.client.get_html(get_url('unit_handler', descriptor[0].location)) self.assertEqual(resp.status_code, 200) _test_no_locations(self, resp) @@ -147,30 +151,29 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): _, course_items = import_from_xml(store, 'common/test/data/', ['simple']) # just pick one vertical - descriptor = store.get_items(Location('i4x', 'edX', 'simple', 'vertical', None, None))[0] - location = descriptor.location.replace(name='.' + descriptor.location.name) - locator = loc_mapper().translate_location( - course_items[0].location.course_id, location, add_entry_if_missing=True) + usage_key = course_items[0].id.make_usage_key('vertical', None) - resp = self.client.get_html(locator.url_reverse('unit')) + resp = self.client.get_html(get_url('unit_handler', usage_key)) self.assertEqual(resp.status_code, 400) _test_no_locations(self, resp, status_code=400) def check_edit_unit(self, test_course_name): _, course_items = import_from_xml(modulestore('direct'), 'common/test/data/', [test_course_name]) - items = modulestore().get_items(Location('i4x', 'edX', test_course_name, 'vertical', None, None)) - self._check_verticals(items, course_items[0].location.course_id) + items = modulestore().get_items(course_items[0].id, category='vertical') + self._check_verticals(items) - def _lock_an_asset(self, content_store, course_location): + def _lock_an_asset(self, content_store, course_id): """ Lock an arbitrary asset in the course :param course_location: """ - course_assets, __ = content_store.get_all_content_for_course(course_location) + course_assets, __ = content_store.get_all_content_for_course(course_id) self.assertGreater(len(course_assets), 0, "No assets to lock") - content_store.set_attr(course_assets[0]['_id'], 'locked', True) - return course_assets[0]['_id'] + asset_id = course_assets[0]['_id'] + asset_key = StaticContent.compute_location(course_id, asset_id['name']) + content_store.set_attr(asset_key, 'locked', True) + return asset_key def test_edit_unit_toy(self): self.check_edit_unit('toy') @@ -188,26 +191,29 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): Unfortunately, None = published for the revision field, so get_items() would return both draft and non-draft copies. ''' - store = modulestore('direct') + direct_store = modulestore('direct') draft_store = modulestore('draft') - import_from_xml(store, 'common/test/data/', ['simple']) + _, course_items = import_from_xml(direct_store, 'common/test/data/', ['simple']) + course_key = course_items[0].id + html_usage_key = course_key.make_usage_key('html', 'test_html') - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module_from_draft_store = draft_store.get_item(html_usage_key) + draft_store.convert_to_draft(html_module_from_draft_store.location) - draft_store.convert_to_draft(html_module.location) + # Query get_items() and find the html item. This should just return back a single item (not 2). - # now query get_items() to get this location with revision=None, this should just - # return back a single item (not 2) + direct_store_items = direct_store.get_items(course_key) + html_items_from_direct_store = [item for item in direct_store_items if (item.location == html_usage_key)] + self.assertEqual(len(html_items_from_direct_store), 1) + self.assertFalse(getattr(html_items_from_direct_store[0], 'is_draft', False)) - items = store.get_items(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) - self.assertEqual(len(items), 1) - self.assertFalse(getattr(items[0], 'is_draft', False)) + # Fetch from the draft store. Note that even though we pass + # None in the revision field, the draft store will replace that with 'draft'. + draft_store_items = draft_store.get_items(course_key) + html_items_from_draft_store = [item for item in draft_store_items if (item.location == html_usage_key)] + self.assertEqual(len(html_items_from_draft_store), 1) + self.assertTrue(getattr(html_items_from_draft_store[0], 'is_draft', False)) - # now refetch from the draft store. Note that even though we pass - # None in the revision field, the draft store will replace that with 'draft' - items = draft_store.get_items(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) - self.assertEqual(len(items), 1) - self.assertTrue(getattr(items[0], 'is_draft', False)) def test_draft_metadata(self): ''' @@ -219,9 +225,10 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): draft_store = modulestore('draft') import_from_xml(store, 'common/test/data/', ['simple']) - course = draft_store.get_item(Location('i4x', 'edX', 'simple', - 'course', '2012_Fall', None), depth=None) - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + course_key = SlashSeparatedCourseKey('edX', 'simple', '2012_Fall') + html_usage_key = course_key.make_usage_key('html', 'test_html') + course = draft_store.get_course(course_key) + html_module = draft_store.get_item(html_usage_key) self.assertEqual(html_module.graceperiod, course.graceperiod) self.assertNotIn('graceperiod', own_metadata(html_module)) @@ -229,7 +236,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): draft_store.convert_to_draft(html_module.location) # refetch to check metadata - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module = draft_store.get_item(html_usage_key) self.assertEqual(html_module.graceperiod, course.graceperiod) self.assertNotIn('graceperiod', own_metadata(html_module)) @@ -238,14 +245,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): draft_store.publish(html_module.location, 0) # refetch to check metadata - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module = draft_store.get_item(html_usage_key) self.assertEqual(html_module.graceperiod, course.graceperiod) self.assertNotIn('graceperiod', own_metadata(html_module)) # put back in draft and change metadata and see if it's now marked as 'own_metadata' draft_store.convert_to_draft(html_module.location) - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module = draft_store.get_item(html_usage_key) new_graceperiod = timedelta(hours=1) @@ -260,7 +267,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): draft_store.update_item(html_module, self.user.id) # read back to make sure it reads as 'own-metadata' - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module = draft_store.get_item(html_usage_key) self.assertIn('graceperiod', own_metadata(html_module)) self.assertEqual(html_module.graceperiod, new_graceperiod) @@ -270,7 +277,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # and re-read and verify 'own-metadata' draft_store.convert_to_draft(html_module.location) - html_module = draft_store.get_item(Location('i4x', 'edX', 'simple', 'html', 'test_html', None)) + html_module = draft_store.get_item(html_usage_key) self.assertIn('graceperiod', own_metadata(html_module)) self.assertEqual(html_module.graceperiod, new_graceperiod) @@ -278,33 +285,25 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): def test_get_depth_with_drafts(self): import_from_xml(modulestore('direct'), 'common/test/data/', ['simple']) - course = modulestore('draft').get_item( - Location('i4x', 'edX', 'simple', 'course', '2012_Fall', None), - depth=None - ) + course_key = SlashSeparatedCourseKey('edX', 'simple', '2012_Fall') + course = modulestore('draft').get_course(course_key) # make sure no draft items have been returned num_drafts = self._get_draft_counts(course) self.assertEqual(num_drafts, 0) - problem = modulestore('draft').get_item( - Location('i4x', 'edX', 'simple', 'problem', 'ps01-simple', None) - ) + problem_usage_key = course_key.make_usage_key('problem', 'ps01-simple') + problem = modulestore('draft').get_item(problem_usage_key) # put into draft modulestore('draft').convert_to_draft(problem.location) # make sure we can query that item and verify that it is a draft - draft_problem = modulestore('draft').get_item( - Location('i4x', 'edX', 'simple', 'problem', 'ps01-simple', None) - ) + draft_problem = modulestore('draft').get_item(problem_usage_key) self.assertTrue(getattr(draft_problem, 'is_draft', False)) # now requery with depth - course = modulestore('draft').get_item( - Location('i4x', 'edX', 'simple', 'course', '2012_Fall', None), - depth=None - ) + course = modulestore('draft').get_course(course_key) # make sure just one draft item have been returned num_drafts = self._get_draft_counts(course) @@ -312,12 +311,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): def test_no_static_link_rewrites_on_import(self): module_store = modulestore('direct') - import_from_xml(module_store, 'common/test/data/', ['toy']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) + course = course_items[0] - handouts = module_store.get_item(Location('i4x', 'edX', 'toy', 'course_info', 'handouts', None)) + handouts_usage_key = course.id.make_usage_key('course_info', 'handouts') + handouts = module_store.get_item(handouts_usage_key) self.assertIn('/static/', handouts.data) - handouts = module_store.get_item(Location('i4x', 'edX', 'toy', 'html', 'toyhtml', None)) + handouts_usage_key = course.id.make_usage_key('html', 'toyhtml') + handouts = module_store.get_item(handouts_usage_key) self.assertIn('/static/', handouts.data) @mock.patch('xmodule.course_module.requests.get') @@ -330,150 +332,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): module_store = modulestore('direct') import_from_xml(module_store, 'common/test/data/', ['toy']) - - course = module_store.get_item(Location('i4x', 'edX', 'toy', 'course', '2012_Fall', None)) - + course = module_store.get_course(SlashSeparatedCourseKey('edX', 'toy', '2012_Fall')) self.assertGreater(len(course.textbooks), 0) - def test_default_tabs_on_create_course(self): - module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - course_location = Location('i4x', 'edX', '999', 'course', 'Robot_Super_Course', None) - - course = module_store.get_item(course_location) - - expected_tabs = [] - expected_tabs.append({u'type': u'courseware'}) - expected_tabs.append({u'type': u'course_info', u'name': u'Course Info'}) - expected_tabs.append({u'type': u'textbooks'}) - expected_tabs.append({u'type': u'discussion', u'name': u'Discussion'}) - expected_tabs.append({u'type': u'wiki', u'name': u'Wiki'}) - expected_tabs.append({u'type': u'progress', u'name': u'Progress'}) - - self.assertEqual(course.tabs, expected_tabs) - - def test_create_static_tab_and_rename(self): - module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - course_location = Location('i4x', 'edX', '999', 'course', 'Robot_Super_Course', None) - - item = ItemFactory.create(parent_location=course_location, category='static_tab', display_name="My Tab") - - course = module_store.get_item(course_location) - - expected_tabs = [] - expected_tabs.append({u'type': u'courseware'}) - expected_tabs.append({u'type': u'course_info', u'name': u'Course Info'}) - expected_tabs.append({u'type': u'textbooks'}) - expected_tabs.append({u'type': u'discussion', u'name': u'Discussion'}) - expected_tabs.append({u'type': u'wiki', u'name': u'Wiki'}) - expected_tabs.append({u'type': u'progress', u'name': u'Progress'}) - expected_tabs.append({u'type': u'static_tab', u'name': u'My Tab', u'url_slug': u'My_Tab'}) - - self.assertEqual(course.tabs, expected_tabs) - - item.display_name = 'Updated' - module_store.update_item(item, self.user.id) - - course = module_store.get_item(course_location) - - expected_tabs = [] - expected_tabs.append({u'type': u'courseware'}) - expected_tabs.append({u'type': u'course_info', u'name': u'Course Info'}) - expected_tabs.append({u'type': u'textbooks'}) - expected_tabs.append({u'type': u'discussion', u'name': u'Discussion'}) - expected_tabs.append({u'type': u'wiki', u'name': u'Wiki'}) - expected_tabs.append({u'type': u'progress', u'name': u'Progress'}) - expected_tabs.append({u'type': u'static_tab', u'name': u'Updated', u'url_slug': u'My_Tab'}) - - self.assertEqual(course.tabs, expected_tabs) - - def test_static_tab_reordering(self): - module_store, course_location, new_location = self._create_static_tabs() - - course = module_store.get_item(course_location) - - # reverse the ordering of the static tabs - reverse_static_tabs = [] - built_in_tabs = [] - for tab in course.tabs: - if tab['type'] == 'static_tab': - reverse_static_tabs.insert(0, tab) - else: - built_in_tabs.append(tab) - - # create the requested tab_id_locators list - tab_id_locators = [ - { - 'tab_id': tab.tab_id - } for tab in built_in_tabs - ] - tab_id_locators.extend([ - { - 'tab_locator': unicode(self._get_tab_locator(course, tab)) - } for tab in reverse_static_tabs - ]) - - self.client.ajax_post(new_location.url_reverse('tabs'), {'tabs': tab_id_locators}) - - course = module_store.get_item(course_location) - - # compare to make sure that the tabs information is in the expected order after the server call - new_static_tabs = [tab for tab in course.tabs if (tab['type'] == 'static_tab')] - self.assertEqual(reverse_static_tabs, new_static_tabs) - - def test_static_tab_deletion(self): - module_store, course_location, _ = self._create_static_tabs() - - course = module_store.get_item(course_location) - num_tabs = len(course.tabs) - last_tab = course.tabs[-1] - url_slug = last_tab['url_slug'] - delete_url = self._get_tab_locator(course, last_tab).url_reverse('xblock') - - self.client.delete(delete_url) - - course = module_store.get_item(course_location) - self.assertEqual(num_tabs - 1, len(course.tabs)) - - def tab_matches(tab): - """ Checks if the tab matches the one we deleted """ - return tab['type'] == 'static_tab' and tab['url_slug'] == url_slug - - tab_found = any(tab_matches(tab) for tab in course.tabs) - - self.assertFalse(tab_found, "tab should have been deleted") - - def _get_tab_locator(self, course, tab): - """ Returns the locator for a given tab. """ - tab_location = 'i4x://edX/999/static_tab/{0}'.format(tab['url_slug']) - return loc_mapper().translate_location( - course.location.course_id, Location(tab_location), True, True - ) - - def _create_static_tabs(self): - """ Creates two static tabs in a dummy course. """ - module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - course_location = Location('i4x', 'edX', '999', 'course', 'Robot_Super_Course', None) - new_location = loc_mapper().translate_location(course_location.course_id, course_location, True, True) - - ItemFactory.create( - parent_location=course_location, - category="static_tab", - display_name="Static_1") - ItemFactory.create( - parent_location=course_location, - category="static_tab", - display_name="Static_2") - - return module_store, course_location, new_location - def test_import_polls(self): module_store = modulestore('direct') - import_from_xml(module_store, 'common/test/data/', ['toy']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) + course_key = course_items[0].id - items = module_store.get_items(Location('i4x', 'edX', 'toy', 'poll_question', None, None)) + items = module_store.get_items(course_key, category='poll_question') found = len(items) > 0 self.assertTrue(found) @@ -489,59 +356,54 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): """ Tests the ajax callback to render an XModule """ - resp = self._test_preview(Location('i4x', 'edX', 'toy', 'vertical', 'vertical_test', None), 'container_preview') - # These are the data-ids of the xblocks contained in the vertical. - # Ultimately, these must be converted to new locators. - self.assertContains(resp, 'i4x://edX/toy/video/sample_video') - self.assertContains(resp, 'i4x://edX/toy/video/separate_file_video') - self.assertContains(resp, 'i4x://edX/toy/video/video_with_end_time') - self.assertContains(resp, 'i4x://edX/toy/poll_question/T1_changemind_poll_foo_2') - - def _test_preview(self, location, view_name): - """ Preview test case. """ direct_store = modulestore('direct') _, course_items = import_from_xml(direct_store, '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 - locator = loc_mapper().translate_location( - course_items[0].location.course_id, location, True, True + resp = self.client.get_json( + get_url('xblock_view_handler', usage_key, kwargs={'view_name': 'container_preview'}) ) - resp = self.client.get_json(locator.url_reverse('xblock', view_name)) self.assertEqual(resp.status_code, 200) # TODO: uncomment when preview no longer has locations being returned. # _test_no_locations(self, resp) - return resp + + # 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') def test_delete(self): direct_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - course_location = Location('i4x', 'edX', '999', 'course', 'Robot_Super_Course', None) + course = CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - chapterloc = ItemFactory.create(parent_location=course_location, display_name="Chapter").location + chapterloc = ItemFactory.create(parent_location=course.location, display_name="Chapter").location ItemFactory.create(parent_location=chapterloc, category='sequential', display_name="Sequential") - sequential = direct_store.get_item(Location('i4x', 'edX', '999', 'sequential', 'Sequential', None)) - chapter = direct_store.get_item(Location('i4x', 'edX', '999', 'chapter', 'Chapter', None)) + sequential_key = course.id.make_usage_key('sequential', 'Sequential') + sequential = direct_store.get_item(sequential_key) + chapter_key = course.id.make_usage_key('chapter', 'Chapter') + chapter = direct_store.get_item(chapter_key) # make sure the parent points to the child object which is to be deleted - self.assertTrue(sequential.location.url() in chapter.children) + self.assertTrue(sequential.location in chapter.children) - location = loc_mapper().translate_location(course_location.course_id, sequential.location, True, True) - self.client.delete(location.url_reverse('xblock'), {'recurse': True, 'all_versions': True}) + self.client.delete(get_url('xblock_handler', sequential_key), {'recurse': True, 'all_versions': True}) found = False try: - direct_store.get_item(Location(['i4x', 'edX', '999', 'sequential', 'Sequential', None])) + direct_store.get_item(sequential_key) found = True except ItemNotFoundError: pass self.assertFalse(found) - chapter = direct_store.get_item(Location(['i4x', 'edX', '999', 'chapter', 'Chapter', None])) + chapter = direct_store.get_item(chapter_key) # make sure the parent no longer points to the child object which was deleted - self.assertFalse(sequential.location.url() in chapter.children) + self.assertFalse(sequential.location in chapter.children) def test_about_overrides(self): ''' @@ -549,21 +411,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): while there is a base definition in /about/effort.html ''' module_store = modulestore('direct') - import_from_xml(module_store, 'common/test/data/', ['toy']) - effort = module_store.get_item(Location(['i4x', 'edX', 'toy', 'about', 'effort', None])) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) + course_key = course_items[0].id + effort = module_store.get_item(course_key.make_usage_key('about', 'effort')) self.assertEqual(effort.data, '6 hours') # this one should be in a non-override folder - effort = module_store.get_item(Location(['i4x', 'edX', 'toy', 'about', 'end_date', None])) + effort = module_store.get_item(course_key.make_usage_key('about', 'end_date')) self.assertEqual(effort.data, 'TBD') - def test_remove_hide_progress_tab(self): - module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - course_location = Location(['i4x', 'edX', '999', 'course', 'Robot_Super_Course', None]) - course = module_store.get_item(course_location) - self.assertFalse(course.hide_progress_tab) - def test_asset_import(self): ''' This test validates that an image asset is imported and a thumbnail was generated for a .gif @@ -573,17 +429,16 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): module_store = modulestore('direct') import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store, verbose=True) - course_location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') - course = module_store.get_item(course_location) + course = module_store.get_course(SlashSeparatedCourseKey('edX', 'toy', '2012_Fall')) self.assertIsNotNone(course) # make sure we have some assets in our contentstore - all_assets, __ = content_store.get_all_content_for_course(course_location) + all_assets, __ = content_store.get_all_content_for_course(course.id) self.assertGreater(len(all_assets), 0) # make sure we have some thumbnails in our contentstore - content_store.get_all_content_thumbnails_for_course(course_location) + content_store.get_all_content_thumbnails_for_course(course.id) # # cdodge: temporarily comment out assertion on thumbnails because many environments @@ -594,7 +449,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content = None try: - location = StaticContent.get_location_from_path('/c4x/edX/toy/asset/sample_static.txt') + location = AssetLocation.from_deprecated_string('/c4x/edX/toy/asset/sample_static.txt') content = content_store.find(location) except NotFoundError: pass @@ -619,8 +474,8 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): ''' This test will exercise the soft delete/restore functionality of the assets ''' - content_store, trash_store, thumbnail_location = self._delete_asset_in_course() - asset_location = StaticContent.get_location_from_path('/c4x/edX/toy/asset/sample_static.txt') + content_store, trash_store, thumbnail_location, _location = self._delete_asset_in_course() + asset_location = AssetLocation.from_deprecated_string('/c4x/edX/toy/asset/sample_static.txt') # now try to find it in store, but they should not be there any longer content = content_store.find(asset_location, throw_on_not_found=False) @@ -664,7 +519,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store) # look up original (and thumbnail) in content store, should be there after import - location = StaticContent.get_location_from_path('/c4x/edX/toy/asset/sample_static.txt') + location = AssetLocation.from_deprecated_string('/c4x/edX/toy/asset/sample_static.txt') content = content_store.find(location, throw_on_not_found=False) thumbnail_location = content.thumbnail_location self.assertIsNotNone(content) @@ -677,12 +532,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # go through the website to do the delete, since the soft-delete logic is in the view course = course_items[0] - location = loc_mapper().translate_location(course.location.course_id, course.location, True, True) - url = location.url_reverse('assets/', '/c4x/edX/toy/asset/sample_static.txt') + url = reverse_course_url( + 'assets_handler', + course.id, + kwargs={'asset_key_string': course.id.make_asset_key('asset', 'sample_static.txt')} + ) resp = self.client.delete(url) self.assertEqual(resp.status_code, 204) - return content_store, trash_store, thumbnail_location + return content_store, trash_store, thumbnail_location, location def test_course_info_updates_import_export(self): """ @@ -694,17 +552,16 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): import_from_xml(module_store, data_dir, ['course_info_updates'], static_content_store=content_store, verbose=True) - course_location = CourseDescriptor.id_to_location('edX/course_info_updates/2014_T1') - course = module_store.get_item(course_location) + course_id = SlashSeparatedCourseKey('edX', 'course_info_updates', '2014_T1') + course = module_store.get_course(course_id) self.assertIsNotNone(course) - course_updates = module_store.get_item( - Location(['i4x', 'edX', 'course_info_updates', 'course_info', 'updates', None])) + course_updates = module_store.get_item(course_id.make_usage_key('course_info', 'updates')) self.assertIsNotNone(course_updates) - # check that course which is imported has files 'updates.html' and 'updates.items.json' + # check that course which is imported has files 'updates.html' and 'updates.items.json' filesystem = OSFS(data_dir + 'course_info_updates/info') self.assertTrue(filesystem.exists('updates.html')) self.assertTrue(filesystem.exists('updates.items.json')) @@ -724,7 +581,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # with same content as in course 'info' directory root_dir = path(mkdtemp_clean()) print 'Exporting to tempdir = {0}'.format(root_dir) - export_to_xml(module_store, content_store, course_location, root_dir, 'test_export') + export_to_xml(module_store, content_store, course_id, root_dir, 'test_export') # check that exported course has files 'updates.html' and 'updates.items.json' filesystem = OSFS(root_dir / 'test_export/info') @@ -744,15 +601,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): ''' This test will exercise the emptying of the asset trashcan ''' - _, trash_store, _ = self._delete_asset_in_course() + __, trash_store, __, _location = self._delete_asset_in_course() # make sure there's something in the trashcan - course_location = CourseDescriptor.id_to_location('edX/toy/6.002_Spring_2012') - all_assets, __ = trash_store.get_all_content_for_course(course_location) + course_id = SlashSeparatedCourseKey('edX', 'toy', '6.002_Spring_2012') + all_assets, __ = trash_store.get_all_content_for_course(course_id) self.assertGreater(len(all_assets), 0) # make sure we have some thumbnails in our trashcan - _all_thumbnails = trash_store.get_all_content_thumbnails_for_course(course_location) + _all_thumbnails = trash_store.get_all_content_thumbnails_for_course(course_id) # # cdodge: temporarily comment out assertion on thumbnails because many environments # will not have the jpeg converter installed and this test will fail @@ -760,14 +617,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # self.assertGreater(len(all_thumbnails), 0) # empty the trashcan - empty_asset_trashcan([course_location]) + empty_asset_trashcan([course_id]) # make sure trashcan is empty - all_assets, count = trash_store.get_all_content_for_course(course_location) + all_assets, count = trash_store.get_all_content_for_course(course_id) self.assertEqual(len(all_assets), 0) self.assertEqual(count, 0) - all_thumbnails = trash_store.get_all_content_thumbnails_for_course(course_location) + all_thumbnails = trash_store.get_all_content_thumbnails_for_course(course_id) self.assertEqual(len(all_thumbnails), 0) def test_clone_course(self): @@ -776,63 +633,57 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): 'org': 'MITx', 'number': '999', 'display_name': 'Robot Super Course', - 'run': '2013_Spring' + 'run': '2013_Spring', } module_store = modulestore('direct') draft_store = modulestore('draft') - import_from_xml(module_store, 'common/test/data/', ['toy']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) - source_course_id = 'edX/toy/2012_Fall' - dest_course_id = 'MITx/999/2013_Spring' - source_location = CourseDescriptor.id_to_location(source_course_id) - dest_location = CourseDescriptor.id_to_location(dest_course_id) + source_course_id = course_items[0].id + dest_course_id = _get_course_id(course_data) # get a vertical (and components in it) to put into 'draft' # this is to assert that draft content is also cloned over - vertical = module_store.get_instance(source_course_id, Location([ - source_location.tag, source_location.org, source_location.course, 'vertical', 'vertical_test', None]), depth=1) + vertical = module_store.get_item( + source_course_id.make_usage_key('vertical', 'vertical_test'), + depth=1 + ) draft_store.convert_to_draft(vertical.location) for child in vertical.get_children(): draft_store.convert_to_draft(child.location) - items = module_store.get_items(Location([source_location.tag, source_location.org, source_location.course, None, None, 'draft'])) + items = module_store.get_items(source_course_id, revision='draft') self.assertGreater(len(items), 0) - _create_course(self, course_data) + _create_course(self, dest_course_id, course_data) content_store = contentstore() # now do the actual cloning - clone_course(module_store, content_store, source_location, dest_location) + clone_course(module_store, content_store, source_course_id, dest_course_id) # first assert that all draft content got cloned as well - items = module_store.get_items(Location([source_location.tag, source_location.org, source_location.course, None, None, 'draft'])) + items = module_store.get_items(source_course_id, revision='draft') self.assertGreater(len(items), 0) - clone_items = module_store.get_items(Location([dest_location.tag, dest_location.org, dest_location.course, None, None, 'draft'])) + clone_items = module_store.get_items(dest_course_id, revision='draft') self.assertGreater(len(clone_items), 0) self.assertEqual(len(items), len(clone_items)) # now loop through all the units in the course and verify that the clone can render them, which # means the objects are at least present - items = module_store.get_items(Location([source_location.tag, source_location.org, source_location.course, None, None])) + items = module_store.get_items(source_course_id, revision=None) self.assertGreater(len(items), 0) - clone_items = module_store.get_items(Location([dest_location.tag, dest_location.org, dest_location.course, None, None])) + clone_items = module_store.get_items(dest_course_id, revision=None) self.assertGreater(len(clone_items), 0) for descriptor in items: - source_item = module_store.get_instance(source_course_id, descriptor.location) - if descriptor.location.category == 'course': - new_loc = descriptor.location.replace(org=dest_location.org, course=dest_location.course, name='2013_Spring') - else: - new_loc = descriptor.location.replace(org=dest_location.org, course=dest_location.course) - print "Checking {0} should now also be at {1}".format(descriptor.location.url(), new_loc.url()) + source_item = module_store.get_item(descriptor.location) + new_loc = descriptor.location.map_into_course(dest_course_id) + print "Checking {0} should now also be at {1}".format(descriptor.location, new_loc) lookup_item = module_store.get_item(new_loc) - # we want to assert equality between the objects, but we know the locations - # differ, so just make them equal for testing purposes - source_item.location = new_loc if hasattr(source_item, 'data') and hasattr(lookup_item, 'data'): self.assertEqual(source_item.data, lookup_item.data) @@ -844,14 +695,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(source_item.has_children, lookup_item.has_children) if source_item.has_children: expected_children = [] - for child_loc_url in source_item.children: - child_loc = Location(child_loc_url) - child_loc = child_loc.replace( - tag=dest_location.tag, - org=dest_location.org, - course=dest_location.course - ) - expected_children.append(child_loc.url()) + for child_loc in source_item.children: + child_loc = child_loc.map_into_course(dest_course_id) + expected_children.append(child_loc) self.assertEqual(expected_children, lookup_item.children) def test_portable_link_rewrites_during_clone_course(self): @@ -867,37 +713,31 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): import_from_xml(module_store, 'common/test/data/', ['toy']) - source_course_id = 'edX/toy/2012_Fall' - dest_course_id = 'MITx/999/2013_Spring' - source_location = CourseDescriptor.id_to_location(source_course_id) - dest_location = CourseDescriptor.id_to_location(dest_course_id) + source_course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') + dest_course_id = _get_course_id(course_data) # let's force a non-portable link in the clone source # as a final check, make sure that any non-portable links are rewritten during cloning - html_module_location = Location([ - source_location.tag, source_location.org, source_location.course, 'html', 'nonportable']) - html_module = module_store.get_instance(source_location.course_id, html_module_location) + html_module = module_store.get_item(source_course_id.make_usage_key('html', 'nonportable')) self.assertIsInstance(html_module.data, basestring) new_data = html_module.data = html_module.data.replace('/static/', '/c4x/{0}/{1}/asset/'.format( - source_location.org, source_location.course)) + source_course_id.org, source_course_id.run)) module_store.update_item(html_module, self.user.id) - html_module = module_store.get_instance(source_location.course_id, html_module_location) + html_module = module_store.get_item(html_module.location) self.assertEqual(new_data, html_module.data) # create the destination course - _create_course(self, course_data) + _create_course(self, dest_course_id, course_data) # do the actual cloning - clone_course(module_store, content_store, source_location, dest_location) + clone_course(module_store, content_store, source_course_id, dest_course_id) # make sure that any non-portable links are rewritten during cloning - html_module_location = Location([ - dest_location.tag, dest_location.org, dest_location.course, 'html', 'nonportable']) - html_module = module_store.get_instance(dest_location.course_id, html_module_location) + html_module = module_store.get_item(dest_course_id.make_usage_key('html', 'nonportable')) - self.assertIn('/static/foo.jpg', html_module.data) + self.assertIn('/asset/foo.jpg', html_module.data) def test_illegal_draft_crud_ops(self): draft_store = modulestore('draft') @@ -905,18 +745,21 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): course = CourseFactory.create(org='MITx', course='999', display_name='Robot Super Course') - location = Location('i4x://MITx/999/chapter/neuvo') + location = course.id.make_usage_key('chapter', 'neuvo') # Ensure draft mongo store does not allow us to create chapters either directly or via convert to draft - self.assertRaises(InvalidVersionError, draft_store.create_and_save_xmodule, location) + with self.assertRaises(InvalidVersionError): + draft_store.create_and_save_xmodule(location) direct_store.create_and_save_xmodule(location) - self.assertRaises(InvalidVersionError, draft_store.convert_to_draft, location) - chapter = draft_store.get_instance(course.id, location) + with self.assertRaises(InvalidVersionError): + draft_store.convert_to_draft(location) + chapter = draft_store.get_item(location) chapter.data = 'chapter data' with self.assertRaises(InvalidVersionError): draft_store.update_item(chapter, self.user.id) - self.assertRaises(InvalidVersionError, draft_store.unpublish, location) + with self.assertRaises(InvalidVersionError): + draft_store.unpublish(location) def test_bad_contentstore_request(self): resp = self.client.get_html('http://localhost:8001/c4x/CDX/123123/asset/&images_circuits_Lab7Solution2.png') @@ -930,13 +773,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store) # first check a static asset link - html_module_location = Location(['i4x', 'edX', 'toy', 'html', 'nonportable']) - html_module = module_store.get_instance('edX/toy/2012_Fall', html_module_location) + course_key = SlashSeparatedCourseKey('edX', 'toy', 'run') + html_module_location = course_key.make_usage_key('html', 'nonportable') + html_module = module_store.get_item(html_module_location) self.assertIn('/static/foo.jpg', html_module.data) # then check a intra courseware link - html_module_location = Location(['i4x', 'edX', 'toy', 'html', 'nonportable_link']) - html_module = module_store.get_instance('edX/toy/2012_Fall', html_module_location) + html_module_location = course_key.make_usage_key('html', 'nonportable_link') + html_module = module_store.get_item(html_module_location) self.assertIn('/jump_to_id/nonportable_link', html_module.data) def test_delete_course(self): @@ -949,37 +793,35 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content_store = contentstore() draft_store = modulestore('draft') - import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store) - location = CourseFactory.create(org='MITx', course='999', display_name='Robot Super Course').location + course_id = course_items[0].id # get a vertical (and components in it) to put into 'draft' - vertical = module_store.get_item(Location(['i4x', 'edX', 'toy', - 'vertical', 'vertical_test', None]), depth=1) + vertical = module_store.get_item(course_id.make_usage_key('vertical', 'vertical_test'), depth=1) draft_store.convert_to_draft(vertical.location) for child in vertical.get_children(): draft_store.convert_to_draft(child.location) # delete the course - delete_course(module_store, content_store, location, commit=True) + delete_course(module_store, content_store, course_id, commit=True) # assert that there's absolutely no non-draft modules in the course # this should also include all draft items - items = module_store.get_items(Location(['i4x', 'edX', '999', 'course', None])) + items = module_store.get_items(course_id) self.assertEqual(len(items), 0) # assert that all content in the asset library is also deleted - assets, count = content_store.get_all_content_for_course(location) + assets, count = content_store.get_all_content_for_course(course_id) self.assertEqual(len(assets), 0) self.assertEqual(count, 0) - def verify_content_existence(self, store, root_dir, location, dirname, category_name, filename_suffix=''): + def verify_content_existence(self, store, root_dir, course_id, dirname, category_name, filename_suffix=''): filesystem = OSFS(root_dir / 'test_export') self.assertTrue(filesystem.exists(dirname)) - query_loc = Location('i4x', location.org, location.course, category_name, None) - items = store.get_items(query_loc) + items = store.get_items(course_id, category=category_name) for item in items: filesystem = OSFS(root_dir / ('test_export/' + dirname)) @@ -998,13 +840,10 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content_store = contentstore() import_from_xml(module_store, 'common/test/data/', ['toy'], static_content_store=content_store) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') + course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') # get a vertical (and components in it) to copy into an orphan sub dag - vertical = module_store.get_item( - Location(['i4x', 'edX', 'toy', 'vertical', 'vertical_test', None]), - depth=1 - ) + vertical = module_store.get_item(course_id.make_usage_key('vertical', 'vertical_test'), depth=1) # We had a bug where orphaned draft nodes caused export to fail. This is here to cover that case. vertical.location = mongo.draft.as_draft(vertical.location.replace(name='no_references')) @@ -1013,9 +852,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(orphan_vertical.location.name, 'no_references') # get the original vertical (and components in it) to put into 'draft' - vertical = module_store.get_item( - Location(['i4x', 'edX', 'toy', 'vertical', 'vertical_test', None]), - depth=1) + vertical = module_store.get_item(course_id.make_usage_key('vertical', 'vertical_test'), depth=1) self.assertEqual(len(orphan_vertical.children), len(vertical.children)) draft_store.convert_to_draft(vertical.location) for child in vertical.get_children(): @@ -1024,46 +861,43 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): root_dir = path(mkdtemp_clean()) # now create a new/different private (draft only) vertical - vertical.location = mongo.draft.as_draft(Location(['i4x', 'edX', 'toy', 'vertical', 'a_private_vertical', None])) + vertical.location = mongo.draft.as_draft(course_id.make_usage_key('vertical', 'a_private_vertical')) draft_store.update_item(vertical, allow_not_found=True) private_vertical = draft_store.get_item(vertical.location) vertical = None # blank out b/c i destructively manipulated its location 2 lines above # add the new private to list of children - sequential = module_store.get_item( - Location('i4x', 'edX', 'toy', 'sequential', 'vertical_sequential', None) - ) + sequential = module_store.get_item(course_id.make_usage_key('sequential', 'vertical_sequential')) private_location_no_draft = private_vertical.location.replace(revision=None) - sequential.children.append(private_location_no_draft.url()) + sequential.children.append(private_location_no_draft) module_store.update_item(sequential, self.user.id) # read back the sequential, to make sure we have a pointer to - sequential = module_store.get_item(Location(['i4x', 'edX', 'toy', - 'sequential', 'vertical_sequential', None])) + sequential = module_store.get_item(course_id.make_usage_key('sequential', 'vertical_sequential')) - self.assertIn(private_location_no_draft.url(), sequential.children) + self.assertIn(private_location_no_draft, sequential.children) - locked_asset = self._lock_an_asset(content_store, location) - locked_asset_attrs = content_store.get_attrs(locked_asset) + locked_asset_key = self._lock_an_asset(content_store, course_id) + locked_asset_attrs = content_store.get_attrs(locked_asset_key) # the later import will reupload del locked_asset_attrs['uploadDate'] print 'Exporting to tempdir = {0}'.format(root_dir) # export out to a tempdir - export_to_xml(module_store, content_store, location, root_dir, 'test_export', draft_modulestore=draft_store) + export_to_xml(module_store, content_store, course_id, root_dir, 'test_export', draft_modulestore=draft_store) # check for static tabs - self.verify_content_existence(module_store, root_dir, location, 'tabs', 'static_tab', '.html') + self.verify_content_existence(module_store, root_dir, course_id, 'tabs', 'static_tab', '.html') # check for about content - self.verify_content_existence(module_store, root_dir, location, 'about', 'about', '.html') + self.verify_content_existence(module_store, root_dir, course_id, 'about', 'about', '.html') - # check for graiding_policy.json + # check for grading_policy.json filesystem = OSFS(root_dir / 'test_export/policies/2012_Fall') self.assertTrue(filesystem.exists('grading_policy.json')) - course = module_store.get_item(location) + course = module_store.get_course(course_id) # compare what's on disk compared to what we have in our course with filesystem.open('grading_policy.json', 'r') as grading_policy: on_disk = loads(grading_policy.read()) @@ -1079,42 +913,38 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(on_disk['course/2012_Fall'], own_metadata(course)) # remove old course - delete_course(module_store, content_store, location, commit=True) + delete_course(module_store, content_store, course_id, commit=True) # reimport over old course - stub_location = Location(['i4x', 'edX', 'toy', None, None]) - course_location = course.location self.check_import( - module_store, root_dir, draft_store, content_store, stub_location, course_location, - locked_asset, locked_asset_attrs + module_store, root_dir, draft_store, content_store, course_id, + locked_asset_key, locked_asset_attrs ) # import to different course id - stub_location = Location(['i4x', 'anotherX', 'anotherToy', None, None]) - course_location = stub_location.replace(category='course', name='Someday') self.check_import( - module_store, root_dir, draft_store, content_store, stub_location, course_location, - locked_asset, locked_asset_attrs + module_store, root_dir, draft_store, content_store, SlashSeparatedCourseKey('anotherX', 'anotherToy', 'Someday'), + locked_asset_key, locked_asset_attrs ) shutil.rmtree(root_dir) - def check_import(self, module_store, root_dir, draft_store, content_store, stub_location, course_location, - locked_asset, locked_asset_attrs): + def check_import(self, module_store, root_dir, draft_store, content_store, course_id, + locked_asset_key, locked_asset_attrs): # reimport import_from_xml( - module_store, root_dir, ['test_export'], draft_store=draft_store, + module_store, + root_dir, + ['test_export'], + draft_store=draft_store, static_content_store=content_store, - target_location_namespace=course_location + target_course_id=course_id, ) - # Unit test fails in Jenkins without this. - loc_mapper().translate_location(course_location.course_id, course_location, True, True) - - items = module_store.get_items(stub_location.replace(category='vertical', name=None)) - self._check_verticals(items, course_location.course_id) + items = module_store.get_items(course_id, category='vertical') + self._check_verticals(items) # verify that we have the content in the draft store as well vertical = draft_store.get_item( - stub_location.replace(category='vertical', name='vertical_test', revision=None), + course_id.make_usage_key('vertical', 'vertical_test'), depth=1 ) @@ -1133,26 +963,25 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # make sure that we don't have a sequential that is in draft mode sequential = draft_store.get_item( - stub_location.replace(category='sequential', name='vertical_sequential', revision=None) + course_id.make_usage_key('sequential', 'vertical_sequential') ) self.assertFalse(getattr(sequential, 'is_draft', False)) # verify that we have the private vertical test_private_vertical = draft_store.get_item( - stub_location.replace(category='vertical', name='a_private_vertical', revision=None) + course_id.make_usage_key('vertical', 'a_private_vertical') ) self.assertTrue(getattr(test_private_vertical, 'is_draft', False)) # make sure the textbook survived the export/import - course = module_store.get_item(course_location) + course = module_store.get_course(course_id) self.assertGreater(len(course.textbooks), 0) - locked_asset['course'] = stub_location.course - locked_asset['org'] = stub_location.org - new_attrs = content_store.get_attrs(locked_asset) + locked_asset_key = locked_asset_key.map_into_course(course_id) + new_attrs = content_store.get_attrs(locked_asset_key) for key, value in locked_asset_attrs.iteritems(): if key == '_id': self.assertEqual(value['name'], new_attrs[key]['name']) @@ -1167,12 +996,12 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content_store = contentstore() import_from_xml(module_store, 'common/test/data/', ['toy']) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') + course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') # create a new video module and add it as a child to a vertical # this re-creates a bug whereby since the video template doesn't have # anything in 'data' field, the export was blowing up - verticals = module_store.get_items(Location('i4x', 'edX', 'toy', 'vertical', None, None)) + verticals = module_store.get_items(course_id, category='vertical') self.assertGreater(len(verticals), 0) @@ -1185,7 +1014,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): print 'Exporting to tempdir = {0}'.format(root_dir) # export out to a tempdir - export_to_xml(module_store, content_store, location, root_dir, 'test_export', draft_modulestore=draft_store) + export_to_xml(module_store, content_store, course_id, root_dir, 'test_export', draft_modulestore=draft_store) shutil.rmtree(root_dir) @@ -1198,9 +1027,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content_store = contentstore() import_from_xml(module_store, 'common/test/data/', ['word_cloud']) - location = CourseDescriptor.id_to_location('HarvardX/ER22x/2013_Spring') + course_id = SlashSeparatedCourseKey('HarvardX', 'ER22x', '2013_Spring') - verticals = module_store.get_items(Location('i4x', 'HarvardX', 'ER22x', 'vertical', None, None)) + verticals = module_store.get_items(course_id, category='vertical') self.assertGreater(len(verticals), 0) @@ -1213,7 +1042,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): print 'Exporting to tempdir = {0}'.format(root_dir) # export out to a tempdir - export_to_xml(module_store, content_store, location, root_dir, 'test_export', draft_modulestore=draft_store) + export_to_xml(module_store, content_store, course_id, root_dir, 'test_export', draft_modulestore=draft_store) shutil.rmtree(root_dir) @@ -1227,9 +1056,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): content_store = contentstore() import_from_xml(module_store, 'common/test/data/', ['toy']) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') + course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') - verticals = module_store.get_items(Location('i4x', 'edX', 'toy', 'vertical', None, None)) + verticals = module_store.get_items(course_id, category='vertical') self.assertGreater(len(verticals), 0) @@ -1242,11 +1071,11 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # Export the course root_dir = path(mkdtemp_clean()) - export_to_xml(module_store, content_store, location, root_dir, 'test_roundtrip', draft_modulestore=draft_store) + export_to_xml(module_store, content_store, course_id, root_dir, 'test_roundtrip', draft_modulestore=draft_store) # Reimport and get the video back import_from_xml(module_store, root_dir) - imported_word_cloud = module_store.get_item(Location('i4x', 'edX', 'toy', 'word_cloud', 'untitled', None)) + imported_word_cloud = module_store.get_item(course_id.make_usage_key('word_cloud', 'untitled')) # It should now contain empty data self.assertEquals(imported_word_cloud.data, '') @@ -1260,41 +1089,34 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): import_from_xml(module_store, 'common/test/data/', ['toy']) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') + course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') # Export the course root_dir = path(mkdtemp_clean()) - export_to_xml(module_store, content_store, location, root_dir, 'test_roundtrip') + export_to_xml(module_store, content_store, course_id, root_dir, 'test_roundtrip') # Reimport and get the video back import_from_xml(module_store, root_dir) # get the sample HTML with styling information - html_module = module_store.get_instance( - 'edX/toy/2012_Fall', - Location('i4x', 'edX', 'toy', 'html', 'with_styling') - ) + html_module = module_store.get_item(course_id.make_usage_key('html', 'with_styling')) self.assertIn('

    ', html_module.data) # get the sample HTML with just a simple tag information - html_module = module_store.get_instance( - 'edX/toy/2012_Fall', - Location('i4x', 'edX', 'toy', 'html', 'just_img') - ) + html_module = module_store.get_item(course_id.make_usage_key('html', 'just_img')) self.assertIn('', html_module.data) def test_course_handouts_rewrites(self): module_store = modulestore('direct') # import a test course - import_from_xml(module_store, 'common/test/data/', ['toy']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) + course_id = course_items[0].id - handout_location = Location(['i4x', 'edX', 'toy', 'course_info', 'handouts']) - # get the translation - handouts_locator = loc_mapper().translate_location('edX/toy/2012_Fall', handout_location) + handouts_location = course_id.make_usage_key('course_info', 'handouts') # get module info (json) - resp = self.client.get(handouts_locator.url_reverse('/xblock')) + resp = self.client.get(get_url('xblock_handler', handouts_location)) # make sure we got a successful response self.assertEqual(resp.status_code, 200) @@ -1305,13 +1127,13 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): def test_prefetch_children(self): module_store = modulestore('direct') import_from_xml(module_store, 'common/test/data/', ['toy']) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') + course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') wrapper = MongoCollectionFindWrapper(module_store.collection.find) module_store.collection.find = wrapper.find print module_store.metadata_inheritance_cache_subsystem print module_store.request_cache - course = module_store.get_item(location, depth=2) + course = module_store.get_course(course_id, depth=2) # make sure we haven't done too many round trips to DB # note we say 3 round trips here for 1) the course, and 2 & 3) for the chapters and sequentials @@ -1320,12 +1142,10 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(wrapper.counter, 3) # make sure we pre-fetched a known sequential which should be at depth=2 - self.assertTrue(Location(['i4x', 'edX', 'toy', 'sequential', - 'vertical_sequential', None]) in course.system.module_data) + self.assertTrue(course_id.make_usage_key('sequential', 'vertical_sequential') in course.system.module_data) # make sure we don't have a specific vertical which should be at depth=3 - self.assertFalse(Location(['i4x', 'edX', 'toy', 'vertical', 'vertical_test', None]) - in course.system.module_data) + self.assertFalse(course_id.make_usage_key('vertical', 'vertical_test') in course.system.module_data) def test_export_course_without_content_store(self): module_store = modulestore('direct') @@ -1333,39 +1153,40 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # Create toy course - import_from_xml(module_store, 'common/test/data/', ['toy']) - location = CourseDescriptor.id_to_location('edX/toy/2012_Fall') - - stub_location = Location(['i4x', 'edX', 'toy', 'sequential', 'vertical_sequential']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) + course_id = course_items[0].id root_dir = path(mkdtemp_clean()) print 'Exporting to tempdir = {0}'.format(root_dir) - export_to_xml(module_store, None, location, root_dir, 'test_export_no_content_store') + export_to_xml(module_store, None, course_id, root_dir, 'test_export_no_content_store') # Delete the course from module store and reimport it - delete_course(module_store, content_store, location, commit=True) + delete_course(module_store, content_store, course_id, commit=True) import_from_xml( module_store, root_dir, ['test_export_no_content_store'], draft_store=None, static_content_store=None, - target_location_namespace=location + target_course_id=course_id ) # Verify reimported course - items = module_store.get_items(stub_location) + items = module_store.get_items( + course_id, + category='sequential', + name='vertical_sequential' + ) self.assertEqual(len(items), 1) - def _check_verticals(self, items, course_id): + def _check_verticals(self, items): """ Test getting the editing HTML for each vertical. """ # Assert is here to make sure that the course being tested actually has verticals (units) to check. self.assertGreater(len(items), 0) for descriptor in items: - unit_locator = loc_mapper().translate_location(course_id, descriptor.location, True, True) - resp = self.client.get_html(unit_locator.url_reverse('unit')) + resp = self.client.get_html(get_url('unit_handler', descriptor.location)) self.assertEqual(resp.status_code, 200) _test_no_locations(self, resp) @@ -1411,10 +1232,6 @@ class ContentStoreTest(ModuleStoreTestCase): MongoClient().drop_database(TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db']) _CONTENTSTORE.clear() - def test_create_course(self): - """Test new course creation - happy path""" - self.assert_created_course() - def assert_created_course(self, number_suffix=None): """ Checks that the course was created properly. @@ -1423,20 +1240,32 @@ class ContentStoreTest(ModuleStoreTestCase): test_course_data.update(self.course_data) if number_suffix: test_course_data['number'] = '{0}_{1}'.format(test_course_data['number'], number_suffix) - _create_course(self, test_course_data) + course_key = _get_course_id(test_course_data) + _create_course(self, course_key, test_course_data) # Verify that the creator is now registered in the course. - self.assertTrue(CourseEnrollment.is_enrolled(self.user, _get_course_id(test_course_data))) + self.assertTrue(CourseEnrollment.is_enrolled(self.user, course_key)) return test_course_data def assert_create_course_failed(self, error_message): """ Checks that the course not created. """ - resp = self.client.ajax_post('/course', self.course_data) + resp = self.client.ajax_post('/course/', self.course_data) self.assertEqual(resp.status_code, 400) data = parse_json(resp) self.assertEqual(data['error'], error_message) + def test_create_course(self): + """Test new course creation - happy path""" + self.assert_created_course() + + def test_create_course_with_dots(self): + """Test new course creation with dots in the name""" + self.course_data['org'] = 'org.foo.bar' + self.course_data['number'] = 'course.number' + self.course_data['run'] = 'run.name' + self.assert_created_course() + def test_create_course_check_forum_seeding(self): """Test new course creation and verify forum seeding """ test_course_data = self.assert_created_course(number_suffix=uuid4().hex) @@ -1492,83 +1321,90 @@ class ContentStoreTest(ModuleStoreTestCase): """ test_course_data = self.assert_created_course(number_suffix=uuid4().hex) course_id = _get_course_id(test_course_data) - course_location = CourseDescriptor.id_to_location(course_id) # Add user in possible groups and check that user in instructor groups of this course - instructor_role = CourseInstructorRole(course_location) - groupnames = instructor_role._group_names # pylint: disable=protected-access - groups = Group.objects.filter(name__in=groupnames) - for group in groups: - group.user_set.add(self.user) + instructor_role = CourseInstructorRole(course_id) + + auth.add_users(self.user, instructor_role, self.user) self.assertTrue(len(instructor_role.users_with_role()) > 0) # Now delete course and check that user not in instructor groups of this course - delete_course_and_groups(course_location.course_id, commit=True) + delete_course_and_groups(course_id, commit=True) + + # Update our cached user since its roles have changed + self.user = User.objects.get_by_natural_key(self.user.natural_key()[0]) self.assertFalse(instructor_role.has_user(self.user)) self.assertEqual(len(instructor_role.users_with_role()), 0) def test_create_course_duplicate_course(self): """Test new course creation - error path""" - self.client.ajax_post('/course', self.course_data) + self.client.ajax_post('/course/', self.course_data) self.assert_course_creation_failed('There is already a course defined with the same organization, course number, and course run. Please change either organization or course number to be unique.') def assert_course_creation_failed(self, error_message): """ Checks that the course did not get created """ - course_id = _get_course_id(self.course_data) - initially_enrolled = CourseEnrollment.is_enrolled(self.user, course_id) - resp = self.client.ajax_post('/course', self.course_data) + test_enrollment = False + try: + course_id = _get_course_id(self.course_data) + initially_enrolled = CourseEnrollment.is_enrolled(self.user, course_id) + test_enrollment = True + except InvalidKeyError: + # b/c the intent of the test with bad chars isn't to test auth but to test the handler, ignore + pass + resp = self.client.ajax_post('/course/', self.course_data) self.assertEqual(resp.status_code, 200) data = parse_json(resp) - self.assertEqual(data['ErrMsg'], error_message) - # One test case involves trying to create the same course twice. Hence for that course, - # the user will be enrolled. In the other cases, initially_enrolled will be False. - self.assertEqual(initially_enrolled, CourseEnrollment.is_enrolled(self.user, course_id)) + self.assertRegexpMatches(data['ErrMsg'], error_message) + if test_enrollment: + # One test case involves trying to create the same course twice. Hence for that course, + # the user will be enrolled. In the other cases, initially_enrolled will be False. + self.assertEqual(initially_enrolled, CourseEnrollment.is_enrolled(self.user, course_id)) def test_create_course_duplicate_number(self): """Test new course creation - error path""" - self.client.ajax_post('/course', self.course_data) + self.client.ajax_post('/course/', self.course_data) self.course_data['display_name'] = 'Robot Super Course Two' self.course_data['run'] = '2013_Summer' - self.assert_course_creation_failed('There is already a course defined with the same organization and course number. Please change at least one field to be unique.') + self.assert_course_creation_failed('There is already a course defined with the same organization, course number, and course run. Please change either organization or course number to be unique.') def test_create_course_case_change(self): """Test new course creation - error path due to case insensitive name equality""" self.course_data['number'] = 'capital' - self.client.ajax_post('/course', self.course_data) + self.client.ajax_post('/course/', self.course_data) cache_current = self.course_data['org'] self.course_data['org'] = self.course_data['org'].lower() - self.assert_course_creation_failed('There is already a course defined with the same organization and course number. Please change at least one field to be unique.') + self.assert_course_creation_failed('There is already a course defined with the same organization, course number, and course run. Please change either organization or course number to be unique.') self.course_data['org'] = cache_current - self.client.ajax_post('/course', self.course_data) + self.client.ajax_post('/course/', self.course_data) cache_current = self.course_data['number'] self.course_data['number'] = self.course_data['number'].upper() - self.assert_course_creation_failed('There is already a course defined with the same organization and course number. Please change at least one field to be unique.') + self.assert_course_creation_failed('There is already a course defined with the same organization, course number, and course run. Please change either organization or course number to be unique.') def test_course_substring(self): """ Test that a new course can be created whose name is a substring of an existing course """ - self.client.ajax_post('/course', self.course_data) + self.client.ajax_post('/course/', self.course_data) cache_current = self.course_data['number'] self.course_data['number'] = '{}a'.format(self.course_data['number']) - resp = self.client.ajax_post('/course', self.course_data) + resp = self.client.ajax_post('/course/', self.course_data) self.assertEqual(resp.status_code, 200) self.course_data['number'] = cache_current self.course_data['org'] = 'a{}'.format(self.course_data['org']) - resp = self.client.ajax_post('/course', self.course_data) + resp = self.client.ajax_post('/course/', self.course_data) self.assertEqual(resp.status_code, 200) def test_create_course_with_bad_organization(self): """Test new course creation - error path for bad organization name""" self.course_data['org'] = 'University of California, Berkeley' self.assert_course_creation_failed( - "Unable to create course 'Robot Super Course'.\n\nInvalid characters in u'University of California, Berkeley'.") + r"(?s)Unable to create course 'Robot Super Course'.*: Invalid characters in u'University of California, Berkeley'") def test_create_course_with_course_creation_disabled_staff(self): """Test new course creation -- course creation disabled, but staff access.""" @@ -1606,26 +1442,26 @@ class ContentStoreTest(ModuleStoreTestCase): """ with mock.patch.dict('django.conf.settings.FEATURES', {'ALLOW_UNICODE_COURSE_ID': False}): error_message = "Special characters not allowed in organization, course number, and course run." - self.course_data['org'] = u'Юникода' + self.course_data['org'] = u'��������������' self.assert_create_course_failed(error_message) - self.course_data['number'] = u'échantillon' + self.course_data['number'] = u'��chantillon' self.assert_create_course_failed(error_message) - self.course_data['run'] = u'όνομα' + self.course_data['run'] = u'����������' self.assert_create_course_failed(error_message) def assert_course_permission_denied(self): """ Checks that the course did not get created due to a PermissionError. """ - resp = self.client.ajax_post('/course', self.course_data) + resp = self.client.ajax_post('/course/', self.course_data) self.assertEqual(resp.status_code, 403) def test_course_index_view_with_no_courses(self): """Test viewing the index page with no courses""" # Create a course so there is something to view - resp = self.client.get_html('/course') + resp = self.client.get_html('/course/') self.assertContains( resp, '

    My Courses

    ', @@ -1648,7 +1484,7 @@ class ContentStoreTest(ModuleStoreTestCase): def test_course_index_view_with_course(self): """Test viewing the index page with an existing course""" CourseFactory.create(display_name='Robot Super Educational Course') - resp = self.client.get_html('/course') + resp = self.client.get_html('/course/') self.assertContains( resp, '

    Robot Super Educational Course

    ', @@ -1659,51 +1495,48 @@ class ContentStoreTest(ModuleStoreTestCase): def test_course_overview_view_with_course(self): """Test viewing the course overview page with an existing course""" - CourseFactory.create(org='MITx', course='999', display_name='Robot Super Course') - - loc = Location(['i4x', 'MITx', '999', 'course', Location.clean('Robot Super Course'), None]) - resp = self._show_course_overview(loc) + course = CourseFactory.create(org='MITx', course='999', display_name='Robot Super Course') + resp = self._show_course_overview(course.id) self.assertContains( resp, - '
    ', + '
    ', status_code=200, html=True ) def test_create_item(self): """Test creating a new xblock instance.""" - locator = _course_factory_create_course() + course = _course_factory_create_course() section_data = { - 'parent_locator': unicode(locator), + 'parent_locator': unicode(course.location), 'category': 'chapter', 'display_name': 'Section One', } - resp = self.client.ajax_post('/xblock', section_data) + resp = self.client.ajax_post(reverse_url('xblock_handler'), section_data) _test_no_locations(self, resp, html=False) self.assertEqual(resp.status_code, 200) data = parse_json(resp) self.assertRegexpMatches( data['locator'], - r"^MITx.999.Robot_Super_Course/branch/draft/block/chapter([0-9]|[a-f]){3,}$" + r"location:MITx\+999\+Robot_Super_Course\+chapter\+([0-9]|[a-f]){3,}$" ) def test_capa_module(self): """Test that a problem treats markdown specially.""" - locator = _course_factory_create_course() + course = _course_factory_create_course() problem_data = { - 'parent_locator': unicode(locator), + 'parent_locator': unicode(course.location), 'category': 'problem' } - resp = self.client.ajax_post('/xblock', problem_data) - + resp = self.client.ajax_post(reverse_url('xblock_handler'), problem_data) self.assertEqual(resp.status_code, 200) payload = parse_json(resp) - problem_loc = loc_mapper().translate_locator_to_location(BlockUsageLocator(payload['locator'])) + problem_loc = UsageKey.from_string(payload['locator']) problem = get_modulestore(problem_loc).get_item(problem_loc) # should be a CapaDescriptor self.assertIsInstance(problem, CapaDescriptor, "New problem is not a CapaDescriptor") @@ -1716,53 +1549,51 @@ class ContentStoreTest(ModuleStoreTestCase): Import and walk through some common URL endpoints. This just verifies non-500 and no other correct behavior, so it is not a deep test """ - def test_get_html(page): + def test_get_html(handler): # Helper function for getting HTML for a page in Studio and # checking that it does not error. - resp = self.client.get_html(new_location.url_reverse(page)) + resp = self.client.get_html( + get_url(handler, course_key, 'course_key_string') + ) self.assertEqual(resp.status_code, 200) _test_no_locations(self, resp) - import_from_xml(modulestore('direct'), 'common/test/data/', ['simple']) - loc = Location(['i4x', 'edX', 'simple', 'course', '2012_Fall', None]) - new_location = loc_mapper().translate_location(loc.course_id, loc, True, True) + _, course_items = import_from_xml(modulestore('direct'), 'common/test/data/', ['simple']) + course_key = course_items[0].id - resp = self._show_course_overview(loc) + resp = self._show_course_overview(course_key) self.assertEqual(resp.status_code, 200) self.assertContains(resp, 'Chapter 2') # go to various pages - test_get_html('import') - test_get_html('export') - test_get_html('course_team') - test_get_html('course_info') - test_get_html('checklists') - test_get_html('assets') - test_get_html('tabs') - test_get_html('settings/details') - test_get_html('settings/grading') - test_get_html('settings/advanced') - test_get_html('textbooks') + test_get_html('import_handler') + test_get_html('export_handler') + test_get_html('course_team_handler') + test_get_html('course_info_handler') + test_get_html('checklists_handler') + test_get_html('assets_handler') + test_get_html('tabs_handler') + test_get_html('settings_handler') + test_get_html('grading_handler') + test_get_html('advanced_settings_handler') + test_get_html('textbooks_list_handler') # go look at a subsection page - subsection_location = loc.replace(category='sequential', name='test_sequence') - subsection_locator = loc_mapper().translate_location(loc.course_id, subsection_location, True, True) - resp = self.client.get_html(subsection_locator.url_reverse('subsection')) + subsection_key = course_key.make_usage_key('sequential', 'test_sequence') + resp = self.client.get_html(get_url('subsection_handler', subsection_key)) self.assertEqual(resp.status_code, 200) _test_no_locations(self, resp) # go look at the Edit page - unit_location = loc.replace(category='vertical', name='test_vertical') - unit_locator = loc_mapper().translate_location(loc.course_id, unit_location, True, True) - resp = self.client.get_html(unit_locator.url_reverse('unit')) + unit_key = course_key.make_usage_key('vertical', 'test_vertical') + resp = self.client.get_html(get_url('unit_handler', unit_key)) self.assertEqual(resp.status_code, 200) _test_no_locations(self, resp) def delete_item(category, name): """ Helper method for testing the deletion of an xblock item. """ - del_loc = loc.replace(category=category, name=name) - del_location = loc_mapper().translate_location(loc.course_id, del_loc, True, True) - resp = self.client.delete(del_location.url_reverse('xblock')) + item_key = course_key.make_usage_key(category, name) + resp = self.client.delete(get_url('xblock_handler', item_key)) self.assertEqual(resp.status_code, 204) _test_no_locations(self, resp, status_code=204, html=False) @@ -1780,23 +1611,12 @@ class ContentStoreTest(ModuleStoreTestCase): def test_import_into_new_course_id(self): module_store = modulestore('direct') - target_location = Location(['i4x', 'MITx', '999', 'course', '2013_Spring']) + target_course_id = _get_course_id(self.course_data) + _create_course(self, target_course_id, self.course_data) - course_data = { - 'org': target_location.org, - 'number': target_location.course, - 'display_name': 'Robot Super Course', - 'run': target_location.name - } + import_from_xml(module_store, 'common/test/data/', ['toy'], target_course_id=target_course_id) - target_course_id = '{0}/{1}/{2}'.format(target_location.org, target_location.course, target_location.name) - - _create_course(self, course_data) - - import_from_xml(module_store, 'common/test/data/', ['toy'], target_location_namespace=target_location) - - modules = module_store.get_items(Location([ - target_location.tag, target_location.org, target_location.course, None, None, None])) + modules = module_store.get_items(target_course_id) # we should have a number of modules in there # we can't specify an exact number since it'll always be changing @@ -1807,7 +1627,7 @@ class ContentStoreTest(ModuleStoreTestCase): # # first check PDF textbooks, to make sure the url paths got updated - course_module = module_store.get_instance(target_course_id, target_location) + course_module = module_store.get_course(target_course_id) self.assertEqual(len(course_module.pdf_textbooks), 1) self.assertEqual(len(course_module.pdf_textbooks[0]["chapters"]), 2) @@ -1818,41 +1638,41 @@ class ContentStoreTest(ModuleStoreTestCase): module_store = modulestore('direct') # If reimporting into the same course do not change the wiki_slug. - target_location = Location('i4x', 'edX', 'toy', 'course', '2012_Fall') + target_course_id = SlashSeparatedCourseKey('edX', 'toy', '2012_Fall') course_data = { - 'org': target_location.org, - 'number': target_location.course, + 'org': target_course_id.org, + 'number': target_course_id.course, 'display_name': 'Robot Super Course', - 'run': target_location.name + 'run': target_course_id.run } - _create_course(self, course_data) - course_module = module_store.get_instance(target_location.course_id, target_location) + _create_course(self, target_course_id, course_data) + course_module = module_store.get_course(target_course_id) course_module.wiki_slug = 'toy' course_module.save() # Import a course with wiki_slug == location.course - import_from_xml(module_store, 'common/test/data/', ['toy'], target_location_namespace=target_location) - course_module = module_store.get_instance(target_location.course_id, target_location) + import_from_xml(module_store, 'common/test/data/', ['toy'], target_course_id=target_course_id) + course_module = module_store.get_course(target_course_id) self.assertEquals(course_module.wiki_slug, 'toy') # But change the wiki_slug if it is a different course. - target_location = Location('i4x', 'MITx', '999', 'course', '2013_Spring') + target_course_id = SlashSeparatedCourseKey('MITx', '999', '2013_Spring') course_data = { - 'org': target_location.org, - 'number': target_location.course, + 'org': target_course_id.org, + 'number': target_course_id.course, 'display_name': 'Robot Super Course', - 'run': target_location.name + 'run': target_course_id.run } - _create_course(self, course_data) + _create_course(self, target_course_id, course_data) # Import a course with wiki_slug == location.course - import_from_xml(module_store, 'common/test/data/', ['toy'], target_location_namespace=target_location) - course_module = module_store.get_instance(target_location.course_id, target_location) + import_from_xml(module_store, 'common/test/data/', ['toy'], target_course_id=target_course_id) + course_module = module_store.get_course(target_course_id) self.assertEquals(course_module.wiki_slug, 'MITx.999.2013_Spring') - # Now try importing a course with wiki_slug == '{0}.{1}.{2}'.format(location.org, location.course, location.name) - import_from_xml(module_store, 'common/test/data/', ['two_toys'], target_location_namespace=target_location) - course_module = module_store.get_instance(target_location.course_id, target_location) + # Now try importing a course with wiki_slug == '{0}.{1}.{2}'.format(location.org, location.course, location.run) + import_from_xml(module_store, 'common/test/data/', ['two_toys'], target_course_id=target_course_id) + course_module = module_store.get_course(target_course_id) self.assertEquals(course_module.wiki_slug, 'MITx.999.2013_Spring') def test_import_metadata_with_attempts_empty_string(self): @@ -1860,7 +1680,9 @@ class ContentStoreTest(ModuleStoreTestCase): import_from_xml(module_store, 'common/test/data/', ['simple']) did_load_item = False try: - module_store.get_item(Location(['i4x', 'edX', 'simple', 'problem', 'ps01-simple', None])) + course_key = SlashSeparatedCourseKey('edX', 'simple', 'problem') + usage_key = course_key.make_usage_key('problem', 'ps01-simple') + module_store.get_item(usage_key) did_load_item = True except ItemNotFoundError: pass @@ -1870,9 +1692,8 @@ class ContentStoreTest(ModuleStoreTestCase): def test_forum_id_generation(self): module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - - new_component_location = Location('i4x', 'edX', '999', 'discussion', 'new_component') + course = CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') + new_component_location = course.id.make_usage_key('discussion', 'new_component') # crate a new module and add it as a child to a vertical module_store.create_and_save_xmodule(new_component_location) @@ -1881,37 +1702,12 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertNotEquals(new_discussion_item.discussion_id, '$$GUID$$') - def test_update_modulestore_signal_did_fire(self): - module_store = modulestore('direct') - CourseFactory.create(org='edX', course='999', display_name='Robot Super Course') - - try: - module_store.modulestore_update_signal = Signal(providing_args=['modulestore', 'course_id', 'location']) - - self.got_signal = False - - def _signal_hander(modulestore=None, course_id=None, location=None, **kwargs): - self.got_signal = True - - module_store.modulestore_update_signal.connect(_signal_hander) - - new_component_location = Location('i4x', 'edX', '999', 'html', 'new_component') - - # crate a new module - module_store.create_and_save_xmodule(new_component_location) - - finally: - module_store.modulestore_update_signal = None - - self.assertTrue(self.got_signal) - def test_metadata_inheritance(self): module_store = modulestore('direct') - import_from_xml(module_store, 'common/test/data/', ['toy']) + _, course_items = import_from_xml(module_store, 'common/test/data/', ['toy']) - course = module_store.get_item(Location(['i4x', 'edX', 'toy', 'course', '2012_Fall', None])) - - verticals = module_store.get_items(Location('i4x', 'edX', 'toy', 'vertical', None, None)) + course = course_items[0] + verticals = module_store.get_items(course.id, category='vertical') # let's assert on the metadata_inheritance on an existing vertical for vertical in verticals: @@ -1920,16 +1716,16 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertGreater(len(verticals), 0) - new_component_location = Location('i4x', 'edX', 'toy', 'html', 'new_component') + new_component_location = course.id.make_usage_key('html', 'new_component') # crate a new module and add it as a child to a vertical module_store.create_and_save_xmodule(new_component_location) parent = verticals[0] - parent.children.append(new_component_location.url()) + parent.children.append(new_component_location) module_store.update_item(parent, self.user.id) # flush the cache - module_store.refresh_cached_metadata_inheritance_tree(new_component_location) + module_store.refresh_cached_metadata_inheritance_tree(new_component_location.course_key) new_module = module_store.get_item(new_component_location) # check for grace period definition which should be defined at the course level @@ -1946,7 +1742,7 @@ class ContentStoreTest(ModuleStoreTestCase): module_store.update_item(new_module, self.user.id) # flush the cache and refetch - module_store.refresh_cached_metadata_inheritance_tree(new_component_location) + module_store.refresh_cached_metadata_inheritance_tree(new_component_location.course_key) new_module = module_store.get_item(new_component_location) self.assertEqual(timedelta(1), new_module.graceperiod) @@ -1994,24 +1790,23 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertEqual(course.course_image, 'images_course_image.jpg') # Ensure that the imported course image is present -- this shouldn't raise an exception - location = course.location._replace(tag='c4x', category='asset', name=course.course_image) - content_store.find(location) + asset_key = course.id.make_asset_key('asset', course.course_image) + content_store.find(asset_key) - def _show_course_overview(self, location): + def _show_course_overview(self, course_key): """ Show the course overview page. """ - new_location = loc_mapper().translate_location(location.course_id, location, True, True) - resp = self.client.get_html(new_location.url_reverse('course/', '')) + resp = self.client.get_html(get_url('course_handler', course_key, 'course_key_string')) _test_no_locations(self, resp) return resp def test_wiki_slug(self): """When creating a course a unique wiki_slug should be set.""" - course_location = Location(['i4x', 'MITx', '999', 'course', '2013_Spring']) - _create_course(self, self.course_data) - course_module = modulestore('direct').get_item(course_location) + course_key = _get_course_id(self.course_data) + _create_course(self, course_key, self.course_data) + course_module = modulestore('direct').get_course(course_key) self.assertEquals(course_module.wiki_slug, 'MITx.999.2013_Spring') @@ -2020,10 +1815,8 @@ class MetadataSaveTestCase(ModuleStoreTestCase): """Test that metadata is correctly cached and decached.""" def setUp(self): - CourseFactory.create( + course = CourseFactory.create( org='edX', course='999', display_name='Robot Super Course') - course_location = Location( - ['i4x', 'edX', '999', 'course', 'Robot_Super_Course', None]) video_sample_xml = '''