[Submission] Add final (default false) to check archive in zenodo

Author: bobot

smtcomp/defs.py

@@ -1133,6 +1133,10 @@ def uniq_id(self) -> str:
     def path(self) -> Path:
         return Path(self.uniq_id())
 
+    def check_final(self) -> None:
+        if self.url.host != "zenodo.org":
+            raise ValueError("Final version should have its archive in zenodo")
+
 
 class Command(BaseModel, extra="forbid"):
     """
@@ -1292,6 +1296,7 @@ class Submission(BaseModel, extra="forbid"):
     participations: Participations
     seed: int | None = None
     competitive: bool = True
+    final: bool = False
 
     @model_validator(mode="after")
     def check_archive(self) -> Submission:
@@ -1303,6 +1308,16 @@ def check_archive(self) -> Submission:
             raise ValueError(
                 "Field command (or aws_repository) is needed in all participations if not present at the root"
             )
+
+        def check_archive(archive: None | Archive) -> None:
+            if archive:
+                archive.check_final()
+
+        if self.final:
+            check_archive(self.archive)
+            for p in self.participations.root:
+                check_archive(p.archive)
+
         return self
 
     def uniq_id(self) -> str:

tests/test_bad_final.json

@@ -0,0 +1,24 @@
+{
+    "name": "mysolver",
+    "contributors": [
+        "foo",
+        {
+            "name": "bar",
+            "website": "http://bar.com/"
+        }
+    ],
+    "final":true,
+    "contacts": ["foo bar <foo@bar.org>"],
+    "archive": {
+        "url": "http://example.com/solver.tar.gz",
+        "h": { "sha256": "012345" }
+    },
+    "website": "http://example.com/",
+    "system_description": "http://example.com/system.pdf",
+    "command": ["foo", "--super-fast"],
+    "solver_type": "Standalone",
+    "participations": [
+        { "tracks": ["SingleQuery"], "divisions": ["QF_Strings"] },
+        { "tracks": ["SingleQuery"], "logics": "QF_.*" }
+    ]
+}

tests/test_good_final.json

@@ -0,0 +1,22 @@
+{
+    "name": "mysolver",
+    "contributors": [
+        "foo",
+        {
+            "name": "bar",
+            "website": "http://bar.com/"
+        }
+    ],
+    "contacts": ["foo bar <foo@bar.org>"],
+    "archive": {
+        "url": "http://zenodo.org/blabla/solver.tar.gz"
+    },
+    "website": "http://example.com/",
+    "system_description": "http://example.com/system.pdf",
+    "command": ["foo", "--super-fast"],
+    "solver_type": "Standalone",
+    "participations": [
+        { "tracks": ["SingleQuery"], "divisions": ["QF_Strings"] },
+        { "tracks": ["SingleQuery"], "logics": "QF_.*" }
+    ]
+}

tests/test_validate.py

@@ -14,8 +14,13 @@
 import smtcomp.results, smtcomp.scoring, smtcomp.generate_website_page
 
 runner = CliRunner()
-good_cases = ["tests/test1.json", "submissions/template/template.json", "submissions/template/template_aws_tracks.json"]
-bad_cases = ["test_bad.json"]
+good_cases = [
+    "tests/test1.json",
+    "submissions/template/template.json",
+    "submissions/template/template_aws_tracks.json",
+    "tests/test_good_final.json",
+]
+bad_cases = ["tests/test_bad.json", "tests/test_bad_final.json"]
 
 
 @pytest.mark.parametrize("name", good_cases)
@@ -27,7 +32,7 @@ def test_good_json(name: str) -> None:
 
 @pytest.mark.parametrize("name", bad_cases)
 def test_bad_json(name: str) -> None:
-    result = runner.invoke(app, ["validate", path.join("tests", name)])
+    result = runner.invoke(app, ["validate", name])
     assert result.exit_code == 1