👔(dimail) allow creation of "pending" mailboxes

Previously, mailbox creation was restricted to "enabled" domains.
We now allow users to create mailboxes on pending and failed domains.
Mailboxes thus created have the "pending" mailboxes status.

src/backend/mailbox_manager/tests/api/mailboxes/test_api_mailboxes_create.py

@@ -137,6 +137,7 @@ def test_api_mailboxes__create_roles_success(role):
         "last_name": str(mailbox.last_name),
         "local_part": str(mailbox.local_part),
         "secondary_email": str(mailbox.secondary_email),
+        "status": enums.MailboxStatusChoices.ENABLED,
     }
 
 
@@ -194,6 +195,7 @@ def test_api_mailboxes__create_with_accent_success(role):
         "last_name": str(mailbox.last_name),
         "local_part": str(mailbox.local_part),
         "secondary_email": str(mailbox.secondary_email),
+        "status": enums.MailboxStatusChoices.ENABLED,
     }
 
 
@@ -236,6 +238,73 @@ def test_api_mailboxes__create_administrator_missing_fields():
     assert response.json() == {"secondary_email": ["This field is required."]}
 
 
+@pytest.mark.parametrize(
+    "role",
+    [
+        enums.MailDomainRoleChoices.OWNER,
+        enums.MailDomainRoleChoices.ADMIN,
+    ],
+)
+def test_api_mailboxes__cannot_create_on_disabled_domain(role):
+    """Admin and owner users should not be able to create mailboxes for a disabled domain"""
+    mail_domain = factories.MailDomainFactory(
+        status=enums.MailDomainStatusChoices.DISABLED
+    )
+    access = factories.MailDomainAccessFactory(role=role, domain=mail_domain)
+
+    client = APIClient()
+    client.force_login(access.user)
+
+    mailbox_values = serializers.MailboxSerializer(
+        factories.MailboxFactory.build()
+    ).data
+    response = client.post(
+        f"/api/v1.0/mail-domains/{mail_domain.slug}/mailboxes/",
+        mailbox_values,
+        format="json",
+    )
+    assert response.status_code == status.HTTP_400_BAD_REQUEST
+    assert not models.Mailbox.objects.exists()
+    assert response.json() == ["You can't create a mailbox for a disabled domain."]
+
+
+@pytest.mark.parametrize(
+    "domain_status",
+    [
+        enums.MailDomainStatusChoices.PENDING,
+        enums.MailDomainStatusChoices.FAILED,
+    ],
+)
+def test_api_mailboxes__create_pending_mailboxes(domain_status):
+    """
+    Admin and owner users should be able to create mailboxes, including on pending and failed
+    domains.
+    Mailboxes created on pending and failed domains should have the "pending" status
+    """
+    mail_domain = factories.MailDomainFactory(status=domain_status)
+    access = factories.MailDomainAccessFactory(
+        role=enums.MailDomainRoleChoices.ADMIN, domain=mail_domain
+    )
+
+    client = APIClient()
+    client.force_login(access.user)
+
+    mailbox_values = serializers.MailboxSerializer(
+        factories.MailboxFactory.build()
+    ).data
+    with responses.RequestsMock():
+        # We add no response in RequestsMock
+        # because we expect no outside calls to be made
+        response = client.post(
+            f"/api/v1.0/mail-domains/{mail_domain.slug}/mailboxes/",
+            mailbox_values,
+            format="json",
+        )
+    assert response.status_code == status.HTTP_201_CREATED
+    mailbox = models.Mailbox.objects.get()
+    assert mailbox.status == "pending"
+
+
 ### REACTING TO DIMAIL-API
 ### We mock dimail's responses to avoid testing dimail's container too
 
@@ -411,6 +480,7 @@ def test_api_mailboxes__domain_owner_or_admin_successful_creation_and_provisioni
         "last_name": str(mailbox_data["last_name"]),
         "local_part": str(mailbox_data["local_part"]),
         "secondary_email": str(mailbox_data["secondary_email"]),
+        "status": enums.MailboxStatusChoices.ENABLED,
     }
     assert mailbox.first_name == mailbox_data["first_name"]
     assert mailbox.last_name == mailbox_data["last_name"]

src/backend/mailbox_manager/tests/api/mailboxes/test_api_mailboxes_list.py

@@ -53,8 +53,8 @@ def test_api_mailboxes__list_authenticated():
 def test_api_mailboxes__list_roles(role):
     """Owner, admin and viewer users should be able to list mailboxes"""
     mail_domain = factories.MailDomainEnabledFactory()
