Skip to content

feat: Added submission history API and extended enrollment API to support grading and finished flags. #31491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Agrendalath merged 2 commits into from
Feb 17, 2023
Merged

feat: Added submission history API and extended enrollment API to support grading and finished flags. #31491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76beb4e
fix: Fixed pagination issue with enrollment api.
farhaanbukhsh Jan 3, 2023
5e24f5d
feat: Added grades API for submission history and section grades brea…
farhaanbukhsh Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
359 changes: 357 additions & 2 deletions lms/djangoapps/grades/rest_api/v1/tests/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,23 @@
Tests for v1 views
"""


from collections import OrderedDict
from unittest.mock import MagicMock, patch
from urllib.parse import urlencode

import ddt
from django.db import connections
from django.urls import reverse
from opaque_keys import InvalidKeyError
from rest_framework import status
from rest_framework.test import APITestCase

from common.djangoapps.student.tests.factories import UserFactory
from common.djangoapps.student.tests.factories import GlobalStaffFactory, UserFactory
from lms.djangoapps.courseware.tests.test_submitting_problems import TestSubmittingProblems
from lms.djangoapps.grades.rest_api.v1.tests.mixins import GradeViewTestMixin
from lms.djangoapps.grades.rest_api.v1.views import CourseGradesView
from openedx.core.djangoapps.user_authn.tests.utils import AuthAndScopesTestMixin
from xmodule.modulestore.tests.factories import BlockFactory


@ddt.ddt
Expand Down Expand Up @@ -257,3 +260,355 @@ def test_staff_can_get_all_grades(self):
])

assert expected_data == resp.data


class SectionGradesBreakdownTest(GradeViewTestMixin, APITestCase):
"""
Tests for course grading status for all users in a course
e.g. /api/grades/v1/section_grades_breakdown
/api/grades/v1/section_grades_breakdown/?course_id={course_id}
/api/grades/v1/section_grades_breakdown/?course_id={course_id}&username={username}
"""

@classmethod
def setUpClass(cls):
super().setUpClass()
cls.namespaced_url = 'grades_api:v1:section_grades_breakdown'
cls.section_breakdown = (
[
{
'category': 'Homework',
'detail': f'Homework {i} Unreleased - 0% (?/?)',
'label': f'HW {i:02d}', 'percent': .0
}
for i in range(1, 11)
]
+ [
{
'category': 'Homework',
'detail': 'Homework 11 Unreleased - 0% (?/?)',
'label': 'HW 11',
'mark': {'detail': 'The lowest 2 Homework scores are dropped.'},
'percent': 0.0
},
{
'category': 'Homework',
'detail': 'Homework 12 Unreleased - 0% (?/?)',
'label': 'HW 12',
'mark': {'detail': 'The lowest 2 Homework scores are dropped.'},
'percent': 0.0
}
]
+ [
{
'category': 'Homework',
'detail': 'Homework Average = 0%',
'label': 'HW Avg', 'percent': 0.0,
'prominent': True
}
]
+ [
{
'category': 'Lab',
'detail': f'Lab {i} Unreleased - 0% (?/?)',
'label': f'Lab {i:02d}', 'percent': .0
}
for i in range(1, 11)
]
+ [
{
'category': 'Lab',
'detail': 'Lab 11 Unreleased - 0% (?/?)',
'label': 'Lab 11',
'mark': {'detail': 'The lowest 2 Lab scores are dropped.'},
'percent': 0.0
},
{
'category': 'Lab',
'detail': 'Lab 12 Unreleased - 0% (?/?)',
'label': 'Lab 12',
'mark': {'detail': 'The lowest 2 Lab scores are dropped.'},
'percent': 0.0
},
{
'category': 'Lab',
'detail': 'Lab Average = 0%',
'label': 'Lab Avg',
'percent': 0.0,
'prominent': True
},
{
'category': 'Midterm Exam',
'detail': 'Midterm Exam = 0%',
'label': 'Midterm',
'percent': 0.0,
'prominent': True
},
{
'category': 'Final Exam',
'detail': 'Final Exam = 0%',
'label': 'Final',
'percent': 0.0,
'prominent': True
}
]
)

def get_url(self, query_params=None):
"""
Helper function to create the url
"""
base_url = reverse(
self.namespaced_url,
)
if query_params:
base_url = f'{base_url}?{query_params}'
return base_url

def test_anonymous(self):
resp = self.client.get(self.get_url())
assert resp.status_code == status.HTTP_401_UNAUTHORIZED

def test_student(self):
self.client.login(username=self.student.username, password=self.password)
resp = self.client.get(self.get_url())
assert resp.status_code == status.HTTP_403_FORBIDDEN

def test_course_does_not_exist(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(
self.get_url(
urlencode({'course_id': 'course-v1:MITx+8.MechCX+2014_T1'})
)
)
expected_data = OrderedDict(
[
('next', None),
('previous', None),
('results', [])
]
)
assert resp.status_code == status.HTTP_200_OK
assert expected_data == resp.data

def test_course_no_enrollments(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(
self.get_url(urlencode({'course_id': self.empty_course.id}))
)
assert resp.status_code == status.HTTP_200_OK
expected_data = OrderedDict(
[
('next', None),
('previous', None),
('results', []),
]
)
assert expected_data == resp.data

def test_staff_can_get_all_grades(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(self.get_url(urlencode({'course_id': self.course_key})))

# This should have permission to access this API endpoint.
assert resp.status_code == status.HTTP_200_OK
expected_data = OrderedDict(
[
('next', None),
('previous', None),
(
'results',
[
{
'course_id': str(self.course_key),
'current_grade': 0,
'passed': False,
'section_breakdown': self.section_breakdown,
'username': 'student'
},
{
'course_id': str(self.course_key),
'current_grade': 0,
'passed': False,
'section_breakdown': self.section_breakdown,
'username': 'other_student'
},
{
'course_id': str(self.course_key),
'current_grade': 0,
'passed': False,
'section_breakdown': self.section_breakdown,
'username': 'program_student'
},
{
'course_id': str(self.course_key),
'current_grade': 0,
'passed': False,
'section_breakdown': self.section_breakdown,
'username': 'program_masters_student'
}
]
)
]
)
assert expected_data == resp.data

def test_staff_can_get_all_grades_for_user(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(self.get_url(urlencode({'course_id': self.course_key,
'username': 'student'})))

# this should have permission to access this API endpoint
assert resp.status_code == status.HTTP_200_OK
expected_data = OrderedDict(
[
('next', None),
('previous', None),
(
'results',
[
{
'course_id': str(self.course_key),
'current_grade': 0,
'passed': False,
'section_breakdown': self.section_breakdown,
'username': 'student'
}
]
)
]
)
assert expected_data == resp.data


class CourseSubmissionHistoryTest(GradeViewTestMixin, APITestCase):
"""
Tests for course submission history for all users in a course
e.g. /api/grades/v1/submission_history/{course_id}
/api/grades/v1/submission_history/{course_id}/?username={username}
"""

@classmethod
def setUpClass(cls):
super().setUpClass()
cls.namespaced_url = 'grades_api:v1:submission_history'

def get_url(self, course_key, query_params=None):
"""
Helper function to create the url
"""
base_url = reverse(
self.namespaced_url,
kwargs={
'course_id': course_key,
}
)
if query_params:
base_url = f'{base_url}?{query_params}'
return base_url

def test_anonymous(self):
resp = self.client.get(self.get_url(course_key=self.course_key))
assert resp.status_code == status.HTTP_401_UNAUTHORIZED

def test_student(self):
self.client.login(username=self.student.username, password=self.password)
resp = self.client.get(self.get_url(course_key=self.course_key))
assert resp.status_code == status.HTTP_403_FORBIDDEN

def test_course_does_not_exist(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(
self.get_url(course_key='course-v1:MITx+8.MechCX+2014_T1')
)
expected_data = OrderedDict([('next', None), ('previous', None), ('results', [])])
assert resp.status_code == status.HTTP_200_OK
assert expected_data == resp.data

def test_course_no_enrollments(self):
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(
self.get_url(course_key=self.empty_course.id)
)
assert resp.status_code == status.HTTP_200_OK
expected_data = OrderedDict([('next', None), ('previous', None), ('results', [])])
assert expected_data == resp.data


class CourseSubmissionHistoryWithDataTest(TestSubmittingProblems):
"""
Tests for course submission history for all users in a course
e.g. /api/grades/v1/submission_history/?course_id={course_id}
/api/grades/v1/submission_history?course_id={course_id}&username={username}
"""

# Tell Django to clean out all databases, not just default
databases = set(connections)

def setUp(self):
super().setUp()
self.namespaced_url = 'grades_api:v1:submission_history'
self.password = 'test'
self.basic_setup()
self.global_staff = GlobalStaffFactory.create()

def basic_setup(self, late=False, reset=False, showanswer=False):
"""
Set up a simple course for testing basic grading functionality.
"""
grading_policy = {
"GRADER": [{
"type": "Homework",
"min_count": 1,
"drop_count": 0,
"short_label": "HW",
"weight": 1.0
}],
"GRADE_CUTOFFS": {
'A': .9,
'B': .33
}
}
self.add_grading_policy(grading_policy)

# set up a simple course with four problems
homework = self.add_graded_section_to_course('homework', late=late, reset=reset, showanswer=showanswer)
vertical = BlockFactory.create(
parent_location=homework.location,
category='vertical',
display_name='Subsection 1',
)
self.add_dropdown_to_section(vertical.location, 'p1', 1)
self.add_dropdown_to_section(vertical.location, 'p2', 1)
self.add_dropdown_to_section(vertical.location, 'p3', 1)

self.refresh_course()

def get_url(self, course_key, query_params=None):
"""
Helper function to create the url
"""
base_url = reverse(
self.namespaced_url,
kwargs={
'course_id': course_key,
}
)
if query_params:
base_url = f'{base_url}?{query_params}'
return base_url

def test_course_exist_with_data(self):
self.submit_question_answer('p1', {'2_1': 'Correct'})
self.client.login(username=self.global_staff.username, password=self.password)
resp = self.client.get(
self.get_url(
course_key=self.course.id,
)
)
assert resp.status_code == status.HTTP_200_OK
resp_json = resp.json()['results'][0]
assert resp_json['course_id'] == str(self.course.id)
assert resp_json['course_name'] == 'test_course'
assert len(resp_json['problems']) > 0
assert len(resp_json['problems'][0]['submission_history']) > 0
10 changes: 10 additions & 0 deletions lms/djangoapps/grades/rest_api/v1/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,14 @@
gradebook_views.SubsectionGradeView.as_view(),
name='course_grade_overrides'
),
path(
'section_grades_breakdown/',
views.SectionGradesBreakdown.as_view(),
name='section_grades_breakdown'
),
re_path(
Comment thread
Agrendalath marked this conversation as resolved.
Outdated
fr'submission_history/{settings.COURSE_ID_PATTERN}/',
views.SubmissionHistoryView.as_view(),
name='submission_history'
),
]
Loading