From 91c31e12d58c120738e5019ca3195dd6d3d50c12 Mon Sep 17 00:00:00 2001 From: Julia Hansbrough Date: Thu, 3 Oct 2013 17:27:21 +0000 Subject: [PATCH 01/35] Implemented bulk email interface for new dashboard --- lms/djangoapps/instructor/views/api.py | 46 +++++++++++- lms/djangoapps/instructor/views/api_urls.py | 3 +- .../instructor/views/instructor_dashboard.py | 20 ++++- lms/djangoapps/instructor/views/legacy.py | 1 - lms/envs/common.py | 2 +- .../instructor_dashboard.coffee | 3 + .../instructor_dashboard/send_email.coffee | 73 +++++++++++++++++++ .../sass/course/instructor/_instructor_2.scss | 4 + .../instructor_dashboard_2/email.html | 65 +++++++++++++++++ .../instructor_dashboard_2.html | 6 ++ .../instructor_dashboard_2/send_email.html | 35 +++++++++ 11 files changed, 252 insertions(+), 6 deletions(-) create mode 100644 lms/static/coffee/src/instructor_dashboard/send_email.coffee create mode 100644 lms/templates/instructor/instructor_dashboard_2/email.html create mode 100644 lms/templates/instructor/instructor_dashboard_2/send_email.html diff --git a/lms/djangoapps/instructor/views/api.py b/lms/djangoapps/instructor/views/api.py index e0b047604e..96f0225b4c 100644 --- a/lms/djangoapps/instructor/views/api.py +++ b/lms/djangoapps/instructor/views/api.py @@ -40,6 +40,12 @@ import analytics.distributions import analytics.csvs import csv +from bulk_email.models import CourseEmail +from html_to_text import html_to_text +from bulk_email import tasks + +from pudb import set_trace + log = logging.getLogger(__name__) @@ -705,6 +711,45 @@ def list_forum_members(request, course_id): } return JsonResponse(response_payload) +@cache_control(no_cache=True, no_store=True, must_revalidate=True) +# todo check if staff is the desired access level +# todo do html and plaintext messages +@require_level('staff') +@require_query_params(send_to="sending to whom", subject="subject line", message="message text") +def send_email(request, course_id): + """ + Send an email to self, staff, or everyone involved in a course. + Query Paramaters: + - 'send_to' specifies what group the email should be sent to + - 'subject' specifies email's subject + - 'message' specifies email's content + """ + set_trace() + course = get_course_by_id(course_id) + has_instructor_access = has_access(request.user, course, 'instructor') + send_to = request.GET.get("send_to") + subject = request.GET.get("subject") + message = request.GET.get("message") + text_message = html_to_text(message) + if subject == "": + return HttpResponseBadRequest("Operation requires instructor access.") + email = CourseEmail( + course_id = course_id, + sender=request.user, + to_option=send_to, + subject=subject, + html_message=message, + text_message=text_message + ) + email.save() + tasks.delegate_email_batches.delay( + email.id, + request.user.id + ) + response_payload = { + 'course_id': course_id, + } + return JsonResponse(response_payload) @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) @@ -769,7 +814,6 @@ def update_forum_role_membership(request, course_id): } return JsonResponse(response_payload) - @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) @require_level('staff') diff --git a/lms/djangoapps/instructor/views/api_urls.py b/lms/djangoapps/instructor/views/api_urls.py index 07af69558f..79cdcf7e69 100644 --- a/lms/djangoapps/instructor/views/api_urls.py +++ b/lms/djangoapps/instructor/views/api_urls.py @@ -2,7 +2,6 @@ Instructor API endpoint urls. """ - from django.conf.urls import patterns, url urlpatterns = patterns('', # nopep8 @@ -34,4 +33,6 @@ urlpatterns = patterns('', # nopep8 'instructor.views.api.update_forum_role_membership', name="update_forum_role_membership"), url(r'^proxy_legacy_analytics$', 'instructor.views.api.proxy_legacy_analytics', name="proxy_legacy_analytics"), + url(r'^send_email$', + 'instructor.views.api.send_email', name="send_email") ) diff --git a/lms/djangoapps/instructor/views/instructor_dashboard.py b/lms/djangoapps/instructor/views/instructor_dashboard.py index e248d47a59..b0d93b96ba 100644 --- a/lms/djangoapps/instructor/views/instructor_dashboard.py +++ b/lms/djangoapps/instructor/views/instructor_dashboard.py @@ -10,6 +10,10 @@ from django.core.urlresolvers import reverse from django.utils.html import escape from django.http import Http404 +from xmodule_modifiers import wrap_xmodule +from xmodule.html_module import HtmlDescriptor +from xblock.field_data import DictFieldData +from xblock.fields import ScopeIds from courseware.access import has_access from courseware.courses import get_course_by_id from django_comment_client.utils import has_forum_access @@ -17,7 +21,6 @@ from django_comment_common.models import FORUM_ROLE_ADMINISTRATOR from xmodule.modulestore.django import modulestore from student.models import CourseEnrollment - @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) def instructor_dashboard_2(request, course_id): @@ -42,7 +45,8 @@ def instructor_dashboard_2(request, course_id): _section_membership(course_id, access), _section_student_admin(course_id, access), _section_data_download(course_id), - _section_analytics(course_id), + _section_send_email(course_id, access,course), + _section_analytics(course_id) ] context = { @@ -140,6 +144,18 @@ def _section_data_download(course_id): } return section_data +def _section_send_email(course_id, access,course): + """ Provide data for the corresponding bulk email section """ + html_module = HtmlDescriptor(course.system, DictFieldData({'data': ''}), ScopeIds(None, None, None, None)) + section_data = { + 'section_key': 'send_email', + 'section_display_name': _('Email'), + 'access': access, + 'send_email': reverse('send_email',kwargs={'course_id': course_id}), + 'editor': wrap_xmodule(html_module.get_html, html_module, 'xmodule_edit.html')() + } + return section_data + def _section_analytics(course_id): """ Provide data for the corresponding dashboard section """ diff --git a/lms/djangoapps/instructor/views/legacy.py b/lms/djangoapps/instructor/views/legacy.py index c7e32a52ae..3d22c8b650 100644 --- a/lms/djangoapps/instructor/views/legacy.py +++ b/lms/djangoapps/instructor/views/legacy.py @@ -62,7 +62,6 @@ from bulk_email.models import CourseEmail from html_to_text import html_to_text from bulk_email import tasks - log = logging.getLogger(__name__) # internal commands for managing forum roles: diff --git a/lms/envs/common.py b/lms/envs/common.py index 96b304294d..25f414eb0c 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -114,7 +114,7 @@ MITX_FEATURES = { # analytics experiments 'ENABLE_INSTRUCTOR_ANALYTICS': False, - 'ENABLE_INSTRUCTOR_EMAIL': False, + 'ENABLE_INSTRUCTOR_EMAIL': True, # enable analytics server. # WARNING: THIS SHOULD ALWAYS BE SET TO FALSE UNDER NORMAL diff --git a/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee b/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee index a7c803f8ac..edbbe6a017 100644 --- a/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee +++ b/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee @@ -156,6 +156,9 @@ setup_instructor_dashboard_sections = (idash_content) -> , constructor: window.InstructorDashboard.sections.StudentAdmin $element: idash_content.find ".#{CSS_IDASH_SECTION}#student_admin" + , + constructor: window.InstructorDashboard.sections.Email + $element: idash_content.find ".#{CSS_IDASH_SECTION}#send_email" , constructor: window.InstructorDashboard.sections.Analytics $element: idash_content.find ".#{CSS_IDASH_SECTION}#analytics" diff --git a/lms/static/coffee/src/instructor_dashboard/send_email.coffee b/lms/static/coffee/src/instructor_dashboard/send_email.coffee new file mode 100644 index 0000000000..4746f1ffed --- /dev/null +++ b/lms/static/coffee/src/instructor_dashboard/send_email.coffee @@ -0,0 +1,73 @@ +# Email Section + +# imports from other modules. +# wrap in (-> ... apply) to defer evaluation +# such that the value can be defined later than this assignment (file load order). +plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments +std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments + +class SendEmail + constructor: (@$container) -> + # gather elements + @$emailEditor = XModule.loadModule($('.xmodule_edit')); + @$send_to = @$container.find("select[name='send_to']'") + @$subject = @$container.find("input[name='subject']'") + #message = emailEditor.save()['data'] + @$btn_send = @$container.find("input[name='send']'") + @$task_response = @$container.find(".request-response") + @$request_response_error = @$container.find(".request-response-error") + + # attach click handlers + + @$btn_send.click => + + send_data = + action: 'send' + send_to: @$send_to.val() + subject: @$subject.val() + message: @$emailEditor.save()['data'] + #message: @$message.val() + + $.ajax + dataType: 'json' + url: @$btn_send.data 'endpoint' + data: send_data + success: (data) => @display_response "Your email was successfully queued for sending." + error: std_ajax_err => @fail_with_error "Error sending email." + + fail_with_error: (msg) -> + console.warn msg + @$task_response.empty() + @$request_response_error.empty() + @$request_response_error.text msg + + display_response: (data_from_server) -> + @$task_response.empty() + @$request_response_error.empty() + @$task_response.text("Your email was successfully queued for sending.") + + +# Email Section +class Email + # enable subsections. + constructor: (@$section) -> + # attach self to html + # so that instructor_dashboard.coffee can find this object + # to call event handlers like 'onClickTitle' + @$section.data 'wrapper', @ + + # isolate # initialize SendEmail subsection + plantTimeout 0, => new SendEmail @$section.find '.send-email' + + # handler for when the section title is clicked. + onClickTitle: -> + + +# export for use +# create parent namespaces if they do not already exist. +# abort if underscore can not be found. +if _? + _.defaults window, InstructorDashboard: {} + _.defaults window.InstructorDashboard, sections: {} + _.defaults window.InstructorDashboard.sections, + Email: Email diff --git a/lms/static/sass/course/instructor/_instructor_2.scss b/lms/static/sass/course/instructor/_instructor_2.scss index 61dab3ef1c..ba9c513b6b 100644 --- a/lms/static/sass/course/instructor/_instructor_2.scss +++ b/lms/static/sass/course/instructor/_instructor_2.scss @@ -110,6 +110,10 @@ section.instructor-dashboard-content-2 { } } +.instructor-dashboard-wrapper-2 section.idash-section#email { + // todo +} + .instructor-dashboard-wrapper-2 section.idash-section#course_info { .course-errors-wrapper { diff --git a/lms/templates/instructor/instructor_dashboard_2/email.html b/lms/templates/instructor/instructor_dashboard_2/email.html new file mode 100644 index 0000000000..9eaefea8ad --- /dev/null +++ b/lms/templates/instructor/instructor_dashboard_2/email.html @@ -0,0 +1,65 @@ +<%! from django.utils.translation import ugettext as _ %> +<%page args="section_data"/> + +

Email

+ +
+ + +
+ ${_("Please try not to email students more than once a day. Important things to consider before sending:")} +
    +
  • ${_("Have you read over the email to make sure it says everything you want to say?")}
    • +
  • ${_("Have you sent the email to yourself first to make sure you're happy with how it's displayed?")}
    • +
+ +
+ +
\ No newline at end of file diff --git a/lms/templates/instructor/instructor_dashboard_2/instructor_dashboard_2.html b/lms/templates/instructor/instructor_dashboard_2/instructor_dashboard_2.html index c209db0103..527143b65b 100644 --- a/lms/templates/instructor/instructor_dashboard_2/instructor_dashboard_2.html +++ b/lms/templates/instructor/instructor_dashboard_2/instructor_dashboard_2.html @@ -31,6 +31,12 @@ + + + + + + <%static:js group='module-descriptor-js'/> ## NOTE that instructor is set as the active page so that the instructor button lights up, even though this is the instructor_2 page. diff --git a/lms/templates/instructor/instructor_dashboard_2/send_email.html b/lms/templates/instructor/instructor_dashboard_2/send_email.html new file mode 100644 index 0000000000..4b5681f251 --- /dev/null +++ b/lms/templates/instructor/instructor_dashboard_2/send_email.html @@ -0,0 +1,35 @@ +<%! from django.utils.translation import ugettext as _ %> +<%page args="section_data"/> + + +
+

${_("Send Email")}

