From 4448b153861e6e5fba3fd4352de16af6b72ee497 Mon Sep 17 00:00:00 2001
From: Felix Kloss <felix.kloss@uni-tuebingen.de>
Date: Mon, 9 Dec 2024 11:41:42 +0100
Subject: [PATCH] Add script `list_games`

I think there was no easy way to get an overview of the games yet, so
this commit adds a script `list_games` which simply prints a list of all
games.
The game IDs are omitted by default but can be shown with the --id flag.
---
 comprl/comprl/scripts/list_games.py | 89 +++++++++++++++++++++++++++++
 comprl/pyproject.toml               |  1 +
 2 files changed, 90 insertions(+)
 create mode 100644 comprl/comprl/scripts/list_games.py

diff --git a/comprl/comprl/scripts/list_games.py b/comprl/comprl/scripts/list_games.py
new file mode 100644
index 0000000..7897694
--- /dev/null
+++ b/comprl/comprl/scripts/list_games.py
@@ -0,0 +1,89 @@
+#!/usr/bin/env python3
+"""List all finished games."""
+
+import argparse
+import contextlib
+import logging
+import sys
+
+import sqlalchemy as sa
+import tabulate
+
+try:
+    import tomllib  # type: ignore[import-not-found]
+except ImportError:
+    # tomllib was added in Python 3.11.  Older versions can use tomli
+    import tomli as tomllib  # type: ignore[import-not-found, no-redef]
+
+from comprl.server.data.sql_backend import Game
+from comprl.server.data.interfaces import GameEndState
+
+
+def main() -> int:
+    """Entry point."""
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument(
+        "config", type=str, help="Config file that specifies the databases."
+    )
+    parser.add_argument(
+        "--verbose", "-v", action="store_true", help="Enable verbose output."
+    )
+    parser.add_argument("--id", action="store_true", help="Show game IDs")
+    args = parser.parse_args()
+
+    logging.basicConfig(
+        level=logging.DEBUG if args.verbose else logging.INFO,
+        format="[%(asctime)s] [%(name)s | %(levelname)s] %(message)s",
+    )
+
+    with open(args.config, "rb") as f:
+        data = tomllib.load(f)["CompetitionServer"]
+
+    db_path = data["database_path"]
+    engine = sa.create_engine(f"sqlite:///{db_path}")
+
+    fields = [
+        "start_time",
+        "user1",
+        "user2",
+        "score1",
+        "score2",
+        "end_state",
+        "winner",
+        "disconnected",
+    ]
+
+    if args.id:
+        fields = ["game_id"] + fields
+
+    table_data = []
+    with sa.orm.Session(engine) as session:
+        for game in session.scalars(sa.select(Game)).all():
+            game_data = {
+                "start_time": game.start_time,
+                "user1": game.user1_.username,
+                "user2": game.user2_.username,
+                "score1": game.score1,
+                "score2": game.score2,
+                "end_state": GameEndState(game.end_state).name,
+                "winner": game.winner_.username if game.winner_ is not None else None,
+                "disconnected": (
+                    game.disconnected_.username
+                    if game.disconnected_ is not None
+                    else None
+                ),
+            }
+
+            if args.id:
+                game_data["game_id"] = game.game_id
+
+            table_data.append([game_data[field] for field in fields])
+
+    print(tabulate.tabulate(table_data, headers=fields))
+
+    return 0
+
+
+if __name__ == "__main__":
+    with contextlib.suppress(KeyboardInterrupt):
+        sys.exit(main())
diff --git a/comprl/pyproject.toml b/comprl/pyproject.toml
index 51af954..a0c8521 100644
--- a/comprl/pyproject.toml
+++ b/comprl/pyproject.toml
@@ -20,6 +20,7 @@ dependencies = [
     "openskill==5.1.0",
     "sqlalchemy",
     "bcrypt",
+    "tabulate",
 ]
 
 [project.optional-dependencies]