org.meanbean.test

Class BeanTester

java.lang.Object

org.meanbean.test.BeanTester

public class BeanTester
extends Object

Concrete BeanTester that affords a means of testing JavaBean objects with respect to:

• the correct functioning of the object's public getter and setter methods

Each property is tested by:

1. generating a random test value for the specific property type
2. invoking the property setter method, passing the generated test value
3. invoking the property getter method and obtaining the return value
4. verifying that the value obtained from the getter method matches the value passed to the setter method

Each property of a type is tested in turn. Each type is tested multiple times to reduce the risk of hard-coded values within a getter or setter matching the random test values generated and the test failing to detect a bug.

Testing can be configured as follows:

• the number of times each type is tested can be configured
• the properties to test can be configured by specifying properties to ignore on a type
• custom Factories can be registered to create test values during testing

See:

• setIterations(int) to set the number of times any type is tested
• addCustomConfiguration(Class<?>,Configuration) to add a custom Configuration across all testing of the specified type
• testBean(Class<?>,Configuration) to specify a custom Configuration for a single test scenario
• getFactoryCollection().addFactory(Class<?>,Factory<?>) to add a custom Factory for a type across all testing

The following example shows how to test a class MyClass:

 BeanTester beanTester = new BeanTester();
 beanTester.testBean(MyClass.class);
 

If the test fails, an AssertionError is thrown.

To ignore a property (say, lastName) when testing a class:

 BeanTester beanTester = new BeanTester();
 Configuration configuration = new ConfigurationBuilder().ignoreProperty("lastName").build();
 beanTester.testBean(MyClass.class, configuration);
 

Author:

Graham Williamson

Field Summary

Fields

Modifier and Type	Field and Description
static int	TEST_ITERATIONS_PER_BEAN Default number of times a bean should be tested.

Constructor Summary

Constructors

Constructor and Description
BeanTester() Prefer BeanVerifier or BeanTesterBuilder.newBeanTester()

Method Summary

Modifier and Type	Method and Description
FactoryCollection	getFactoryCollection() The collection of test data Factories with which you can register new Factories for custom Data Types.
int	getIterations() Get the number of times each bean should be tested.
RandomValueGenerator	getRandomValueGenerator() Get a RandomNumberGenerator.
protected void	testBean(BeanInformation beanInformation, Configuration configuration) Test the type specified by the beanInformation parameter using the specified Configuration.
void	testBean(Class<?> beanClass) Test the type specified by the beanClass parameter.
void	testBean(Class<?> beanClass, Configuration customConfiguration) Test the type specified by the beanClass parameter, using the custom Configuration provided as an override to any global configuration settings.
void	testBeans(Class<?>... beanClasses)

Methods inherited from class java.lang.Object

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

Field Detail

TEST_ITERATIONS_PER_BEAN

public static final int TEST_ITERATIONS_PER_BEAN

Default number of times a bean should be tested.

See Also:

Constant Field Values

Constructor Detail

BeanTester

public BeanTester()

Prefer BeanVerifier or BeanTesterBuilder.newBeanTester()

Method Detail

getFactoryCollection

public FactoryCollection getFactoryCollection()

The collection of test data Factories with which you can register new Factories for custom Data Types.

Returns:

The collection of test data Factories.

getRandomValueGenerator

public RandomValueGenerator getRandomValueGenerator()

Get a RandomNumberGenerator.

Returns:

A RandomNumberGenerator.

getIterations

public int getIterations()

Get the number of times each bean should be tested.

Note: A custom Configuration can override this global setting.

Returns:

The number of times each bean should be tested. This value will be at least 1.

testBean

public void testBean(Class<?> beanClass)
              throws IllegalArgumentException,
                     AssertionError,
                     BeanTestException

Test the type specified by the beanClass parameter.

Testing will test each publicly readable and writable property of the specified beanClass to ensure that the getters and setters function correctly.

The test is performed repeatedly using random data for each scenario to prevent salient getter/setter failures.

When a test is failed, an AssertionError is thrown.

Parameters:

beanClass - The type to be tested.

Throws:

IllegalArgumentException - If the beanClass is deemed illegal. For example, if it is null.

AssertionError - If the bean fails the test.

BeanTestException - If an unexpected exception occurs during testing.

testBeans

public void testBeans(Class<?>... beanClasses)
               throws IllegalArgumentException,
                      AssertionError,
                      BeanTestException

Throws:

IllegalArgumentException

AssertionError

BeanTestException

testBean

public void testBean(Class<?> beanClass,
                     Configuration customConfiguration)
              throws IllegalArgumentException,
                     AssertionError,
                     BeanTestException

Test the type specified by the beanClass parameter, using the custom Configuration provided as an override to any global configuration settings.

Testing will test each publicly readable and writable property of the specified beanClass to ensure that the getters and setters function correctly.

The test is performed repeatedly using random data for each scenario to prevent salient getter/setter failures.

When a test is failed, an AssertionError is thrown.

Parameters:

beanClass - The type to be tested.

customConfiguration - The custom Configuration to be used when testing the specified beanClass type. This Configuration is only used for this individual test and will not be retained for future testing of this or any other type. To register a custom Configuration across multiple tests, use addCustomConfiguration(). If no custom Configuration is required, pass null or use testBean(Class<?>) instead.

Throws:

IllegalArgumentException - If the beanClass is deemed illegal. For example, if it is null.

AssertionError - If the bean fails the test.

BeanTestException - If an unexpected exception occurs during testing.

testBean

protected void testBean(BeanInformation beanInformation,
                        Configuration configuration)
                 throws IllegalArgumentException,
                        AssertionError,
                        BeanTestException

Test the type specified by the beanInformation parameter using the specified Configuration.

Testing will test each publicly readable and writable property of the specified beanClass to ensure that the getters and setters function correctly.

The test is performed repeatedly using random data for each scenario to prevent salient getter/setter failures.

When a test is failed, an AssertionError is thrown.

Parameters:

beanInformation - Information about the type to be tested.

configuration - The custom Configuration to be used when testing the specified beanClass type. If no custom Configuration is required, pass null or use testBean(Class<?>) instead.

Throws:

IllegalArgumentException - If the beanInformation is deemed illegal. For example, if it is null.

AssertionError - If the bean fails the test.

BeanTestException - If an unexpected exception occurs during testing.