+ + +
+ + +
+ + + +
+ +
+
+
\ No newline at end of file From d69748ce7f8bb42bb266259a1a553c52f899d998 Mon Sep 17 00:00:00 2001 From: Adam Palay Date: Tue, 24 Sep 2013 17:21:27 -0400 Subject: [PATCH 02/35] disable buttons for large courses on legacy and beta instr dash set max enrollment for downloads to 200 --- .../courseware/instructor_dashboard.html | 27 +++++++++++++++---- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/lms/templates/courseware/instructor_dashboard.html b/lms/templates/courseware/instructor_dashboard.html index 7b06d8e309..414014c240 100644 --- a/lms/templates/courseware/instructor_dashboard.html +++ b/lms/templates/courseware/instructor_dashboard.html @@ -173,8 +173,8 @@ function goto( mode)

- - + +

@@ -369,9 +369,26 @@ function goto( mode) %if modeflag.get('Enrollment'):
-

- - +

${_("Enrollment Data")}

+ % if disable_buttons: + +
+
+

+ ${_("Note: some of these buttons are known to time out for larger " + "courses. We have temporarily disabled those features for courses " + "with more than {max_enrollment} students. We are urgently working on " + "fixing this issue. Thank you for your patience as we continue " + "working to improve the platform!").format( + max_enrollment=settings.MITX_FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] + )} +

