Remove dependency on local filesystem. (#228)

* Pull changes from #107 and #212

* Add a workspace class. Refactoring + tests

* Refactor SWE-Bench and make sure all 500 tasks can be solved.

* Pass revision id to parent class

* Tests should check for default SWE-bench/SWE-bench_Verified

* Make sure we apply any changes needed for setting up the environment.

* Rename RemoteWorkspace -> Workspace

* Fix typos.

* Use better delimiter for here-document + add explantion to workspace.write_file

* Show with hidden files when listing file with workspace

* Fix interact_with_pdb test

* Raises if git diff fails

---------

Co-authored-by: Matheus Pereira <matpereira@microsoft.com>

Author: MarcCote

debug_gym/agents/base_agent.py

@@ -348,10 +348,12 @@ def save_patch(self, task_name="custom"):
         )
 
     def log(self, task_name="custom"):
+        # Simple tools list.
+        tools = [f"{tool.name}({tool.arguments})" for tool in self.env.tools]
         jsonl_output = {
             "problem": task_name,
             "config": self.config,
-            "tools": self.llm.define_tools(self.env.tools),
+            "tools": self.llm.define_tools(self.env.tools) if self.llm else tools,
             "uuid": self._uuid,
             "success": self.env.done,
             "log": [],

debug_gym/gym/envs/aider.py

@@ -1,22 +1,81 @@
 import os
 import subprocess
+import tempfile
+from pathlib import Path
 
 import debug_gym.gym.utils as utils
 from debug_gym.constants import DEBUG_GYM_CACHE_DIR
 from debug_gym.gym.entities import EvalOutput
 from debug_gym.gym.envs.env import RepoEnv
+from debug_gym.gym.terminal import DockerTerminal, Terminal
+
+DOCKER_AIDER_IMAGE_NAME = "debug-gym:aider"
+
+
+def build_docker_image(logger):
+    """
+    Build a Docker image for the Mini Nightmare environment.
+    """
+    # Check if Docker image is built.
+    import docker
+
+    docker_client = docker.from_env(timeout=600)
+    try:
+        docker_client.images.get(DOCKER_AIDER_IMAGE_NAME)
+        return
+    except docker.errors.ImageNotFound:
+        pass
+
+    logger.info(f"Docker image {DOCKER_AIDER_IMAGE_NAME} not found. Building it...")
+
+    # Starts from the official Python 3.12 slim image
+    base_image = "python:3.12-slim"
+    # Then install git and the required Python packages
+    setup_commands = [
+        "apt update",
+        "apt install -y git tree",
+        "pip install pytest",
+    ]
+    # Create a temporary Dockerfile
+    with tempfile.TemporaryDirectory() as build_dir:
+        dockerfile_path = Path(build_dir) / "Dockerfile"
+        with open(dockerfile_path, "w") as dockerfile:
+            dockerfile.write(f"FROM {base_image}\n")
+            for command in setup_commands:
+                dockerfile.write(f"RUN {command}\n")
+
+        # Build the Docker image using docker client
+        image, build_logs = docker_client.images.build(
+            path=str(build_dir),
+            dockerfile="Dockerfile",
+            tag=DOCKER_AIDER_IMAGE_NAME,
+            rm=True,
+        )
+
+    logger.info(f"Docker image {DOCKER_AIDER_IMAGE_NAME} built successfully.")
 
 
 class AiderBenchmarkEnv(RepoEnv):
     REPO_URL = "https://github.com/exercism/python"
     REPO_PATH = DEBUG_GYM_CACHE_DIR / "exercism"
 
+    def __init__(
+        self,
+        entrypoint: str = "python -m pytest --tb=no -s .",
+        terminal: Terminal | None = None,
+        **kwargs,
+    ):
+
+        terminal = terminal or DockerTerminal(
+            base_image=DOCKER_AIDER_IMAGE_NAME,
+            logger=kwargs.get("logger"),
+        )
+
+        super().__init__(entrypoint=entrypoint, terminal=terminal, **kwargs)
+
     @property
     def instructions(self) -> str:
-        return self.current_sample["instructions"]
-
-    def __init__(self, entrypoint: str = "python -m pytest -s .", **kwargs):
-        super().__init__(entrypoint=entrypoint, **kwargs)
+        return self.current_task["instructions"]
 
     def calculate_max_score(self, eval_output: EvalOutput) -> int:
         return utils.extract_max_score_from_pytest_output(eval_output.output)
@@ -30,15 +89,43 @@ def eval(self, **kwargs) -> EvalOutput:
         self.last_eval = EvalOutput(success, output)
         return self.last_eval
 
-    def reset(self, *, options: dict = None):
-        options = options or {}
-        self.current_sample = self.dataset[options["task_name"]]
-        directory = self.current_sample["base_directory"]
-        self.setup_workspace(directory, entrypoint=self.entrypoint)
-        infos = super().reset(options=options)
-        return infos
+    def setup_task(self, task_name: str, options: dict = None):
+        if task_name not in self.dataset:
+            raise ValueError(f"Task {task_name} not found in the dataset.")
+        self.current_task = self.dataset[task_name]
+
+    def setup_workspace(self):
+        self.workspace.reset()
+
+        self.logger.info("Copying files..")
+        self.workspace.copy_content(
+            src=self.current_task["codebase"], target=self.workspace.working_dir
+        )
+        self.workspace.setup_file_filters()  # Use codebase's .debugignore and .debugreadonly.
+
+        self.set_entrypoints("python -m pytest --tb=no -s .")
+
+    def setup_terminal(self):
+        self.logger.info(f"Configuring {self.terminal}...")
+
+        self.terminal.run("git init")
+        self.terminal.run("git config user.name 'debug-gym'")
+        self.terminal.run("git config user.email '<>'")
+
+        self.terminal.run(
+            "git add *.py *.txt"
+        )  # Aider tasks only have Python and text files.
+        self.terminal.run("git commit -am 'Init'")
+
+        self.terminal.run(
+            "git add .debugignore .debugreadonly"
+        )  # Aider tasks come with those.
+        self.terminal.run("git commit -am 'Add debug-gym ignore and read-only files'")
 
     def load_dataset(self, problems: str | list[str] | None = None):
+        if isinstance(self.terminal, DockerTerminal):
+            build_docker_image(self.logger)
+
         if not os.path.exists(self.REPO_PATH):
             subprocess.run(["git", "clone", self.REPO_URL, self.REPO_PATH], check=True)
 
@@ -65,9 +152,6 @@ def load_dataset(self, problems: str | list[str] | None = None):
                     ".?*",  # Ignore hidden files and directories but not current dir "."
                     "__pycache__/",
                     "*.pyc",
-                    # "*.md",
-                    # "log/",
-                    # "data/",
                 ],
             )
             # Add .debugreadonly so tests are readonly.
@@ -76,7 +160,7 @@ def load_dataset(self, problems: str | list[str] | None = None):
             )
 
             dataset[task_name] = {
-                "base_directory": directory,
+                "codebase": directory,
                 "instructions": instructions,
                 "filename": task_name + ".py",
             }