-    mailbox1 = factories.MailboxFactory(domain=mail_domain)
-    mailbox2 = factories.MailboxFactory(domain=mail_domain)
+    mailbox1 = factories.MailboxEnabledFactory(domain=mail_domain)
+    mailbox2 = factories.MailboxEnabledFactory(domain=mail_domain)
 
     access = factories.MailDomainAccessFactory(role=role, domain=mail_domain)
     client = APIClient()
@@ -69,6 +69,7 @@ def test_api_mailboxes__list_roles(role):
             "last_name": str(mailbox2.last_name),
             "local_part": str(mailbox2.local_part),
             "secondary_email": str(mailbox2.secondary_email),
+            "status": enums.MailboxStatusChoices.ENABLED,
         },
         {
             "id": str(mailbox1.id),
@@ -76,6 +77,7 @@ def test_api_mailboxes__list_roles(role):
             "last_name": str(mailbox1.last_name),
             "local_part": str(mailbox1.local_part),
             "secondary_email": str(mailbox1.secondary_email),
+            "status": enums.MailboxStatusChoices.ENABLED,
         },
     ]
 

src/backend/mailbox_manager/tests/test_models_mailboxes.py

@@ -74,7 +74,7 @@ def test_models_mailboxes__domain_must_be_a_maildomain_instance():
 
 def test_models_mailboxes__domain_cannot_be_null():
     """The "domain" field should not be null."""
-    with pytest.raises(models.MailDomain.DoesNotExist, match="Mailbox has no domain."):
+    with pytest.raises(exceptions.ValidationError, match="This field cannot be null"):
         factories.MailboxFactory(domain=None)
 
 
@@ -93,44 +93,37 @@ def test_models_mailboxes__secondary_email_cannot_be_null():
         factories.MailboxFactory(secondary_email=None)
 
 
-def test_models_mailboxes__cannot_be_created_for_disabled_maildomain():
-    """Mailbox creation is allowed only for a domain enabled.
+@pytest.mark.parametrize(
+    "domain_status",
+    [
+        enums.MailDomainStatusChoices.PENDING,
+        enums.MailDomainStatusChoices.FAILED,
+    ],
+)
+def test_models_mailboxes__can_create_pending_mailboxes_on_non_enabled_domain(
+    domain_status,
+):
+    """Mailbox creation is allowed for a domain pending and failed.
+    A pending mailbox is created."""
+    mailbox = factories.MailboxFactory(
+        domain=factories.MailDomainFactory(status=domain_status)
+    )
+    assert mailbox.status == enums.MailboxStatusChoices.PENDING
+
+
+def test_models_mailboxes__cannot_create_mailboxes_on_disabled_domain():
+    """Mailbox creation is not allowed for a domain disabled.
     A disabled status for the mail domain raises an error."""
     with pytest.raises(
         exceptions.ValidationError,
-        match="You can create mailbox only for a domain enabled",
+        match="You can't create a mailbox for a disabled domain.",
     ):
         factories.MailboxFactory(
             domain=factories.MailDomainFactory(
                 status=enums.MailDomainStatusChoices.DISABLED
             )
         )
-
-
-def test_models_mailboxes__cannot_be_created_for_failed_maildomain():
-    """Mailbox creation is allowed only for a domain enabled.
-    A failed status for the mail domain raises an error."""
-    with pytest.raises(
-        exceptions.ValidationError,
-        match="You can create mailbox only for a domain enabled",
-    ):
-        factories.MailboxFactory(
-            domain=factories.MailDomainFactory(
-                status=enums.MailDomainStatusChoices.FAILED
-            )
-        )
-
-
-def test_models_mailboxes__cannot_be_created_for_pending_maildomain():
-    """Mailbox creation is allowed only for a domain enabled.
-    A pending status for the mail domain raises an error."""
-    with pytest.raises(
-        exceptions.ValidationError,
-        match="You can create mailbox only for a domain enabled",
-    ):
-        # MailDomainFactory initializes a mail domain with default values,
-        # so mail domain status is pending!
-        factories.MailboxFactory(domain=factories.MailDomainFactory())
+        assert not models.Mailbox.objects.exist()
 
 
 ### REACTING TO DIMAIL-API

src/backend/mailbox_manager/tests/test_models_maildomain.py

@@ -37,6 +37,21 @@ def test_models_mail_domain__slug_inferred_from_name():
     assert domain.slug == slugify(name)
 
 
+# "STATUS" FIELD
+
+
+def test_models_mail_domain__status_should_not_be_empty():
+    """Status field should not be empty."""
+    with pytest.raises(ValidationError, match="This field cannot be blank"):
+        factories.MailDomainFactory(status="")
+
+
+def test_models_mail_domain__status_should_not_be_null():
+    """Status field should not be null."""
+    with pytest.raises(ValidationError, match="This field cannot be null."):
+        factories.MailDomainFactory(status=None)
+
+
 # get_abilities