Rework tours plugin

Also replace tests using a ps server for team validation with the ps cli
interface

Author: Parnassius

Diff for: .env-example

@@ -30,10 +30,3 @@ COMMAND_CHARACTER=.
 ## WEBHOOKS: Dictionary containing room names associated with Discord webhook URLs.
 ## Used to send notifications about room events such as tournaments.
 # WEBHOOKS='{"room1": "https://discord.com/api/webhooks/123/abc", "room2": "https://discord.com/api/webhooks/456/def"}'
-
-## TESTS_MOD_USERNAME: PS username of a dummy user used to run tests against a real
-## showdown instance.
-# TESTS_MOD_USERNAME=mymod
-
-## TESTS_MOD_PASSWORD: PS password of the dummy tests user.
-# TESTS_MOD_PASSWORD=mypassword

Diff for: .github/workflows/ci-cd.yml

@@ -54,19 +54,9 @@ jobs:
       - name: Save coverage report
         run: cat coverage/coverage.md >> $GITHUB_STEP_SUMMARY
 
-  secrets-check:
-    runs-on: ubuntu-24.04
-    outputs:
-      has-secrets: ${{ steps.secrets-check.outputs.has-secrets }}
-    steps:
-      - name: Check if secrets are available
-        id: secrets-check
-        run: echo "has-secrets=${{ secrets.TESTS_BOT_USERNAME != '' }}" >> $GITHUB_OUTPUT
-
   integration:
     runs-on: ubuntu-24.04
-    needs: secrets-check
-    if: needs.secrets-check.outputs.has-secrets == 'true'
+    if: github.event_name == 'schedule'
     steps:
       - uses: actions/checkout@v4
       - name: Cache veekun database
@@ -91,12 +81,7 @@ jobs:
       - name: Create folders
         run: mkdir -p data pokemon-showdown
       - name: Run integration tests
-        run: podman build --env USERNAME --env PASSWORD --env TESTS_MOD_USERNAME --env TESTS_MOD_PASSWORD --volume "$PWD"/pokemon-showdown:/pokemon-showdown --volume "$PWD"/data:/data --target integration .
-        env:
-          USERNAME: ${{ secrets.TESTS_BOT_USERNAME }}
-          PASSWORD: ${{ secrets.TESTS_BOT_PASSWORD }}
-          TESTS_MOD_USERNAME: ${{ secrets.TESTS_MOD_USERNAME }}
-          TESTS_MOD_PASSWORD: ${{ secrets.TESTS_MOD_PASSWORD }}
+        run: podman build --volume "$PWD"/pokemon-showdown:/pokemon-showdown --volume "$PWD"/data:/data --target integration .
 
   coverage-badge:
     runs-on: ubuntu-24.04

Diff for: Containerfile

@@ -31,8 +31,11 @@ FROM builder as test-base
 
 RUN apk add --no-cache gcc musl-dev linux-headers
 RUN apk add --no-cache make
+RUN apk add --no-cache nodejs npm
+
+ENV CERBOTTANA_SHOWDOWN_PATH=/pokemon-showdown
 
-RUN mkdir -p /data
+RUN mkdir -p /data /pokemon-showdown
 
 RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --no-editable
@@ -49,13 +52,7 @@ RUN uv run coverage report --format=markdown > /coverage/coverage.md
 
 FROM test-base as integration
 
-ENV CERBOTTANA_SHOWDOWN_PATH=/pokemon-showdown
-
-RUN apk add --no-cache nodejs npm
-
-RUN mkdir -p /pokemon-showdown
-
-RUN make pytest-integration
+RUN uv run pytest -m integration
 
 
 FROM base as final

Diff for: Makefile

@@ -21,16 +21,12 @@ ruff:
 
 .PHONY: pytest
 pytest:
-	@uv run pytest -m 'not integration' --cov
-
-.PHONY: pytest-integration
-pytest-integration:
-	@uv run pytest -m 'integration'
+	@uv run pytest --cov
 
 .PHONY: lint
 lint: format-check darglint mypy ruff
 
 .PHONY: all
-all: format darglint mypy ruff pytest pytest-integration
+all: format darglint mypy ruff pytest
 
 .DEFAULT_GOAL := all

