Package org.springframework.shell.test

Interface ShellTestClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ShellTestClient.DefaultShellClient

public interface ShellTestClient
extends Closeable

Client for terminal session which can be used as a programmatic way to interact with a shell application. In a typical test it is required to write into a shell and read what is visible in a shell.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ShellTestClient.BaseShellSession<T extends ShellTestClient.BaseShellSession<T>>
static interface	ShellTestClient.Builder	Builder interface for ShellClient.
static class	ShellTestClient.DefaultBuilder
static class	ShellTestClient.DefaultInteractiveShellSession
static class	ShellTestClient.DefaultNonInteractiveShellSession
static class	ShellTestClient.DefaultShellClient
static interface	ShellTestClient.InteractiveShellSession
static interface	ShellTestClient.NonInteractiveShellSession
static class	ShellTestClient.ShellRunnerTask
static final record	ShellTestClient.ShellRunnerTaskData

Method Summary

Modifier and Type	Method	Description
static ShellTestClient.Builder	builder(TerminalSession terminalSession, Shell shell, PromptProvider promptProvider, org.jline.reader.LineReader lineReader, org.jline.terminal.Terminal terminal)	Get an instance of a builder.
ShellTestClient.InteractiveShellSession	interactive()	Run interactive shell session.
ShellTestClient.NonInteractiveShellSession	nonInteractive(String... args)	Run non-interactive command session.
ShellTestClient.NonInteractiveShellSession	nonInterative(String... args)	Deprecated. since 3.4.2 in favor of nonInteractive(String...)
ShellScreen	screen()	Read the screen.

Methods inherited from interface java.io.Closeable

close

Method Details

interactive

ShellTestClient.InteractiveShellSession interactive()

Run interactive shell session.

Returns:

session for chaining

nonInterative

@Deprecated(since="3.4.2")
ShellTestClient.NonInteractiveShellSession nonInterative(String... args)

Deprecated.

since 3.4.2 in favor of nonInteractive(String...)

Run non-interactive command session.

Parameters:

args - the command arguments

Returns:

session for chaining

nonInteractive

ShellTestClient.NonInteractiveShellSession nonInteractive(String... args)

Run non-interactive command session.

Parameters:

args - the command arguments

Returns:

session for chaining

Since:

3.4.2

screen

ShellScreen screen()

Read the screen.

Returns:

the screen

builder

static ShellTestClient.Builder builder(TerminalSession terminalSession,
 Shell shell,
 PromptProvider promptProvider,
 org.jline.reader.LineReader lineReader,
 org.jline.terminal.Terminal terminal)

Get an instance of a builder.

Parameters:

terminalSession - the terminal session

shell - the shell

promptProvider - the prompt provider

lineReader - the line reader

terminal - the terminal

Returns:

a Builder