This is a test thread body with some text.
"} ) serialized = self.serialize(thread_data) - assert serialized['preview_body'] == "This is a test thread body with some text." + assert ( + serialized["preview_body"] + == "This is a test thread body with some text." + ) @ddt.ddt @@ -402,12 +473,12 @@ def make_cs_content(self, overrides=None, with_endorsement=False): """ merged_overrides = { "user_id": str(self.author.id), - "username": self.author.username + "username": self.author.username, } if with_endorsement: merged_overrides["endorsement"] = { "user_id": str(self.endorser.id), - "time": self.endorsed_at + "time": self.endorsed_at, } merged_overrides.update(overrides or {}) return make_minimal_cs_comment(merged_overrides) @@ -417,7 +488,9 @@ def serialize(self, comment, thread_data=None): Create a serializer with an appropriate context and use it to serialize the given comment, returning the result. """ - context = get_context(self.course, self.request, make_minimal_cs_thread(thread_data)) + context = get_context( + self.course, self.request, make_minimal_cs_thread(thread_data) + ) return CommentSerializer(comment, context=context).data def test_basic(self): @@ -446,6 +519,8 @@ def test_basic(self): "parent_id": None, "author": self.author.username, "author_label": None, + "is_author_banned": False, + "author_ban_scope": None, "created_at": "2015-04-28T00:00:00Z", "updated_at": "2015-04-28T11:11:11Z", "raw_body": "Test body", @@ -464,6 +539,7 @@ def test_basic(self): "can_delete": False, "last_edit": None, "edit_by_label": None, + "learner_status": "new", "profile_image": { "has_image": False, "image_url_full": "http://testserver/static/default_500.png", @@ -471,6 +547,10 @@ def test_basic(self): "image_url_medium": "http://testserver/static/default_50.png", "image_url_small": "http://testserver/static/default_30.png", }, + "is_deleted": None, + "deleted_at": None, + "deleted_by": None, + "deleted_by_label": None, } assert self.serialize(comment) == expected @@ -483,7 +563,7 @@ def test_basic(self): FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_STUDENT, ], - [True, False] + [True, False], ) ) @ddt.unpack @@ -500,10 +580,12 @@ def test_endorsed_by(self, endorser_role_name, thread_anonymous): self.create_role(endorser_role_name, [self.endorser]) serialized = self.serialize( self.make_cs_content(with_endorsement=True), - thread_data={"anonymous": thread_anonymous} + thread_data={"anonymous": thread_anonymous}, ) actual_endorser_anonymous = serialized["endorsed_by"] is None - expected_endorser_anonymous = endorser_role_name == FORUM_ROLE_STUDENT and thread_anonymous + expected_endorser_anonymous = ( + endorser_role_name == FORUM_ROLE_STUDENT and thread_anonymous + ) assert actual_endorser_anonymous == expected_endorser_anonymous @ddt.data( @@ -526,56 +608,106 @@ def test_endorsed_by_labels(self, role_name, expected_label): """ self.create_role(role_name, [self.endorser]) serialized = self.serialize(self.make_cs_content(with_endorsement=True)) - assert serialized['endorsed_by_label'] == expected_label + assert serialized["endorsed_by_label"] == expected_label def test_endorsed_at(self): serialized = self.serialize(self.make_cs_content(with_endorsement=True)) - assert serialized['endorsed_at'] == self.endorsed_at + assert serialized["endorsed_at"] == self.endorsed_at def test_children(self): - comment = self.make_cs_content({ - "id": "test_root", - "children": [ - self.make_cs_content({ - "id": "test_child_1", - "parent_id": "test_root", - }), - self.make_cs_content({ - "id": "test_child_2", - "parent_id": "test_root", - "children": [ - self.make_cs_content({ - "id": "test_grandchild", - "parent_id": "test_child_2" - }) - ], - }), - ], - }) + comment = self.make_cs_content( + { + "id": "test_root", + "children": [ + self.make_cs_content( + { + "id": "test_child_1", + "parent_id": "test_root", + } + ), + self.make_cs_content( + { + "id": "test_child_2", + "parent_id": "test_root", + "children": [ + self.make_cs_content( + { + "id": "test_grandchild", + "parent_id": "test_child_2", + } + ) + ], + } + ), + ], + } + ) serialized = self.serialize(comment) - assert serialized['children'][0]['id'] == 'test_child_1' - assert serialized['children'][0]['parent_id'] == 'test_root' - assert serialized['children'][1]['id'] == 'test_child_2' - assert serialized['children'][1]['parent_id'] == 'test_root' - assert serialized['children'][1]['children'][0]['id'] == 'test_grandchild' - assert serialized['children'][1]['children'][0]['parent_id'] == 'test_child_2' + assert serialized["children"][0]["id"] == "test_child_1" + assert serialized["children"][0]["parent_id"] == "test_root" + assert serialized["children"][1]["id"] == "test_child_2" + assert serialized["children"][1]["parent_id"] == "test_root" + assert serialized["children"][1]["children"][0]["id"] == "test_grandchild" + assert serialized["children"][1]["children"][0]["parent_id"] == "test_child_2" + + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) + def test_ban_lookup_is_memoized_for_duplicate_authors(self): + comment_1 = self.make_cs_content({"id": "test_comment_1"}) + comment_2 = self.make_cs_content({"id": "test_comment_2"}) + context = get_context( + self.course, + self.request, + make_minimal_cs_thread({"id": "test_thread"}), + ) + + with mock.patch( + "lms.djangoapps.discussion.toggles.ENABLE_DISCUSSION_BAN.is_enabled", + return_value=True, + ), mock.patch( + "forum.api.is_user_banned", + return_value=True, + create=True, + ) as is_user_banned_mock, mock.patch( + "forum.api.get_user_bans", + return_value=[{"is_active": True, "scope": "course"}], + create=True, + ) as get_user_bans_mock: + serialized = CommentSerializer( + [comment_1, comment_2], + context=context, + many=True, + ).data + + assert serialized[0]["is_author_banned"] is True + assert serialized[0]["author_ban_scope"] == "course" + assert serialized[1]["is_author_banned"] is True + assert serialized[1]["author_ban_scope"] == "course" + assert is_user_banned_mock.call_count == 1 + assert get_user_bans_mock.call_count == 1 @ddt.ddt class ThreadSerializerDeserializationTest( - ForumsEnableMixin, - CommentsServiceMockMixin, - UrlResetMixin, - SharedModuleStoreTestCase + ForumsEnableMixin, + CommentsServiceMockMixin, + UrlResetMixin, + SharedModuleStoreTestCase, ): """Tests for ThreadSerializer deserialization.""" + @classmethod - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def setUpClass(cls): super().setUpClass() cls.course = CourseFactory.create() - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def setUp(self): super().setUp() httpretty.reset() @@ -583,8 +715,8 @@ def setUp(self): self.addCleanup(httpretty.reset) self.addCleanup(httpretty.disable) patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) @@ -599,18 +731,22 @@ def setUp(self): "title": "Test Title", "raw_body": "Test body", } - self.existing_thread = Thread(**make_minimal_cs_thread({ - "id": "existing_thread", - "course_id": str(self.course.id), - "commentable_id": "original_topic", - "thread_type": "discussion", - "title": "Original Title", - "body": "Original body", - "user_id": str(self.user.id), - "username": self.user.username, - "read": "False", - "endorsed": "False" - })) + self.existing_thread = Thread( + **make_minimal_cs_thread( + { + "id": "existing_thread", + "course_id": str(self.course.id), + "commentable_id": "original_topic", + "thread_type": "discussion", + "title": "Original Title", + "body": "Original body", + "user_id": str(self.user.id), + "username": self.user.username, + "read": "False", + "endorsed": "False", + } + ) + ) def save_and_reserialize(self, data, instance=None): """ @@ -622,7 +758,7 @@ def save_and_reserialize(self, data, instance=None): instance, data=data, partial=(instance is not None), - context=get_context(self.course, self.request) + context=get_context(self.course, self.request), ) assert serializer.is_valid() serializer.save() @@ -634,33 +770,36 @@ def test_create_missing_field(self): data.pop(field) serializer = ThreadSerializer(data=data) assert not serializer.is_valid() - assert serializer.errors == {field: ['This field is required.']} + assert serializer.errors == {field: ["This field is required."]} @ddt.data("", " ") def test_create_empty_string(self, value): data = self.minimal_data.copy() data.update({field: value for field in ["topic_id", "title", "raw_body"]}) - serializer = ThreadSerializer(data=data, context=get_context(self.course, self.request)) + serializer = ThreadSerializer( + data=data, context=get_context(self.course, self.request) + ) assert not serializer.is_valid() assert serializer.errors == { - field: ['This field may not be blank.'] for field in ['topic_id', 'title', 'raw_body'] + field: ["This field may not be blank."] + for field in ["topic_id", "title", "raw_body"] } def test_update_empty(self): self.register_put_thread_response(self.existing_thread.attributes) self.save_and_reserialize({}, self.existing_thread) assert parsed_body(httpretty.last_request()) == { - 'course_id': [str(self.course.id)], - 'commentable_id': ['original_topic'], - 'thread_type': ['discussion'], - 'title': ['Original Title'], - 'body': ['Original body'], - 'anonymous': ['False'], - 'anonymous_to_peers': ['False'], - 'closed': ['False'], - 'pinned': ['False'], - 'user_id': [str(self.user.id)], - 'read': ['False'] + "course_id": [str(self.course.id)], + "commentable_id": ["original_topic"], + "thread_type": ["discussion"], + "title": ["Original Title"], + "body": ["Original body"], + "anonymous": ["False"], + "anonymous_to_peers": ["False"], + "closed": ["False"], + "pinned": ["False"], + "user_id": [str(self.user.id)], + "read": ["False"], } @ddt.data(True, False) @@ -675,18 +814,18 @@ def test_update_all(self, read): } saved = self.save_and_reserialize(data, self.existing_thread) assert parsed_body(httpretty.last_request()) == { - 'course_id': [str(self.course.id)], - 'commentable_id': ['edited_topic'], - 'thread_type': ['question'], - 'title': ['Edited Title'], - 'body': ['Edited body'], - 'anonymous': ['False'], - 'anonymous_to_peers': ['False'], - 'closed': ['False'], - 'pinned': ['False'], - 'user_id': [str(self.user.id)], - 'read': [str(read)], - 'editing_user_id': [str(self.user.id)], + "course_id": [str(self.course.id)], + "commentable_id": ["edited_topic"], + "thread_type": ["question"], + "title": ["Edited Title"], + "body": ["Edited body"], + "anonymous": ["False"], + "anonymous_to_peers": ["False"], + "closed": ["False"], + "pinned": ["False"], + "user_id": [str(self.user.id)], + "read": [str(read)], + "editing_user_id": [str(self.user.id)], } for key in data: assert saved[key] == data[key] @@ -701,7 +840,7 @@ def test_update_anonymous(self): "anonymous": True, } self.save_and_reserialize(data, self.existing_thread) - assert parsed_body(httpretty.last_request())["anonymous"] == ['True'] + assert parsed_body(httpretty.last_request())["anonymous"] == ["True"] def test_update_anonymous_to_peers(self): """ @@ -713,7 +852,7 @@ def test_update_anonymous_to_peers(self): "anonymous_to_peers": True, } self.save_and_reserialize(data, self.existing_thread) - assert parsed_body(httpretty.last_request())["anonymous_to_peers"] == ['True'] + assert parsed_body(httpretty.last_request())["anonymous_to_peers"] == ["True"] @ddt.data("", " ") def test_update_empty_string(self, value): @@ -721,11 +860,12 @@ def test_update_empty_string(self, value): self.existing_thread, data={field: value for field in ["topic_id", "title", "raw_body"]}, partial=True, - context=get_context(self.course, self.request) + context=get_context(self.course, self.request), ) assert not serializer.is_valid() assert serializer.errors == { - field: ['This field may not be blank.'] for field in ['topic_id', 'title', 'raw_body'] + field: ["This field may not be blank."] + for field in ["topic_id", "title", "raw_body"] } def test_update_course_id(self): @@ -733,15 +873,20 @@ def test_update_course_id(self): self.existing_thread, data={"course_id": "some/other/course"}, partial=True, - context=get_context(self.course, self.request) + context=get_context(self.course, self.request), ) assert not serializer.is_valid() - assert serializer.errors == {'course_id': ['This field is not allowed in an update.']} + assert serializer.errors == { + "course_id": ["This field is not allowed in an update."] + } @ddt.ddt -class CommentSerializerDeserializationTest(ForumsEnableMixin, CommentsServiceMockMixin, SharedModuleStoreTestCase): +class CommentSerializerDeserializationTest( + ForumsEnableMixin, CommentsServiceMockMixin, SharedModuleStoreTestCase +): """Tests for ThreadSerializer deserialization.""" + @classmethod def setUpClass(cls): super().setUpClass() @@ -754,8 +899,8 @@ def setUp(self): self.addCleanup(httpretty.reset) self.addCleanup(httpretty.disable) patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) @@ -777,14 +922,18 @@ def setUp(self): "thread_id": "test_thread", "raw_body": "Test body", } - self.existing_comment = Comment(**make_minimal_cs_comment({ - "id": "existing_comment", - "thread_id": "dummy", - "body": "Original body", - "user_id": str(self.user.id), - "username": self.user.username, - "course_id": str(self.course.id), - })) + self.existing_comment = Comment( + **make_minimal_cs_comment( + { + "id": "existing_comment", + "thread_id": "dummy", + "body": "Original body", + "user_id": str(self.user.id), + "username": self.user.username, + "course_id": str(self.course.id), + } + ) + ) def save_and_reserialize(self, data, instance=None): """ @@ -794,13 +943,10 @@ def save_and_reserialize(self, data, instance=None): context = get_context( self.course, self.request, - make_minimal_cs_thread({"course_id": str(self.course.id)}) + make_minimal_cs_thread({"course_id": str(self.course.id)}), ) serializer = CommentSerializer( - instance, - data=data, - partial=(instance is not None), - context=context + instance, data=data, partial=(instance is not None), context=context ) assert serializer.is_valid() serializer.save() @@ -812,21 +958,23 @@ def test_create_missing_field(self): data.pop(field) serializer = CommentSerializer( data=data, - context=get_context(self.course, self.request, make_minimal_cs_thread()) + context=get_context( + self.course, self.request, make_minimal_cs_thread() + ), ) assert not serializer.is_valid() - assert serializer.errors == {field: ['This field is required.']} + assert serializer.errors == {field: ["This field is required."]} def test_update_empty(self): self.register_put_comment_response(self.existing_comment.attributes) self.save_and_reserialize({}, instance=self.existing_comment) assert parsed_body(httpretty.last_request()) == { - 'body': ['Original body'], - 'course_id': [str(self.course.id)], - 'user_id': [str(self.user.id)], - 'anonymous': ['False'], - 'anonymous_to_peers': ['False'], - 'endorsed': ['False'] + "body": ["Original body"], + "course_id": [str(self.course.id)], + "user_id": [str(self.user.id)], + "anonymous": ["False"], + "anonymous_to_peers": ["False"], + "endorsed": ["False"], } def test_update_anonymous(self): @@ -839,7 +987,7 @@ def test_update_anonymous(self): "anonymous": True, } self.save_and_reserialize(data, self.existing_comment) - assert parsed_body(httpretty.last_request())["anonymous"] == ['True'] + assert parsed_body(httpretty.last_request())["anonymous"] == ["True"] def test_update_anonymous_to_peers(self): """ @@ -851,7 +999,7 @@ def test_update_anonymous_to_peers(self): "anonymous_to_peers": True, } self.save_and_reserialize(data, self.existing_comment) - assert parsed_body(httpretty.last_request())["anonymous_to_peers"] == ['True'] + assert parsed_body(httpretty.last_request())["anonymous_to_peers"] == ["True"] @ddt.data("thread_id", "parent_id") def test_update_non_updatable(self, field): @@ -859,23 +1007,26 @@ def test_update_non_updatable(self, field): self.existing_comment, data={field: "different_value"}, partial=True, - context=get_context(self.course, self.request) + context=get_context(self.course, self.request), ) assert not serializer.is_valid() - assert serializer.errors == {field: ['This field is not allowed in an update.']} + assert serializer.errors == {field: ["This field is not allowed in an update."]} class FilterSpamTest(SharedModuleStoreTestCase): """ Tests for the filter_spam method """ - @override_settings(DISCUSSION_SPAM_URLS=['example.com']) + + @override_settings(DISCUSSION_SPAM_URLS=["example.com"]) def test_filter(self): self.assertEqual( - filter_spam_urls_from_html('')[0], - 'abc
'
+ filter_spam_urls_from_html(
+ ''
+ )[0],
+ "abc
",
)
self.assertEqual(
- filter_spam_urls_from_html('example.com/abc/def
')[0],
- ''
+ filter_spam_urls_from_html("example.com/abc/def
")[0],
+ "",
)
diff --git a/lms/djangoapps/discussion/rest_api/tests/test_tasks_v2.py b/lms/djangoapps/discussion/rest_api/tests/test_tasks_v2.py
index 153ba156049d..e14da2dfa851 100644
--- a/lms/djangoapps/discussion/rest_api/tests/test_tasks_v2.py
+++ b/lms/djangoapps/discussion/rest_api/tests/test_tasks_v2.py
@@ -14,6 +14,7 @@
from common.djangoapps.student.tests.factories import StaffFactory, UserFactory
from lms.djangoapps.discussion.django_comment_client.tests.factories import RoleFactory
from lms.djangoapps.discussion.rest_api.tasks import (
+ delete_course_post_for_user,
send_response_endorsed_notifications,
send_response_notifications,
send_thread_created_notification
@@ -802,3 +803,50 @@ def test_response_endorsed_notifications(self):
self.assertEqual(notification_data.content_url, _get_mfe_url(self.course.id, thread.id))
self.assertEqual(notification_data.app_name, 'discussion')
self.assertEqual('response_endorsed', notification_data.notification_type)
+
+
+class TestDeleteCoursePostForUserTask(ModuleStoreTestCase):
+ """Tests for delete_course_post_for_user task behavior."""
+
+ def setUp(self):
+ super().setUp()
+ self.course = CourseFactory.create()
+ self.target_user = UserFactory.create()
+ self.moderator = UserFactory.create()
+
+ def test_ban_succeeds_when_email_send_fails(self):
+ """Ban should still succeed even if escalation email raises an exception."""
+ with mock.patch(
+ 'lms.djangoapps.discussion.rest_api.tasks.Thread.delete_user_threads',
+ return_value=2,
+ ), mock.patch(
+ 'lms.djangoapps.discussion.rest_api.tasks.Comment.delete_user_comments',
+ return_value=3,
+ ), mock.patch(
+ 'forum.api.ban_user',
+ return_value={'id': 42},
+ create=True,
+ ) as mock_ban_user, mock.patch(
+ 'lms.djangoapps.discussion.rest_api.emails.send_ban_escalation_email',
+ side_effect=Exception('email failure'),
+ ) as mock_send_email, mock.patch(
+ 'lms.djangoapps.discussion.rest_api.tasks.tracker.emit',
+ ), mock.patch(
+ 'lms.djangoapps.discussion.rest_api.tasks.segment.track',
+ ):
+ result = delete_course_post_for_user.run(
+ user_id=self.target_user.id,
+ username=self.target_user.username,
+ course_ids=[str(self.course.id)],
+ event_data={'triggered_by_user_id': self.moderator.id},
+ ban_user=True,
+ ban_scope='course',
+ moderator_id=self.moderator.id,
+ reason='test reason',
+ )
+
+ mock_ban_user.assert_called_once()
+ mock_send_email.assert_called_once()
+ self.assertTrue(result['ban_created'])
+ self.assertEqual(result['ban_id'], 42)
+ self.assertIsNone(result['ban_error'])
diff --git a/lms/djangoapps/discussion/rest_api/tests/test_views.py b/lms/djangoapps/discussion/rest_api/tests/test_views.py
index be8a793abc92..3b4b6ff47d5e 100644
--- a/lms/djangoapps/discussion/rest_api/tests/test_views.py
+++ b/lms/djangoapps/discussion/rest_api/tests/test_views.py
@@ -2,7 +2,6 @@
Tests for Discussion API views
"""
-
import json
import random
from datetime import datetime
@@ -20,22 +19,22 @@
from rest_framework import status
from rest_framework.test import APIClient, APITestCase
-from lms.djangoapps.discussion.toggles import ENABLE_DISCUSSIONS_MFE
-from lms.djangoapps.discussion.rest_api.utils import get_usernames_from_search_string
-from xmodule.modulestore import ModuleStoreEnum
-from xmodule.modulestore.django import modulestore
-from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase
-from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory, check_mongo_calls
-
from common.djangoapps.course_modes.models import CourseMode
from common.djangoapps.course_modes.tests.factories import CourseModeFactory
-from common.djangoapps.student.models import get_retired_username_by_username, CourseEnrollment
-from common.djangoapps.student.roles import CourseInstructorRole, CourseStaffRole, GlobalStaff
+from common.djangoapps.student.models import (
+ CourseEnrollment,
+ get_retired_username_by_username,
+)
+from common.djangoapps.student.roles import (
+ CourseInstructorRole,
+ CourseStaffRole,
+ GlobalStaff,
+)
from common.djangoapps.student.tests.factories import (
AdminFactory,
CourseEnrollmentFactory,
SuperuserFactory,
- UserFactory
+ UserFactory,
)
from common.djangoapps.util.testing import UrlResetMixin
from lms.djangoapps.discussion.django_comment_client.tests.utils import (
@@ -48,21 +47,57 @@
make_minimal_cs_comment,
make_minimal_cs_thread,
)
+from lms.djangoapps.discussion.rest_api.serializers import (
+ BulkDeleteBanRequestSerializer,
+)
+from lms.djangoapps.discussion.rest_api.utils import get_usernames_from_search_string
+from lms.djangoapps.discussion.rest_api.views import DiscussionModerationViewSet
+from lms.djangoapps.discussion.toggles import ENABLE_DISCUSSIONS_MFE
from openedx.core.djangoapps.course_groups.tests.helpers import config_course_cohorts
-from openedx.core.djangoapps.discussions.config.waffle import ENABLE_NEW_STRUCTURE_DISCUSSIONS
-from openedx.core.djangoapps.discussions.models import DiscussionsConfiguration, DiscussionTopicLink, Provider
-from openedx.core.djangoapps.discussions.tasks import update_discussions_settings_from_course_task
+from openedx.core.djangoapps.discussions.config.waffle import (
+ ENABLE_NEW_STRUCTURE_DISCUSSIONS,
+)
+from openedx.core.djangoapps.discussions.models import (
+ DiscussionsConfiguration,
+ DiscussionTopicLink,
+ Provider,
+)
+from openedx.core.djangoapps.discussions.tasks import (
+ update_discussions_settings_from_course_task,
+)
from openedx.core.djangoapps.django_comment_common.models import (
CourseDiscussionSettings,
Role,
)
from openedx.core.djangoapps.django_comment_common.utils import seed_permissions_roles
from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user
-from openedx.core.djangoapps.oauth_dispatch.tests.factories import AccessTokenFactory, ApplicationFactory
-from openedx.core.djangoapps.user_api.models import RetirementState, UserRetirementStatus
+from openedx.core.djangoapps.oauth_dispatch.tests.factories import (
+ AccessTokenFactory,
+ ApplicationFactory,
+)
+from openedx.core.djangoapps.user_api.models import (
+ RetirementState,
+ UserRetirementStatus,
+)
+from openedx.core.djangoapps.django_comment_common.comment_client.utils import (
+ CommentClientRequestError,
+)
+from xmodule.modulestore import ModuleStoreEnum
+from xmodule.modulestore.django import modulestore
+from xmodule.modulestore.tests.django_utils import (
+ ModuleStoreTestCase,
+ SharedModuleStoreTestCase,
+)
+from xmodule.modulestore.tests.factories import (
+ BlockFactory,
+ CourseFactory,
+ check_mongo_calls,
+)
-class DiscussionAPIViewTestMixin(ForumsEnableMixin, CommentsServiceMockMixin, UrlResetMixin):
+class DiscussionAPIViewTestMixin(
+ ForumsEnableMixin, CommentsServiceMockMixin, UrlResetMixin
+):
"""
Mixin for common code in tests of Discussion API views. This includes
creation of common structures (e.g. a course, user, and enrollment), logging
@@ -72,7 +107,9 @@ class DiscussionAPIViewTestMixin(ForumsEnableMixin, CommentsServiceMockMixin, Ur
client_class = APIClient
- @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
+ @mock.patch.dict(
+ "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}
+ )
def setUp(self):
super().setUp()
self.maxDiff = None # pylint: disable=invalid-name
@@ -81,7 +118,7 @@ def setUp(self):
course="y",
run="z",
start=datetime.now(UTC),
- discussion_topics={"Test Topic": {"id": "test_topic"}}
+ discussion_topics={"Test Topic": {"id": "test_topic"}},
)
self.password = "Password1234"
self.user = UserFactory.create(password=self.password)
@@ -96,23 +133,25 @@ def assert_response_correct(self, response, expected_status, expected_content):
Assert that the response has the given status code and parsed content
"""
assert response.status_code == expected_status
- parsed_content = json.loads(response.content.decode('utf-8'))
+ parsed_content = json.loads(response.content.decode("utf-8"))
assert parsed_content == expected_content
def register_thread(self, overrides=None):
"""
Create cs_thread with minimal fields and register response
"""
- cs_thread = make_minimal_cs_thread({
- "id": "test_thread",
- "course_id": str(self.course.id),
- "commentable_id": "test_topic",
- "username": self.user.username,
- "user_id": str(self.user.id),
- "thread_type": "discussion",
- "title": "Test Title",
- "body": "Test body",
- })
+ cs_thread = make_minimal_cs_thread(
+ {
+ "id": "test_thread",
+ "course_id": str(self.course.id),
+ "commentable_id": "test_topic",
+ "username": self.user.username,
+ "user_id": str(self.user.id),
+ "thread_type": "discussion",
+ "title": "Test Title",
+ "body": "Test body",
+ }
+ )
cs_thread.update(overrides or {})
self.register_get_thread_response(cs_thread)
self.register_put_thread_response(cs_thread)
@@ -121,14 +160,16 @@ def register_comment(self, overrides=None):
"""
Create cs_comment with minimal fields and register response
"""
- cs_comment = make_minimal_cs_comment({
- "id": "test_comment",
- "course_id": str(self.course.id),
- "thread_id": "test_thread",
- "username": self.user.username,
- "user_id": str(self.user.id),
- "body": "Original body",
- })
+ cs_comment = make_minimal_cs_comment(
+ {
+ "id": "test_comment",
+ "course_id": str(self.course.id),
+ "thread_id": "test_thread",
+ "username": self.user.username,
+ "user_id": str(self.user.id),
+ "body": "Original body",
+ }
+ )
cs_comment.update(overrides or {})
self.register_get_comment_response(cs_comment)
self.register_put_comment_response(cs_comment)
@@ -140,7 +181,7 @@ def test_not_authenticated(self):
self.assert_response_correct(
response,
401,
- {"developer_message": "Authentication credentials were not provided."}
+ {"developer_message": "Authentication credentials were not provided."},
)
def test_inactive(self):
@@ -149,12 +190,16 @@ def test_inactive(self):
@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
-class UploadFileViewTest(ForumsEnableMixin, CommentsServiceMockMixin, UrlResetMixin, ModuleStoreTestCase):
+class UploadFileViewTest(
+ ForumsEnableMixin, CommentsServiceMockMixin, UrlResetMixin, ModuleStoreTestCase
+):
"""
Tests for UploadFileView.
"""
- @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
+ @mock.patch.dict(
+ "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}
+ )
def setUp(self):
super().setUp()
self.valid_file = {
@@ -165,11 +210,13 @@ def setUp(self):
),
}
self.user = UserFactory.create(password=self.TEST_PASSWORD)
- self.course = CourseFactory.create(org='a', course='b', run='c', start=datetime.now(UTC))
+ self.course = CourseFactory.create(
+ org="a", course="b", run="c", start=datetime.now(UTC)
+ )
self.url = reverse("upload_file", kwargs={"course_id": str(self.course.id)})
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -257,10 +304,13 @@ def test_file_upload_with_thread_key(self):
"""
self.user_login()
self.enroll_user_in_course()
- response = self.client.post(self.url, {
- **self.valid_file,
- "thread_key": "somethread",
- })
+ response = self.client.post(
+ self.url,
+ {
+ **self.valid_file,
+ "thread_key": "somethread",
+ },
+ )
response_data = json.loads(response.content)
assert "/somethread/" in response_data["location"]
@@ -314,7 +364,9 @@ class CommentViewSetListByUserTest(
Common test cases for views retrieving user-published content.
"""
- @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
+ @mock.patch.dict(
+ "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}
+ )
def setUp(self):
super().setUp()
@@ -323,8 +375,8 @@ def setUp(self):
self.addCleanup(httpretty.reset)
self.addCleanup(httpretty.disable)
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -335,7 +387,9 @@ def setUp(self):
self.other_user = UserFactory.create(password=self.TEST_PASSWORD)
self.register_get_user_response(self.other_user)
- self.course = CourseFactory.create(org="a", course="b", run="c", start=datetime.now(UTC))
+ self.course = CourseFactory.create(
+ org="a", course="b", run="c", start=datetime.now(UTC)
+ )
CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id)
self.url = self.build_url(self.user.username, self.course.id)
@@ -346,16 +400,18 @@ def register_mock_endpoints(self):
"""
self.register_get_threads_response(
threads=[
- make_minimal_cs_thread({
- "id": f"test_thread_{index}",
- "course_id": str(self.course.id),
- "commentable_id": f"test_topic_{index}",
- "username": self.user.username,
- "user_id": str(self.user.id),
- "thread_type": "discussion",
- "title": f"Test Title #{index}",
- "body": f"Test body #{index}",
- })
+ make_minimal_cs_thread(
+ {
+ "id": f"test_thread_{index}",
+ "course_id": str(self.course.id),
+ "commentable_id": f"test_topic_{index}",
+ "username": self.user.username,
+ "user_id": str(self.user.id),
+ "thread_type": "discussion",
+ "title": f"Test Title #{index}",
+ "body": f"Test body #{index}",
+ }
+ )
for index in range(30)
],
page=1,
@@ -363,16 +419,18 @@ def register_mock_endpoints(self):
)
self.register_get_comments_response(
comments=[
- make_minimal_cs_comment({
- "id": f"test_comment_{index}",
- "thread_id": "test_thread",
- "user_id": str(self.user.id),
- "username": self.user.username,
- "created_at": "2015-05-11T00:00:00Z",
- "updated_at": "2015-05-11T11:11:11Z",
- "body": f"Test body #{index}",
- "votes": {"up_count": 4},
- })
+ make_minimal_cs_comment(
+ {
+ "id": f"test_comment_{index}",
+ "thread_id": "test_thread",
+ "user_id": str(self.user.id),
+ "username": self.user.username,
+ "created_at": "2015-05-11T00:00:00Z",
+ "updated_at": "2015-05-11T11:11:11Z",
+ "body": f"Test body #{index}",
+ "votes": {"up_count": 4},
+ }
+ )
for index in range(30)
],
page=1,
@@ -384,11 +442,13 @@ def build_url(self, username, course_id, **kwargs):
Builds an URL to access content from an user on a specific course.
"""
base = reverse("comment-list")
- query = urlencode({
- "username": username,
- "course_id": str(course_id),
- **kwargs,
- })
+ query = urlencode(
+ {
+ "username": username,
+ "course_id": str(course_id),
+ **kwargs,
+ }
+ )
return f"{base}?{query}"
def assert_successful_response(self, response):
@@ -414,7 +474,9 @@ def test_request_by_unauthorized_user(self):
they're not either enrolled or staff members.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
response = self.client.get(self.url)
assert response.status_code == status.HTTP_404_NOT_FOUND
assert json.loads(response.content)["developer_message"] == "Course not found."
@@ -425,7 +487,9 @@ def test_request_by_enrolled_user(self):
comments in that course.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
CourseEnrollmentFactory.create(user=self.other_user, course_id=self.course.id)
self.assert_successful_response(self.client.get(self.url))
@@ -434,7 +498,9 @@ def test_request_by_global_staff(self):
Staff users are allowed to get any user's comments.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
GlobalStaff().add_users(self.other_user)
self.assert_successful_response(self.client.get(self.url))
@@ -445,7 +511,9 @@ def test_request_by_course_staff(self, role):
course.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
role(course_key=self.course.id).add_users(self.other_user)
self.assert_successful_response(self.client.get(self.url))
@@ -454,7 +522,9 @@ def test_request_with_non_existent_user(self):
Requests for users that don't exist result in a 404 response.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
GlobalStaff().add_users(self.other_user)
url = self.build_url("non_existent", self.course.id)
response = self.client.get(url)
@@ -465,7 +535,9 @@ def test_request_with_non_existent_course(self):
Requests for courses that don't exist result in a 404 response.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
GlobalStaff().add_users(self.other_user)
url = self.build_url(self.user.username, "course-v1:x+y+z")
response = self.client.get(url)
@@ -476,14 +548,18 @@ def test_request_with_invalid_course_id(self):
Requests with invalid course ID should fail form validation.
"""
self.register_mock_endpoints()
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
GlobalStaff().add_users(self.other_user)
url = self.build_url(self.user.username, "an invalid course")
response = self.client.get(url)
assert response.status_code == status.HTTP_400_BAD_REQUEST
parsed_response = json.loads(response.content)
- assert parsed_response["field_errors"]["course_id"]["developer_message"] == \
- "'an invalid course' is not a valid course id"
+ assert (
+ parsed_response["field_errors"]["course_id"]["developer_message"]
+ == "'an invalid course' is not a valid course id"
+ )
def test_request_with_empty_results_page(self):
"""
@@ -493,7 +569,9 @@ def test_request_with_empty_results_page(self):
self.register_get_threads_response(threads=[], page=1, num_pages=1)
self.register_get_comments_response(comments=[], page=1, num_pages=1)
- self.client.login(username=self.other_user.username, password=self.TEST_PASSWORD)
+ self.client.login(
+ username=self.other_user.username, password=self.TEST_PASSWORD
+ )
GlobalStaff().add_users(self.other_user)
url = self.build_url(self.user.username, self.course.id, page=2)
response = self.client.get(url)
@@ -501,17 +579,23 @@ def test_request_with_empty_results_page(self):
@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
-@override_settings(DISCUSSION_MODERATION_EDIT_REASON_CODES={"test-edit-reason": "Test Edit Reason"})
-@override_settings(DISCUSSION_MODERATION_CLOSE_REASON_CODES={"test-close-reason": "Test Close Reason"})
+@override_settings(
+ DISCUSSION_MODERATION_EDIT_REASON_CODES={"test-edit-reason": "Test Edit Reason"}
+)
+@override_settings(
+ DISCUSSION_MODERATION_CLOSE_REASON_CODES={"test-close-reason": "Test Close Reason"}
+)
class CourseViewTest(DiscussionAPIViewTestMixin, ModuleStoreTestCase):
"""Tests for CourseView"""
def setUp(self):
super().setUp()
- self.url = reverse("discussion_course", kwargs={"course_id": str(self.course.id)})
+ self.url = reverse(
+ "discussion_course", kwargs={"course_id": str(self.course.id)}
+ )
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -521,9 +605,7 @@ def test_404(self):
reverse("course_topics", kwargs={"course_id": "non/existent/course"})
)
self.assert_response_correct(
- response,
- 404,
- {"developer_message": "Course not found."}
+ response, 404, {"developer_message": "Course not found."}
)
def test_basic(self):
@@ -534,6 +616,7 @@ def test_basic(self):
{
"id": str(self.course.id),
"is_posting_enabled": True,
+ "is_user_banned": False,
"blackouts": [],
"thread_list_url": "http://testserver/api/discussion/v1/threads/?course_id=course-v1%3Ax%2By%2Bz",
"following_thread_list_url": (
@@ -547,23 +630,28 @@ def test_basic(self):
"allow_anonymous_to_peers": False,
"has_bulk_delete_privileges": False,
"has_moderation_privileges": False,
- 'is_course_admin': False,
- 'is_course_staff': False,
+ "is_course_admin": False,
+ "is_course_staff": False,
"is_group_ta": False,
- 'is_user_admin': False,
+ "is_user_admin": False,
"user_roles": ["Student"],
- "edit_reasons": [{"code": "test-edit-reason", "label": "Test Edit Reason"}],
- "post_close_reasons": [{"code": "test-close-reason", "label": "Test Close Reason"}],
- 'show_discussions': True,
- 'is_notify_all_learners_enabled': False,
- 'captcha_settings': {
- 'enabled': False,
- 'site_key': None,
+ "edit_reasons": [
+ {"code": "test-edit-reason", "label": "Test Edit Reason"}
+ ],
+ "post_close_reasons": [
+ {"code": "test-close-reason", "label": "Test Close Reason"}
+ ],
+ "show_discussions": True,
+ "is_notify_all_learners_enabled": False,
+ "captcha_settings": {
+ "enabled": False,
+ "site_key": None,
},
"is_email_verified": True,
"only_verified_users_can_post": False,
- "content_creation_rate_limited": False
- }
+ "content_creation_rate_limited": False,
+ "enable_discussion_ban": False,
+ },
)
@@ -574,8 +662,10 @@ class RetireViewTest(DiscussionAPIViewTestMixin, ModuleStoreTestCase):
def setUp(self):
super().setUp()
- RetirementState.objects.create(state_name='PENDING', state_execution_order=1)
- self.retire_forums_state = RetirementState.objects.create(state_name='RETIRE_FORUMS', state_execution_order=11)
+ RetirementState.objects.create(state_name="PENDING", state_execution_order=1)
+ self.retire_forums_state = RetirementState.objects.create(
+ state_name="RETIRE_FORUMS", state_execution_order=11
+ )
self.retirement = UserRetirementStatus.create_retirement(self.user)
self.retirement.current_state = self.retire_forums_state
@@ -586,8 +676,8 @@ def setUp(self):
self.retired_username = get_retired_username_by_username(self.user.username)
self.url = reverse("retire_discussion_user")
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -599,14 +689,14 @@ def assert_response_correct(self, response, expected_status, expected_content):
assert response.status_code == expected_status
if expected_content:
- assert response.content.decode('utf-8') == expected_content
+ assert response.content.decode("utf-8") == expected_content
def build_jwt_headers(self, user):
"""
Helper function for creating headers for the JWT authentication.
"""
token = create_jwt_for_user(user)
- headers = {'HTTP_AUTHORIZATION': 'JWT ' + token}
+ headers = {"HTTP_AUTHORIZATION": "JWT " + token}
return headers
def test_basic(self):
@@ -615,7 +705,7 @@ def test_basic(self):
"""
self.register_get_user_retire_response(self.user)
headers = self.build_jwt_headers(self.superuser)
- data = {'username': self.user.username}
+ data = {"username": self.user.username}
response = self.superuser_client.post(self.url, data, **headers)
self.assert_response_correct(response, 204, b"")
@@ -623,9 +713,11 @@ def test_downstream_forums_error(self):
"""
Check that we bubble up errors from the comments service
"""
- self.register_get_user_retire_response(self.user, status=500, body="Server error")
+ self.register_get_user_retire_response(
+ self.user, status=500, body="Server error"
+ )
headers = self.build_jwt_headers(self.superuser)
- data = {'username': self.user.username}
+ data = {"username": self.user.username}
response = self.superuser_client.post(self.url, data, **headers)
self.assert_response_correct(response, 500, '"Server error"')
@@ -635,7 +727,7 @@ def test_nonexistent_user(self):
"""
nonexistent_username = "nonexistent user"
self.retired_username = get_retired_username_by_username(nonexistent_username)
- data = {'username': nonexistent_username}
+ data = {"username": nonexistent_username}
headers = self.build_jwt_headers(self.superuser)
response = self.superuser_client.post(self.url, data, **headers)
self.assert_response_correct(response, 404, None)
@@ -649,7 +741,10 @@ def test_not_authenticated(self):
@ddt.ddt
@httpretty.activate
-@mock.patch('django.conf.settings.USERNAME_REPLACEMENT_WORKER', 'test_replace_username_service_worker')
+@mock.patch(
+ "django.conf.settings.USERNAME_REPLACEMENT_WORKER",
+ "test_replace_username_service_worker",
+)
@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
class ReplaceUsernamesViewTest(DiscussionAPIViewTestMixin, ModuleStoreTestCase):
"""Tests for ReplaceUsernamesView"""
@@ -662,8 +757,8 @@ def setUp(self):
self.new_username = "test_username_replacement"
self.url = reverse("replace_discussion_username")
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -682,34 +777,28 @@ def build_jwt_headers(self, user):
Helper function for creating headers for the JWT authentication.
"""
token = create_jwt_for_user(user)
- headers = {'HTTP_AUTHORIZATION': 'JWT ' + token}
+ headers = {"HTTP_AUTHORIZATION": "JWT " + token}
return headers
def call_api(self, user, client, data):
- """ Helper function to call API with data """
+ """Helper function to call API with data"""
data = json.dumps(data)
headers = self.build_jwt_headers(user)
- return client.post(self.url, data, content_type='application/json', **headers)
+ return client.post(self.url, data, content_type="application/json", **headers)
- @ddt.data(
- [{}, {}],
- {},
- [{"test_key": "test_value", "test_key_2": "test_value_2"}]
- )
+ @ddt.data([{}, {}], {}, [{"test_key": "test_value", "test_key_2": "test_value_2"}])
def test_bad_schema(self, mapping_data):
- """ Verify the endpoint rejects bad data schema """
- data = {
- "username_mappings": mapping_data
- }
+ """Verify the endpoint rejects bad data schema"""
+ data = {"username_mappings": mapping_data}
response = self.call_api(self.worker, self.worker_client, data)
assert response.status_code == 400
def test_auth(self):
- """ Verify the endpoint only works with the service worker """
+ """Verify the endpoint only works with the service worker"""
data = {
"username_mappings": [
{"test_username_1": "test_new_username_1"},
- {"test_username_2": "test_new_username_2"}
+ {"test_username_2": "test_new_username_2"},
]
}
@@ -727,15 +816,15 @@ def test_auth(self):
assert response.status_code == 200
def test_basic(self):
- """ Check successful replacement """
+ """Check successful replacement"""
data = {
"username_mappings": [
{self.user.username: self.new_username},
]
}
expected_response = {
- 'failed_replacements': [],
- 'successful_replacements': data["username_mappings"]
+ "failed_replacements": [],
+ "successful_replacements": data["username_mappings"],
}
self.register_get_username_replacement_response(self.user)
response = self.call_api(self.worker, self.worker_client, data)
@@ -751,7 +840,9 @@ def test_not_authenticated(self):
@ddt.ddt
@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
-class CourseTopicsViewTest(DiscussionAPIViewTestMixin, CommentsServiceMockMixin, ModuleStoreTestCase):
+class CourseTopicsViewTest(
+ DiscussionAPIViewTestMixin, CommentsServiceMockMixin, ModuleStoreTestCase
+):
"""
Tests for CourseTopicsView
"""
@@ -768,10 +859,12 @@ def setUp(self):
"courseware-2": {"discussion": 4, "question": 5},
"courseware-3": {"discussion": 7, "question": 2},
}
- self.register_get_course_commentable_counts_response(self.course.id, self.thread_counts_map)
+ self.register_get_course_commentable_counts_response(
+ self.course.id, self.thread_counts_map
+ )
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -786,7 +879,7 @@ def create_course(self, blocks_count, module_store, topics):
run="c",
start=datetime.now(UTC),
default_store=module_store,
- discussion_topics=topics
+ discussion_topics=topics,
)
CourseEnrollmentFactory.create(user=self.user, course_id=course.id)
course_url = reverse("course_topics", kwargs={"course_id": str(course.id)})
@@ -794,10 +887,10 @@ def create_course(self, blocks_count, module_store, topics):
for i in range(blocks_count):
BlockFactory.create(
parent_location=course.location,
- category='discussion',
- discussion_id=f'id_module_{i}',
- discussion_category=f'Category {i}',
- discussion_target=f'Discussion {i}',
+ category="discussion",
+ discussion_id=f"id_module_{i}",
+ discussion_category=f"Category {i}",
+ discussion_target=f"Discussion {i}",
publish_item=False,
)
return course_url, course.id
@@ -812,7 +905,7 @@ def make_discussion_xblock(self, topic_id, category, subcategory, **kwargs):
discussion_id=topic_id,
discussion_category=category,
discussion_target=subcategory,
- **kwargs
+ **kwargs,
)
def test_404(self):
@@ -820,9 +913,7 @@ def test_404(self):
reverse("course_topics", kwargs={"course_id": "non/existent/course"})
)
self.assert_response_correct(
- response,
- 404,
- {"developer_message": "Course not found."}
+ response, 404, {"developer_message": "Course not found."}
)
def test_basic(self):
@@ -832,21 +923,30 @@ def test_basic(self):
200,
{
"courseware_topics": [],
- "non_courseware_topics": [{
- "id": "test_topic",
- "name": "Test Topic",
- "children": [],
- "thread_list_url": 'http://testserver/api/discussion/v1/threads/'
- '?course_id=course-v1%3Ax%2By%2Bz&topic_id=test_topic',
- "thread_counts": {"discussion": 0, "question": 0},
- }],
- }
+ "non_courseware_topics": [
+ {
+ "id": "test_topic",
+ "name": "Test Topic",
+ "children": [],
+ "thread_list_url": "http://testserver/api/discussion/v1/threads/"
+ "?course_id=course-v1%3Ax%2By%2Bz&topic_id=test_topic",
+ "thread_counts": {"discussion": 0, "question": 0},
+ }
+ ],
+ },
)
@ddt.data(
(2, ModuleStoreEnum.Type.split, 2, {"Test Topic 1": {"id": "test_topic_1"}}),
- (2, ModuleStoreEnum.Type.split, 2,
- {"Test Topic 1": {"id": "test_topic_1"}, "Test Topic 2": {"id": "test_topic_2"}}),
+ (
+ 2,
+ ModuleStoreEnum.Type.split,
+ 2,
+ {
+ "Test Topic 1": {"id": "test_topic_1"},
+ "Test Topic 2": {"id": "test_topic_2"},
+ },
+ ),
(10, ModuleStoreEnum.Type.split, 2, {"Test Topic 1": {"id": "test_topic_1"}}),
)
@ddt.unpack
@@ -868,7 +968,7 @@ def test_discussion_topic_404(self):
self.assert_response_correct(
response,
404,
- {"developer_message": "Discussion not found for 'invalid_topic_id'."}
+ {"developer_message": "Discussion not found for 'invalid_topic_id'."},
)
def test_topic_id(self):
@@ -888,38 +988,41 @@ def test_topic_id(self):
"non_courseware_topics": [],
"courseware_topics": [
{
- "children": [{
- "children": [],
- "id": "topic_id_1",
- "thread_list_url": "http://testserver/api/discussion/v1/threads/?"
- "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_1",
- "name": "test_target_1",
- "thread_counts": {"discussion": 0, "question": 0},
- }],
+ "children": [
+ {
+ "children": [],
+ "id": "topic_id_1",
+ "thread_list_url": "http://testserver/api/discussion/v1/threads/?"
+ "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_1",
+ "name": "test_target_1",
+ "thread_counts": {"discussion": 0, "question": 0},
+ }
+ ],
"id": None,
"thread_list_url": "http://testserver/api/discussion/v1/threads/?"
- "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_1",
+ "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_1",
"name": "test_category_1",
"thread_counts": None,
},
{
- "children":
- [{
+ "children": [
+ {
"children": [],
"id": "topic_id_2",
"thread_list_url": "http://testserver/api/discussion/v1/threads/?"
- "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_2",
+ "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_2",
"name": "test_target_2",
"thread_counts": {"discussion": 0, "question": 0},
- }],
+ }
+ ],
"id": None,
"thread_list_url": "http://testserver/api/discussion/v1/threads/?"
- "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_2",
+ "course_id=course-v1%3Ax%2By%2Bz&topic_id=topic_id_2",
"name": "test_category_2",
"thread_counts": None,
- }
- ]
- }
+ },
+ ],
+ },
)
@override_waffle_flag(ENABLE_NEW_STRUCTURE_DISCUSSIONS, True)
@@ -930,45 +1033,46 @@ def test_new_course_structure_response(self):
"""
chapter = BlockFactory.create(
parent_location=self.course.location,
- category='chapter',
+ category="chapter",
display_name="Week 1",
start=datetime(2015, 3, 1, tzinfo=UTC),
)
sequential = BlockFactory.create(
parent_location=chapter.location,
- category='sequential',
+ category="sequential",
display_name="Lesson 1",
start=datetime(2015, 3, 1, tzinfo=UTC),
)
BlockFactory.create(
parent_location=sequential.location,
- category='vertical',
- display_name='vertical',
+ category="vertical",
+ display_name="vertical",
start=datetime(2015, 4, 1, tzinfo=UTC),
)
DiscussionsConfiguration.objects.create(
- context_key=self.course.id,
- provider_type=Provider.OPEN_EDX
+ context_key=self.course.id, provider_type=Provider.OPEN_EDX
)
update_discussions_settings_from_course_task(str(self.course.id))
response = json.loads(self.client.get(self.url).content.decode())
- keys = ['children', 'id', 'name', 'thread_counts', 'thread_list_url']
- assert list(response.keys()) == ['courseware_topics', 'non_courseware_topics']
- assert len(response['courseware_topics']) == 1
- courseware_keys = list(response['courseware_topics'][0].keys())
+ keys = ["children", "id", "name", "thread_counts", "thread_list_url"]
+ assert list(response.keys()) == ["courseware_topics", "non_courseware_topics"]
+ assert len(response["courseware_topics"]) == 1
+ courseware_keys = list(response["courseware_topics"][0].keys())
courseware_keys.sort()
assert courseware_keys == keys
- assert len(response['non_courseware_topics']) == 1
- non_courseware_keys = list(response['non_courseware_topics'][0].keys())
+ assert len(response["non_courseware_topics"]) == 1
+ non_courseware_keys = list(response["non_courseware_topics"][0].keys())
non_courseware_keys.sort()
assert non_courseware_keys == keys
@ddt.ddt
-@mock.patch('lms.djangoapps.discussion.rest_api.api._get_course', mock.Mock())
+@mock.patch("lms.djangoapps.discussion.rest_api.api._get_course", mock.Mock())
@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
@override_waffle_flag(ENABLE_NEW_STRUCTURE_DISCUSSIONS, True)
-class CourseTopicsViewV3Test(DiscussionAPIViewTestMixin, CommentsServiceMockMixin, ModuleStoreTestCase):
+class CourseTopicsViewV3Test(
+ DiscussionAPIViewTestMixin, CommentsServiceMockMixin, ModuleStoreTestCase
+):
"""
Tests for CourseTopicsViewV3
"""
@@ -984,55 +1088,68 @@ def setUp(self) -> None:
end=datetime(2028, 1, 1),
enrollment_start=datetime(2020, 1, 1),
enrollment_end=datetime(2028, 1, 1),
- discussion_topics={"Course Wide Topic": {
- "id": 'course-wide-topic',
- "usage_key": None,
- }}
+ discussion_topics={
+ "Course Wide Topic": {
+ "id": "course-wide-topic",
+ "usage_key": None,
+ }
+ },
)
self.chapter = BlockFactory.create(
parent_location=self.course.location,
- category='chapter',
+ category="chapter",
display_name="Week 1",
start=datetime(2015, 3, 1, tzinfo=UTC),
)
self.sequential = BlockFactory.create(
parent_location=self.chapter.location,
- category='sequential',
+ category="sequential",
display_name="Lesson 1",
start=datetime(2015, 3, 1, tzinfo=UTC),
)
self.verticals = [
BlockFactory.create(
parent_location=self.sequential.location,
- category='vertical',
- display_name='vertical',
+ category="vertical",
+ display_name="vertical",
start=datetime(2015, 4, 1, tzinfo=UTC),
)
]
course_key = self.course.id
- self.config = DiscussionsConfiguration.objects.create(context_key=course_key, provider_type=Provider.OPEN_EDX)
+ self.config = DiscussionsConfiguration.objects.create(
+ context_key=course_key, provider_type=Provider.OPEN_EDX
+ )
topic_links = []
update_discussions_settings_from_course_task(str(course_key))
- topic_id_query = DiscussionTopicLink.objects.filter(context_key=course_key).values_list(
- 'external_id', flat=True,
+ topic_id_query = DiscussionTopicLink.objects.filter(
+ context_key=course_key
+ ).values_list(
+ "external_id",
+ flat=True,
)
- topic_ids = list(topic_id_query.order_by('ordering'))
+ topic_ids = list(topic_id_query.order_by("ordering"))
DiscussionTopicLink.objects.bulk_create(topic_links)
self.topic_stats = {
- **{topic_id: dict(discussion=random.randint(0, 10), question=random.randint(0, 10))
- for topic_id in set(topic_ids)},
+ **{
+ topic_id: dict(
+ discussion=random.randint(0, 10), question=random.randint(0, 10)
+ )
+ for topic_id in set(topic_ids)
+ },
topic_ids[0]: dict(discussion=0, question=0),
}
patcher = mock.patch(
- 'lms.djangoapps.discussion.rest_api.api.get_course_commentable_counts',
+ "lms.djangoapps.discussion.rest_api.api.get_course_commentable_counts",
mock.Mock(return_value=self.topic_stats),
)
patcher.start()
self.addCleanup(patcher.stop)
- self.url = reverse("course_topics_v3", kwargs={"course_id": str(self.course.id)})
+ self.url = reverse(
+ "course_topics_v3", kwargs={"course_id": str(self.course.id)}
+ )
patcher = mock.patch(
- 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled',
- return_value=False
+ "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled",
+ return_value=False,
)
patcher.start()
self.addCleanup(patcher.stop)
@@ -1041,12 +1158,23 @@ def test_basic(self):
response = self.client.get(self.url)
data = json.loads(response.content.decode())
expected_non_courseware_keys = [
- 'id', 'usage_key', 'name', 'thread_counts', 'enabled_in_context',
- 'courseware'
+ "id",
+ "usage_key",
+ "name",
+ "thread_counts",
+ "enabled_in_context",
+ "courseware",
]
expected_courseware_keys = [
- 'id', 'block_id', 'lms_web_url', 'legacy_web_url', 'student_view_url',
- 'type', 'display_name', 'children', 'courseware'
+ "id",
+ "block_id",
+ "lms_web_url",
+ "legacy_web_url",
+ "student_view_url",
+ "type",
+ "display_name",
+ "children",
+ "courseware",
]
assert response.status_code == 200
assert len(data) == 2
@@ -1054,11 +1182,11 @@ def test_basic(self):
assert non_courseware_topic_keys == expected_non_courseware_keys
courseware_topic_keys = list(data[1].keys())
assert courseware_topic_keys == expected_courseware_keys
- expected_courseware_keys.remove('courseware')
- sequential_keys = list(data[1]['children'][0].keys())
- assert sequential_keys == (expected_courseware_keys + ['thread_counts'])
- expected_non_courseware_keys.remove('courseware')
- vertical_keys = list(data[1]['children'][0]['children'][0].keys())
+ expected_courseware_keys.remove("courseware")
+ sequential_keys = list(data[1]["children"][0].keys())
+ assert sequential_keys == (expected_courseware_keys + ["thread_counts"])
+ expected_non_courseware_keys.remove("courseware")
+ vertical_keys = list(data[1]["children"][0]["children"][0].keys())
assert vertical_keys == expected_non_courseware_keys
@@ -1095,53 +1223,70 @@ def setUp(self):
{"key": "author", "value": self.author.username},
{"key": "abuse_flagged", "value": False},
{"key": "author_label", "value": None},
+ {"key": "is_author_banned", "value": False},
+ {"key": "author_ban_scope", "value": None},
{"key": "can_delete", "value": True},
{"key": "close_reason", "value": None},
{
"key": "comment_list_url",
- "value": "http://testserver/api/discussion/v1/comments/?thread_id=test_thread"
+ "value": "http://testserver/api/discussion/v1/comments/?thread_id=test_thread",
},
{
"key": "editable_fields",
"value": [
- 'abuse_flagged', 'anonymous', 'copy_link', 'following', 'raw_body',
- 'read', 'title', 'topic_id', 'type'
- ]
+ "abuse_flagged",
+ "anonymous",
+ "copy_link",
+ "following",
+ "raw_body",
+ "read",
+ "title",
+ "topic_id",
+ "type",
+ ],
},
{"key": "endorsed_comment_list_url", "value": None},
{"key": "following", "value": False},
{"key": "group_name", "value": None},
{"key": "has_endorsed", "value": False},
{"key": "last_edit", "value": None},
+ {"key": "learner_status", "value": "new"},
{"key": "non_endorsed_comment_list_url", "value": None},
{"key": "preview_body", "value": "Test body"},
{"key": "raw_body", "value": "Test body"},
-
{"key": "rendered_body", "value": "Test body
"}, {"key": "response_count", "value": 0}, {"key": "topic_id", "value": "test_topic"}, {"key": "type", "value": "discussion"}, - {"key": "users", "value": { - self.user.username: { - "profile": { - "image": { - "has_image": False, - "image_url_full": "http://testserver/static/default_500.png", - "image_url_large": "http://testserver/static/default_120.png", - "image_url_medium": "http://testserver/static/default_50.png", - "image_url_small": "http://testserver/static/default_30.png", + { + "key": "users", + "value": { + self.user.username: { + "profile": { + "image": { + "has_image": False, + "image_url_full": "http://testserver/static/default_500.png", + "image_url_large": "http://testserver/static/default_120.png", + "image_url_medium": "http://testserver/static/default_50.png", + "image_url_small": "http://testserver/static/default_30.png", + } } } - } - }}, + }, + }, {"key": "vote_count", "value": 4}, {"key": "voted", "value": False}, - + {"key": "is_deleted", "value": False}, + {"key": "deleted_at", "value": None}, + {"key": "deleted_by", "value": None}, + {"key": "deleted_by_label", "value": None}, ] - self.url = reverse("discussion_learner_threads", kwargs={'course_id': str(self.course.id)}) + self.url = reverse( + "discussion_learner_threads", kwargs={"course_id": str(self.course.id)} + ) patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) @@ -1152,12 +1297,12 @@ def update_thread(self, thread): Value of these keys has been defined in setUp function """ for element in self.add_keys: - thread[element['key']] = element['value'] + thread[element["key"]] = element["value"] for pair in self.replace_keys: - thread[pair['to']] = thread.pop(pair['from']) + thread[pair["to"]] = thread.pop(pair["from"]) for key in self.remove_keys: thread.pop(key) - thread['comment_count'] += 1 + thread["comment_count"] += 1 return thread def test_basic(self): @@ -1169,22 +1314,26 @@ def test_basic(self): """ self.register_get_user_response(self.user) expected_cs_comments_response = { - "collection": [make_minimal_cs_thread({ - "id": "test_thread", - "course_id": str(self.course.id), - "commentable_id": "test_topic", - "user_id": str(self.user.id), - "username": self.user.username, - "created_at": "2015-04-28T00:00:00Z", - "updated_at": "2015-04-28T11:11:11Z", - "title": "Test Title", - "body": "Test body", - "votes": {"up_count": 4}, - "comments_count": 5, - "unread_comments_count": 3, - "closed_by_label": None, - "edit_by_label": None, - })], + "collection": [ + make_minimal_cs_thread( + { + "id": "test_thread", + "course_id": str(self.course.id), + "commentable_id": "test_topic", + "user_id": str(self.user.id), + "username": self.user.username, + "created_at": "2015-04-28T00:00:00Z", + "updated_at": "2015-04-28T11:11:11Z", + "title": "Test Title", + "body": "Test body", + "votes": {"up_count": 4}, + "comments_count": 5, + "unread_comments_count": 3, + "closed_by_label": None, + "edit_by_label": None, + } + ) + ], "page": 1, "num_pages": 1, } @@ -1192,14 +1341,14 @@ def test_basic(self): self.url += f"?username={self.user.username}" response = self.client.get(self.url) assert response.status_code == 200 - response_data = json.loads(response.content.decode('utf-8')) - expected_api_response = expected_cs_comments_response['collection'] + response_data = json.loads(response.content.decode("utf-8")) + expected_api_response = expected_cs_comments_response["collection"] for thread in expected_api_response: self.update_thread(thread) - assert response_data['results'] == expected_api_response - assert response_data['pagination'] == { + assert response_data["results"] == expected_api_response + assert response_data["pagination"] == { "next": None, "previous": None, "count": 1, @@ -1229,20 +1378,24 @@ def test_thread_type_by(self, thread_type): thread_type (str): Value of thread_type can be 'None', 'discussion' and 'question' """ - threads = [make_minimal_cs_thread({ - "id": "test_thread", - "course_id": str(self.course.id), - "commentable_id": "test_topic", - "user_id": str(self.user.id), - "username": self.user.username, - "created_at": "2015-04-28T00:00:00Z", - "updated_at": "2015-04-28T11:11:11Z", - "title": "Test Title", - "body": "Test body", - "votes": {"up_count": 4}, - "comments_count": 5, - "unread_comments_count": 3, - })] + threads = [ + make_minimal_cs_thread( + { + "id": "test_thread", + "course_id": str(self.course.id), + "commentable_id": "test_topic", + "user_id": str(self.user.id), + "username": self.user.username, + "created_at": "2015-04-28T00:00:00Z", + "updated_at": "2015-04-28T11:11:11Z", + "title": "Test Title", + "body": "Test body", + "votes": {"up_count": 4}, + "comments_count": 5, + "unread_comments_count": 3, + } + ) + ] expected_cs_comments_response = { "collection": threads, "page": 1, @@ -1256,23 +1409,26 @@ def test_thread_type_by(self, thread_type): "course_id": str(self.course.id), "username": self.user.username, "thread_type": thread_type, - } + }, ) assert response.status_code == 200 - self.assert_last_query_params({ - "user_id": [str(self.user.id)], - "course_id": [str(self.course.id)], - "page": ["1"], - "per_page": ["10"], - "thread_type": [thread_type], - "sort_key": ['activity'], - "count_flagged": ["False"] - }) + self.assert_last_query_params( + { + "user_id": [str(self.user.id)], + "course_id": [str(self.course.id)], + "page": ["1"], + "per_page": ["10"], + "thread_type": [thread_type], + "sort_key": ["activity"], + "count_flagged": ["False"], + "show_deleted": ["False"], + } + ) @ddt.data( ("last_activity_at", "activity"), ("comment_count", "comments"), - ("vote_count", "votes") + ("vote_count", "votes"), ) @ddt.unpack def test_order_by(self, http_query, cc_query): @@ -1283,20 +1439,24 @@ def test_order_by(self, http_query, cc_query): http_query (str): Query string sent in the http request cc_query (str): Query string used for the comments client service """ - threads = [make_minimal_cs_thread({ - "id": "test_thread", - "course_id": str(self.course.id), - "commentable_id": "test_topic", - "user_id": str(self.user.id), - "username": self.user.username, - "created_at": "2015-04-28T00:00:00Z", - "updated_at": "2015-04-28T11:11:11Z", - "title": "Test Title", - "body": "Test body", - "votes": {"up_count": 4}, - "comments_count": 5, - "unread_comments_count": 3, - })] + threads = [ + make_minimal_cs_thread( + { + "id": "test_thread", + "course_id": str(self.course.id), + "commentable_id": "test_topic", + "user_id": str(self.user.id), + "username": self.user.username, + "created_at": "2015-04-28T00:00:00Z", + "updated_at": "2015-04-28T11:11:11Z", + "title": "Test Title", + "body": "Test body", + "votes": {"up_count": 4}, + "comments_count": 5, + "unread_comments_count": 3, + } + ) + ] expected_cs_comments_response = { "collection": threads, "page": 1, @@ -1310,17 +1470,20 @@ def test_order_by(self, http_query, cc_query): "course_id": str(self.course.id), "username": self.user.username, "order_by": http_query, - } + }, ) assert response.status_code == 200 - self.assert_last_query_params({ - "user_id": [str(self.user.id)], - "course_id": [str(self.course.id)], - "page": ["1"], - "per_page": ["10"], - "sort_key": [cc_query], - "count_flagged": ["False"] - }) + self.assert_last_query_params( + { + "user_id": [str(self.user.id)], + "course_id": [str(self.course.id)], + "page": ["1"], + "per_page": ["10"], + "sort_key": [cc_query], + "count_flagged": ["False"], + "show_deleted": ["False"], + } + ) @ddt.data("flagged", "unanswered", "unread", "unresponded") def test_status_by(self, post_status): @@ -1331,20 +1494,24 @@ def test_status_by(self, post_status): post_status (str): Value of post_status can be 'flagged', 'unanswered' and 'unread' """ - threads = [make_minimal_cs_thread({ - "id": "test_thread", - "course_id": str(self.course.id), - "commentable_id": "test_topic", - "user_id": str(self.user.id), - "username": self.user.username, - "created_at": "2015-04-28T00:00:00Z", - "updated_at": "2015-04-28T11:11:11Z", - "title": "Test Title", - "body": "Test body", - "votes": {"up_count": 4}, - "comments_count": 5, - "unread_comments_count": 3, - })] + threads = [ + make_minimal_cs_thread( + { + "id": "test_thread", + "course_id": str(self.course.id), + "commentable_id": "test_topic", + "user_id": str(self.user.id), + "username": self.user.username, + "created_at": "2015-04-28T00:00:00Z", + "updated_at": "2015-04-28T11:11:11Z", + "title": "Test Title", + "body": "Test body", + "votes": {"up_count": 4}, + "comments_count": 5, + "unread_comments_count": 3, + } + ) + ] expected_cs_comments_response = { "collection": threads, "page": 1, @@ -1358,29 +1525,37 @@ def test_status_by(self, post_status): "course_id": str(self.course.id), "username": self.user.username, "status": post_status, - } + }, ) if post_status == "flagged": assert response.status_code == 403 else: assert response.status_code == 200 - self.assert_last_query_params({ - "user_id": [str(self.user.id)], - "course_id": [str(self.course.id)], - "page": ["1"], - "per_page": ["10"], - post_status: ['True'], - "sort_key": ['activity'], - "count_flagged": ["False"] - }) + self.assert_last_query_params( + { + "user_id": [str(self.user.id)], + "course_id": [str(self.course.id)], + "page": ["1"], + "per_page": ["10"], + post_status: ["True"], + "sort_key": ["activity"], + "count_flagged": ["False"], + "show_deleted": ["False"], + } + ) @ddt.ddt -class CourseDiscussionSettingsAPIViewTest(APITestCase, UrlResetMixin, ModuleStoreTestCase): +class CourseDiscussionSettingsAPIViewTest( + APITestCase, UrlResetMixin, ModuleStoreTestCase +): """ Test the course discussion settings handler API endpoint. """ - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def setUp(self): super().setUp() self.course = CourseFactory.create( @@ -1388,24 +1563,26 @@ def setUp(self): course="y", run="z", start=datetime.now(UTC), - discussion_topics={"Test Topic": {"id": "test_topic"}} + discussion_topics={"Test Topic": {"id": "test_topic"}}, + ) + self.path = reverse( + "discussion_course_settings", kwargs={"course_id": str(self.course.id)} ) - self.path = reverse('discussion_course_settings', kwargs={'course_id': str(self.course.id)}) self.password = self.TEST_PASSWORD - self.user = UserFactory(username='staff', password=self.password, is_staff=True) + self.user = UserFactory(username="staff", password=self.password, is_staff=True) patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) def _get_oauth_headers(self, user): """Return the OAuth headers for testing OAuth authentication""" - access_token = AccessTokenFactory.create(user=user, application=ApplicationFactory()).token - headers = { - 'HTTP_AUTHORIZATION': 'Bearer ' + access_token - } + access_token = AccessTokenFactory.create( + user=user, application=ApplicationFactory() + ).token + headers = {"HTTP_AUTHORIZATION": "Bearer " + access_token} return headers def _login_as_staff(self): @@ -1413,24 +1590,30 @@ def _login_as_staff(self): self.client.login(username=self.user.username, password=self.password) def _login_as_discussion_staff(self): - user = UserFactory(username='abc', password='abc') - role = Role.objects.create(name='Administrator', course_id=self.course.id) + user = UserFactory(username="abc", password="abc") + role = Role.objects.create(name="Administrator", course_id=self.course.id) role.users.set([user]) - self.client.login(username=user.username, password='abc') + self.client.login(username=user.username, password="abc") def _create_divided_discussions(self): """Create some divided discussions for testing.""" - divided_inline_discussions = ['Topic A', ] - divided_course_wide_discussions = ['Topic B', ] - divided_discussions = divided_inline_discussions + divided_course_wide_discussions + divided_inline_discussions = [ + "Topic A", + ] + divided_course_wide_discussions = [ + "Topic B", + ] + divided_discussions = ( + divided_inline_discussions + divided_course_wide_discussions + ) BlockFactory.create( parent=self.course, - category='discussion', - discussion_id=topic_name_to_id(self.course, 'Topic A'), - discussion_category='Chapter', - discussion_target='Discussion', - start=datetime.now() + category="discussion", + discussion_id=topic_name_to_id(self.course, "Topic A"), + discussion_category="Chapter", + discussion_target="Discussion", + start=datetime.now(), ) discussion_topics = { "Topic B": {"id": "Topic B"}, @@ -1439,31 +1622,36 @@ def _create_divided_discussions(self): config_course_discussions( self.course, discussion_topics=discussion_topics, - divided_discussions=divided_discussions + divided_discussions=divided_discussions, ) return divided_inline_discussions, divided_course_wide_discussions def _get_expected_response(self): """Return the default expected response before any changes to the discussion settings.""" return { - 'always_divide_inline_discussions': False, - 'divided_inline_discussions': [], - 'divided_course_wide_discussions': [], - 'id': 1, - 'division_scheme': 'cohort', - 'available_division_schemes': ['cohort'], - 'reported_content_email_notifications': False, + "always_divide_inline_discussions": False, + "divided_inline_discussions": [], + "divided_course_wide_discussions": [], + "id": 1, + "division_scheme": "cohort", + "available_division_schemes": ["cohort"], + "reported_content_email_notifications": False, } def patch_request(self, data, headers=None): headers = headers if headers else {} - return self.client.patch(self.path, json.dumps(data), content_type='application/merge-patch+json', **headers) + return self.client.patch( + self.path, + json.dumps(data), + content_type="application/merge-patch+json", + **headers, + ) def _assert_current_settings(self, expected_response): """Validate the current discussion settings against the expected response.""" response = self.client.get(self.path) assert response.status_code == 200 - content = json.loads(response.content.decode('utf-8')) + content = json.loads(response.content.decode("utf-8")) assert content == expected_response def _assert_patched_settings(self, data, expected_response): @@ -1472,7 +1660,7 @@ def _assert_patched_settings(self, data, expected_response): assert response.status_code == 204 self._assert_current_settings(expected_response) - @ddt.data('get', 'patch') + @ddt.data("get", "patch") def test_authentication_required(self, method): """Test and verify that authentication is required for this endpoint.""" self.client.logout() @@ -1480,8 +1668,8 @@ def test_authentication_required(self, method): assert response.status_code == 401 @ddt.data( - {'is_staff': False, 'get_status': 403, 'put_status': 403}, - {'is_staff': True, 'get_status': 200, 'put_status': 204}, + {"is_staff": False, "get_status": 403, "put_status": 403}, + {"is_staff": True, "get_status": 200, "put_status": 204}, ) @ddt.unpack def test_oauth(self, is_staff, get_status, put_status): @@ -1494,7 +1682,7 @@ def test_oauth(self, is_staff, get_status, put_status): assert response.status_code == get_status response = self.patch_request( - {'always_divide_inline_discussions': True}, headers + {"always_divide_inline_discussions": True}, headers ) assert response.status_code == put_status @@ -1502,66 +1690,68 @@ def test_non_existent_course_id(self): """Test the response when this endpoint is passed a non-existent course id.""" self._login_as_staff() response = self.client.get( - reverse('discussion_course_settings', kwargs={ - 'course_id': 'course-v1:a+b+c' - }) + reverse( + "discussion_course_settings", kwargs={"course_id": "course-v1:a+b+c"} + ) ) assert response.status_code == 404 def test_patch_request_by_discussion_staff(self): """Test the response when patch request is sent by a user with discussions staff role.""" self._login_as_discussion_staff() - response = self.patch_request( - {'always_divide_inline_discussions': True} - ) + response = self.patch_request({"always_divide_inline_discussions": True}) assert response.status_code == 403 def test_get_request_by_discussion_staff(self): """Test the response when get request is sent by a user with discussions staff role.""" self._login_as_discussion_staff() - divided_inline_discussions, divided_course_wide_discussions = self._create_divided_discussions() + divided_inline_discussions, divided_course_wide_discussions = ( + self._create_divided_discussions() + ) response = self.client.get(self.path) assert response.status_code == 200 expected_response = self._get_expected_response() - expected_response['divided_course_wide_discussions'] = [ - topic_name_to_id(self.course, name) for name in divided_course_wide_discussions + expected_response["divided_course_wide_discussions"] = [ + topic_name_to_id(self.course, name) + for name in divided_course_wide_discussions ] - expected_response['divided_inline_discussions'] = [ + expected_response["divided_inline_discussions"] = [ topic_name_to_id(self.course, name) for name in divided_inline_discussions ] - content = json.loads(response.content.decode('utf-8')) + content = json.loads(response.content.decode("utf-8")) assert content == expected_response def test_get_request_by_non_staff_user(self): """Test the response when get request is sent by a regular user with no staff role.""" - user = UserFactory(username='abc', password='abc') - self.client.login(username=user.username, password='abc') + user = UserFactory(username="abc", password="abc") + self.client.login(username=user.username, password="abc") response = self.client.get(self.path) assert response.status_code == 403 def test_patch_request_by_non_staff_user(self): """Test the response when patch request is sent by a regular user with no staff role.""" - user = UserFactory(username='abc', password='abc') - self.client.login(username=user.username, password='abc') - response = self.patch_request( - {'always_divide_inline_discussions': True} - ) + user = UserFactory(username="abc", password="abc") + self.client.login(username=user.username, password="abc") + response = self.patch_request({"always_divide_inline_discussions": True}) assert response.status_code == 403 def test_get_settings(self): """Test the current discussion settings against the expected response.""" - divided_inline_discussions, divided_course_wide_discussions = self._create_divided_discussions() + divided_inline_discussions, divided_course_wide_discussions = ( + self._create_divided_discussions() + ) self._login_as_staff() response = self.client.get(self.path) assert response.status_code == 200 expected_response = self._get_expected_response() - expected_response['divided_course_wide_discussions'] = [ - topic_name_to_id(self.course, name) for name in divided_course_wide_discussions + expected_response["divided_course_wide_discussions"] = [ + topic_name_to_id(self.course, name) + for name in divided_course_wide_discussions ] - expected_response['divided_inline_discussions'] = [ + expected_response["divided_inline_discussions"] = [ topic_name_to_id(self.course, name) for name in divided_inline_discussions ] - content = json.loads(response.content.decode('utf-8')) + content = json.loads(response.content.decode("utf-8")) assert content == expected_response def test_available_schemes(self): @@ -1569,18 +1759,23 @@ def test_available_schemes(self): config_course_cohorts(self.course, is_cohorted=False) self._login_as_staff() expected_response = self._get_expected_response() - expected_response['available_division_schemes'] = [] + expected_response["available_division_schemes"] = [] self._assert_current_settings(expected_response) CourseModeFactory.create(course_id=self.course.id, mode_slug=CourseMode.AUDIT) - CourseModeFactory.create(course_id=self.course.id, mode_slug=CourseMode.VERIFIED) + CourseModeFactory.create( + course_id=self.course.id, mode_slug=CourseMode.VERIFIED + ) - expected_response['available_division_schemes'] = [CourseDiscussionSettings.ENROLLMENT_TRACK] + expected_response["available_division_schemes"] = [ + CourseDiscussionSettings.ENROLLMENT_TRACK + ] self._assert_current_settings(expected_response) config_course_cohorts(self.course, is_cohorted=True) - expected_response['available_division_schemes'] = [ - CourseDiscussionSettings.COHORT, CourseDiscussionSettings.ENROLLMENT_TRACK + expected_response["available_division_schemes"] = [ + CourseDiscussionSettings.COHORT, + CourseDiscussionSettings.ENROLLMENT_TRACK, ] self._assert_current_settings(expected_response) @@ -1594,11 +1789,11 @@ def test_empty_body_patch_request(self): assert response.status_code == 400 @ddt.data( - {'abc': 123}, - {'divided_course_wide_discussions': 3}, - {'divided_inline_discussions': 'a'}, - {'always_divide_inline_discussions': ['a']}, - {'division_scheme': True} + {"abc": 123}, + {"divided_course_wide_discussions": 3}, + {"divided_inline_discussions": "a"}, + {"always_divide_inline_discussions": ["a"]}, + {"division_scheme": True}, ) def test_invalid_body_parameters(self, body): """Test the response status code on sending a PATCH request with parameters having incorrect types.""" @@ -1612,31 +1807,34 @@ def test_update_always_divide_inline_discussion_settings(self): self._login_as_staff() expected_response = self._get_expected_response() self._assert_current_settings(expected_response) - expected_response['always_divide_inline_discussions'] = True + expected_response["always_divide_inline_discussions"] = True - self._assert_patched_settings({'always_divide_inline_discussions': True}, expected_response) + self._assert_patched_settings( + {"always_divide_inline_discussions": True}, expected_response + ) def test_update_course_wide_discussion_settings(self): """Test whether the 'divided_course_wide_discussions' setting is updated.""" - discussion_topics = { - 'Topic B': {'id': 'Topic B'} - } + discussion_topics = {"Topic B": {"id": "Topic B"}} config_course_cohorts(self.course, is_cohorted=True) config_course_discussions(self.course, discussion_topics=discussion_topics) expected_response = self._get_expected_response() self._login_as_staff() self._assert_current_settings(expected_response) - expected_response['divided_course_wide_discussions'] = [ + expected_response["divided_course_wide_discussions"] = [ topic_name_to_id(self.course, "Topic B") ] self._assert_patched_settings( - {'divided_course_wide_discussions': [topic_name_to_id(self.course, "Topic B")]}, - expected_response + { + "divided_course_wide_discussions": [ + topic_name_to_id(self.course, "Topic B") + ] + }, + expected_response, ) - expected_response['divided_course_wide_discussions'] = [] + expected_response["divided_course_wide_discussions"] = [] self._assert_patched_settings( - {'divided_course_wide_discussions': []}, - expected_response + {"divided_course_wide_discussions": []}, expected_response ) def test_update_inline_discussion_settings(self): @@ -1649,17 +1847,23 @@ def test_update_inline_discussion_settings(self): now = datetime.now() BlockFactory.create( parent_location=self.course.location, - category='discussion', - discussion_id='Topic_A', - discussion_category='Chapter', - discussion_target='Discussion', - start=now + category="discussion", + discussion_id="Topic_A", + discussion_category="Chapter", + discussion_target="Discussion", + start=now, + ) + expected_response["divided_inline_discussions"] = [ + "Topic_A", + ] + self._assert_patched_settings( + {"divided_inline_discussions": ["Topic_A"]}, expected_response ) - expected_response['divided_inline_discussions'] = ['Topic_A', ] - self._assert_patched_settings({'divided_inline_discussions': ['Topic_A']}, expected_response) - expected_response['divided_inline_discussions'] = [] - self._assert_patched_settings({'divided_inline_discussions': []}, expected_response) + expected_response["divided_inline_discussions"] = [] + self._assert_patched_settings( + {"divided_inline_discussions": []}, expected_response + ) def test_update_division_scheme(self): """Test whether the 'division_scheme' setting is updated.""" @@ -1667,15 +1871,17 @@ def test_update_division_scheme(self): self._login_as_staff() expected_response = self._get_expected_response() self._assert_current_settings(expected_response) - expected_response['division_scheme'] = 'none' - self._assert_patched_settings({'division_scheme': 'none'}, expected_response) + expected_response["division_scheme"] = "none" + self._assert_patched_settings({"division_scheme": "none"}, expected_response) def test_update_reported_content_email_notifications(self): """Test whether the 'reported_content_email_notifications' setting is updated.""" config_course_cohorts(self.course, is_cohorted=True) - config_course_discussions(self.course, reported_content_email_notifications=True) + config_course_discussions( + self.course, reported_content_email_notifications=True + ) expected_response = self._get_expected_response() - expected_response['reported_content_email_notifications'] = True + expected_response["reported_content_email_notifications"] = True self._login_as_staff() self._assert_current_settings(expected_response) @@ -1685,12 +1891,15 @@ class CourseDiscussionRolesAPIViewTest(APITestCase, UrlResetMixin, ModuleStoreTe """ Test the course discussion roles management endpoint. """ - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def setUp(self): super().setUp() patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) @@ -1701,26 +1910,27 @@ def setUp(self): start=datetime.now(UTC), ) self.password = self.TEST_PASSWORD - self.user = UserFactory(username='staff', password=self.password, is_staff=True) - course_key = CourseKey.from_string('course-v1:x+y+z') + self.user = UserFactory(username="staff", password=self.password, is_staff=True) + course_key = CourseKey.from_string("course-v1:x+y+z") seed_permissions_roles(course_key) - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def path(self, course_id=None, role=None): """Return the URL path to the endpoint based on the provided arguments.""" course_id = str(self.course.id) if course_id is None else course_id - role = 'Moderator' if role is None else role + role = "Moderator" if role is None else role return reverse( - 'discussion_course_roles', - kwargs={'course_id': course_id, 'rolename': role} + "discussion_course_roles", kwargs={"course_id": course_id, "rolename": role} ) def _get_oauth_headers(self, user): """Return the OAuth headers for testing OAuth authentication.""" - access_token = AccessTokenFactory.create(user=user, application=ApplicationFactory()).token - headers = { - 'HTTP_AUTHORIZATION': 'Bearer ' + access_token - } + access_token = AccessTokenFactory.create( + user=user, application=ApplicationFactory() + ).token + headers = {"HTTP_AUTHORIZATION": "Bearer " + access_token} return headers def _login_as_staff(self): @@ -1745,9 +1955,11 @@ def _add_users_to_role(self, users, rolename): def post(self, role, user_id, action): """Make a POST request to the endpoint using the provided parameters.""" self._login_as_staff() - return self.client.post(self.path(role=role), {'user_id': user_id, 'action': action}) + return self.client.post( + self.path(role=role), {"user_id": user_id, "action": action} + ) - @ddt.data('get', 'post') + @ddt.data("get", "post") def test_authentication_required(self, method): """Test and verify that authentication is required for this endpoint.""" self.client.logout() @@ -1760,29 +1972,31 @@ def test_oauth(self): self.client.logout() response = self.client.get(self.path(), **oauth_headers) assert response.status_code == 200 - body = {'user_id': 'staff', 'action': 'allow'} - response = self.client.post(self.path(), body, format='json', **oauth_headers) + body = {"user_id": "staff", "action": "allow"} + response = self.client.post(self.path(), body, format="json", **oauth_headers) assert response.status_code == 200 @ddt.data( - {'username': 'u1', 'is_staff': False, 'expected_status': 403}, - {'username': 'u2', 'is_staff': True, 'expected_status': 200}, + {"username": "u1", "is_staff": False, "expected_status": 403}, + {"username": "u2", "is_staff": True, "expected_status": 200}, ) @ddt.unpack def test_staff_permission_required(self, username, is_staff, expected_status): """Test and verify that only users with staff permission can access this endpoint.""" - UserFactory(username=username, password='edx', is_staff=is_staff) - self.client.login(username=username, password='edx') + UserFactory(username=username, password="edx", is_staff=is_staff) + self.client.login(username=username, password="edx") response = self.client.get(self.path()) assert response.status_code == expected_status - response = self.client.post(self.path(), {'user_id': username, 'action': 'allow'}, format='json') + response = self.client.post( + self.path(), {"user_id": username, "action": "allow"}, format="json" + ) assert response.status_code == expected_status def test_non_existent_course_id(self): """Test the response when the endpoint URL contains a non-existent course id.""" self._login_as_staff() - path = self.path(course_id='course-v1:a+b+c') + path = self.path(course_id="course-v1:a+b+c") response = self.client.get(path) assert response.status_code == 404 @@ -1793,7 +2007,7 @@ def test_non_existent_course_id(self): def test_non_existent_course_role(self): """Test the response when the endpoint URL contains a non-existent role.""" self._login_as_staff() - path = self.path(role='A') + path = self.path(role="A") response = self.client.get(path) assert response.status_code == 400 @@ -1802,10 +2016,10 @@ def test_non_existent_course_role(self): assert response.status_code == 400 @ddt.data( - {'role': 'Moderator', 'count': 0}, - {'role': 'Moderator', 'count': 1}, - {'role': 'Group Moderator', 'count': 2}, - {'role': 'Community TA', 'count': 3}, + {"role": "Moderator", "count": 0}, + {"role": "Moderator", "count": 1}, + {"role": "Group Moderator", "count": 2}, + {"role": "Community TA", "count": 3}, ) @ddt.unpack def test_get_role_members(self, role, count): @@ -1819,14 +2033,14 @@ def test_get_role_members(self, role, count): assert response.status_code == 200 - content = json.loads(response.content.decode('utf-8')) - assert content['course_id'] == 'course-v1:x+y+z' - assert len(content['results']) == count - expected_fields = ('username', 'email', 'first_name', 'last_name', 'group_name') - for item in content['results']: + content = json.loads(response.content.decode("utf-8")) + assert content["course_id"] == "course-v1:x+y+z" + assert len(content["results"]) == count + expected_fields = ("username", "email", "first_name", "last_name", "group_name") + for item in content["results"]: for expected_field in expected_fields: assert expected_field in item - assert content['division_scheme'] == 'cohort' + assert content["division_scheme"] == "cohort" def test_post_missing_body(self): """Test the response with a POST request without a body.""" @@ -1835,9 +2049,9 @@ def test_post_missing_body(self): assert response.status_code == 400 @ddt.data( - {'a': 1}, - {'user_id': 'xyz', 'action': 'allow'}, - {'user_id': 'staff', 'action': 123}, + {"a": 1}, + {"user_id": "xyz", "action": "allow"}, + {"user_id": "staff", "action": 123}, ) def test_missing_or_invalid_parameters(self, body): """ @@ -1848,82 +2062,100 @@ def test_missing_or_invalid_parameters(self, body): response = self.client.post(self.path(), body) assert response.status_code == 400 - response = self.client.post(self.path(), body, format='json') + response = self.client.post(self.path(), body, format="json") assert response.status_code == 400 @ddt.data( - {'action': 'allow', 'user_in_role': False}, - {'action': 'allow', 'user_in_role': True}, - {'action': 'revoke', 'user_in_role': False}, - {'action': 'revoke', 'user_in_role': True} + {"action": "allow", "user_in_role": False}, + {"action": "allow", "user_in_role": True}, + {"action": "revoke", "user_in_role": False}, + {"action": "revoke", "user_in_role": True}, ) @ddt.unpack def test_post_update_user_role(self, action, user_in_role): """Test the response when updating the user's role""" users = self._create_and_enroll_users(count=1) user = users[0] - role = 'Moderator' + role = "Moderator" if user_in_role: self._add_users_to_role(users, role) response = self.post(role, user.username, action) assert response.status_code == 200 - content = json.loads(response.content.decode('utf-8')) - assertion = self.assertTrue if action == 'allow' else self.assertFalse - assertion(any(user.username in x['username'] for x in content['results'])) + content = json.loads(response.content.decode("utf-8")) + assertion = self.assertTrue if action == "allow" else self.assertFalse + assertion(any(user.username in x["username"] for x in content["results"])) @ddt.ddt @httpretty.activate @override_waffle_flag(ENABLE_DISCUSSIONS_MFE, True) -class CourseActivityStatsTest(ForumsEnableMixin, UrlResetMixin, CommentsServiceMockMixin, APITestCase, - SharedModuleStoreTestCase): +class CourseActivityStatsTest( + ForumsEnableMixin, + UrlResetMixin, + CommentsServiceMockMixin, + APITestCase, + SharedModuleStoreTestCase, +): """ Tests for the course stats endpoint """ - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def setUp(self) -> None: super().setUp() patcher = mock.patch( - 'openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled', - return_value=False + "openedx.core.djangoapps.discussions.config.waffle.ENABLE_FORUM_V2.is_enabled", + return_value=False, ) patcher.start() self.addCleanup(patcher.stop) self.course = CourseFactory.create() self.course_key = str(self.course.id) seed_permissions_roles(self.course.id) - self.user = UserFactory(username='user') - self.moderator = UserFactory(username='moderator') + self.user = UserFactory(username="user") + self.moderator = UserFactory(username="moderator") moderator_role = Role.objects.get(name="Moderator", course_id=self.course.id) moderator_role.users.add(self.moderator) self.stats = [ { - "active_flags": random.randint(0, 3), - "inactive_flags": random.randint(0, 2), + "threads": random.randint(0, 10), "replies": random.randint(0, 30), "responses": random.randint(0, 100), - "threads": random.randint(0, 10), - "username": f"user-{idx}" + "deleted_threads": 0, + "deleted_replies": 0, + "deleted_responses": 0, + "active_flags": random.randint(0, 3), + "inactive_flags": random.randint(0, 2), + "username": f"user-{idx}", } for idx in range(10) ] for stat in self.stats: user = UserFactory.create( - username=stat['username'], + username=stat["username"], email=f"{stat['username']}@example.com", - password=self.TEST_PASSWORD + password=self.TEST_PASSWORD, ) - CourseEnrollment.enroll(user, self.course.id, mode='audit') + CourseEnrollment.enroll(user, self.course.id, mode="audit") - CourseEnrollment.enroll(self.moderator, self.course.id, mode='audit') - self.stats_without_flags = [{**stat, "active_flags": None, "inactive_flags": None} for stat in self.stats] + CourseEnrollment.enroll(self.moderator, self.course.id, mode="audit") + self.stats_without_flags = [ + {**stat, "active_flags": None, "inactive_flags": None} + for stat in self.stats + ] self.register_course_stats_response(self.course_key, self.stats, 1, 3) - self.url = reverse("discussion_course_activity_stats", kwargs={"course_key_string": self.course_key}) + self.url = reverse( + "discussion_course_activity_stats", + kwargs={"course_key_string": self.course_key}, + ) - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def test_regular_user(self): """ Tests that for a regular user stats are returned without flag counts @@ -1933,7 +2165,9 @@ def test_regular_user(self): data = response.json() assert data["results"] == self.stats_without_flags - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def test_moderator_user(self): """ Tests that for a moderator user stats are returned with flag counts @@ -1953,25 +2187,40 @@ def test_moderator_user(self): ("user", "recency", "recency"), ) @ddt.unpack - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) - def test_sorting(self, username, ordering_requested, ordering_performed): + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) + @mock.patch("lms.djangoapps.discussion.rest_api.api.get_course_user_stats") + def test_sorting( + self, + username, + ordering_requested, + ordering_performed, + mock_get_course_user_stats, + ): """ Test valid sorting options and defaults """ + mock_get_course_user_stats.return_value = { + "user_stats": [], + "page": 1, + "num_pages": 1, + "count": 0, + } self.client.login(username=username, password=self.TEST_PASSWORD) params = {} if ordering_requested: params = {"order_by": ordering_requested} self.client.get(self.url, params) - assert urlparse( - httpretty.last_request().path # lint-amnesty, pylint: disable=no-member - ).path == f"/api/v1/users/{self.course_key}/stats" - assert parse_qs( - urlparse(httpretty.last_request().path).query # lint-amnesty, pylint: disable=no-member - ).get("sort_key", None) == [ordering_performed] + + call_args, call_kwargs = mock_get_course_user_stats.call_args + called_params = call_kwargs.get("params") or call_args[1] + assert called_params.get("sort_key") == ordering_performed @ddt.data("flagged", "xyz") - @mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def test_sorting_error_regular_user(self, order_by): """ Test for invalid sorting options for regular users. @@ -1981,47 +2230,225 @@ def test_sorting_error_regular_user(self, order_by): assert "order_by" in response.json()["field_errors"] @ddt.data( - ('user', 'user-0,user-1,user-2,user-3,user-4,user-5,user-6,user-7,user-8,user-9'), - ('moderator', 'moderator'), + ( + "user", + "user-0,user-1,user-2,user-3,user-4,user-5,user-6,user-7,user-8,user-9", + ), + ("moderator", "moderator"), ) @ddt.unpack - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_DISCUSSION_SERVICE': True}) - def test_with_username_param(self, username_search_string, comma_separated_usernames): + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) + def test_with_username_param( + self, username_search_string, comma_separated_usernames + ): """ Test for endpoint with username param. """ - params = {'username': username_search_string} + params = {"username": username_search_string} self.client.login(username=self.moderator.username, password=self.TEST_PASSWORD) self.client.get(self.url, params) - assert urlparse( - httpretty.last_request().path # lint-amnesty, pylint: disable=no-member - ).path == f'/api/v1/users/{self.course_key}/stats' + assert ( + urlparse( + httpretty.last_request().path # lint-amnesty, pylint: disable=no-member + ).path + == f"/api/v1/users/{self.course_key}/stats" + ) assert parse_qs( - urlparse(httpretty.last_request().path).query # lint-amnesty, pylint: disable=no-member - ).get('usernames', [None]) == [comma_separated_usernames] + urlparse( + httpretty.last_request().path + ).query # lint-amnesty, pylint: disable=no-member + ).get("usernames", [None]) == [comma_separated_usernames] - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_DISCUSSION_SERVICE': True}) + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) def test_with_username_param_with_no_matches(self): """ Test for endpoint with username param with no matches. """ - params = {'username': 'unknown'} + params = {"username": "unknown"} self.client.login(username=self.moderator.username, password=self.TEST_PASSWORD) response = self.client.get(self.url, params) data = response.json() - self.assertFalse(data['results']) - assert data['pagination']['count'] == 0 + self.assertFalse(data["results"]) + assert data["pagination"]["count"] == 0 - @ddt.data( - 'user-0', - 'USER-1', - 'User-2', - 'UsEr-3' + @ddt.data("user-0", "USER-1", "User-2", "UsEr-3") + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} ) - @mock.patch.dict("django.conf.settings.FEATURES", {'ENABLE_DISCUSSION_SERVICE': True}) def test_with_username_param_case(self, username_search_string): """ Test user search function is case-insensitive. """ - response = get_usernames_from_search_string(self.course_key, username_search_string, 1, 1) + response = get_usernames_from_search_string( + self.course_key, username_search_string, 1, 1 + ) assert response == (username_search_string.lower(), 1, 1) + + @mock.patch.dict( + "django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True} + ) + def test_banned_username_lookup_error_fails_open(self): + """Stats endpoint should not fail when banned-username lookup backend errors.""" + self.client.login(username=self.user.username, password=self.TEST_PASSWORD) + with mock.patch( + "lms.djangoapps.discussion.rest_api.api.ENABLE_DISCUSSION_BAN.is_enabled", + return_value=True, + ), mock.patch( + "lms.djangoapps.discussion.rest_api.api.forum_api.get_banned_usernames", + side_effect=CommentClientRequestError("temporary backend failure"), + create=True, + ): + response = self.client.get(self.url) + + assert response.status_code == 200 + data = response.json() + assert data["results"] == self.stats_without_flags + + +@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) +@ddt.ddt +class DiscussionModerationViewSetUnitTests(APITestCase): + """Unit tests for DiscussionModerationViewSet helper behavior.""" + + class _DiscussionModerationViewSetTestProxy(DiscussionModerationViewSet): + """Test proxy exposing internal helper for unit testing.""" + + def get_or_create_ban_proxy(self, user, course_key, ban_scope, reason, request): + return self._get_or_create_ban(user, course_key, ban_scope, reason, request) + + def validate_ban_request_proxy(self, request, serializer_data): + return self._validate_ban_request_and_get_user(request, serializer_data) + + def setUp(self): + super().setUp() + self.viewset = self._DiscussionModerationViewSetTestProxy() + self.user = UserFactory.create() + self.moderator = UserFactory.create() + self.request = mock.Mock(user=self.moderator) + self.course_key = CourseKey.from_string("course-v1:x+y+z") + + @ddt.data(("course", False), ("organization", True)) + @ddt.unpack + def test_get_or_create_ban_uses_expected_check_org(self, ban_scope, check_org): + with mock.patch("forum.api.is_user_banned", return_value=False, create=True) as is_user_banned, mock.patch( + "forum.api.ban_user", + return_value={"id": 1, "reactivated": False}, + create=True, + ): + self.viewset.get_or_create_ban_proxy( + user=self.user, + course_key=self.course_key, + ban_scope=ban_scope, + reason="", + request=self.request, + ) + + is_user_banned.assert_called_once_with( + self.user, + self.course_key, + check_org=check_org, + ) + + def test_validate_ban_request_invalid_course_id_returns_400(self): + result = self.viewset.validate_ban_request_proxy( + request=self.request, + serializer_data={ + "user_id": self.user.id, + "course_id": "invalid-course-id", + "scope": "course", + "reason": "", + }, + ) + + assert result.status_code == status.HTTP_400_BAD_REQUEST + assert result.data == {"error": "Invalid course_id: invalid-course-id"} + + def test_bulk_delete_ban_invalid_course_id_returns_400(self): + request = mock.Mock(user=self.moderator, data={}) + serializer_instance = mock.Mock() + serializer_instance.is_valid.return_value = True + serializer_instance.validated_data = { + "user_id": self.user.id, + "course_id": "invalid-course-id", + "ban_user": False, + "ban_scope": "course", + "reason": "", + } + + with mock.patch( + "lms.djangoapps.discussion.rest_api.serializers.BulkDeleteBanRequestSerializer", + return_value=serializer_instance, + ): + response = self.viewset.bulk_delete_ban(request) + + assert response.status_code == status.HTTP_400_BAD_REQUEST + assert response.data == {"error": "Invalid course_id: invalid-course-id"} + + def test_banned_users_invalid_course_id_returns_400(self): + request = mock.Mock(user=self.moderator, query_params={}) + + response = self.viewset.banned_users(request, course_id="invalid-course-id") + + assert response.status_code == status.HTTP_400_BAD_REQUEST + assert response.data == {"error": "Invalid course_id: invalid-course-id"} + + def test_unban_user_by_id_invalid_course_id_returns_400(self): + request = mock.Mock( + user=self.moderator, + data={"course_id": "invalid-course-id", "reason": "appeal approved"}, + ) + + with mock.patch( + "forum.api.get_ban", + return_value={"is_active": True, "course_id": None, "scope": "organization", "org_key": "x"}, + create=True, + ): + response = self.viewset.unban_user_by_id(request, pk=1) + + assert response.status_code == status.HTTP_400_BAD_REQUEST + assert response.data == {"error": "Invalid course_id: invalid-course-id"} + + +@mock.patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) +class BulkDeleteBanRequestSerializerUnitTests(APITestCase): + """Unit tests for BulkDeleteBanRequestSerializer validation behavior.""" + + def setUp(self): + super().setUp() + self.target_user = UserFactory.create() + self.course_id = "course-v1:x+y+z" + + def test_org_scope_accepts_is_staff_when_ban_user_true(self): + acting_user = UserFactory.create(is_staff=True) + request = mock.Mock(user=acting_user) + serializer = BulkDeleteBanRequestSerializer( + data={ + "user_id": self.target_user.id, + "course_id": self.course_id, + "ban_user": True, + "ban_scope": "organization", + "reason": "policy violation", + }, + context={"request": request}, + ) + + assert serializer.is_valid(), serializer.errors + + def test_org_scope_skips_permission_check_when_ban_user_false(self): + acting_user = UserFactory.create(is_staff=False) + request = mock.Mock(user=acting_user) + serializer = BulkDeleteBanRequestSerializer( + data={ + "user_id": self.target_user.id, + "course_id": self.course_id, + "ban_user": False, + "ban_scope": "organization", + }, + context={"request": request}, + ) + + assert serializer.is_valid(), serializer.errors diff --git a/lms/djangoapps/discussion/rest_api/tests/test_views_v2.py b/lms/djangoapps/discussion/rest_api/tests/test_views_v2.py index 4247cbcab06c..c2f2f1877a79 100644 --- a/lms/djangoapps/discussion/rest_api/tests/test_views_v2.py +++ b/lms/djangoapps/discussion/rest_api/tests/test_views_v2.py @@ -14,8 +14,6 @@ from unittest import mock import ddt -from forum.backends.mongodb.comments import Comment -from forum.backends.mongodb.threads import CommentThread import httpretty from django.urls import reverse from pytz import UTC @@ -23,30 +21,39 @@ from rest_framework.parsers import JSONParser from rest_framework.test import APIClient -from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory from common.djangoapps.student.tests.factories import ( CourseEnrollmentFactory, UserFactory, ) from common.djangoapps.util.testing import PatchMediaTypeMixin, UrlResetMixin from common.test.utils import disable_signal -from lms.djangoapps.discussion.tests.utils import ( - make_minimal_cs_comment, - make_minimal_cs_thread, +from forum.backends.mongodb.comments import Comment +from forum.backends.mongodb.threads import CommentThread +from lms.djangoapps.discussion.django_comment_client.tests.utils import ( + ForumsEnableMixin, ) -from lms.djangoapps.discussion.django_comment_client.tests.utils import ForumsEnableMixin from lms.djangoapps.discussion.rest_api import api from lms.djangoapps.discussion.rest_api.tests.utils import ( ForumMockUtilsMixin, ProfileImageTestMixin, make_paginated_api_response, ) +from lms.djangoapps.discussion.tests.utils import ( + make_minimal_cs_comment, + make_minimal_cs_thread, +) from openedx.core.djangoapps.django_comment_common.models import ( - FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_MODERATOR, FORUM_ROLE_STUDENT, - assign_role + FORUM_ROLE_ADMINISTRATOR, + FORUM_ROLE_COMMUNITY_TA, + FORUM_ROLE_MODERATOR, + FORUM_ROLE_STUDENT, + assign_role, ) -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_storage +from openedx.core.djangoapps.user_api.accounts.image_helpers import ( + get_profile_image_storage, +) +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.tests.factories import CourseFactory class DiscussionAPIViewTestMixin(ForumsEnableMixin, ForumMockUtilsMixin, UrlResetMixin): @@ -112,6 +119,7 @@ def register_thread(self, overrides=None): "thread_type": "discussion", "title": "Test Title", "body": "Test body", + "is_deleted": False, } ) cs_thread.update(overrides or {}) @@ -330,6 +338,7 @@ def test_patch_read_non_owner_user(self): "voted", ], "response_count": 2, + "is_deleted": None, } ) assert response_data == expected_data @@ -359,6 +368,8 @@ def expected_response_data(self, overrides=None): "parent_id": None, "author": self.user.username, "author_label": None, + "is_author_banned": False, + "author_ban_scope": None, "created_at": "1970-01-01T00:00:00Z", "updated_at": "1970-01-01T00:00:00Z", "raw_body": "Original body", @@ -386,6 +397,11 @@ def expected_response_data(self, overrides=None): "image_url_medium": "http://testserver/static/default_50.png", "image_url_small": "http://testserver/static/default_30.png", }, + "learner_status": "new", + "is_deleted": False, + "deleted_at": None, + "deleted_by": None, + "deleted_by_label": None, } response_data.update(overrides or {}) return response_data @@ -500,6 +516,7 @@ def create_source_thread(self, overrides=None): "votes": {"up_count": 4}, "comments_count": 5, "unread_comments_count": 3, + "is_deleted": False, } ) @@ -511,15 +528,17 @@ def test_course_id_missing(self): self.assert_response_correct( response, 400, - {"field_errors": {"course_id": {"developer_message": "This field is required."}}} + { + "field_errors": { + "course_id": {"developer_message": "This field is required."} + } + }, ) def test_404(self): response = self.client.get(self.url, {"course_id": "non/existent/course"}) self.assert_response_correct( - response, - 404, - {"developer_message": "Course not found."} + response, 404, {"developer_message": "Course not found."} ) def test_basic(self): @@ -548,6 +567,7 @@ def test_basic(self): "voted", ], "abuse_flagged_count": None, + "is_deleted": None, } ) ] @@ -870,7 +890,9 @@ class BulkDeleteUserPostsTest(DiscussionAPIViewTestMixin, ModuleStoreTestCase): def setUp(self): super().setUp() - self.url = reverse("bulk_delete_user_posts", kwargs={"course_id": str(self.course.id)}) + self.url = reverse( + "bulk_delete_user_posts", kwargs={"course_id": str(self.course.id)} + ) self.user2 = UserFactory.create(password=self.password) CourseEnrollmentFactory.create(user=self.user2, course_id=self.course.id) @@ -886,13 +908,19 @@ def mock_comment_and_thread_count(self, comment_count=1, thread_count=1): thread_collection = mock.MagicMock() thread_collection.count_documents.return_value = thread_count patch_thread = mock.patch.object( - CommentThread, "_collection", new_callable=mock.PropertyMock, return_value=thread_collection + CommentThread, + "_collection", + new_callable=mock.PropertyMock, + return_value=thread_collection, ) comment_collection = mock.MagicMock() comment_collection.count_documents.return_value = comment_count patch_comment = mock.patch.object( - Comment, "_collection", new_callable=mock.PropertyMock, return_value=comment_collection + Comment, + "_collection", + new_callable=mock.PropertyMock, + return_value=comment_collection, ) thread_mock = patch_thread.start() @@ -907,7 +935,9 @@ def test_bulk_delete_denied_for_discussion_roles(self, role): """ Test bulk delete user posts denied with discussion roles. """ - thread_mock, comment_mock = self.mock_comment_and_thread_count(comment_count=1, thread_count=1) + thread_mock, comment_mock = self.mock_comment_and_thread_count( + comment_count=1, thread_count=1 + ) assign_role(self.course.id, self.user, role) response = self.client.post( f"{self.url}?username={self.user2.username}", @@ -931,7 +961,9 @@ def test_bulk_delete_allowed_for_discussion_roles(self, role): assert response.status_code == status.HTTP_202_ACCEPTED assert response.json() == {"comment_count": 1, "thread_count": 1} - @mock.patch('lms.djangoapps.discussion.rest_api.views.delete_course_post_for_user.apply_async') + @mock.patch( + "lms.djangoapps.discussion.rest_api.views.delete_course_post_for_user.apply_async" + ) @ddt.data(True, False) def test_task_only_runs_if_execute_param_is_true(self, execute, task_mock): """ diff --git a/lms/djangoapps/discussion/rest_api/tests/utils.py b/lms/djangoapps/discussion/rest_api/tests/utils.py index 342afb0ada5e..5d58ad9c3fac 100644 --- a/lms/djangoapps/discussion/rest_api/tests/utils.py +++ b/lms/djangoapps/discussion/rest_api/tests/utils.py @@ -2,7 +2,6 @@ Discussion API test utilities """ - import hashlib import json import re @@ -14,11 +13,18 @@ from PIL import Image from pytz import UTC -from lms.djangoapps.discussion.django_comment_client.tests.mixins import MockForumApiMixin -from openedx.core.djangoapps.django_comment_common.comment_client.utils import CommentClientRequestError +from lms.djangoapps.discussion.django_comment_client.tests.mixins import ( + MockForumApiMixin, +) +from openedx.core.djangoapps.django_comment_common.comment_client.utils import ( + CommentClientRequestError, +) from openedx.core.djangoapps.profile_images.images import create_profile_images from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file -from openedx.core.djangoapps.user_api.accounts.image_helpers import get_profile_image_names, set_has_profile_image +from openedx.core.djangoapps.user_api.accounts.image_helpers import ( + get_profile_image_names, + set_has_profile_image, +) def _get_thread_callback(thread_data): @@ -26,6 +32,7 @@ def _get_thread_callback(thread_data): Get a callback function that will return POST/PUT data overridden by response_overrides. """ + def callback(request, _uri, headers): """ Simulate the thread creation or update endpoint by returning the provided @@ -42,7 +49,7 @@ def callback(request, _uri, headers): response_data["edit_history"] = [ { "original_body": original_data["body"], - "author": thread_data.get('username'), + "author": thread_data.get("username"), "reason_code": val, }, ] @@ -68,11 +75,13 @@ def callback(*args, **kwargs): if key in ["anonymous", "anonymous_to_peers", "closed", "pinned"]: response_data[key] = val is True or val == "True" elif key == "edit_reason_code": - response_data["edit_history"] = [{ - "original_body": original_data["body"], - "author": thread_data.get("username"), - "reason_code": val, - }] + response_data["edit_history"] = [ + { + "original_body": original_data["body"], + "author": thread_data.get("username"), + "reason_code": val, + } + ] else: response_data[key] = val @@ -87,6 +96,7 @@ def _get_comment_callback(comment_data, thread_id, parent_id): plus necessary dummy data, overridden by the content of the POST/PUT request. """ + def callback(request, _uri, headers): """ Simulate the comment creation or update endpoint as described above. @@ -105,7 +115,7 @@ def callback(request, _uri, headers): response_data["edit_history"] = [ { "original_body": original_data["body"], - "author": comment_data.get('username'), + "author": comment_data.get("username"), "reason_code": val, }, ] @@ -135,11 +145,13 @@ def callback(*args, **kwargs): if key in ["anonymous", "anonymous_to_peers", "endorsed"]: response_data[key] = val is True or val == "True" elif key == "edit_reason_code": - response_data["edit_history"] = [{ - "original_body": original_data["body"], - "author": comment_data.get("username"), - "reason_code": val, - }] + response_data["edit_history"] = [ + { + "original_body": original_data["body"], + "author": comment_data.get("username"), + "reason_code": val, + } + ] else: response_data[key] = val @@ -152,9 +164,11 @@ def make_user_callbacks(user_map): """ Returns a callable that mimics user creation. """ + def callback(*args, **kwargs): - user_id = args[0] if args else kwargs.get('user_id') + user_id = args[0] if args else kwargs.get("user_id") return user_map[str(user_id)] + return callback @@ -163,54 +177,58 @@ class CommentsServiceMockMixin: def register_get_threads_response(self, threads, page, num_pages): """Register a mock response for GET on the CS thread list endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, "http://localhost:4567/api/v1/threads", - body=json.dumps({ - "collection": threads, - "page": page, - "num_pages": num_pages, - "thread_count": len(threads), - }), - status=200 + body=json.dumps( + { + "collection": threads, + "page": page, + "num_pages": num_pages, + "thread_count": len(threads), + } + ), + status=200, ) def register_get_course_commentable_counts_response(self, course_id, thread_counts): """Register a mock response for GET on the CS thread list endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/commentables/{course_id}/counts", body=json.dumps(thread_counts), - status=200 + status=200, ) def register_get_threads_search_response(self, threads, rewrite, num_pages=1): """Register a mock response for GET on the CS thread search endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, "http://localhost:4567/api/v1/search/threads", - body=json.dumps({ - "collection": threads, - "page": 1, - "num_pages": num_pages, - "corrected_text": rewrite, - "thread_count": len(threads), - }), - status=200 + body=json.dumps( + { + "collection": threads, + "page": 1, + "num_pages": num_pages, + "corrected_text": rewrite, + "thread_count": len(threads), + } + ), + status=200, ) def register_post_thread_response(self, thread_data): """Register a mock response for POST on the CS commentable endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.POST, re.compile(r"http://localhost:4567/api/v1/(\w+)/threads"), - body=_get_thread_callback(thread_data) + body=_get_thread_callback(thread_data), ) def register_put_thread_response(self, thread_data): @@ -218,49 +236,51 @@ def register_put_thread_response(self, thread_data): Register a mock response for PUT on the CS endpoint for the given thread_id. """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.PUT, "http://localhost:4567/api/v1/threads/{}".format(thread_data["id"]), - body=_get_thread_callback(thread_data) + body=_get_thread_callback(thread_data), ) def register_get_thread_error_response(self, thread_id, status_code): """Register a mock error response for GET on the CS thread endpoint.""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/threads/{thread_id}", body="", - status=status_code + status=status_code, ) def register_get_thread_response(self, thread): """ Register a mock response for GET on the CS thread instance endpoint. """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, "http://localhost:4567/api/v1/threads/{id}".format(id=thread["id"]), body=json.dumps(thread), - status=200 + status=200, ) def register_get_comments_response(self, comments, page, num_pages): """Register a mock response for GET on the CS comments list endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, "http://localhost:4567/api/v1/comments", - body=json.dumps({ - "collection": comments, - "page": page, - "num_pages": num_pages, - "comment_count": len(comments), - }), - status=200 + body=json.dumps( + { + "collection": comments, + "page": page, + "num_pages": num_pages, + "comment_count": len(comments), + } + ), + status=200, ) def register_post_comment_response(self, comment_data, thread_id, parent_id=None): @@ -274,11 +294,11 @@ def register_post_comment_response(self, comment_data, thread_id, parent_id=None else: url = f"http://localhost:4567/api/v1/threads/{thread_id}/comments" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.POST, url, - body=_get_comment_callback(comment_data, thread_id, parent_id) + body=_get_comment_callback(comment_data, thread_id, parent_id), ) def register_put_comment_response(self, comment_data): @@ -288,11 +308,11 @@ def register_put_comment_response(self, comment_data): """ thread_id = comment_data["thread_id"] parent_id = comment_data.get("parent_id") - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.PUT, "http://localhost:4567/api/v1/comments/{}".format(comment_data["id"]), - body=_get_comment_callback(comment_data, thread_id, parent_id) + body=_get_comment_callback(comment_data, thread_id, parent_id), ) def register_get_comment_error_response(self, comment_id, status_code): @@ -300,12 +320,12 @@ def register_get_comment_error_response(self, comment_id, status_code): Register a mock error response for GET on the CS comment instance endpoint. """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/comments/{comment_id}", body="", - status=status_code + status=status_code, ) def register_get_comment_response(self, response_overrides): @@ -313,75 +333,83 @@ def register_get_comment_response(self, response_overrides): Register a mock response for GET on the CS comment instance endpoint. """ comment = make_minimal_cs_comment(response_overrides) - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, "http://localhost:4567/api/v1/comments/{id}".format(id=comment["id"]), body=json.dumps(comment), - status=200 + status=200, ) - def register_get_user_response(self, user, subscribed_thread_ids=None, upvoted_ids=None): + def register_get_user_response( + self, user, subscribed_thread_ids=None, upvoted_ids=None + ): """Register a mock response for GET on the CS user instance endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/users/{user.id}", - body=json.dumps({ - "id": str(user.id), - "subscribed_thread_ids": subscribed_thread_ids or [], - "upvoted_ids": upvoted_ids or [], - }), - status=200 + body=json.dumps( + { + "id": str(user.id), + "subscribed_thread_ids": subscribed_thread_ids or [], + "upvoted_ids": upvoted_ids or [], + } + ), + status=200, ) def register_get_user_retire_response(self, user, status=200, body=""): """Register a mock response for GET on the CS user retirement endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.POST, f"http://localhost:4567/api/v1/users/{user.id}/retire", body=body, - status=status + status=status, ) def register_get_username_replacement_response(self, user, status=200, body=""): - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.POST, f"http://localhost:4567/api/v1/users/{user.id}/replace_username", body=body, - status=status + status=status, ) def register_subscribed_threads_response(self, user, threads, page, num_pages): """Register a mock response for GET on the CS user instance endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/users/{user.id}/subscribed_threads", - body=json.dumps({ - "collection": threads, - "page": page, - "num_pages": num_pages, - "thread_count": len(threads), - }), - status=200 + body=json.dumps( + { + "collection": threads, + "page": page, + "num_pages": num_pages, + "thread_count": len(threads), + } + ), + status=200, ) def register_course_stats_response(self, course_key, stats, page, num_pages): """Register a mock response for GET on the CS user course stats instance endpoint""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/users/{course_key}/stats", - body=json.dumps({ - "user_stats": stats, - "page": page, - "num_pages": num_pages, - "count": len(stats), - }), - status=200 + body=json.dumps( + { + "user_stats": stats, + "page": page, + "num_pages": num_pages, + "count": len(stats), + } + ), + status=200, ) def register_subscription_response(self, user): @@ -389,13 +417,13 @@ def register_subscription_response(self, user): Register a mock response for POST and DELETE on the CS user subscription endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." for method in [httpretty.POST, httpretty.DELETE]: httpretty.register_uri( method, f"http://localhost:4567/api/v1/users/{user.id}/subscriptions", body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_thread_votes_response(self, thread_id): @@ -403,13 +431,13 @@ def register_thread_votes_response(self, thread_id): Register a mock response for PUT and DELETE on the CS thread votes endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." for method in [httpretty.PUT, httpretty.DELETE]: httpretty.register_uri( method, f"http://localhost:4567/api/v1/threads/{thread_id}/votes", body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_comment_votes_response(self, comment_id): @@ -417,41 +445,39 @@ def register_comment_votes_response(self, comment_id): Register a mock response for PUT and DELETE on the CS comment votes endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." for method in [httpretty.PUT, httpretty.DELETE]: httpretty.register_uri( method, f"http://localhost:4567/api/v1/comments/{comment_id}/votes", body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_flag_response(self, content_type, content_id): """Register a mock response for PUT on the CS flag endpoints""" - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." for path in ["abuse_flag", "abuse_unflag"]: httpretty.register_uri( "PUT", "http://localhost:4567/api/v1/{content_type}s/{content_id}/{path}".format( - content_type=content_type, - content_id=content_id, - path=path + content_type=content_type, content_id=content_id, path=path ), body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_read_response(self, user, content_type, content_id): """ Register a mock response for POST on the CS 'read' endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.POST, f"http://localhost:4567/api/v1/users/{user.id}/read", - params={'source_type': content_type, 'source_id': content_id}, + params={"source_type": content_type, "source_id": content_id}, body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_thread_flag_response(self, thread_id): @@ -466,48 +492,48 @@ def register_delete_thread_response(self, thread_id): """ Register a mock response for DELETE on the CS thread instance endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.DELETE, f"http://localhost:4567/api/v1/threads/{thread_id}", body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_delete_comment_response(self, comment_id): """ Register a mock response for DELETE on the CS comment instance endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.DELETE, f"http://localhost:4567/api/v1/comments/{comment_id}", body=json.dumps({}), # body is unused - status=200 + status=200, ) def register_user_active_threads(self, user_id, response): """ Register a mock response for GET on the CS comment active threads endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/users/{user_id}/active_threads", body=json.dumps(response), - status=200 + status=200, ) def register_get_subscriptions(self, thread_id, response): """ Register a mock response for GET on the CS comment active threads endpoint """ - assert httpretty.is_enabled(), 'httpretty must be enabled to mock calls.' + assert httpretty.is_enabled(), "httpretty must be enabled to mock calls." httpretty.register_uri( httpretty.GET, f"http://localhost:4567/api/v1/threads/{thread_id}/subscriptions", body=json.dumps(response), - status=200 + status=200, ) def assert_query_params_equal(self, httpretty_request, expected_params): @@ -531,7 +557,7 @@ def request_patch(self, request_data): return self.client.patch( self.url, json.dumps(request_data), - content_type="application/merge-patch+json" + content_type="application/merge-patch+json", ) def expected_thread_data(self, overrides=None): @@ -543,6 +569,8 @@ def expected_thread_data(self, overrides=None): "anonymous_to_peers": False, "author": self.user.username, "author_label": None, + "is_author_banned": False, + "author_ban_scope": None, "created_at": "1970-01-01T00:00:00Z", "updated_at": "1970-01-01T00:00:00Z", "raw_body": "Test body", @@ -588,6 +616,11 @@ def expected_thread_data(self, overrides=None): "closed_by_label": None, "close_reason": None, "close_reason_code": None, + "learner_status": "new", + "is_deleted": False, + "deleted_at": None, + "deleted_by": None, + "deleted_by_label": None, } response_data.update(overrides or {}) return response_data @@ -598,137 +631,153 @@ class ForumMockUtilsMixin(MockForumApiMixin): def register_get_threads_response(self, threads, page, num_pages): """Register a mock response for GET on the CS thread list endpoint""" - self.set_mock_return_value('get_user_threads', { - "collection": threads, - "page": page, - "num_pages": num_pages, - "thread_count": len(threads), - }) + self.set_mock_return_value( + "get_user_threads", + { + "collection": threads, + "page": page, + "num_pages": num_pages, + "thread_count": len(threads), + }, + ) def register_get_course_commentable_counts_response(self, course_id, thread_counts): """Register a mock response for GET on the CS thread list endpoint""" - self.set_mock_return_value('get_commentables_stats', thread_counts) + self.set_mock_return_value("get_commentables_stats", thread_counts) def register_get_threads_search_response(self, threads, rewrite, num_pages=1): """Register a mock response for GET on the CS thread search endpoint""" - self.set_mock_return_value('search_threads', { - "collection": threads, - "page": 1, - "num_pages": num_pages, - "corrected_text": rewrite, - "thread_count": len(threads), - }) + self.set_mock_return_value( + "search_threads", + { + "collection": threads, + "page": 1, + "num_pages": num_pages, + "corrected_text": rewrite, + "thread_count": len(threads), + }, + ) def register_post_thread_response(self, thread_data): - self.set_mock_side_effect('create_thread', make_thread_callback(thread_data)) + self.set_mock_side_effect("create_thread", make_thread_callback(thread_data)) def register_put_thread_response(self, thread_data): - self.set_mock_side_effect('update_thread', make_thread_callback(thread_data)) + self.set_mock_side_effect("update_thread", make_thread_callback(thread_data)) def register_get_thread_error_response(self, thread_id, status_code): self.set_mock_side_effect( - 'get_thread', - CommentClientRequestError(f"Thread does not exist with Id: {thread_id}") + "get_thread", + CommentClientRequestError(f"Thread does not exist with Id: {thread_id}"), ) def register_get_thread_response(self, thread): - self.set_mock_return_value('get_thread', thread) + self.set_mock_return_value("get_thread", thread) def register_get_comments_response(self, comments, page, num_pages): - self.set_mock_return_value('get_parent_comment', { - "collection": comments, - "page": page, - "num_pages": num_pages, - "comment_count": len(comments), - }) + self.set_mock_return_value( + "get_parent_comment", + { + "collection": comments, + "page": page, + "num_pages": num_pages, + "comment_count": len(comments), + }, + ) def register_post_comment_response(self, comment_data, thread_id, parent_id=None): self.set_mock_side_effect( - 'create_child_comment' if parent_id else 'create_parent_comment', - make_comment_callback(comment_data, thread_id, parent_id) + "create_child_comment" if parent_id else "create_parent_comment", + make_comment_callback(comment_data, thread_id, parent_id), ) def register_put_comment_response(self, comment_data): thread_id = comment_data["thread_id"] parent_id = comment_data.get("parent_id") self.set_mock_side_effect( - 'update_comment', - make_comment_callback(comment_data, thread_id, parent_id) + "update_comment", make_comment_callback(comment_data, thread_id, parent_id) ) def register_get_comment_error_response(self, comment_id, status_code): self.set_mock_side_effect( - 'get_parent_comment', - CommentClientRequestError(f"Comment does not exist with Id: {comment_id}") + "get_parent_comment", + CommentClientRequestError(f"Comment does not exist with Id: {comment_id}"), ) def register_get_comment_response(self, response_overrides): comment = make_minimal_cs_comment(response_overrides) - self.set_mock_return_value('get_parent_comment', comment) + self.set_mock_return_value("get_parent_comment", comment) - def register_get_user_response(self, user, subscribed_thread_ids=None, upvoted_ids=None): + def register_get_user_response( + self, user, subscribed_thread_ids=None, upvoted_ids=None + ): """Register a mock response for GET on the CS user endpoint""" self.users_map[str(user.id)] = { "id": str(user.id), "subscribed_thread_ids": subscribed_thread_ids or [], "upvoted_ids": upvoted_ids or [], } - self.set_mock_side_effect('get_user', make_user_callbacks(self.users_map)) + self.set_mock_side_effect("get_user", make_user_callbacks(self.users_map)) def register_get_user_retire_response(self, user, body=""): - self.set_mock_return_value('retire_user', body) + self.set_mock_return_value("retire_user", body) def register_get_username_replacement_response(self, user, status=200, body=""): - self.set_mock_return_value('update_username', body) + self.set_mock_return_value("update_username", body) def register_subscribed_threads_response(self, user, threads, page, num_pages): - self.set_mock_return_value('get_user_subscriptions', { - "collection": threads, - "page": page, - "num_pages": num_pages, - "thread_count": len(threads), - }) + self.set_mock_return_value( + "get_user_subscriptions", + { + "collection": threads, + "page": page, + "num_pages": num_pages, + "thread_count": len(threads), + }, + ) def register_course_stats_response(self, course_key, stats, page, num_pages): - self.set_mock_return_value('get_user_course_stats', { - "user_stats": stats, - "page": page, - "num_pages": num_pages, - "count": len(stats), - }) + self.set_mock_return_value( + "get_user_course_stats", + { + "user_stats": stats, + "page": page, + "num_pages": num_pages, + "count": len(stats), + }, + ) def register_subscription_response(self, user): - self.set_mock_return_value('create_subscription', {}) - self.set_mock_return_value('delete_subscription', {}) + self.set_mock_return_value("create_subscription", {}) + self.set_mock_return_value("delete_subscription", {}) def register_thread_votes_response(self, thread_id): - self.set_mock_return_value('update_thread_votes', {}) - self.set_mock_return_value('delete_thread_vote', {}) + self.set_mock_return_value("update_thread_votes", {}) + self.set_mock_return_value("delete_thread_vote", {}) def register_comment_votes_response(self, comment_id): - self.set_mock_return_value('update_comment_votes', {}) - self.set_mock_return_value('delete_comment_vote', {}) + self.set_mock_return_value("update_comment_votes", {}) + self.set_mock_return_value("delete_comment_vote", {}) def register_flag_response(self, content_type, content_id): - if content_type == 'thread': - self.set_mock_return_value('update_thread_flag', {}) - elif content_type == 'comment': - self.set_mock_return_value('update_comment_flag', {}) + if content_type == "thread": + self.set_mock_return_value("update_thread_flag", {}) + elif content_type == "comment": + self.set_mock_return_value("update_comment_flag", {}) def register_read_response(self, user, content_type, content_id): - self.set_mock_return_value('mark_thread_as_read', {}) + self.set_mock_return_value("mark_thread_as_read", {}) def register_delete_thread_response(self, thread_id): - self.set_mock_return_value('delete_thread', {}) + self.set_mock_return_value("delete_thread", {}) def register_delete_comment_response(self, comment_id): - self.set_mock_return_value('delete_comment', {}) + self.set_mock_return_value("delete_comment", {}) def register_user_active_threads(self, user_id, response): - self.set_mock_return_value('get_user_active_threads', response) + self.set_mock_return_value("get_user_active_threads", response) def register_get_subscriptions(self, thread_id, response): - self.set_mock_return_value('get_thread_subscriptions', response) + self.set_mock_return_value("get_thread_subscriptions", response) def register_thread_flag_response(self, thread_id): """Register a mock response for PUT on the CS thread flag endpoints""" @@ -759,7 +808,7 @@ def request_patch(self, request_data): return self.client.patch( self.url, json.dumps(request_data), - content_type="application/merge-patch+json" + content_type="application/merge-patch+json", ) def expected_thread_data(self, overrides=None): @@ -771,6 +820,8 @@ def expected_thread_data(self, overrides=None): "anonymous_to_peers": False, "author": self.user.username, "author_label": None, + "is_author_banned": False, + "author_ban_scope": None, "created_at": "1970-01-01T00:00:00Z", "updated_at": "1970-01-01T00:00:00Z", "raw_body": "Test body", @@ -816,6 +867,11 @@ def expected_thread_data(self, overrides=None): "closed_by_label": None, "close_reason": None, "close_reason_code": None, + "learner_status": "new", + "is_deleted": False, + "deleted_at": None, + "deleted_by": None, + "deleted_by_label": None, } response_data.update(overrides or {}) return response_data @@ -888,7 +944,9 @@ def make_minimal_cs_comment(overrides=None): return ret -def make_paginated_api_response(results=None, count=0, num_pages=0, next_link=None, previous_link=None): +def make_paginated_api_response( + results=None, count=0, num_pages=0, next_link=None, previous_link=None +): """ Generates the response dictionary of paginated APIs with passed data """ @@ -899,7 +957,7 @@ def make_paginated_api_response(results=None, count=0, num_pages=0, next_link=No "count": count, "num_pages": num_pages, }, - "results": results or [] + "results": results or [], } @@ -917,7 +975,9 @@ def create_profile_image(self, user, storage): with make_image_file() as image_file: create_profile_images(image_file, get_profile_image_names(user.username)) self.check_images(user, storage) - set_has_profile_image(user.username, True, self.TEST_PROFILE_IMAGE_UPLOADED_AT) + set_has_profile_image( + user.username, True, self.TEST_PROFILE_IMAGE_UPLOADED_AT + ) def check_images(self, user, storage, exist=True): """ @@ -931,7 +991,7 @@ def check_images(self, user, storage, exist=True): assert storage.exists(name) with closing(Image.open(storage.path(name))) as img: assert img.size == (size, size) - assert img.format == 'JPEG' + assert img.format == "JPEG" else: assert not storage.exists(name) @@ -939,18 +999,18 @@ def get_expected_user_profile(self, username): """ Returns the expected user profile data for a given username """ - url = 'http://example-storage.com/profile-images/{filename}_{{size}}.jpg?v={timestamp}'.format( - filename=hashlib.md5(b'secret' + username.encode('utf-8')).hexdigest(), - timestamp=self.TEST_PROFILE_IMAGE_UPLOADED_AT.strftime("%s") + url = "http://example-storage.com/profile-images/{filename}_{{size}}.jpg?v={timestamp}".format( + filename=hashlib.md5(b"secret" + username.encode("utf-8")).hexdigest(), + timestamp=self.TEST_PROFILE_IMAGE_UPLOADED_AT.strftime("%s"), ) return { - 'profile': { - 'image': { - 'has_image': True, - 'image_url_full': url.format(size=500), - 'image_url_large': url.format(size=120), - 'image_url_medium': url.format(size=50), - 'image_url_small': url.format(size=30), + "profile": { + "image": { + "has_image": True, + "image_url_full": url.format(size=500), + "image_url_large": url.format(size=120), + "image_url_medium": url.format(size=50), + "image_url_small": url.format(size=30), } } } @@ -960,14 +1020,14 @@ def parsed_body(request): """Returns a parsed dictionary version of a request body""" # This could just be HTTPrettyRequest.parsed_body, but that method double-decodes '%2B' -> '+' -> ' '. # You can just remove this method when this issue is fixed: https://github.com/gabrielfalcao/HTTPretty/issues/240 - return parse_qs(request.body.decode('utf8')) + return parse_qs(request.body.decode("utf8")) def querystring(request): """Returns a parsed dictionary version of a query string""" # This could just be HTTPrettyRequest.querystring, but that method double-decodes '%2B' -> '+' -> ' '. # You can just remove this method when this issue is fixed: https://github.com/gabrielfalcao/HTTPretty/issues/240 - return parse_qs(request.path.split('?', 1)[-1]) + return parse_qs(request.path.split("?", 1)[-1]) class ThreadMock(object): @@ -975,7 +1035,9 @@ class ThreadMock(object): A mock thread object """ - def __init__(self, thread_id, creator, title, parent_id=None, body='', commentable_id=None): + def __init__( + self, thread_id, creator, title, parent_id=None, body="", commentable_id=None + ): self.id = thread_id self.user_id = str(creator.id) self.username = creator.username diff --git a/lms/djangoapps/discussion/rest_api/urls.py b/lms/djangoapps/discussion/rest_api/urls.py index f102dc41f249..7a7cbc4b15af 100644 --- a/lms/djangoapps/discussion/rest_api/urls.py +++ b/lms/djangoapps/discussion/rest_api/urls.py @@ -9,6 +9,7 @@ from lms.djangoapps.discussion.rest_api.views import ( BulkDeleteUserPosts, + BulkRestoreUserPosts, CommentViewSet, CourseActivityStatsView, CourseDiscussionRolesAPIView, @@ -18,8 +19,11 @@ CourseTopicsViewV3, CourseView, CourseViewV2, + DeletedContentView, + DiscussionModerationViewSet, LearnerThreadView, ReplaceUsernamesView, + RestoreContent, RetireUserView, ThreadViewSet, UploadFileView, @@ -30,27 +34,49 @@ ROUTER.register("comments", CommentViewSet, basename="comment") urlpatterns = [ + # Moderation endpoints (defined first to avoid router conflicts) + path( + 'v1/moderation/ban-user/', + DiscussionModerationViewSet.as_view({'post': 'ban_user'}), + name='discussion-moderation-ban-user' + ), + path( + 'v1/moderation/unban-user/', + DiscussionModerationViewSet.as_view({'post': 'unban_user'}), + name='discussion-moderation-unban-user' + ), + path( + 'v1/moderation/
+ + {% filter force_escape %} + {% blocktrans %} + Discussion Ban Alert + {% endblocktrans %} + {% endfilter %} ++ ++ {% filter force_escape %} + {% blocktrans %} + A user has been banned from course discussions. Please review this moderation action. + {% endblocktrans %} + {% endfilter %} + + +
+ {% trans "Action Required:" as action_required %}{{ action_required|force_escape }} + {% trans "Please review this moderation action and follow up as needed. If this ban was applied in error or requires adjustment, contact the moderator or course staff." as review_instructions %}{{ review_instructions|force_escape }} + + + {% block google_analytics_pixel %} + {% if ga_tracking_pixel_url %} + + {% endif %} + {% endblock %} + |
+
${ chapter['display_name']}
%if hide_url:
${section.display_name} - %if (total > 0 or earned > 0) and section.show_grades(staff_access): + %if (total > 0 or earned > 0) and ShowCorrectness.correctness_available(section.show_correctness, section.due, staff_access): ${_("{earned} of {total} possible points").format(earned='{:.3n}'.format(float(earned)), total='{:.3n}'.format(float(total)))} @@ -189,14 +190,14 @@
%else: ${ section.display_name} - %if (total > 0 or earned > 0) and section.show_grades(staff_access): + %if (total > 0 or earned > 0) and ShowCorrectness.correctness_available(section.show_correctness, section.due, staff_access): ${_("{earned} of {total} possible points").format(earned='{:.3n}'.format(float(earned)), total='{:.3n}'.format(float(total)))} %endif %endif - %if (total > 0 or earned > 0) and section.show_grades(staff_access): + %if (total > 0 or earned > 0) and ShowCorrectness.correctness_available(section.show_correctness, section.due, staff_access): ${"({0:.3n}/{1:.3n}) {2}".format( float(earned), float(total), percentageString )} %endif
@@ -219,7 +220,7 @@
%endif
%if len(section.problem_scores.values()) > 0:
- %if section.show_grades(staff_access):
+ %if ShowCorrectness.correctness_available(section.show_correctness, section.due, staff_access):
- ${ _("Problem Scores: ") if section.graded else _("Practice Scores: ")}
%for score in section.problem_scores.values():
diff --git a/lms/templates/lti.html b/lms/templates/lti.html
index 05346ec3dc40..d03b7e386740 100644
--- a/lms/templates/lti.html
+++ b/lms/templates/lti.html
@@ -37,6 +37,7 @@
${button_text or _('View resource in a new window')}
+ External link
% else:
diff --git a/lms/templates/pdf_viewer.html b/lms/templates/pdf_viewer.html
index a3314d54b5ac..1f4b8cd54abf 100644
--- a/lms/templates/pdf_viewer.html
+++ b/lms/templates/pdf_viewer.html
@@ -1,5 +1,5 @@
<%page expression_filter="h"/>
-
+
<%namespace name='static' file='static_content.html'/>
<%!
from openedx.core.djangolib.js_utils import (
@@ -46,10 +46,44 @@
PDFJS.workerSrc = "${static.url('js/vendor/pdfjs/pdf.worker.js') | n, js_escaped_string}";
PDFJS.disableWorker = true;
PDFJS.cMapUrl = "${static.url('css/vendor/pdfjs/cmaps/') | n, js_escaped_string}";
- PDF_URL = '${current_url | n, js_escaped_string}';
+
+ var PDF_URL = '${current_url | n, js_escaped_string}';
+
+ if (window.parent !== window) {
+ window.parent.postMessage({type: 'request_pdf_url'}, '*');
+
+ function handlePdfUrlResponse(event) {
+ if (event.data && event.data.type === 'pdf_url_response') {
+ PDF_URL = event.data.url;
+
+ if (PDFViewerApplication.open) {
+ PDFViewerApplication.open(PDF_URL);
+ PDFViewerApplication.mouseScroll(0);
+
+ setTimeout(function() {
+ if (PDFViewerApplication.pdfDocument) {
+ if (event.data.title) document.getElementById('titleField').textContent = event.data.title;
+ if (event.data.author) document.getElementById('authorField').textContent = event.data.author;
+ if (event.data.subject) document.getElementById('subjectField').textContent = event.data.subject;
+ if (event.data.keywords) document.getElementById('keywordsField').textContent = event.data.keywords;
+ document.getElementById('creatorField').textContent = 'edX Platform';
+ }
+ }, 500);
+ }
+ } else if (event.data && event.data.type === 'chapter_change') {
+ window.parent.postMessage({type: 'request_pdf_url'}, '*');
+ }
+ }
+
+ window.addEventListener('message', handlePdfUrlResponse);
+ }
+
+ document.addEventListener('DOMContentLoaded', function () {
+ PDFViewerApplication && PDFViewerApplication.open(PDF_URL);
+ });
-
+
<%static:js group='main_vendor'/>
<%static:js group='application'/>
@@ -347,77 +381,77 @@
-
-
-
-
- Preparing document for printing...
-
-
- 0%
-
-
-
+
+
+
+
+ Preparing document for printing...
+
+
+ 0%
+
+
+
+
+
-
-
${button_text or _('View resource in a new window')} + External link
% else: diff --git a/lms/templates/pdf_viewer.html b/lms/templates/pdf_viewer.html index a3314d54b5ac..1f4b8cd54abf 100644 --- a/lms/templates/pdf_viewer.html +++ b/lms/templates/pdf_viewer.html @@ -1,5 +1,5 @@ <%page expression_filter="h"/> - + <%namespace name='static' file='static_content.html'/> <%! from openedx.core.djangolib.js_utils import ( @@ -46,10 +46,44 @@ PDFJS.workerSrc = "${static.url('js/vendor/pdfjs/pdf.worker.js') | n, js_escaped_string}"; PDFJS.disableWorker = true; PDFJS.cMapUrl = "${static.url('css/vendor/pdfjs/cmaps/') | n, js_escaped_string}"; - PDF_URL = '${current_url | n, js_escaped_string}'; + + var PDF_URL = '${current_url | n, js_escaped_string}'; + + if (window.parent !== window) { + window.parent.postMessage({type: 'request_pdf_url'}, '*'); + + function handlePdfUrlResponse(event) { + if (event.data && event.data.type === 'pdf_url_response') { + PDF_URL = event.data.url; + + if (PDFViewerApplication.open) { + PDFViewerApplication.open(PDF_URL); + PDFViewerApplication.mouseScroll(0); + + setTimeout(function() { + if (PDFViewerApplication.pdfDocument) { + if (event.data.title) document.getElementById('titleField').textContent = event.data.title; + if (event.data.author) document.getElementById('authorField').textContent = event.data.author; + if (event.data.subject) document.getElementById('subjectField').textContent = event.data.subject; + if (event.data.keywords) document.getElementById('keywordsField').textContent = event.data.keywords; + document.getElementById('creatorField').textContent = 'edX Platform'; + } + }, 500); + } + } else if (event.data && event.data.type === 'chapter_change') { + window.parent.postMessage({type: 'request_pdf_url'}, '*'); + } + } + + window.addEventListener('message', handlePdfUrlResponse); + } + + document.addEventListener('DOMContentLoaded', function () { + PDFViewerApplication && PDFViewerApplication.open(PDF_URL); + }); - + <%static:js group='main_vendor'/> <%static:js group='application'/> @@ -347,77 +381,77 @@ -
-
-
-
- Preparing document for printing...
-
-
- 0%
-
-
-
+
-
+
+
-
+
+ Preparing document for printing...
+
+
+ 0%
+
+
+
+
+