OpenSlides/tests/utils/test_views.py

from unittest.mock import patch

from django.contrib.auth.models import AnonymousUser
from django.core.exceptions import ImproperlyConfigured
from django.core.urlresolvers import clear_url_caches
from django.db import connection, reset_queries
from django.test import RequestFactory
from django.test.client import Client
from django.test.utils import override_settings

from openslides.utils import views
from openslides.utils.signals import template_manipulation
from openslides.utils.test import TestCase

from . import views as test_views
from .models import DummyModel


@override_settings(ROOT_URLCONF='tests.utils.urls')
class ViewTestCase(TestCase):
    rf = RequestFactory()

    def setUp(self):
        # Clear the cache for the urlresolver, so the overriden settings works.
        clear_url_caches()


class LoginMixinTest(ViewTestCase):
    def test_dispatch(self):
        client = Client()
        response = client.get('/login_mixin/')
        self.assertEqual(response['Location'], 'http://testserver/login/?next=/login_mixin/')

        client.login(username='admin', password='admin')
        response = client.get('/login_mixin/')
        self.assertEqual(response.status_code, 200)
        self.assertEqual(response.content, b'Well done.')


class PermissionMixinTest(ViewTestCase):
    def test_dispatch(self):
        client = Client()

        # View without required_permission
        response = client.get('/permission_mixin1/')
        self.assertEqual(response.status_code, 200)
        self.assertEqual(response.content, b'Well done.')

        # View with required_permission without login
        response = client.get('/permission_mixin2/')
        self.assertEqual(response.status_code, 302)
        self.assertEqual(response['Location'], 'http://testserver/login/?next=/permission_mixin2/')

        # View with required_permission, with login, without permission
        client.login(username='admin', password='admin')
        response = client.get('/permission_mixin2/')
        self.assertEqual(response.status_code, 403)

        # View with required_permission, with login, with permission
        response = client.get('/permission_mixin3/')
        self.assertEqual(response.status_code, 200)


class AjaxMixinTest(ViewTestCase):
    def test_ajax_get(self):
        view = test_views.AjaxMixinView()
        ajax_get = view.ajax_get
        response = ajax_get(self.rf.get('/', {}))
        self.assertEqual(response.content, b'{"new_context": "newer_context"}')

    def test_get_ajax_context(self):
        get_ajax_context = test_views.AjaxMixinView().get_ajax_context
        self.assertEqual(get_ajax_context()['new_context'], 'newer_context')
        self.assertEqual(
            get_ajax_context(test_content='some_content')['test_content'],
            'some_content')


class ExtraContextMixinTest(ViewTestCase):
    """
    Tests the ExtraContextMixin by testing the TemplateView.
    """
    def test_get_context_data(self):
        view = views.TemplateView()
        get_context_data = view.get_context_data
        view.request = self.rf.get('/', {})
        view.request.user = AnonymousUser()

        context = get_context_data()
        self.assertIn('extra_stylefiles', context)
        self.assertIn('extra_javascript', context)

        context = get_context_data(some_context='context')
        self.assertIn('some_context', context)

        template_manipulation.connect(set_context, dispatch_uid='set_context_test')
        context = get_context_data()
        self.assertIn('new_context', context)
        template_manipulation.disconnect(set_context, dispatch_uid='set_context_test')


class UrlMixinTest(ViewTestCase):
    def test_get_url(self):
        get_url = test_views.UrlMixinView().get_url

        # url_name has the higher priority
        self.assertEqual(get_url('test_url_mixin', 'view_url'),
                         '/url_mixin/')

        # If the url_name is none, return the second argument
        self.assertEqual(get_url(None, 'view_url'),
                         'view_url')

        # Test argument in url
        self.assertEqual(get_url('test_url_mixin_args', None,
                                 args=[1]),
                         '/url_mixin_args/1/')

        # No Url given.
        self.assertRaisesMessage(
            ImproperlyConfigured,
            'No url to redirect to. See openslides.utils.views.UrlMixin for more details.',
            get_url, None, None)

    def test_get_url_with_object(self):
        get_url = test_views.UrlMixinViewWithObject().get_url

        self.assertEqual(get_url(None, None),
                         'default_url')
        self.assertEqual(get_url(None, None, use_absolute_url_link='detail'),
                         'detail_url')

    def test_get_url_name_args(self):
        view = test_views.UrlMixinViewWithObject()
        get_url_name_args = view.get_url_name_args
        view.url_name_args = [1]

        self.assertEqual(get_url_name_args(), [1])

        view.url_name_args = None
        self.assertEqual(get_url_name_args(), [])

        view.object.pk = 5
        self.assertEqual(get_url_name_args(), [5])


class QuestionViewTest(ViewTestCase):
    def test_get_redirect_url(self):
        view = views.QuestionView()
        get_redirect_url = view.get_redirect_url

        view.request = self.rf.get('/')
        view.question_url = 'redirect_to_get_url'
        self.assertEqual(get_redirect_url(), 'redirect_to_get_url')

        view.request = self.rf.post('/')
        view.url = 'redirect_to_post_url'
        self.assertEqual(get_redirect_url(), 'redirect_to_post_url')

    def test_get_question_message(self):
        view = views.QuestionView()
        get_question_message = view.get_question_message

        self.assertEqual(get_question_message(), 'Are you sure?')

        view.question_message = 'new_question'
        self.assertEqual(get_question_message(), 'new_question')

        self.assertIsInstance(get_question_message(), str)

    def test_get_answer_options(self):
        view = views.QuestionView()
        get_answer_options = view.get_answer_options

        self.assertIn('yes', dict(get_answer_options()))
        self.assertIn('no', dict(get_answer_options()))

        view.answer_options = [('new_answer', 'Answer')]
        self.assertNotIn('yes', dict(get_answer_options()))
        self.assertIn('new_answer', dict(get_answer_options()))

    @patch('openslides.utils.views.messages')
    def test_confirm_form(self, mock_messages):
        view = views.QuestionView()
        view.question_message = 'the question'
        confirm_form = view.confirm_form
        view.request = self.rf.get('/')

        confirm_form()

        self.assertTrue(mock_messages.warning.called)

        question = mock_messages.warning.call_args[0][1]
        self.assertIn('the question', question)


class DetailViewTest(ViewTestCase):
    def test_get_object_cache(self):
        with self.settings(DEBUG=True):
            DummyModel.objects.create(title='title_ooth8she7yos1Oi8Boh3')
            reset_queries()
            client = Client()
            response = client.get('/dummy_detail_view/1/')
            self.assertContains(response, 'title_ooth8she7yos1Oi8Boh3')
            self.assertEqual(len(connection.queries), 3)


def set_context(sender, request, context, **kwargs):
    """
    receiver for testing the ExtraContextMixin
    """
    context.update({'new_context': 'some new context'})