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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file robotframework_sshtunnellibrary-1.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for robotframework_sshtunnellibrary-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 6277824f13b0f27a31fe96fdfedbcadc5eca7d0f2515c8b6a029a9c065de0d4c
MD5 88193f43ce7b5cd7fea3ccc54d9035ea
BLAKE2b-256 20de78dd4d852b65f266316d38ea2a99fa9e07c8654073e9eeeb37541f1c267a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page