+
+
+ % endif + + +
%if settings.MITX_FEATURES.get('REMOTE_GRADEBOOK_URL','') and instructor_access: From 867d3ba1da728f260d14e4e188ad25e3c8706723 Mon Sep 17 00:00:00 2001 From: Julia Hansbrough Date: Thu, 3 Oct 2013 17:27:21 +0000 Subject: [PATCH 03/35] Implemented bulk email interface for new dashboard Responses to Adam's comments; reset common.py, i18n compliance, deleted extraneous email.html file, fixed an HttpResponse, deleted unnecessary commented-out code, some small style tweaks --- lms/djangoapps/instructor/tests/test_api.py | 92 +++++++++++++++++-- .../{test_legacy_email.py => test_email.py} | 11 +++ lms/djangoapps/instructor/views/api.py | 44 +++++++-- .../instructor/views/instructor_dashboard.py | 21 ++++- .../src/instructor_dashboard/analytics.coffee | 11 ++- .../instructor_dashboard/course_info.coffee | 15 +-- .../instructor_dashboard/data_download.coffee | 11 ++- .../instructor_dashboard.coffee | 49 +++++----- .../instructor_dashboard/membership.coffee | 11 ++- .../instructor_dashboard/send_email.coffee | 21 +++-- .../instructor_dashboard/student_admin.coffee | 11 ++- .../sass/course/instructor/_instructor_2.scss | 74 ++++++++++++++- .../instructor_dashboard_2/email.html | 4 +- .../instructor_dashboard_2/send_email.html | 8 ++ 14 files changed, 302 insertions(+), 81 deletions(-) rename lms/djangoapps/instructor/tests/{test_legacy_email.py => test_email.py} (93%) diff --git a/lms/djangoapps/instructor/tests/test_api.py b/lms/djangoapps/instructor/tests/test_api.py index a32217ab30..6e86c40a2e 100644 --- a/lms/djangoapps/instructor/tests/test_api.py +++ b/lms/djangoapps/instructor/tests/test_api.py @@ -6,9 +6,7 @@ import unittest import json import requests from urllib import quote -from django.conf import settings from django.test import TestCase -from nose.tools import raises from mock import Mock, patch from django.test.utils import override_settings from django.core.urlresolvers import reverse @@ -125,6 +123,7 @@ class TestInstructorAPIDenyLevels(ModuleStoreTestCase, LoginEnrollmentTestCase): 'list_forum_members', 'update_forum_role_membership', 'proxy_legacy_analytics', + 'send_email', ] for endpoint in staff_level_endpoints: url = reverse(endpoint, kwargs={'course_id': self.course.id}) @@ -280,8 +279,8 @@ class TestInstructorAPILevelsAccess(ModuleStoreTestCase, LoginEnrollmentTestCase This test does NOT test whether the actions had an effect on the database, that is the job of test_access. This tests the response and action switch. - Actually, modify_access does not having a very meaningful - response yet, so only the status code is tested. + Actually, modify_access does not have a very meaningful + response yet, so only the status code is tested. """ def setUp(self): self.instructor = AdminFactory.create() @@ -691,7 +690,81 @@ class TestInstructorAPIRegradeTask(ModuleStoreTestCase, LoginEnrollmentTestCase) }) print response.content self.assertEqual(response.status_code, 200) - self.assertTrue(act.called) + + +@override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) +class TestInstructorSendEmail(ModuleStoreTestCase, LoginEnrollmentTestCase): + """ + fill this out + """ + def setUp(self): + self.instructor = AdminFactory.create() + self.course = CourseFactory.create() + self.client.login(username=self.instructor.username, password='test') + + def test_send_email_as_logged_in_instructor(self): + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url,{ + 'send_to': 'staff', + 'subject': 'test subject', + 'message': 'test message', + }) + self.assertEqual(response.status_code, 200) + + def test_send_email_but_not_logged_in(self): + self.client.logout() + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url, { + 'send_to': 'staff', + 'subject': 'test subject', + 'message': 'test message', + }) + self.assertEqual(response.status_code, 403) + + def test_send_email_but_not_staff(self): + self.client.logout() + self.student = UserFactory() + self.client.login(username=self.student.username, password='test') + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url, { + 'send_to': 'staff', + 'subject': 'test subject', + 'message': 'test message', + }) + self.assertEqual(response.status_code, 403) + + def test_send_email_but_course_not_exist(self): + url = reverse('send_email', kwargs={'course_id': 'GarbageCourse/DNE/NoTerm'}) + response = self.client.get(url, { + 'send_to': 'staff', + 'subject': 'test subject', + 'message': 'test message', + }) + self.assertNotEqual(response.status_code, 200) + + def test_send_email_no_sendto(self): + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url, { + 'subject': 'test subject', + 'message': 'test message', + }) + self.assertEqual(response.status_code, 400) + + def test_send_email_no_subject(self): + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url, { + 'send_to': 'staff', + 'message': 'test message', + }) + self.assertEqual(response.status_code, 400) + + def test_send_email_no_message(self): + url = reverse('send_email', kwargs={'course_id': self.course.id}) + response = self.client.get(url, { + 'send_to': 'staff', + 'subject': 'test subject', + }) + self.assertEqual(response.status_code, 400) @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) @@ -896,7 +969,8 @@ class TestInstructorAPIHelpers(TestCase): output = 'i4x://MITx/6.002x/problem/L2Node1' self.assertEqual(_msk_from_problem_urlname(*args), output) - @raises(ValueError) - def test_msk_from_problem_urlname_error(self): - args = ('notagoodcourse', 'L2Node1') - _msk_from_problem_urlname(*args) + # TODO add this back in as soon as i know where the heck "raises" comes from + #@raises(ValueError) + #def test_msk_from_problem_urlname_error(self): + # args = ('notagoodcourse', 'L2Node1') + # _msk_from_problem_urlname(*args) diff --git a/lms/djangoapps/instructor/tests/test_legacy_email.py b/lms/djangoapps/instructor/tests/test_email.py similarity index 93% rename from lms/djangoapps/instructor/tests/test_legacy_email.py rename to lms/djangoapps/instructor/tests/test_email.py index d8761466b0..5f664bc0e5 100644 --- a/lms/djangoapps/instructor/tests/test_legacy_email.py +++ b/lms/djangoapps/instructor/tests/test_email.py @@ -17,6 +17,16 @@ from xmodule.modulestore import XML_MODULESTORE_TYPE from mock import patch +@override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) +class TestNewInstructorDashboardEmailView(ModuleStoreTestCase): + """ + Check for email view displayed with flag + """ + # will need to check for Mongo vs XML, ENABLED vs not enabled, + # is studio course vs not studio course + # section_data + # what is html_module? + # which are API lines @override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) class TestInstructorDashboardEmailView(ModuleStoreTestCase): @@ -43,6 +53,7 @@ class TestInstructorDashboardEmailView(ModuleStoreTestCase): @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True}) def test_email_flag_true(self): + from nose.tools import set_trace; set_trace() # Assert that the URL for the email view is in the response response = self.client.get(self.url) self.assertTrue(self.email_link in response.content) diff --git a/lms/djangoapps/instructor/views/api.py b/lms/djangoapps/instructor/views/api.py index 96f0225b4c..25e070d01a 100644 --- a/lms/djangoapps/instructor/views/api.py +++ b/lms/djangoapps/instructor/views/api.py @@ -9,7 +9,6 @@ Many of these GETs may become PUTs in the future. import re import logging import requests -from collections import OrderedDict from django.conf import settings from django_future.csrf import ensure_csrf_cookie from django.views.decorators.cache import cache_control @@ -44,10 +43,6 @@ from bulk_email.models import CourseEmail from html_to_text import html_to_text from bulk_email import tasks -from pudb import set_trace - -log = logging.getLogger(__name__) - def common_exceptions_400(func): """ @@ -403,7 +398,7 @@ def get_anon_ids(request, course_id): # pylint: disable=W0613 students = User.objects.filter( courseenrollment__course_id=course_id, ).order_by('id') - header =['User ID', 'Anonymized user ID'] + header = ['User ID', 'Anonymized user ID'] rows = [[s.id, unique_id_for_user(s)] for s in students] return csv_response(course_id.replace('/', '-') + '-anon-ids.csv', header, rows) @@ -751,6 +746,42 @@ def send_email(request, course_id): } return JsonResponse(response_payload) +@ensure_csrf_cookie +@cache_control(no_cache=True, no_store=True, must_revalidate=True) +@require_level('staff') +@require_query_params(send_to="sending to whom", subject="subject line", message="message text") +def send_email(request, course_id): + """ + Send an email to self, staff, or everyone involved in a course. + Query Paramaters: + - 'send_to' specifies what group the email should be sent to + - 'subject' specifies email's subject + - 'message' specifies email's content + """ + course = get_course_by_id(course_id) + send_to = request.GET.get("send_to") + subject = request.GET.get("subject") + message = request.GET.get("message") + text_message = html_to_text(message) + email = CourseEmail( + course_id=course_id, + sender=request.user, + to_option=send_to, + subject=subject, + html_message=message, + text_message=text_message + ) + email.save() + tasks.delegate_email_batches.delay( + email.id, + request.user.id + ) + response_payload = { + 'course_id': course_id, + } + return JsonResponse(response_payload) + + @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) @require_level('staff') @@ -814,6 +845,7 @@ def update_forum_role_membership(request, course_id): } return JsonResponse(response_payload) + @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) @require_level('staff') diff --git a/lms/djangoapps/instructor/views/instructor_dashboard.py b/lms/djangoapps/instructor/views/instructor_dashboard.py index b0d93b96ba..daf78b6162 100644 --- a/lms/djangoapps/instructor/views/instructor_dashboard.py +++ b/lms/djangoapps/instructor/views/instructor_dashboard.py @@ -12,13 +12,14 @@ from django.http import Http404 from xmodule_modifiers import wrap_xmodule from xmodule.html_module import HtmlDescriptor +from xmodule.modulestore import MONGO_MODULESTORE_TYPE +from xmodule.modulestore.django import modulestore from xblock.field_data import DictFieldData from xblock.fields import ScopeIds from courseware.access import has_access from courseware.courses import get_course_by_id from django_comment_client.utils import has_forum_access from django_comment_common.models import FORUM_ROLE_ADMINISTRATOR -from xmodule.modulestore.django import modulestore from student.models import CourseEnrollment @ensure_csrf_cookie @@ -27,6 +28,7 @@ def instructor_dashboard_2(request, course_id): """ Display the instructor dashboard for a course. """ course = get_course_by_id(course_id, depth=None) + is_studio_course = (modulestore().get_modulestore_type(course_id) == MONGO_MODULESTORE_TYPE) access = { 'admin': request.user.is_staff, @@ -45,14 +47,24 @@ def instructor_dashboard_2(request, course_id): _section_membership(course_id, access), _section_student_admin(course_id, access), _section_data_download(course_id), - _section_send_email(course_id, access,course), _section_analytics(course_id) ] + enrollment_count = sections[0]['enrollment_count'] + + disable_buttons = False + max_enrollment_for_buttons = settings.MITX_FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS") + if max_enrollment_for_buttons is not None: + disable_buttons = enrollment_count > max_enrollment_for_buttons + + if settings.MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and is_studio_course: + sections.append(_section_send_email(course_id, access, course)) + context = { 'course': course, 'old_dashboard_url': reverse('instructor_dashboard', kwargs={'course_id': course_id}), 'sections': sections, + 'disable_buttons': disable_buttons, } return render_to_response('instructor/instructor_dashboard_2/instructor_dashboard_2.html', context) @@ -144,13 +156,14 @@ def _section_data_download(course_id): } return section_data -def _section_send_email(course_id, access,course): + +def _section_send_email(course_id, access, course): """ Provide data for the corresponding bulk email section """ html_module = HtmlDescriptor(course.system, DictFieldData({'data': ''}), ScopeIds(None, None, None, None)) section_data = { 'section_key': 'send_email', 'section_display_name': _('Email'), - 'access': access, + 'access': access, 'send_email': reverse('send_email',kwargs={'course_id': course_id}), 'editor': wrap_xmodule(html_module.get_html, html_module, 'xmodule_edit.html')() } diff --git a/lms/static/coffee/src/instructor_dashboard/analytics.coffee b/lms/static/coffee/src/instructor_dashboard/analytics.coffee index d53b511e1c..018b7e9c57 100644 --- a/lms/static/coffee/src/instructor_dashboard/analytics.coffee +++ b/lms/static/coffee/src/instructor_dashboard/analytics.coffee @@ -1,8 +1,11 @@ -# Analytics Section +### +Analytics Section + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/coffee/src/instructor_dashboard/course_info.coffee b/lms/static/coffee/src/instructor_dashboard/course_info.coffee index d48c7ba873..19f9ce9707 100644 --- a/lms/static/coffee/src/instructor_dashboard/course_info.coffee +++ b/lms/static/coffee/src/instructor_dashboard/course_info.coffee @@ -1,10 +1,13 @@ -# Course Info Section -# This is the implementation of the simplest section -# of the instructor dashboard. +### +Course Info Section +This is the implementation of the simplest section +of the instructor dashboard. + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/coffee/src/instructor_dashboard/data_download.coffee b/lms/static/coffee/src/instructor_dashboard/data_download.coffee index ee9be4254d..b5bbde9182 100644 --- a/lms/static/coffee/src/instructor_dashboard/data_download.coffee +++ b/lms/static/coffee/src/instructor_dashboard/data_download.coffee @@ -1,8 +1,11 @@ -# Data Download Section +### +Data Download Section + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee b/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee index edbbe6a017..c645fcf67e 100644 --- a/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee +++ b/lms/static/coffee/src/instructor_dashboard/instructor_dashboard.coffee @@ -1,26 +1,31 @@ -# Instructor Dashboard Tab Manager -# The instructor dashboard is broken into sections. -# Only one section is visible at a time, -# and is responsible for its own functionality. -# -# NOTE: plantTimeout (which is just setTimeout from util.coffee) -# is used frequently in the instructor dashboard to isolate -# failures. If one piece of code under a plantTimeout fails -# then it will not crash the rest of the dashboard. -# -# NOTE: The instructor dashboard currently does not -# use backbone. Just lots of jquery. This should be fixed. -# -# NOTE: Server endpoints in the dashboard are stored in -# the 'data-endpoint' attribute of relevant html elements. -# The urls are rendered there by a template. -# -# NOTE: For an example of what a section object should look like -# see course_info.coffee +### +Instructor Dashboard Tab Manager + +The instructor dashboard is broken into sections. + +Only one section is visible at a time, + and is responsible for its own functionality. + +NOTE: plantTimeout (which is just setTimeout from util.coffee) + is used frequently in the instructor dashboard to isolate + failures. If one piece of code under a plantTimeout fails + then it will not crash the rest of the dashboard. + +NOTE: The instructor dashboard currently does not + use backbone. Just lots of jquery. This should be fixed. + +NOTE: Server endpoints in the dashboard are stored in + the 'data-endpoint' attribute of relevant html elements. + The urls are rendered there by a template. + +NOTE: For an example of what a section object should look like + see course_info.coffee + +imports from other modules +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/coffee/src/instructor_dashboard/membership.coffee b/lms/static/coffee/src/instructor_dashboard/membership.coffee index a50cd2c3dd..54b04be5db 100644 --- a/lms/static/coffee/src/instructor_dashboard/membership.coffee +++ b/lms/static/coffee/src/instructor_dashboard/membership.coffee @@ -1,8 +1,11 @@ -# Membership Section +### +Membership Section + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/coffee/src/instructor_dashboard/send_email.coffee b/lms/static/coffee/src/instructor_dashboard/send_email.coffee index 4746f1ffed..af509a7d52 100644 --- a/lms/static/coffee/src/instructor_dashboard/send_email.coffee +++ b/lms/static/coffee/src/instructor_dashboard/send_email.coffee @@ -1,8 +1,11 @@ -# Email Section +### +Email Section + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments @@ -12,7 +15,6 @@ class SendEmail @$emailEditor = XModule.loadModule($('.xmodule_edit')); @$send_to = @$container.find("select[name='send_to']'") @$subject = @$container.find("input[name='subject']'") - #message = emailEditor.save()['data'] @$btn_send = @$container.find("input[name='send']'") @$task_response = @$container.find(".request-response") @$request_response_error = @$container.find(".request-response-error") @@ -26,25 +28,24 @@ class SendEmail send_to: @$send_to.val() subject: @$subject.val() message: @$emailEditor.save()['data'] - #message: @$message.val() $.ajax dataType: 'json' url: @$btn_send.data 'endpoint' data: send_data - success: (data) => @display_response "Your email was successfully queued for sending." - error: std_ajax_err => @fail_with_error "Error sending email." + success: (data) => @display_response gettext('Your email was successfully queued for sending.') + error: std_ajax_err => @fail_with_error gettext('Error sending email.') fail_with_error: (msg) -> console.warn msg @$task_response.empty() @$request_response_error.empty() - @$request_response_error.text msg + @$request_response_error.text gettext(msg) display_response: (data_from_server) -> @$task_response.empty() @$request_response_error.empty() - @$task_response.text("Your email was successfully queued for sending.") + @$task_response.text(gettext('Your email was successfully queued for sending.')) # Email Section diff --git a/lms/static/coffee/src/instructor_dashboard/student_admin.coffee b/lms/static/coffee/src/instructor_dashboard/student_admin.coffee index 3e5c8c27c2..00ca4d2d45 100644 --- a/lms/static/coffee/src/instructor_dashboard/student_admin.coffee +++ b/lms/static/coffee/src/instructor_dashboard/student_admin.coffee @@ -1,8 +1,11 @@ -# Student Admin Section +### +Student Admin Section + +imports from other modules. +wrap in (-> ... apply) to defer evaluation +such that the value can be defined later than this assignment (file load order). +### -# imports from other modules. -# wrap in (-> ... apply) to defer evaluation -# such that the value can be defined later than this assignment (file load order). plantTimeout = -> window.InstructorDashboard.util.plantTimeout.apply this, arguments plantInterval = -> window.InstructorDashboard.util.plantInterval.apply this, arguments std_ajax_err = -> window.InstructorDashboard.util.std_ajax_err.apply this, arguments diff --git a/lms/static/sass/course/instructor/_instructor_2.scss b/lms/static/sass/course/instructor/_instructor_2.scss index ba9c513b6b..19f6abf5ed 100644 --- a/lms/static/sass/course/instructor/_instructor_2.scss +++ b/lms/static/sass/course/instructor/_instructor_2.scss @@ -18,6 +18,75 @@ right: 15px; font-size: 11pt; } + + // system feedback - messages + .msg { + border-radius: 1px; + padding: 10px 15px; + margin-bottom: 20px; + + .copy { + font-weight: 600; + } + } + + // TYPE: warning + .msg-warning { + border-top: 2px solid $warning-color; + background: tint($warning-color,95%); + + .copy { + color: $warning-color; + } + } + + // TYPE: confirm + .msg-confirm { + border-top: 2px solid $confirm-color; + background: tint($confirm-color,95%); + + .copy { + color: $confirm-color; + } + } + + // TYPE: confirm + .msg-error { + border-top: 2px solid $error-color; + background: tint($error-color,95%); + + .copy { + color: $error-color; + } + } + + // inline copy + .copy-confirm { + color: $confirm-color; + } + + .copy-warning { + color: $warning-color; + } + + .copy-error { + color: $error-color; + } + + .list-advice { + list-style: none; + padding: 0; + margin: 20px 0; + + .item { + font-weight: 600; + margin-bottom: 10px; + + &:last-child { + margin-bottom: 0; + } + } + } } section.instructor-dashboard-content-2 { @@ -110,11 +179,6 @@ section.instructor-dashboard-content-2 { } } -.instructor-dashboard-wrapper-2 section.idash-section#email { - // todo -} - - .instructor-dashboard-wrapper-2 section.idash-section#course_info { .course-errors-wrapper { margin-top: 2em; diff --git a/lms/templates/instructor/instructor_dashboard_2/email.html b/lms/templates/instructor/instructor_dashboard_2/email.html index 9eaefea8ad..3ede65e7fb 100644 --- a/lms/templates/instructor/instructor_dashboard_2/email.html +++ b/lms/templates/instructor/instructor_dashboard_2/email.html @@ -34,8 +34,6 @@ - \ No newline at end of file + diff --git a/lms/templates/instructor/instructor_dashboard_2/send_email.html b/lms/templates/instructor/instructor_dashboard_2/send_email.html index 4b5681f251..68fd0938a1 100644 --- a/lms/templates/instructor/instructor_dashboard_2/send_email.html +++ b/lms/templates/instructor/instructor_dashboard_2/send_email.html @@ -3,6 +3,7 @@ +

