org.jboss.forge.addon.shell.test

Interface ShellTest

All Known Implementing Classes:

DefaultShellTest

public interface ShellTest

Utility for interacting with the Forge Shell in an asynchronous manner, providing methods to perform blocking writes, reads, and other test functions.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
void	clearScreen() Clear the screen and reset the buffer.
void	execute(String line) Execute the given line without waiting for it to run to completion.
org.jboss.forge.addon.ui.result.Result	execute(String line, int quantity, TimeUnit unit) Execute the given line and return the Result.
String	getBuffer() Get the Console buffer object.
org.jboss.forge.addon.shell.Shell	getShell() Get the underlying test Shell object.
String	getStdErr() Get the current contents of STDERR since the last time it was cleared.
OutputStream	getStdIn() Get the STDIN OutputStream for writing.
String	getStdOut() Get the current contents of STDOUT since the last time it was cleared.
void	sendCompletionSignal() Initiate completion by sending the appropriate signal or character sequence to the Shell.
void	waitForBufferChanged(Callable<?> task, int quantity, TimeUnit unit) Wait for the console Buffer to be updated after the given task is executed.
void	waitForBufferValue(Callable<?> task, String expected, int quantity, TimeUnit unit) Wait for the console Buffer to be updated after the given task is executed, and assert that it matches the given String.
String	waitForCompletion(int quantity, TimeUnit unit) Clear STDOUT, then send the completion signal.
String	waitForCompletion(String expected, String write, int quantity, TimeUnit unit) Clear STDOUT, then write the given string to the buffer and assert that the full buffer is equal to the expected content.
String	waitForStdErrChanged(Callable<?> callable, int quantity, TimeUnit unit) Clear STDERR, execute the given Callable task, waiting for STDERR and returning the resultant output.
void	waitForStdErrChanged(String input, int quantity, TimeUnit unit) Clear and wait for the next write to STDOUT.
void	waitForStdErrValue(Callable<Void> task, String expected, int timeout, TimeUnit unit) Clear STDERR, execute the given Callable task, waiting for STDERR to be updated, and assert that it matches the given value.
void	waitForStdErrValue(String expected, int timeout, TimeUnit unit) Wait for STDERR to write the expected value.
String	waitForStdOutChanged(Callable<?> task, int quantity, TimeUnit unit) lear and wait for the next write to STDOUT.
void	waitForStdOutChanged(String input, int quantity, TimeUnit unit) Clear and wait for the next write to STDOUT.
void	waitForStdOutValue(Callable<Void> task, String expected, int timeout, TimeUnit unit) Execute the given Callable task, waiting for STDOUT to be updated, and assert that it matches the given value.
void	waitForStdOutValue(String expected, int timeout, TimeUnit unit) Wait for STDOUT to write the expected value.
void	write(String string) Write to STDIN.

Method Detail

getBuffer

String getBuffer()

Get the Console buffer object.

getShell

org.jboss.forge.addon.shell.Shell getShell()

Get the underlying test Shell object.

execute

void execute(String line)

Execute the given line without waiting for it to run to completion.

execute

org.jboss.forge.addon.ui.result.Result execute(String line,
                                             int quantity,
                                             TimeUnit unit)
                                               throws TimeoutException

Execute the given line and return the Result. Fail if not complete within the given quantity of TimeUnit. (Appends the newline character to the given input if necessary, and calls OutputStream.flush() on getStdIn()).

Throws:

TimeoutException - if the given command was not executed successfully within the allotted timeout.

waitForBufferChanged

void waitForBufferChanged(Callable<?> task,
                        int quantity,
                        TimeUnit unit)
                          throws TimeoutException

Wait for the console Buffer to be updated after the given task is executed.

Throws:

TimeoutException - if the timeout is reached without detecting a buffer value change.

waitForBufferValue

void waitForBufferValue(Callable<?> task,
                      String expected,
                      int quantity,
                      TimeUnit unit)
                        throws TimeoutException

