Robot Framework RADKit Library

A Robot Framework library for interacting with Cisco RADKit-connected devices, providing keywords for authentication, device inventory, parallel command execution, port forwarding, and Genie-based structured parsing.

Installation

RADKit client packages are hosted on a Cisco-internal PyPI index. Configure pip accordingly:

pip install --extra-index-url https://radkit.cisco.com/pip robotframework-radkit

For Genie parsing support (optional):

pip install --extra-index-url https://radkit.cisco.com/pip robotframework-radkit[genie]

Prerequisites

• Python 3.10+
• A RADKit identity with enrolled certificates (see RADKit documentation)
• Access to a RADKit service (remote service instance)

Quick Start

*** Settings ***
Library    RADKitLibrary

*** Variables ***
${SERVICE_SN}    abcd-1234-efgh

*** Test Cases ***
Query Device Inventory
    # identity can also be set via RADKIT_IDENTITY env var
    RADKit Certificate Login    identity=user@cisco.com
    RADKit Select Service    ${SERVICE_SN}
    @{devices}=    RADKit Device Inventory
    Log Many    @{devices}

Execute Show Version
    RADKit Certificate Login    identity=user@cisco.com
    RADKit Select Service    ${SERVICE_SN}
    ${result}=    RADKit Execute    show version    devices=router1
    Log    ${result}[router1]

Keywords

Connection Management

Device Management

Command Execution

Port Forwarding

Genie Parsing (optional, requires robotframework-radkit[genie])

Authentication

The library uses certificate-based authentication. Credentials can be provided as keyword arguments or through environment variables:

Optional pyATS Integration

When pyats.robot.pyATSRobot is loaded in the test suite, the RADKit Port Forward to Device keyword can optionally update testbed device connection entries via the testbed_device and testbed_conn parameters. This feature is automatically available when pyATS is installed; no additional configuration is needed.

*** Settings ***
Library    pyats.robot.pyATSRobot
Library    RADKitLibrary

*** Test Cases ***
Port Forward With Testbed Update
    RADKit Certificate Login    identity=user@cisco.com
    RADKit Select Service    ${SERVICE_SN}
    RADKit Port Forward to Device    linuxdevice    local_port=0
    ...    destination_port=22    testbed_device=linux_server    testbed_conn=cli
    connect to device "linux_server" via "cli"

Usage Examples

Execute Commands on Multiple Devices

RADKit Select Service    ${SERVICE_SN}
@{devices}=    Create List    router1    router2    router3
${result}=    RADKit Execute    show version    devices=${devices}
# Access output: ${result}[router1], ${result}[router2], etc.

Execute Multiple Commands

@{commands}=    Create List    show version    show clock
${result}=    RADKit Execute    ${commands}    devices=router1;router2
# Access: ${result}[router1][show version], ${result}[router1][show clock], etc.

Use Inventory Filters

${inventory}=    RADKit Device Inventory    raw=True
${subset}=    Evaluate    $inventory.filter("name", "PE*").filter("device_type", "IOSXE")
${result}=    RADKit Execute    show version    devices=${subset}

Parse Output with Genie

@{devices}=    Create List    router1    router2
RADKit Genie Fingerprint    ${devices}
${parsed}=    RADKit Genie Parse    commands=show version    devices=${devices}
# Access parsed data: ${parsed}[router1][show version][version]

Development

Setup Development Environment

git clone https://github.com/Cisco-RADKit/robotframework-radkit.git
cd robotframework-radkit

# Install in development mode (includes genie dependencies)
uv sync --extra dev --extra genie

# Install pre-commit hooks
pre-commit install

Running Tests

# Run all tests
pytest tests/

# Run unit tests only
pytest tests/unit/test_unit_*.py

# Run with coverage
pytest --cov=RADKitLibrary tests/

# Run linters
ruff check .
mypy .
bandit -r RADKitLibrary/

Code Quality

This project uses:

• ruff for linting and formatting
• mypy for type checking
• bandit for security analysis
• pytest for testing
• pre-commit for git hooks

Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Run the test suite
5. Submit a pull request

Resources

• RADKit Website
• RADKit Documentation
• Robot Framework Documentation

License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.

Authors

• Oliver Boehmer (@oboehmer)