Skip to main content

SSH Tunnel Library for Robot framework

Project description

# robotframework-sshtunnellibrary

SSHTunnelLibrary is a Robotframework library to support SSHTunnels. It will help to connect to remote host using SSH Local Forwarding.

## Usage
Install robotframework-sshtunnellibrary and its dependencies via pip

```
pip install -U sshtunnel
pip install -U robotframework-sshtunnellibrary
```

## Example

SSH Tunnel Library can be used with libraries like SSHLibrary, RequestLibrary, DatabaseLibrary, SeleniumLibrary to make connection to ssh, rest api, database connection, web application respectively.

Here is an example to make SSH connection using request library via SSH Server.

``` robotframework
*** Settings ***
Library SSHTunnelLibrary
Library SSHLibrary

*** Variables ***
${REMOTE_HOST}= <Remote_IP/Name>
${REMOTE_PORT}= 22
${SSH_SERVER}= <SSH_Server_IP/Name>
${SSH_SERVER_PORT}= 22
${SSH_SERVER_USERNAME}= <SSH_Server_Username>
${SSH_SERVER_PASSWORD}= <SSH_Server_Password>
${LOCAL_HOST}= localhost
${LOCAL_PORT}= 0

${REMOTE_USERNAME}= <Remote_host_Username>
${REMOTE_PASSWORD}= <Remote_host_Password>

*** Test Cases ***
SSH Connection using SSH Tunnel
# Create Tunnel
Start SSH Tunnel MySshTunnel ${REMOTE_HOST} ${REMOTE_PORT} ${SSH_SERVER} ${SSH_SERVER_PORT} ${SSH_SERVER_USERNAME} ${SSH_SERVER_PASSWORD} ${LOCAL_HOST} ${LOCAL_PORT}
${LOCAL_BIND_PORT}= Get Local Port

# Connection using local bind
Open Connection ${LOCAL_HOST} port=${LOCAL_BIND_PORT}
Login ${REMOTE_USERNAME} ${REMOTE_PASSWORD}

# Closing the Tunnel
Stop SSH Tunnel MySshTunnel
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for robotframework-sshtunnellibrary, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size robotframework_sshtunnellibrary-1.0.0-py2-none-any.whl (4.2 kB) File type Wheel Python version py2 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page