Wait for the console Buffer to be updated after the given task is executed, and assert that it matches the given String.

Throws:

TimeoutException - if the timeout is reached without detecting the appropriate value.

waitForStdOutChanged

void waitForStdOutChanged(String input,
                        int quantity,
                        TimeUnit unit)
                          throws TimeoutException

Clear and wait for the next write to STDOUT. Send the provided line to STDIN.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDOUT.

waitForStdOutChanged

String waitForStdOutChanged(Callable<?> task,
                          int quantity,
                          TimeUnit unit)
                            throws TimeoutException

lear and wait for the next write to STDOUT. Execute the given Callable task, waiting for STDOUT and returning the resultant output.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDOUT.

waitForStdOutValue

void waitForStdOutValue(Callable<Void> task,
                      String expected,
                      int timeout,
                      TimeUnit unit)
                        throws TimeoutException

Execute the given Callable task, waiting for STDOUT to be updated, and assert that it matches the given value.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDOUT.

waitForStdErrChanged

void waitForStdErrChanged(String input,
                        int quantity,
                        TimeUnit unit)
                          throws TimeoutException

Clear and wait for the next write to STDOUT. Send the provided line to STDIN. Fail if no write occurs within the given quantity of TimeUnit

Throws:

TimeoutException - if the timeout is reached without detecting a write to STDERR.

waitForStdOutValue

void waitForStdOutValue(String expected,
                      int timeout,
                      TimeUnit unit)
                        throws TimeoutException

Wait for STDOUT to write the expected value. Does not clear STDOUT before waiting.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDOUT.

waitForStdErrValue

void waitForStdErrValue(String expected,
                      int timeout,
                      TimeUnit unit)
                        throws TimeoutException

Wait for STDERR to write the expected value. Does not clear STDERR before waiting.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDERR.

waitForStdErrChanged

String waitForStdErrChanged(Callable<?> callable,
                          int quantity,
                          TimeUnit unit)
                            throws TimeoutException

Clear STDERR, execute the given Callable task, waiting for STDERR and returning the resultant output.

Throws:

TimeoutException - if the timeout is reached without detecting a write to STDERR.

waitForStdErrValue

void waitForStdErrValue(Callable<Void> task,
                      String expected,
                      int timeout,
                      TimeUnit unit)
                        throws TimeoutException

Clear STDERR, execute the given Callable task, waiting for STDERR to be updated, and assert that it matches the given value.

Throws:

TimeoutException - if the timeout is reached without detecting the expected write to STDERR.

getStdIn

OutputStream getStdIn()

Get the STDIN OutputStream for writing.

getStdOut

String getStdOut()

Get the current contents of STDOUT since the last time it was cleared.

getStdErr

String getStdErr()

Get the current contents of STDERR since the last time it was cleared.

write

void write(String string)
           throws IOException

Write to STDIN. (Does not call OutputStream.flush() on getStdIn().)

Throws:

IOException

sendCompletionSignal

void sendCompletionSignal()
                          throws IOException

Initiate completion by sending the appropriate signal or character sequence to the Shell.

Throws:

IOException

clearScreen

void clearScreen()
                 throws IOException

Clear the screen and reset the buffer.

Throws:

IOException

waitForCompletion

String waitForCompletion(String expected,
                       String write,
                       int quantity,
                       TimeUnit unit)
                         throws TimeoutException

Clear STDOUT, then write the given string to the buffer and assert that the full buffer is equal to the expected content. Return the contents of STDOUT since the given text was written.

Throws:

TimeoutException - if the buffer did not match STDOUT within the given timeout.

waitForCompletion

String waitForCompletion(int quantity,
                       TimeUnit unit)
                         throws TimeoutException

Clear STDOUT, then send the completion signal. Return the contents of STDOUT once completion has finished and the buffer is re-written to STDOUT.

Throws:

TimeoutException - if the buffer did not match STDOUT within the given timeout.