Newer
Older
# -*- coding: utf-8 -*-
from __future__ import division
__copyright__ = "Copyright (C) 2017 Dong Zhuang"
__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
import re
from django.test import TestCase, mock
from django.test.utils import override_settings
from django.utils.translation import ugettext_lazy as _
from course.models import Course
from course.views import EditCourseForm
from course.versioning import CourseCreationForm
from .base_test_mixins import SingleCourseTestMixin
from .utils import LocmemBackendTestsMixin, mail
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
180
181
182
183
184
185
186
187
from .test_views import DATE_TIME_PICKER_TIME_FORMAT
LANGUAGES = [
('en', _('English')),
('ko', _('Korean')),
('fr', _('French')),
]
ASSERSION_ERROR_LANGUAGE_PATTERN = (
"%s page visiting results don't match in terms of "
"whether the response contains Korean characters."
)
ASSERSION_ERROR_CONTENT_LANGUAGE_PATTERN = (
"%s page visiting result don't match in terms of "
"whether the response content-language are restored."
)
VALIDATION_ERROR_LANG_NOT_SUPPORTED_PATTERN = (
"'%s' is currently not supported as a course specific language at "
"this site."
)
class CourseSpecificLangTestMixin(SingleCourseTestMixin, TestCase):
# {{{ assertion method
def response_contains_korean(self, resp):
# Korean literals for 12th month (December)
return "12월" in resp.content.decode("utf-8")
def assertResponseContainsChinese(self, resp): # noqa
self.assertTrue(self.response_contains_korean(resp))
def assertResponseNotContainsChinese(self, resp): # noqa
self.assertFalse(self.response_contains_korean(resp))
# }}}
# {{{ common tests
def resp_info_with_diff_settings(self, url):
contains_korean_result = []
response_content_language_result = []
with override_settings(USE_I18N=True, LANGUAGE_CODE='en-us'):
resp = self.c.get(url)
self.assertEqual(resp.status_code, 200)
contains_korean_result.append(self.response_contains_korean(resp))
response_content_language_result.append(resp['content-language'])
resp = self.c.get(url, HTTP_ACCEPT_LANGUAGE='ko')
self.assertEqual(resp.status_code, 200)
contains_korean_result.append(self.response_contains_korean(resp))
response_content_language_result.append(resp['content-language'])
with override_settings(USE_I18N=False):
resp = self.c.get(url)
self.assertEqual(resp.status_code, 200)
contains_korean_result.append(self.response_contains_korean(resp))
response_content_language_result.append(resp['content-language'])
resp = self.c.get(url, HTTP_ACCEPT_LANGUAGE='ko')
self.assertEqual(resp.status_code, 200)
contains_korean_result.append(self.response_contains_korean(resp))
response_content_language_result.append(resp['content-language'])
return contains_korean_result, response_content_language_result
def home_resp_contains_korean_with_diff_settings(self):
return self.resp_info_with_diff_settings("/")
def course_resp_contains_korean_with_diff_settings(self):
return self.resp_info_with_diff_settings(self.course_page_url)
# }}}
class CourseSpecificLangConfigureTest(CourseSpecificLangTestMixin, TestCase):
# By default, self.course.force_lang is None
def setUp(self):
super(CourseSpecificLangConfigureTest, self).setUp()
# We use faked time header to find out whether the expected Chinese
# characters are rendered
self.c.force_login(self.instructor_participation.user)
fake_time = datetime.datetime(2038, 12, 31, 0, 0, 0, 0)
set_fake_time_data = {
"time": fake_time.strftime(DATE_TIME_PICKER_TIME_FORMAT),
"set": ['']}
self.post_set_fake_time(set_fake_time_data)
def assertResponseBehaveLikeUnconfigured(self): # noqa
# For each setting combinations, the response behaves the same
# as before this functionality was introduced
expected_result = ([False, True, False, True],
['en', 'ko', 'en', 'ko'])
self.assertEqual(
self.home_resp_contains_korean_with_diff_settings()[0],
expected_result[0],
ASSERSION_ERROR_LANGUAGE_PATTERN % "Home"
)
self.assertEqual(
self.home_resp_contains_korean_with_diff_settings()[1],
expected_result[1],
ASSERSION_ERROR_CONTENT_LANGUAGE_PATTERN % "Home"
)
expected_result = ([False, True, False, True],
['en', 'ko', 'en', 'ko'])
self.assertEqual(
self.course_resp_contains_korean_with_diff_settings()[0],
expected_result[0],
ASSERSION_ERROR_LANGUAGE_PATTERN % "Course"
)
self.assertEqual(
self.course_resp_contains_korean_with_diff_settings()[1],
expected_result[1],
ASSERSION_ERROR_CONTENT_LANGUAGE_PATTERN % "Course"
)
def assertResponseBehaveAsExpectedForCourseWithForceLang(self): # noqa
# For each setting combinations, the response behaves as expected
expected_result = ([False, True, False, True],
['en', 'ko', 'en', 'ko'])
self.assertEqual(
self.home_resp_contains_korean_with_diff_settings()[0],
expected_result[0],
ASSERSION_ERROR_LANGUAGE_PATTERN % "Home"
)
self.assertEqual(
self.home_resp_contains_korean_with_diff_settings()[1],
expected_result[1],
ASSERSION_ERROR_CONTENT_LANGUAGE_PATTERN % "Home"
)
expected_result = ([True, True, True, True],
['en', 'ko', 'en', 'ko'])
self.assertEqual(
self.course_resp_contains_korean_with_diff_settings()[0],
expected_result[0],
ASSERSION_ERROR_LANGUAGE_PATTERN % "Course"
)
self.assertEqual(
self.course_resp_contains_korean_with_diff_settings()[1],
expected_result[1],
ASSERSION_ERROR_CONTENT_LANGUAGE_PATTERN % "Course"
)
def set_course_lang_to_ko(self):
self.course.force_lang = "ko"
self.course.save()
self.course.refresh_from_db()
def test_languages_not_configured(self):
self.assertResponseBehaveLikeUnconfigured()
def test_languages_not_configured_course_has_force_lang(self):
self.set_course_lang_to_ko()
self.assertResponseBehaveAsExpectedForCourseWithForceLang()
@override_settings(LANGUAGES=LANGUAGES)
def test_languages_configured(self):
# because self.course.force_lang is None
self.assertResponseBehaveLikeUnconfigured()
@override_settings(LANGUAGES=LANGUAGES)
def test_languages_configured_course_has_force_lang(self):
self.set_course_lang_to_ko()
self.assertResponseBehaveAsExpectedForCourseWithForceLang()
@override_settings(LANGUAGES=LANGUAGES)
def test_languages_configured_course_has_force_lang_get_language_none(self):
self.set_course_lang_to_ko()
with mock.patch("course.utils.translation.get_language")\
as mock_get_language,\
mock.patch("course.utils.translation.deactivate_all")\
as mock_deactivate_all:
mock_get_language.return_value = None
home_visit_result = self.home_resp_contains_korean_with_diff_settings()
self.assertEqual(
# Display Korean according to i18n, language_code and browser
home_visit_result[0], [False, True, False, True])
self.assertEqual(mock_deactivate_all.call_count, 0)
mock_deactivate_all.reset_mock()
course_page_visit_result = (
self.course_resp_contains_korean_with_diff_settings())
self.assertEqual(
# All display Korean
course_page_visit_result[0], [True, True, True, True])
# There are 4 visit, each will call deactivate_all()
self.assertEqual(mock_deactivate_all.call_count, 4)
class CourseSpecificLangFormTest(SingleCourseTestMixin, TestCase):
def test_edit_course_force_lang_invalid(self):
course_kwargs = self.copy_course_dict_and_set_attrs_for_post(
{"force_lang": "foo"})
form = EditCourseForm(course_kwargs, instance=self.course)
self.assertTrue("force_lang" in form.fields)
self.assertFalse(form.is_valid())
self.assertEqual(form.errors["force_lang"][0],
VALIDATION_ERROR_LANG_NOT_SUPPORTED_PATTERN % "foo")
def test_edit_course_force_lang_valid(self):
course_kwargs = self.copy_course_dict_and_set_attrs_for_post(
{"force_lang": "de"})
form = EditCourseForm(course_kwargs, instance=self.course)
self.assertTrue(form.is_valid())
def test_create_course_force_lang_invalid(self):
course_kwargs = self.copy_course_dict_and_set_attrs_for_post(
{"force_lang": "foo"})
course_kwargs["identifier"] = "another-test-course"
expected_course_count = Course.objects.count()
form = CourseCreationForm(course_kwargs)
self.assertTrue("force_lang" in form.fields)
self.assertFalse(form.is_valid())
self.assertEqual(form.errors["force_lang"][0],
VALIDATION_ERROR_LANG_NOT_SUPPORTED_PATTERN % "foo")
self.assertEqual(Course.objects.count(), expected_course_count)
class RelateSiteNameTest(SingleCourseTestMixin, LocmemBackendTestsMixin, TestCase):
def setUp(self):
super(RelateSiteNameTest, self).setUp()
def get_translation_count(self, mocked_method, literal):
return len(
[arg[0] for arg, kwarg in [
args for args in mocked_method.call_args_list]
if arg[0] == literal])
def verify_result_with_configure(self, my_site_name):
# home page
with mock.patch("django.utils.translation.trans_real.do_translate")\
as mock_trans:
mock_trans.side_effect = lambda x, y: x
resp = self.c.get("/")
self.assertEqual(resp.status_code, 200)
self.assertContains(resp, "<title>%s</title>" % my_site_name, html=True)
# Three translations in nav_bar brand, html title and
# "Welcome to RELATE", respectively
self.assertEqual(
self.get_translation_count(mock_trans, my_site_name), 3)
mock_trans.reset_mock()
# course page
resp = self.c.get(self.get_course_page_url())
self.assertEqual(resp.status_code, 200)
test_site_name_re = re.compile(
".+<title>.+-.+%s.+</title>.+" % my_site_name, re.DOTALL)
self.assertRegex(resp.content.decode(), test_site_name_re)
# One translation in html title
self.assertEqual(
self.get_translation_count(mock_trans, my_site_name), 1)
# email
with override_settings(RELATE_REGISTRATION_ENABLED=True, USE_I18N=True):
# render() is mocked so as to count string translated in email rendering
with mock.patch("django.utils.translation.trans_real.do_translate")\
as mock_trans,\
mock.patch("course.auth._") as mock_ugettext,\
mock.patch('course.auth.messages'),\
mock.patch('course.auth.render'):
mock_trans.return_value = "foo"
with self.temporarily_switch_to_user(None):
resp = self.post_sign_up(
data={"username": "Jack", "email": "jack@exmaple.com"},
follow=False
)
self.assertTrue(resp.status_code, 200)
self.assertEqual(len(mail.outbox), 1)
# In the view, tranlating RELATE for email title.
self.assertEqual(
self.get_translation_count(mock_ugettext, my_site_name), 1)
# Three RELATE in the email template
self.assertEqual(
self.get_translation_count(mock_trans, my_site_name), 3)
@override_settings()
def test_default_configure(self):
self.verify_result_with_configure("RELATE")
@override_settings(RELATE_SITE_NAME="My RELATE")
def test_custom_configure(self):
self.verify_result_with_configure("My RELATE")