raw_blob

Author: sdemagny

src/backend/core/factories.py

@@ -231,3 +231,19 @@ class Meta:
         [choice[0] for choice in models.MessageTemplateKindChoices.choices]
     )
     is_active = True
+
+
+class BlobFactory(factory.django.DjangoModelFactory):
+    """A factory to create blobs for testing purposes."""
+
+    class Meta:
+        model = models.Blob
+
+    sha256 = factory.LazyFunction(lambda: b"test_sha256_hash_32_bytes_long")
+    size = factory.Faker("random_int", min=100, max=10000)
+    content_type = factory.Faker("mime_type")
+    compression = factory.fuzzy.FuzzyChoice(
+        [choice[0] for choice in models.CompressionTypeChoices.choices]
+    )
+    raw_content = factory.LazyFunction(lambda: b"test raw content for blob")
+    mailbox = factory.SubFactory(MailboxFactory)

src/backend/core/migrations/0005_messagetemplate_alter_maildomain_custom_attributes_and_more.py

@@ -0,0 +1,89 @@
+# Generated by Django 5.1.8 on 2025-08-20 06:48
+
+import django.db.models.deletion
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0004_alter_maildomain_custom_attributes_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MessageTemplate',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
+                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
+                ('name', models.CharField(help_text="Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')", max_length=255, verbose_name='name')),
+                ('description', models.TextField(blank=True, help_text='Optional description of when to use this template', verbose_name='description')),
+                ('html_body', models.TextField(blank=True, help_text="HTML email body template with placeholders (e.g., '<p>Dear {recipient_name},</p>') or signature content", verbose_name='HTML body')),
+                ('text_body', models.TextField(blank=True, help_text="Plain text email body template with placeholders (e.g., 'Dear {recipient_name},') or signature content", verbose_name='text body')),
+                ('kind', models.SmallIntegerField(choices=[(1, 'reply'), (2, 'new_message'), (3, 'signature')], default=1, help_text='Kind of template (reply, forward, new message, auto reply, signature)', verbose_name='kind')),
+                ('is_active', models.BooleanField(default=True, help_text='Whether this template is available for use', verbose_name='is active')),
+            ],
+            options={
+                'verbose_name': 'message template',
+                'verbose_name_plural': 'message templates',
+                'db_table': 'messages_messagetemplate',
+                'ordering': ['name'],
+            },
+        ),
+        migrations.AlterField(
+            model_name='maildomain',
+            name='custom_attributes',
+            field=models.JSONField(blank=True, default=dict, help_text='Metadata to sync to the maildomain group in the identity provider.', verbose_name='Custom attributes'),
+        ),
+        migrations.AlterField(
+            model_name='user',
+            name='custom_attributes',
+            field=models.JSONField(blank=True, default=dict, help_text='Metadata to sync to the user in the identity provider.', verbose_name='Custom attributes'),
+        ),
+        migrations.CreateModel(
+            name='MessageTemplateMailbox',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
+                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
+                ('is_default', models.BooleanField(default=False, help_text='Whether this template is the default for this mailbox', verbose_name='is default')),
+                ('mailbox', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='template_mailboxes', to='core.mailbox')),
+                ('template', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='template_mailboxes', to='core.messagetemplate')),
+            ],
+            options={
+                'verbose_name': 'message template mailbox',
+                'verbose_name_plural': 'message template mailboxes',
+                'db_table': 'messages_messagetemplatemailbox',
+                'unique_together': {('template', 'mailbox')},
+            },
+        ),
+        migrations.AddField(
+            model_name='messagetemplate',
+            name='mailboxes',
+            field=models.ManyToManyField(help_text='Mailboxes that can use this template', related_name='message_templates', through='core.MessageTemplateMailbox', to='core.mailbox'),
+        ),
+        migrations.CreateModel(
+            name='MessageTemplateMailDomain',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
+                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
+                ('is_default', models.BooleanField(default=False, help_text='Whether this template is the default for this mail domain', verbose_name='is default')),
+                ('maildomain', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='template_maildomains', to='core.maildomain')),
+                ('template', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='template_maildomains', to='core.messagetemplate')),
+            ],
+            options={
+                'verbose_name': 'message template mail domain',
+                'verbose_name_plural': 'message template mail domains',
+                'db_table': 'messages_messagetemplatemaildomain',
+                'unique_together': {('template', 'maildomain')},
+            },
+        ),
+        migrations.AddField(
+            model_name='messagetemplate',
+            name='maildomains',
+            field=models.ManyToManyField(help_text='Mail domains that can use this template', related_name='message_templates', through='core.MessageTemplateMailDomain', to='core.maildomain'),
+        ),
+    ]

src/backend/core/migrations/0006_messagetemplate_raw_blob.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.1.8 on 2025-08-20 11:21
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0005_messagetemplate_alter_maildomain_custom_attributes_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='messagetemplate',
+            name='raw_blob',
+            field=models.ForeignKey(blank=True, help_text='Reference to the blob containing raw template data', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='message_templates', to='core.blob'),
+        ),
+    ]

src/backend/core/tests/api/test_message_template.py

@@ -40,6 +40,12 @@ def fixture_mailbox():
     return factories.MailboxFactory()
 
 
+@pytest.fixture(name="blob")
+def fixture_blob(mailbox):
+    """Create a test blob."""
+    return factories.BlobFactory(mailbox=mailbox)
+
+
 class TestMessageTemplateViewSet:
     """Test the MessageTemplateViewSet."""
 
@@ -608,7 +614,7 @@ def test_retrieve_no_access(self, user):
         )
         assert response.status_code == status.HTTP_404_NOT_FOUND
 
-    def test_create(self, user, mailbox):
+    def test_create(self, user, mailbox, blob):
         """Test creating a new email template."""
         factories.MailboxAccessFactory(
             mailbox=mailbox,
@@ -655,7 +661,7 @@ def test_create_unauthorized(self):
         response = client.post(reverse("message-templates-list"), data)
         assert response.status_code == status.HTTP_401_UNAUTHORIZED
 
-    def test_update(self, user, mailbox):
+    def test_update(self, user, mailbox, blob):
         """Test updating an email template."""
         factories.MailboxAccessFactory(
             mailbox=mailbox,
@@ -700,7 +706,7 @@ def test_update(self, user, mailbox):
         template.refresh_from_db()
         assert template.raw_blob.get_content().decode("utf-8") == "updated raw content"
 
-    def test_partial_update(self, user, mailbox):
+    def test_partial_update(self, user, mailbox, blob):
         """Test partially updating an email template."""
         factories.MailboxAccessFactory(
             mailbox=mailbox,
@@ -1055,6 +1061,7 @@ def test_template_abilities_in_response(self, user, mailbox):
         )
         assert response.status_code == status.HTTP_200_OK
         assert "abilities" in response.data
+        assert "raw_blob" in response.data  # raw_blob field should be present
 
     def test_template_list_with_abilities(self, user, mailbox):
         """Test that template list includes abilities."""
@@ -1081,6 +1088,7 @@ def test_template_list_with_abilities(self, user, mailbox):
         assert response.status_code == status.HTTP_200_OK
         assert len(response.data) == 1
         assert "abilities" in response.data[0]
+        assert "raw_blob" in response.data[0]  # raw_blob field should be present
 
     def test_template_no_access_abilities(self, user):
         """Test that users without access get no abilities."""