♻️(backend) change email invitation content

Change the email invitation content. More
document related variables are added.
To benefit of the document inheritance, we moved
the function email_invitation to the document model.

src/backend/core/tests/documents/test_api_document_accesses_create.py

@@ -171,7 +171,7 @@ def test_api_document_accesses_create_authenticated_administrator(via, mock_user
     email = mail.outbox[0]
     assert email.to == [other_user["email"]]
     email_content = " ".join(email.body.split())
-    assert "Invitation to join Docs!" in email_content
+    assert f"{user.email} shared a document with you: {document.title}" in email_content
     assert "docs/" + str(document.id) + "/" in email_content
 
 
@@ -225,5 +225,5 @@ def test_api_document_accesses_create_authenticated_owner(via, mock_user_teams):
     email = mail.outbox[0]
     assert email.to == [other_user["email"]]
     email_content = " ".join(email.body.split())
-    assert "Invitation to join Docs!" in email_content
+    assert f"{user.email} shared a document with you: {document.title}" in email_content
     assert "docs/" + str(document.id) + "/" in email_content

src/backend/core/tests/documents/test_api_document_invitations.py

@@ -118,7 +118,10 @@ def test_api_document_invitations__create__privileged_members(
         email = mail.outbox[0]
         assert email.to == ["guest@example.com"]
         email_content = " ".join(email.body.split())
-        assert "Invitation to join Docs!" in email_content
+        assert (
+            f"{user.email} shared a document with you: {document.title}"
+            in email_content
+        )
     else:
         assert response.status_code == status.HTTP_403_FORBIDDEN
         assert models.Invitation.objects.exists() is False
@@ -158,7 +161,10 @@ def test_api_document_invitations__create__email_from_content_language():
     assert email.to == ["guest@example.com"]
 
     email_content = " ".join(email.body.split())
-    assert "Invitation à rejoindre Docs !" in email_content
+    assert (
+        f"{user.email} a partagé un document avec vous: {document.title}"
+        in email_content
+    )
 
 
 def test_api_document_invitations__create__email_from_content_language_not_supported():
@@ -196,7 +202,7 @@ def test_api_document_invitations__create__email_from_content_language_not_suppo
     assert email.to == ["guest@example.com"]
 
     email_content = " ".join(email.body.split())
-    assert "Invitation to join Docs!" in email_content
+    assert f"{user.email} shared a document with you: {document.title}" in email_content
 
 
 def test_api_document_invitations__create__issuer_and_document_override():

src/backend/core/tests/test_models_documents.py

@@ -2,7 +2,12 @@
 Unit tests for the Document model
 """
 
+import smtplib
+from logging import Logger
+from unittest import mock
+
 from django.contrib.auth.models import AnonymousUser
+from django.core import mail
 from django.core.exceptions import ValidationError
 from django.core.files.storage import default_storage
 
@@ -322,3 +327,94 @@ def test_models_documents_version_duplicate():
         Bucket=default_storage.bucket_name, Prefix=file_key
     )
     assert len(response["Versions"]) == 2
+
+
+def test_models_documents__email_invitation__success():
+    """
+    The email invitation is sent successfully.
+    """
+    document = factories.DocumentFactory()
+
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 0
+
+    document.email_invitation(
+        "en", "guest@example.com", models.RoleChoices.EDITOR, "sender@example.com"
+    )
+
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 1
+
+    # pylint: disable-next=no-member
+    email = mail.outbox[0]
+
+    assert email.to == ["guest@example.com"]
+    email_content = " ".join(email.body.split())
+
+    assert (
+        f"sender@example.com invited you as an editor on the following document : {document.title}"
+        in email_content
+    )
+    assert f"docs/{document.id}/" in email_content
+
+
+def test_models_documents__email_invitation__success_fr():
+    """
+    The email invitation is sent successfully in french.
+    """
+    document = factories.DocumentFactory()
+
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 0
+
+    document.email_invitation(
+        "fr-fr", "guest2@example.com", models.RoleChoices.OWNER, "sender2@example.com"
+    )
+
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 1
+
+    # pylint: disable-next=no-member
+    email = mail.outbox[0]
+
+    assert email.to == ["guest2@example.com"]
+    email_content = " ".join(email.body.split())
+
+    assert (
+        f"sender2@example.com vous a invité en tant que propriétaire "
+        f"sur le document suivant : {document.title}" in email_content
+    )
+    assert f"docs/{document.id}/" in email_content
+
+
+@mock.patch(
+    "core.models.send_mail",
+    side_effect=smtplib.SMTPException("Error SMTPException"),
+)
+@mock.patch.object(Logger, "error")
+def test_models_documents__email_invitation__failed(mock_logger, _mock_send_mail):
+    """Check mail behavior when an SMTP error occurs when sent an email invitation."""
+    document = factories.DocumentFactory()
+
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 0
+
+    document.email_invitation(
+        "en", "guest3@example.com", models.RoleChoices.ADMIN, "sender3@example.com"
+    )
+
+    # No email has been sent
+    # pylint: disable-next=no-member
+    assert len(mail.outbox) == 0
+
+    # Logger should be called
+    mock_logger.assert_called_once()
+
+    (
+        _,
+        email,
+        exception,
+    ) = mock_logger.call_args.args
+
+    assert email == "guest3@example.com"
+    assert isinstance(exception, smtplib.SMTPException)

src/backend/core/tests/test_utils.py

@@ -1,87 +0,0 @@
-"""
-Unit tests for the Invitation model
-"""
-
-import smtplib
-from logging import Logger
-from unittest import mock
-
-from django.core import mail
-
-import pytest
-
-from core.utils import email_invitation
-
-pytestmark = pytest.mark.django_db
-
-
-def test_utils__email_invitation_success():
-    """
-    The email invitation is sent successfully.
-    """
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 0
-
-    email_invitation("en", "guest@example.com", "123-456-789")
-
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 1
-
-    # pylint: disable-next=no-member
-    email = mail.outbox[0]
-
-    assert email.to == ["guest@example.com"]
-    email_content = " ".join(email.body.split())
-    assert "Invitation to join Docs!" in email_content
-    assert "docs/123-456-789/" in email_content
-
-
-def test_utils__email_invitation_success_fr():
-    """
-    The email invitation is sent successfully in french.
-    """
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 0
-
-    email_invitation("fr-fr", "guest@example.com", "123-456-789")
-
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 1
-
-    # pylint: disable-next=no-member
-    email = mail.outbox[0]
-
-    assert email.to == ["guest@example.com"]
-    email_content = " ".join(email.body.split())
-    assert "Invitation à rejoindre Docs !" in email_content
-    assert "docs/123-456-789/" in email_content
-
-
-@mock.patch(
-    "core.utils.send_mail",
-    side_effect=smtplib.SMTPException("Error SMTPException"),
-)
-@mock.patch.object(Logger, "error")
-def test_utils__email_invitation_failed(mock_logger, _mock_send_mail):
-    """Check mail behavior when an SMTP error occurs when sent an email invitation."""
-
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 0
-
-    email_invitation("en", "guest@example.com", "123-456-789")
-
-    # No email has been sent
-    # pylint: disable-next=no-member
-    assert len(mail.outbox) == 0
-
-    # Logger should be called
-    mock_logger.assert_called_once()
-
-    (
-        _,
-        email,
-        exception,
-    ) = mock_logger.call_args.args
-
-    assert email == "guest@example.com"
-    assert isinstance(exception, smtplib.SMTPException)