Add a comment with the summary of the submission

Author: bobot

.github/workflows/main.yml

@@ -31,9 +31,13 @@ jobs:
 
       - name: Show changed files
         run: |
-          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
-            poetry run smtcomp show $file
-          done
+          poetry run smtcomp show --into-comment-file comment.md ${{ steps.changed-files.outputs.all_changed_files }}
+
+      - name: PR comment with file
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          filePath: comment.md
+          comment_tag: summary
 
       - name: Run checks
         run: make check

smtcomp/defs.py

@@ -67,6 +67,18 @@ def of_int(cls, id: int) -> EnumAutoInt:
     def __hash__(self) -> int:
         return self.id
 
+    def __lt__(self, a: EnumAutoInt) -> bool:
+        return self.id.__lt__(a.id)
+
+    def __le__(self, a: EnumAutoInt) -> bool:
+        return self.id.__le__(a.id)
+
+    def __gt__(self, a: EnumAutoInt) -> bool:
+        return self.id.__gt__(a.id)
+
+    def __ge__(self, a: EnumAutoInt) -> bool:
+        return self.id.__ge__(a.id)
+
 
 class NameEmail(BaseModel):
     """

smtcomp/main.py

@@ -26,27 +26,49 @@
 import smtcomp.selection
 from smtcomp.unpack import write_cin, read_cin
 import smtcomp.scramble_benchmarks
+from rich.console import Console
 
 app = typer.Typer()
 
 
 @app.command()
-def show(file: str) -> None:
+def show(
+    files: list[Path] = typer.Argument(None),
+    into_comment_file: Annotated[Optional[Path], typer.Option(help="Write the summary into the given file")] = None,
+) -> None:
     """
     Show information about a solver submission
     """
-    s = None
-    try:
-        s = submission.read(file)
-    except Exception as e:
-        rich.print(f"[red]Error during file parsing of {file}[/red]")
-        print(e)
-        exit(1)
-    if not s:
-        rich.print(f"[red]Empty submission??? {file}[/red]")
-        exit(1)
-    submission.show(s)
 
+    def read_submission(file: Path) -> defs.Submission:
+        try:
+            return submission.read(str(file))
+        except Exception as e:
+            rich.print(f"[red]Error during file parsing of {file}[/red]")
+            print(e)
+            exit(1)
+
+    l = list(map(read_submission, files))
+
+    console = Console(record=into_comment_file is not None)
+    if into_comment_file is not None:
+        console.print("<details><summary>Summary of modified submissions</summary>")
+    for s in l:
+        if into_comment_file is not None:
+            console.print("")
+            console.print("```")
+        t = submission.tree_summary(s)
+        console.print(t)
+        if into_comment_file is not None:
+            console.print("```")
+    if into_comment_file is not None:
+        console.print("</details>")
+
+    if into_comment_file is not None:
+        if len(l) > 0:
+            into_comment_file.write_text(console.export_text())
+        else:
+            into_comment_file.write_text("")
 
 @app.command()
 def validate(file: str) -> None:

smtcomp/submission.py

@@ -10,7 +10,7 @@ def read(file: str) -> Submission:
     return Submission.model_validate_json(Path(file).read_text())
 
 
-def show(s: Submission) -> None:
+def tree_summary(s: Submission) -> Tree:
     tree = Tree(f"[bold]{s.name}[/bold]")
     tree.add(f"{len(s.contributors)} authors")
     tree.add(f"website: {s.website}")
@@ -23,4 +23,8 @@ def show(s: Submission) -> None:
             slogics = map(str, logics)
             for logic in sorted(slogics):
                 tree_div.add(logic)
-    rich.print(tree)
+    return tree
+
+
+def show(s: Submission) -> None:
+    rich.print(tree_summary(s))

tests/test_validate.py

@@ -26,6 +26,12 @@ def test_bad_json(name: str) -> None:
     assert result.exit_code == 1
 
 
+@pytest.mark.parametrize("name", good_cases)
+def test_show_json(name: str) -> None:
+    result = runner.invoke(app, ["show", name])
+    assert result.exit_code == 0
+
+
 submissions = list(Path("submissions").glob("*.json"))