Skip to main content

Robot Framework

The Robot wrapper lives at sdk/python/cmdra_client/robot_library.py and exposes the Python SDK as Robot keywords.

Install the Robot extra​

.venv/bin/pip install -e './sdk/python[robot]'

Import the library​

*** Settings ***
Library    cmdra_client.robot_library.CmdraLibrary    ${ADDRESS}    ${CA_CERT}    ${CLIENT_CERT}    ${CLIENT_KEY}

Available keyword families​

The library exposes the same high-level operations as the Python SDK, including:

  • Start Argv
  • Start Argv Async
  • Start Shell Command
  • Start Shell Command Async
  • Start Shell Command With PTY
  • Start Shell Command Async With PTY
  • Start Shell Session
  • Start Shell Session Async
  • Start Shell Session With PTY
  • Start Shell Session Async With PTY
  • Get Execution
  • List Executions
  • Delete Execution
  • Clear History
  • Get Execution With Output
  • Cancel Execution
  • Read Output
  • Write Stdin
  • Upload File
  • Upload File Async
  • Download File
  • Download File Async
  • Download Archive
  • Download Archive Async

History management keywords​

The Robot wrapper includes explicit history-management keywords:

  • Delete Execution
  • Clear History

Example usage:

*** Test Cases ***
Delete One Finished Execution
    ${execution}=    Start Argv    /bin/echo    hello
    ${execution_id}=    Set Variable    ${execution.execution_id}
    ${deleted_id}=    Delete Execution    ${execution_id}
    Should Be Equal    ${deleted_id}    ${execution_id}

Clear Finished History
    ${result}=    Clear History
    Log    deleted=${result.deleted_count} skipped_running=${result.skipped_running_count}

Delete Execution removes one finished execution or transfer from persisted history. Clear History removes finished history for the authenticated client identity and leaves running items in place.

PTY-oriented shell keywords​

The Robot wrapper also exposes PTY-specific shell keywords:

  • Start Shell Command With PTY
  • Start Shell Command Async With PTY
  • Start Shell Session With PTY
  • Start Shell Session Async With PTY

Use those when you want terminal-style shell behavior on Unix-like platforms or on Windows through ConPTY.

Non-interactive stdin keyword​

The Robot wrapper also exposes Write Stdin for pushing input into a running shell command or shell session without holding an attach stream open.

Example usage:

*** Test Cases ***
Feed A Running Shell Command
    ${execution}=    Start Shell Command    read line; printf '%s\n' "$line"    shell_binary=/bin/sh
    ${stdin_line}=    Catenate    SEPARATOR=    robot-write-stdin    ${\n}
    Write Stdin    ${execution.execution_id}    ${stdin_line}    eof=${True}
    Sleep    0.2s
    ${details}=    Get Execution With Output    ${execution.execution_id}
    ${contains}=    Evaluate    any(b"robot-write-stdin" in chunk.data for chunk in $details.output if not chunk.eof)
    Should Be True    ${contains}

Run the smoke suite​

From the repository root:

export PYTHONPATH="$PWD/sdk/python"
.venv/bin/robot \
  --variable ADDRESS:127.0.0.1:8443 \
  --variable CA_CERT:dev/certs/ca.crt \
  --variable CLIENT_CERT:dev/certs/client-a.crt \
  --variable CLIENT_KEY:dev/certs/client-a.key \
  sdk/python/examples/robot_smoke.robot

Run the CI-oriented suite:

export PYTHONPATH="$PWD/sdk/python"
.venv/bin/robot \
  --variable ADDRESS:127.0.0.1:8443 \
  --variable CA_CERT:dev/certs/ca.crt \
  --variable CLIENT_CERT:dev/certs/client-a.crt \
  --variable CLIENT_KEY:dev/certs/client-a.key \
  sdk/python/examples/robot_ci.robot