com.goldencode.p2j.testengine

Class AbstractMethodTestDescriptor

java.lang.Object

com.goldencode.p2j.testengine.NoopDescriptor

com.goldencode.p2j.testengine.AbstractFWDTestDescriptor

com.goldencode.p2j.testengine.AbstractMethodTestDescriptor

All Implemented Interfaces:

Printable, java.io.Externalizable, java.io.Serializable, org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>, org.junit.platform.engine.TestDescriptor

Direct Known Subclasses:

FWDClassMethodTestDescriptor, FWDProcedureMethodTestDescriptor

public abstract class AbstractMethodTestDescriptor
extends AbstractFWDTestDescriptor

Test descriptor for a Java method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.platform.engine.support.hierarchical.Node

org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor, org.junit.platform.engine.support.hierarchical.Node.ExecutionMode, org.junit.platform.engine.support.hierarchical.Node.Invocation<C extends org.junit.platform.engine.support.hierarchical.EngineExecutionContext>, org.junit.platform.engine.support.hierarchical.Node.SkipResult

Nested classes/interfaces inherited from interface org.junit.platform.engine.TestDescriptor

org.junit.platform.engine.TestDescriptor.Type, org.junit.platform.engine.TestDescriptor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.List<java.lang.reflect.Method>	afterEach Methods to execute after the main method, if any.
(package private) java.util.List<java.lang.reflect.Method>	beforeEach Methods to execute before the main method, if any.
(package private) java.lang.Class<?>	clazz The Java class to create instances of.
(package private) java.lang.String	expectedException This field, if not empty, contains the name of legacy exception class expected to be thrown by the test.
(package private) java.lang.reflect.Method	fixture Optional fixture method
(package private) java.lang.reflect.Method	method The test method
(package private) CallParameter[]	parameterList Optional legacy method invocation parameters, used by test methods with data providers, or null for no parameters

Fields inherited from class com.goldencode.p2j.testengine.NoopDescriptor

parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMethodTestDescriptor() Default constructor.
protected	AbstractMethodTestDescriptor(AbstractClassTestDescriptor parent, java.lang.Class<?> clazz, java.lang.reflect.Method execute, CallParameter[] parameterList, java.lang.reflect.Method fixture, java.util.List<java.lang.reflect.Method> beforeEach, java.util.List<java.lang.reflect.Method> afterEach, java.lang.String expectedException) Constructor.
protected	AbstractMethodTestDescriptor(org.junit.platform.engine.UniqueId id, java.lang.String displayName, java.lang.Class<?> clazz, java.lang.reflect.Method execute, CallParameter[] parameterList, java.lang.reflect.Method fixture, java.util.List<java.lang.reflect.Method> beforeEach, java.util.List<java.lang.reflect.Method> afterEach, java.lang.String expectedException) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterImpl() Execute the after behavior of this node implementation.
void	beforeImpl() Execute the before behavior of this node implementation.
FWDEngineExecutionContext	execute(FWDEngineExecutionContext context, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor) Execute the behavior of this node.
void	executeImpl() Execute the implementation behavior of this node.
private void	executeTestMethod() Execute the test method.
java.util.Optional<org.junit.platform.engine.TestSource>	getSource() Get the source of the test or container described by this descriptor, if available.
protected java.lang.Object	getTestObject() Get test object.
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class com.goldencode.p2j.testengine.AbstractFWDTestDescriptor

after, before, callLFMethodsImpl, callMethodImpl, callMethodImpl, checkInstance, cleanUp, cleanUpImpl, getTags, getTags, prepare, prepareImpl, toString

Methods inherited from class com.goldencode.p2j.testengine.NoopDescriptor

addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getType, getUniqueId, hashCode, print, removeChild, removeFromHierarchy, setParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.junit.platform.engine.support.hierarchical.Node

around, getExclusiveResources, getExecutionMode, nodeFinished, nodeSkipped, shouldBeSkipped

Methods inherited from interface org.junit.platform.engine.TestDescriptor

accept, containsTests, getAncestors, getDescendants, getLegacyReportingName, isContainer, isRoot, isTest, mayRegisterTests, prune

Methods inherited from interface com.goldencode.util.Printable

asString

Field Detail

afterEach

java.util.List<java.lang.reflect.Method> afterEach

Methods to execute after the main method, if any.

beforeEach

java.util.List<java.lang.reflect.Method> beforeEach

Methods to execute before the main method, if any.

clazz

java.lang.Class<?> clazz

The Java class to create instances of.

expectedException

java.lang.String expectedException

This field, if not empty, contains the name of legacy exception class expected to be thrown by the test. This field must never be null.

fixture

transient java.lang.reflect.Method fixture

Optional fixture method

method