${_("Send Email")}

@@ -29,6 +30,13 @@

+
+ ${_("Please try not to email students more than once a day. Before sending your email, consider:")} +
    +
  • ${_("Have you read over the email to make sure it says everything you want to say?")}
    • +
  • ${_("Have you sent the email to yourself first to make sure you're happy with how it's displayed?")}
    • +
+
From d8a857dba2b56e41e396930b1c5300348b88aa5b Mon Sep 17 00:00:00 2001 From: Julia Hansbrough Date: Fri, 4 Oct 2013 15:33:11 +0000 Subject: [PATCH 04/35] Changed GET to POST and xmodule HTML editor call, section CSS --- AUTHORS | 1 + CHANGELOG.rst | 6 +- lms/djangoapps/instructor/tests/test_email.py | 1 - lms/djangoapps/instructor/views/api.py | 47 +++++++++++++-- .../instructor/views/instructor_dashboard.py | 5 +- lms/envs/dev.py | 1 + .../instructor_dashboard/send_email.coffee | 5 +- .../sass/course/instructor/_instructor_2.scss | 58 +++++++++++++++++++ .../instructor_dashboard_2/send_email.html | 56 ++++++++++-------- 9 files changed, 145 insertions(+), 35 deletions(-) diff --git a/AUTHORS b/AUTHORS index 94963e4630..2f4d7efead 100644 --- a/AUTHORS +++ b/AUTHORS @@ -89,3 +89,4 @@ Akshay Jagadeesh Nick Parlante Marko Seric Felipe Montoya +Julia Hansbrough diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 23814b0454..1630f53ace 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,10 +5,12 @@ These are notable changes in edx-platform. This is a rolling list of changes, in roughly chronological order, most recent first. Add your entries at or near the top. Include a label indicating the component affected. - LMS: Fix issue with CourseMode expiration dates -LMS: Add PaidCourseRegistration mode, where payment is required before course registration. +LMS: Ported bulk emailing to the beta instructor dashboard. + +LMS: Add PaidCourseRegistration mode, where payment is required before course +registration. LMS: Add split testing functionality for internal use. diff --git a/lms/djangoapps/instructor/tests/test_email.py b/lms/djangoapps/instructor/tests/test_email.py index 5f664bc0e5..1150c575fe 100644 --- a/lms/djangoapps/instructor/tests/test_email.py +++ b/lms/djangoapps/instructor/tests/test_email.py @@ -53,7 +53,6 @@ class TestInstructorDashboardEmailView(ModuleStoreTestCase): @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True}) def test_email_flag_true(self): - from nose.tools import set_trace; set_trace() # Assert that the URL for the email view is in the response response = self.client.get(self.url) self.assertTrue(self.email_link in response.content) diff --git a/lms/djangoapps/instructor/views/api.py b/lms/djangoapps/instructor/views/api.py index 25e070d01a..e7f394cea1 100644 --- a/lms/djangoapps/instructor/views/api.py +++ b/lms/djangoapps/instructor/views/api.py @@ -106,6 +106,43 @@ def require_query_params(*args, **kwargs): return wrapped return decorator +def require_post_params(*args, **kwargs): + """ + Checks for required paremters or renders a 400 error. + (decorator with arguments) + + `args` is a *list of required GET parameter names. + `kwargs` is a **dict of required GET parameter names + to string explanations of the parameter + """ + required_params = [] + required_params += [(arg, None) for arg in args] + required_params += [(key, kwargs[key]) for key in kwargs] + # required_params = e.g. [('action', 'enroll or unenroll'), ['emails', None]] + + def decorator(func): # pylint: disable=C0111 + def wrapped(*args, **kwargs): # pylint: disable=C0111 + request = args[0] + + error_response_data = { + 'error': 'Missing required query parameter(s)', + 'parameters': [], + 'info': {}, + } + + for (param, extra) in required_params: + default = object() + if request.POST.get(param, default) == default: + error_response_data['parameters'] += [param] + error_response_data['info'][param] = extra + + if len(error_response_data['parameters']) > 0: + return JsonResponse(error_response_data, status=400) + else: + return func(*args, **kwargs) + return wrapped + return decorator + def require_level(level): """ @@ -749,19 +786,19 @@ def send_email(request, course_id): @ensure_csrf_cookie @cache_control(no_cache=True, no_store=True, must_revalidate=True) @require_level('staff') -@require_query_params(send_to="sending to whom", subject="subject line", message="message text") +@require_post_params(send_to="sending to whom", subject="subject line", message="message text") def send_email(request, course_id): """ Send an email to self, staff, or everyone involved in a course. - Query Paramaters: + Query Parameters: - 'send_to' specifies what group the email should be sent to - 'subject' specifies email's subject - 'message' specifies email's content """ course = get_course_by_id(course_id) - send_to = request.GET.get("send_to") - subject = request.GET.get("subject") - message = request.GET.get("message") + send_to = request.POST.get("send_to") + subject = request.POST.get("subject") + message = request.POST.get("message") text_message = html_to_text(message) email = CourseEmail( course_id=course_id, diff --git a/lms/djangoapps/instructor/views/instructor_dashboard.py b/lms/djangoapps/instructor/views/instructor_dashboard.py index daf78b6162..fa3dbbf4af 100644 --- a/lms/djangoapps/instructor/views/instructor_dashboard.py +++ b/lms/djangoapps/instructor/views/instructor_dashboard.py @@ -160,12 +160,15 @@ def _section_data_download(course_id): def _section_send_email(course_id, access, course): """ Provide data for the corresponding bulk email section """ html_module = HtmlDescriptor(course.system, DictFieldData({'data': ''}), ScopeIds(None, None, None, None)) + fragment = course.system.render(html_module, None, 'studio_view') + fragment = wrap_xmodule('xmodule_edit.html', html_module, 'studio_view', fragment, None) + email_editor = fragment.content section_data = { 'section_key': 'send_email', 'section_display_name': _('Email'), 'access': access, 'send_email': reverse('send_email',kwargs={'course_id': course_id}), - 'editor': wrap_xmodule(html_module.get_html, html_module, 'xmodule_edit.html')() + 'editor': email_editor } return section_data diff --git a/lms/envs/dev.py b/lms/envs/dev.py index c596208b3f..ad5fc4eaa0 100644 --- a/lms/envs/dev.py +++ b/lms/envs/dev.py @@ -28,6 +28,7 @@ MITX_FEATURES['ENABLE_MANUAL_GIT_RELOAD'] = True MITX_FEATURES['ENABLE_PSYCHOMETRICS'] = False # real-time psychometrics (eg item response theory analysis in instructor dashboard) MITX_FEATURES['ENABLE_INSTRUCTOR_ANALYTICS'] = True MITX_FEATURES['ENABLE_SERVICE_STATUS'] = True +MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True MITX_FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True MITX_FEATURES['ENABLE_INSTRUCTOR_BETA_DASHBOARD'] = True MITX_FEATURES['MULTIPLE_ENROLLMENT_ROLES'] = True diff --git a/lms/static/coffee/src/instructor_dashboard/send_email.coffee b/lms/static/coffee/src/instructor_dashboard/send_email.coffee index af509a7d52..c8b0588b5d 100644 --- a/lms/static/coffee/src/instructor_dashboard/send_email.coffee +++ b/lms/static/coffee/src/instructor_dashboard/send_email.coffee @@ -22,6 +22,8 @@ class SendEmail # attach click handlers @$btn_send.click => + + success_message = gettext('Your email was successfully queued for sending.') send_data = action: 'send' @@ -30,10 +32,11 @@ class SendEmail message: @$emailEditor.save()['data'] $.ajax + type: 'POST' dataType: 'json' url: @$btn_send.data 'endpoint' data: send_data - success: (data) => @display_response gettext('Your email was successfully queued for sending.') + success: (data) => @display_response ("

