Module com.renomad.minum

Package com.renomad.minum.web

Class FunctionalTesting

java.lang.Object

com.renomad.minum.web.FunctionalTesting

public final class FunctionalTesting
extends Object

Tools to enable system-wide integration testing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FunctionalTesting.TestResponse	A Response designed to work with FunctionalTesting

Constructor Summary

Constructors

Constructor	Description
FunctionalTesting(Context context, String host, int port)	Allows the user to set the host and port to target for testing.

Method Summary

Modifier and Type	Method	Description
FunctionalTesting.TestResponse	get(String path)	Send a GET request (as a client to the server)
FunctionalTesting.TestResponse	get(String path, List<String> extraHeaders)	Send a GET request (as a client to the server)
FunctionalTesting.TestResponse	innerClientSend(ISocketWrapper client, RequestLine.Method method, String path, byte[] payload, List<String> extraHeaders)
FunctionalTesting.TestResponse	post(String path, String payload)	Send a POST request (as a client to the server) using url encoding
FunctionalTesting.TestResponse	post(String path, String payload, List<String> extraHeaders)	Send a POST request (as a client to the server) using url encoding
FunctionalTesting.TestResponse	send(RequestLine.Method method, String path)	Send a request as a client to the server
FunctionalTesting.TestResponse	send(RequestLine.Method method, String path, byte[] payload, List<String> extraHeaders)	Send a request as a client to the server

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionalTesting

public FunctionalTesting(Context context,
 String host,
 int port)

Allows the user to set the host and port to target for testing.

Method Details

get

public FunctionalTesting.TestResponse get(String path)

Send a GET request (as a client to the server)

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

get

public FunctionalTesting.TestResponse get(String path,
 List<String> extraHeaders)

Send a GET request (as a client to the server)

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

extraHeaders - a list containing extra headers you need the client to send, for example,

List.of("cookie: id=foo")

post

public FunctionalTesting.TestResponse post(String path,
 String payload)

Send a POST request (as a client to the server) using url encoding

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

payload - a body payload in string form

post

public FunctionalTesting.TestResponse post(String path,
 String payload,
 List<String> extraHeaders)

Send a POST request (as a client to the server) using url encoding

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

payload - a body payload in string form

extraHeaders - a list containing extra headers you need the client to send, for example,

List.of("cookie: id=foo")

send

public FunctionalTesting.TestResponse send(RequestLine.Method method,
 String path)

Send a request as a client to the server

This helper method is the same as send(RequestLine.Method, String, byte[], List) except it will set the body as empty and does not require any extra headers to be set. In this case, the headers sent are very minimal. See the source.

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

send

public FunctionalTesting.TestResponse send(RequestLine.Method method,
 String path,
 byte[] payload,
 List<String> extraHeaders)

Send a request as a client to the server

Parameters:

path - the path to an endpoint, that is, the value for path that is entered in WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction) for pathname

payload - a body payload in byte array form

extraHeaders - a list containing extra headers you need the client to send, for example,

List.of("cookie: id=foo")

Returns:

a properly-built client, or null if exceptions occur

innerClientSend

public FunctionalTesting.TestResponse innerClientSend(ISocketWrapper client,
 RequestLine.Method method,
 String path,
 byte[] payload,
 List<String> extraHeaders)
                                               throws IOException

Throws:

IOException