udata 12.0.2.dev10__py3-none-any.whl → 13.0.1.dev21__py3-none-any.whl

udata/tests/test_mail.py

@@ -1,120 +1,156 @@
-from contextlib import contextmanager
-from smtplib import SMTPRecipientsRefused
-
 import pytest
 
 from udata.core.organization.factories import OrganizationFactory
 from udata.core.user.factories import UserFactory
-from udata.mail import mail, mail_sent, send
-from udata.tests import DBTestMixin, TestCase
-from udata.tests.helpers import assert_emit, assert_not_emit
-
-SMTPRecipientsRefusedList = ["not-found@udata", "not-found-either@udata"]
-
-
-class FakeSender:
-    def send(self, msg):
-        if all(recipient in SMTPRecipientsRefusedList for recipient in msg.recipients):
-            raise SMTPRecipientsRefused(msg.recipients)
-        mail_sent.send(msg)
-
-
-class FakeMail:
-    @contextmanager
-    def connect(*args, **kw):
-        yield FakeSender()
-
-
-class MailSendTest(TestCase, DBTestMixin):
-    def create_app(self):
-        app = super().create_app()
-        app.config["SEND_MAIL"] = True
-        return app
-
-    @pytest.fixture(autouse=True)
-    def patch_mail(self, mocker):
-        mocker.patch("udata.mail.mail", FakeMail())
-
-    def test_send_mail(self):
-        with assert_emit(mail_sent):
-            send("subject", [UserFactory(email="recipient@udata")], "base")
-
-    def test_send_mail_to_not_found_recipients(self):
-        with assert_not_emit(mail_sent):
-            send("subject", [UserFactory(email="not-found@udata")], "base")
-
-    def test_send_mail_to_multiple_recipients_with_some_not_found(self):
-        recipients = [
-            UserFactory(email="not-found@udata"),
-            UserFactory(email="recipient@udata"),
-            UserFactory(email="not-found-either@udata"),
-        ]
-        with assert_emit(mail_sent):
-            send("subject", recipients, "base")
-
-
-@pytest.mark.usefixtures("clean_db")
-@pytest.mark.frontend
-class MailCampaignTest:
-    def test_send_mail_campaign_link_new_member(self, app):
-        # MTM campaign are only added on web URL (not API ones generated when
-        # no front-end is configured)
-        app.config["CDATA_BASE_URL"] = "https://www.data.gouv.fr"
-
-        org = OrganizationFactory()
-        recipient = UserFactory(email="recipient@udata")
-
-        app.config["SEND_MAIL"] = True
-        app.config["MAIL_CAMPAIGN"] = ""
-        with mail.record_messages() as outbox:
-            send(
-                "subject",
-                [recipient],
-                "new_member",
-                org=org,
+from udata.i18n import lazy_gettext as _
+from udata.mail import LabelledContent, MailMessage, ParagraphWithLinks, send_mail
+from udata.tests.api import APITestCase
+from udata.tests.helpers import capture_mails
+
+
+class MailGenerationTest(APITestCase):
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_simple_mail(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org"),
+                MailMessage(_("Unknown"), paragraphs=[_("Some text")]),
+            )
+
+        assert len(mails) == 1
+        assert len(mails[0].recipients) == 1
+        assert mails[0].recipients[0] == "jane@example.org"
+        assert mails[0].subject == "Unknown"
+        assert "Some text" in mails[0].body
+        assert "Some text" in mails[0].html
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_allow_none_in_paragraphs(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org"),
+                MailMessage(_("Unknown"), paragraphs=[_("Some text"), None]),
             )
-        assert len(outbox) == 1
-        message = outbox[0]
-        assert "mtm_campaign" not in message.body
-        assert "mtm_campaign" not in message.html
-
-        app.config["MAIL_CAMPAIGN"] = "data-gouv-fr"
-        with mail.record_messages() as outbox:
-            send(
-                "subject",
-                [recipient],
-                "new_member",
-                org=org,
+
+        assert len(mails) == 1
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_multiple_recipients(self):
+        with capture_mails() as mails:
+            send_mail(
+                [
+                    UserFactory(email="jane@example.org"),
+                    UserFactory(email="john@example.org", prefered_language="fr"),
+                ],
+                MailMessage(_("Unknown"), paragraphs=[_("Some text")]),
+            )
+
+        assert len(mails) == 2
+        assert len(mails[0].recipients) == 1
+        assert mails[0].recipients[0] == "jane@example.org"
+        assert mails[0].subject == "Unknown"
+        assert len(mails[1].recipients) == 1
+        assert mails[1].recipients[0] == "john@example.org"
+        assert mails[1].subject == "Inconnu"
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_use_user_language(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(_("Unknown"), paragraphs=[_("Some text")]),
             )
-        assert len(outbox) == 1
-        message = outbox[0]
-        assert "mtm_campaign=data-gouv-fr" in message.body
-        assert "mtm_campaign=data-gouv-fr" in message.html
-
-    def test_send_mail_campaign_link_badge_added_company(self, app):
-        # MTM campaign are only added on web URL (not API ones generated when
-        # no front-end is configured)
-        app.config["CDATA_BASE_URL"] = "https://www.data.gouv.fr"
-
-        app.config["SEND_MAIL"] = True
-        org = OrganizationFactory()
-        org.add_badge("company")
-        badge = org.badges[0]
-        badge.created_by = UserFactory()
-        recipient = UserFactory(email="recipient@udata")
-
-        app.config["MAIL_CAMPAIGN"] = ""
-        with mail.record_messages() as outbox:
-            send("subject", [recipient], "badge_added_company", organization=org, badge=badge)
-        assert len(outbox) == 1
-        message = outbox[0]
-        assert "mtm_campaign" not in message.body
-        assert "mtm_campaign" not in message.html
-
-        app.config["MAIL_CAMPAIGN"] = "data-gouv-fr"
-        with mail.record_messages() as outbox:
-            send("subject", [recipient], "badge_added_company", organization=org, badge=badge)
-        assert len(outbox) == 1
-        message = outbox[0]
-        assert "mtm_campaign=data-gouv-fr" in message.body
-        assert "mtm_campaign=data-gouv-fr" in message.html
+
+        assert len(mails) == 1
+        assert mails[0].subject == "Inconnu"
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_use_objects_in_translations(self):
+        org = OrganizationFactory(name="My Org")
+
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(
+                    _("Unknown"),
+                    paragraphs=[ParagraphWithLinks(_("Some text %(org)s", org=org))],
+                ),
+            )
+
+        assert len(mails) == 1
+        assert "My Org" in mails[0].body
+        assert org.url_for() not in mails[0].body
+        assert "My Org" in mails[0].html
+        assert "<a" in mails[0].html
+        assert org.url_for() in mails[0].html
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_labelled_bloc(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(
+                    _("Unknown"),
+                    paragraphs=[LabelledContent(_("Some text:"), "Some content", inline=True)],
+                ),
+            )
+
+        assert len(mails) == 1
+        assert "<strong>Du texte :</strong> Some content" in mails[0].html
+        assert "Du texte : Some content" in mails[0].body
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_labelled_bloc_truncation(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(
+                    _("Unknown"),
+                    paragraphs=[
+                        LabelledContent(
+                            _("Some text:"),
+                            """
+                                Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
+                            """,
+                        )
+                    ],
+                ),
+            )
+
+        assert len(mails) == 1
+        assert "a type specimen book." not in mails[0].html
+        assert "a type specimen book." not in mails[0].body
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_escape_user_content_in_content(self):
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(
+                    _("Unknown"),
+                    paragraphs=[
+                        LabelledContent(
+                            _("Some text:"), "<script>Some content</script>", inline=True
+                        )
+                    ],
+                ),
+            )
+
+        assert len(mails) == 1
+        assert "<script>" not in mails[0].html
+
+    @pytest.mark.options(DEFAULT_LANGUAGE="en")
+    def test_escape_user_content_in_object_label(self):
+        org = OrganizationFactory(name="<script>My Org</script>")
+
+        with capture_mails() as mails:
+            send_mail(
+                UserFactory(email="jane@example.org", prefered_language="fr"),
+                MailMessage(
+                    _("Unknown"),
+                    paragraphs=[ParagraphWithLinks(_("Some text %(org)s", org=org))],
+                ),
+            )
+
+        assert len(mails) == 1
+        assert "<script>" not in mails[0].html