Database fixes (#27)

* Database fixes

* Workflow saving to db

* Run formatters

* Run formatter

* Some tests

* Fix tests

* Some util tests

* Not working tests

* More tests

* More more tests

* Fix non django tests

* Add missing migration

* Higher coverage

* Run formatters

* Run black

* Bump version

Author: MasloMaslane

example_workflows/string_regs.json

@@ -1,4 +1,4 @@
-__version__ = "1.0.0.dev2"
+__version__ = "1.0.0.dev3"
 
 from sio3pack.files import LocalFile
 from sio3pack.packages.exceptions import *
@@ -22,18 +22,21 @@ def from_file(file: str | LocalFile, configuration: SIO3PackConfig = None) -> Pa
     return Package.from_file(file, configuration=configuration)
 
 
-def from_db(problem_id: int) -> Package:
+def from_db(problem_id: int, configuration: SIO3PackConfig = None) -> Package:
     """
     Initialize a package object from the database.
     If sio3pack isn't installed with Django support, it should raise an ImproperlyConfigured exception.
     If there is no package with the given problem_id, it should raise an UnknownPackageType exception.
 
     :param problem_id: The problem id.
+    :param configuration: Configuration of the package.
     :return: The package object.
     """
     try:
-        import django
+        from django.conf import settings
 
-        return Package.from_db(problem_id)
+        configuration = configuration or SIO3PackConfig()
+        configuration.django_settings = settings
+        return Package.from_db(problem_id, configuration)
     except ImportError:
         raise ImproperlyConfigured("sio3pack is not installed with Django support.")

src/sio3pack/__init__.py

@@ -1,12 +1,24 @@
-from typing import Any, Type
+import json
+from typing import Any
 
 from django.core.files import File
 from django.db import transaction
 
 import sio3pack
-from sio3pack.django.common.models import SIO3Package, SIO3PackModelSolution, SIO3PackNameTranslation, SIO3PackStatement
-from sio3pack.files import LocalFile, RemoteFile
-from sio3pack.packages.exceptions import ImproperlyConfigured, PackageAlreadyExists
+from sio3pack.django.common.models import (
+    SIO3Package,
+    SIO3PackMainModelSolution,
+    SIO3PackModelSolution,
+    SIO3PackNameTranslation,
+    SIO3PackStatement,
+    SIO3PackTest,
+    SIO3PackWorkflow,
+)
+from sio3pack.files import LocalFile
+from sio3pack.files.remote_file import RemoteFile
+from sio3pack.packages.exceptions import PackageAlreadyExists
+from sio3pack.test import Test
+from sio3pack.workflow import Workflow
 
 
 class DjangoHandler:
@@ -47,7 +59,9 @@ def save_to_db(self):
 
         self._save_translated_titles()
         self._save_model_solutions()
+        self._save_main_model_solution()
         self._save_problem_statements()
+        self._save_tests()
 
     def _save_translated_titles(self):
         """
@@ -60,6 +74,18 @@ def _save_translated_titles(self):
                 name=title,
             )
 
+    def _save_main_model_solution(self):
+        """
+        Save the main model solution to the database.
+        """
+        instance = SIO3PackMainModelSolution(
+            package=self.db_package,
+        )
+        instance.source_file.save(
+            self.package.main_model_solution.filename, File(open(self.package.main_model_solution.path, "rb"))
+        )
+        instance.save()
+
     def _save_model_solutions(self):
         for order, solution in enumerate(self.package.model_solutions):
             instance = SIO3PackModelSolution(
@@ -68,6 +94,7 @@ def _save_model_solutions(self):
                 order_key=order,
             )
             instance.source_file.save(solution.filename, File(open(solution.path, "rb")))
+            instance.save()
 
     def _save_problem_statements(self):
         def _add_statement(language: str, statement: LocalFile):
@@ -82,6 +109,28 @@ def _add_statement(language: str, statement: LocalFile):
         for lang, statement in self.package.lang_statements.items():
             _add_statement(lang, statement)
 
+    def _save_tests(self):
+        for test in self.package.tests:
+            instance = SIO3PackTest(
+                package=self.db_package,
+                name=test.test_name,
+                test_id=test.test_id,
+                group=test.group,
+            )
+            if test.in_file:
+                instance.input_file.save(test.in_file.filename, File(open(test.in_file.path, "rb")))
+            if test.out_file:
+                instance.output_file.save(test.out_file.filename, File(open(test.out_file.path, "rb")))
+            instance.save()
+
+    def _save_workflows(self):
+        for name, wf in self.package.workflow_manager.all().items():
+            instance = SIO3PackWorkflow(
+                package=self.db_package,
+                name=name,
+                workflow_raw=json.dumps(wf.to_json()),
+            )
+
     @property
     def short_name(self) -> str:
         """
@@ -110,11 +159,41 @@ def model_solutions(self) -> list[dict[str, Any]]:
         A list of model solutions, where each element is a dictionary containing
         a :class:`sio3pack.RemoteFile` object.
         """
-        return [{"file": RemoteFile(s.source_file.path)} for s in self.db_package.model_solutions.all()]
+        return [{"file": RemoteFile(s.source_file)} for s in self.db_package.model_solutions.all()]
+
+    @property
+    def main_model_solution(self) -> RemoteFile:
+        """
+        The main model solution as a :class:`sio3pack.RemoteFile`.
+        """
+        return RemoteFile(self.db_package.main_model_solution.source_file)
 
     @property
     def lang_statements(self) -> dict[str, RemoteFile]:
         """
         A dictionary of problem statements, where keys are language codes and values are files.
         """
-        return {s.language: RemoteFile(s.content.path) for s in self.db_package.statements.all()}
+        return {s.language: RemoteFile(s.content) for s in self.db_package.statements.all()}
+
+    @property
+    def tests(self) -> list[Test]:
+        """
+        A list of tests, where each element is a dictionary containing
+        """
+        return [
+            Test(
+                test_id=t.test_id,
+                test_name=t.name,
+                group=t.group,
+                in_file=RemoteFile(t.input_file) if t.input_file else None,
+                out_file=RemoteFile(t.output_file) if t.output_file else None,
+            )
+            for t in self.db_package.tests.all()
+        ]
+
+    @property
+    def workflows(self) -> dict[str, Workflow]:
+        """
+        A dictionary of workflows, where keys are workflow names and values are :class:`sio3pack.Workflow` objects.
+        """
+        return {w.name: w.workflow for w in self.db_package.workflows.all()}

src/sio3pack/django/common/handler.py

@@ -0,0 +1,68 @@
+# Generated by Django 4.2.20 on 2025-05-05 09:29
+
+from django.db import migrations, models
+import django.db.models.deletion
+import sio3pack.django.common.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0003_alter_sio3packnametranslation_language_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SIO3PackTest",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=255, verbose_name="name")),
+                ("test_id", models.CharField(max_length=255, verbose_name="id")),
+                ("group", models.CharField(max_length=255, verbose_name="group")),
+                (
+                    "input_file",
+                    models.FileField(
+                        blank=True,
+                        null=True,
+                        upload_to=sio3pack.django.common.models.make_problem_filename,
+                        verbose_name="input file",
+                    ),
+                ),
+                (
+                    "output_file",
+                    models.FileField(
+                        blank=True,
+                        null=True,
+                        upload_to=sio3pack.django.common.models.make_problem_filename,
+                        verbose_name="output file",
+                    ),
+                ),
+                (
+                    "package",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, related_name="tests", to="common.sio3package"
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="SIO3PackMainModelSolution",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "source_file",
+                    models.FileField(
+                        upload_to=sio3pack.django.common.models.make_problem_filename, verbose_name="source file"
+                    ),
+                ),
+                (
+                    "package",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="main_model_solution",
+                        to="common.sio3package",
+                    ),
+                ),
+            ],
+        ),
+    ]

src/sio3pack/django/common/migrations/0004_sio3packtest_sio3packmainmodelsolution.py

@@ -0,0 +1,40 @@
+# Generated by Django 4.2.20 on 2025-05-05 09:48
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0004_sio3packtest_sio3packmainmodelsolution"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="sio3packtest",
+            options={"verbose_name": "test", "verbose_name_plural": "tests"},
+        ),
+        migrations.AlterUniqueTogether(
+            name="sio3packtest",
+            unique_together={("package", "name", "test_id", "group")},
+        ),
+        migrations.CreateModel(
+            name="SIO3PackWorkflow",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=255, verbose_name="name")),
+                ("workflow_raw", models.TextField(verbose_name="workflow")),
+                (
+                    "package",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, related_name="workflows", to="common.sio3package"
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "workflow",
+                "verbose_name_plural": "workflows",
+            },
+        ),
+    ]

src/sio3pack/django/common/migrations/0005_alter_sio3packtest_options_and_more.py

@@ -0,0 +1,39 @@
+# Generated by Django 4.2.20 on 2025-05-08 13:31
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0005_alter_sio3packtest_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="sio3packmainmodelsolution",
+            name="package",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.CASCADE, related_name="main_model_solution", to="common.sio3package"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="sio3packnametranslation",
+            name="language",
+            field=models.CharField(
+                choices=[("en", "English"), ("pl", "Polski")], max_length=7, verbose_name="language code"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="sio3packstatement",
+            name="language",
+            field=models.CharField(
+                blank=True,
+                choices=[("en", "English"), ("pl", "Polski")],
+                max_length=7,
+                null=True,
+                verbose_name="language code",
+            ),
+        ),
+    ]

src/sio3pack/django/common/migrations/0006_alter_sio3packmainmodelsolution_package_and_more.py

@@ -1,10 +1,13 @@
+import json
 import os
 
 from django.conf import settings
 from django.db import models
 from django.utils.text import get_valid_filename
 from django.utils.translation import gettext_lazy as _
 
+from sio3pack.workflow import Workflow
+
 try:
     from oioioi.filetracker.fields import FileField
 except ImportError:
@@ -67,6 +70,18 @@ def short_name(self):
         return self.name.rsplit(".", 1)[0]
 
 
+class SIO3PackMainModelSolution(models.Model):
+    package = models.OneToOneField(SIO3Package, on_delete=models.CASCADE, related_name="main_model_solution")
+    source_file = FileField(upload_to=make_problem_filename, verbose_name=_("source file"))
+
+    def __str__(self):
+        return f"<SIO3PackMainModelSolution {self.package.short_name}>"
+
+    @property
+    def short_name(self):
+        return self.source_file.name.rsplit(".", 1)[0]
+
+
 class SIO3PackStatement(models.Model):
     package = models.ForeignKey(SIO3Package, on_delete=models.CASCADE, related_name="statements")
     language = models.CharField(
@@ -92,3 +107,37 @@ def __str__(self):
     class Meta(object):
         verbose_name = _("problem statement")
         verbose_name_plural = _("problem statements")
+
+
+class SIO3PackTest(models.Model):
+    package = models.ForeignKey(SIO3Package, on_delete=models.CASCADE, related_name="tests")
+    name = models.CharField(max_length=255, verbose_name=_("name"))
+    test_id = models.CharField(max_length=255, verbose_name=_("id"))
+    group = models.CharField(max_length=255, verbose_name=_("group"))
+    input_file = FileField(upload_to=make_problem_filename, verbose_name=_("input file"), blank=True, null=True)
+    output_file = FileField(upload_to=make_problem_filename, verbose_name=_("output file"), blank=True, null=True)
+
+    def __str__(self):
+        return f"<SIO3PackTest {self.name}>"
+
+    class Meta(object):
+        verbose_name = _("test")
+        verbose_name_plural = _("tests")
+        unique_together = ("package", "name", "test_id", "group")
+
+
+class SIO3PackWorkflow(models.Model):
+    package = models.ForeignKey(SIO3Package, on_delete=models.CASCADE, related_name="workflows")
+    name = models.CharField(max_length=255, verbose_name=_("name"))
+    workflow_raw = models.TextField(verbose_name=_("workflow"))
+
+    def __str__(self):
+        return f"<SIO3PackWorkflow {self.name}>"
+
+    @property
+    def workflow(self) -> Workflow:
+        return Workflow.from_json(json.loads(self.workflow_raw))
+
+    class Meta(object):
+        verbose_name = _("workflow")
+        verbose_name_plural = _("workflows")