com.github.gun88:fitnesse-ssh-fixture

fitnesse-ssh-fixture

FitNesse fixture for SSH and SFTP connections -

Table of Contents

• Quick Start
• Documentation
• Installation
• Running
• Build
• Releases

Quick Start

• Download release file: fitnesse-ssh-fixture-1.0.1.jar
• Put fitnesse-ssh-fixture-1.0.1.jar in the plugins directory (or add it to the classpath)
• Run FitNesse and navigate PlugIns suite to get fitnesse-ssh-fixture UserGuide and Examples

Note: As shown in QuickStart documentation session, the plugin mode installation can be executed just placing the fitnesse-ssh-fixture.jar in the FitNesse plugin directory or by making the jar file available in the FitNesse web server classpath. When the archive is available in classpath, documentation files and dependency libraries are automatically extracted and tuned. To know more about other installation methods, go to Installation documentation page

Documentation

Documentation is automatically extracted in plugin mode or via auto-extraction tool. Is also available online here.

Check documentation to know more about:

• Installation
• SshTestCreation
• EndpointDefinition
• Options
• Customization

Installation

SshFixture can be installed as a plugin or just provided during test executions. The suggested installation mode is the plugin mode. More details on installation modes are available here

Running

Once installed in your FitNesse distribution, start creating your first test. Tests can be developed in decision table and script table mode as shown in test creation documentation page. The following is a simple test example in table mode.

|import                               |
|com.github.gun88.fitnesse.fixture.ssh|

|ssh client                       |foo/[e-mail] |
|command                          |output?|error? |exitCode?|
|echo foo-bar                     |foo-bar|       |0        |
|echo foo-bar 1>&2                |       |foo-bar|0        |
|exit 123                         |       |       |123      |
|echo foo; echo bar 1>&2; exit 234|foo    |bar    |234      |

!define TEST_SYSTEM {slim}
!path ${jsch.jar.path}
!path ${sshFixture.jar.path}

Note: the ssh-fitnesse.dev host is a virtual hosts embedded with fitnesse-ssh-fixture-x.y.z.jar and emulating a ssh server. If you want to make real calls, replace it with an actual ssh server hostname

Note: if SshFixture is not installed as a plugin, remember to set or replace properties: jsch.jar.path, sshFixture.jar.path; with actual paths

Note: In this example the connection was built via username and password, that are set in plain text in table header. Click here to view different authentication and credential storing methods

Build

The fitnesse-ssh-fixture build can be executed via Maven.

Produced build will be a jar named fitnesse-ssh-fixture-x.y.z.jar, available under target directory.

Note: build version number instead of x.y.z

Execute mvn clean package (or mvn clean verify to execute integration tests or mvn clean install to make fitnesse-ssh-fixture-x.y.z.jar available in your local repository)

Releases

v1.0.1 (fitnesse-ssh-fixture)

• fitnesse-ssh-fixture-1.0.1.jar

v1.0.0 (fitnesse-ssh-fixture)

• fitnesse-ssh-fixture-1.0.0.jar