Package org.openstreetmap.atlas.checks.validation.verifier

Class ConsumerBasedExpectedCheckVerifier

java.lang.Object

org.junit.rules.Verifier

org.openstreetmap.atlas.checks.validation.verifier.ConsumerBasedExpectedCheckVerifier

All Implemented Interfaces:

org.junit.rules.TestRule

public class ConsumerBasedExpectedCheckVerifier
extends org.junit.rules.Verifier

JUnit Verifier to run verifier functions on the list of CheckFlags generated by the checks under test. This is in production code due to some downstream projects needing to use it for tests.

Constructor Summary

Constructors

Constructor	Description
ConsumerBasedExpectedCheckVerifier()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	actual(org.openstreetmap.atlas.geography.atlas.Atlas atlas, BaseCheck<?> check)	Adds a test Atlas and a Check to verify
ConsumerBasedExpectedCheckVerifier	globallyVerify(java.util.function.Consumer<java.util.List<CheckFlag>> verifierFunction)	Registers a custom function to verify all of the resulting flags when the Check is run over the test Atlas
protected void	verify()
ConsumerBasedExpectedCheckVerifier	verify(java.util.function.Consumer<CheckFlag> verifierFunction)	Registers a custom function to verify each resulting CheckFlag individually
ConsumerBasedExpectedCheckVerifier	verifyEmpty()	Verifies that no CheckFlags were returned when the Check is run over the test Atlas
ConsumerBasedExpectedCheckVerifier	verifyExpectedSize(int size)	Verifies that a specific number of CheckFlags were returned when the Check is run over the test Atlas
ConsumerBasedExpectedCheckVerifier	verifyNotEmpty()	Verifies that at least one CheckFlag was returned when the Check is run over the test Atlas
ConsumerBasedExpectedCheckVerifier	verifyNotNull()	Checks for null values returned by the Check

Methods inherited from class org.junit.rules.Verifier

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerBasedExpectedCheckVerifier

public ConsumerBasedExpectedCheckVerifier()

Default constructor

Method Detail

actual

public void actual(org.openstreetmap.atlas.geography.atlas.Atlas atlas,
                   BaseCheck<?> check)

Adds a test Atlas and a Check to verify

Parameters:

atlas - a test Atlas

check - the Check under test

globallyVerify

public ConsumerBasedExpectedCheckVerifier globallyVerify(java.util.function.Consumer<java.util.List<CheckFlag>> verifierFunction)

Registers a custom function to verify all of the resulting flags when the Check is run over the test Atlas

Parameters:

verifierFunction - a function that verifies the complete results

Returns:

the ConsumerBasedExpectedCheckVerifier

verify

public ConsumerBasedExpectedCheckVerifier verify(java.util.function.Consumer<CheckFlag> verifierFunction)

Registers a custom function to verify each resulting CheckFlag individually

Parameters:

verifierFunction - a function that verifies each result individually

Returns:

the ConsumerBasedExpectedCheckVerifier

verifyEmpty

public ConsumerBasedExpectedCheckVerifier verifyEmpty()

Verifies that no CheckFlags were returned when the Check is run over the test Atlas

Returns:

the ConsumerBasedExpectedCheckVerifier

verifyExpectedSize

public ConsumerBasedExpectedCheckVerifier verifyExpectedSize(int size)

Verifies that a specific number of CheckFlags were returned when the Check is run over the test Atlas

Parameters:

size - The number of CheckFlags expected

Returns:

the ConsumerBasedExpectedCheckVerifier

verifyNotEmpty

public ConsumerBasedExpectedCheckVerifier verifyNotEmpty()

Verifies that at least one CheckFlag was returned when the Check is run over the test Atlas

Returns:

the ConsumerBasedExpectedCheckVerifier

verifyNotNull

public ConsumerBasedExpectedCheckVerifier verifyNotNull()

Checks for null values returned by the Check

Returns:

the ConsumerBasedExpectedCheckVerifier

verify

protected void verify()
               throws java.lang.Throwable

Overrides:

verify in class org.junit.rules.Verifier

Throws:

java.lang.Throwable