Skip to content

E
edx-platform
Commit 62042188 by J. Cliff Dyer
Options

Revert "Fix Gating to use grades API, instead of its own calculations" 

This reverts commit 31812141.
parent 75772d20
Showing with 520 additions and 289 deletions
lms/djangoapps/course_api/blocks/transformers/tests/test_milestones.py
""" """
Tests for ProctoredExamTransformer. Tests for ProctoredExamTransformer.
""" """
from mock import patch from mock import patch, Mock
from nose.plugins.attrib import attr from nose.plugins.attrib import attr
import ddt import ddt
...@@ -53,8 +53,7 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM ...@@ -53,8 +53,7 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM
'course', 'A', 'B', 'C', 'ProctoredExam', 'D', 'E', 'PracticeExam', 'F', 'G', 'H', 'I', 'TimedExam', 'J', 'K' 'course', 'A', 'B', 'C', 'ProctoredExam', 'D', 'E', 'PracticeExam', 'F', 'G', 'H', 'I', 'TimedExam', 'J', 'K'
) )
# The special exams (proctored, practice, timed) are not visible to # The special exams (proctored, practice, timed) should never be visible to students
# students via the Courses API.
ALL_BLOCKS_EXCEPT_SPECIAL = ('course', 'A', 'B', 'C', 'H', 'I') ALL_BLOCKS_EXCEPT_SPECIAL = ('course', 'A', 'B', 'C', 'H', 'I')
def get_course_hierarchy(self): def get_course_hierarchy(self):
...@@ -135,27 +134,27 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM ...@@ -135,27 +134,27 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM
( (
'H', 'H',
'A', 'A',
('course', 'A', 'B', 'C'), 'B',
('course', 'A', 'B', 'C',)
), ),
( (
'H', 'H',
'ProctoredExam', 'ProctoredExam',
'D',
('course', 'A', 'B', 'C'), ('course', 'A', 'B', 'C'),
), ),
) )
@ddt.unpack @ddt.unpack
def test_gated(self, gated_block_ref, gating_block_ref, expected_blocks_before_completion): def test_gated(self, gated_block_ref, gating_block_ref, gating_block_child, expected_blocks_before_completion):
""" """
First, checks that a student cannot see the gated block when it is gated First, checks that a student cannot see the gated block when it is gated by the gating block and no
by the gating block and no attempt has been made to complete the gating attempt has been made to complete the gating block.
block. Then, checks that the student can see the gated block after the Then, checks that the student can see the gated block after the gating block has been completed.
gating block has been completed.
expected_blocks_before_completion is the set of blocks we expect to be expected_blocks_before_completion is the set of blocks we expect to be visible to the student
visible to the student before the student has completed the gating block. before the student has completed the gating block.
The test data includes one special exam and one non-special block as the The test data includes one special exam and one non-special block as the gating blocks.
gating blocks.
""" """
self.course.enable_subsection_gating = True self.course.enable_subsection_gating = True
self.setup_gated_section(self.blocks[gated_block_ref], self.blocks[gating_block_ref]) self.setup_gated_section(self.blocks[gated_block_ref], self.blocks[gating_block_ref])
...@@ -166,16 +165,16 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM ...@@ -166,16 +165,16 @@ class MilestonesTransformerTestCase(CourseStructureTestCase, MilestonesTestCaseM
# clear the request cache to simulate a new request # clear the request cache to simulate a new request
self.clear_caches() self.clear_caches()
# this call triggers reevaluation of prerequisites fulfilled by the # mock the api that the lms gating api calls to get the score for each block to always return 1 (ie 100%)
# gating block. with patch('gating.api.get_module_score', Mock(return_value=1)):
lms_gating_api.evaluate_prerequisite(
self.course,
self.user,
self.blocks[gating_block_ref].location,
100.0,
)
with self.assertNumQueries(3): # this call triggers reevaluation of prerequisites fulfilled by the parent of the
# block passed in, so we pass in a child of the gating block
lms_gating_api.evaluate_prerequisite(
self.course,
UsageKey.from_string(unicode(self.blocks[gating_block_child].location)),
self.user.id)
with self.assertNumQueries(2):
self.get_blocks_and_check_against_expected(self.user, self.ALL_BLOCKS_EXCEPT_SPECIAL) self.get_blocks_and_check_against_expected(self.user, self.ALL_BLOCKS_EXCEPT_SPECIAL)
def test_staff_access(self): def test_staff_access(self):
......
lms/djangoapps/gating/api.py
...@@ -6,14 +6,35 @@ import json ...@@ -6,14 +6,35 @@ import json
from collections import defaultdict from collections import defaultdict
from django.contrib.auth.models import User from django.contrib.auth.models import User
from xmodule.modulestore.django import modulestore
from openedx.core.lib.gating import api as gating_api from openedx.core.lib.gating import api as gating_api
from lms.djangoapps.grades.module_grades import get_module_score
from util import milestones_helpers from util import milestones_helpers
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
def _get_xblock_parent(xblock, category=None):
"""
Returns the parent of the given XBlock. If an optional category is supplied,
traverses the ancestors of the XBlock and returns the first with the
given category.
Arguments:
xblock (XBlock): Get the parent of this XBlock
category (str): Find an ancestor with this category (e.g. sequential)
"""
parent = xblock.get_parent()
if parent and category:
if parent.category == category:
return parent
else:
return _get_xblock_parent(parent, category)
return parent
@gating_api.gating_enabled(default=False) @gating_api.gating_enabled(default=False)
def evaluate_prerequisite(course, user, subsection_usage_key, new_score): def evaluate_prerequisite(course, prereq_content_key, user_id):
""" """
Finds the parent subsection of the content in the course and evaluates Finds the parent subsection of the content in the course and evaluates
any milestone relationships attached to that subsection. If the calculated any milestone relationships attached to that subsection. If the calculated
...@@ -21,40 +42,44 @@ def evaluate_prerequisite(course, user, subsection_usage_key, new_score): ...@@ -21,40 +42,44 @@ def evaluate_prerequisite(course, user, subsection_usage_key, new_score):
dependent subsections, the related milestone will be fulfilled for the user. dependent subsections, the related milestone will be fulfilled for the user.
Arguments: Arguments:
user (User): User for which evaluation should occur user_id (int): ID of User for which evaluation should occur
course (CourseModule): The course course (CourseModule): The course
subsection_usage_key (UsageKey): Usage key of the updated subsection prereq_content_key (UsageKey): The prerequisite content usage key
new_score (float): New score of the given subsection, in percentage.
Returns: Returns:
None None
""" """
prereq_milestone = gating_api.get_gating_milestone( xblock = modulestore().get_item(prereq_content_key)
course.id, sequential = _get_xblock_parent(xblock, 'sequential')
subsection_usage_key, if sequential:
'fulfills' prereq_milestone = gating_api.get_gating_milestone(
) course.id,
if prereq_milestone: sequential.location.for_branch(None),
gated_content_milestones = defaultdict(list) 'fulfills'
for milestone in gating_api.find_gating_milestones(course.id, None, 'requires'): )
gated_content_milestones[milestone['id']].append(milestone) if prereq_milestone:
gated_content_milestones = defaultdict(list)
gated_content = gated_content_milestones.get(prereq_milestone['id']) for milestone in gating_api.find_gating_milestones(course.id, None, 'requires'):
if gated_content: gated_content_milestones[milestone['id']].append(milestone)
for milestone in gated_content:
# Default minimum score to 100 gated_content = gated_content_milestones.get(prereq_milestone['id'])
min_score = 100.0 if gated_content:
requirements = milestone.get('requirements') user = User.objects.get(id=user_id)
if requirements: score = get_module_score(user, course, sequential) * 100
try: for milestone in gated_content:
min_score = float(requirements.get('min_score')) # Default minimum score to 100
except (ValueError, TypeError): min_score = 100
log.warning( requirements = milestone.get('requirements')
'Failed to find minimum score for gating milestone %s, defaulting to 100', if requirements:
json.dumps(milestone) try:
) min_score = int(requirements.get('min_score'))
except (ValueError, TypeError):
if new_score >= min_score: log.warning(
milestones_helpers.add_user_milestone({'id': user.id}, prereq_milestone) 'Failed to find minimum score for gating milestone %s, defaulting to 100',
else: json.dumps(milestone)
milestones_helpers.remove_user_milestone({'id': user.id}, prereq_milestone) )
if score >= min_score:
milestones_helpers.add_user_milestone({'id': user_id}, prereq_milestone)
else:
milestones_helpers.remove_user_milestone({'id': user_id}, prereq_milestone)
lms/djangoapps/gating/signals.py
...@@ -2,12 +2,14 @@ ...@@ -2,12 +2,14 @@
Signal handlers for the gating djangoapp Signal handlers for the gating djangoapp
""" """
from django.dispatch import receiver from django.dispatch import receiver
from lms.djangoapps.grades.signals.signals import SUBSECTION_SCORE_UPDATED from opaque_keys.edx.keys import CourseKey, UsageKey
from xmodule.modulestore.django import modulestore
from lms.djangoapps.grades.signals.signals import SCORE_CHANGED
from gating import api as gating_api from gating import api as gating_api
@receiver(SUBSECTION_SCORE_UPDATED) @receiver(SCORE_CHANGED)
def handle_subsection_score_updated(**kwargs): def handle_score_changed(**kwargs):
""" """
Receives the SCORE_CHANGED signal sent by LMS when a student's score has changed Receives the SCORE_CHANGED signal sent by LMS when a student's score has changed
for a given component and triggers the evaluation of any milestone relationships for a given component and triggers the evaluation of any milestone relationships
...@@ -19,13 +21,10 @@ def handle_subsection_score_updated(**kwargs): ...@@ -19,13 +21,10 @@ def handle_subsection_score_updated(**kwargs):
Returns: Returns:
None None
""" """
course = kwargs['course'] course = modulestore().get_course(CourseKey.from_string(kwargs.get('course_id')))
if course.enable_subsection_gating: if course.enable_subsection_gating:
subsection_grade = kwargs['subsection_grade']
new_score = subsection_grade.graded_total.earned / subsection_grade.graded_total.possible * 100.0
gating_api.evaluate_prerequisite( gating_api.evaluate_prerequisite(
course, course,
kwargs['user'], UsageKey.from_string(kwargs.get('usage_id')),
subsection_grade.location, kwargs.get('user').id,
new_score,
) )
lms/djangoapps/gating/tests/test_api.py
...@@ -6,18 +6,15 @@ from nose.plugins.attrib import attr ...@@ -6,18 +6,15 @@ from nose.plugins.attrib import attr
from ddt import ddt, data, unpack from ddt import ddt, data, unpack
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
from courseware.tests.helpers import LoginEnrollmentTestCase
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.tests.helpers import get_request_for_user
from lms.djangoapps.grades.tests.utils import answer_problem
from lms.djangoapps.grades.new.course_grade import CourseGradeFactory
from milestones import api as milestones_api from milestones import api as milestones_api
from milestones.tests.utils import MilestonesTestCaseMixin from milestones.tests.utils import MilestonesTestCaseMixin
from openedx.core.lib.gating import api as gating_api from openedx.core.lib.gating import api as gating_api
from request_cache.middleware import RequestCache from gating.api import _get_xblock_parent, evaluate_prerequisite
class GatingTestCase(ModuleStoreTestCase): class GatingTestCase(LoginEnrollmentTestCase, ModuleStoreTestCase):
""" """
Base TestCase class for setting up a basic course structure Base TestCase class for setting up a basic course structure
and testing the gating feature and testing the gating feature
...@@ -37,16 +34,6 @@ class GatingTestCase(ModuleStoreTestCase): ...@@ -37,16 +34,6 @@ class GatingTestCase(ModuleStoreTestCase):
display_name='edX 101' display_name='edX 101'
) )
self.course.enable_subsection_gating = True self.course.enable_subsection_gating = True
grading_policy = {
"GRADER": [{
"type": "Homework",
"min_count": 3,
"drop_count": 0,
"short_label": "HW",
"weight": 1.0
}]
}
self.course.grading_policy = grading_policy
self.course.save() self.course.save()
self.store.update_item(self.course, 0) self.store.update_item(self.course, 0)
...@@ -54,197 +41,136 @@ class GatingTestCase(ModuleStoreTestCase): ...@@ -54,197 +41,136 @@ class GatingTestCase(ModuleStoreTestCase):
self.chapter1 = ItemFactory.create( self.chapter1 = ItemFactory.create(
parent_location=self.course.location, parent_location=self.course.location,
category='chapter', category='chapter',
display_name='chapter 1' display_name='untitled chapter 1'
) )
# create sequentials # create sequentials
self.seq1 = ItemFactory.create( self.seq1 = ItemFactory.create(
parent_location=self.chapter1.location, parent_location=self.chapter1.location,
category='sequential', category='sequential',
display_name='gating sequential 1', display_name='untitled sequential 1'
graded=True,
format='Homework',
) )
self.seq2 = ItemFactory.create( self.seq2 = ItemFactory.create(
parent_location=self.chapter1.location, parent_location=self.chapter1.location,
category='sequential', category='sequential',
display_name='gated sequential 2', display_name='untitled sequential 2'
graded=True,
format='Homework',
)
self.seq3 = ItemFactory.create(
parent_location=self.chapter1.location,
category='sequential',
display_name='sequential 3',
graded=True,
format='Homework',
) )
# create problem # create vertical
self.gating_prob1 = ItemFactory.create( self.vert1 = ItemFactory.create(
parent_location=self.seq1.location, parent_location=self.seq1.location,
category='problem', category='vertical',
display_name='gating problem 1', display_name='untitled vertical 1'
)
self.gated_prob2 = ItemFactory.create(
parent_location=self.seq2.location,
category='problem',
display_name='gated problem 2',
) )
self.prob3 = ItemFactory.create(
parent_location=self.seq3.location, # create problem
self.prob1 = ItemFactory.create(
parent_location=self.vert1.location,
category='problem', category='problem',
display_name='problem 3', display_name='untitled problem 1'
) )
# create orphan # create orphan
self.orphan = ItemFactory.create( self.prob2 = ItemFactory.create(
parent_location=self.course.location, parent_location=self.course.location,
category='problem', category='problem',
display_name='orphan' display_name='untitled problem 2'
)
self.prereq_milestone = None
def setup_gating_milestone(self, min_score):
"""
Setup a gating milestone for testing.
Gating content: seq1 (must be fulfilled before access to seq2)
Gated content: seq2 (requires completion of seq1 before access)
"""
gating_api.add_prerequisite(self.course.id, self.seq1.location)
gating_api.set_required_content(self.course.id, self.seq2.location, self.seq1.location, min_score)
self.prereq_milestone = gating_api.get_gating_milestone(self.course.id, self.seq1.location, 'fulfills')
def verify_access_to_gated_content(self, user, expected_access):
"""
Verifies access to gated content for the given user is as expected.
"""
# clear the request cache to flush any cached access results
RequestCache.clear_request_cache()
# access to gating content (seq1) remains constant
self.assertTrue(bool(has_access(user, 'load', self.seq1, self.course.id)))
# access to gated content (seq2) is as expected
self.assertEquals(bool(has_access(user, 'load', self.seq2, self.course.id)), expected_access)
def verify_user_has_prereq_milestone(self, user, expected_has_milestone):
"""
Verifies whether or not the user has the prereq milestone
"""
self.assertEquals(
milestones_api.user_has_milestone({'id': user.id}, self.prereq_milestone),
expected_has_milestone,
) )
@attr(shard=3) class TestGetXBlockParent(GatingTestCase):
class TestGatedContent(GatingTestCase, MilestonesTestCaseMixin):
""" """
Tests for gated content. Tests for the get_xblock_parent function
""" """
def setUp(self):
super(TestGatedContent, self).setUp()
self.setup_gating_milestone(100)
self.non_staff_user, _ = self.create_non_staff_user()
def test_gated_for_nonstaff(self):
self.verify_user_has_prereq_milestone(self.non_staff_user, expected_has_milestone=False)
self.verify_access_to_gated_content(self.non_staff_user, expected_access=False)
def test_not_gated_for_staff(self): def test_get_direct_parent(self):
self.verify_user_has_prereq_milestone(self.user, expected_has_milestone=False) """ Test test_get_direct_parent """
self.verify_access_to_gated_content(self.user, expected_access=True)
def _verify_course_grade(self, user, expected_percent): result = _get_xblock_parent(self.vert1)
""" self.assertEqual(result.location, self.seq1.location)
Verifies the given user's course grade is the expected percentage.
Also verifies the user's grade information contains values for
all problems in the course, whether or not they are currently
gated.
"""
course_grade = CourseGradeFactory(user).create(self.course)
for prob in [self.gating_prob1, self.gated_prob2, self.prob3]:
self.assertIn(prob.location, course_grade.locations_to_scores)
self.assertNotIn(self.orphan.location, course_grade.locations_to_scores)
self.assertEquals(course_grade.percent, expected_percent)
def test_gated_content_always_in_grades(self): def test_get_parent_with_category(self):
request = get_request_for_user(self.non_staff_user) """ Test test_get_parent_of_category """
# start with a grade from a non-gated subsection result = _get_xblock_parent(self.vert1, 'sequential')
answer_problem(self.course, request, self.prob3, 10, 10) self.assertEqual(result.location, self.seq1.location)
result = _get_xblock_parent(self.vert1, 'chapter')
self.assertEqual(result.location, self.chapter1.location)
# verify gated status and overall course grade percentage def test_get_parent_none(self):
self.verify_user_has_prereq_milestone(self.non_staff_user, expected_has_milestone=False) """ Test test_get_parent_none """
self.verify_access_to_gated_content(self.non_staff_user, expected_access=False)
self._verify_course_grade(self.non_staff_user, .33)
# fulfill the gated requirements result = _get_xblock_parent(self.vert1, 'unit')
answer_problem(self.course, request, self.gating_prob1, 10, 10) self.assertIsNone(result)
# verify gated status and overall course grade percentage
self.verify_user_has_prereq_milestone(self.non_staff_user, expected_has_milestone=True)
self.verify_access_to_gated_content(self.non_staff_user, expected_access=True)
self._verify_course_grade(self.non_staff_user, .67)
@attr(shard=3) @attr(shard=3)
@ddt @ddt
class TestHandleSubsectionGradeUpdates(GatingTestCase, MilestonesTestCaseMixin): class TestEvaluatePrerequisite(GatingTestCase, MilestonesTestCaseMixin):
""" """
Tests for gated content when subsection grade is updated. Tests for the evaluate_prerequisite function
""" """
def setUp(self): def setUp(self):
super(TestHandleSubsectionGradeUpdates, self).setUp() super(TestEvaluatePrerequisite, self).setUp()
self.user, _ = self.create_non_staff_user() # run tests for a non-staff user self.user_dict = {'id': self.user.id}
self.request = get_request_for_user(self.user) self.prereq_milestone = None
def test_signal_handler_called(self): def _setup_gating_milestone(self, min_score):
with patch('lms.djangoapps.gating.signals.gating_api.evaluate_prerequisite') as mock_handler: """
self.assertFalse(mock_handler.called) Setup a gating milestone for testing
answer_problem(self.course, self.request, self.gating_prob1, 1, 1) """
self.assertTrue(mock_handler.called)
@data((1, 2, True), (1, 1, True), (0, 1, False)) gating_api.add_prerequisite(self.course.id, self.seq1.location)
@unpack gating_api.set_required_content(self.course.id, self.seq2.location, self.seq1.location, min_score)
def test_min_score_achieved(self, earned, max_possible, result): self.prereq_milestone = gating_api.get_gating_milestone(self.course.id, self.seq1.location, 'fulfills')
self.setup_gating_milestone(50)
self.verify_user_has_prereq_milestone(self.user, expected_has_milestone=False) @patch('gating.api.get_module_score')
self.verify_access_to_gated_content(self.user, expected_access=False) @data((.5, True), (1, True), (0, False))
@unpack
def test_min_score_achieved(self, module_score, result, mock_module_score):
""" Test test_min_score_achieved """
answer_problem(self.course, self.request, self.gating_prob1, earned, max_possible) self._setup_gating_milestone(50)
self.verify_user_has_prereq_milestone(self.user, expected_has_milestone=result) mock_module_score.return_value = module_score
self.verify_access_to_gated_content(self.user, expected_access=result) evaluate_prerequisite(self.course, self.prob1.location, self.user.id)
self.assertEqual(milestones_api.user_has_milestone(self.user_dict, self.prereq_milestone), result)
@patch('gating.api.log.warning') @patch('gating.api.log.warning')
@data((1, 2, False), (1, 1, True)) @patch('gating.api.get_module_score')
@data((.5, False), (1, True))
@unpack @unpack
def test_invalid_min_score(self, earned, max_possible, result, mock_log): def test_invalid_min_score(self, module_score, result, mock_module_score, mock_log):
self.setup_gating_milestone(None) """ Test test_invalid_min_score """
answer_problem(self.course, self.request, self.gating_prob1, earned, max_possible) self._setup_gating_milestone(None)
self.verify_user_has_prereq_milestone(self.user, expected_has_milestone=result)
mock_module_score.return_value = module_score
evaluate_prerequisite(self.course, self.prob1.location, self.user.id)
self.assertEqual(milestones_api.user_has_milestone(self.user_dict, self.prereq_milestone), result)
self.assertTrue(mock_log.called) self.assertTrue(mock_log.called)
def test_orphaned_xblock(self): @patch('gating.api.get_module_score')
with patch('lms.djangoapps.gating.signals.gating_api.evaluate_prerequisite') as mock_handler: def test_orphaned_xblock(self, mock_module_score):
self.assertFalse(mock_handler.called) """ Test test_orphaned_xblock """
answer_problem(self.course, self.request, self.orphan, 1, 1)
self.assertFalse(mock_handler.called) evaluate_prerequisite(self.course, self.prob2.location, self.user.id)
self.assertFalse(mock_module_score.called)
@patch('gating.api.get_module_score')
def test_no_prerequisites(self, mock_module_score):
""" Test test_no_prerequisites """
@patch('gating.api.milestones_helpers') evaluate_prerequisite(self.course, self.prob1.location, self.user.id)
def test_no_prerequisites(self, mock_milestones): self.assertFalse(mock_module_score.called)
answer_problem(self.course, self.request, self.gating_prob1, 1, 1)
self.assertFalse(mock_milestones.called)
@patch('gating.api.milestones_helpers') @patch('gating.api.get_module_score')
def test_no_gated_content(self, mock_milestones): def test_no_gated_content(self, mock_module_score):
""" Test test_no_gated_content """
# Setup gating milestones data
gating_api.add_prerequisite(self.course.id, self.seq1.location) gating_api.add_prerequisite(self.course.id, self.seq1.location)
answer_problem(self.course, self.request, self.gating_prob1, 1, 1)
self.assertFalse(mock_milestones.called) evaluate_prerequisite(self.course, self.prob1.location, self.user.id)
self.assertFalse(mock_module_score.called)
lms/djangoapps/gating/tests/test_signals.py
""" """
Unit tests for gating.signals module Unit tests for gating.signals module
""" """
from mock import patch, MagicMock from mock import patch
from opaque_keys.edx.keys import UsageKey from opaque_keys.edx.keys import UsageKey
from student.tests.factories import UserFactory from student.tests.factories import UserFactory
...@@ -9,7 +9,7 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase ...@@ -9,7 +9,7 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.tests.factories import CourseFactory
from xmodule.modulestore.django import modulestore from xmodule.modulestore.django import modulestore
from gating.signals import handle_subsection_score_updated from gating.signals import handle_score_changed
class TestHandleScoreChanged(ModuleStoreTestCase): class TestHandleScoreChanged(ModuleStoreTestCase):
...@@ -24,22 +24,28 @@ class TestHandleScoreChanged(ModuleStoreTestCase): ...@@ -24,22 +24,28 @@ class TestHandleScoreChanged(ModuleStoreTestCase):
@patch('gating.signals.gating_api.evaluate_prerequisite') @patch('gating.signals.gating_api.evaluate_prerequisite')
def test_gating_enabled(self, mock_evaluate): def test_gating_enabled(self, mock_evaluate):
""" Test evaluate_prerequisite is called when course.enable_subsection_gating is True """
self.course.enable_subsection_gating = True self.course.enable_subsection_gating = True
modulestore().update_item(self.course, 0) modulestore().update_item(self.course, 0)
handle_subsection_score_updated( handle_score_changed(
sender=None, sender=None,
course=self.course, points_possible=1,
points_earned=1,
user=self.user, user=self.user,
subsection_grade=MagicMock(), course_id=unicode(self.course.id),
usage_id=unicode(self.test_usage_key)
) )
mock_evaluate.assert_called() mock_evaluate.assert_called_with(self.course, self.test_usage_key, self.user.id) # pylint: disable=no-member
@patch('gating.signals.gating_api.evaluate_prerequisite') @patch('gating.signals.gating_api.evaluate_prerequisite')
def test_gating_disabled(self, mock_evaluate): def test_gating_disabled(self, mock_evaluate):
handle_subsection_score_updated( """ Test evaluate_prerequisite is not called when course.enable_subsection_gating is False """
handle_score_changed(
sender=None, sender=None,
course=self.course, points_possible=1,
points_earned=1,
user=self.user, user=self.user,
subsection_grade=MagicMock(), course_id=unicode(self.course.id),
usage_id=unicode(self.test_usage_key)
) )
mock_evaluate.assert_not_called() mock_evaluate.assert_not_called()
lms/djangoapps/grades/module_grades.py 0 → 100644
"""
Functionality for module-level grades.
"""
# TODO The score computation in this file is not accurate
# since it is summing percentages instead of computing a
# final percentage of the individual sums.
# Regardless, this file and its code should be removed soon
# as part of TNL-5062.
from django.test.client import RequestFactory
from courseware.model_data import FieldDataCache, ScoresClient
from courseware.module_render import get_module_for_descriptor
from opaque_keys.edx.locator import BlockUsageLocator
from util.module_utils import yield_dynamic_descriptor_descendants
def _get_mock_request(student):
"""
Make a fake request because grading code expects to be able to look at
the request. We have to attach the correct user to the request before
grading that student.
"""
request = RequestFactory().get('/')
request.user = student
return request
def _calculate_score_for_modules(user_id, course, modules):
"""
Calculates the cumulative score (percent) of the given modules
"""
# removing branch and version from exam modules locator
# otherwise student module would not return scores since module usage keys would not match
modules = [m for m in modules]
locations = [
BlockUsageLocator(
course_key=course.id,
block_type=module.location.block_type,
block_id=module.location.block_id
)
if isinstance(module.location, BlockUsageLocator) and module.location.version
else module.location
for module in modules
]
scores_client = ScoresClient(course.id, user_id)
scores_client.fetch_scores(locations)
# Iterate over all of the exam modules to get score percentage of user for each of them
module_percentages = []
ignore_categories = ['course', 'chapter', 'sequential', 'vertical', 'randomize', 'library_content']
for index, module in enumerate(modules):
if module.category not in ignore_categories and (module.graded or module.has_score):
module_score = scores_client.get(locations[index])
if module_score:
correct = module_score.correct or 0
total = module_score.total or 1
module_percentages.append(correct / total)
return sum(module_percentages) / float(len(module_percentages)) if module_percentages else 0
def get_module_score(user, course, module):
"""
Collects all children of the given module and calculates the cumulative
score for this set of modules for the given user.
Arguments:
user (User): The user
course (CourseModule): The course
module (XBlock): The module
Returns:
float: The cumulative score
"""
def inner_get_module(descriptor):
"""
Delegate to get_module_for_descriptor
"""
field_data_cache = FieldDataCache([descriptor], course.id, user)
return get_module_for_descriptor(
user,
_get_mock_request(user),
descriptor,
field_data_cache,
course.id,
course=course
)
modules = yield_dynamic_descriptor_descendants(
module,
user.id,
inner_get_module
)
return _calculate_score_for_modules(user.id, course, modules)
lms/djangoapps/grades/new/subsection_grade.py
...@@ -251,6 +251,11 @@ class SubsectionGradeFactory(object): ...@@ -251,6 +251,11 @@ class SubsectionGradeFactory(object):
""" """
Updates the SubsectionGrade object for the student and subsection. Updates the SubsectionGrade object for the student and subsection.
""" """
# Save ourselves the extra queries if the course does not persist
# subsection grades.
if not PersistentGradesEnabledFlag.feature_enabled(self.course.id):
return
self._log_event(log.warning, u"update, subsection: {}".format(subsection.location)) self._log_event(log.warning, u"update, subsection: {}".format(subsection.location))
block_structure = self._get_block_structure(block_structure) block_structure = self._get_block_structure(block_structure)
...@@ -259,10 +264,8 @@ class SubsectionGradeFactory(object): ...@@ -259,10 +264,8 @@ class SubsectionGradeFactory(object):
self.student, block_structure, self._submissions_scores, self._csm_scores self.student, block_structure, self._submissions_scores, self._csm_scores
) )
if PersistentGradesEnabledFlag.feature_enabled(self.course.id): grade_model = subsection_grade.update_or_create_model(self.student)
grade_model = subsection_grade.update_or_create_model(self.student) self._update_saved_subsection_grade(subsection.location, grade_model)
self._update_saved_subsection_grade(subsection.location, grade_model)
return subsection_grade return subsection_grade
@lazy @lazy
......
lms/djangoapps/grades/signals/handlers.py
...@@ -13,7 +13,7 @@ from openedx.core.djangoapps.content.block_structure.api import get_course_in_ca ...@@ -13,7 +13,7 @@ from openedx.core.djangoapps.content.block_structure.api import get_course_in_ca
from student.models import user_by_anonymous_id from student.models import user_by_anonymous_id
from submissions.models import score_set, score_reset from submissions.models import score_set, score_reset
from .signals import SCORE_CHANGED, SUBSECTION_SCORE_UPDATED from .signals import SCORE_CHANGED
from ..config.models import PersistentGradesEnabledFlag from ..config.models import PersistentGradesEnabledFlag
from ..transformer import GradesTransformer from ..transformer import GradesTransformer
from ..new.subsection_grade import SubsectionGradeFactory from ..new.subsection_grade import SubsectionGradeFactory
...@@ -95,6 +95,8 @@ def recalculate_subsection_grade_handler(sender, **kwargs): # pylint: disable=u ...@@ -95,6 +95,8 @@ def recalculate_subsection_grade_handler(sender, **kwargs): # pylint: disable=u
""" """
student = kwargs['user'] student = kwargs['user']
course_key = CourseLocator.from_string(kwargs['course_id']) course_key = CourseLocator.from_string(kwargs['course_id'])
if not PersistentGradesEnabledFlag.feature_enabled(course_key):
return
scored_block_usage_key = UsageKey.from_string(kwargs['usage_id']).replace(course_key=course_key) scored_block_usage_key = UsageKey.from_string(kwargs['usage_id']).replace(course_key=course_key)
collected_block_structure = get_course_in_cache(course_key) collected_block_structure = get_course_in_cache(course_key)
...@@ -113,12 +115,6 @@ def recalculate_subsection_grade_handler(sender, **kwargs): # pylint: disable=u ...@@ -113,12 +115,6 @@ def recalculate_subsection_grade_handler(sender, **kwargs): # pylint: disable=u
subsection_usage_key, subsection_usage_key,
collected_block_structure=collected_block_structure, collected_block_structure=collected_block_structure,
) )
subsection_grade = subsection_grade_factory.update( subsection_grade_factory.update(
transformed_subsection_structure[subsection_usage_key], transformed_subsection_structure transformed_subsection_structure[subsection_usage_key], transformed_subsection_structure
) )
SUBSECTION_SCORE_UPDATED.send(
sender=None,
course=course,
user=student,
subsection_grade=subsection_grade,
)
lms/djangoapps/grades/signals/signals.py
...@@ -14,20 +14,8 @@ SCORE_CHANGED = Signal( ...@@ -14,20 +14,8 @@ SCORE_CHANGED = Signal(
providing_args=[ providing_args=[
'points_possible', # Maximum score available for the exercise 'points_possible', # Maximum score available for the exercise
'points_earned', # Score obtained by the user 'points_earned', # Score obtained by the user
'user', # User object 'user_id', # Integer User ID
'course_id', # Unicode string representing the course 'course_id', # Unicode string representing the course
'usage_id' # Unicode string indicating the courseware instance 'usage_id' # Unicode string indicating the courseware instance
] ]
) )
# Signal that indicates that a user's score for a subsection has been updated.
# This is a downstream signal of SCORE_CHANGED sent for each affected containing
# subsection.
SUBSECTION_SCORE_UPDATED = Signal(
providing_args=[
'course', # Course object
'user', # User object
'subsection_grade', # SubsectionGrade object
]
)
lms/djangoapps/grades/tests/test_grades.py
...@@ -10,7 +10,12 @@ from nose.plugins.attrib import attr ...@@ -10,7 +10,12 @@ from nose.plugins.attrib import attr
from opaque_keys.edx.locations import SlashSeparatedCourseKey from opaque_keys.edx.locations import SlashSeparatedCourseKey
from capa.tests.response_xml_factory import MultipleChoiceResponseXMLFactory from capa.tests.response_xml_factory import MultipleChoiceResponseXMLFactory
from courseware.tests.helpers import get_request_for_user from courseware.module_render import get_module
from courseware.model_data import FieldDataCache, set_score
from courseware.tests.helpers import (
LoginEnrollmentTestCase,
get_request_for_user
)
from lms.djangoapps.course_blocks.api import get_course_blocks from lms.djangoapps.course_blocks.api import get_course_blocks
from student.tests.factories import UserFactory from student.tests.factories import UserFactory
from student.models import CourseEnrollment from student.models import CourseEnrollment
...@@ -20,9 +25,9 @@ from xmodule.modulestore import ModuleStoreEnum ...@@ -20,9 +25,9 @@ from xmodule.modulestore import ModuleStoreEnum
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase
from .utils import answer_problem
from .. import course_grades from .. import course_grades
from ..course_grades import summary as grades_summary from ..course_grades import summary as grades_summary
from ..module_grades import get_module_score
from ..new.course_grade import CourseGradeFactory from ..new.course_grade import CourseGradeFactory
from ..new.subsection_grade import SubsectionGradeFactory from ..new.subsection_grade import SubsectionGradeFactory
...@@ -337,3 +342,222 @@ class TestScoreForModule(SharedModuleStoreTestCase): ...@@ -337,3 +342,222 @@ class TestScoreForModule(SharedModuleStoreTestCase):
earned, possible = self.course_grade.score_for_module(self.m.location) earned, possible = self.course_grade.score_for_module(self.m.location)
self.assertEqual(earned, 0) self.assertEqual(earned, 0)
self.assertEqual(possible, 0) self.assertEqual(possible, 0)
class TestGetModuleScore(LoginEnrollmentTestCase, SharedModuleStoreTestCase):
"""
Test get_module_score
"""
@classmethod
def setUpClass(cls):
super(TestGetModuleScore, cls).setUpClass()
cls.course = CourseFactory.create()
cls.chapter = ItemFactory.create(
parent=cls.course,
category="chapter",
display_name="Test Chapter"
)
cls.seq1 = ItemFactory.create(
parent=cls.chapter,
category='sequential',
display_name="Test Sequential 1",
graded=True
)
cls.seq2 = ItemFactory.create(
parent=cls.chapter,
category='sequential',
display_name="Test Sequential 2",
graded=True
)
cls.seq3 = ItemFactory.create(
parent=cls.chapter,
category='sequential',
display_name="Test Sequential 3",
graded=True
)
cls.vert1 = ItemFactory.create(
parent=cls.seq1,
category='vertical',
display_name='Test Vertical 1'
)
cls.vert2 = ItemFactory.create(
parent=cls.seq2,
category='vertical',
display_name='Test Vertical 2'
)
cls.vert3 = ItemFactory.create(
parent=cls.seq3,
category='vertical',
display_name='Test Vertical 3'
)
cls.randomize = ItemFactory.create(
parent=cls.vert2,
category='randomize',
display_name='Test Randomize'
)
cls.library_content = ItemFactory.create(
parent=cls.vert3,
category='library_content',
display_name='Test Library Content'
)
problem_xml = MultipleChoiceResponseXMLFactory().build_xml(
question_text='The correct answer is Choice 3',
choices=[False, False, True, False],
choice_names=['choice_0', 'choice_1', 'choice_2', 'choice_3']
)
cls.problem1 = ItemFactory.create(
parent=cls.vert1,
category="problem",
display_name="Test Problem 1",
data=problem_xml
)
cls.problem2 = ItemFactory.create(
parent=cls.vert1,
category="problem",
display_name="Test Problem 2",
data=problem_xml
)
cls.problem3 = ItemFactory.create(
parent=cls.randomize,
category="problem",
display_name="Test Problem 3",
data=problem_xml
)
cls.problem4 = ItemFactory.create(
parent=cls.randomize,
category="problem",
display_name="Test Problem 4",
data=problem_xml
)
cls.problem5 = ItemFactory.create(
parent=cls.library_content,
category="problem",
display_name="Test Problem 5",
data=problem_xml
)
cls.problem6 = ItemFactory.create(
parent=cls.library_content,
category="problem",
display_name="Test Problem 6",
data=problem_xml
)
def setUp(self):
"""
Set up test course
"""
super(TestGetModuleScore, self).setUp()
self.request = get_request_for_user(UserFactory())
self.client.login(username=self.request.user.username, password="test")
CourseEnrollment.enroll(self.request.user, self.course.id)
self.course_structure = get_course_blocks(self.request.user, self.course.location)
# warm up the score cache to allow accurate query counts, even if tests are run in random order
get_module_score(self.request.user, self.course, self.seq1)
def test_subsection_scores(self):
"""
Test test_get_module_score
"""
# One query is for getting the list of disabled XBlocks (which is
# then stored in the request).
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
new_score = SubsectionGradeFactory(self.request.user, self.course, self.course_structure).create(self.seq1)
self.assertEqual(score, 0)
self.assertEqual(new_score.all_total.earned, 0)
answer_problem(self.course, self.request, self.problem1)
answer_problem(self.course, self.request, self.problem2)
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
new_score = SubsectionGradeFactory(self.request.user, self.course, self.course_structure).create(self.seq1)
self.assertEqual(score, 1.0)
self.assertEqual(new_score.all_total.earned, 2.0)
# These differ because get_module_score normalizes the subsection score
# to 1, which can cause incorrect aggregation behavior that will be
# fixed by TNL-5062.
answer_problem(self.course, self.request, self.problem1)
answer_problem(self.course, self.request, self.problem2, 0)
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
new_score = SubsectionGradeFactory(self.request.user, self.course, self.course_structure).create(self.seq1)
self.assertEqual(score, .5)
self.assertEqual(new_score.all_total.earned, 1.0)
def test_get_module_score_with_empty_score(self):
"""
Test test_get_module_score_with_empty_score
"""
set_score(self.request.user.id, self.problem1.location, None, None) # pylint: disable=no-member
set_score(self.request.user.id, self.problem2.location, None, None) # pylint: disable=no-member
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
self.assertEqual(score, 0)
answer_problem(self.course, self.request, self.problem1)
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
self.assertEqual(score, 0.5)
answer_problem(self.course, self.request, self.problem2)
with self.assertNumQueries(1):
score = get_module_score(self.request.user, self.course, self.seq1)
self.assertEqual(score, 1.0)
def test_get_module_score_with_randomize(self):
"""
Test test_get_module_score_with_randomize
"""
answer_problem(self.course, self.request, self.problem3)
answer_problem(self.course, self.request, self.problem4)
score = get_module_score(self.request.user, self.course, self.seq2)
self.assertEqual(score, 1.0)
def test_get_module_score_with_library_content(self):
"""
Test test_get_module_score_with_library_content
"""
answer_problem(self.course, self.request, self.problem5)
answer_problem(self.course, self.request, self.problem6)
score = get_module_score(self.request.user, self.course, self.seq3)
self.assertEqual(score, 1.0)
def answer_problem(course, request, problem, score=1, max_value=1):
"""
Records a correct answer for the given problem.
Arguments:
course (Course): Course object, the course the required problem is in
request (Request): request Object
problem (xblock): xblock object, the problem to be answered
"""
user = request.user
grade_dict = {'value': score, 'max_value': max_value, 'user_id': user.id}
field_data_cache = FieldDataCache.cache_for_descriptor_descendents(
course.id,
user,
course,
depth=2
)
# pylint: disable=protected-access
module = get_module(
user,
request,
problem.scope_ids.usage_id,
field_data_cache,
)._xmodule
module.system.publish(problem, 'grade', grade_dict)
lms/djangoapps/grades/tests/test_signals.py
...@@ -244,7 +244,7 @@ class ScoreChangedUpdatesSubsectionGradeTest(ModuleStoreTestCase): ...@@ -244,7 +244,7 @@ class ScoreChangedUpdatesSubsectionGradeTest(ModuleStoreTestCase):
with self.store.default_store(default_store): with self.store.default_store(default_store):
self.set_up_course(enable_subsection_grades=False) self.set_up_course(enable_subsection_grades=False)
self.assertFalse(PersistentGradesEnabledFlag.feature_enabled(self.course.id)) self.assertFalse(PersistentGradesEnabledFlag.feature_enabled(self.course.id))
with check_mongo_calls(2) and self.assertNumQueries(3): with check_mongo_calls(2) and self.assertNumQueries(0):
recalculate_subsection_grade_handler(None, **self.score_changed_kwargs) recalculate_subsection_grade_handler(None, **self.score_changed_kwargs)
@skip("Pending completion of TNL-5089") @skip("Pending completion of TNL-5089")
......
lms/djangoapps/grades/tests/utils.py
...@@ -3,8 +3,6 @@ Utilities for grades related tests ...@@ -3,8 +3,6 @@ Utilities for grades related tests
""" """
from contextlib import contextmanager from contextlib import contextmanager
from mock import patch from mock import patch
from courseware.module_render import get_module
from courseware.model_data import FieldDataCache
from xmodule.graders import ProblemScore from xmodule.graders import ProblemScore
...@@ -26,32 +24,3 @@ def mock_get_score(earned=0, possible=1): ...@@ -26,32 +24,3 @@ def mock_get_score(earned=0, possible=1):
with patch('lms.djangoapps.grades.new.subsection_grade.get_score') as mock_score: with patch('lms.djangoapps.grades.new.subsection_grade.get_score') as mock_score:
mock_score.return_value = ProblemScore(earned, possible, earned, possible, 1, True, None, None) mock_score.return_value = ProblemScore(earned, possible, earned, possible, 1, True, None, None)
yield mock_score yield mock_score
def answer_problem(course, request, problem, score=1, max_value=1):
"""
Records an answer for the given problem.
Arguments:
course (Course): Course object, the course the required problem is in
request (Request): request Object
problem (xblock): xblock object, the problem to be answered
score (float): The new score for the problem
max_value (float): The new maximum score for the problem
"""
user = request.user
grade_dict = {'value': score, 'max_value': max_value, 'user_id': user.id}
field_data_cache = FieldDataCache.cache_for_descriptor_descendents(
course.id,
user,
course,
depth=2
)
module = get_module(
user,
request,
problem.location,
field_data_cache,
)
module.runtime.publish(problem, 'grade', grade_dict)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment