com.goldencode.p2j.testengine

Class UnitTestServer

java.lang.Object

com.goldencode.p2j.testengine.UnitTestServer

public class UnitTestServer
extends java.lang.Object

FWD unit testing engine remote operation server-side implementation. This class contains static methods matching the UnitTestEngine interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	UnitTestServer.WorkArea Context local work area.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<UnitTestServer.WorkArea>	context Context local work area.
private static java.util.function.Predicate<java.lang.Class<?>>	isTestClassCandidate Filter only class types which can contain tests or are test providers: public non-abstract non-internal.
private static java.util.regex.Pattern	legacyErrorStackTraceElementRegexp Legacy stack trace entry pattern
(package private) static CentralLogger	LOG Logger for this test engine

Constructor Summary

Constructors

Constructor and Description
UnitTestServer()

Method Summary

Modifier and Type	Method and Description
private static void	addOptionally(org.junit.platform.engine.TestDescriptor parentDescriptor, java.lang.Class<?> javaClass, java.lang.reflect.Method explicitMethods) Scan a class for test methods, declared in the class.
static void	after(org.junit.platform.engine.UniqueId testId) Execute the after behavior of this node.
static void	before(org.junit.platform.engine.UniqueId testId) Execute the before behavior of this node.
static void	cleanUp(org.junit.platform.engine.UniqueId testId) Clean up the supplied context after execution.
private static java.util.List<java.lang.reflect.Method>	collectAnnotatedMethods(java.lang.Class<?> clazz, java.lang.Class<? extends java.lang.annotation.Annotation> annoClass, boolean topDown) Collect all methods annotated with the given class, but not annotated as disabled.
private static void	convertError(java.lang.Runnable action) Run the provided code, convert legacy errors thrown to AbstractAssertionFailedError and throw the result.
protected static void	convertError(java.lang.Runnable action, java.lang.String expectedExceptionClassName) Run the provided code, convert legacy errors thrown into AbstractAssertionFailedError along with legacy error stack trace, throw the result.
static org.junit.platform.engine.TestDescriptor	discover(org.junit.platform.engine.UniqueId uniqueId, java.net.URI[] classroots, java.lang.String[] packages, java.lang.String[] classes, java.lang.String[] methods, java.net.URI[] uris, java.lang.String[] files, java.lang.String[] directories, java.lang.String[] modules, java.lang.String[] resources, java.lang.String[] iterations) Discover test sources provided as arguments.
static void	execute(org.junit.platform.engine.UniqueId testId) Execute the behavior of this node.
private static AbstractFWDTestDescriptor	getDescriptor(org.junit.platform.engine.UniqueId testId) Find descriptor by its ID.
static void	initialize() Initialize FWD server.
private static boolean	methodIsAnnotatedAndPublic(java.lang.reflect.Method method, java.lang.Class<? extends java.lang.annotation.Annotation> annoClass) Test if a method is annotated with the given annotation, and is not annotated with the Disabled annotation, and is public.
static void	prepare(org.junit.platform.engine.UniqueId testId) Prepare test descriptor.
private static void	register(AbstractFWDTestDescriptor descriptor) Register a new descriptor.
private static void	scanClassRecursively(org.junit.platform.engine.TestDescriptor engineDescriptor, java.lang.Class<?> javaClass) Recursively scan a class for all test methods, including whose defined in the class and referenced classes, if the class is marked as test suite.
private static AbstractClassTestDescriptor	testAndCreate(java.lang.Class<?> clazz, org.junit.platform.engine.TestDescriptor parentDescriptor, java.lang.reflect.Method optionalMethod) Test a Java class candidate for existent tests methods.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

static final CentralLogger LOG

Logger for this test engine

context

private static final ContextLocal<UnitTestServer.WorkArea> context

Context local work area.

isTestClassCandidate

private static final java.util.function.Predicate<java.lang.Class<?>> isTestClassCandidate

Filter only class types which can contain tests or are test providers: public non-abstract non-internal.

legacyErrorStackTraceElementRegexp

private static final java.util.regex.Pattern legacyErrorStackTraceElementRegexp

Legacy stack trace entry pattern

Constructor Detail

UnitTestServer

public UnitTestServer()

Method Detail

after

public static void after(org.junit.platform.engine.UniqueId testId)
                  throws ErrorConditionException,
                         org.opentest4j.AssertionFailedError

Execute the after behavior of this node.

This method will be called once after execution of this node.

Parameters:

testId - test descriptor ID

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

before

public static void before(org.junit.platform.engine.UniqueId testId)
                   throws ErrorConditionException,
                          org.opentest4j.AssertionFailedError

Execute the before behavior of this node.

This method will be called once before execution of this node.

Parameters:

testId - test descriptor ID

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

cleanUp

public static void cleanUp(org.junit.platform.engine.UniqueId testId)

Clean up the supplied context after execution.

Reset the test class instance.

Parameters:

testId - test descriptor ID

See Also:

prepare(org.junit.platform.engine.UniqueId)

discover

public static org.junit.platform.engine.TestDescriptor discover(org.junit.platform.engine.UniqueId uniqueId,
                                                                java.net.URI[] classroots,
                                                                java.lang.String[] packages,
                                                                java.lang.String[] classes,
                                                                java.lang.String[] methods,
                                                                java.net.URI[] uris,
                                                                java.lang.String[] files,
                                                                java.lang.String[] directories,
                                                                java.lang.String[] modules,
                                                                java.lang.String[] resources,
                                                                java.lang.String[] iterations)
                                                         throws ErrorConditionException,
                                                                org.opentest4j.AssertionFailedError

