tests.py 66.1 KB
Newer Older
1 2
"""Tests for django comment client views."""
from contextlib import contextmanager
3
import logging
4
import json
Ben McMorran committed
5
import ddt
6

Ben McMorran committed
7 8
from django.conf import settings
from django.core.cache import get_cache
9
from django.test.client import Client, RequestFactory
10
from django.contrib.auth.models import User
11
from django.core.management import call_command
12
from django.core.urlresolvers import reverse
Ben McMorran committed
13
from request_cache.middleware import RequestCache
14
from mock import patch, ANY, Mock
15
from nose.tools import assert_true, assert_equal  # pylint: disable=no-name-in-module
16
from opaque_keys.edx.locations import SlashSeparatedCourseKey
17
from lms.lib.comment_client import Thread
18

19
from common.test.utils import MockSignalHandlerMixin, disable_signal
20
from django_comment_client.base import views
21
from django_comment_client.tests.group_id import CohortedTopicGroupIdTestMixin, NonCohortedTopicGroupIdTestMixin, GroupIdAssertionMixin
22
from django_comment_client.tests.utils import CohortedTestCase
23
from django_comment_client.tests.unicode import UnicodeTestMixin
24
from django_comment_common.models import Role
25
from django_comment_common.utils import seed_permissions_roles, ThreadContext
26
from student.tests.factories import CourseEnrollmentFactory, UserFactory, CourseAccessRoleFactory
27
from util.testing import UrlResetMixin
Ben McMorran committed
28
from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
29
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
Ben McMorran committed
30 31 32
from xmodule.modulestore.tests.factories import check_mongo_calls
from xmodule.modulestore.django import modulestore
from xmodule.modulestore import ModuleStoreEnum
33

34 35
from teams.tests.factories import CourseTeamFactory

36

37 38
log = logging.getLogger(__name__)

39
CS_PREFIX = "http://localhost:4567/api/v1"
40

41
# pylint: disable=missing-docstring
muhammad-ammar committed
42

43 44

class MockRequestSetupMixin(object):
45 46
    def _create_response_mock(self, data):
        return Mock(text=json.dumps(data), json=Mock(return_value=data))
47

48
    def _set_mock_request_data(self, mock_request, data):
49
        mock_request.return_value = self._create_response_mock(data)
50 51


52
@patch('lms.lib.comment_client.utils.requests.request')
53
class CreateThreadGroupIdTestCase(
54
        MockRequestSetupMixin,
55
        CohortedTestCase,
56 57 58 59 60 61
        CohortedTopicGroupIdTestMixin,
        NonCohortedTopicGroupIdTestMixin
):
    cs_endpoint = "/threads"

    def call_view(self, mock_request, commentable_id, user, group_id, pass_group_id=True):
62
        self._set_mock_request_data(mock_request, {})
63 64 65 66 67 68 69 70 71 72
        mock_request.return_value.status_code = 200
        request_data = {"body": "body", "title": "title", "thread_type": "discussion"}
        if pass_group_id:
            request_data["group_id"] = group_id
        request = RequestFactory().post("dummy_url", request_data)
        request.user = user
        request.view_name = "create_thread"

        return views.create_thread(
            request,
73
            course_id=unicode(self.course.id),
74 75
            commentable_id=commentable_id
        )
76

77 78 79 80 81 82 83 84 85 86 87
    def test_group_info_in_response(self, mock_request):
        response = self.call_view(
            mock_request,
            "cohorted_topic",
            self.student,
            None
        )
        self._assert_json_response_contains_group_info(response)


@patch('lms.lib.comment_client.utils.requests.request')
88 89 90
@disable_signal(views, 'thread_edited')
@disable_signal(views, 'thread_voted')
@disable_signal(views, 'thread_deleted')
91 92
class ThreadActionGroupIdTestCase(
        MockRequestSetupMixin,
93
        CohortedTestCase,
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
        GroupIdAssertionMixin
):
    def call_view(
            self,
            view_name,
            mock_request,
            user=None,
            post_params=None,
            view_args=None
    ):
        self._set_mock_request_data(
            mock_request,
            {
                "user_id": str(self.student.id),
                "group_id": self.student_cohort.id,
                "closed": False,
110 111
                "type": "thread",
                "commentable_id": "non_team_dummy_id"
112 113 114 115 116 117 118 119 120
            }
        )
        mock_request.return_value.status_code = 200
        request = RequestFactory().post("dummy_url", post_params or {})
        request.user = user or self.student
        request.view_name = view_name

        return getattr(views, view_name)(
            request,
121
            course_id=unicode(self.course.id),
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
            thread_id="dummy",
            **(view_args or {})
        )

    def test_update(self, mock_request):
        response = self.call_view(
            "update_thread",
            mock_request,
            post_params={"body": "body", "title": "title"}
        )
        self._assert_json_response_contains_group_info(response)

    def test_delete(self, mock_request):
        response = self.call_view("delete_thread", mock_request)
        self._assert_json_response_contains_group_info(response)

    def test_vote(self, mock_request):
        response = self.call_view(
            "vote_for_thread",
            mock_request,
            view_args={"value": "up"}
        )
        self._assert_json_response_contains_group_info(response)
        response = self.call_view("undo_vote_for_thread", mock_request)
        self._assert_json_response_contains_group_info(response)

    def test_flag(self, mock_request):
        response = self.call_view("flag_abuse_for_thread", mock_request)
        self._assert_json_response_contains_group_info(response)
        response = self.call_view("un_flag_abuse_for_thread", mock_request)
        self._assert_json_response_contains_group_info(response)

    def test_pin(self, mock_request):
        response = self.call_view(
            "pin_thread",
            mock_request,
            user=self.moderator
        )
        self._assert_json_response_contains_group_info(response)
        response = self.call_view(
            "un_pin_thread",
            mock_request,
            user=self.moderator
        )
        self._assert_json_response_contains_group_info(response)

    def test_openclose(self, mock_request):
        response = self.call_view(
            "openclose_thread",
            mock_request,
            user=self.moderator
        )
        self._assert_json_response_contains_group_info(
            response,
            lambda d: d['content']
        )


Ben McMorran committed
180 181 182 183 184 185 186
class ViewsTestCaseMixin(object):
    """
    This class is used by both ViewsQueryCountTestCase and ViewsTestCase. By
    breaking out set_up_course into its own method, ViewsQueryCountTestCase
    can build a course in a particular modulestore, while ViewsTestCase can
    just run it in setUp for all tests.
    """
187

Ben McMorran committed
188 189 190 191 192
    def set_up_course(self, module_count=0):
        """
        Creates a course, optionally with module_count discussion modules, and
        a user with appropriate permissions.
        """
193

194
        # create a course
polesye committed
195 196 197 198 199
        self.course = CourseFactory.create(
            org='MITx', course='999',
            discussion_topics={"Some Topic": {"id": "some_topic"}},
            display_name='Robot Super Course',
        )
200
        self.course_id = self.course.id
Ben McMorran committed
201 202 203 204 205 206 207 208 209 210 211

        # add some discussion modules
        for i in range(module_count):
            ItemFactory.create(
                parent_location=self.course.location,
                category='discussion',
                discussion_id='id_module_{}'.format(i),
                discussion_category='Category {}'.format(i),
                discussion_target='Discussion {}'.format(i)
            )

212
        # seed the forums permissions and roles
213
        call_command('seed_permissions_roles', unicode(self.course_id))
214

215 216 217 218 219
        # Patch the comment client user save method so it does not try
        # to create a new cc user when creating a django user
        with patch('student.models.cc.User.save'):
            uname = 'student'
            email = 'student@edx.org'
220
            self.password = 'test'  # pylint: disable=attribute-defined-outside-init
221 222

            # Create the user and make them active so we can log them in.
223
            self.student = User.objects.create_user(uname, email, self.password)  # pylint: disable=attribute-defined-outside-init
224 225 226
            self.student.is_active = True
            self.student.save()

