Odoo18-Base/addons/test_mail/tests/test_mail_flow.py
2025-01-06 10:57:38 +07:00

320 lines
15 KiB
Python

from odoo.addons.mail.tests.common import mail_new_test_user, MailCommon
from odoo.addons.test_mail.data.test_mail_data import MAIL_TEMPLATE
from odoo.addons.test_mail.tests.common import TestRecipients
from odoo.tools.mail import email_normalize, formataddr
from odoo.tests import tagged
@tagged('mail_gateway', 'mail_flow', 'post_install', '-at_install')
class TestMailFlow(MailCommon, TestRecipients):
""" Test flows matching business cases with incoming / outgoing emails. """
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.user_employee_2 = mail_new_test_user(
cls.env,
company_id=cls.user_employee.company_id.id,
email='eglantine@example.com',
groups='base.group_user,base.group_partner_manager',
login='employee2',
name='Eglantine Employee',
notification_type='email',
signature='--\nEglantine',
)
cls.partner_employee_2 = cls.user_employee_2.partner_id
cls.user_employee_3 = mail_new_test_user(
cls.env,
company_id=cls.user_employee.company_id.id,
email='emmanuel@example.com',
groups='base.group_user,base.group_partner_manager',
login='employee3',
name='Emmanuel Employee',
notification_type='email',
signature='--\nEmmanuel',
)
cls.partner_employee_3 = cls.user_employee_3.partner_id
cls.user_portal = cls._create_portal_user()
cls.partner_portal = cls.user_portal.partner_id
cls.test_emails = [
# emails only
'"Sylvie Lelitre" <sylvie.lelitre@zboing.com>',
'"Josiane Quichopoils" <accounting@zboing.com>',
'pay@zboing.com',
'invoicing@zboing.com',
# existing partners
'"Robert Brutijus" <robert@zboing.com>',
# existing portal users
'"Portal Zboing" <portal@zboing.com>',
]
cls.test_emails_normalized = [
'sylvie.lelitre@zboing.com', 'accounting@zboing.com', 'invoicing@zboing.com',
'pay@zboing.com', 'robert@zboing.com', 'portal@zboing.com',
]
cls.customer_zboing = cls.env['res.partner'].create({
'email': cls.test_emails[4],
'name': 'Robert Brutijus',
'phone': '+32455335577',
})
cls.user_portal_zboing = mail_new_test_user(
cls.env,
email=cls.test_emails[5],
groups='base.group_portal',
login='portal_zboing',
name='Portal Zboing',
)
cls.customer_portal_zboing = cls.user_portal_zboing.partner_id
# lead@test.mycompany.com will cause the creation of new mail.test.lead
cls.mail_test_lead_model = cls.env['ir.model']._get('mail.test.lead')
cls.alias = cls.env['mail.alias'].create({
'alias_domain_id': cls.mail_alias_domain.id,
'alias_contact': 'everyone',
'alias_model_id': cls.mail_test_lead_model.id,
'alias_name': 'lead',
})
# help@test.mycompany.com will cause the creation of new mail.test.ticket.mc
cls.container = cls.env['mail.test.container.mc'].create({
'alias_name': 'help',
'company_id': cls.user_employee.company_id.id,
'name': 'help',
})
def test_assert_initial_values(self):
""" Assert base values for tests """
self.assertEqual(
self.env['res.partner'].search([('email_normalized', 'in', self.test_emails_normalized)]),
self.customer_zboing + self.customer_portal_zboing,
)
def test_lead_mailgateway(self):
""" Flow of this test
* incoming email creating a lead -> email set as first message
* a salesperson is assigned
* - he adds followers (internal and portal)
* - he replies through chatter, using suggested recipients
* customer replies, adding other people
Tested features
* cc / to support
* suggested recipients computation
"""
# incoming customer email: lead alias + recipients (to + cc)
# ------------------------------------------------------------
email_to = f'lead@{self.alias_domain}, {self.test_emails[1]}, {self.partner_employee.email_formatted}'
email_cc = f'{self.test_emails[2]}, {self.test_emails[5]}'
with self.mock_mail_gateway(), self.mock_mail_app():
lead = self.format_and_process(
MAIL_TEMPLATE,
self.test_emails[0],
email_to,
cc=email_cc,
subject='Inquiry',
target_model='mail.test.lead',
)
self.assertEqual(lead.email_cc, email_cc, 'Filled by mail.thread.cc mixin')
self.assertEqual(lead.email_from, self.test_emails[0])
self.assertEqual(lead.name, 'Inquiry')
self.assertFalse(lead.partner_id)
# followers
self.assertFalse(lead.message_partner_ids)
# messages
self.assertEqual(len(lead.message_ids), 1, 'Incoming email should be only message, no creation message')
incoming_email = lead.message_ids
self.assertMailNotifications(
incoming_email,
[
{
'content': 'Please call me as soon as possible',
'message_type': 'email',
'message_values': {
'author_id': self.env['res.partner'],
'email_from': self.test_emails[0],
'mail_server_id': self.env['ir.mail_server'],
'parent_id': self.env['mail.message'],
'notified_partner_ids': self.env['res.partner'],
'partner_ids': self.partner_employee + self.customer_portal_zboing,
'subtype_id': self.env.ref('mail.mt_comment'),
},
'notif': [], # no notif, mailgateway sets recipients without notification
},
],
)
# user is assigned, should notify him
with self.mock_mail_gateway(), self.mock_mail_app():
lead.write({'user_id': self.user_employee.id})
lead_as_emp = lead.with_user(self.user_employee.id)
self.assertEqual(lead_as_emp.message_partner_ids, self.partner_employee)
# adds other employee and a portal customer as followers
lead_as_emp.message_subscribe(partner_ids=(self.partner_employee_2 + self.partner_portal).ids)
self.assertEqual(lead_as_emp.message_partner_ids, self.partner_employee + self.partner_employee_2 + self.partner_portal)
# updates some customer information
lead_as_emp.write({
'customer_name': 'Sylvie Lelitre (Zboing)',
'phone': '+32455001122',
'lang_code': 'fr_FR',
})
# uses Chatter: fetches suggested recipients, post a message
# - checks all suggested: incoming email to + cc are included
# - for all notified people: expected 'email_to' is them + external
# email addresses -> including portal customers
# ------------------------------------------------------------
suggested_all = lead_as_emp._message_get_suggested_recipients()
expected_all = [
{ # mail.thread.cc: email_cc field
'create_values': {},
'email': 'pay@zboing.com',
'lang': None,
'name': 'pay@zboing.com',
'reason': 'CC Email',
},
{ # mail.thread.cc: email_cc field (linked to partner)
'email': 'portal@zboing.com',
'lang': None,
'name': 'Portal Zboing',
'reason': 'CC Email',
'partner_id': self.customer_portal_zboing.id,
},
{ # then primary emailadditional_values
'create_values': {
'lang': 'fr_FR',
'mobile': False,
'name': 'Sylvie Lelitre (Zboing)',
'phone': '+32455001122',
},
'email': '"Sylvie Lelitre" <sylvie.lelitre@zboing.com>',
'lang': None,
'name': 'Sylvie Lelitre (Zboing)',
'reason': 'Customer Email',
},
]
for suggested, expected in zip(suggested_all, expected_all):
self.assertDictEqual(suggested, expected)
# check recipients, which creates them (simulating discuss in a quick way)
self.env["res.partner"]._find_or_create_from_emails(
[sug['email'] for sug in suggested_all],
{email_normalize(sug['email']): sug.get('create_values') or {} for sug in suggested_all},
)
partner_sylvie = self.env['res.partner'].search(
[('email_normalized', '=', 'sylvie.lelitre@zboing.com')]
)
partner_pay = self.env['res.partner'].search(
[('email_normalized', '=', 'pay@zboing.com')]
)
self.assertEqual(
len(partner_sylvie + partner_pay), 2,
'Mail: should have created partners for emails')
self.assertFalse(
self.env['res.partner'].search([('email_normalized', '=', 'accounting@zboing.com')]),
'Mail: currently other "To" in incoming emails are lost if not linked to existing partners'
)
# finally post the message with recipients
with self.mock_mail_gateway():
responsible_answer = lead_as_emp.message_post(
body='<p>Well received !',
partner_ids=(partner_sylvie + partner_pay + self.customer_portal_zboing).ids,
message_type='comment',
subject=f'Re: {lead.name}',
subtype_id=self.env.ref('mail.mt_comment').id,
)
self.assertEqual(lead_as_emp.message_partner_ids, self.partner_employee + self.partner_employee_2 + self.partner_portal)
external_partners = partner_sylvie + partner_pay + self.customer_portal_zboing + self.partner_portal
internal_partners = self.partner_employee + self.partner_employee_2
expected_chatter_reply_to = formataddr((f'{self.env.company.name} {lead.name}', f'{self.alias_catchall}@{self.alias_domain}'))
self.assertMailNotifications(
responsible_answer,
[
{
'content': 'Well received !',
'mail_mail_values': {
'mail_server_id': self.env['ir.mail_server'], # no specified server
},
'message_type': 'comment',
'message_values': {
'author_id': self.partner_employee,
'email_from': self.partner_employee.email_formatted,
'mail_server_id': self.env['ir.mail_server'],
'notified_partner_ids': external_partners + self.partner_employee_2,
'parent_id': incoming_email,
'partner_ids': partner_sylvie + partner_pay + self.customer_portal_zboing,
'reply_to': expected_chatter_reply_to,
'subtype_id': self.env.ref('mail.mt_comment'),
},
'notif': [
{'partner': partner_sylvie, 'type': 'email'},
{'partner': partner_pay, 'type': 'email'},
{'partner': self.customer_portal_zboing, 'type': 'email'},
{'partner': self.partner_employee_2, 'type': 'email'},
{'partner': self.partner_portal, 'type': 'email'},
],
},
],
)
# expected Msg['To'] : actual recipient + all "not internal partners" + catchall (to receive answers)
for partner in responsible_answer.notified_partner_ids:
with self.subTest(name=partner.name):
self.assertSMTPEmailsSent(
mail_server=self.mail_server_notification,
msg_from=formataddr((self.partner_employee.name, f'{self.default_from}@{self.alias_domain}')),
smtp_from=self.mail_server_notification.from_filter,
smtp_to_list=[partner.email_normalized],
msg_to_lst=[partner.email_formatted],
)
# customer replies using "Reply All" + adds new people
# ------------------------------------------------------------
self.gateway_mail_reply_from_smtp_email(
MAIL_TEMPLATE, [partner_sylvie.email_normalized], reply_all=True,
cc=f'{self.test_emails[3]}, {self.test_emails[4]}', # used mainly for existing partners currently
)
self.assertEqual(len(lead.message_ids), 3, 'Incoming email + chatter reply + customer reply')
self.assertMailNotifications(
lead.message_ids[0],
[
{
'content': 'Please call me as soon as possible',
'message_type': 'email',
'message_values': {
'author_id': partner_sylvie,
'email_from': partner_sylvie.email_formatted,
'mail_server_id': self.env['ir.mail_server'],
# notified: followers, behaves like classic post
'notified_partner_ids': internal_partners + self.partner_portal,
'parent_id': incoming_email,
# reply-all when being only recipients = no other recipients
'partner_ids': self.customer_zboing,
'subject': f'Re: Re: {lead.name}',
'subtype_id': self.env.ref('mail.mt_comment'),
},
# portal was already in email_to, hence not notified twice through odoo
'notif': [
{'partner': self.partner_employee, 'type': 'inbox'},
{'partner': self.partner_employee_2, 'type': 'email'},
{'partner': self.partner_portal, 'type': 'email'},
],
},
],
)
def test_ticket_mailgateway(self):
# incoming customer email: help alias + recipients (to + cc)
# ------------------------------------------------------------
email_to = f'help@{self.alias_domain}, {self.test_emails[1]}, {self.partner_employee.email_formatted}'
email_cc = f'{self.test_emails[2]}, {self.test_emails[5]}'
with self.mock_mail_gateway(), self.mock_mail_app():
ticket = self.format_and_process(
MAIL_TEMPLATE,
self.test_emails[0],
email_to,
cc=email_cc,
subject='Inquiry',
target_model='mail.test.ticket.mc',
)
self.assertEqual(ticket.name, 'Inquiry')