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

This will force the use of the new v2 forum's APIs for searching.

Author: Ali-Salman29

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

@@ -241,3 +241,219 @@ def test_team_discussion_id_not_cohorted(self, mock_is_forum_v2_enabled, mock_re
         self.call_view(mock_is_forum_v2_enabled, mock_request, team.discussion_topic_id, self.student, '')
 
         self._assert_comments_service_called_without_group_id(mock_request)
+
+
+class GroupIdAssertionMixinV2:
+    """
+    Provides assertion methods for testing group_id functionality in forum v2.
+
+    This mixin contains helper methods to verify that the comments service is called
+    with the correct group_id parameters and that responses contain the expected
+    group information.
+    """
+    def _get_params_last_call(self, function_name):
+        """
+        Returns the data or params dict that `mock_request` was called with.
+        """
+        return self.get_mock_func_calls(function_name)[-1][1]
+
+    def _assert_comments_service_called_with_group_id(self, group_id):
+        assert self.check_mock_called('get_user_threads')
+        assert self._get_params_last_call('get_user_threads')['group_id'] == group_id
+
+    def _assert_comments_service_called_without_group_id(self):
+        assert self.check_mock_called('get_user_threads')
+        assert 'group_id' not in self._get_params_last_call('get_user_threads')
+
+    def _assert_html_response_contains_group_info(self, response):
+        group_info = {"group_id": None, "group_name": None}
+        match = re.search(r'"group_id": (\d*),', response.content.decode('utf-8'))
+        if match and match.group(1) != '':
+            group_info["group_id"] = int(match.group(1))
+        match = re.search(r'"group_name": "(\w*)"', response.content.decode('utf-8'))
+        if match:
+            group_info["group_name"] = match.group(1)
+        self._assert_thread_contains_group_info(group_info)
+
+    def _assert_json_response_contains_group_info(self, response, extract_thread=None):
+        """
+        :param extract_thread: a function which accepts a dictionary (complete
+            json response payload) and returns another dictionary (first
+            occurrence of a thread model within that payload).  if None is
+            passed, the identity function is assumed.
+        """
+        payload = json.loads(response.content.decode('utf-8'))
+        thread = extract_thread(payload) if extract_thread else payload
+        self._assert_thread_contains_group_info(thread)
+
+    def _assert_thread_contains_group_info(self, thread):
+        assert thread['group_id'] == self.student_cohort.id
+        assert thread['group_name'] == self.student_cohort.name
+
+
+class CohortedTopicGroupIdTestMixinV2(GroupIdAssertionMixinV2):
+    """
+    Provides test cases to verify that views pass the correct `group_id` to
+    the comments service when requesting content in cohorted discussions for forum v2.
+    """
+    def call_view(self, commentable_id, user, group_id, pass_group_id=True):
+        """
+        Call the view for the implementing test class, constructing a request
+        from the parameters.
+        """
+        pass  # lint-amnesty, pylint: disable=unnecessary-pass
+
+    def test_cohorted_topic_student_without_group_id(self):
+        self.call_view("cohorted_topic", self.student, '', pass_group_id=False)
+        self._assert_comments_service_called_with_group_id(self.student_cohort.id)
+
+    def test_cohorted_topic_student_none_group_id(self):
+        self.call_view("cohorted_topic", self.student, "")
+        self._assert_comments_service_called_with_group_id(self.student_cohort.id)
+
+    def test_cohorted_topic_student_with_own_group_id(self):
+        self.call_view("cohorted_topic", self.student, self.student_cohort.id)
+        self._assert_comments_service_called_with_group_id(self.student_cohort.id)
+
+    def test_cohorted_topic_student_with_other_group_id(self):
+        self.call_view(
+            "cohorted_topic",
+            self.student,
+            self.moderator_cohort.id
+        )
+        self._assert_comments_service_called_with_group_id(self.student_cohort.id)
+
+    def test_cohorted_topic_moderator_without_group_id(self):
+        self.call_view(
+            "cohorted_topic",
+            self.moderator,
+            '',
+            pass_group_id=False
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_cohorted_topic_moderator_none_group_id(self):
+        self.call_view("cohorted_topic", self.moderator, "")
+        self._assert_comments_service_called_without_group_id()
+
+    def test_cohorted_topic_moderator_with_own_group_id(self):
+        self.call_view(
+            "cohorted_topic",
+            self.moderator,
+            self.moderator_cohort.id
+        )
+        self._assert_comments_service_called_with_group_id(self.moderator_cohort.id)
+
+    def test_cohorted_topic_moderator_with_other_group_id(self):
+        self.call_view(
+            "cohorted_topic",
+            self.moderator,
+            self.student_cohort.id
+        )
+        self._assert_comments_service_called_with_group_id(self.student_cohort.id)
+
+    def test_cohorted_topic_moderator_with_invalid_group_id(self):
+        invalid_id = self.student_cohort.id + self.moderator_cohort.id
+        response = self.call_view("cohorted_topic", self.moderator, invalid_id)  # lint-amnesty, pylint: disable=assignment-from-no-return
+        assert response.status_code == 500
+
+    def test_cohorted_topic_enrollment_track_invalid_group_id(self):
+        CourseModeFactory.create(course_id=self.course.id, mode_slug=CourseMode.AUDIT)
+        CourseModeFactory.create(course_id=self.course.id, mode_slug=CourseMode.VERIFIED)
+        discussion_settings = CourseDiscussionSettings.get(self.course.id)
+        discussion_settings.update({
+            'divided_discussions': ['cohorted_topic'],
+            'division_scheme': CourseDiscussionSettings.ENROLLMENT_TRACK,
+            'always_divide_inline_discussions': True,
+        })
+
+        invalid_id = -1000
+        response = self.call_view("cohorted_topic", self.moderator, invalid_id)  # lint-amnesty, pylint: disable=assignment-from-no-return
+        assert response.status_code == 500
+
+
+class NonCohortedTopicGroupIdTestMixinV2(GroupIdAssertionMixinV2):
+    """
+    Provides test cases to verify that views pass the correct `group_id` to
+    the comments service when requesting content in non-cohorted discussions for forum v2.
+    """
+    def call_view(self, commentable_id, user, group_id, pass_group_id=True):
+        """
+        Call the view for the implementing test class, constructing a request
+        from the parameters.
+        """
+        pass  # lint-amnesty, pylint: disable=unnecessary-pass
+
+    def test_non_cohorted_topic_student_without_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.student,
+            '',
+            pass_group_id=False
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_student_none_group_id(self):
+        self.call_view("non_cohorted_topic", self.student, '')
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_student_with_own_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.student,
+            self.student_cohort.id
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_student_with_other_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.student,
+            self.moderator_cohort.id
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_moderator_without_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.moderator,
+            "",
+            pass_group_id=False,
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_moderator_none_group_id(self):
+        self.call_view("non_cohorted_topic", self.moderator, '')
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_moderator_with_own_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.moderator,
+            self.moderator_cohort.id,
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_moderator_with_other_group_id(self):
+        self.call_view(
+            "non_cohorted_topic",
+            self.moderator,
+            self.student_cohort.id,
+        )
+        self._assert_comments_service_called_without_group_id()
+
+    def test_non_cohorted_topic_moderator_with_invalid_group_id(self):
+        invalid_id = self.student_cohort.id + self.moderator_cohort.id
+        self.call_view("non_cohorted_topic", self.moderator, invalid_id)
+        self._assert_comments_service_called_without_group_id()
+
+    def test_team_discussion_id_not_cohorted(self):
+        team = CourseTeamFactory(
+            course_id=self.course.id,
+            topic_id='topic-id'
+        )
+
+        team.add_user(self.student)
+        self.call_view(team.discussion_topic_id, self.student, '')
+
+        self._assert_comments_service_called_without_group_id()