[IMP] event_sms, link_tracker, sms, test_mail_full: improve SMS-based mailing tests

PURPOSE

Purpose is to have more tests when sending sms mailings, notably about
canceled or failed mails or sms as well as jinja and links rendering.

SPECIFICATIONS

In this commit we improve SMS Marketing mailing tests. We notably

  * add tests for void and invalid email and numbers. It allows to check they
    correctly update their trace status;
  * add tests for unsubscribe and view links embedded in sms marketing;
  * add tests to simulate a click on links sent through sms marketing and
    ensure click statistics are effectively updated;
  * ensure content of sent sms are checked;

Default content of mailings used in test is updated to ensure jinja is
correctly rendered, including links and some corner cases. This will also
helps ensuring behavior is kept when converting to QWeb.

In event we now correctly use sms gateway mock to ensure SMS finding.

In link_tracker a helper is added to check url tracking in plaintext content.

LINKS

Task ID-2508643
Followup of odoo/odoo#68874 (improve mail tests)
Prepares Task ID-27033 (support QWeb in templates)
Prepares Task ID-2377974 (clean trace and status management in mass mailing)
COM PR odoo/odoo#69461
ENT PR odoo/enterprise#17780

1 files changed, 78 insertions, 27 deletions

diff --git a/addons/sms/tests/common.py b/addons/sms/tests/common.py
index d225390f02c..03b31dd8406 100644
--- a/addons/sms/tests/common.py
+++ b/addons/sms/tests/common.py
@@ -8,6 +8,7 @@ from odoo.tests import common
 from odoo.addons.mail.tests.common import MailCommon
 from odoo.addons.phone_validation.tools import phone_validation
 from odoo.addons.sms.models.sms_api import SmsApi
+from odoo.addons.sms.models.sms_sms import SmsSms
 
 
 class MockSMS(common.BaseCase):
@@ -17,8 +18,10 @@ class MockSMS(common.BaseCase):
         self._clear_sms_sent()
 
     @contextmanager
-    def mockSMSGateway(self, sim_error=None, nbr_t_error=None):
+    def mockSMSGateway(self, sms_allow_unlink=False, sim_error=None, nbr_t_error=None):
         self._clear_sms_sent()
+        sms_create_origin = SmsSms.create
+        sms_unlink_origin = SmsSms.unlink
 
         def _contact_iap(local_endpoint, params):
             # mock single sms sending
@@ -52,14 +55,35 @@ class MockSMS(common.BaseCase):
                         })
                 return result
 
+        def _sms_sms_create(model, *args, **kwargs):
+            res = sms_create_origin(model, *args, **kwargs)
+            self._new_sms += res.sudo()
+            return res
+
+        def _sms_sms_unlink(records, *args, **kwargs):
+            if sms_allow_unlink:
+                return sms_unlink_origin(records, *args, **kwargs)
+            # hack: instead of unlink, update state to sent for tests
+            else:
+                records.filtered(lambda sms: sms.id in self._new_sms.ids).state = 'sent'
+            return True
+
         try:
-            with patch.object(SmsApi, '_contact_iap', side_effect=_contact_iap) as contact_iap_mock:
+            with patch.object(SmsApi, '_contact_iap', side_effect=_contact_iap), \
+                    patch.object(SmsSms, 'create', autospec=True, wraps=SmsSms, side_effect=_sms_sms_create), \
+                    patch.object(SmsSms, 'unlink', autospec=True, wraps=SmsSms, side_effect=_sms_sms_unlink):
                 yield
         finally:
             pass
 
     def _clear_sms_sent(self):
         self._sms = []
+        self._new_sms = self.env['sms.sms'].sudo()
+
+    def _clear_outoing_sms(self):
+        """ As SMS gateway mock keeps SMS, we may need to remove them manually
+        if there are several tests in the same tx. """
+        self.env['sms.sms'].sudo().search([('state', '=', 'outgoing')]).unlink()
 
 
 class SMSCase(MockSMS):
@@ -77,7 +101,9 @@ class SMSCase(MockSMS):
     def _find_sms_sms(self, partner, number, status):
         if number is None and partner:
             number = partner.phone_get_sanitized_number()
-        domain = [('partner_id', '=', partner.id), ('number', '=', number)]
+        domain = [('id', 'in', self._new_sms.ids),
+                  ('partner_id', '=', partner.id),
+                  ('number', '=', number)]
         if status:
             domain += [('state', '=', status)]
 
@@ -88,7 +114,11 @@ class SMSCase(MockSMS):
             raise NotImplementedError()
         return sms
 
