Skip to content

fix: studio access notifications #38789

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

Open
Kelketek wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −24
Open

fix: studio access notifications #38789

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
20 changes: 15 additions & 5 deletions cms/djangoapps/course_creators/admin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
)
from cms.djangoapps.course_creators.views import update_course_creator_group, update_org_content_creator_role
from common.djangoapps.edxmako.shortcuts import render_to_string
from openedx.core.djangoapps.theming.helpers import get_current_site

log = logging.getLogger("studio.coursecreatoradmin")

Expand Down Expand Up @@ -134,6 +135,16 @@ def update_creator_group_callback(sender, **kwargs): # pylint: disable=unused-a
update_course_creator_group(kwargs['caller'], user, create_role)


def course_creator_notification_context(subject):
return {
'studio_request_email': settings.FEATURES.get('STUDIO_REQUEST_EMAIL', ''),
'is_secure': (settings.CMS_ROOT_URL or '').split(':')[0].lower() == 'https',
'site': str(get_current_site() or settings.CMS_BASE),
'user_name': subject.username,
'user_email': subject.email,
}


@receiver(send_user_notification, sender=CourseCreator)
def send_user_notification_callback(sender, **kwargs): # pylint: disable=unused-argument
"""
Expand All @@ -142,9 +153,8 @@ def send_user_notification_callback(sender, **kwargs): # pylint: disable=unused
user = kwargs['user']
updated_state = kwargs['state']

studio_request_email = settings.FEATURES.get('STUDIO_REQUEST_EMAIL', '')
context = {'studio_request_email': studio_request_email}

context = course_creator_notification_context(user)
studio_request_email = context['studio_request_email']
subject = render_to_string('emails/course_creator_subject.txt', context)
subject = ''.join(subject.splitlines())
if updated_state == CourseCreator.GRANTED:
Expand All @@ -169,8 +179,8 @@ def send_admin_notification_callback(sender, **kwargs): # pylint: disable=unuse
"""
user = kwargs['user']

studio_request_email = settings.FEATURES.get('STUDIO_REQUEST_EMAIL', '')
context = {'user_name': user.username, 'user_email': user.email}
context = course_creator_notification_context(user)
studio_request_email = context['studio_request_email']

subject = render_to_string('emails/course_creator_admin_subject.txt', context)
subject = ''.join(subject.splitlines())
Expand Down
31 changes: 12 additions & 19 deletions cms/djangoapps/course_creators/tests/test_admin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,12 @@

from cms.djangoapps.course_creators.admin import CourseCreatorAdmin
from cms.djangoapps.course_creators.models import CourseCreator
from common.djangoapps.edxmako.shortcuts import render_to_string
from common.djangoapps.student import auth
from common.djangoapps.student.roles import CourseCreatorRole
from common.djangoapps.student.tests.factories import UserFactory


def mock_render_to_string(template_name, context):
"""Return a string that encodes template_name and context"""
return str((template_name, context))


class CourseCreatorAdminTest(TestCase):
"""
Tests for course creator admin.
Expand Down Expand Up @@ -55,11 +51,14 @@ def setUp(self):
"ENABLE_CREATOR_GROUP": True,
"STUDIO_REQUEST_EMAIL": self.studio_request_email
}
self.context = {
'studio_request_email': self.studio_request_email,
'is_secure': False,
'site': 'localhost:8001',
'user_name': 'test_user',
'user_email': 'test_user+courses@edx.org',
}

@mock.patch(
'cms.djangoapps.course_creators.admin.render_to_string',
mock.Mock(side_effect=mock_render_to_string, autospec=True)
)
@mock.patch('django.contrib.auth.models.User.email_user')
def test_change_status(self, email_user):
"""
Expand All @@ -71,16 +70,15 @@ def change_state_and_verify_email(state, is_creator):
self._change_state(state)
self.assertEqual(is_creator, auth.user_has_role(self.user, CourseCreatorRole())) # noqa: PT009

context = {'studio_request_email': self.studio_request_email}
if state == CourseCreator.GRANTED:
template = 'emails/course_creator_granted.txt'
elif state == CourseCreator.DENIED:
template = 'emails/course_creator_denied.txt'
else:
template = 'emails/course_creator_revoked.txt'
email_user.assert_called_with(
mock_render_to_string('emails/course_creator_subject.txt', context),
mock_render_to_string(template, context),
render_to_string('emails/course_creator_subject.txt', self.context).strip(),
render_to_string(template, self.context),
self.studio_request_email
)

Expand All @@ -103,10 +101,6 @@ def change_state_and_verify_email(state, is_creator):

change_state_and_verify_email(CourseCreator.DENIED, False)

@mock.patch(
'cms.djangoapps.course_creators.admin.render_to_string',
mock.Mock(side_effect=mock_render_to_string, autospec=True)
)
def test_mail_admin_on_pending(self):
"""
Tests that the admin account is notified when a user is in the 'pending' state.
Expand All @@ -121,16 +115,15 @@ def check_admin_message_state(state, expect_sent_to_admin, expect_sent_to_user):
# message sent. Admin message will follow.
base_num_emails = 1 if expect_sent_to_user else 0
if expect_sent_to_admin:
context = {'user_name': 'test_user', 'user_email': 'test_user+courses@edx.org'}

self.assertEqual(base_num_emails + 1, len(mail.outbox), 'Expected admin message to be sent') # noqa: PT009 # pylint: disable=line-too-long
sent_mail = mail.outbox[base_num_emails]
self.assertEqual( # noqa: PT009
mock_render_to_string('emails/course_creator_admin_subject.txt', context),
render_to_string('emails/course_creator_admin_subject.txt', self.context).strip(),
sent_mail.subject
)
self.assertEqual( # noqa: PT009
mock_render_to_string('emails/course_creator_admin_user_pending.txt', context),
render_to_string('emails/course_creator_admin_user_pending.txt', self.context),
sent_mail.body
)
self.assertEqual(self.studio_request_email, sent_mail.from_email) # noqa: PT009
Expand Down
Loading