extract function to libkernelbot

Author: ngc92

src/kernelbot/cogs/leaderboard_cog.py

@@ -19,10 +19,9 @@
 from libkernelbot.leaderboard_db import (
     LeaderboardItem,
     LeaderboardRankedEntry,
-    RunItem,
     SubmissionItem,
 )
-from libkernelbot.submission import SubmissionRequest, prepare_submission
+from libkernelbot.submission import SubmissionRequest, generate_run_verdict, prepare_submission
 from libkernelbot.utils import format_time, setup_logging
 
 if TYPE_CHECKING:
@@ -57,38 +56,6 @@ async def select_gpu_view(
         await view.wait()
         return view
 
-    def generate_run_verdict(self, run: RunItem, sub_data: SubmissionItem):
-        medals = {1: "🥇 First", 2: "🥈 Second", 3: "🥉 Third"}
-
-        # get the competition
-        with self.bot.leaderboard_db as db:
-            competition = db.get_leaderboard_submissions(
-                sub_data["leaderboard_name"], run["runner"]
-            )
-        # compare against the competition
-        other_by_user = False
-        run_time = float(run["score"])
-        score_text = format_time(run_time * 1e9)
-
-        for entry in competition:
-            # can we find our own run? Only if it is the fastest submission by this user
-            if entry["submission_id"] == sub_data["submission_id"]:
-                rank = entry["rank"]
-                if 1 <= rank <= 3:
-                    return f"> {medals[rank]} place on {run['runner']}: {score_text}"
-                elif rank <= 10:
-                    return f"> {rank}th place on {run['runner']}: {score_text}"
-                else:
-                    return f"> Personal best on {run['runner']}: {score_text}"
-            elif entry["user_id"] == sub_data["user_id"]:
-                other_by_user = True
-        if other_by_user:
-            # User already has a submission that is faster
-            return f"> Successful on {run['runner']}: {score_text}"
-        else:
-            # no submission by the user exists
-            return f"> 🍾 First successful submission on {run['runner']}: {score_text}"
-
     async def post_submit_hook(self, interaction: discord.Interaction, sub_id: int):
         with self.bot.leaderboard_db as db:
             sub_data: SubmissionItem = db.get_submission_by_id(sub_id)
@@ -100,7 +67,7 @@ async def post_submit_hook(self, interaction: discord.Interaction, sub_id: int):
                 and run["mode"] == SubmissionMode.LEADERBOARD.value
                 and run["passed"]
             ):
-                result_lines.append(self.generate_run_verdict(run, sub_data))
+                result_lines.append(generate_run_verdict(self.bot.backend, run, sub_data))
 
         if len(result_lines) > 0:
             await send_discord_message(

src/libkernelbot/submission.py

@@ -8,10 +8,11 @@
 from better_profanity import profanity
 
 from libkernelbot.consts import RankCriterion
+from libkernelbot.db_types import RunItem, SubmissionItem
 from libkernelbot.leaderboard_db import LeaderboardDB, LeaderboardItem
 from libkernelbot.run_eval import FullResult
 from libkernelbot.task import LeaderboardTask
-from libkernelbot.utils import KernelBotError, setup_logging
+from libkernelbot.utils import KernelBotError, format_time, setup_logging
 
 if typing.TYPE_CHECKING:
     from backend import KernelBackend
@@ -194,3 +195,34 @@ def compute_score(result: FullResult, task: LeaderboardTask, submission_id: int)
             raise KernelBotError(f"Invalid ranking criterion {task.ranking_by}")
 
     return score
+
+
+def generate_run_verdict(backend: "KernelBackend", run: RunItem, sub_data: SubmissionItem):
+    medals = {1: "🥇 First", 2: "🥈 Second", 3: "🥉 Third"}
+
+    # get the competition
+    with backend.db as db:
+        competition = db.get_leaderboard_submissions(sub_data["leaderboard_name"], run["runner"])
+    # compare against the competition
+    other_by_user = False
+    run_time = float(run["score"])
+    score_text = format_time(run_time * 1e9)
+
+    for entry in competition:
+        # can we find our own run? Only if it is the fastest submission by this user
+        if entry["submission_id"] == sub_data["submission_id"]:
+            rank = entry["rank"]
+            if 1 <= rank <= 3:
+                return f"> {medals[rank]} place on {run['runner']}: {score_text}"
+            elif rank <= 10:
+                return f"> {rank}th place on {run['runner']}: {score_text}"
+            else:
+                return f"> Personal best on {run['runner']}: {score_text}"
+        elif entry["user_id"] == sub_data["user_id"]:
+            other_by_user = True
+    if other_by_user:
+        # User already has a submission that is faster
+        return f"> Successful on {run['runner']}: {score_text}"
+    else:
+        # no submission by the user exists
+        return f"> 🍾 First successful submission on {run['runner']}: {score_text}"

unit-tests/test_report.py

@@ -62,7 +62,7 @@ def sample_run_result(mode="test") -> RunResult:
             "benchmark.0.worst": "1.8",
         }
     else:
