Skip to content

Add OAuth2 support for problem response reports endpoints #24873

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

Closed
pcockwell wants to merge 1 commit into from
Closed

Add OAuth2 support for problem response reports endpoints #24873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
119 changes: 101 additions & 18 deletions lms/djangoapps/instructor/tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
from openedx.core.djangoapps.course_groups.cohorts import set_course_cohorted
from openedx.core.djangoapps.django_comment_common.models import FORUM_ROLE_COMMUNITY_TA
from openedx.core.djangoapps.django_comment_common.utils import seed_permissions_roles

from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from openedx.core.djangoapps.site_configuration.tests.mixins import SiteMixin
from openedx.core.lib.teams_config import TeamsConfig
Expand Down Expand Up @@ -132,7 +133,7 @@
},
{
'report_type': 'problem responses',
'instructor_api_endpoint': 'get_problem_responses',
'instructor_api_endpoint': 'api_instructor:get_problem_responses',
'task_api_endpoint': 'lms.djangoapps.instructor_task.api.submit_calculate_problem_responses_csv',
'extra_instructor_api_kwargs': {},
}
Expand All @@ -152,7 +153,7 @@
'export_ora2_submission_files',
'export_ora2_summary',
'get_grading_config',
'get_problem_responses',
'api_instructor:get_problem_responses',
'get_proctored_exam_results',
'get_student_enrollment_status',
'get_student_progress_url',
Expand All @@ -163,8 +164,8 @@
'list_email_content',
'list_entrance_exam_instructor_tasks',
'list_forum_members',
'list_instructor_tasks',
'list_report_downloads',
'api_instructor:list_instructor_tasks',
'api_instructor:list_report_downloads',
'mark_student_can_skip_entrance_exam',
'modify_access',
'register_and_enroll_students',
Expand Down Expand Up @@ -413,14 +414,14 @@ def setUp(self):
{'unique_student_identifier': self.user.email, 'rolename': 'Moderator', 'action': 'allow'}),
('list_forum_members', {'rolename': FORUM_ROLE_COMMUNITY_TA}),
('send_email', {'send_to': '["staff"]', 'subject': 'test', 'message': 'asdf'}),
('list_instructor_tasks', {}),
('api_instructor:list_instructor_tasks', {}),
('list_background_email_tasks', {}),
('list_report_downloads', {}),
('api_instructor:list_report_downloads', {}),
('calculate_grades_csv', {}),
('get_students_features', {}),
('get_students_who_may_enroll', {}),
('get_proctored_exam_results', {}),
('get_problem_responses', {}),
('api_instructor:get_problem_responses', {}),
('export_ora2_data', {}),
('export_ora2_submission_files', {}),
('export_ora2_summary', {}),
Expand Down Expand Up @@ -498,7 +499,7 @@ def _access_problem_responses_endpoint(self, msg):
mock_problem_key.course_key = self.course.id
with patch.object(UsageKey, 'from_string') as patched_method:
patched_method.return_value = mock_problem_key
self._access_endpoint('get_problem_responses', {}, 200, msg)
self._access_endpoint('api_instructor:get_problem_responses', {}, 200, msg)