-    def assertSMSSent(self, numbers, content=None):
+    def assertNoSMS(self):
+        """ Check no sms went through gateway during mock. """
+        self.assertTrue(len(self._new_sms) == 0)
+
+    def assertSMSIapSent(self, numbers, content=None):
         """ Check sent SMS. Order is not checked. Each number should have received
         the same content. Useful to check batch sending.
 
@@ -99,33 +129,51 @@ class SMSCase(MockSMS):
             sent_sms = next((sms for sms in self._sms if sms['number'] == number), None)
             self.assertTrue(bool(sent_sms), 'Number %s not found in %s' % (number, repr([s['number'] for s in self._sms])))
             if content is not None:
-                self.assertEqual(sent_sms['body'], content)
+                self.assertIn(content, sent_sms['body'])
 
-    def assertSMSCanceled(self, partner, number, error_code, content=None):
+    def assertSMSSent(self, numbers, content=None):
+        """ Deprecated. Remove in 14.4 """
+        return self.assertSMSIapSent(numbers, content=content)
+
+    def assertSMS(self, partner, number, status, error_code=None,
+                  content=None, fields_values=None):
+        """ Find a ``sms.sms`` record, based on given partner, number and status.
+
+        :param partner: optional partner, used to find a ``sms.sms`` and a number
+          if not given;
+        :param number: optional number, used to find a ``sms.sms``, notably if
+          partner is not given;
+        :param error_code: check error code if SMS is not sent or outgoing;
+        :param content: if given, should be contained in sms body;
+        :param fields_values: optional values allowing to check directly some
+          values on ``sms.sms`` record;
+        """
+        sms_sms = self._find_sms_sms(partner, number, status)
+        if error_code:
+            self.assertEqual(sms_sms.error_code, error_code)
+        if content is not None:
+            self.assertIn(content, sms_sms.body)
+        for fname, fvalue in (fields_values or {}).items():
+            self.assertEqual(
+                sms_sms[fname], fvalue,
+                'SMS: expected %s for %s, got %s' % (fvalue, fname, sms_sms[fname]))
+        if status == 'sent':
+            self.assertSMSIapSent([sms_sms.number], content=content)
+
+    def assertSMSCanceled(self, partner, number, error_code, content=None, fields_values=None):
         """ Check canceled SMS. Search is done for a pair partner / number where
         partner can be an empty recordset. """
-        sms = self._find_sms_sms(partner, number, 'canceled')
-        self.assertTrue(sms, 'SMS: not found canceled SMS for %s (number: %s)' % (partner, number))
-        self.assertEqual(sms.error_code, error_code)
-        if content is not None:
-            self.assertEqual(sms.body, content)
+        self.assertSMS(partner, number, 'canceled', error_code=error_code, content=content, fields_values=fields_values)
 
-    def assertSMSFailed(self, partner, number, error_code, content=None):
+    def assertSMSFailed(self, partner, number, error_code, content=None, fields_values=None):
         """ Check failed SMS. Search is done for a pair partner / number where
         partner can be an empty recordset. """
-        sms = self._find_sms_sms(partner, number, 'error')
-        self.assertTrue(sms, 'SMS: not found failed SMS for %s (number: %s)' % (partner, number))
-        self.assertEqual(sms.error_code, error_code)
-        if content is not None:
-            self.assertEqual(sms.body, content)
+        self.assertSMS(partner, number, 'error', error_code=error_code, content=content, fields_values=fields_values)
 
-    def assertSMSOutgoing(self, partner, number, content=None):
+    def assertSMSOutgoing(self, partner, number, content=None, fields_values=None):
         """ Check outgoing SMS. Search is done for a pair partner / number where
         partner can be an empty recordset. """
-        sms = self._find_sms_sms(partner, number, 'outgoing')
-        self.assertTrue(sms, 'SMS: not found failed SMS for %s (number: %s)' % (partner, number))
-        if content is not None:
-            self.assertEqual(sms.body, content)
+        self.assertSMS(partner, number, 'outgoing', content=content, fields_values=fields_values)
 
     def assertNoSMSNotification(self, messages=None):
         base_domain = [('notification_type', '=', 'sms')]
@@ -134,7 +182,7 @@ class SMSCase(MockSMS):
         self.assertEqual(self.env['mail.notification'].search(base_domain), self.env['mail.notification'])
         self.assertEqual(self._sms, [])
 
-    def assertSMSNotification(self, recipients_info, content, messages=None, check_sms=True):
+    def assertSMSNotification(self, recipients_info, content, messages=None, check_sms=True, sent_unlink=False):
         """ Check content of notifications.
 
           :param recipients_info: list[{
@@ -174,13 +222,16 @@ class SMSCase(MockSMS):
                 self.assertEqual(notif.failure_type, recipient_info['failure_type'])
             if check_sms:
                 if state == 'sent':
-                    self.assertSMSSent([number], content)
+                    if sent_unlink:
+                        self.assertSMSIapSent([number], content=content)
+                    else:
+                        self.assertSMS(partner, number, 'sent', content=content)
                 elif state == 'ready':
-                    self.assertSMSOutgoing(partner, number, content)
+                    self.assertSMS(partner, number, 'outgoing', content=content)
                 elif state == 'exception':
-                    self.assertSMSFailed(partner, number, recipient_info['failure_type'], content)
+                    self.assertSMS(partner, number, 'error', error_code=recipient_info['failure_type'], content=content)
                 elif state == 'canceled':
-                    self.assertSMSCanceled(partner, number, recipient_info.get('failure_type', False), content)
+                    self.assertSMS(partner, number, 'canceled', error_code=recipient_info['failure_type'], content=content)
                 else:
                     raise NotImplementedError('Not implemented')