feat!: remove cs_comments_service support for forum's flag APIs

This will force the use of the new v2 forum's APIs for flaging/unflaging.

Author: Ali-Salman29

lms/djangoapps/discussion/django_comment_client/base/tests.py

@@ -8,11 +8,6 @@
 class MockForumApiMixin:
     """Mixin to mock forum_api across different test cases with a single mock instance."""
 
-    @classmethod
-    def setUpClass(cls):
-        """Apply a single forum_api mock at the class level."""
-        cls.setUpClassAndForumMock()
-
     @classmethod
     def setUpClassAndForumMock(cls):
         """
@@ -49,11 +44,6 @@ def disposeForumMocks(cls):
         for patcher in cls.forum_api_patchers:
             patcher.stop()
 
-    @classmethod
-    def tearDownClass(cls):
-        """Stop patches after tests complete."""
-        cls.disposeForumMocks()
-
     def set_mock_return_value(self, function_name, return_value):
         """
         Set a return value for a specific method in forum_api mock.
@@ -65,3 +55,50 @@ def set_mock_return_value(self, function_name, return_value):
         setattr(
             self.mock_forum_api, function_name, mock.Mock(return_value=return_value)
         )
+
+    def set_mock_side_effect(self, function_name, side_effect_fn):
+        """
+        Set a side effect for a specific method in forum_api mock.
+
+        Args:
+            function_name (str): The method name in the mock to set a side effect for.
+            side_effect_fn (Callable): A function to be called when the mock is called.
+        """
+        setattr(
+            self.mock_forum_api, function_name, mock.Mock(side_effect=side_effect_fn)
+        )
+
+    def check_mock_called_with(self, function_name, index, *parms, **kwargs):
+        """
+        Check if a specific method in forum_api mock was called with the given parameters.
+
+        Args:
+            function_name (str): The method name in the mock to check.
+            parms (tuple): The parameters to check the method was called with.
+        """
+        call_args = getattr(self.mock_forum_api, function_name).call_args_list[index]
+        assert call_args == mock.call(*parms, **kwargs)
+
+    def check_mock_called(self, function_name):
+        """
+        Check if a specific method in the forum_api mock was called.
+
+        Args:
+            function_name (str): The method name in the mock to check.
+
+        Returns:
+            bool: True if the method was called, False otherwise.
+        """
+        return getattr(self.mock_forum_api, function_name).called
+
+    def get_mock_func_calls(self, function_name):
+        """
+        Returns a list of call arguments for a specific method in the mock_forum_api.
+
+        Args:
+            function_name (str): The name of the method in the mock_forum_api to retrieve call arguments for.
+
+        Returns:
+            list: A list of call arguments for the specified method.
+        """
+        return getattr(self.mock_forum_api, function_name).call_args_list

lms/djangoapps/discussion/django_comment_client/base/tests_v2.py

@@ -2150,18 +2150,6 @@ def test_following(self):
         assert cs_request.method == 'POST'
         assert parsed_body(cs_request) == {'source_type': ['thread'], 'source_id': ['test_id']}
 
-    def test_abuse_flagged(self):
-        self.register_post_thread_response({"id": "test_id", "username": self.user.username})
-        self.register_thread_flag_response("test_id")
-        data = self.minimal_data.copy()
-        data["abuse_flagged"] = "True"
-        result = create_thread(self.request, data)
-        assert result['abuse_flagged'] is True
-        cs_request = httpretty.last_request()
-        assert urlparse(cs_request.path).path == '/api/v1/threads/test_id/abuse_flag'  # lint-amnesty, pylint: disable=no-member
-        assert cs_request.method == 'PUT'
-        assert parsed_body(cs_request) == {'user_id': [str(self.user.id)]}
-
     def test_course_id_missing(self):
         with pytest.raises(ValidationError) as assertion:
             create_thread(self.request, {})
@@ -2510,18 +2498,6 @@ def test_endorsed(self, role_name, is_thread_author, thread_type):
         except ValidationError:
             assert expected_error
 
-    def test_abuse_flagged(self):
-        self.register_post_comment_response({"id": "test_comment", "username": self.user.username}, "test_thread")
-        self.register_comment_flag_response("test_comment")
-        data = self.minimal_data.copy()
-        data["abuse_flagged"] = "True"
-        result = create_comment(self.request, data)
-        assert result['abuse_flagged'] is True
-        cs_request = httpretty.last_request()
-        assert urlparse(cs_request.path).path == '/api/v1/comments/test_comment/abuse_flag'  # lint-amnesty, pylint: disable=no-member
-        assert cs_request.method == 'PUT'
-        assert parsed_body(cs_request) == {'user_id': [str(self.user.id)]}
-
     def test_thread_id_missing(self):
         with pytest.raises(ValidationError) as assertion:
             create_comment(self.request, {})
