code-battles-cli 1.1.1__tar.gz → 1.2.0__tar.gz

code_battles_cli-1.2.0/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+on: [push]
+jobs:
+    test:
+        name: Test
+        strategy:
+            matrix:
+                version: ["3.8", "3.12"]
+                os: [ubuntu-latest, windows-latest, macos-latest]
+        runs-on: ${{ matrix.os }}
+        steps:
+            - name: Clone the repository
+              uses: actions/checkout@v4
+            - name: Install the latest version of rye
+              uses: eifinger/setup-rye@v4
+            - name: Pin Python version
+              run: rye pin ${{ matrix.version }}
+            - name: Sync rye
+              run: rye sync
+            - name: Run tests
+              run: rye test

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: code-battles-cli
-Version: 1.1.1
+Version: 1.2.0
 Summary: A CLI for competitors in any Code Battles event!
 Requires-Python: >=3.8
 Requires-Dist: click>=8.1.7
@@ -53,7 +53,7 @@ If you want to choose a custom bot name, you can run `code-battles upload bots/e
 
 ## Running a simulation
 
-You can run a simulation by running `code-battles run NYC bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
+You can run a simulation by running `code-battles run '{"map": "NYC"}' bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
 
 You will probably find the scripting API nicer to work with if you want to run simulations locally.
 

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/README.md

@@ -42,7 +42,7 @@ If you want to choose a custom bot name, you can run `code-battles upload bots/e
 
 ## Running a simulation
 
