com.sap.cloud.security.test

Class SecurityTestRule

java.lang.Object

org.junit.rules.ExternalResource

com.sap.cloud.security.test.SecurityTestRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class SecurityTestRule
extends org.junit.rules.ExternalResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_APP_ID
static String	DEFAULT_CLIENT_ID
static String	DEFAULT_DOMAIN

Method Summary

Modifier and Type	Method and Description
SecurityTestRule	addApplicationServlet(Class<? extends javax.servlet.Servlet> servletClass, String path) Adds a servlet to the servlet server.
SecurityTestRule	addApplicationServlet(org.eclipse.jetty.servlet.ServletHolder servletHolder, String path) Adds a servlet to the servlet server.
SecurityTestRule	addApplicationServletFilter(Class<? extends javax.servlet.Filter> filterClass) Adds a filter to the servlet server.
protected void	after()
protected void	before()
Token	createToken() Creates a very basic token on base of the preconfigured Jwt token generator.
String	getApplicationServerUri() Returns the URI of the embedded jetty server or null if not specified.
static SecurityTestRule	getInstance(Service service) Creates an instance of the test rule for the given service.
JwtGenerator	getPreconfiguredJwtGenerator() Note: the JwtGenerator is fully configured as part of before() method.
com.github.tomakehurst.wiremock.junit.WireMockRule	getWireMockRule() Deprecated. use getWireMockServer() method instead. Note that WireMockServer is the base class of WireMockRule.
com.github.tomakehurst.wiremock.WireMockServer	getWireMockServer() Allows to stub further endpoints of the identity service.
SecurityTestRule	setKeys(String publicKeyPath, String privateKeyPath) Overwrites the private/public key pair to be used.
SecurityTestRule	setPort(int port) Overwrites the port on which the identity service mock server runs (WireMock).
SecurityTestRule	useApplicationServer() Specifies an embedded jetty as servlet server.
SecurityTestRule	useApplicationServer(ApplicationServerOptions applicationServerOptions) Specifies an embedded jetty as servlet server.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APP_ID

public static final String DEFAULT_APP_ID

See Also:

Constant Field Values

DEFAULT_CLIENT_ID

public static final String DEFAULT_CLIENT_ID

See Also:

Constant Field Values

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

See Also:

Constant Field Values

Method Detail

getInstance

public static SecurityTestRule getInstance(Service service)

Creates an instance of the test rule for the given service.

Parameters:

service - the service for which the test rule should be created.

Returns:

the test rule instance.

useApplicationServer

public SecurityTestRule useApplicationServer()

Specifies an embedded jetty as servlet server. It needs to be configured before the before() method. The application server will be started with default options for the given Service, see ApplicationServerOptions.forService(Service) for details. By default the servlet server will listen on a free random port. Use useApplicationServer(ApplicationServerOptions) to overwrite default settings. Use getApplicationServerUri() to obtain the actual port used at runtime.

Returns:

the rule itself.

useApplicationServer

public SecurityTestRule useApplicationServer(ApplicationServerOptions applicationServerOptions)

Specifies an embedded jetty as servlet server. It needs to be configured before the before() method. Use ApplicationServerOptions.forService(Service) to obtain a configuration object that can be customized. See ApplicationServerOptions for details.

Parameters:

applicationServerOptions - custom options to configure the application server.

Returns:

the rule itself.

addApplicationServlet

public SecurityTestRule addApplicationServlet(Class<? extends javax.servlet.Servlet> servletClass,
                                              String path)

Adds a servlet to the servlet server. Only has an effect when used in conjunction with useApplicationServer().

Parameters:

servletClass - the servlet class that should be served.

path - the path on which the servlet should be served, e.g. "/*".

Returns:

the rule itself.

addApplicationServlet

public SecurityTestRule addApplicationServlet(org.eclipse.jetty.servlet.ServletHolder servletHolder,
                                              String path)

Adds a servlet to the servlet server. Only has an effect when used in conjunction with useApplicationServer().

Parameters:

servletHolder - the servlet inside a ServletHolder that should be served.

path - the path on which the servlet should be served, e.g. "/*".

Returns:

the rule itself.

addApplicationServletFilter

public SecurityTestRule addApplicationServletFilter(Class<? extends javax.servlet.Filter> filterClass)

Adds a filter to the servlet server. Only has an effect when used in conjunction with useApplicationServer().

Parameters:

filterClass - the filter class that should intercept with incoming requests.

Returns:

the rule itself.

setPort

public SecurityTestRule setPort(int port)

Overwrites the port on which the identity service mock server runs (WireMock). It needs to be configured before the before() method. If the port is not specified or is set to 0, a free random port is chosen.

Parameters:

port - the port on which the wire mock service is started.

Returns:

the rule itself.

setKeys

public SecurityTestRule setKeys(String publicKeyPath,
                                String privateKeyPath)

Overwrites the private/public key pair to be used. The private key is used to sign the jwt token. The public key is provided by jwks endpoint (on behalf of WireMock). Checked exceptions are caught and rethrown as runtime exceptions for test convenience.

Parameters:

publicKeyPath - resource path to public key file.

privateKeyPath - resource path to private key file.

Returns:

the rule itself.

before

protected void before()
               throws Exception

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Exception

getPreconfiguredJwtGenerator

public JwtGenerator getPreconfiguredJwtGenerator()

Note: the JwtGenerator is fully configured as part of before() method.

Returns:

the preconfigured Jwt token generator

createToken

public Token createToken()

Creates a very basic token on base of the preconfigured Jwt token generator. In case you like to specify further token claims, you can make use of getPreconfiguredJwtGenerator()

Returns:

the token.

getWireMockRule

@Nullable
 @Deprecated
public com.github.tomakehurst.wiremock.junit.WireMockRule getWireMockRule()

Deprecated. use getWireMockServer() method instead. Note that WireMockServer is the base class of WireMockRule.

getWireMockServer

@Nullable
public com.github.tomakehurst.wiremock.WireMockServer getWireMockServer()

Allows to stub further endpoints of the identity service. Returns null if the rule is not yet initialized as part of before() method. You can find a detailed explanation on how to configure wire mock here: http://wiremock.org/docs/getting-started/

Returns:

an instance of WireMockRule or null.

getApplicationServerUri

@Nullable
public String getApplicationServerUri()

Returns the URI of the embedded jetty server or null if not specified.

Returns:

uri of the application server

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource