org.meanbean.test

Interface BeanVerifier

public interface BeanVerifier

BeanVerifier can be used in unit tests to verify

• bean getter/setter methods
• equals/hashCode methods
• toString method

Example usage:

 BeanVerifier.verifyBean(Company.class); // verify bean methods, equals/hashCode and toString
 
 BeanVerifier.verifyBeans(Company.class, Employee.class);
 
 BeanVerifier.forClass(Company.class)
     .withSettings(settings -> settings.setDefaultIterations(12))
     .withSettings(settings -> settings.addIgnoredProperty(Company::getName)) // exclude name property in bean getter/setter test
     .verifyGettersAndSetters()
 

Method Summary

Modifier and Type	Method and Description
VerifierSettingsEditor	editSettings() Customizes bean verification settings.
static BeanVerifier	forClass(Class<?> beanClass) Start a fluent bean verification chain for the given beanClass
default void	verify() Performs verifyGettersAndSetters(), verifyEqualsAndHashCode() and verifyToString()
static void	verifyBean(Class<?> beanClass) Verify that given beanClass has valid bean getters/setters, equals/hashCode, and toString methods
static void	verifyBeans(Class<?>... beanClasses) Verify that given beanClasses have valid bean getters/setters, equals/hashCode, and toString methods
static void	verifyBeansIn(Package packageObj) Verify that bean classes in given packageObj have valid bean getters/setters, equals/hashCode, and toString methods
static void	verifyBeansIn(String packageName) Verify that bean classes in given packageName have valid bean getters/setters, equals/hashCode, and toString methods
BeanVerifier	verifyEqualsAndHashCode() Checks the bean's equals and hashCode methods.
BeanVerifier	verifyGettersAndSetters() Checks the bean's public getter and setter methods.
BeanVerifier	verifyToString() Checks that the bean overrides the default to Object::toString method.
BeanVerifier	withSettings(Consumer<VerifierSettings> verifierSettingsEditor) Customizes bean verification settings.

Method Detail

forClass

static BeanVerifier forClass(Class<?> beanClass)

Start a fluent bean verification chain for the given beanClass

verifyBean

static void verifyBean(Class<?> beanClass)

Verify that given beanClass has valid bean getters/setters, equals/hashCode, and toString methods

verifyBeans

static void verifyBeans(Class<?>... beanClasses)

Verify that given beanClasses have valid bean getters/setters, equals/hashCode, and toString methods

verifyBeansIn

static void verifyBeansIn(String packageName)

Verify that bean classes in given packageName have valid bean getters/setters, equals/hashCode, and toString methods

verifyBeansIn

static void verifyBeansIn(Package packageObj)

Verify that bean classes in given packageObj have valid bean getters/setters, equals/hashCode, and toString methods

withSettings

BeanVerifier withSettings(Consumer<VerifierSettings> verifierSettingsEditor)

Customizes bean verification settings. Example:

   BeanVerifier.forClass(Company.class)
       .withSettings(settings -> settings.registerFactory(Employee.class, () -> createEmployee())
       .withSettings(settings -> settings.setDefaultIterations(10))
 

editSettings

VerifierSettingsEditor editSettings()

Customizes bean verification settings. Example:

   BeanVerifier.forClass(Company.class)
       .editSettings()              // start editing settings
       .setDefaultIterations(12)
       .addEqualsInsignificantProperty(Company::getId)
       .registerFactory(Company.class, () -> company)
       .addIgnoredProperty(Company::getName)
       .edited()                    // finish editing settings and perform verifications
       .verifyGettersAndSetters();
 

verifyEqualsAndHashCode

BeanVerifier verifyEqualsAndHashCode()

Checks the bean's equals and hashCode methods.

See Also:

EqualsMethodTester, HashCodeMethodTester

verifyGettersAndSetters

BeanVerifier verifyGettersAndSetters()

Checks the bean'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.

See Also:

BeanTester

verifyToString

BeanVerifier verifyToString()

Checks that the bean overrides the default to Object::toString method.

See Also:

ToStringMethodTester

verify

default void verify()

Performs verifyGettersAndSetters(), verifyEqualsAndHashCode() and verifyToString()