# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
from odoo.addons.mail.tests.common import MailCommon, mail_new_test_user
from odoo.addons.test_mail.tests.common import TestRecipients
from odoo.exceptions import AccessError
from odoo.tests import tagged
from odoo.tests.common import users
@tagged('mail_composer_mixin')
class TestMailComposerMixin(MailCommon, TestRecipients):
@classmethod
def setUpClass(cls):
super(TestMailComposerMixin, cls).setUpClass()
# ensure employee can create partners, necessary for templates
cls.user_employee.write({
'groups_id': [(4, cls.env.ref('base.group_partner_manager').id)],
})
cls.mail_template = cls.env['mail.template'].create({
'body_html': 'EnglishBody for
',
'model_id': cls.env['ir.model']._get('mail.test.composer.source').id,
'name': 'Test Template for mail.test.composer.source',
'lang': '{{ object.customer_id.lang }}',
'subject': 'EnglishSubject for {{ object.name }}',
})
cls.test_record = cls.env['mail.test.composer.source'].create({
'name': cls.partner_1.name,
'customer_id': cls.partner_1.id,
})
# Enable group-based template management
cls.env['ir.config_parameter'].set_param('mail.restrict.template.rendering', True)
# User without the group "mail.group_mail_template_editor"
cls.user_rendering_restricted = mail_new_test_user(
cls.env,
company_id=cls.company_admin.id,
groups='base.group_user',
login='user_rendering_restricted',
name='Code Template Restricted User',
notification_type='inbox',
signature='--\nErnest'
)
cls.user_rendering_restricted.groups_id -= cls.env.ref('mail.group_mail_template_editor')
cls.user_employee.groups_id += cls.env.ref('mail.group_mail_template_editor')
cls._activate_multi_lang(
layout_arch_db=' English Layout for ',
lang_code='es_ES',
test_record=cls.test_record,
test_template=cls.mail_template,
)
@users("employee")
def test_content_sync(self):
""" Test updating template updates the dynamic fields accordingly. """
source = self.test_record.with_env(self.env)
template = self.mail_template.with_env(self.env)
template_void = template.copy()
template_void.write({
'body_html': '
',
'lang': False,
'subject': False,
})
composer = self.env['mail.test.composer.mixin'].create({
'name': 'Invite',
'template_id': template.id,
'source_ids': [(4, source.id)],
})
self.assertEqual(composer.body, template.body_html)
self.assertTrue(composer.body_has_template_value)
self.assertEqual(composer.lang, template.lang)
self.assertEqual(composer.subject, template.subject)
# check rendering
body = composer._render_field('body', source.ids)[source.id]
self.assertEqual(body, f'EnglishBody for {source.name}
')
subject = composer._render_field('subject', source.ids)[source.id]
self.assertEqual(subject, f'EnglishSubject for {source.name}')
# manual values > template default values
composer.write({
'body': 'CustomBody for
',
'subject': 'CustomSubject for {{ object.name }}',
})
self.assertFalse(composer.body_has_template_value)
body = composer._render_field('body', source.ids)[source.id]
self.assertEqual(body, f'CustomBody for {source.name}
')
subject = composer._render_field('subject', source.ids)[source.id]
self.assertEqual(subject, f'CustomSubject for {source.name}')
# template with void values: should not force void (TODO)
composer.template_id = template_void.id
self.assertEqual(composer.body, 'CustomBody for
')
self.assertFalse(composer.body_has_template_value)
self.assertEqual(composer.lang, template.lang)
self.assertEqual(composer.subject, 'CustomSubject for {{ object.name }}')
# reset template TOOD should reset
composer.write({'template_id': False})
self.assertFalse(composer.body)
self.assertFalse(composer.body_has_template_value)
self.assertFalse(composer.lang)
self.assertFalse(composer.subject)
@users("user_rendering_restricted")
def test_mail_composer_mixin_render_lang(self):
""" Test _render_lang when rendering is involved, depending on template
editor rights. """
source = self.test_record.with_env(self.env)
composer = self.env['mail.test.composer.mixin'].create({
'description': 'Description for
',
'name': 'Invite',
'template_id': self.mail_template.id,
'source_ids': [(4, source.id)],
})
# _render_lang should be ok when content is the same as template
rendered = composer._render_lang(source.ids)
self.assertEqual(rendered, {source.id: self.partner_1.lang})
# _render_lang should crash when content is dynamic and not coming from template
composer.lang = " {{ 'en_US' }}"
with self.assertRaises(AccessError):
rendered = composer._render_lang(source.ids)
# _render_lang should crash when content is not coming from template but not dynamic
composer.lang = "fr_FR"
rendered = composer._render_lang(source.ids)
self.assertEqual(rendered, {source.id: "fr_FR"})
@users("employee")
def test_rendering_custom(self):
""" Test rendering with custom strings (not coming from template) """
source = self.test_record.with_env(self.env)
composer = self.env['mail.test.composer.mixin'].create({
'description': 'Description for
',
'body': 'SpecificBody from
',
'name': 'Invite',
'subject': 'SpecificSubject for {{ object.name }}',
})
self.assertEqual(composer.body, 'SpecificBody from
')
self.assertEqual(composer.subject, 'SpecificSubject for {{ object.name }}')
subject = composer._render_field('subject', source.ids)[source.id]
self.assertEqual(subject, f'SpecificSubject for {source.name}')
body = composer._render_field('body', source.ids)[source.id]
self.assertEqual(body, f'SpecificBody from {self.env.user.name}
')
description = composer._render_field('description', source.ids)[source.id]
self.assertEqual(description, f'Description for {source.name}
')
@users("employee")
def test_rendering_lang(self):
""" Test rendering with language involved """
template = self.mail_template.with_env(self.env)
customer = self.partner_1.with_env(self.env)
customer.lang = 'es_ES'
source = self.test_record.with_env(self.env)
composer = self.env['mail.test.composer.mixin'].create({
'description': 'Description for
',
'name': 'Invite',
'template_id': self.mail_template.id,
'source_ids': [(4, source.id)],
})
self.assertEqual(composer.body, template.body_html)
self.assertEqual(composer.subject, template.subject)
self.assertEqual(composer.lang, '{{ object.customer_id.lang }}')
# do not specifically ask for language computation
subject = composer._render_field('subject', source.ids, compute_lang=False)[source.id]
self.assertEqual(subject, f'EnglishSubject for {source.name}')
body = composer._render_field('body', source.ids, compute_lang=False)[source.id]
self.assertEqual(body, f'EnglishBody for {source.name}
')
description = composer._render_field('description', source.ids)[source.id]
self.assertEqual(description, f'Description for {source.name}
')
# ask for dynamic language computation
subject = composer._render_field('subject', source.ids, compute_lang=True)[source.id]
self.assertEqual(subject, f'SpanishSubject for {source.name}',
'Translation comes from the template, as both values equal')
body = composer._render_field('body', source.ids, compute_lang=True)[source.id]
self.assertEqual(body, f'SpanishBody for {source.name}
',
'Translation comes from the template, as both values equal')
description = composer._render_field('description', source.ids)[source.id]
self.assertEqual(description, f'Description for {source.name}
')