Skip to content

Secure Copy Protocol (SCP)

This example showcases the transferring of a file to a remote server by using the SCP and SSH exec wrapper.

It consists of two files:

conftest.py - Implements a fixture that returns a RemoteInterface() interface.

test_scp.py - Contains a test that sends a file to a remote server by using the SCP wrapper.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
import pytest

from hil_sdk.interfaces.remote_interface import RemoteInterface


@pytest.fixture
def remote_interface_fixture():
    # Replace HOSTNAME and USERNAME with the remote server that you want to connect to.
    # If password is required, pass a password string to the RemoteInterface()
    # e.g. RemoteInterface("HOSTNAME", "USERNAME", "PASSWORD")
    return RemoteInterface("HOSTNAME", "USERNAME")

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import os

def test_scp(remote_interface_fixture):

    # Replace REMOTE_PATH with the location on the remote server where you want the file to be sent to.
    remote_path = "REMOTE_PATH"
    file_to_send = "test_scp.txt"
    expected_file_location = os.path.join(remote_path, file_to_send)

    print(f"Verifying that {file_to_send} was not on the remote device...")
    assert remote_interface_fixture.ssh_exec(f"cat {expected_file_location}") == f"cat: {expected_file_location}: No such file or directory\r\n"
    print(f"{file_to_send} does not exist")

    script_dir = os.path.dirname(os.path.abspath(__file__))
    file_to_send_path = os.path.join(script_dir, file_to_send)
    remote_interface_fixture.scp_send(file_to_send_path, remote_path)

    print(f"Verifying that {file_to_send} was transferred successfully...")
    assert remote_interface_fixture.ssh_exec(f"cat {expected_file_location}") == "It works!!\r\n"
    print(f"{file_to_send} was transferred successfully")

    print(f"Removing {file_to_send} for the next test...")
    remote_interface_fixture.ssh_exec(f"rm {expected_file_location}")