Merge branch 'master' into jonahstanley/add-courseteam-tests

Conflicts:
	cms/djangoapps/contentstore/features/common.py

common/djangoapps/terrain/course_helpers.py

@@ -1,5 +1,5 @@
-#pylint: disable=C0111
-#pylint: disable=W0621
+# pylint: disable=C0111
+# pylint: disable=W0621
 
 from lettuce import world, step
 from .factories import *

common/djangoapps/track/views.py

@@ -1,13 +1,11 @@
 import json
 import logging
-import os
 import pytz
 import datetime
 import dateutil.parser
 
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse
-from django.http import Http404
 from django.shortcuts import redirect
 from django.conf import settings
 from mitxmako.shortcuts import render_to_response
@@ -22,6 +20,7 @@ LOGFIELDS = ['username', 'ip', 'event_source', 'event_type', 'event', 'agent', '
 
 
 def log_event(event):
+    """Write tracking event to log file, and optionally to TrackingLog model."""
     event_str = json.dumps(event)
     log.info(event_str[:settings.TRACK_MAX_EVENT])
     if settings.MITX_FEATURES.get('ENABLE_SQL_TRACKING_LOGS'):
@@ -34,6 +33,11 @@ def log_event(event):
 
 
 def user_track(request):
+    """
+    Log when GET call to "event" URL is made by a user.
+
+    GET call should provide "event_type", "event", and "page" arguments.
+    """
     try:  # TODO: Do the same for many of the optional META parameters
         username = request.user.username
     except:
@@ -50,7 +54,6 @@ def user_track(request):
     except:
         agent = ''
 
-    # TODO: Move a bunch of this into log_event
     event = {
         "username": username,
         "session": scookie,
@@ -68,6 +71,7 @@ def user_track(request):
 
 
 def server_track(request, event_type, event, page=None):
+    """Log events related to server requests."""
     try:
         username = request.user.username
     except:
@@ -95,9 +99,52 @@ def server_track(request, event_type, event, page=None):
     log_event(event)
 
 
+def task_track(request_info, task_info, event_type, event, page=None):
+    """
+    Logs tracking information for events occuring within celery tasks.
+
+    The `event_type` is a string naming the particular event being logged,
+    while `event` is a dict containing whatever additional contextual information
+    is desired.
+
+    The `request_info` is a dict containing information about the original
+    task request.  Relevant keys are `username`, `ip`, `agent`, and `host`.
+    While the dict is required, the values in it are not, so that {} can be
+    passed in.
+
+    In addition, a `task_info` dict provides more information about the current
+    task, to be stored with the `event` dict.  This may also be an empty dict.
+
+    The `page` parameter is optional, and allows the name of the page to
+    be provided.
+    """
+
+    # supplement event information with additional information
+    # about the task in which it is running.
+    full_event = dict(event, **task_info)
+
+    # All fields must be specified, in case the tracking information is
+    # also saved to the TrackingLog model.  Get values from the task-level
+    # information, or just add placeholder values.
+    event = {
+        "username": request_info.get('username', 'unknown'),
+        "ip": request_info.get('ip', 'unknown'),
+        "event_source": "task",
+        "event_type": event_type,
+        "event": full_event,
+        "agent": request_info.get('agent', 'unknown'),
+        "page": page,
+        "time": datetime.datetime.utcnow().isoformat(),
+        "host": request_info.get('host', 'unknown')
+        }
+
+    log_event(event)
+
+
 @login_required
 @ensure_csrf_cookie
 def view_tracking_log(request, args=''):
+    """View to output contents of TrackingLog model.  For staff use only."""
     if not request.user.is_staff:
         return redirect('/')
     nlen = 100

common/djangoapps/xmodule_modifiers.py

@@ -1,4 +1,3 @@
-import re
 import json
 import logging
 import static_replace