" + success_message + "

") error: std_ajax_err => @fail_with_error gettext('Error sending email.') fail_with_error: (msg) -> diff --git a/lms/static/sass/course/instructor/_instructor_2.scss b/lms/static/sass/course/instructor/_instructor_2.scss index 19f6abf5ed..c9a4c79aa8 100644 --- a/lms/static/sass/course/instructor/_instructor_2.scss +++ b/lms/static/sass/course/instructor/_instructor_2.scss @@ -241,6 +241,60 @@ section.instructor-dashboard-content-2 { } } +.instructor-dashboard-wrapper-2 section.idash-section#send_email { + // form fields + .list-fields { + list-style: none; + margin: 0; + padding: 0; + + .field { + margin-bottom: 20px; + padding: 0; + + &:last-child { + margin-bottom: 0; + } + } + } + + // system feedback - messages + .msg { + + + .copy { + font-weight: 600; + } + } + + .msg-confirm { + background: tint(green,90%); + + .copy { + color: green; + } + } + + .list-advice { + list-style: none; + padding: 0; + margin: 20px 0; + + .item { + font-weight: 600; + margin-bottom: 10px; + + &:last-child { + margin-bottom: 0; + } + } + } + .msg .copy { + font-weight: 600; } + .msg-confirm { + background: #e5f2e5; } +} + .instructor-dashboard-wrapper-2 section.idash-section#membership { $half_width: $baseline * 20; @@ -538,3 +592,7 @@ section.instructor-dashboard-content-2 { right: $baseline; } } + +input[name="subject"] { + width:600px; +} diff --git a/lms/templates/instructor/instructor_dashboard_2/send_email.html b/lms/templates/instructor/instructor_dashboard_2/send_email.html index 68fd0938a1..5a11bcf207 100644 --- a/lms/templates/instructor/instructor_dashboard_2/send_email.html +++ b/lms/templates/instructor/instructor_dashboard_2/send_email.html @@ -6,38 +6,44 @@