227 228 229
            # Add a discussion moderator
            self.moderator = UserFactory.create(password=self.password)  # pylint: disable=attribute-defined-outside-init

230 231 232
            # Enroll the student in the course
            CourseEnrollmentFactory(user=self.student,
                                    course_id=self.course_id)
233

234 235 236 237
            # Enroll the moderator and give them the appropriate roles
            CourseEnrollmentFactory(user=self.moderator, course_id=self.course.id)
            self.moderator.roles.add(Role.objects.get(name="Moderator", course_id=self.course.id))

238
            self.client = Client()
239
            assert_true(self.client.login(username='student', password=self.password))
240

Ben McMorran committed
241 242 243 244 245 246 247 248 249
    def _setup_mock_request(self, mock_request, include_depth=False):
        """
        Ensure that mock_request returns the data necessary to make views
        function correctly
        """
        mock_request.return_value.status_code = 200
        data = {
            "user_id": str(self.student.id),
            "closed": False,
250
            "commentable_id": "non_team_dummy_id"
Ben McMorran committed
251 252 253 254 255
        }
        if include_depth:
            data["depth"] = 0
        self._set_mock_request_data(mock_request, data)

256
    def create_thread_helper(self, mock_request, extra_request_data=None, extra_response_data=None):
Ben McMorran committed
257 258 259
        """
        Issues a request to create a thread and verifies the result.
        """
260
        mock_request.return_value.status_code = 200
261
        self._set_mock_request_data(mock_request, {
262
            "thread_type": "discussion",
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
            "title": "Hello",
            "body": "this is a post",
            "course_id": "MITx/999/Robot_Super_Course",
            "anonymous": False,
            "anonymous_to_peers": False,
            "commentable_id": "i4x-MITx-999-course-Robot_Super_Course",
            "created_at": "2013-05-10T18:53:43Z",
            "updated_at": "2013-05-10T18:53:43Z",
            "at_position_list": [],
            "closed": False,
            "id": "518d4237b023791dca00000d",
            "user_id": "1",
            "username": "robot",
            "votes": {
                "count": 0,
                "up_count": 0,
                "down_count": 0,
                "point": 0
            },
            "abuse_flaggers": [],
            "type": "thread",
            "group_id": None,
            "pinned": False,
            "endorsed": False,
            "unread_comments_count": 0,
            "read": False,
            "comments_count": 0,
        })
291 292 293 294 295 296 297 298
        thread = {
            "thread_type": "discussion",
            "body": ["this is a post"],
            "anonymous_to_peers": ["false"],
            "auto_subscribe": ["false"],
            "anonymous": ["false"],
            "title": ["Hello"],
        }
299 300
        if extra_request_data:
            thread.update(extra_request_data)
301
        url = reverse('create_thread', kwargs={'commentable_id': 'i4x-MITx-999-course-Robot_Super_Course',
302
                                               'course_id': unicode(self.course_id)})
303
        response = self.client.post(url, data=thread)
304
        assert_true(mock_request.called)
305 306 307
        expected_data = {
            'thread_type': 'discussion',
            'body': u'this is a post',
308
            'context': ThreadContext.COURSE,
309 310 311 312 313 314
            'anonymous_to_peers': False, 'user_id': 1,
            'title': u'Hello',
            'commentable_id': u'i4x-MITx-999-course-Robot_Super_Course',
            'anonymous': False,
            'course_id': unicode(self.course_id),
        }
315 316
        if extra_response_data:
            expected_data.update(extra_response_data)
317 318
        mock_request.assert_called_with(
            'post',
319
            '{prefix}/i4x-MITx-999-course-Robot_Super_Course/threads'.format(prefix=CS_PREFIX),
320
            data=expected_data,
321
            params={'request_id': ANY},
322
            headers=ANY,
323 324
            timeout=5
        )
325
        assert_equal(response.status_code, 200)
326

Ben McMorran committed
327 328 329 330 331
    def update_thread_helper(self, mock_request):
        """
        Issues a request to update a thread and verifies the result.
        """
        self._setup_mock_request(mock_request)
332 333 334 335 336 337
        # Mock out saving in order to test that content is correctly
        # updated. Otherwise, the call to thread.save() receives the
        # same mocked request data that the original call to retrieve
        # the thread did, overwriting any changes.
        with patch.object(Thread, 'save'):
            response = self.client.post(
Peter Fogg committed
338 339
                reverse("update_thread", kwargs={
                    "thread_id": "dummy",
340
                    "course_id": unicode(self.course_id)
Peter Fogg committed
341
                }),
342 343
                data={"body": "foo", "title": "foo", "commentable_id": "some_topic"}
            )
Ben McMorran committed
344
        self.assertEqual(response.status_code, 200)
345 346 347 348
        data = json.loads(response.content)
        self.assertEqual(data['body'], 'foo')
        self.assertEqual(data['title'], 'foo')
        self.assertEqual(data['commentable_id'], 'some_topic')
Ben McMorran committed
349 350 351 352


@ddt.ddt
@patch('lms.lib.comment_client.utils.requests.request')
353 354
@disable_signal(views, 'thread_created')
@disable_signal(views, 'thread_edited')
Ben McMorran committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
class ViewsQueryCountTestCase(UrlResetMixin, ModuleStoreTestCase, MockRequestSetupMixin, ViewsTestCaseMixin):

    @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
    def setUp(self):
        super(ViewsQueryCountTestCase, self).setUp(create_user=False)

    def clear_caches(self):
        """Clears caches so that query count numbers are accurate."""
        for cache in settings.CACHES:
            get_cache(cache).clear()
        RequestCache.clear_request_cache()

    def count_queries(func):  # pylint: disable=no-self-argument
        """
        Decorates test methods to count mongo and SQL calls for a
        particular modulestore.
        """
        def inner(self, default_store, module_count, mongo_calls, sql_queries, *args, **kwargs):
            with modulestore().default_store(default_store):
                self.set_up_course(module_count=module_count)
                self.clear_caches()
                with self.assertNumQueries(sql_queries):
                    with check_mongo_calls(mongo_calls):
                        func(self, *args, **kwargs)
        return inner

    @ddt.data(
382 383 384 385
        (ModuleStoreEnum.Type.mongo, 3, 4, 22),
        (ModuleStoreEnum.Type.mongo, 20, 4, 22),
        (ModuleStoreEnum.Type.split, 3, 13, 22),
        (ModuleStoreEnum.Type.split, 20, 13, 22),
Ben McMorran committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    )
    @ddt.unpack
    @count_queries
    def test_create_thread(self, mock_request):
        self.create_thread_helper(mock_request)

    @ddt.data(
        (ModuleStoreEnum.Type.mongo, 3, 3, 16),
        (ModuleStoreEnum.Type.mongo, 20, 3, 16),
        (ModuleStoreEnum.Type.split, 3, 10, 16),
        (ModuleStoreEnum.Type.split, 20, 10, 16),
    )
    @ddt.unpack
    @count_queries
    def test_update_thread(self, mock_request):
        self.update_thread_helper(mock_request)


404
@ddt.ddt
Ben McMorran committed
405
@patch('lms.lib.comment_client.utils.requests.request')
406 407 408 409 410 411 412
class ViewsTestCase(
        UrlResetMixin,
        ModuleStoreTestCase,
        MockRequestSetupMixin,
        ViewsTestCaseMixin,
        MockSignalHandlerMixin
):
Ben McMorran committed
413 414 415 416 417 418 419 420 421

    @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
    def setUp(self):
        # Patching the ENABLE_DISCUSSION_SERVICE value affects the contents of urls.py,
        # so we need to call super.setUp() which reloads urls.py (because
        # of the UrlResetMixin)
        super(ViewsTestCase, self).setUp(create_user=False)
        self.set_up_course()

422 423 424 425 426 427 428
    @contextmanager
    def assert_discussion_signals(self, signal, user=None):
        if user is None:
            user = self.student
        with self.assert_signal_sent(views, signal, sender=None, user=user, exclude_args=('post',)):
            yield