def test_staff_level(self):
"""
Expand All @@ -518,7 +519,7 @@ def test_staff_level(self):
# TODO: make these work
if endpoint in ['update_forum_role_membership', 'list_forum_members']:
continue
elif endpoint == 'get_problem_responses':
elif endpoint == 'api_instructor:get_problem_responses':
self._access_problem_responses_endpoint(
"Staff member should be allowed to access endpoint " + endpoint
)
Expand Down Expand Up @@ -555,7 +556,7 @@ def test_instructor_level(self):
# TODO: make these work
if endpoint in ['update_forum_role_membership']:
continue
elif endpoint == 'get_problem_responses':
elif endpoint == 'api_instructor:get_problem_responses':
self._access_problem_responses_endpoint(
"Instructor should be allowed to access endpoint " + endpoint
)
Expand Down Expand Up @@ -2493,7 +2494,7 @@ def test_get_problem_responses_invalid_location(self):
message when users submit an invalid problem location.
"""
url = reverse(
'get_problem_responses',
'api_instructor:get_problem_responses',
kwargs={'course_id': str(self.course.id)}
)
problem_location = ''
Expand Down Expand Up @@ -2528,7 +2529,7 @@ def test_get_problem_responses_successful(self):
message if CSV generation was started successfully.
"""
url = reverse(
'get_problem_responses',
'api_instructor:get_problem_responses',
kwargs={'course_id': str(self.course.id)}
)
problem_location = ''
Expand All @@ -2548,7 +2549,7 @@ def test_get_problem_responses_already_running(self):
message if CSV generation is already in progress.
"""
url = reverse(
'get_problem_responses',
'api_instructor:get_problem_responses',
kwargs={'course_id': str(self.course.id)}
)
task_type = 'problem_responses_csv'
Expand Down Expand Up @@ -2739,7 +2740,7 @@ def test_list_report_downloads_error(self, mock_error):
"""
ex_status = 503
ex_reason = 'Slow Down'
url = reverse('list_report_downloads', kwargs={'course_id': str(self.course.id)})
url = reverse('api_instructor:list_report_downloads', kwargs={'course_id': str(self.course.id)})
with patch('storages.backends.s3boto.S3BotoStorage.listdir', side_effect=BotoServerError(ex_status, ex_reason)):
response = self.client.post(url, {})
mock_error.assert_called_with(
Expand All @@ -2753,7 +2754,7 @@ def test_list_report_downloads_error(self, mock_error):
assert res_json == {'downloads': []}

def test_list_report_downloads(self):
url = reverse('list_report_downloads', kwargs={'course_id': str(self.course.id)})
url = reverse('api_instructor:list_report_downloads', kwargs={'course_id': str(self.course.id)})
with patch('lms.djangoapps.instructor_task.models.DjangoStorageReportStore.links_for') as mock_links_for:
mock_links_for.return_value = [
('mock_file_name_1', 'https://1.mock.url'),
Expand Down Expand Up @@ -3539,7 +3540,7 @@ def setUp(self):
def test_list_instructor_tasks_running(self, act):
""" Test list of all running tasks. """
act.return_value = self.tasks
url = reverse('list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
url = reverse('api_instructor:list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
mock_factory = MockCompletionInfo()
with patch(
'lms.djangoapps.instructor.views.instructor_task_helpers.get_task_completion_info'
Expand Down Expand Up @@ -3581,7 +3582,7 @@ def test_list_background_email_tasks(self, act):
def test_list_instructor_tasks_problem(self, act):
""" Test list task history for problem. """
act.return_value = self.tasks
url = reverse('list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
url = reverse('api_instructor:list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
mock_factory = MockCompletionInfo()
with patch(
'lms.djangoapps.instructor.views.instructor_task_helpers.get_task_completion_info'
Expand All @@ -3604,7 +3605,7 @@ def test_list_instructor_tasks_problem(self, act):
def test_list_instructor_tasks_problem_student(self, act):
""" Test list task history for problem AND student. """
act.return_value = self.tasks
url = reverse('list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
url = reverse('api_instructor:list_instructor_tasks', kwargs={'course_id': str(self.course.id)})
mock_factory = MockCompletionInfo()
with patch(
'lms.djangoapps.instructor.views.instructor_task_helpers.get_task_completion_info'
Expand All @@ -3626,6 +3627,88 @@ def test_list_instructor_tasks_problem_student(self, act):
assert actual_tasks == expected_tasks


class TestInstructorAPIOAuth(SharedModuleStoreTestCase, LoginEnrollmentTestCase):
"""
Test instructor API OAuth endpoint support.
"""
password = 'password'

@classmethod
def setUpClass(cls):
super(TestInstructorAPIOAuth, cls).setUpClass()
cls.course = CourseFactory.create(
entrance_exam_id='i4x://{}/{}/chapter/Entrance_exam'.format('test_org', 'test_course')
)

def setUp(self):
super().setUp()
self.staff = GlobalStaffFactory()

@patch('lms.djangoapps.instructor_task.api.get_running_instructor_tasks')
def test_list_instructor_tasks_oauth(self, act):
"""
Test if list_instructor_tasks endpoints supports OAuth
"""
act.return_value = []
url = reverse('api_instructor:list_instructor_tasks', kwargs={'course_id': text_type(self.course.id)})
# OAuth Client
oauth_client = ApplicationFactory.create()
access_token = AccessTokenFactory.create(
user=self.staff,
application=oauth_client
).token
headers = {
'HTTP_AUTHORIZATION': 'Bearer ' + access_token
}
mock_factory = MockCompletionInfo()
with patch(
'lms.djangoapps.instructor_task.views.get_task_completion_info'
) as mock_completion_info:
mock_completion_info.side_effect = mock_factory.mock_get_task_completion_info
response = self.client.post(url, {}, **headers)
self.assertEqual(response.status_code, 200)

def test_get_problem_responses_oauth(self):
"""
Test whether get_problem_responses allows access via OAuth
"""
url = reverse('api_instructor:get_problem_responses', kwargs={'course_id': text_type(self.course.id)})
problem_location = ''

# OAuth Client
oauth_client = ApplicationFactory.create()
access_token = AccessTokenFactory.create(
user=self.staff,
application=oauth_client
).token
headers = {
'HTTP_AUTHORIZATION': 'Bearer ' + access_token
}

response = self.client.post(url, {'problem_location': problem_location}, **headers)
# Http error 400 means Bad request, but our user was authorized
self.assertEqual(response.status_code, 400)

def test_list_report_downloads_oauth(self):
"""
Test whether list_report_downloads allows access via OAuth
"""
url = reverse('api_instructor:list_report_downloads', kwargs={'course_id': text_type(self.course.id)})

# OAuth Client
oauth_client = ApplicationFactory.create()
access_token = AccessTokenFactory.create(
user=self.staff,
application=oauth_client
).token
headers = {
'HTTP_AUTHORIZATION': 'Bearer ' + access_token
}

response = self.client.post(url, {}, **headers)
self.assertEqual(response.status_code, 200)


@patch('lms.djangoapps.instructor_task.api.get_instructor_task_history', autospec=True)
class TestInstructorEmailContentList(SharedModuleStoreTestCase, LoginEnrollmentTestCase):
"""
Expand Down
33 changes: 33 additions & 0 deletions lms/djangoapps/instructor/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
"""
Instructor API endpoint new urls.
"""

from django.conf import settings
from django.conf.urls import url

import lms.djangoapps.instructor.views.api as instructor_api

app_name = 'instructor'
urlpatterns = [
url(
r'^v1/course/{}/tasks$'.format(
settings.COURSE_ID_PATTERN,
),
instructor_api.InstructorTasks.as_view(),
name='list_instructor_tasks',
),
url(
r'^v1/course/{}/reports$'.format(
settings.COURSE_ID_PATTERN,
),
instructor_api.ReportDownloadsList.as_view(),
name='list_report_downloads',
),
url(
r'^v1/course/{}/reports/problem_responses$'.format(
settings.COURSE_ID_PATTERN,
),
instructor_api.ProblemResponseReport.as_view(),
name='get_problem_responses',
),
]
Loading