Package de.cuioss.test.valueobjects

Class ValueObjectTest<T>

java.lang.Object

de.cuioss.test.valueobjects.PropertyAwareTest<T>

de.cuioss.test.valueobjects.ValueObjectTest<T>

Type Parameters:

T - identifying the type to be tested is usually but not necessarily at least Serializable.

All Implemented Interfaces:

ObjectContractTestSupport, GeneratorRegistry

public class ValueObjectTest<T>
extends PropertyAwareTest<T>
implements ObjectContractTestSupport

Base-class for running tests on value-objects. It runs two type of tests:

• Tests for the canonical Object methods Object.equals(Object), Object.hashCode() and Object.toString() with each test can be vetoed using VetoObjectTestContract at type-level. See de.cuioss.test.valueobjects.api.object for details
• Individual contract-testing like VerifyBeanProperty or VerifyFactoryMethod, see de.cuioss.test.valueobjects.api.contracts for details.

Configuration

See PropertyAwareTest for details on configuring PropertyMetadata and TypedGenerator

Usage examples can be found at the package-documentation: de.cuioss.test.valueobjects.junit5

Author:

Oliver Wolff

Constructor Summary

Constructors

Constructor	Description
ValueObjectTest()

Method Summary

Modifier and Type	Method	Description
protected T	anyValueObject()	This method can be used in two ways: In case you have at least de.cuioss.test.valueobjects.api.contracts configured this method will implicitly return an arbitrary Object of the implicitly created underlying ParameterizedInstantiator In case you have no ParameterizedInstantiator configured you can implement this method for feeding the shouldImplementObjectContracts()
void	initializeBaseClass()	Initializes all contracts
protected List<TestContract<T>>	resolveTestContracts(List<PropertyMetadata> initialMetadata)	Resolves the concrete TestContracts to be tested.
void	shouldImplementObjectContracts()	Base test for ValueObjects verifying the correctness of Object.equals(Object) Object.hashCode(), Object.toString() and Serializable implementations.
final void	shouldVerifyTestContracts()	Tests all configured TestContracts.

Methods inherited from class de.cuioss.test.valueobjects.PropertyAwareTest

initializePropertiesAndGenerators, resolvePropertyMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cuioss.test.valueobjects.util.GeneratorRegistry

registerAdditionalGenerators

Constructor Details

ValueObjectTest

public ValueObjectTest()

Method Details

initializeBaseClass

@BeforeEach
public void initializeBaseClass()

Initializes all contracts

resolveTestContracts

protected List<TestContract<T>> resolveTestContracts(List<PropertyMetadata> initialMetadata)

Resolves the concrete TestContracts to be tested. They are derived by the corresponding annotations

Parameters:

initialMetadata -

Returns:

shouldImplementObjectContracts

@Test
public void shouldImplementObjectContracts()

Description copied from interface: ObjectContractTestSupport

Base test for ValueObjects verifying the correctness of Object.equals(Object) Object.hashCode(), Object.toString() and Serializable implementations.

If you want to disable one of these tests you can annotate the test class with VetoObjectTestContract with the value ObjectTestContracts.EQUALS_AND_HASHCODE, ObjectTestContracts.SERIALIZABLE or ObjectTestContracts.TO_STRING

Specified by:

shouldImplementObjectContracts in interface ObjectContractTestSupport

shouldVerifyTestContracts

@Test
public final void shouldVerifyTestContracts()

Tests all configured TestContracts. The individual contracts are to be configured using class level annotations or overwriting resolveTestContracts(SortedSet)

anyValueObject

protected T anyValueObject()

This method can be used in two ways:

• In case you have at least de.cuioss.test.valueobjects.api.contracts configured this method will implicitly return an arbitrary Object of the implicitly created underlying ParameterizedInstantiator
• In case you have no ParameterizedInstantiator configured you can implement this method for feeding the shouldImplementObjectContracts()

Returns:

a concrete valueObject, or null