Ben McMorran committed
429
    def test_create_thread(self, mock_request):
430 431
        with self.assert_discussion_signals('thread_created'):
            self.create_thread_helper(mock_request)
Ben McMorran committed
432

433 434 435 436 437 438 439 440 441 442 443
    def test_create_thread_standalone(self, mock_request):
        team = CourseTeamFactory.create(
            name="A Team",
            course_id=self.course_id,
            topic_id='topic_id',
            discussion_topic_id="i4x-MITx-999-course-Robot_Super_Course"
        )

        # Add the student to the team so they can post to the commentable.
        team.add_user(self.student)

444
        # create_thread_helper verifies that extra data are passed through to the comments service
445
        self.create_thread_helper(mock_request, extra_response_data={'context': ThreadContext.STANDALONE})
446

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
    def test_delete_thread(self, mock_request):
        self._set_mock_request_data(mock_request, {
            "user_id": str(self.student.id),
            "closed": False,
        })
        test_thread_id = "test_thread_id"
        request = RequestFactory().post("dummy_url", {"id": test_thread_id})
        request.user = self.student
        request.view_name = "delete_thread"
        with self.assert_discussion_signals('thread_deleted'):
            response = views.delete_thread(
                request,
                course_id=unicode(self.course.id),
                thread_id=test_thread_id
            )
        self.assertEqual(response.status_code, 200)
        self.assertTrue(mock_request.called)

465
    def test_delete_comment(self, mock_request):
466
        self._set_mock_request_data(mock_request, {
467 468 469 470 471 472 473
            "user_id": str(self.student.id),
            "closed": False,
        })
        test_comment_id = "test_comment_id"
        request = RequestFactory().post("dummy_url", {"id": test_comment_id})
        request.user = self.student
        request.view_name = "delete_comment"
474 475 476 477 478 479
        with self.assert_discussion_signals('comment_deleted'):
            response = views.delete_comment(
                request,
                course_id=unicode(self.course.id),
                comment_id=test_comment_id
            )
480 481 482 483 484 485
        self.assertEqual(response.status_code, 200)
        self.assertTrue(mock_request.called)
        args = mock_request.call_args[0]
        self.assertEqual(args[0], "delete")
        self.assertTrue(args[1].endswith("/{}".format(test_comment_id)))

486 487 488 489 490 491 492
    def _test_request_error(self, view_name, view_kwargs, data, mock_request):
        """
        Submit a request against the given view with the given data and ensure
        that the result is a 400 error and that no data was posted using
        mock_request
        """
        self._setup_mock_request(mock_request, include_depth=(view_name == "create_sub_comment"))
493 494 495 496 497 498 499 500 501

        response = self.client.post(reverse(view_name, kwargs=view_kwargs), data=data)
        self.assertEqual(response.status_code, 400)
        for call in mock_request.call_args_list:
            self.assertEqual(call[0][0].lower(), "get")

    def test_create_thread_no_title(self, mock_request):
        self._test_request_error(
            "create_thread",
502
            {"commentable_id": "dummy", "course_id": unicode(self.course_id)},
503 504 505 506 507 508 509
            {"body": "foo"},
            mock_request
        )

    def test_create_thread_empty_title(self, mock_request):
        self._test_request_error(
            "create_thread",
510
            {"commentable_id": "dummy", "course_id": unicode(self.course_id)},
511 512 513 514 515 516 517
            {"body": "foo", "title": " "},
            mock_request
        )

    def test_create_thread_no_body(self, mock_request):
        self._test_request_error(
            "create_thread",
518
            {"commentable_id": "dummy", "course_id": unicode(self.course_id)},
519 520 521 522 523 524 525
            {"title": "foo"},
            mock_request
        )

    def test_create_thread_empty_body(self, mock_request):
        self._test_request_error(
            "create_thread",
526
            {"commentable_id": "dummy", "course_id": unicode(self.course_id)},
527 528 529 530 531 532 533
            {"body": " ", "title": "foo"},
            mock_request
        )

    def test_update_thread_no_title(self, mock_request):
        self._test_request_error(
            "update_thread",
534
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
535 536 537 538 539 540 541
            {"body": "foo"},
            mock_request
        )

    def test_update_thread_empty_title(self, mock_request):
        self._test_request_error(
            "update_thread",
542
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
543 544 545 546 547 548 549
            {"body": "foo", "title": " "},
            mock_request
        )

    def test_update_thread_no_body(self, mock_request):
        self._test_request_error(
            "update_thread",
550
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
551 552 553 554 555 556 557
            {"title": "foo"},
            mock_request
        )

    def test_update_thread_empty_body(self, mock_request):
        self._test_request_error(
            "update_thread",
558
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
559 560 561 562
            {"body": " ", "title": "foo"},
            mock_request
        )

polesye committed
563
    def test_update_thread_course_topic(self, mock_request):
564 565
        with self.assert_discussion_signals('thread_edited'):
            self.update_thread_helper(mock_request)
polesye committed
566

567
    @patch('django_comment_client.utils.get_discussion_categories_ids', return_value=["test_commentable"])
568 569 570
    def test_update_thread_wrong_commentable_id(self, mock_get_discussion_id_map, mock_request):
        self._test_request_error(
            "update_thread",
571
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
572 573 574 575
            {"body": "foo", "title": "foo", "commentable_id": "wrong_commentable"},
            mock_request
        )

576 577 578 579 580 581 582 583 584 585 586 587
    def test_create_comment(self, mock_request):
        self._setup_mock_request(mock_request)
        with self.assert_discussion_signals('comment_created'):
            response = self.client.post(
                reverse(
                    "create_comment",
                    kwargs={"course_id": unicode(self.course_id), "thread_id": "dummy"}
                ),
                data={"body": "body"}
            )
        self.assertEqual(response.status_code, 200)

588 589 590
    def test_create_comment_no_body(self, mock_request):
        self._test_request_error(
            "create_comment",
591
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
592 593 594 595 596 597 598
            {},
            mock_request
        )

    def test_create_comment_empty_body(self, mock_request):
        self._test_request_error(
            "create_comment",
599
            {"thread_id": "dummy", "course_id": unicode(self.course_id)},
600 601 602 603 604 605 606
            {"body": " "},
            mock_request
        )

    def test_create_sub_comment_no_body(self, mock_request):
        self._test_request_error(
            "create_sub_comment",
607
            {"comment_id": "dummy", "course_id": unicode(self.course_id)},
608 609 610 611 612 613 614
            {},
            mock_request
        )

    def test_create_sub_comment_empty_body(self, mock_request):
        self._test_request_error(
            "create_sub_comment",
615
            {"comment_id": "dummy", "course_id": unicode(self.course_id)},
616 617 618 619 620 621 622
            {"body": " "},
            mock_request
        )

    def test_update_comment_no_body(self, mock_request):
        self._test_request_error(
            "update_comment",
623
            {"comment_id": "dummy", "course_id": unicode(self.course_id)},
624 625 626 627 628 629 630
            {},
            mock_request
        )

    def test_update_comment_empty_body(self, mock_request):
        self._test_request_error(
            "update_comment",
631
            {"comment_id": "dummy", "course_id": unicode(self.course_id)},
632 633 634 635
            {"body": " "},
            mock_request
        )

636 637 638 639
    def test_update_comment_basic(self, mock_request):
        self._setup_mock_request(mock_request)
        comment_id = "test_comment_id"
        updated_body = "updated body"
640 641 642 643 644 645 646 647
        with self.assert_discussion_signals('comment_edited'):
            response = self.client.post(
                reverse(
                    "update_comment",
                    kwargs={"course_id": unicode(self.course_id), "comment_id": comment_id}
                ),
                data={"body": updated_body}
            )
