scalebox-sdk 0.1.0__py3-none-any.whl

scalebox/sandbox_async/commands/command.py

@@ -0,0 +1,307 @@
+from typing import Dict, List, Literal, Optional, Union, overload
+
+import aiohttp
+
+from ... import csx_connect
+from ...connection_config import (
+    KEEPALIVE_PING_HEADER,
+    KEEPALIVE_PING_INTERVAL_SEC,
+    ConnectionConfig,
+    Username,
+)
+from ...exceptions import SandboxException
+from ...generated import api_pb2, api_pb2_connect
+from ...generated.rpc import handle_rpc_exception
+from ...sandbox.commands.command_handle import CommandResult
+from ...sandbox.commands.main import ProcessInfo
+from ...sandbox_async.commands.command_handle import AsyncCommandHandle, Stderr, Stdout
+from ...sandbox_async.utils import OutputHandler
+
+
+class Commands:
+    """
+    Module for executing commands in the sandbox.
+    """
+
+    def __init__(
+        self,
+        envd_api_url: str,
+        connection_config: ConnectionConfig,
+        pool: aiohttp.ClientSession,
+    ) -> None:
+        self._connection_config = connection_config
+        self._rpc = api_pb2_connect.AsyncProcessClient(
+            envd_api_url,
+            http_client=pool
+        )
+        self._headers=connection_config.headers
+        self._pool = pool
+
+    async def list(
+        self,
+        request_timeout: Optional[float] = None,
+    ) -> List[ProcessInfo]:
+        """
+        Lists all running commands and PTY sessions.
+
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: List of running commands and PTY sessions
+        """
+        try:
+            res = await self._rpc.list(
+                api_pb2.ListRequest(),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            return [
+                ProcessInfo(
+                    pid=p.pid,
+                    tag=p.tag,
+                    cmd=p.config.cmd,
+                    args=list(p.config.args),
+                    envs=dict(p.config.envs),
+                    cwd=p.config.cwd,
+                )
+                for p in res.processes
+            ]
+        except Exception as e:
+            raise handle_rpc_exception(e)
+
+    async def kill(
+        self,
+        pid: int,
+        request_timeout: Optional[float] = None,
+    ) -> bool:
+        """
+        Kill a running command specified by its process ID.
+        It uses `SIGKILL` signal to kill the command.
+
+        :param pid: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `True` if the command was killed, `False` if the command was not found
+        """
+        try:
+            await self._rpc.send_signal(
+                api_pb2.SendSignalRequest(
+                    process=api_pb2.ProcessSelector(pid=pid),
+                    signal=api_pb2.Signal.SIGNAL_SIGKILL,
+                ),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            return True
+        except Exception as e:
+            if "not found" in str(e):
+                return False
+            raise handle_rpc_exception(e)
+
+    async def send_stdin(
+        self,
+        pid: int,
+        data: str,
+        request_timeout: Optional[float] = None,
+    ) -> None:
+        """
+        Send data to command stdin.
+
+        :param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
+        :param data: Data to send to the command
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        try:
+            await self._rpc.send_input(
+                api_pb2.SendInputRequest(
+                    process=api_pb2.ProcessSelector(pid=pid),
+                    input=api_pb2.ProcessInput(
+                        stdin=data.encode(),
+                    ),
+                ),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+        except Exception as e:
+            print(e)
+            raise handle_rpc_exception(e)
+
+    @overload
+    async def run(
+        self,
+        cmd: str,
+        background: Union[Literal[False], None] = None,
+        envs: Optional[Dict[str, str]] = None,
+        user: Username = "user",
+        cwd: Optional[str] = None,
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ) -> CommandResult:
+        """
+        Start a new command and wait until it finishes executing.
+
+        :param cmd: Command to execute
+        :param background: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
+        :param envs: Environment variables used for the command
+        :param user: User to run the command as
+        :param cwd: Working directory to run the command
+        :param on_stdout: Callback for command stdout output
+        :param on_stderr: Callback for command stderr output
+        :param timeout: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `CommandResult` result of the command execution
+        """
+        ...
+
+    @overload
+    async def run(
+        self,
+        cmd: str,
+        background: Literal[True],
+        envs: Optional[Dict[str, str]] = None,
+        user: Username = "user",
+        cwd: Optional[str] = None,
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ) -> AsyncCommandHandle:
+        """
+        Start a new command and return a handle to interact with it.
+
+        :param cmd: Command to execute
+        :param background: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
+        :param envs: Environment variables used for the command
+        :param user: User to run the command as
+        :param cwd: Working directory to run the command
+        :param on_stdout: Callback for command stdout output
+        :param on_stderr: Callback for command stderr output
+        :param timeout: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `AsyncCommandHandle` handle to interact with the running command
+        """
+        ...
+
+    async def run(
+        self,
+        cmd: str,
+        background: Union[bool, None] = None,
+        envs: Optional[Dict[str, str]] = None,
+        user: Username = "user",
+        cwd: Optional[str] = None,
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ):
+        proc = await self._start(
+            cmd,
+            envs,
+            user,
+            cwd,
+            timeout,
+            request_timeout,
+            on_stdout=on_stdout,
+            on_stderr=on_stderr,
+        )
+        return proc if background else await proc.wait()
+
+    async def _start(
+        self,
+        cmd: str,
+        envs: Optional[Dict[str, str]] = None,
+        user: Username = "user",
+        cwd: Optional[str] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+    ) -> AsyncCommandHandle:
+        try:
+            events = self._rpc.start(
+                api_pb2.StartRequest(
+                    process=api_pb2.ProcessConfig(
+                        cmd="/bin/bash",
+                        envs=envs,
+                        args=["-l", "-c", cmd],
+                        cwd=cwd,
+                    ),
+                ),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            start_event = await events.__anext__()
+
+            if not start_event.HasField("event"):
+                raise SandboxException(
+                    f"Failed to start process: expected start event, got {start_event}"
+                )
+
+            return AsyncCommandHandle(
+                pid=start_event.event.start.pid,
+                handle_kill=lambda: self.kill(start_event.event.start.pid),
+                events=events,
+                on_stdout=on_stdout,
+                on_stderr=on_stderr,
+            )
+        except Exception as e:
+            raise handle_rpc_exception(e)
+
+    async def connect(
+        self,
+        pid: int,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+    ) -> AsyncCommandHandle:
+        """
+        Connects to a running command.
+        You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results.
+
+        :param pid: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
+        :param request_timeout: Request timeout in **seconds**
+        :param timeout: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+        :param on_stdout: Callback for command stdout output
+        :param on_stderr: Callback for command stderr output
+
+        :return: `AsyncCommandHandle` handle to interact with the running command
+        """
+        events = self._rpc.connect(
+            api_pb2.ConnectRequest(
+                process=api_pb2.ProcessSelector(pid=pid),
+            ),
+            self._headers,
+            timeout_seconds=self._connection_config.get_request_timeout(
+                request_timeout
+            ),
+        )
+
+        try:
+            start_event = await events.__anext__()
+
+            if not start_event.HasField("event"):
+                raise SandboxException(
+                    f"Failed to connect to process: expected start event, got {start_event}"
+                )
+
+            return AsyncCommandHandle(
+                pid=start_event.event.start.pid,
+                handle_kill=lambda: self.kill(start_event.event.start.pid),
+                events=events,
+                on_stdout=on_stdout,
+                on_stderr=on_stderr,
+            )
+        except Exception as e:
+            raise handle_rpc_exception(e)

scalebox/sandbox_async/commands/command_handle.py

@@ -0,0 +1,187 @@
+import asyncio
+import inspect
+from typing import Any, AsyncIterator, Callable, Coroutine, Optional, Tuple, Union
+
+from ...generated import api_pb2
+from ...generated.rpc import handle_rpc_exception
+from ...sandbox.commands.command_handle import (
+    CommandExitException,
+    CommandResult,
+    PtyOutput,
+    Stderr,
+    Stdout,
+)
+from ...sandbox_async.utils import OutputHandler
+
+
+class AsyncCommandHandle:
+    """
+    Command execution handle.
+
+    It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
+    """
+
+    @property
+    def pid(self):
+        """
+        Command process ID.
+        """
+        return self._pid
+
+    @property
+    def stdout(self):
+        """
+        Command stdout output.
+        """
+        return self._stdout
+
+    @property
+    def stderr(self):
+        """
+        Command stderr output.
+        """
+        return self._stderr
+
+    @property
+    def error(self):
+        """
+        Command execution error message.
+        """
+        if self._result is None:
+            return None
+        return self._result.error
+
+    @property
+    def exit_code(self):
+        """
+        Command execution exit code.
+
+        `0` if the command finished successfully.
+
+        It is `None` if the command is still running.
+        """
+        if self._result is None:
+            return None
+        return self._result.exit_code
+
+    def __init__(
+        self,
+        pid: int,
+        handle_kill: Callable[[], Coroutine[Any, Any, bool]],
+        events: AsyncIterator[
+            Union[api_pb2.StartResponse, api_pb2.ConnectResponse]
+        ],
+        on_stdout: Optional[OutputHandler[Stdout]] = None,
+        on_stderr: Optional[OutputHandler[Stderr]] = None,
+        on_pty: Optional[OutputHandler[PtyOutput]] = None,
+    ):
+        self._pid = pid
+        self._handle_kill = handle_kill
+        self._events = events
+
+        self._stdout: str = ""
+        self._stderr: str = ""
+
+        self._on_stdout = on_stdout
+        self._on_stderr = on_stderr
+        self._on_pty = on_pty
+
+        self._result: Optional[CommandResult] = None
+        self._iteration_exception: Optional[Exception] = None
+
+        self._wait = asyncio.create_task(self._handle_events())
+
+    async def _iterate_events(
+        self,
+    ) -> AsyncIterator[
+        Union[
+            Tuple[Stdout, None, None],
+            Tuple[None, Stderr, None],
+            Tuple[None, None, PtyOutput],
+        ],
+    ]:
+        async for event in self._events:
+            if event.event.HasField("data"):
+                if event.event.data.stdout:
+                    out = event.event.data.stdout.decode("utf-8", "replace")
+                    self._stdout += out
+                    yield out, None, None
+                if event.event.data.stderr:
+                    out = event.event.data.stderr.decode("utf-8", "replace")
+                    self._stderr += out
+                    yield None, out, None
+                if event.event.data.pty:
+                    yield None, None, event.event.data.pty
+            if event.event.HasField("end"):
+                self._result = CommandResult(
+                    stdout=self._stdout,
+                    stderr=self._stderr,
+                    exit_code=event.event.end.exit_code,
+                    error=event.event.end.error,
+                )
+
+    async def disconnect(self) -> None:
+        """
+        Disconnects from the command.
+
+        The command is not killed, but SDK stops receiving events from the command.
+        You can reconnect to the command using `sandbox.commands.connect` method.
+        """
+        self._wait.cancel()
+        # BUG: In Python 3.8 closing async generator can throw RuntimeError.
+        # await self._events.aclose()
+
+    async def _handle_events(self):
+        try:
+            async for stdout, stderr, pty in self._iterate_events():
+                if stdout is not None and self._on_stdout:
+                    cb = self._on_stdout(stdout)
+                    if inspect.isawaitable(cb):
+                        await cb
+                elif stderr is not None and self._on_stderr:
+                    cb = self._on_stderr(stderr)
+                    if inspect.isawaitable(cb):
+                        await cb
+                elif pty is not None and self._on_pty:
+                    cb = self._on_pty(pty)
+                    if inspect.isawaitable(cb):
+                        await cb
+        except StopAsyncIteration:
+            pass
+        except Exception as e:
+            self._iteration_exception = handle_rpc_exception(e)
+
+    async def wait(self) -> CommandResult:
+        """
+        Wait for the command to finish and return the result.
+        If the command exits with a non-zero exit code, it throws a `CommandExitException`.
+
+        :return: `CommandResult` result of command execution
+        """
+        await self._wait
+        if self._iteration_exception:
+            raise self._iteration_exception
+
+        if self._result is None:
+            raise Exception("Command ended without an end event")
+
+        if self._result.exit_code != 0:
+            raise CommandExitException(
+                stdout=self._stdout,
+                stderr=self._stderr,
+                exit_code=self._result.exit_code,
+                error=self._result.error,
+            )
+
+        return self._result
+
+    async def kill(self) -> bool:
+        """
+        Kills the command.
+
+        It uses `SIGKILL` signal to kill the command
+
+        :return: `True` if the command was killed successfully, `False` if the command was not found
+        """
+        result = await self._handle_kill()
+        return result

scalebox/sandbox_async/commands/pty.py

@@ -0,0 +1,187 @@
+from typing import Dict, Optional
+
+import aiohttp
+
+from ... import csx_connect
+from ...connection_config import (
+    KEEPALIVE_PING_HEADER,
+    KEEPALIVE_PING_INTERVAL_SEC,
+    ConnectionConfig,
+    Username,
+)
+from ...exceptions import SandboxException
+from ...generated import api_pb2, api_pb2_connect
+from ...generated.rpc import authentication_header, handle_rpc_exception
+from ...sandbox.commands.command_handle import PtySize
+from ...sandbox_async.commands.command_handle import (
+    AsyncCommandHandle,
+    OutputHandler,
+    PtyOutput,
+)
+
+
+class Pty:
+    """
+    Module for interacting with PTYs (pseudo-terminals) in the sandbox.
+    """
+
+    def __init__(
+        self,
+        envd_api_url: str,
+        connection_config: ConnectionConfig,
+        pool: aiohttp.ClientSession,
+    ) -> None:
+        self._connection_config = connection_config
+        self._rpc = api_pb2_connect.AsyncProcessClient(
+            envd_api_url,
+            pool
+        )
+        self._headers = connection_config.headers
+        self._pool = pool
+
+    async def kill(
+        self,
+        pid: int,
+        request_timeout: Optional[float] = None,
+    ) -> bool:
+        """
+        Kill PTY.
+
+        :param pid: Process ID of the PTY
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: `true` if the PTY was killed, `false` if the PTY was not found
+        """
+        try:
+            await self._rpc.send_signal(
+                api_pb2.SendSignalRequest(
+                    process=api_pb2.ProcessSelector(pid=pid),
+                    signal=api_pb2.Signal.SIGNAL_SIGKILL,
+                ),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+            return True
+        except Exception as e:
+            if isinstance(e, csx_connect.ConnectException):
+                if e.status == csx_connect.Code.not_found:
+                    return False
+            raise handle_rpc_exception(e)
+
+    async def send_stdin(
+        self,
+        pid: int,
+        data: bytes,
+        request_timeout: Optional[float] = None,
+    ) -> None:
+        """
+        Send input to a PTY.
+
+        :param pid: Process ID of the PTY
+        :param data: Input data to send
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        try:
+            await self._rpc.send_input(
+                api_pb2.SendInputRequest(
+                    process=api_pb2.ProcessSelector(pid=pid),
+                    input=api_pb2.ProcessInput(
+                        pty=data,
+                    ),
+                ),
+                self._headers,
+                timeout_seconds=self._connection_config.get_request_timeout(
+                    request_timeout
+                ),
+            )
+        except Exception as e:
+            raise handle_rpc_exception(e)
+
+    async def create(
+        self,
+        size: PtySize,
+        on_data: OutputHandler[PtyOutput],
+        user: Username = "user",
+        cwd: Optional[str] = None,
+        envs: Optional[Dict[str, str]] = None,
+        timeout: Optional[float] = 60,
+        request_timeout: Optional[float] = None,
+    ) -> AsyncCommandHandle:
+        """
+        Start a new PTY (pseudo-terminal).
+
+        :param size: Size of the PTY
+        :param on_data: Callback to handle PTY data
+        :param user: User to use for the PTY
+        :param cwd: Working directory for the PTY
+        :param envs: Environment variables for the PTY
+        :param timeout: Timeout for the PTY in **seconds**
+        :param request_timeout: Timeout for the request in **seconds**
+
+        :return: Handle to interact with the PTY
+        """
+        envs = envs or {}
+        envs["TERM"] = "xterm-256color"
+        events = self._rpc.start(
+            api_pb2.StartRequest(
+                process=api_pb2.ProcessConfig(
+                    cmd="/bin/bash",
+                    envs=envs,
+                    args=["-i", "-l"],
+                    cwd=cwd,
+                ),
+                pty=api_pb2.PTY(
+                    size=api_pb2.PTY.Size(rows=size.rows, cols=size.cols)
+                ),
+            ),
+            self._headers,
+            timeout_seconds=self._connection_config.get_request_timeout(
+                request_timeout
+            ),
+        )
+
+        try:
+            start_event = await events.__anext__()
+
+            if not start_event.HasField("event"):
+                raise SandboxException(
+                    f"Failed to start process: expected start event, got {start_event}"
+                )
+
+            return AsyncCommandHandle(
+                pid=start_event.event.start.pid,
+                handle_kill=lambda: self.kill(start_event.event.start.pid),
+                events=events,
+                on_pty=on_data,
+            )
+        except Exception as e:
+            raise handle_rpc_exception(e)
+
+    async def resize(
+        self,
+        pid: int,
+        size: PtySize,
+        request_timeout: Optional[float] = None,
+    ):
+        """
+        Resize PTY.
+        Call this when the terminal window is resized and the number of columns and rows has changed.
+
+        :param pid: Process ID of the PTY
+        :param size: New size of the PTY
+        :param request_timeout: Timeout for the request in **seconds**
+        """
+        await self._rpc.update(
+            api_pb2.UpdateRequest(
+                process=api_pb2.ProcessSelector(pid=pid),
+                pty=api_pb2.PTY(
+                    size=api_pb2.PTY.Size(rows=size.rows, cols=size.cols),
+                ),
+            ),
+            self._headers,
+            timeout_seconds=self._connection_config.get_request_timeout(
+                request_timeout
+            ),
+        )