@@ -2957,108 +2933,6 @@ def test_vote_count_two_users(
                 assert result['vote_count'] == vote_count
                 self.register_get_user_response(self.user, upvoted_ids=[])
 
-    @ddt.data(*itertools.product([True, False], [True, False]))
-    @ddt.unpack
-    @mock.patch("eventtracking.tracker.emit")
-    def test_abuse_flagged(self, old_flagged, new_flagged, mock_emit):
-        """
-        Test attempts to edit the "abuse_flagged" field.
-
-        old_flagged indicates whether the thread should be flagged at the start
-        of the test. new_flagged indicates the value for the "abuse_flagged"
-        field in the update. If old_flagged and new_flagged are the same, no
-        update should be made. Otherwise, a PUT should be made to the flag or
-        or unflag endpoint according to the new_flagged value.
-        """
-        self.register_get_user_response(self.user)
-        self.register_thread_flag_response("test_thread")
-        self.register_thread({"abuse_flaggers": [str(self.user.id)] if old_flagged else []})
-        data = {"abuse_flagged": new_flagged}
-        result = update_thread(self.request, "test_thread", data)
-        assert result['abuse_flagged'] == new_flagged
-        last_request_path = urlparse(httpretty.last_request().path).path  # lint-amnesty, pylint: disable=no-member
-        flag_url = "/api/v1/threads/test_thread/abuse_flag"
-        unflag_url = "/api/v1/threads/test_thread/abuse_unflag"
-        if old_flagged == new_flagged:
-            assert last_request_path != flag_url
-            assert last_request_path != unflag_url
-        else:
-            assert last_request_path == (flag_url if new_flagged else unflag_url)
-            assert httpretty.last_request().method == 'PUT'
-            assert parsed_body(httpretty.last_request()) == {'user_id': [str(self.user.id)]}
-
-            expected_event_name = 'edx.forum.thread.reported' if new_flagged else 'edx.forum.thread.unreported'
-            expected_event_data = {
-                'body': 'Original body',
-                'id': 'test_thread',
-                'content_type': 'Post',
-                'commentable_id': 'original_topic',
-                'url': '',
-                'user_course_roles': [],
-                'user_forums_roles': [FORUM_ROLE_STUDENT],
-                'target_username': self.user.username,
-                'title_truncated': False,
-                'title': 'Original Title',
-                'thread_type': 'discussion',
-                'group_id': None,
-                'truncated': False,
-            }
-            if not new_flagged:
-                expected_event_data['reported_status_cleared'] = False
-
-            actual_event_name, actual_event_data = mock_emit.call_args[0]
-            self.assertEqual(actual_event_name, expected_event_name)
-            self.assertEqual(actual_event_data, expected_event_data)
-
-    @ddt.data(
-        (False, True),
-        (True, True),
-    )
-    @ddt.unpack
-    @mock.patch("eventtracking.tracker.emit")
-    def test_thread_un_abuse_flag_for_moderator_role(self, is_author, remove_all, mock_emit):
-        """
-        Test un-abuse flag for moderator role.
-
-        When moderator unflags a reported thread, it should
-        pass the "all" flag to the api. This will indicate
-        to the api to clear all abuse_flaggers, and mark the
-        thread as unreported.
-        """
-        _assign_role_to_user(user=self.user, course_id=self.course.id, role=FORUM_ROLE_ADMINISTRATOR)
-        self.register_get_user_response(self.user)
-        self.register_thread_flag_response("test_thread")
-        self.register_thread({"abuse_flaggers": ["11"], "user_id": str(self.user.id) if is_author else "12"})
-        data = {"abuse_flagged": False}
-        update_thread(self.request, "test_thread", data)
-        assert httpretty.last_request().method == 'PUT'
-        query_params = {'user_id': [str(self.user.id)]}
-        if remove_all:
-            query_params.update({'all': ['True']})
-        assert parsed_body(httpretty.last_request()) == query_params
-
-        expected_event_name = 'edx.forum.thread.unreported'
-        expected_event_data = {
-            'body': 'Original body',
-            'id': 'test_thread',
-            'content_type': 'Post',
-            'commentable_id': 'original_topic',
-            'url': '',
-            'user_course_roles': [],
-            'user_forums_roles': [FORUM_ROLE_STUDENT, FORUM_ROLE_ADMINISTRATOR],
-            'target_username': self.user.username,
-            'title_truncated': False,
-            'title': 'Original Title',
-            'reported_status_cleared': False,
-            'thread_type': 'discussion',
-            'group_id': None,
-            'truncated': False,
-        }
-
-        actual_event_name, actual_event_data = mock_emit.call_args[0]
-        self.assertEqual(actual_event_name, expected_event_name)
-        self.assertEqual(actual_event_data, expected_event_data)
-
     def test_invalid_field(self):
         self.register_thread()
         with pytest.raises(ValidationError) as assertion:
@@ -3566,100 +3440,6 @@ def test_vote_count_two_users(
                 assert result['vote_count'] == vote_count
                 self.register_get_user_response(self.user, upvoted_ids=[])
 
-    @ddt.data(*itertools.product([True, False], [True, False]))
-    @ddt.unpack
-    @mock.patch("eventtracking.tracker.emit")
-    def test_abuse_flagged(self, old_flagged, new_flagged, mock_emit):
-        """
-        Test attempts to edit the "abuse_flagged" field.
-
-        old_flagged indicates whether the comment should be flagged at the start
-        of the test. new_flagged indicates the value for the "abuse_flagged"
-        field in the update. If old_flagged and new_flagged are the same, no
-        update should be made. Otherwise, a PUT should be made to the flag or
-        or unflag endpoint according to the new_flagged value.
-        """
-        self.register_get_user_response(self.user)
-        self.register_comment_flag_response("test_comment")
-        self.register_comment({"abuse_flaggers": [str(self.user.id)] if old_flagged else []})
-        data = {"abuse_flagged": new_flagged}
-        result = update_comment(self.request, "test_comment", data)
-        assert result['abuse_flagged'] == new_flagged
-        last_request_path = urlparse(httpretty.last_request().path).path  # lint-amnesty, pylint: disable=no-member
-        flag_url = "/api/v1/comments/test_comment/abuse_flag"
-        unflag_url = "/api/v1/comments/test_comment/abuse_unflag"
-        if old_flagged == new_flagged:
-            assert last_request_path != flag_url
-            assert last_request_path != unflag_url
-        else:
-            assert last_request_path == (flag_url if new_flagged else unflag_url)
-            assert httpretty.last_request().method == 'PUT'
-            assert parsed_body(httpretty.last_request()) == {'user_id': [str(self.user.id)]}
-
-            expected_event_name = 'edx.forum.response.reported' if new_flagged else 'edx.forum.response.unreported'
-            expected_event_data = {
-                'body': 'Original body',
-                'id': 'test_comment',
-                'content_type': 'Response',
-                'commentable_id': 'dummy',
-                'url': '',
-                'truncated': False,
-                'user_course_roles': [],
-                'user_forums_roles': [FORUM_ROLE_STUDENT],
-                'target_username': self.user.username,
-            }
-            if not new_flagged:
-                expected_event_data['reported_status_cleared'] = False
-
-            actual_event_name, actual_event_data = mock_emit.call_args[0]
-            self.assertEqual(actual_event_name, expected_event_name)
-            self.assertEqual(actual_event_data, expected_event_data)
-
-    @ddt.data(
-        (False, True),
-        (True, True),
-    )
-    @ddt.unpack
-    @mock.patch("eventtracking.tracker.emit")
-    def test_comment_un_abuse_flag_for_moderator_role(self, is_author, remove_all, mock_emit):
-        """
-        Test un-abuse flag for moderator role.
-
-        When moderator unflags a reported comment, it should
-        pass the "all" flag to the api. This will indicate
-        to the api to clear all abuse_flaggers, and mark the
-        comment as unreported.
-        """
-        _assign_role_to_user(user=self.user, course_id=self.course.id, role=FORUM_ROLE_ADMINISTRATOR)
-        self.register_get_user_response(self.user)
-        self.register_comment_flag_response("test_comment")
-        self.register_comment({"abuse_flaggers": ["11"], "user_id": str(self.user.id) if is_author else "12"})
-        data = {"abuse_flagged": False}
-        update_comment(self.request, "test_comment", data)
-        assert httpretty.last_request().method == 'PUT'
-        query_params = {'user_id': [str(self.user.id)]}
-        if remove_all:
-            query_params.update({'all': ['True']})
-        assert parsed_body(httpretty.last_request()) == query_params
-
-        expected_event_name = 'edx.forum.response.unreported'
-        expected_event_data = {
-            'body': 'Original body',
-            'id': 'test_comment',
-            'content_type': 'Response',
-            'commentable_id': 'dummy',
-            'truncated': False,
-            'url': '',
-            'user_course_roles': [],
-            'user_forums_roles': [FORUM_ROLE_STUDENT, FORUM_ROLE_ADMINISTRATOR],
-            'target_username': self.user.username,
-            'reported_status_cleared': False,
-        }
-
-        actual_event_name, actual_event_data = mock_emit.call_args[0]
-        self.assertEqual(actual_event_name, expected_event_name)
-        self.assertEqual(actual_event_data, expected_event_data)
-
     @ddt.data(
         FORUM_ROLE_ADMINISTRATOR,
         FORUM_ROLE_MODERATOR,