java.lang.reflect.Method method

The test method

parameterList

transient CallParameter[] parameterList

Optional legacy method invocation parameters, used by test methods with data providers, or null for no parameters

Constructor Detail

AbstractMethodTestDescriptor

protected AbstractMethodTestDescriptor()

Default constructor. Required for serialization only. Not to be used in applications.

AbstractMethodTestDescriptor

protected AbstractMethodTestDescriptor(AbstractClassTestDescriptor parent,
                                       java.lang.Class<?> clazz,
                                       java.lang.reflect.Method execute,
                                       CallParameter[] parameterList,
                                       java.lang.reflect.Method fixture,
                                       java.util.List<java.lang.reflect.Method> beforeEach,
                                       java.util.List<java.lang.reflect.Method> afterEach,
                                       java.lang.String expectedException)

Constructor.

The unique ID and display name for the descriptor are calculated based on the parent descriptor ID and the method name.

Parameters:

parent - the parent descriptor

clazz - the Java class to create instances

execute - the method to execute

parameterList - the list of method call parameters

fixture - if not null, the method of the same class used as a fixture for other test method(s)

beforeEach - methods to execute before the execute method

afterEach - methods to execute after the execute method

expectedException - if not null, the expected exception legacy class name

AbstractMethodTestDescriptor

protected AbstractMethodTestDescriptor(org.junit.platform.engine.UniqueId id,
                                       java.lang.String displayName,
                                       java.lang.Class<?> clazz,
                                       java.lang.reflect.Method execute,
                                       CallParameter[] parameterList,
                                       java.lang.reflect.Method fixture,
                                       java.util.List<java.lang.reflect.Method> beforeEach,
                                       java.util.List<java.lang.reflect.Method> afterEach,
                                       java.lang.String expectedException)

Constructor.

Parameters:

id - thr ID for this test descriptor

displayName - the display name

clazz - the Java class to create instances

execute - the method to execute

parameterList - TODO

fixture - if not null, the method of the same class used as a fixture for other test method(s)

beforeEach - methods to execute before the execute method

afterEach - methods to execute after the execute method

expectedException - if not null, the expected exception legacy class name

Method Detail

afterImpl

public void afterImpl()
               throws ErrorConditionException

Execute the after behavior of this node implementation.

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

Overrides:

afterImpl in class AbstractFWDTestDescriptor

Throws:

ErrorConditionException - remote code may throw this

beforeImpl

public void beforeImpl()
                throws ErrorConditionException

Execute the before behavior of this node implementation.

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

Overrides:

beforeImpl in class AbstractFWDTestDescriptor

Throws:

ErrorConditionException - remote code may throw this

execute

public FWDEngineExecutionContext execute(FWDEngineExecutionContext context,
                                         org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)
                                  throws ErrorConditionException

Execute the behavior of this node.

Containers typically do not implement this method since the HierarchicalTestEngine handles execution of their children.

The supplied dynamicTestExecutor may be used to submit additional dynamic tests for immediate execution.

Specified by:

execute in interface org.junit.platform.engine.support.hierarchical.Node<FWDEngineExecutionContext>

Overrides:

execute in class AbstractFWDTestDescriptor

Parameters:

context - the context to execute in

dynamicTestExecutor - the executor to submit dynamic tests to

Returns:

the new context to be used for children of this node and for the after behavior of the parent of this node, if any

Throws:

ErrorConditionException

See Also:

Node.before(C), Node.after(C)

executeImpl

public void executeImpl()
                 throws ErrorConditionException

Execute the implementation behavior of this node.

Overrides:

executeImpl in class AbstractFWDTestDescriptor

Throws:

ErrorConditionException - remote code may throw this

getSource

public java.util.Optional<org.junit.platform.engine.TestSource> getSource()

Get the source of the test or container described by this descriptor, if available.

Specified by:

getSource in interface org.junit.platform.engine.TestDescriptor

Overrides:

getSource in class NoopDescriptor

See Also:

TestSource

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class AbstractFWDTestDescriptor

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException - if I/O errors occur

java.lang.ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class AbstractFWDTestDescriptor

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException - Includes any I/O exceptions that may occur

getTestObject

protected java.lang.Object getTestObject()

Get test object. The test object is either a legacy class instance if tests are implemented as legacy class methods or a persistent procedure instance it tests are implemented as internal procedures.

The value should be null if the test method is a static legacy class method.

Overrides:

getTestObject in class AbstractFWDTestDescriptor

Returns:

the test object or null

executeTestMethod

private void executeTestMethod()
                        throws ErrorConditionException,
                               LegacyErrorException

Execute the test method.

Throws:

ErrorConditionException - thrown by the method executed

LegacyErrorException - legacy errors are no caught by this method