In this section:
Introduction
The SFTP Client tool runs a single SFTP session of up to ten commands using public key authentication. Any standard SFTP commands can be used, check the documentation for your server to see which commands are available. Raw SFTP traffic is supplied as an output to the tool. Any failures during tool execution are reported as Quality Tasks. If failures occur, server connections are closed, and tool execution terminates. The tool is a standard implementation of SFTP V3.
Installation
This tool can be installed from the UI or the command line.
UI Installation
- Go to Parasoft > Preferences and click System Properties.
- Click Add JARs and choose the sftpclient.jar file.
- Click Apply.
- Restart SOAtest/Virtualize.
Command Line Installation
Add the sftpclient.jar file to the system.properties.classpath property in your settings properties file. For example:
system.properties.classpath=<PATH_TO_JAR>/sftpclient.jar
Usage
The SFTP Client can be added as a standalone tool via the Add Test wizard or chained to the output of another tool via the Add Output wizard.
Configuration
You can configure the following settings.
Commands Settings
| Home Directory | Defines the user's local home directory. This directory is not the same as the user's remote home directory, which is configured on the server side. If empty, the system's current user's home directory will be used. |
|---|---|
| Command #1 - #10 | Specifies the series of SFTP commands to be performed during the SFTP session. The commands will be executed in the order in which they are listed here. They should be entered exactly as if they were being performed in an interactive SFTP console. At least one of these fields must be defined. |
Connection Settings
| Host | Defines the hostname or IP address of the server. The default is localhost. |
|---|---|
| Port | Defines the port for connecting to the server. The default is |
| User Name | Defines the username for connecting to the server. If empty, the tool will remain disabled. |
| Key Store File | Defines the absolute path to the user’s private key file, which should be in PEM format. If empty, the tool will remain disabled. |
| Known Hosts File | Defines the absolute path to a known hosts file, which should be formatted as a standard OpenSSH known hosts file. If a known hosts file is defined, then strict host key checking will be enabled. If the host key is not found in the known hosts file, the connection to the server will be closed. If empty, strict host key checking will remain disabled. |
| Timeout | Defines how many seconds to wait to connect to the SSH server (as well as the underlying SFTP channel) before timing out and closing all connections. The default is 30 seconds. |
Third-party Content
This plug-in includes items that have been sourced from third parties as outlined below.
- JCraft (JCraft License)
Additional license details are available in this plugin's licenses folder.