-You can run a simulation by running `code-battles run NYC bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
+You can run a simulation by running `code-battles run '{"map": "NYC"}' bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
 
 You will probably find the scripting API nicer to work with if you want to run simulations locally.
 

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "code-battles-cli"
-version = "1.1.1"
+version = "1.2.0"
 description = "A CLI for competitors in any Code Battles event!"
 dependencies = [
     "requests>=2.32.3",
@@ -20,7 +20,7 @@ build-backend = "hatchling.build"
 
 [tool.rye]
 managed = true
-dev-dependencies = []
+dev-dependencies = ["pytest>=8.3.5"]
 
 [tool.hatch.metadata]
 allow-direct-references = true

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/requirements-dev.lock

@@ -39,10 +39,16 @@ grpcio-status==1.67.0
     # via google-api-core
 idna==3.10
     # via requests
+iniconfig==2.1.0
+    # via pytest
 markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
+packaging==25.0
+    # via pytest
+pluggy==1.5.0
+    # via pytest
 proto-plus==1.24.0
     # via google-api-core
     # via google-cloud-firestore
@@ -59,6 +65,7 @@ pyasn1-modules==0.4.1
     # via google-auth
 pygments==2.18.0
     # via rich
+pytest==8.3.5
 requests==2.32.3
     # via code-battles-cli
     # via google-api-core

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/src/code_battles_cli/api.py

@@ -6,27 +6,40 @@ Firestore client implementation inspired by https://medium.com/@bobthomas295/cli
 
 import base64
 import datetime
-import logging
 import gzip
-import os
 import json
+import logging
+import os
 import shutil
 import subprocess
 import sys
-from typing import Any, Callable, Dict, List, Optional, Union
 from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import requests
-from google.oauth2.credentials import Credentials
 from google.cloud.firestore import Client as FirestoreClient
+from google.oauth2.credentials import Credentials
 from rich.prompt import Prompt
-from code_battles_cli.log import console, log, progress
 
+from code_battles_cli.log import console, log
 
 SIMULATION_FINISHED_MARK = b"--- SIMULATION FINISHED ---"
 SIMULATION_STEP_MARK = b"__CODE_BATTLES_ADVANCE_STEP"
 
 
+class SimulationException(Exception):
+    def __init__(self, stderr: bytes, exit_code: int):
+        self.stderr = stderr
+        self.exit_code = exit_code
+
+    def __str__(self):
+        return (
+            f"Simulation failed with exit code {self.exit_code}. Output:\n"
+            + self.stderr.decode()
+        )
+
+
 @dataclass
 class LogEntry:
     step: int
@@ -45,12 +58,13 @@ class SimulationResults:
 
 @dataclass
 class Simulation:
-    map: str
+    parameters: Dict[str, str]
     player_names: str
     game: str
     version: str
     timestamp: datetime.datetime
     logs: list
+    alerts: list
     decisions: List[bytes]
     seed: int
 
@@ -59,12 +73,13 @@ class Simulation:
             gzip.compress(
                 json.dumps(
                     {
-                        "map": self.map,
+                        "parameters": self.parameters,
                         "playerNames": self.player_names,
                         "game": self.game,
                         "version": self.version,
                         "timestamp": self.timestamp.isoformat(),
                         "logs": self.logs,
+                        "alerts": self.alerts,
                         "decisions": [
                             base64.b64encode(decision).decode()
                             for decision in self.decisions
@@ -79,12 +94,15 @@ class Simulation:
     def load(file: str):
         contents: Dict[str, Any] = json.loads(gzip.decompress(base64.b64decode(file)))
         return Simulation(
-            contents["map"],
+            contents["parameters"]
+            if "parameters" in contents
+            else {"map": contents["map"]},
             contents["playerNames"],
             contents["game"],
             contents["version"],
             datetime.datetime.fromisoformat(contents["timestamp"]),
             contents["logs"],
+            contents["alerts"],
             [base64.b64decode(decision) for decision in contents["decisions"]],
             contents["seed"],
         )
@@ -162,9 +180,6 @@ class Client:
         configuration = requests.get(self.url + "/firebase-configuration.json").json()
         self.firebase_api_key: str = configuration["apiKey"]
         self.firebase_project_id: str = configuration["projectId"]
-        # print(
-        #     f"Got API Key: '{self.firebase_api_key}' and Project ID: '{self.firebase_project_id}'"
-        # )
 
     def _sign_in(self, email_domain="gmail.com"):
         try:
@@ -197,9 +212,14 @@ class Client:
         self.document.set(bots, merge)
 
     def _possibly_download(self, force_download=False):
-        code_directory = os.path.expanduser(
-            f"~/.cache/code-battles/{''.join([c for c in self.url.removeprefix("https").removesuffix(".web.app") if c.isalnum()])}"
+        directory_name = "".join(
+            [
+                c
+                for c in self.url.removeprefix("https").removesuffix(".web.app")
+                if c.isalnum() or c == "-"
+            ]
         )
+        code_directory = os.path.expanduser(f"~/.cache/code-battles/{directory_name}")
 
         if force_download and os.path.exists(code_directory):
             shutil.rmtree(code_directory)
@@ -207,31 +227,11 @@ class Client:
         if not os.path.exists(code_directory):
             os.makedirs(code_directory)
 
-            with console.status("[blue]Fetching configuration from game website..."):
-                pyscript_configuration = requests.get(self.url + "/config.json").json()
-                logging.info(
-                    f"Fetched configuration containing {len(pyscript_configuration["files"])} game files."
-                )
-
-            with progress:
-                progress_id = progress.add_task(
-                    "[blue]Fetching game files...",
-                    total=len(pyscript_configuration["files"]),
-                )
-
-                for url_path, path in pyscript_configuration["files"].items():
-                    if not path.endswith(".py"):
-                        continue
-
-                    local_path = os.path.join(code_directory, *path.split("/"))
-                    os.makedirs(os.path.dirname(local_path), exist_ok=True)
-                    text = requests.get(self.url + url_path).text
-                    with open(local_path, "w") as f:
-                        f.write(text)
-                    progress.update(progress_id, advance=1)
-                progress.update(progress_id, visible=False)
-
-            logging.info("Finished fetching game files.")
+            with console.status("[blue]Fetching packed Python file..."):
+                packed_file = requests.get(self.url + "/scripts/packed.py").text
+                local_path = Path(code_directory) / "packed.py"
+                local_path.write_text(packed_file)
+                logging.info("Fetched packed Python file.")
 
         return code_directory
 
@@ -257,7 +257,7 @@ class Client:
             return output.decode()
 
         output = json.loads(output)
-        return SimulationResults(
+        result = SimulationResults(
             output["winner_index"],
             output["winner"],
             output["steps"],
@@ -269,9 +269,16 @@ class Client:
             ],
         )
 
+        error: bytes = p.stderr.read()
+        exit_code = p.wait()
+        if exit_code != 0:
+            raise SimulationException(error, exit_code)
+
+        return result
+
     def run_simulation(
         self,
-        map: str,
+        parameters: Dict[str, str],
         bot_filenames: List[str],
         bot_names: Optional[List[str]] = None,
         seed: Optional[int] = None,
@@ -300,16 +307,17 @@ class Client:
         p = subprocess.Popen(
             [
                 sys.executable,
-                os.path.join(code_directory, "main.py"),
+                os.path.join(code_directory, "packed.py"),
                 "simulate",
                 str(seed),
-                str(output_file),
-                map,
+                str(os.path.abspath(output_file)),
+                json.dumps(parameters),
                 "-".join(bot_names),
             ]
             + [os.path.abspath(f) for f in bot_filenames],
             env={"PYTHONPATH": os.path.join(code_directory, "code_battles")},
             stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
         )
 
         return self._get_simulation_output(p, json_output, on_step)
@@ -334,7 +342,7 @@ class Client:
         p = subprocess.Popen(
             [
                 sys.executable,
-                os.path.join(code_directory, "main.py"),
+                os.path.join(code_directory, "packed.py"),
                 "simulate-from-file",
                 simulation_file,
             ],

{code_battles_cli-1.1.1 → code_battles_cli-1.2.0}/src/code_battles_cli/commands/run.py

@@ -1,6 +1,7 @@
-import time
+import json
 import logging
 import sys
+import time
 from typing import List, Optional, Tuple
 
 import click
@@ -10,7 +11,7 @@ from code_battles_cli.log import log, progress
 
 
 @click.command()
-@click.argument("map", required=False)
+@click.argument("parameters", required=False)
 @click.argument("bots", nargs=-1)
 @click.option(
     "-U",
@@ -53,7 +54,7 @@ def run(
     username: Optional[str],
     password: Optional[str],
     dump_credentials: bool,
-    map: str,
+    parameters: Optional[str],
     bots: Tuple[str],
     force_download: bool,
     seed: Optional[int],
@@ -72,18 +73,18 @@ def run(
             progress.update(progress_id, advance=1)
 
         if simulation_file is not None:
-            assert (
-                map is None
-            ), "The simulation's map is given from the simulation file!"
-            assert (
-                len(bots) == 0
-            ), "The simulation's bots are given from the simulation file!"
-            assert (
-                seed is None
-            ), "The simulation's seed is given from the simulation file!"
-            assert (
-                output_file is None
-            ), "Shouldn't dump simualtion file from existing simulation file!"
+            assert parameters is None, (
+                "The simulation's map is given from the simulation file!"
+            )
+            assert len(bots) == 0, (
+                "The simulation's bots are given from the simulation file!"
+            )
+            assert seed is None, (
+                "The simulation's seed is given from the simulation file!"
+            )
+            assert output_file is None, (
+                "Shouldn't dump simualtion file from existing simulation file!"
+            )
 
             with open(simulation_file, "r") as f:
                 simulation_text = f.read()
@@ -92,7 +93,7 @@ def run(
                 f"Detected simulation file of {simulation.game} {simulation.version}"
             )
             logging.info(
-                f"Simulation happened in {simulation.map} between {', '.join(simulation.player_names)} with seed {simulation.seed}"
+                f"Simulation happened in {simulation.parameters.get('map')} between {', '.join(simulation.player_names)} with seed {simulation.seed}"
             )
             logging.info(f"Simulation contains {len(simulation.decisions)} decisions")
             progress.update(progress_id, total=len(simulation.decisions) - 1)
@@ -104,7 +105,7 @@ def run(
             assert len(bots) > 0, "Bots are required for simulation!"
 
             results = client.run_simulation(
-                map,
+                json.loads(parameters),
                 list(bots),
                 seed=seed,
                 force_download=False,
@@ -113,4 +114,4 @@ def run(
             )
     print("The winner is", results.winner, "after", results.steps, "steps.")
     end = time.time()
-    log.info(f"Simulation took {(end - start) :.2f}s.")
+    log.info(f"Simulation took {(end - start):.2f}s.")

code_battles_cli-1.2.0/tests/test_cli.py

@@ -0,0 +1,2 @@
+def test_client():
+    from code_battles_cli.api import Client