Add exec_command tool, integrate it into main app, and add tests

Author: lzwjava

mini_copilot/exec_tool.py

@@ -0,0 +1,26 @@
+import subprocess
+
+
+def exec_command(command: str) -> str:
+    """Execute a shell command and return its output (stdout or stderr)."""
+    print(f"[exec] Running command: {command}")
+    try:
+        # Run command with a 30s timeout, capturing both stdout and stderr
+        result = subprocess.run(
+            command, shell=True, capture_output=True, text=True, timeout=30
+        )
+        output = result.stdout if result.returncode == 0 else result.stderr
+        if not output.strip():
+            output = f"(Process exited with code {result.returncode})"
+        return output
+    except subprocess.TimeoutExpired:
+        return "Error: Command timed out after 30 seconds."
+    except Exception as e:
+        return f"Error executing command: {str(e)}"
+
+
+if __name__ == "__main__":
+    import sys
+
+    if len(sys.argv) > 1:
+        print(exec_command(" ".join(sys.argv[1:])))

mini_copilot/main.py

@@ -20,6 +20,7 @@ def completer(text, state):
 
 from mini_copilot.github_api import chat, get_copilot_token
 from mini_copilot.web_search import web_search
+from mini_copilot.exec_tool import exec_command
 from mini_copilot.commands.auth import handle_login_command
 from mini_copilot.commands.model import handle_model_command
 from mini_copilot.commands.search_provider import handle_search_provider_command
@@ -59,7 +60,25 @@ def completer(text, state):
         },
     },
 }
-TOOLS = [WEB_SEARCH_TOOL]
+
+EXEC_COMMAND_TOOL = {
+    "type": "function",
+    "function": {
+        "name": "exec_command",
+        "description": "Execute a shell command on the local system and return the output.",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "command": {
+                    "type": "string",
+                    "description": "The shell command to execute.",
+                },
+            },
+            "required": ["command"],
+        },
+    },
+}
+TOOLS = [WEB_SEARCH_TOOL, EXEC_COMMAND_TOOL]
 
 
 def load_github_token():
@@ -167,6 +186,19 @@ def main():
                                 "content": search_context,
                             }
                         )
+
+                    if function_name == "exec_command":
+                        command = function_args.get("command")
+                        output = exec_command(command)
+
+                        messages.append(
+                            {
+                                "tool_call_id": tool_call["id"],
+                                "role": "tool",
+                                "name": function_name,
+                                "content": output,
+                            }
+                        )
                 response_message = chat(
                     messages, copilot_token, current_model, tools=TOOLS
                 )

tests/test_exec_tool.py

@@ -0,0 +1,21 @@
+import unittest
+from mini_copilot.exec_tool import exec_command
+
+
+class TestExecTool(unittest.TestCase):
+    def test_exec_echo(self):
+        output = exec_command("echo 'hello world'")
+        self.assertEqual(output.strip(), "hello world")
+
+    def test_exec_ls(self):
+        output = exec_command("ls pyproject.toml")
+        self.assertIn("pyproject.toml", output)
+
+    def test_exec_error(self):
+        # Depending on the system, the error message might vary, but it should contain some indication of failure
+        output = exec_command("non_existent_command_12345")
+        self.assertIn("not found", output.lower())
+
+
+if __name__ == "__main__":
+    unittest.main()