fix: Backticks get always escaped by runtime; add Ipython test (All-H…

…ands-AI#2321)

* added tests related to backticks

* updated .gitignore

* added extra linter test for All-Hands-AI#2210

* hotfix for integration test

* added test_ipython unit test

* added test_ipython unit test

* remove draft test from test_ipython.py

---------

Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>

opendevin/runtime/server/runtime.py

@@ -1,3 +1,5 @@
+import ast
+
 from opendevin.core.config import config
 from opendevin.events.action import (
     AgentRecallAction,
@@ -35,6 +37,36 @@ def __init__(
         super().__init__(event_stream, sid, sandbox)
         self.file_store = LocalFileStore(config.workspace_base)
 
+    def _is_python_code(self, text):
+        """
+        Check if the given text is valid Python code.
+
+        Args:
+            text (str): The text to check.
+
+        Returns:
+            bool: True if the text is valid Python code, False otherwise.
+        """
+        try:
+            ast.parse(text)
+            return True
+        except SyntaxError:
+            return False
+
+    def _preprocess_text(self, text):
+        """
+        Preprocess the text to escape backticks if it's valid Python code.
+
+        Args:
+            text (str): The text to preprocess.
+
+        Returns:
+            str: The preprocessed or original text.
+        """
+        if self._is_python_code(text):
+            return text.replace('`', r'\`')
+        return text
+
     async def run(self, action: CmdRunAction) -> Observation:
         return self._run_command(action.command, background=action.background)
 
@@ -48,7 +80,7 @@ async def kill(self, action: CmdKillAction) -> Observation:
         )
 
     async def run_ipython(self, action: IPythonRunCellAction) -> Observation:
-        action.code = action.code.replace('`', r'\`')
+        action.code = self._preprocess_text(action.code)
         obs = self._run_command(
             ("cat > /tmp/opendevin_jupyter_temp.py <<'EOL'\n" f'{action.code}\n' 'EOL'),
             background=False,

tests/unit/test_ipython.py

@@ -0,0 +1,103 @@
+import pathlib
+import tempfile
+from unittest.mock import MagicMock, call, patch
+
+import pytest
+
+from opendevin.core.config import config
+from opendevin.events.action import IPythonRunCellAction
+from opendevin.events.observation import IPythonRunCellObservation
+from opendevin.runtime.docker.ssh_box import DockerSSHBox
+from opendevin.runtime.plugins import JupyterRequirement
+from opendevin.runtime.server.runtime import ServerRuntime
+
+
+@pytest.fixture
+def temp_dir(monkeypatch):
+    # get a temporary directory
+    with tempfile.TemporaryDirectory() as temp_dir:
+        pathlib.Path().mkdir(parents=True, exist_ok=True)
+        yield temp_dir
+
+
+@pytest.mark.asyncio
+async def test_run_python_backticks():
+    # Create a mock event_stream
+    mock_event_stream = MagicMock()
+
+    test_code = "print('Hello, `World`!\n')"
+
+    # Mock the asynchronous sandbox execute method
+    mock_sandbox_execute = MagicMock()
+    mock_sandbox_execute.side_effect = [
+        (0, ''),  # Initial call during DockerSSHBox initialization
+        (0, ''),  # Initial call during DockerSSHBox initialization
+        (0, ''),  # Initial call during DockerSSHBox initialization
+        (0, ''),  # Write command
+        (0, test_code),  # Execute command
+    ]
+
+    # Set up the patches for the runtime and sandbox
+    with patch(
+        'opendevin.runtime.docker.ssh_box.DockerSSHBox.execute',
+        new=mock_sandbox_execute,
+    ):
+        # Initialize the runtime with the mock event_stream
+        runtime = ServerRuntime(event_stream=mock_event_stream)
+
+        # Define the test action with a simple IPython command
+        action = IPythonRunCellAction(code=test_code)
+
+        # Call the run_ipython method with the test action
+        result = await runtime.run_action(action)
+
+        # Assert that the result is an instance of IPythonRunCellObservation
+        assert isinstance(result, IPythonRunCellObservation)
+
+        # Assert that the execute method was called with the correct commands
+        expected_write_command = (
+            "cat > /tmp/opendevin_jupyter_temp.py <<'EOL'\n" f'{test_code}\n' 'EOL'
+        )
+        expected_execute_command = 'cat /tmp/opendevin_jupyter_temp.py | execute_cli'
+        mock_sandbox_execute.assert_has_calls(
+            [
+                call('mkdir -p /tmp'),
+                call('git config --global user.name "OpenDevin"'),
+                call('git config --global user.email "opendevin@opendevin.ai"'),
+                call(expected_write_command),
+                call(expected_execute_command),
+            ]
+        )
+
+        assert (
+            test_code == result.content
+        ), f'The output should contain the expected print output, got: {result.content}'
+
+
+def test_sandbox_jupyter_plugin_backticks(temp_dir):
+    # get a temporary directory
+    with patch.object(config, 'workspace_base', new=temp_dir), patch.object(
+        config, 'workspace_mount_path', new=temp_dir
+    ), patch.object(config, 'run_as_devin', new='true'), patch.object(
+        config, 'sandbox_type', new='ssh'
+    ):
+        for box in [DockerSSHBox()]:
+            box.init_plugins([JupyterRequirement])
+            test_code = "print('Hello, `World`!')"
+            expected_write_command = (
+                "cat > /tmp/opendevin_jupyter_temp.py <<'EOL'\n" f'{test_code}\n' 'EOL'
+            )
+            expected_execute_command = (
+                'cat /tmp/opendevin_jupyter_temp.py | execute_cli'
+            )
+            exit_code, output = box.execute(expected_write_command)
+            exit_code, output = box.execute(expected_execute_command)
+            print(output)
+            assert exit_code == 0, (
+                'The exit code should be 0 for ' + box.__class__.__name__
+            )
+            assert output.strip() == 'Hello, `World`!', (
+                'The output should be the same as the input for '
+                + box.__class__.__name__
+            )
+            box.close()