MA-635 Block Mobile Content for unfulfilled milestones
Previously, the mobile api did not check for pre-requisite courses or entrance exams. This change checks for these milestones and then returns course content accordingly.
This commit is contained in:
christopher lee
137
lms/djangoapps/mobile_api/test_milestones.py
Normal file
137
lms/djangoapps/mobile_api/test_milestones.py
Normal file
@@ -0,0 +1,137 @@
|
||||
"""
|
||||
Milestone related tests for the mobile_api
|
||||
"""
|
||||
from mock import patch
|
||||
|
||||
from courseware.tests.helpers import get_request_for_user
|
||||
from courseware.tests.test_entrance_exam import answer_entrance_exam_problem, add_entrance_exam_milestone
|
||||
from util.milestones_helpers import (
|
||||
add_prerequisite_course,
|
||||
fulfill_course_milestone,
|
||||
seed_milestone_relationship_types,
|
||||
)
|
||||
from xmodule.modulestore.django import modulestore
|
||||
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
|
||||
|
||||
|
||||
class MobileAPIMilestonesMixin(object):
|
||||
"""
|
||||
Tests the Mobile API decorators for milestones.
|
||||
|
||||
The two milestones currently supported in these tests are entrance exams and
|
||||
pre-requisite courses. If either of these milestones are unfulfilled,
|
||||
the mobile api will appropriately block content until the milestone is
|
||||
fulfilled.
|
||||
"""
|
||||
MILESTONE_MESSAGE = {
|
||||
'developer_message':
|
||||
'Cannot access content with unfulfilled pre-requisites or unpassed entrance exam.'
|
||||
}
|
||||
|
||||
ALLOW_ACCESS_TO_MILESTONE_COURSE = False # pylint: disable=invalid-name
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENABLE_PREREQUISITE_COURSES': True, 'MILESTONES_APP': True})
|
||||
def test_unfulfilled_prerequisite_course(self):
|
||||
""" Tests the case for an unfulfilled pre-requisite course """
|
||||
self._add_prerequisite_course()
|
||||
self.init_course_access()
|
||||
self._verify_unfulfilled_milestone_response()
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENABLE_PREREQUISITE_COURSES': True, 'MILESTONES_APP': True})
|
||||
def test_unfulfilled_prerequisite_course_for_staff(self):
|
||||
self._add_prerequisite_course()
|
||||
self.user.is_staff = True
|
||||
self.user.save()
|
||||
self.init_course_access()
|
||||
self.api_response()
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENABLE_PREREQUISITE_COURSES': True, 'MILESTONES_APP': True})
|
||||
def test_fulfilled_prerequisite_course(self):
|
||||
"""
|
||||
Tests the case when a user fulfills existing pre-requisite course
|
||||
"""
|
||||
self._add_prerequisite_course()
|
||||
add_prerequisite_course(self.course.id, self.prereq_course.id)
|
||||
fulfill_course_milestone(self.prereq_course.id, self.user)
|
||||
self.init_course_access()
|
||||
self.api_response()
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENTRANCE_EXAMS': True, 'MILESTONES_APP': True})
|
||||
def test_unpassed_entrance_exam(self):
|
||||
"""
|
||||
Tests the case where the user has not passed the entrance exam
|
||||
"""
|
||||
self._add_entrance_exam()
|
||||
self.init_course_access()
|
||||
self._verify_unfulfilled_milestone_response()
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENTRANCE_EXAMS': True, 'MILESTONES_APP': True})
|
||||
def test_unpassed_entrance_exam_for_staff(self):
|
||||
self._add_entrance_exam()
|
||||
self.user.is_staff = True
|
||||
self.user.save()
|
||||
self.init_course_access()
|
||||
self.api_response()
|
||||
|
||||
@patch.dict('django.conf.settings.FEATURES', {'ENTRANCE_EXAMS': True, 'MILESTONES_APP': True})
|
||||
def test_passed_entrance_exam(self):
|
||||
"""
|
||||
Tests access when user has passed the entrance exam
|
||||
"""
|
||||
self._add_entrance_exam()
|
||||
self._pass_entrance_exam()
|
||||
self.init_course_access()
|
||||
self.api_response()
|
||||
|
||||
def _add_entrance_exam(self):
|
||||
""" Sets up entrance exam """
|
||||
seed_milestone_relationship_types()
|
||||
self.course.entrance_exam_enabled = True
|
||||
|
||||
self.entrance_exam = ItemFactory.create( # pylint: disable=attribute-defined-outside-init
|
||||
parent=self.course,
|
||||
category="chapter",
|
||||
display_name="Entrance Exam Chapter",
|
||||
is_entrance_exam=True,
|
||||
in_entrance_exam=True
|
||||
)
|
||||
self.problem_1 = ItemFactory.create( # pylint: disable=attribute-defined-outside-init
|
||||
parent=self.entrance_exam,
|
||||
category='problem',
|
||||
display_name="The Only Exam Problem",
|
||||
graded=True,
|
||||
in_entrance_exam=True
|
||||
)
|
||||
|
||||
add_entrance_exam_milestone(self.course, self.entrance_exam)
|
||||
|
||||
self.course.entrance_exam_minimum_score_pct = 0.50
|
||||
self.course.entrance_exam_id = unicode(self.entrance_exam.location)
|
||||
modulestore().update_item(self.course, self.user.id)
|
||||
|
||||
def _add_prerequisite_course(self):
|
||||
""" Helper method to set up the prerequisite course """
|
||||
seed_milestone_relationship_types()
|
||||
self.prereq_course = CourseFactory.create() # pylint: disable=attribute-defined-outside-init
|
||||
add_prerequisite_course(self.course.id, self.prereq_course.id)
|
||||
|
||||
def _pass_entrance_exam(self):
|
||||
""" Helper function to pass the entrance exam """
|
||||
request = get_request_for_user(self.user)
|
||||
answer_entrance_exam_problem(self.course, request, self.problem_1)
|
||||
|
||||
def _verify_unfulfilled_milestone_response(self):
|
||||
"""
|
||||
Verifies the response depending on ALLOW_ACCESS_TO_MILESTONE_COURSE
|
||||
|
||||
Since different endpoints will have different behaviours towards milestones,
|
||||
setting ALLOW_ACCESS_TO_MILESTONE_COURSE (default is False) to True, will
|
||||
not return a 204. For example, when getting a list of courses a user is
|
||||
enrolled in, although a user may have unfulfilled milestones, the course
|
||||
should still show up in the course enrollments list.
|
||||
"""
|
||||
if self.ALLOW_ACCESS_TO_MILESTONE_COURSE:
|
||||
self.api_response()
|
||||
else:
|
||||
response = self.api_response(expected_response_code=204)
|
||||
self.assertEqual(response.data, self.MILESTONE_MESSAGE)
|
||||
@@ -13,18 +13,21 @@ Test utilities for mobile API tests:
|
||||
# pylint: disable=no-member
|
||||
import ddt
|
||||
from mock import patch
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from django.core.urlresolvers import reverse
|
||||
|
||||
from opaque_keys.edx.keys import CourseKey
|
||||
from courseware.tests.factories import UserFactory
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from opaque_keys.edx.keys import CourseKey
|
||||
|
||||
from courseware.tests.factories import UserFactory
|
||||
from student import auth
|
||||
from student.models import CourseEnrollment
|
||||
|
||||
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
|
||||
from xmodule.modulestore.tests.factories import CourseFactory
|
||||
|
||||
from mobile_api.test_milestones import MobileAPIMilestonesMixin
|
||||
|
||||
|
||||
class MobileAPITestCase(ModuleStoreTestCase, APITestCase):
|
||||
"""
|
||||
@@ -124,7 +127,7 @@ class MobileAuthUserTestMixin(MobileAuthTestMixin):
|
||||
|
||||
|
||||
@ddt.ddt
|
||||
class MobileCourseAccessTestMixin(object):
|
||||
class MobileCourseAccessTestMixin(MobileAPIMilestonesMixin):
|
||||
"""
|
||||
Test Mixin for testing APIs marked with mobile_course_access.
|
||||
(Use MobileEnrolledCourseAccessTestMixin when verify_enrolled is set to True.)
|
||||
|
||||
@@ -49,6 +49,7 @@ class TestUserEnrollmentApi(MobileAPITestCase, MobileAuthUserTestMixin, MobileEn
|
||||
"""
|
||||
REVERSE_INFO = {'name': 'courseenrollment-detail', 'params': ['username']}
|
||||
ALLOW_ACCESS_TO_UNRELEASED_COURSE = True
|
||||
ALLOW_ACCESS_TO_MILESTONE_COURSE = True
|
||||
|
||||
def verify_success(self, response):
|
||||
super(TestUserEnrollmentApi, self).verify_success(response)
|
||||
|
||||
@@ -3,16 +3,21 @@ Common utility methods and decorators for Mobile APIs.
|
||||
"""
|
||||
|
||||
import functools
|
||||
from rest_framework import permissions
|
||||
|
||||
from django.http import Http404
|
||||
|
||||
from rest_framework import permissions, status, response
|
||||
|
||||
from opaque_keys.edx.keys import CourseKey
|
||||
from xmodule.modulestore.django import modulestore
|
||||
|
||||
from courseware.courses import get_course_with_access
|
||||
from openedx.core.lib.api.permissions import IsUserInUrl
|
||||
from openedx.core.lib.api.authentication import (
|
||||
SessionAuthenticationAllowInactiveUser,
|
||||
OAuth2AuthenticationAllowInactiveUser,
|
||||
)
|
||||
from openedx.core.lib.api.permissions import IsUserInUrl
|
||||
from util.milestones_helpers import any_unfulfilled_milestones
|
||||
from xmodule.modulestore.django import modulestore
|
||||
|
||||
|
||||
def mobile_course_access(depth=0, verify_enrolled=True):
|
||||
@@ -30,12 +35,25 @@ def mobile_course_access(depth=0, verify_enrolled=True):
|
||||
"""
|
||||
course_id = CourseKey.from_string(kwargs.pop('course_id'))
|
||||
with modulestore().bulk_operations(course_id):
|
||||
course = get_course_with_access(
|
||||
request.user,
|
||||
'load_mobile' if verify_enrolled else 'load_mobile_no_enrollment_check',
|
||||
course_id,
|
||||
depth=depth
|
||||
)
|
||||
try:
|
||||
course = get_course_with_access(
|
||||
request.user,
|
||||
'load_mobile' if verify_enrolled else 'load_mobile_no_enrollment_check',
|
||||
course_id,
|
||||
depth=depth
|
||||
)
|
||||
except Http404:
|
||||
# any_unfulfilled_milestones called a second time since get_course_with_access returns a bool
|
||||
if any_unfulfilled_milestones(course_id, request.user.id):
|
||||
message = {
|
||||
"developer_message": "Cannot access content with unfulfilled pre-requisites or unpassed entrance exam." # pylint: disable=line-too-long
|
||||
}
|
||||
return response.Response(
|
||||
data=message,
|
||||
status=status.HTTP_204_NO_CONTENT
|
||||
)
|
||||
else:
|
||||
raise
|
||||
return func(self, request, course=course, *args, **kwargs)
|
||||
return _wrapper
|
||||
return _decorator
|
||||
|
||||
Reference in New Issue
Block a user