org.springframework.cloud.stream.test.junit

Class AbstractExternalResourceTestSupport<R>

java.lang.Object

org.springframework.cloud.stream.test.junit.AbstractExternalResourceTestSupport<R>

Type Parameters:

R - resource type

All Implemented Interfaces:

org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

public abstract class AbstractExternalResourceTestSupport<R>
extends Object
implements org.junit.jupiter.api.extension.BeforeEachCallback

Abstract base class for JUnit Rules that detect the presence of some external resource. If the resource is indeed present, it will be available during the test lifecycle through getResource(). If it is not, tests will either fail or be skipped, depending on the value of system property "SCS_EXTERNAL_SERVERS_REQUIRED".

Author:

Eric Bottard, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger
protected R	resource
static String	SCS_EXTERNAL_SERVERS_REQUIRED SCS external servers required environment variable.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalResourceTestSupport(String resourceDescription)

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
protected abstract void	cleanupResource() Perform cleanup of the resource field, which is guaranteed to be non null.
R	getResource()
protected abstract void	obtainResource() Try to obtain and validate a resource.

Methods inherited from class java.lang.Object

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

Field Detail

SCS_EXTERNAL_SERVERS_REQUIRED

public static final String SCS_EXTERNAL_SERVERS_REQUIRED

SCS external servers required environment variable.

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

resource

protected R resource

Constructor Detail

AbstractExternalResourceTestSupport

protected AbstractExternalResourceTestSupport(String resourceDescription)

Method Detail

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

getResource

public R getResource()

cleanupResource

protected abstract void cleanupResource()
                                 throws Exception

Perform cleanup of the resource field, which is guaranteed to be non null.

Throws:

Exception - any exception thrown by this method will be logged and swallowed

obtainResource

protected abstract void obtainResource()
                                throws Exception

Try to obtain and validate a resource. Implementors should either set the resource field with a valid resource and return normally, or throw an exception.

Throws:

Exception - when resource couldn't be obtained