f33f12bbea
* Python code cleanup by the cleanup-python-code Jenkins job. This pull request was generated by the cleanup-python-code Jenkins job, which ran ``` cd lms/djangoapps/dashboard; find . -type f -name '*.py' | while read fname; do sed -i 's/ # lint-amnesty, pylint: disable=super-with-arguments//; s/ # lint-amnesty, pylint: disable=import-error, wrong-import-order//; s/ # lint-amnesty, pylint: disable=wrong-import-order//' "$fname"; done; find . -type f -name '*.py' | while read fname; do pyupgrade --exit-zero-even-if-changed --py3-plus --py36-plus --py38-plus "$fname"; done; isort --recursive . ``` The following packages were installed: `pyupgrade,isort` * feedback done Co-authored-by: Zulqarnain <muhammad.zulqarnain@arbisoft.com>
98 lines
4.5 KiB
Python
98 lines
4.5 KiB
Python
"""
|
|
Tests the forum notification signals.
|
|
"""
|
|
import mock
|
|
from django.test import TestCase
|
|
from edx_django_utils.cache import RequestCache
|
|
|
|
from lms.djangoapps.discussion.signals.handlers import ENABLE_FORUM_NOTIFICATIONS_FOR_SITE_KEY
|
|
from openedx.core.djangoapps.django_comment_common import models, signals
|
|
from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory, SiteFactory
|
|
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
|
|
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
|
|
|
|
|
|
class SendMessageHandlerTestCase(TestCase): # lint-amnesty, pylint: disable=missing-class-docstring
|
|
|
|
def setUp(self): # lint-amnesty, pylint: disable=super-method-not-called
|
|
self.sender = mock.Mock()
|
|
self.user = mock.Mock()
|
|
self.post = mock.Mock()
|
|
self.post.thread.course_id = 'course-v1:edX+DemoX+Demo_Course'
|
|
|
|
self.site = SiteFactory.create()
|
|
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.get_current_site')
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.send_message')
|
|
def test_comment_created_signal_sends_message(self, mock_send_message, mock_get_current_site):
|
|
site_config = SiteConfigurationFactory.create(site=self.site)
|
|
enable_notifications_cfg = {ENABLE_FORUM_NOTIFICATIONS_FOR_SITE_KEY: True}
|
|
site_config.site_values = enable_notifications_cfg
|
|
site_config.save()
|
|
mock_get_current_site.return_value = self.site
|
|
signals.comment_created.send(sender=self.sender, user=self.user, post=self.post)
|
|
|
|
mock_send_message.assert_called_once_with(self.post, mock_get_current_site.return_value)
|
|
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.get_current_site', return_value=None)
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.send_message')
|
|
def test_comment_created_signal_message_not_sent_without_site(self, mock_send_message, mock_get_current_site): # lint-amnesty, pylint: disable=unused-argument
|
|
signals.comment_created.send(sender=self.sender, user=self.user, post=self.post)
|
|
|
|
assert not mock_send_message.called
|
|
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.get_current_site')
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.send_message')
|
|
def test_comment_created_signal_msg_not_sent_without_site_config(self, mock_send_message, mock_get_current_site):
|
|
mock_get_current_site.return_value = self.site
|
|
signals.comment_created.send(sender=self.sender, user=self.user, post=self.post)
|
|
|
|
assert not mock_send_message.called
|
|
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.get_current_site')
|
|
@mock.patch('lms.djangoapps.discussion.signals.handlers.send_message')
|
|
def test_comment_created_signal_msg_not_sent_with_site_config_disabled(
|
|
self, mock_send_message, mock_get_current_site
|
|
):
|
|
site_config = SiteConfigurationFactory.create(site=self.site)
|
|
enable_notifications_cfg = {ENABLE_FORUM_NOTIFICATIONS_FOR_SITE_KEY: False}
|
|
site_config.site_values = enable_notifications_cfg
|
|
site_config.save()
|
|
mock_get_current_site.return_value = self.site
|
|
signals.comment_created.send(sender=self.sender, user=self.user, post=self.post)
|
|
|
|
assert not mock_send_message.called
|
|
|
|
|
|
class CoursePublishHandlerTestCase(ModuleStoreTestCase):
|
|
"""
|
|
Tests for discussion updates on course publish.
|
|
"""
|
|
ENABLED_SIGNALS = ['course_published']
|
|
|
|
def test_discussion_id_map_updates_on_publish(self):
|
|
course_key_args = dict(org='org', course='number', run='run')
|
|
course_key = self.store.make_course_key(**course_key_args)
|
|
|
|
# create course
|
|
course = CourseFactory(emit_signals=True, **course_key_args)
|
|
assert course.id == course_key
|
|
self._assert_discussion_id_map(course_key, {})
|
|
|
|
# create discussion block
|
|
RequestCache().clear()
|
|
discussion_id = 'discussion1'
|
|
discussion_block = ItemFactory.create(
|
|
parent_location=course.location,
|
|
category="discussion",
|
|
discussion_id=discussion_id,
|
|
)
|
|
self._assert_discussion_id_map(course_key, {discussion_id: str(discussion_block.location)})
|
|
|
|
def _assert_discussion_id_map(self, course_key, expected_map):
|
|
"""
|
|
Verifies the discussion ID map for the given course matches the expected value.
|
|
"""
|
|
mapping_entry = models.DiscussionsIdMapping.objects.get(course_id=course_key)
|
|
self.assertDictEqual(mapping_entry.mapping, expected_map)
|