-        assert False, f"Invalid mode: {mode}"
+        raise AssertionError(f"Invalid mode: {mode}")
 
     return RunResult(
         success=True,

unit-tests/test_submission.py

@@ -6,7 +6,7 @@
 
 from libkernelbot import submission
 from libkernelbot.consts import RankCriterion
-from libkernelbot.db_types import LeaderboardItem
+from libkernelbot.db_types import LeaderboardItem, RunItem, SubmissionItem
 from libkernelbot.utils import KernelBotError
 
 
@@ -344,3 +344,56 @@ def test_compute_score():
     mock_task.ranking_by = "WRONG"
     with pytest.raises(KernelBotError, match="Invalid ranking criterion WRONG"):
         submission.compute_score(mock_result, mock_task, 1)
+
+
+def test_generate_run_verdict(mock_backend):
+    """Test generate_run_verdict function with various ranking scenarios."""
+    from libkernelbot.submission import generate_run_verdict
+
+    # Mock run and submission data
+    run_item: RunItem = {"score": 1.5, "runner": "A100"}
+
+    sub_data: SubmissionItem = {
+        "submission_id": 123,
+        "leaderboard_name": "test_board",
+        "user_id": 42,
+    }
+
+    # Test first place
+    mock_backend.db.get_leaderboard_submissions.return_value = [
+        {"submission_id": 123, "user_id": 42, "rank": 1},
+        {"submission_id": 542, "user_id": 44, "rank": 2},
+    ]
+    result = generate_run_verdict(mock_backend, run_item, sub_data)
+    assert result == "> 🥇 First place on A100: 1500 ms"
+
+    # Test 5th place
+    mock_backend.db.get_leaderboard_submissions.return_value = [
+        {"submission_id": 652, "user_id": 41, "rank": 4},
+        {"submission_id": 123, "user_id": 42, "rank": 5},
+    ]
+    result = generate_run_verdict(mock_backend, run_item, sub_data)
+    assert result == "> 5th place on A100: 1500 ms"
+
+    # Test personal best (rank > 10)
+    mock_backend.db.get_leaderboard_submissions.return_value = [
+        {"submission_id": 123, "user_id": 42, "rank": 15}
+    ]
+    result = generate_run_verdict(mock_backend, run_item, sub_data)
+    assert result == "> Personal best on A100: 1500 ms"
+
+    # This user already has a faster submission
+    mock_backend.db.get_leaderboard_submissions.return_value = [
+        {"submission_id": 999, "user_id": 42, "rank": 3},
+        {"submission_id": 256, "user_id": 41, "rank": 2},
+    ]
+    result = generate_run_verdict(mock_backend, run_item, sub_data)
+    assert result == "> Successful on A100: 1500 ms"
+
+    # Test first submission by user
+    mock_backend.db.get_leaderboard_submissions.return_value = [
+        {"submission_id": 256, "user_id": 41, "rank": 2},
+        {"submission_id": 999, "user_id": 999, "rank": 999},
+    ]
+    result = generate_run_verdict(mock_backend, run_item, sub_data)
+    assert result == "> 🍾 First successful submission on A100: 1500 ms"