${_("Send Email")}

- - + + %if to_option == "staff": + + %else: + + %endif + %if to_option == "all": + + %else: - %endif - -
- - -
- - - + %endif + +
+
  • +
    + +
    • +
  • + + + +
    • +
    ${_("Please try not to email students more than once a day. Before sending your email, consider:")} -
      +
      • ${_("Have you read over the email to make sure it says everything you want to say?")}
      • ${_("Have you sent the email to yourself first to make sure you're happy with how it's displayed?")}
    - -
    +
    \ No newline at end of file From 3f88b87916a5edf207db1fd1887eee0cc50083d4 Mon Sep 17 00:00:00 2001 From: Will Daly Date: Wed, 2 Oct 2013 17:09:06 -0400 Subject: [PATCH 05/35] Added acceptance tests for bulk email (through beta dashboard) --- common/djangoapps/terrain/course_helpers.py | 22 ++- common/djangoapps/terrain/ui_helpers.py | 25 ++- .../instructor/features/bulk_email.feature | 16 ++ .../instructor/features/bulk_email.py | 165 ++++++++++++++++++ lms/envs/acceptance.py | 3 + .../instructor_dashboard_2/send_email.html | 2 +- 6 files changed, 226 insertions(+), 7 deletions(-) create mode 100644 lms/djangoapps/instructor/features/bulk_email.feature create mode 100644 lms/djangoapps/instructor/features/bulk_email.py diff --git a/common/djangoapps/terrain/course_helpers.py b/common/djangoapps/terrain/course_helpers.py index 22222d30a4..cd454016f2 100644 --- a/common/djangoapps/terrain/course_helpers.py +++ b/common/djangoapps/terrain/course_helpers.py @@ -2,7 +2,7 @@ # pylint: disable=W0621 from lettuce import world -from django.contrib.auth.models import User +from django.contrib.auth.models import User, Group from student.models import CourseEnrollment from xmodule.modulestore.django import editable_modulestore from xmodule.contentstore.django import contentstore @@ -41,14 +41,28 @@ def log_in(username='robot', password='test', email='robot@edx.org', name='Robot @world.absorb -def register_by_course_id(course_id, is_staff=False): - create_user('robot', 'password') - u = User.objects.get(username='robot') +def register_by_course_id(course_id, username='robot', password='test', is_staff=False): + create_user(username, password) + user = User.objects.get(username=username) if is_staff: u.is_staff = True u.save() CourseEnrollment.enroll(u, course_id) +@world.absorb +def add_to_course_staff(username, course_num): + """ + Add the user with `username` to the course staff group + for `course_num`. + """ + # Based on code in lms/djangoapps/courseware/access.py + group_name = "instructor_{}".format(course_num) + group, _ = Group.objects.get_or_create(name=group_name) + group.save() + + user = User.objects.get(username=username) + user.groups.add(group) + @world.absorb def clear_courses(): diff --git a/common/djangoapps/terrain/ui_helpers.py b/common/djangoapps/terrain/ui_helpers.py index e400ca9b95..f143973c46 100644 --- a/common/djangoapps/terrain/ui_helpers.py +++ b/common/djangoapps/terrain/ui_helpers.py @@ -45,8 +45,29 @@ def is_css_not_present(css_selector, wait_time=5): world.browser.driver.implicitly_wait(world.IMPLICIT_WAIT) @world.absorb -def css_has_text(css_selector, text, index=0): - return world.css_text(css_selector, index=index) == text +def css_has_text(css_selector, text, index=0, strip=False): + """ + Return a boolean indicating whether the element with `css_selector` + has `text`. + + If `strip` is True, strip whitespace at beginning/end of both + strings before comparing. + + If there are multiple elements matching the css selector, + use `index` to indicate which one. + """ + # If we're expecting a non-empty string, give the page + # a chance to fill in text fields. + if text: + world.wait_for(lambda _: world.css_text(css_selector, index=index)) + + actual_text = world.css_text(css_selector, index=index) + + if strip: + actual_text = actual_text.strip() + text = text.strip() + + return actual_text == text @world.absorb diff --git a/lms/djangoapps/instructor/features/bulk_email.feature b/lms/djangoapps/instructor/features/bulk_email.feature new file mode 100644 index 0000000000..7b46d1ec9b --- /dev/null +++ b/lms/djangoapps/instructor/features/bulk_email.feature @@ -0,0 +1,16 @@ +@shard_2 +Feature: Bulk Email + As an instructor, + In order to communicate with students and staff + I want to send email to staff and students in a course. + + Scenario: Send bulk email + Given I am an instructor for a course + When I send email to "" + Then Email is sent to "" + + Examples: + | Recipient | + | myself | + | course staff | + | students, staff, and instructors | diff --git a/lms/djangoapps/instructor/features/bulk_email.py b/lms/djangoapps/instructor/features/bulk_email.py new file mode 100644 index 0000000000..6706f0f430 --- /dev/null +++ b/lms/djangoapps/instructor/features/bulk_email.py @@ -0,0 +1,165 @@ +""" +Define steps for bulk email acceptance test. +""" + +from lettuce import world, step +from lettuce.django import mail +from nose.tools import assert_in, assert_true, assert_equal +from django.core.management import call_command + + +@step(u'I am an instructor for a course') +def i_am_an_instructor(step): + + # Clear existing courses to avoid conflicts + world.clear_courses() + + # Create a new course + course = world.CourseFactory.create( + org='edx', + number='999', + display_name='Test Course' + ) + + # Register the instructor as staff for the course + world.register_by_course_id( + 'edx/999/Test_Course', + username='instructor', + password='password', + is_staff=True + ) + world.add_to_course_staff('instructor', '999') + + # Register another staff member + world.register_by_course_id( + 'edx/999/Test_Course', + username='staff', + password='password', + is_staff=True + ) + world.add_to_course_staff('staff', '999') + + # Register a student + world.register_by_course_id( + 'edx/999/Test_Course', + username='student', + password='password', + is_staff=False + ) + + # Log in as the instructor for the course + world.log_in( + username='instructor', + password='password', + email="instructor@edx.org", + name="Instructor" + ) + + +# Dictionary mapping a description of the email recipient +# to the corresponding