Add --keep-containers option

Author: klieret

codeclash/games/__init__.py

@@ -1,5 +1,3 @@
-from pathlib import Path
-
 from codeclash.games.battlecode.battlecode import BattleCodeGame
 from codeclash.games.battlesnake.battlesnake import BattleSnakeGame
 from codeclash.games.corewar.corewar import CoreWarGame
@@ -11,7 +9,7 @@
 
 
 # might consider postponing imports to avoid loading things we don't need
-def get_game(config: dict, *, tournament_id: str, local_output_dir: Path) -> CodeGame:
+def get_game(config: dict, **kwargs) -> CodeGame:
     game = {
         x.name: x
         for x in [
@@ -26,4 +24,4 @@ def get_game(config: dict, *, tournament_id: str, local_output_dir: Path) -> Cod
     }.get(config["game"]["name"])
     if game is None:
         raise ValueError(f"Unknown game: {config['game']['name']}")
-    return game(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    return game(config, **kwargs)

codeclash/games/battlecode/battlecode.py

@@ -1,5 +1,4 @@
 import re
-from pathlib import Path
 
 from codeclash.agents.player import Player
 from codeclash.constants import DIR_WORK, RESULT_TIE
@@ -13,8 +12,8 @@
 class BattleCodeGame(CodeGame):
     name: str = "BattleCode"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         assert len(config["players"]) == 2, "BattleCode is a two-player game"
         self.run_cmd_round: str = "python run.py run"
         for arg, val in self.game_config.get("args", {}).items():

codeclash/games/battlesnake/battlesnake.py

@@ -2,7 +2,6 @@
 import random
 import time
 from concurrent.futures import ThreadPoolExecutor, as_completed
-from pathlib import Path
 
 from tqdm.auto import tqdm
 
@@ -14,8 +13,8 @@
 class BattleSnakeGame(CodeGame):
     name: str = "BattleSnake"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         self.run_cmd_round: str = "./battlesnake play"
         for arg, val in self.game_config.get("args", {}).items():
             if isinstance(val, bool):

codeclash/games/corewar/corewar.py

@@ -1,6 +1,5 @@
 import re
 import shlex
-from pathlib import Path
 
 from codeclash.agents.player import Player
 from codeclash.games.game import CodeGame, RoundStats
@@ -12,8 +11,8 @@
 class CoreWarGame(CodeGame):
     name: str = "CoreWar"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         self.run_cmd_round: str = "./src/pmars"
         for arg, val in self.game_config.get("args", {}).items():
             if isinstance(val, bool):

codeclash/games/game.py

@@ -61,7 +61,7 @@ def to_dict(self) -> dict[str, Any]:
 class CodeGame(ABC):
     name: str
 
-    def __init__(self, config: dict, *, tournament_id: str, local_output_dir: Path):
+    def __init__(self, config: dict, *, tournament_id: str, local_output_dir: Path, keep_containers: bool = False):
         """The CodeGame class is responsible for running games, i.e., taking a list of code
         from different agents/players and running them against each other.
         It also provides the environments for the game and agents to run in.
@@ -74,11 +74,13 @@ def __init__(self, config: dict, *, tournament_id: str, local_output_dir: Path):
             config: The overall config for the tournament.
             tournament_id: The id of the tournament.
             local_output_dir: The host/local directory to write logs to.
+            keep_containers: Do not remove containers after games/agent finish.
         """
         self.url_gh: str = f"git@github.com:{GH_ORG}/{self.name}.git"
         self.artifacts: list[Path] = []
         """Artifact objects that we might want to clean up after the game."""
         self.config: dict = config
+        self._keep_containers: bool = keep_containers
         self._metadata: dict = {
             "name": self.name,
             "config": self.config["game"],
@@ -156,6 +158,10 @@ def log_round(self, round_num: int) -> Path:
     def get_environment(self, branch_name: str | None = None) -> DockerEnvironment:
         """Get docker container ID with the game code installed."""
         self.build_image()
+        if not self._keep_containers:
+            run_args = ["--rm"]
+        else:
+            run_args = []
         environment = DockerEnvironment(
             image=self.image_name,
             cwd=str(DIR_WORK),
@@ -169,6 +175,7 @@ def get_environment(self, branch_name: str | None = None) -> DockerEnvironment:
             },
             container_timeout="3h",
             logger=self.logger,
+            run_args=run_args,
         )
         # Logger setting will likely not take effect for initial container creation logs
         environment.logger = get_logger("environment", emoji="🪴")

codeclash/games/huskybench/huskybench.py

@@ -1,5 +1,4 @@
 import re
-from pathlib import Path
 
 from codeclash.agents.player import Player
 from codeclash.games.game import CodeGame, RoundStats
@@ -14,8 +13,8 @@
 class HuskyBenchGame(CodeGame):
     name: str = "HuskyBench"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         self.num_players: int = len(config["players"])
         self.run_cmd_round: str = (
             f"python engine/main.py --port {HB_PORT} --players {self.num_players} "

codeclash/games/robocode/robocode.py

@@ -13,8 +13,8 @@
 class RoboCodeGame(CodeGame):
     name: str = "RoboCode"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         self.run_cmd_round: str = "./robocode.sh"
         for arg, val in self.game_config.get("args", {}).items():
             if isinstance(val, bool):

codeclash/games/robotrumble/robotrumble.py

@@ -1,7 +1,6 @@
 import shlex
 from collections import Counter
 from concurrent.futures import ThreadPoolExecutor, as_completed
-from pathlib import Path
 
 from tqdm.auto import tqdm
 
@@ -13,8 +12,8 @@
 class RobotRumbleGame(CodeGame):
     name: str = "RobotRumble"
 
-    def __init__(self, config, *, tournament_id: str, local_output_dir: Path):
-        super().__init__(config, tournament_id=tournament_id, local_output_dir=local_output_dir)
+    def __init__(self, config, **kwargs):
+        super().__init__(config, **kwargs)
         assert len(config["players"]) == 2, "RobotRumble is a two-player game"
         self.run_cmd_round: str = "./rumblebot run term"
 

codeclash/tournaments/pvp.py

@@ -17,13 +17,22 @@
 
 
 class PvpTournament(AbstractTournament):
-    def __init__(self, config: dict, *, output_dir: Path, cleanup: bool = False, push: bool = False):
+    def __init__(
+        self,
+        config: dict,
+        *,
+        output_dir: Path,
+        cleanup: bool = False,
+        push: bool = False,
+        keep_containers: bool = False,
+    ):
         super().__init__(config, name="PvpTournament", output_dir=output_dir)
         self.cleanup_on_end = cleanup
         self.game: CodeGame = get_game(
             self.config,
             tournament_id=self.tournament_id,
             local_output_dir=self.local_output_dir,
+            keep_containers=keep_containers,
         )
         self.agents: list[Player] = []
         for agent_conf in self.config["players"]:

codeclash/tournaments/single_player.py

@@ -19,13 +19,14 @@
 
 
 class SinglePlayerTraining(AbstractTournament):
-    def __init__(self, config: dict, *, output_dir: Path, cleanup: bool = False):
+    def __init__(self, config: dict, *, output_dir: Path, cleanup: bool = False, keep_containers: bool = False):
         super().__init__(config, name="SinglePlayerTraining", output_dir=output_dir)
         self.cleanup_on_end = cleanup
         self.game: CodeGame = get_game(
             self.config,
             tournament_id=self.tournament_id,
             local_output_dir=self.local_output_dir,
+            keep_containers=keep_containers,
         )
         self.agent: Player = self.get_agent(self.config["player"], round=1)
         mirror_agent_config = copy.deepcopy(self.config["player"])