648 649 650 651 652 653 654 655 656 657
        self.assertEqual(response.status_code, 200)
        mock_request.assert_called_with(
            "put",
            "{prefix}/comments/{comment_id}".format(prefix=CS_PREFIX, comment_id=comment_id),
            headers=ANY,
            params=ANY,
            timeout=ANY,
            data={"body": updated_body}
        )

658 659 660 661 662 663 664
    def test_flag_thread_open(self, mock_request):
        self.flag_thread(mock_request, False)

    def test_flag_thread_close(self, mock_request):
        self.flag_thread(mock_request, True)

    def flag_thread(self, mock_request, is_closed):
665
        mock_request.return_value.status_code = 200
666 667 668 669 670 671 672 673 674 675
        self._set_mock_request_data(mock_request, {
            "title": "Hello",
            "body": "this is a post",
            "course_id": "MITx/999/Robot_Super_Course",
            "anonymous": False,
            "anonymous_to_peers": False,
            "commentable_id": "i4x-MITx-999-course-Robot_Super_Course",
            "created_at": "2013-05-10T18:53:43Z",
            "updated_at": "2013-05-10T18:53:43Z",
            "at_position_list": [],
676
            "closed": is_closed,
677
            "id": "518d4237b023791dca00000d",
678
            "user_id": "1", "username": "robot",
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
            "votes": {
                "count": 0,
                "up_count": 0,
                "down_count": 0,
                "point": 0
            },
            "abuse_flaggers": [1],
            "type": "thread",
            "group_id": None,
            "pinned": False,
            "endorsed": False,
            "unread_comments_count": 0,
            "read": False,
            "comments_count": 0,
        })
694 695 696 697
        url = reverse('flag_abuse_for_thread', kwargs={
            'thread_id': '518d4237b023791dca00000d',
            'course_id': unicode(self.course_id)
        })
698
        response = self.client.post(url)
699
        assert_true(mock_request.called)
700

