Configuration Options #

Options can be set using the fluent API. Some options are also available to be set in comparator-verifier.properties which should be on the test classpath, e.g. in src/test/resources. Using the API sets values on a per-test basis, whereas setting a value in the properties file provides a default value for all tests. Values set in via the API will override values in the properties file.

withExamples(T first, T second, T... rest) #

Provides explicit examples for verification. At least two examples are required.

withGeneratedExamples(int count) or comparatorverifier.examples.count #

Automatically generates examples for verification.

strict() or comparatorverifier.mode=strict #

Enables strict verification. The following checks are included:

• Warning.SERIALIZABLE

permissive() or comparatorverifier.mode=permissive #

Enables permissive verification, excluding the following checks:

• Warning.CONSISTENT_WITH_EQUALS
• Warning.SERIALIZABLE

suppress(Warning first, Warning... rest) / only(Warning first, Warning... rest) #

A comparator that does not meet the comparator contract will not be safe to use with Java collections.

Consider using permissive() or strict() instead to alter verification behaviour.

Suppresses/include-only specific warnings during verification.

verify() #

Runs the verification process and throws an exception if validation fails.

Using a Properties File #

Create a file in src/test/resources called comparator-verifier.properties.

# number of examples to generate by default, int
comparatorverifier.examples.count=10
# mode in which to run, default | permissive | strict
comparatorverifier.mode=default