Merge branch 'Rossi-Luciano-implement_sps_package_validation'

Author: gitnnolabs

config/settings/base.py

@@ -247,7 +247,7 @@
 # This can be omitted to allow all files, but note that this may present a security risk
 # if untrusted users are allowed to upload files -
 # see https://docs.wagtail.org/en/stable/advanced_topics/deploying.html#user-uploaded-files
-WAGTAILDOCS_EXTENSIONS = ['csv', 'docx', 'key', 'odt', 'pdf', 'pptx', 'rtf', 'txt', 'xlsx', 'zip']
+WAGTAILDOCS_EXTENSIONS = ['csv', 'docx', 'json', 'key', 'odt', 'pdf', 'pptx', 'rtf', 'txt', 'xlsx', 'zip']
 
 # https://docs.djangoproject.com/en/dev/ref/settings/#auth-user-model
 AUTH_USER_MODEL = 'users.CustomUser'

config/settings/test.py

@@ -0,0 +1,30 @@
+import tempfile
+
+from .base import *
+
+DEBUG = False
+TEMPLATE_DEBUG = False
+SECRET_KEY = "test-secret-key-not-for-production"
+ALLOWED_HOSTS = ["localhost", "127.0.0.1", "testserver"]
+WAGTAILADMIN_BASE_URL = "http://testserver"
+
+PASSWORD_HASHERS = [
+    "django.contrib.auth.hashers.MD5PasswordHasher",
+]
+
+EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"
+
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+    }
+}
+
+CELERY_TASK_ALWAYS_EAGER = True
+CELERY_TASK_EAGER_PROPAGATES = True
+
+COMPRESS_ENABLED = False
+
+MEDIA_ROOT = tempfile.mkdtemp(prefix="markapi_test_media_")
+
+LLAMA_ENABLED = False

conftest.py

@@ -0,0 +1 @@
+

requirements/local.txt

@@ -8,8 +8,8 @@ watchgod==0.8.2  # https://github.com/samuelcolvin/watchgod
 django-extensions==3.2.3  # https://github.com/django-extensions/django-extensions
 django-debug-toolbar  # https://github.com/jazzband/django-debug-toolbar
 
-pytest==8.3.5
+pytest==9.0.3
 pytest-django==4.11.1
-pytest-cov==6.1.1
-coverage==7.8.0
+pytest-cov==7.1.0
+coverage==7.10.6
 django-coverage-plugin==3.1.0

requirements/production.txt

@@ -3,9 +3,9 @@
 -r base.txt
 
 gevent==24.2.1  # http://www.gevent.org/
-gunicorn==21.2.0 # https://github.com/benoitc/gunicorn
+gunicorn==26.0.0
 psycopg2-binary==2.9.9  # https://github.com/psycopg/psycopg2
-sentry-sdk[django]==2.5.1  # https://github.com/getsentry/sentry-python
+sentry-sdk[django]==2.60.0
 
 # Django
 # ------------------------------------------------------------------------------

setup.cfg

@@ -33,6 +33,9 @@ django_settings_module = config.settings.test
 # Django migrations should not produce any errors:
 ignore_errors = True
 
+[tool:pytest]
+DJANGO_SETTINGS_MODULE = config.settings.test
+
 [coverage:run]
 include =
     users/*

xml_manager/apps.py

@@ -2,5 +2,8 @@
 
 
 class XmlManagerConfig(AppConfig):
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'xml_manager'
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "xml_manager"
+
+    def ready(self):
+        import xml_manager.signals  # noqa: F401

xml_manager/exceptions.py

@@ -12,3 +12,6 @@ class XML_File_PDF_Generation_Error(Exception):
 
 class XML_File_HTML_Generation_Error(Exception):
     pass
+
+class SPS_Package_Validation_Error(Exception):
+    pass

xml_manager/forms.py

@@ -0,0 +1,59 @@
+import os
+
+from django import forms
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+from wagtail.admin.forms import WagtailAdminModelForm
+
+from xml_manager.models import SPSPackageValidation
+
+
+class SPSPackageValidationForm(WagtailAdminModelForm):
+    zip_upload = forms.FileField(
+        label=_("SPS package (.zip)"),
+        required=False,
+        help_text=_(
+            "On edit, leave empty to revalidate the current package without "
+            "replacing the file."
+        ),
+    )
+
+    class Meta:
+        model = SPSPackageValidation
+        fields = []
+
+    def clean_zip_upload(self):
+        zip_upload = self.cleaned_data.get("zip_upload")
+        if not zip_upload:
+            return zip_upload
+        if not zip_upload.name.lower().endswith(".zip"):
+            raise ValidationError(_("Only .zip files are allowed."))
+        if zip_upload.size == 0:
+            raise ValidationError(_("The file is empty."))
+        return zip_upload
+
+    def clean(self):
+        cleaned = super().clean()
+        if not self.instance.pk and not cleaned.get("zip_upload"):
+            raise ValidationError(_("A .zip file is required."))
+        return cleaned
+
+    @staticmethod
+    def save_wagtail_document(zip_upload):
+        from wagtail.documents.models import Document
+
+        document = Document(title=os.path.basename(zip_upload.name))
+        document.file.save(zip_upload.name, zip_upload, save=True)
+        return document
+
+    @staticmethod
+    def save_wagtail_document_from_path(file_path, title=None):
+        from django.core.files import File
+        from wagtail.documents.models import Document
+
+        basename = os.path.basename(file_path)
+        document_title = title or basename
+        with open(file_path, "rb") as fp:
+            document = Document(title=document_title)
+            document.file.save(basename, File(fp), save=True)
+        return document

xml_manager/migrations/0004_spspackagevalidation.py

@@ -0,0 +1,105 @@
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("wagtaildocs", "0014_alter_document_file_size"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("xml_manager", "0003_xmldocumentpdf_docx_file"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SPSPackageValidation",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "zip_size_bytes",
+                    models.PositiveBigIntegerField(
+                        default=0, verbose_name="ZIP size (bytes)"
+                    ),
+                ),
+                (
+                    "validated_at",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="Validated at"
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("pending", "Pending"),
+                            ("running", "Running"),
+                            ("done", "Done"),
+                            ("error", "Error"),
+                        ],
+                        default="pending",
+                        max_length=16,
+                        verbose_name="Status",
+                    ),
+                ),
+                (
+                    "error_message",
+                    models.TextField(blank=True, verbose_name="Error message"),
+                ),
+                (
+                    "exceptions_document",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="wagtaildocs.document",
+                        verbose_name="Exceptions file",
+                    ),
+                ),
+                (
+                    "package_document",
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="sps_validation",
+                        to="wagtaildocs.document",
+                        verbose_name="SPS package document",
+                    ),
+                ),
+                (
+                    "validated_by",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="sps_package_validations",
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="Validated by",
+                    ),
+                ),
+                (
+                    "validation_document",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="wagtaildocs.document",
+                        verbose_name="Validation file",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "SPS package validation",
+                "verbose_name_plural": "SPS package validations",
+            },
+        ),
+    ]