701 702
        call_list = [
            (
703
                ('get', '{prefix}/threads/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
704
                {
705 706
                    'data': None,
                    'params': {'mark_as_read': True, 'request_id': ANY},
707
                    'headers': ANY,
708 709 710 711
                    'timeout': 5
                }
            ),
            (
712
                ('put', '{prefix}/threads/518d4237b023791dca00000d/abuse_flag'.format(prefix=CS_PREFIX)),
713 714
                {
                    'data': {'user_id': '1'},
715
                    'params': {'request_id': ANY},
716
                    'headers': ANY,
717 718 719 720
                    'timeout': 5
                }
            ),
            (
721
                ('get', '{prefix}/threads/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
722
                {
723 724
                    'data': None,
                    'params': {'mark_as_read': True, 'request_id': ANY},
725
                    'headers': ANY,
726 727 728 729
                    'timeout': 5
                }
            )
        ]
730

731
        assert_equal(call_list, mock_request.call_args_list)
732 733

        assert_equal(response.status_code, 200)
734

735 736 737 738 739 740 741
    def test_un_flag_thread_open(self, mock_request):
        self.un_flag_thread(mock_request, False)

    def test_un_flag_thread_close(self, mock_request):
        self.un_flag_thread(mock_request, True)

    def un_flag_thread(self, mock_request, is_closed):
742
        mock_request.return_value.status_code = 200
743 744 745 746 747 748 749 750 751 752
        self._set_mock_request_data(mock_request, {
            "title": "Hello",
            "body": "this is a post",
            "course_id": "MITx/999/Robot_Super_Course",
            "anonymous": False,
            "anonymous_to_peers": False,
            "commentable_id": "i4x-MITx-999-course-Robot_Super_Course",
            "created_at": "2013-05-10T18:53:43Z",
            "updated_at": "2013-05-10T18:53:43Z",
            "at_position_list": [],
753
            "closed": is_closed,
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
            "id": "518d4237b023791dca00000d",
            "user_id": "1",
            "username": "robot",
            "votes": {
                "count": 0,
                "up_count": 0,
                "down_count": 0,
                "point": 0
            },
            "abuse_flaggers": [],
            "type": "thread",
            "group_id": None,
            "pinned": False,
            "endorsed": False,
            "unread_comments_count": 0,
            "read": False,
            "comments_count": 0
        })
772 773 774 775
        url = reverse('un_flag_abuse_for_thread', kwargs={
            'thread_id': '518d4237b023791dca00000d',
            'course_id': unicode(self.course_id)
        })
776 777 778
        response = self.client.post(url)
        assert_true(mock_request.called)

779 780
        call_list = [
            (
781
                ('get', '{prefix}/threads/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
782
                {
783 784
                    'data': None,
                    'params': {'mark_as_read': True, 'request_id': ANY},
785
                    'headers': ANY,
786 787 788 789
                    'timeout': 5
                }
            ),
            (
790
                ('put', '{prefix}/threads/518d4237b023791dca00000d/abuse_unflag'.format(prefix=CS_PREFIX)),
791 792
                {
                    'data': {'user_id': '1'},
793
                    'params': {'request_id': ANY},
794
                    'headers': ANY,
795 796 797 798
                    'timeout': 5
                }
            ),
            (
799
                ('get', '{prefix}/threads/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
800
                {
801 802
                    'data': None,
                    'params': {'mark_as_read': True, 'request_id': ANY},
803
                    'headers': ANY,
804 805 806 807
                    'timeout': 5
                }
            )
        ]
808

809
        assert_equal(call_list, mock_request.call_args_list)
810 811 812

        assert_equal(response.status_code, 200)

813 814 815 816 817 818 819
    def test_flag_comment_open(self, mock_request):
        self.flag_comment(mock_request, False)

    def test_flag_comment_close(self, mock_request):
        self.flag_comment(mock_request, True)

    def flag_comment(self, mock_request, is_closed):
820
        mock_request.return_value.status_code = 200
821 822 823 824 825 826 827 828 829
        self._set_mock_request_data(mock_request, {
            "body": "this is a comment",
            "course_id": "MITx/999/Robot_Super_Course",
            "anonymous": False,
            "anonymous_to_peers": False,
            "commentable_id": "i4x-MITx-999-course-Robot_Super_Course",
            "created_at": "2013-05-10T18:53:43Z",
            "updated_at": "2013-05-10T18:53:43Z",
            "at_position_list": [],
830
            "closed": is_closed,
831 832 833 834 835 836 837 838 839 840 841 842 843
            "id": "518d4237b023791dca00000d",
            "user_id": "1",
            "username": "robot",
            "votes": {
                "count": 0,
                "up_count": 0,
                "down_count": 0,
                "point": 0
            },
            "abuse_flaggers": [1],
            "type": "comment",
            "endorsed": False
        })
844 845 846 847
        url = reverse('flag_abuse_for_comment', kwargs={
            'comment_id': '518d4237b023791dca00000d',
            'course_id': unicode(self.course_id)
        })
848 849 850
        response = self.client.post(url)
        assert_true(mock_request.called)

851 852
        call_list = [
            (
853
                ('get', '{prefix}/comments/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
854
                {
855 856
                    'data': None,
                    'params': {'request_id': ANY},
857
                    'headers': ANY,
858 859 860 861
                    'timeout': 5
                }
            ),
            (
862
                ('put', '{prefix}/comments/518d4237b023791dca00000d/abuse_flag'.format(prefix=CS_PREFIX)),
863 864
                {
                    'data': {'user_id': '1'},
865
                    'params': {'request_id': ANY},
866
                    'headers': ANY,
867 868 869 870
                    'timeout': 5
                }
            ),
            (
871
                ('get', '{prefix}/comments/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
872
                {
873 874
                    'data': None,
                    'params': {'request_id': ANY},
875
                    'headers': ANY,
876 877 878 879
                    'timeout': 5
                }
            )
        ]
880

881
        assert_equal(call_list, mock_request.call_args_list)
882 883 884

        assert_equal(response.status_code, 200)

885 886 887 888 889 890 891
    def test_un_flag_comment_open(self, mock_request):
        self.un_flag_comment(mock_request, False)

    def test_un_flag_comment_close(self, mock_request):
        self.un_flag_comment(mock_request, True)

    def un_flag_comment(self, mock_request, is_closed):
892
        mock_request.return_value.status_code = 200
893 894 895 896 897 898 899 900 901
        self._set_mock_request_data(mock_request, {
            "body": "this is a comment",
            "course_id": "MITx/999/Robot_Super_Course",
            "anonymous": False,
            "anonymous_to_peers": False,
            "commentable_id": "i4x-MITx-999-course-Robot_Super_Course",
            "created_at": "2013-05-10T18:53:43Z",
            "updated_at": "2013-05-10T18:53:43Z",
            "at_position_list": [],
902
            "closed": is_closed,
903 904 905 906 907 908 909 910 911 912 913 914 915
            "id": "518d4237b023791dca00000d",
            "user_id": "1",
            "username": "robot",
            "votes": {
                "count": 0,
                "up_count": 0,
                "down_count": 0,
                "point": 0
            },
            "abuse_flaggers": [],
            "type": "comment",
            "endorsed": False
        })
916 917 918 919
        url = reverse('un_flag_abuse_for_comment', kwargs={
            'comment_id': '518d4237b023791dca00000d',
            'course_id': unicode(self.course_id)
        })
920 921 922
        response = self.client.post(url)
        assert_true(mock_request.called)

923 924
        call_list = [
            (
925
                ('get', '{prefix}/comments/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
926
                {
927 928
                    'data': None,
                    'params': {'request_id': ANY},
929
                    'headers': ANY,
930 931 932 933
                    'timeout': 5
                }
            ),
            (
934
                ('put', '{prefix}/comments/518d4237b023791dca00000d/abuse_unflag'.format(prefix=CS_PREFIX)),
935 936
                {
                    'data': {'user_id': '1'},
937
                    'params': {'request_id': ANY},
938
                    'headers': ANY,
939 940 941 942
                    'timeout': 5
                }
            ),
            (
943
                ('get', '{prefix}/comments/518d4237b023791dca00000d'.format(prefix=CS_PREFIX)),
944
                {
945 946
                    'data': None,
                    'params': {'request_id': ANY},
947
                    'headers': ANY,
948 949 950 951
                    'timeout': 5
                }
            )
        ]
952

953
        assert_equal(call_list, mock_request.call_args_list)
954

955
        assert_equal(response.status_code, 200)
956

957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
    @ddt.data(
        ('upvote_thread', 'thread_id', 'thread_voted'),
        ('upvote_comment', 'comment_id', 'comment_voted'),
        ('downvote_thread', 'thread_id', 'thread_voted'),
        ('downvote_comment', 'comment_id', 'comment_voted')
    )
    @ddt.unpack
    def test_voting(self, view_name, item_id, signal, mock_request):
        self._setup_mock_request(mock_request)
        with self.assert_discussion_signals(signal):
            response = self.client.post(
                reverse(
                    view_name,
                    kwargs={item_id: 'dummy', 'course_id': unicode(self.course_id)}
                )
            )
        self.assertEqual(response.status_code, 200)

    def test_endorse_comment(self, mock_request):
        self._setup_mock_request(mock_request)
        self.client.login(username=self.moderator.username, password=self.password)
        with self.assert_discussion_signals('comment_endorsed', user=self.moderator):
            response = self.client.post(
                reverse(
                    'endorse_comment',
                    kwargs={'comment_id': 'dummy', 'course_id': unicode(self.course_id)}
                )
            )
        self.assertEqual(response.status_code, 200)

987

988
@patch("lms.lib.comment_client.utils.requests.request")
989
@disable_signal(views, 'comment_endorsed')
990
class ViewPermissionsTestCase(UrlResetMixin, ModuleStoreTestCase, MockRequestSetupMixin):
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
    @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
    def setUp(self):
        super(ViewPermissionsTestCase, self).setUp()
        self.password = "test password"
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create(password=self.password)
        self.moderator = UserFactory.create(password=self.password)
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)
        CourseEnrollmentFactory(user=self.moderator, course_id=self.course.id)
        self.moderator.roles.add(Role.objects.get(name="Moderator", course_id=self.course.id))

    def test_pin_thread_as_student(self, mock_request):
1004
        self._set_mock_request_data(mock_request, {})
1005 1006
        self.client.login(username=self.student.username, password=self.password)
        response = self.client.post(
1007
            reverse("pin_thread", kwargs={"course_id": unicode(self.course.id), "thread_id": "dummy"})
1008 1009 1010 1011
        )
        self.assertEqual(response.status_code, 401)

    def test_pin_thread_as_moderator(self, mock_request):
1012
        self._set_mock_request_data(mock_request, {})
1013 1014
        self.client.login(username=self.moderator.username, password=self.password)
        response = self.client.post(
1015
            reverse("pin_thread", kwargs={"course_id": unicode(self.course.id), "thread_id": "dummy"})
1016 1017 1018 1019
        )
        self.assertEqual(response.status_code, 200)

    def test_un_pin_thread_as_student(self, mock_request):
1020
        self._set_mock_request_data(mock_request, {})
1021 1022
        self.client.login(username=self.student.username, password=self.password)
        response = self.client.post(
1023
            reverse("un_pin_thread", kwargs={"course_id": unicode(self.course.id), "thread_id": "dummy"})
1024 1025 1026 1027
        )
        self.assertEqual(response.status_code, 401)

    def test_un_pin_thread_as_moderator(self, mock_request):
1028
        self._set_mock_request_data(mock_request, {})
1029 1030
        self.client.login(username=self.moderator.username, password=self.password)
        response = self.client.post(
1031
            reverse("un_pin_thread", kwargs={"course_id": unicode(self.course.id), "thread_id": "dummy"})
1032 1033 1034
        )
        self.assertEqual(response.status_code, 200)

1035 1036 1037 1038
    def _set_mock_request_thread_and_comment(self, mock_request, thread_data, comment_data):
        def handle_request(*args, **kwargs):
            url = args[1]
            if "/threads/" in url:
1039
                return self._create_response_mock(thread_data)
1040
            elif "/comments/" in url:
1041
                return self._create_response_mock(comment_data)
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
            else:
                raise ArgumentError("Bad url to mock request")
        mock_request.side_effect = handle_request

    def test_endorse_response_as_staff(self, mock_request):
        self._set_mock_request_thread_and_comment(
            mock_request,
            {"type": "thread", "thread_type": "question", "user_id": str(self.student.id)},
            {"type": "comment", "thread_id": "dummy"}
        )
        self.client.login(username=self.moderator.username, password=self.password)
        response = self.client.post(
1054
            reverse("endorse_comment", kwargs={"course_id": unicode(self.course.id), "comment_id": "dummy"})
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
        )
        self.assertEqual(response.status_code, 200)

    def test_endorse_response_as_student(self, mock_request):
        self._set_mock_request_thread_and_comment(
            mock_request,
            {"type": "thread", "thread_type": "question", "user_id": str(self.moderator.id)},
            {"type": "comment", "thread_id": "dummy"}
        )
        self.client.login(username=self.student.username, password=self.password)
        response = self.client.post(
1066
            reverse("endorse_comment", kwargs={"course_id": unicode(self.course.id), "comment_id": "dummy"})
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
        )
        self.assertEqual(response.status_code, 401)

    def test_endorse_response_as_student_question_author(self, mock_request):
        self._set_mock_request_thread_and_comment(
            mock_request,
            {"type": "thread", "thread_type": "question", "user_id": str(self.student.id)},
            {"type": "comment", "thread_id": "dummy"}
        )
        self.client.login(username=self.student.username, password=self.password)
        response = self.client.post(
1078
            reverse("endorse_comment", kwargs={"course_id": unicode(self.course.id), "comment_id": "dummy"})
1079 1080 1081
        )
        self.assertEqual(response.status_code, 200)

1082

1083
class CreateThreadUnicodeTestCase(ModuleStoreTestCase, UnicodeTestMixin, MockRequestSetupMixin):
1084
    def setUp(self):
1085 1086
        super(CreateThreadUnicodeTestCase, self).setUp()

1087 1088 1089 1090 1091 1092
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)

    @patch('lms.lib.comment_client.utils.requests.request')
1093 1094 1095 1096
    def _test_unicode_data(self, text, mock_request,):
        """
        Test to make sure unicode data in a thread doesn't break it.
        """
1097
        self._set_mock_request_data(mock_request, {})
1098
        request = RequestFactory().post("dummy_url", {"thread_type": "discussion", "body": text, "title": text})
1099 1100
        request.user = self.student
        request.view_name = "create_thread"
1101
        response = views.create_thread(
1102
            request, course_id=unicode(self.course.id), commentable_id="non_team_dummy_id"
1103
        )
1104 1105 1106 1107 1108 1109 1110

        self.assertEqual(response.status_code, 200)
        self.assertTrue(mock_request.called)
        self.assertEqual(mock_request.call_args[1]["data"]["body"], text)
        self.assertEqual(mock_request.call_args[1]["data"]["title"], text)


1111
@disable_signal(views, 'thread_edited')
1112
class UpdateThreadUnicodeTestCase(ModuleStoreTestCase, UnicodeTestMixin, MockRequestSetupMixin):
1113
    def setUp(self):
1114 1115
        super(UpdateThreadUnicodeTestCase, self).setUp()

1116 1117 1118 1119 1120
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)

1121
    @patch('django_comment_client.utils.get_discussion_categories_ids', return_value=["test_commentable"])
1122
    @patch('lms.lib.comment_client.utils.requests.request')
1123
    def _test_unicode_data(self, text, mock_request, mock_get_discussion_id_map):
1124
        self._set_mock_request_data(mock_request, {
1125 1126 1127
            "user_id": str(self.student.id),
            "closed": False,
        })
1128
        request = RequestFactory().post("dummy_url", {"body": text, "title": text, "thread_type": "question", "commentable_id": "test_commentable"})
1129 1130
        request.user = self.student
        request.view_name = "update_thread"
1131
        response = views.update_thread(request, course_id=unicode(self.course.id), thread_id="dummy_thread_id")
1132 1133 1134 1135 1136

        self.assertEqual(response.status_code, 200)
        self.assertTrue(mock_request.called)
        self.assertEqual(mock_request.call_args[1]["data"]["body"], text)
        self.assertEqual(mock_request.call_args[1]["data"]["title"], text)
1137
        self.assertEqual(mock_request.call_args[1]["data"]["thread_type"], "question")
1138
        self.assertEqual(mock_request.call_args[1]["data"]["commentable_id"], "test_commentable")
1139 1140


1141
@disable_signal(views, 'comment_created')
1142
class CreateCommentUnicodeTestCase(ModuleStoreTestCase, UnicodeTestMixin, MockRequestSetupMixin):
1143
    def setUp(self):
1144 1145
        super(CreateCommentUnicodeTestCase, self).setUp()

1146 1147 1148 1149 1150 1151 1152
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)

    @patch('lms.lib.comment_client.utils.requests.request')
    def _test_unicode_data(self, text, mock_request):
1153
        commentable_id = "non_team_dummy_id"
1154
        self._set_mock_request_data(mock_request, {
1155
            "closed": False,
1156
            "commentable_id": commentable_id
1157
        })
1158 1159 1160
        # We have to get clever here due to Thread's setters and getters.
        # Patch won't work with it.
        try:
1161
            Thread.commentable_id = commentable_id
1162 1163 1164 1165 1166 1167
            request = RequestFactory().post("dummy_url", {"body": text})
            request.user = self.student
            request.view_name = "create_comment"
            response = views.create_comment(
                request, course_id=unicode(self.course.id), thread_id="dummy_thread_id"
            )
1168

1169 1170 1171 1172 1173
            self.assertEqual(response.status_code, 200)
            self.assertTrue(mock_request.called)
            self.assertEqual(mock_request.call_args[1]["data"]["body"], text)
        finally:
            del Thread.commentable_id
1174 1175


1176
@disable_signal(views, 'comment_edited')
1177
class UpdateCommentUnicodeTestCase(ModuleStoreTestCase, UnicodeTestMixin, MockRequestSetupMixin):
1178
    def setUp(self):
1179 1180
        super(UpdateCommentUnicodeTestCase, self).setUp()

1181 1182 1183 1184 1185 1186 1187
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)

    @patch('lms.lib.comment_client.utils.requests.request')
    def _test_unicode_data(self, text, mock_request):
1188
        self._set_mock_request_data(mock_request, {
1189 1190 1191 1192 1193 1194
            "user_id": str(self.student.id),
            "closed": False,
        })
        request = RequestFactory().post("dummy_url", {"body": text})
        request.user = self.student
        request.view_name = "update_comment"
1195
        response = views.update_comment(request, course_id=unicode(self.course.id), comment_id="dummy_comment_id")
1196 1197 1198 1199 1200 1201

        self.assertEqual(response.status_code, 200)
        self.assertTrue(mock_request.called)
        self.assertEqual(mock_request.call_args[1]["data"]["body"], text)


1202
@disable_signal(views, 'comment_created')
1203
class CreateSubCommentUnicodeTestCase(ModuleStoreTestCase, UnicodeTestMixin, MockRequestSetupMixin):
1204 1205 1206
    """
    Make sure comments under a response can handle unicode.
    """
1207
    def setUp(self):
1208 1209
        super(CreateSubCommentUnicodeTestCase, self).setUp()

1210 1211 1212 1213 1214 1215 1216
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)

    @patch('lms.lib.comment_client.utils.requests.request')
    def _test_unicode_data(self, text, mock_request):
1217 1218 1219
        """
        Create a comment with unicode in it.
        """
1220
        self._set_mock_request_data(mock_request, {
1221 1222
            "closed": False,
            "depth": 1,
1223 1224
            "thread_id": "test_thread",
            "commentable_id": "non_team_dummy_id"
1225 1226 1227 1228
        })
        request = RequestFactory().post("dummy_url", {"body": text})
        request.user = self.student
        request.view_name = "create_sub_comment"
1229 1230 1231
        Thread.commentable_id = Mock()
        try:
            response = views.create_sub_comment(
1232
                request, course_id=unicode(self.course.id), comment_id="dummy_comment_id"
1233
            )
1234

1235 1236 1237 1238 1239 1240 1241
            self.assertEqual(response.status_code, 200)
            self.assertTrue(mock_request.called)
            self.assertEqual(mock_request.call_args[1]["data"]["body"], text)
        finally:
            del Thread.commentable_id


1242 1243
@ddt.ddt
@patch("lms.lib.comment_client.utils.requests.request")
1244 1245 1246 1247 1248
@disable_signal(views, 'thread_voted')
@disable_signal(views, 'thread_edited')
@disable_signal(views, 'comment_created')
@disable_signal(views, 'comment_voted')
@disable_signal(views, 'comment_deleted')
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
class TeamsPermissionsTestCase(UrlResetMixin, ModuleStoreTestCase, MockRequestSetupMixin):
    # Most of the test points use the same ddt data.
    # args: user, commentable_id, status_code
    ddt_permissions_args = [
        # Student in team can do operations on threads/comments within the team commentable.
        ('student_in_team', 'team_commentable_id', 200),
        # Non-team commentables can be edited by any student.
        ('student_in_team', 'course_commentable_id', 200),
        # Student not in team cannot do operations within the team commentable.
        ('student_not_in_team', 'team_commentable_id', 401),
        # Non-team commentables can be edited by any student.
        ('student_not_in_team', 'course_commentable_id', 200),
1261 1262
        # Moderators can always operator on threads within a team, regardless of team membership.
        ('moderator', 'team_commentable_id', 200)
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
    ]

    @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True})
    def setUp(self):
        super(TeamsPermissionsTestCase, self).setUp()
        self.password = "test password"
        teams_configuration = {
            'topics': [{'id': "topic_id", 'name': 'Solar Power', 'description': 'Solar power is hot'}]
        }
        self.course = CourseFactory.create(teams_configuration=teams_configuration)
        seed_permissions_roles(self.course.id)

        # Create 3 users-- student in team, student not in team, discussion moderator
        self.student_in_team = UserFactory.create(password=self.password)
        self.student_not_in_team = UserFactory.create(password=self.password)
        self.moderator = UserFactory.create(password=self.password)
        CourseEnrollmentFactory(user=self.student_in_team, course_id=self.course.id)
        CourseEnrollmentFactory(user=self.student_not_in_team, course_id=self.course.id)
        CourseEnrollmentFactory(user=self.moderator, course_id=self.course.id)
        self.moderator.roles.add(Role.objects.get(name="Moderator", course_id=self.course.id))

        # Create a team.
        self.team_commentable_id = "team_discussion_id"
        self.team = CourseTeamFactory.create(
            name=u'The Only Team',
            course_id=self.course.id,
            topic_id='topic_id',
            discussion_topic_id=self.team_commentable_id
        )
        self.team.add_user(self.student_in_team)

        # Dummy commentable ID not linked to a team
        self.course_commentable_id = "course_level_commentable"

    def _setup_mock(self, user, mock_request, data):
        user = getattr(self, user)
        self._set_mock_request_data(mock_request, data)
        self.client.login(username=user.username, password=self.password)

    @ddt.data(
        # student_in_team will be able to update his own post, regardless of team membership
        ('student_in_team', 'student_in_team', 'team_commentable_id', 200),
        ('student_in_team', 'student_in_team', 'course_commentable_id', 200),
        # students can only update their own posts
        ('student_in_team', 'moderator', 'team_commentable_id', 401),
        # Even though student_not_in_team is not in the team, he can still modify posts he created while in the team.
        ('student_not_in_team', 'student_not_in_team', 'team_commentable_id', 200),
        # Moderators can change their own posts and other people's posts.
        ('moderator', 'moderator', 'team_commentable_id', 200),
        ('moderator', 'student_in_team', 'team_commentable_id', 200),
    )
    @ddt.unpack
    def test_update_thread(self, user, thread_author, commentable_id, status_code, mock_request):
        """
        Verify that update_thread is limited to thread authors and privileged users (team membership does not matter).
        """
        commentable_id = getattr(self, commentable_id)
        # thread_author is who is marked as the author of the thread being updated.
        thread_author = getattr(self, thread_author)
        self._setup_mock(
            user, mock_request,  # user is the person making the request.
1324 1325 1326 1327 1328
            {
                "user_id": str(thread_author.id),
                "closed": False, "commentable_id": commentable_id,
                "context": "standalone"
            }
1329 1330 1331 1332 1333 1334 1335 1336 1337
        )
        response = self.client.post(
            reverse(
                "update_thread",
                kwargs={
                    "course_id": unicode(self.course.id),
                    "thread_id": "dummy"
                }
            ),
1338
            data={"body": "foo", "title": "foo", "commentable_id": commentable_id}
1339 1340 1341
        )
        self.assertEqual(response.status_code, status_code)

