Reimplemented legacy dashboard enrollment data functionality

(cherry picked from commit 9987097)
(cherry picked from commit 62cf6a4)

Author: gsidebo

lms/djangoapps/instructor/views/api.py

@@ -78,7 +78,10 @@
     unenroll_email
 )
 from lms.djangoapps.instructor.views import INVOICE_KEY
-from lms.djangoapps.instructor.views.instructor_task_helpers import extract_email_features, extract_task_features
+from lms.djangoapps.instructor.views.instructor_task_helpers import (
+    extract_email_features,
+    extract_task_features,
+)
 from lms.djangoapps.instructor_task import api as task_api
 from lms.djangoapps.instructor_task.api_helper import AlreadyRunningError, QueueConnectionError
 from lms.djangoapps.instructor_task.models import ReportStore
@@ -148,7 +151,7 @@
     parse_datetime,
     require_student_from_identifier,
     set_due_date_extension,
-    strip_if_string
+    strip_if_string,
 )
 
 log = logging.getLogger(__name__)
@@ -587,7 +590,9 @@ def create_and_enroll_user(email, username, name, country, password, course_id,
     except Exception as ex:  # pylint: disable=broad-except
         log.exception(type(ex).__name__)
         errors.append({
-            'username': username, 'email': email, 'response': type(ex).__name__,
+            'username': username,
+            'email': email,
+            'response': type(ex).__name__
         })
     else:
         try:
@@ -2408,6 +2413,7 @@ def list_instructor_tasks(request, course_id):
         - `problem_location_str` and `unique_student_identifier` lists task
             history for problem AND student (intersection)
     """
+    include_remote_gradebook = request.GET.get('include_remote_gradebook') is not None
     course_id = CourseKey.from_string(course_id)
     problem_location_str = strip_if_string(request.POST.get('problem_location_str', False))
     student = request.POST.get('unique_student_identifier', None)
@@ -2430,6 +2436,11 @@ def list_instructor_tasks(request, course_id):
         else:
             # Specifying for single problem's history
             tasks = task_api.get_instructor_task_history(course_id, module_state_key)
+    elif include_remote_gradebook:
+        tasks = lms.djangoapps.instructor_task.api.get_running_instructor_rgb_tasks(
+            course_id,
+            user=request.user
+        )
     else:
         # If no problem or student, just get currently running tasks
         tasks = task_api.get_running_instructor_tasks(course_id)

lms/djangoapps/instructor/views/instructor_dashboard.py

@@ -146,6 +146,9 @@ def instructor_dashboard_2(request, course_id):
     if access['data_researcher']:
         sections.append(_section_data_download(course, access))
 
+    if settings.FEATURES.get('ENABLE_INSTRUCTOR_REMOTE_GRADEBOOK_CONTROLS', False):
+        sections.append(_section_remote_gradebook(course))
+
     analytics_dashboard_message = None
     if show_analytics_dashboard_message(course_key) and (access['staff'] or access['instructor']):
         # Construct a URL to the external analytics dashboard
@@ -726,6 +729,57 @@ def _section_data_download(course, access):
     return section_data
 
 
+def _section_remote_gradebook(course):
+    """ Provide data for the corresponding dashboard section """
+    rg_course_setting = course.remote_gradebook or {}
+    rg_name = rg_course_setting.get('name') or settings.REMOTE_GRADEBOOK.get('DEFAULT_NAME')
+    section_data = {
+        'section_key': 'remote_gradebook',
+        'section_display_name': _('Remote Gradebook'),
+        'course': course,
+        'remote_gradebook_name': rg_name,
+        'get_remote_gradebook_sections_url': reverse(
+            'get_remote_gradebook_sections', kwargs={'course_id': unicode(course.id)}
+        ),
+        'get_assignment_names_url': reverse(
+            'get_assignment_names', kwargs={'course_id': unicode(course.id)}
+        ),
+        'get_non_staff_enrollments_url': reverse(
+            'get_non_staff_enrollments', kwargs={'course_id': unicode(course.id)}
+        ),
+        'list_remote_enrolled_students_url': reverse(
+            'list_remote_enrolled_students', kwargs={'course_id': unicode(course.id)}
+        ),
+        'list_remote_students_in_section_url': reverse(
+            'list_remote_students_in_section', kwargs={'course_id': unicode(course.id)}
+        ),
+        'add_enrollments_using_remote_gradebook_url': reverse(
+            'add_enrollments_using_remote_gradebook', kwargs={'course_id': unicode(course.id)}
+        ),
+        'list_remote_assignments_url': reverse(
+            'list_remote_assignments', kwargs={'course_id': unicode(course.id)}
+        ),
+        'display_assignment_grades_url': reverse(
+            'display_assignment_grades', kwargs={'course_id': unicode(course.id)}
+        ),
+        'export_assignment_grades_to_rg_url': reverse(
+            'export_assignment_grades_to_rg', kwargs={'course_id': unicode(course.id)}
+        ),
+        'export_assignment_grades_csv_url': reverse(
+            'export_assignment_grades_csv', kwargs={'course_id': unicode(course.id)}
+        ),
+        'list_instructor_tasks_url': '{}?include_remote_gradebook=true'.format(
+            reverse(
+                'list_instructor_tasks', kwargs={'course_id': unicode(course.id)}
+            )
+        ),
+        'list_report_downloads_url': reverse(
+            'list_report_downloads', kwargs={'course_id': unicode(course.id)}
+        ),
+    }
+    return section_data
+
+
 def null_applicable_aside_types(block):  # pylint: disable=unused-argument
     """
     get_aside method for monkey-patching into applicable_aside_types

lms/djangoapps/instructor_task/api.py

@@ -6,10 +6,11 @@
 arguments.
 
 """
-
+import datetime
 
 import hashlib
 from collections import Counter
+from pytz import UTC
 
 import six
 from celery.states import READY_STATES
@@ -42,8 +43,9 @@
     proctored_exam_results_csv,
     rescore_problem,
     reset_problem_attempts,
-    send_bulk_course_email
+    send_bulk_course_email,
 )
+from remote_gradebook.constants import RGB_TASK_TYPES
 from util import milestones_helpers
 from xmodule.modulestore.django import modulestore
 
@@ -68,6 +70,24 @@ def get_running_instructor_tasks(course_id):
     return instructor_tasks.order_by('-id')
 
 
+def get_running_instructor_rgb_tasks(course_id, user):
+    """
+    Returns a query of InstructorTask objects of running tasks for a given course
+    including remote gradebook-specific tasks.
+    """
+    instructor_tasks = get_running_instructor_tasks(course_id)
+    now = datetime.datetime.now(UTC)
+    rgb_tasks = InstructorTask.objects.filter(
+        course_id=course_id,
+        task_type__in=RGB_TASK_TYPES,
+        updated__lte=now,
+        updated__gte=now - datetime.timedelta(days=2),
+        requester=user
+    ).order_by('-updated')[0:3]
+
+    return (instructor_tasks | rgb_tasks).distinct()
+
+
 def get_instructor_task_history(course_id, usage_key=None, student=None, task_type=None):
     """
     Returns a query of InstructorTask objects of historical tasks for a given course,

lms/djangoapps/instructor_task/tasks_helper/misc.py

@@ -340,3 +340,10 @@ def upload_ora2_data(
     TASK_LOG.info(u'%s, Task type: %s, Upload complete.', task_info_string, action_name)
 
     return UPDATE_STATUS_SUCCEEDED
+
+
+def _progress_error(error_msg, task_progress):
+    task_progress.failed = 1
+    curr_step = {'step': error_msg}
+    task_progress.update_task_state(extra_meta=curr_step)
+    return UPDATE_STATUS_FAILED

lms/djangoapps/remote_gradebook/__init__.py

@@ -0,0 +1,30 @@
+"""
+Remote Gradebook Application Configuration
+"""
+
+from django.apps import AppConfig
+from openedx.core.constants import COURSE_ID_PATTERN
+from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType, PluginURLs, PluginSettings
+
+
+class RemoteGradebookConfig(AppConfig):
+    """
+    Configuration class for Remote Gradebook Django app
+    """
+    name = u'lms.djangoapps.remote_gradebook'
+
+    plugin_app = {
+        PluginURLs.CONFIG: {
+            ProjectType.LMS: {
+                PluginURLs.NAMESPACE: u'',
+                PluginURLs.REGEX: u'courses/{}/remote_gradebook/api/'.format(COURSE_ID_PATTERN),
+                PluginURLs.RELATIVE_PATH: u'urls',
+            }
+        },
+        PluginSettings.CONFIG: {
+            ProjectType.LMS: {
+                SettingsType.AWS: {PluginSettings.RELATIVE_PATH: u'settings.aws'},
+                SettingsType.COMMON: {PluginSettings.RELATIVE_PATH: u'settings.common'},
+            }
+        }
+    }

lms/djangoapps/remote_gradebook/apps.py

@@ -0,0 +1,10 @@
+"""
+Remote gradebook constants
+"""
+
+TASK_TYPE_RGB_EXPORT_GRADES = "export_grades_to_rgb"
+TASK_TYPE_RGB_EXPORT_ASSIGNMENT_GRADES = "export_assignment_grades_csv"
+RGB_TASK_TYPES = [
+    TASK_TYPE_RGB_EXPORT_GRADES,
+    TASK_TYPE_RGB_EXPORT_ASSIGNMENT_GRADES
+]

lms/djangoapps/remote_gradebook/constants.py

@@ -0,0 +1,14 @@
+"""AWS settings unique to the remote gradebook plugin."""
+
+
+def plugin_settings(settings):
+    """Settings for the remote gradebook plugin."""
+    settings.REMOTE_GRADEBOOK = settings.ENV_TOKENS.get(
+        "REMOTE_GRADEBOOK", settings.REMOTE_GRADEBOOK
+    )
+    settings.REMOTE_GRADEBOOK_USER = settings.AUTH_TOKENS.get(
+        "REMOTE_GRADEBOOK_USER", settings.REMOTE_GRADEBOOK_USER
+    )
+    settings.REMOTE_GRADEBOOK_PASSWORD = settings.AUTH_TOKENS.get(
+        "REMOTE_GRADEBOOK_PASSWORD", settings.REMOTE_GRADEBOOK_PASSWORD
+    )

lms/djangoapps/remote_gradebook/settings/__init__.py

@@ -0,0 +1,9 @@
+"""Common settings unique to the remote gradebook plugin."""
+
+
+def plugin_settings(settings):
+    """Settings for the remote gradebook plugin."""
+    settings.REMOTE_GRADEBOOK = {}
+    settings.REMOTE_GRADEBOOK_USER = None
+    settings.REMOTE_GRADEBOOK_PASSWORD = None
+    settings.FEATURES['ENABLE_INSTRUCTOR_REMOTE_GRADEBOOK_CONTROLS'] = False