Discover test sources provided as arguments.

Note: only the classroots, packages, classes, methods and modules are supported by this engine. All other parameters can have no relation neither to ABLUnit nor OEUnit, and are preserved for possible future extensions.

Parameters:

uniqueId - the engine unique ID

classroots - the list of class root URLs

packages - the list of packages

classes - the list of class names

methods - the list of method specifications

uris - the list of URIs

files - the list of files

directories - the list of directories

modules - the list of modules

resources - the list of resources

iterations - the list of iterations (currently not supported)

Returns:

the test descriptor discovered or null if no match was found.

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

execute

public static void execute(org.junit.platform.engine.UniqueId testId)
                    throws ErrorConditionException,
                           org.opentest4j.AssertionFailedError

Execute the behavior of this node.

Locate the test descriptor by its unique ID and calls AbstractFWDTestDescriptor.executeImpl()

Parameters:

testId - test descriptor ID

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

initialize

public static void initialize()

Initialize FWD server.

prepare

public static void prepare(org.junit.platform.engine.UniqueId testId)
                    throws ErrorConditionException,
                           org.opentest4j.AssertionFailedError

Prepare test descriptor.

Locate the test descriptor by its unique ID and calls AbstractFWDTestDescriptor.prepareImpl()

Parameters:

testId - test descriptor ID

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

convertError

protected static final void convertError(java.lang.Runnable action,
                                         java.lang.String expectedExceptionClassName)
                                  throws ErrorConditionException,
                                         org.opentest4j.AssertionFailedError

Run the provided code, convert legacy errors thrown into AbstractAssertionFailedError along with legacy error stack trace, throw the result.

This is a FWD extension to support test runners (e.g. Eclipse), which "know" how to display AssertionFailedError specially.

Parameters:

action - the action to run, must return the legacy error thrown or null

expectedExceptionClassName - the expected legacy error class name or an empty string if no legacy error was expected

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

addOptionally

private static final void addOptionally(org.junit.platform.engine.TestDescriptor parentDescriptor,
                                        java.lang.Class<?> javaClass,
                                        java.lang.reflect.Method explicitMethods)

Scan a class for test methods, declared in the class.

Parameters:

parentDescriptor - the parent descriptor to register found test descriptors in

javaClass - the Java class to scan

explicitMethods - optional list of explicit test methods to execute, can be null

methodIsAnnotatedAndPublic

private static final boolean methodIsAnnotatedAndPublic(java.lang.reflect.Method method,
                                                        java.lang.Class<? extends java.lang.annotation.Annotation> annoClass)

Test if a method is annotated with the given annotation, and is not annotated with the Disabled annotation, and is public. Log methods, which are properly annotated, but are not public.

Parameters:

method - the method to test

annoClass - the annotation to test

Returns:

true is the method argument matches the criteria

collectAnnotatedMethods

private static final java.util.List<java.lang.reflect.Method> collectAnnotatedMethods(java.lang.Class<?> clazz,
                                                                                      java.lang.Class<? extends java.lang.annotation.Annotation> annoClass,
                                                                                      boolean topDown)

Collect all methods annotated with the given class, but not annotated as disabled.

Parameters:

clazz - the class to scan for methods

annoClass - the annotation class to match

topDown - if true, then traverse class hierarchy top-down, otherwise traverse bottom-up.

Returns:

the list of methods found; never null

convertError

private static final void convertError(java.lang.Runnable action)
                                throws ErrorConditionException,
                                       org.opentest4j.AssertionFailedError

Run the provided code, convert legacy errors thrown to AbstractAssertionFailedError and throw the result.

This is a FWD extension to support test runners (e.g. Eclipse), which "knows" how to display AbstractAssertionFailedError specially.

Parameters:

action - the action to run, must return the legacy error thrown or null

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

getDescriptor

private static final AbstractFWDTestDescriptor getDescriptor(org.junit.platform.engine.UniqueId testId)

Find descriptor by its ID.

Parameters:

testId - unique ID

Returns:

the test descriptor.

register

private static final void register(AbstractFWDTestDescriptor descriptor)

Register a new descriptor.

Parameters:

descriptor - the descriptor to register

scanClassRecursively

private static final void scanClassRecursively(org.junit.platform.engine.TestDescriptor engineDescriptor,
                                               java.lang.Class<?> javaClass)
                                        throws ErrorConditionException,
                                               org.opentest4j.AssertionFailedError

Recursively scan a class for all test methods, including whose defined in the class and referenced classes, if the class is marked as test suite.

Parameters:

engineDescriptor - the engine descriptor to register found test descriptors in

javaClass - the Java class to scan

Throws:

ErrorConditionException - remote code may throw this

org.opentest4j.AssertionFailedError - remote legacy errors are converted to this exception type

testAndCreate

private static final AbstractClassTestDescriptor testAndCreate(java.lang.Class<?> clazz,
                                                               org.junit.platform.engine.TestDescriptor parentDescriptor,
                                                               java.lang.reflect.Method optionalMethod)

Test a Java class candidate for existent tests methods. If found, create a new class test descriptor.

Parameters:

clazz - the class under test

parentDescriptor - the parent descriptor

optionalMethod - the explicit method or null to scan the class for all test methods

Returns:

the class test descriptor or null if this class has no test methods.