1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    @ddt.data(
        # Students can delete their own posts
        ('student_in_team', 'student_in_team', 'team_commentable_id', 200),
        # Moderators can delete any post
        ('moderator', 'student_in_team', 'team_commentable_id', 200),
        # Others cannot delete posts
        ('student_in_team', 'moderator', 'team_commentable_id', 401),
        ('student_not_in_team', 'student_in_team', 'team_commentable_id', 401)
    )
    @ddt.unpack
    def test_delete_comment(self, user, comment_author, commentable_id, status_code, mock_request):
        commentable_id = getattr(self, commentable_id)
        comment_author = getattr(self, comment_author)

        self._setup_mock(user, mock_request, {
            "closed": False,
            "commentable_id": commentable_id,
            "user_id": str(comment_author.id)
        })

        response = self.client.post(
            reverse(
                "delete_comment",
                kwargs={
                    "course_id": unicode(self.course.id),
                    "comment_id": "dummy"
                }
            ),
            data={"body": "foo", "title": "foo"}
        )
        self.assertEqual(response.status_code, status_code)

1374 1375 1376 1377
    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_create_comment(self, user, commentable_id, status_code, mock_request):
        """
1378
        Verify that create_comment is limited to members of the team or users with 'edit_content' permission.
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
        """
        commentable_id = getattr(self, commentable_id)
        self._setup_mock(user, mock_request, {"closed": False, "commentable_id": commentable_id})

        response = self.client.post(
            reverse(
                "create_comment",
                kwargs={
                    "course_id": unicode(self.course.id),
                    "thread_id": "dummy"
                }
            ),
            data={"body": "foo", "title": "foo"}
        )
        self.assertEqual(response.status_code, status_code)

    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_create_sub_comment(self, user, commentable_id, status_code, mock_request):
        """
1399
        Verify that create_subcomment is limited to members of the team or users with 'edit_content' permission.
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
        """
        commentable_id = getattr(self, commentable_id)
        self._setup_mock(
            user, mock_request,
            {"closed": False, "commentable_id": commentable_id, "thread_id": "dummy_thread"},
        )
        response = self.client.post(
            reverse(
                "create_sub_comment",
                kwargs={
                    "course_id": unicode(self.course.id),
                    "comment_id": "dummy_comment"
                }
            ),
            data={"body": "foo", "title": "foo"}
        )
        self.assertEqual(response.status_code, status_code)

    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_comment_actions(self, user, commentable_id, status_code, mock_request):
        """
1422 1423
        Verify that voting and flagging of comments is limited to members of the team or users with
        'edit_content' permission.
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
        """
        commentable_id = getattr(self, commentable_id)
        self._setup_mock(
            user, mock_request,
            {"closed": False, "commentable_id": commentable_id, "thread_id": "dummy_thread"},
        )
        for action in ["upvote_comment", "downvote_comment", "un_flag_abuse_for_comment", "flag_abuse_for_comment"]:
            response = self.client.post(
                reverse(
                    action,
                    kwargs={"course_id": unicode(self.course.id), "comment_id": "dummy_comment"}
                )
            )
            self.assertEqual(response.status_code, status_code)

    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_threads_actions(self, user, commentable_id, status_code, mock_request):
        """
1443 1444
        Verify that voting, flagging, and following of threads is limited to members of the team or users with
        'edit_content' permission.
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
        """
        commentable_id = getattr(self, commentable_id)
        self._setup_mock(
            user, mock_request,
            {"closed": False, "commentable_id": commentable_id},
        )
        for action in ["upvote_thread", "downvote_thread", "un_flag_abuse_for_thread", "flag_abuse_for_thread",
                       "follow_thread", "unfollow_thread"]:
            response = self.client.post(
                reverse(
                    action,
                    kwargs={"course_id": unicode(self.course.id), "thread_id": "dummy_thread"}
                )
            )
            self.assertEqual(response.status_code, status_code)

    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_create_thread(self, user, commentable_id, status_code, __):
        """
1465
        Verify that creation of threads is limited to members of the team or users with 'edit_content' permission.
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
        """
        commentable_id = getattr(self, commentable_id)
        # mock_request is not used because Commentables don't exist in comment service.
        self.client.login(username=getattr(self, user).username, password=self.password)
        response = self.client.post(
            reverse(
                "create_thread",
                kwargs={"course_id": unicode(self.course.id), "commentable_id": commentable_id}
            ),
            data={"body": "foo", "title": "foo", "thread_type": "discussion"}
        )
        self.assertEqual(response.status_code, status_code)

    @ddt.data(*ddt_permissions_args)
    @ddt.unpack
    def test_commentable_actions(self, user, commentable_id, status_code, __):
        """
1483 1484
        Verify that following of commentables is limited to members of the team or users with
        'edit_content' permission.
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
        """
        commentable_id = getattr(self, commentable_id)
        # mock_request is not used because Commentables don't exist in comment service.
        self.client.login(username=getattr(self, user).username, password=self.password)
        for action in ["follow_commentable", "unfollow_commentable"]:
            response = self.client.post(
                reverse(
                    action,
                    kwargs={"course_id": unicode(self.course.id), "commentable_id": commentable_id}
                )
            )
            self.assertEqual(response.status_code, status_code)


1499
@disable_signal(views, 'comment_created')
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
class ForumEventTestCase(ModuleStoreTestCase, MockRequestSetupMixin):
    """
    Forum actions are expected to launch analytics events. Test these here.
    """
    def setUp(self):
        super(ForumEventTestCase, self).setUp()
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        CourseEnrollmentFactory(user=self.student, course_id=self.course.id)
        self.student.roles.add(Role.objects.get(name="Student", course_id=self.course.id))
        CourseAccessRoleFactory(course_id=self.course.id, user=self.student, role='Wizard')

    @patch('eventtracking.tracker.emit')
    @patch('lms.lib.comment_client.utils.requests.request')
    def test_thread_event(self, __, mock_emit):
        request = RequestFactory().post(
            "dummy_url", {
                "thread_type": "discussion",
                "body": "Test text",
                "title": "Test",
                "auto_subscribe": True
            }
        )
        request.user = self.student
        request.view_name = "create_thread"

1527
        views.create_thread(request, course_id=unicode(self.course.id), commentable_id="test_commentable")
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556

        event_name, event = mock_emit.call_args[0]
        self.assertEqual(event_name, 'edx.forum.thread.created')
        self.assertEqual(event['body'], 'Test text')
        self.assertEqual(event['title'], 'Test')
        self.assertEqual(event['commentable_id'], 'test_commentable')
        self.assertEqual(event['user_forums_roles'], ['Student'])
        self.assertEqual(event['options']['followed'], True)
        self.assertEqual(event['user_course_roles'], ['Wizard'])
        self.assertEqual(event['anonymous'], False)
        self.assertEqual(event['group_id'], None)
        self.assertEqual(event['thread_type'], 'discussion')
        self.assertEquals(event['anonymous_to_peers'], False)

    @patch('eventtracking.tracker.emit')
    @patch('lms.lib.comment_client.utils.requests.request')
    def test_response_event(self, mock_request, mock_emit):
        """
        Check to make sure an event is fired when a user responds to a thread.
        """
        mock_request.return_value.status_code = 200
        self._set_mock_request_data(mock_request, {
            "closed": False,
            "commentable_id": 'test_commentable_id',
            'thread_id': 'test_thread_id',
        })
        request = RequestFactory().post("dummy_url", {"body": "Test comment", 'auto_subscribe': True})
        request.user = self.student
        request.view_name = "create_comment"