Diff for: pyproject.toml

@@ -24,7 +24,6 @@ dev = [
     "pytest-asyncio==0.25.3",
     "pytest-cov==6.0.0",
     "pytest-mock==3.14.0",
-    "pytest-xprocess==1.0.2",
     "python-dotenv[cli]==1.0.1",
     "ruff==0.9.9",
     "types-python-dateutil==2.9.0.20241206",

Diff for: src/cerbottana/plugins/__init__.py

@@ -6,7 +6,7 @@
 from collections.abc import Callable, Coroutine
 from functools import wraps
 from pathlib import Path
-from typing import TYPE_CHECKING, ClassVar
+from typing import TYPE_CHECKING, ClassVar, Protocol, runtime_checkable
 
 from domify.base_element import BaseElement
 from sqlalchemy import select
@@ -25,6 +25,12 @@
     HTMLPageFunc = Callable[[User, Room, int], BaseElement | None]
 
 
+@runtime_checkable
+class CommandClass(Protocol):
+    @classmethod
+    async def cmd_func(cls, msg: Message) -> None: ...
+
+
 # --- Command logic and complementary decorators ---
 
 
@@ -33,24 +39,27 @@ class Command:
 
     def __init__(
         self,
+        func_name: str,
         func: CommandFunc,
+        cls: CommandClass | None,
         aliases: tuple[str, ...],
         helpstr: str,
         is_unlisted: bool,
         required_rank: Role,
         required_rank_editable: bool | str,
         allow_pm: bool | Role,
     ) -> None:
-        self.name = func.__name__
+        self.name = func_name
         self.module = func.__module__
         self.callback = func
+        self.cls = cls
         self.aliases = (self.name, *aliases)
         self.helpstr = helpstr
         self.is_unlisted = is_unlisted
         self.required_rank = required_rank
         self.required_rank_editable = required_rank_editable
         self.allow_pm = allow_pm
-        self._instances[func.__name__] = self
+        self._instances[func_name] = self
 
     @property
     def splitted_aliases(self) -> dict[str, Command]:
@@ -107,6 +116,7 @@ def get_rank_editable_commands(cls) -> set[str]:
 
 
 def command_check_permission(
+    func_name: str,
     func: CommandFunc,
     allow_pm: bool | Role,
     main_room_only: bool,
@@ -120,7 +130,7 @@ async def wrapper(msg: Message) -> None:
         elif msg.room:
             roomid = msg.room.roomid
         is_pm = msg.room is None
-        req_rank = msg.conn.commands[func.__name__].get_required_rank(roomid, is_pm)
+        req_rank = msg.conn.commands[func_name].get_required_rank(roomid, is_pm)
 
         if main_room_only and not msg.user.has_role(req_rank, msg.conn.main_room):
             return
@@ -151,7 +161,7 @@ def command_wrapper(
     required_rank_editable: bool | str = False,
     main_room_only: bool = False,
     parametrize_room: bool = False,
-) -> Callable[[CommandFunc], Command]:
+) -> Callable[[CommandFunc | CommandClass], Command]:
     """Decorates a function to generate a Command instance.
 
     Args:
@@ -174,11 +184,17 @@ def command_wrapper(
             the docstring of `parametrize_room_wrapper`. Defaults to False.
 
     Returns:
-        Callable[[CommandFunc], Command]: Wrapper.
+        Callable[[CommandFunc | CommandClass], Command]: Wrapper.
     """
 
-    def cls_wrapper(func: CommandFunc) -> Command:
+    def cls_wrapper(func: CommandFunc | CommandClass) -> Command:
+        func_name = func.__name__.lower()  # type: ignore[union-attr]
+        cls = None
+        if isinstance(func, CommandClass):
+            cls = func
+            func = cls.cmd_func
         func = command_check_permission(
+            func_name,
             func,
             allow_pm,
             main_room_only,
@@ -187,7 +203,9 @@ def cls_wrapper(func: CommandFunc) -> Command:
         if parametrize_room:
             func = parametrize_room_wrapper(func)
         return Command(
+            func_name,
             func,
+            cls,
             aliases,
             helpstr,
             is_unlisted,