Package org.springframework.shell.test

Class ShellTestClient

java.lang.Object

org.springframework.shell.test.ShellTestClient

public class ShellTestClient
extends Object

Client for shell session which can be used as a programmatic way to interact with a shell application. In a typical test, it is required to send a command to the shell as if a user typed it and then verify the shell output.

Author:

Janne Valkealahti, Mahmoud Ben Hassine

Constructor Summary

Constructors

Constructor	Description
ShellTestClient(CommandParser commandParser, CommandRegistry commandRegistry)	Create a ShellTestClient using the given CommandParser and CommandRegistry.

Method Summary

Modifier and Type	Method	Description
ShellScreen	sendCommand(String input)	Execute a command and write its result to the shell screen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShellTestClient

public ShellTestClient(CommandParser commandParser,
 CommandRegistry commandRegistry)

Create a ShellTestClient using the given CommandParser and CommandRegistry.

Parameters:

commandParser - the command parser

commandRegistry - the command registry

Method Details

sendCommand

public ShellScreen sendCommand(String input)
                        throws Exception

Execute a command and write its result to the shell screen.

Parameters:

input - the raw input command

Returns:

the shell screen after command execution

Throws:

Exception - if an error occurred during command execution