1557
        views.create_comment(request, course_id=unicode(self.course.id), thread_id='test_thread_id')
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583

        event_name, event = mock_emit.call_args[0]
        self.assertEqual(event_name, 'edx.forum.response.created')
        self.assertEqual(event['body'], "Test comment")
        self.assertEqual(event['commentable_id'], 'test_commentable_id')
        self.assertEqual(event['user_forums_roles'], ['Student'])
        self.assertEqual(event['user_course_roles'], ['Wizard'])
        self.assertEqual(event['discussion']['id'], 'test_thread_id')
        self.assertEqual(event['options']['followed'], True)

    @patch('eventtracking.tracker.emit')
    @patch('lms.lib.comment_client.utils.requests.request')
    def test_comment_event(self, mock_request, mock_emit):
        """
        Ensure an event is fired when someone comments on a response.
        """
        self._set_mock_request_data(mock_request, {
            "closed": False,
            "depth": 1,
            "thread_id": "test_thread_id",
            "commentable_id": "test_commentable_id",
            "parent_id": "test_response_id"
        })
        request = RequestFactory().post("dummy_url", {"body": "Another comment"})
        request.user = self.student
        request.view_name = "create_sub_comment"
1584
        views.create_sub_comment(request, course_id=unicode(self.course.id), comment_id="dummy_comment_id")
1585 1586 1587 1588 1589 1590 1591 1592 1593

        event_name, event = mock_emit.call_args[0]
        self.assertEqual(event_name, "edx.forum.comment.created")
        self.assertEqual(event['body'], 'Another comment')
        self.assertEqual(event['discussion']['id'], 'test_thread_id')
        self.assertEqual(event['response']['id'], 'test_response_id')
        self.assertEqual(event['user_forums_roles'], ['Student'])
        self.assertEqual(event['user_course_roles'], ['Wizard'])
        self.assertEqual(event['options']['followed'], False)
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607


class UsersEndpointTestCase(ModuleStoreTestCase, MockRequestSetupMixin):

    def set_post_counts(self, mock_request, threads_count=1, comments_count=1):
        """
        sets up a mock response from the comments service for getting post counts for our other_user
        """
        self._set_mock_request_data(mock_request, {
            "threads_count": threads_count,
            "comments_count": comments_count,
        })

    def setUp(self):
1608 1609
        super(UsersEndpointTestCase, self).setUp()

1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
        self.course = CourseFactory.create()
        seed_permissions_roles(self.course.id)
        self.student = UserFactory.create()
        self.enrollment = CourseEnrollmentFactory(user=self.student, course_id=self.course.id)
        self.other_user = UserFactory.create(username="other")
        CourseEnrollmentFactory(user=self.other_user, course_id=self.course.id)

    def make_request(self, method='get', course_id=None, **kwargs):
        course_id = course_id or self.course.id
        request = getattr(RequestFactory(), method)("dummy_url", kwargs)
        request.user = self.student
        request.view_name = "users"
        return views.users(request, course_id=course_id.to_deprecated_string())

    @patch('lms.lib.comment_client.utils.requests.request')
    def test_finds_exact_match(self, mock_request):
        self.set_post_counts(mock_request)
        response = self.make_request(username="other")
        self.assertEqual(response.status_code, 200)
        self.assertEqual(
            json.loads(response.content)["users"],
            [{"id": self.other_user.id, "username": self.other_user.username}]
        )

    @patch('lms.lib.comment_client.utils.requests.request')
    def test_finds_no_match(self, mock_request):
        self.set_post_counts(mock_request)
        response = self.make_request(username="othor")
        self.assertEqual(response.status_code, 200)
        self.assertEqual(json.loads(response.content)["users"], [])

    def test_requires_GET(self):
        response = self.make_request(method='post', username="other")
        self.assertEqual(response.status_code, 405)

    def test_requires_username_param(self):
        response = self.make_request()
        self.assertEqual(response.status_code, 400)
        content = json.loads(response.content)
        self.assertIn("errors", content)
        self.assertNotIn("users", content)

    def test_course_does_not_exist(self):
        course_id = SlashSeparatedCourseKey.from_deprecated_string("does/not/exist")
        response = self.make_request(course_id=course_id, username="other")

        self.assertEqual(response.status_code, 404)
        content = json.loads(response.content)
        self.assertIn("errors", content)
        self.assertNotIn("users", content)

    def test_requires_requestor_enrolled_in_course(self):
        # unenroll self.student from the course.
        self.enrollment.delete()

        response = self.make_request(username="other")
        self.assertEqual(response.status_code, 404)
        content = json.loads(response.content)
1668 1669
        self.assertIn("errors", content)
        self.assertNotIn("users", content)
1670 1671 1672 1673 1674 1675 1676

    @patch('lms.lib.comment_client.utils.requests.request')
    def test_requires_matched_user_has_forum_content(self, mock_request):
        self.set_post_counts(mock_request, 0, 0)
        response = self.make_request(username="other")
        self.assertEqual(response.status_code, 200)
        self.assertEqual(json.loads(response.content)["users"], [])