com.boomi.connector.testutil.junit

Class OperationTest

java.lang.Object

com.boomi.connector.testutil.junit.ConnectorTest

com.boomi.connector.testutil.junit.OperationTest

Direct Known Subclasses:

CreateOperationTest, DeleteOperationTest, ExecuteOperationTest, GetOperationTest, QueryOperationTest, UpdateOperationTest, UpsertOperationTest

public abstract class OperationTest
extends ConnectorTest

Base test class for testing connector operations with ConnectorTester . All implementing classes will execute a single test to verify successful execution of the operation.

To create tests for specific operations, you should extend the operation specific subclasses instead of implementing this directly.

See Also:

CreateOperationTest, DeleteOperationTest, ExecuteOperationTest, QueryOperationTest, UpdateOperationTest, UpsertOperationTest

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EXPECTED_RESULT_COUNT

Fields inherited from class com.boomi.connector.testutil.junit.ConnectorTest

connectorTester, testContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OperationTest(OperationType operationType, String objectTypeId) Creates an instance of an operation test.
protected	OperationTest(OperationType operationType, String objectTypeId, OptionalTestInput optionalTestInput) Creates an instance of an operation test.

Method Summary

Modifier and Type	Method and Description
protected void	afterOperation(List<SimpleOperationResult> results) This method can be overridden to provide additional verification beyond the base verifications performed by testOperation().
protected void	afterOperation(SimpleOperationResult result) This method can be overridden to provide additional verification beyond the base verifications performed by testOperation().
protected abstract List<SimpleOperationResult>	executeOperation() This method should perform the actual operation being tested
void	prepareForOperation() Setup method for operation tests
void	testOperation() Test method to verify the successful execution of the target operation

Methods inherited from class com.boomi.connector.testutil.junit.ConnectorTest

browseProfile, browseTypes, clearObjectDefinitionCache, getBrowseContext, getConnectorTestContext, getOperationContext, setupConnectorTester

Methods inherited from class java.lang.Object

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

Field Detail

EXPECTED_RESULT_COUNT

protected static final int EXPECTED_RESULT_COUNT

See Also:

Constant Field Values

Constructor Detail

OperationTest

protected OperationTest(OperationType operationType,
                        String objectTypeId)

Creates an instance of an operation test.

Intended to be used as part of a Parameterized test but can be run as a single test instance by invoking this constructor from the no argument constructor of the implementing class.

Parameters:

operationType - the operation under test

objectTypeId - the object type id under test

OperationTest

protected OperationTest(OperationType operationType,
                        String objectTypeId,
                        OptionalTestInput optionalTestInput)

Creates an instance of an operation test.

Intended to be used as part of a Parameterized test but can be run as a single test instance by invoking this constructor from the no argument constructor of the implementing class.

Parameters:

operationType - the operation under test

objectTypeId - the object type id under test

optionalTestInput - optional input for the test

Method Detail

prepareForOperation

public final void prepareForOperation()

Setup method for operation tests

This method will set the object type and object type id in the test context. It will also verify that any ObjectDefinitionRole cookies have been loaded.

testOperation

public final void testOperation()
                         throws Exception

Test method to verify the successful execution of the target operation

The test will execute the operation specified by the implementing class and verify the SimpleOperationResult. Successful operations are assumed to have only a single result as the test only supports a single input value. The operation status and presence of payloads will be verified against expectedOperationStatus and expectedEmptyPayloads. The expected values are specified by OptionalTestInput and default to OperationStatus.SUCCESS and false, respectively. If payloads are expected, they should not be null.

Throws:

Exception - exception testing the operation

afterOperation

protected void afterOperation(List<SimpleOperationResult> results)
                       throws Exception

This method can be overridden to provide additional verification beyond the base verifications performed by testOperation(). This method will only execute after other verifications have passed. The default behavior of this method is to pass the first item in the list to afterOperation(SimpleOperationResult).

Parameters:

results - list of results created by executing the operation

Throws:

Exception - execption validating the operation results

afterOperation

protected void afterOperation(SimpleOperationResult result)
                       throws Exception

This method can be overridden to provide additional verification beyond the base verifications performed by testOperation(). This method will only execute after other verifications have passed. If afterOperation(SimpleOperationResult) has also been overridden, then it is the responsibility of the overriding class to ensure that this method is called (if needed).

Parameters:

result - SimpleOperationResult created by executing the operation

Throws:

Exception - exception validating the operation result

executeOperation

protected abstract List<SimpleOperationResult> executeOperation()

This method should perform the actual operation being tested

Returns:

List of SimpleOperationResult representing the result of the operation