com.hcl.domino.keep.testhelper

Class TestSubscriberJson

java.lang.Object

com.hcl.domino.keep.testhelper.TestSubscriberGeneric<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.testhelper.TestSubscriberJson

All Implemented Interfaces:

io.reactivex.Emitter<io.vertx.core.json.JsonObject>, io.reactivex.ObservableEmitter<io.vertx.core.json.JsonObject>, io.reactivex.Observer<io.vertx.core.json.JsonObject>

public class TestSubscriberJson
extends TestSubscriberGeneric<io.vertx.core.json.JsonObject>

Helper class as subscriber to the request methods extending TestSubscriberGeneric for use with JsonObject adds the ability to put expected results into a queue

TestSubscriberJson sub = new TestSubscriberJson()
.expectFailure()
.errorClass(SomeError.class)
.errorMessage(String message)
.expectedOnNextCount(42)
.minimumOnNextCount(3)
.maximumOnNextCount(100)
.expectEmpty(true)
.failOnAdditionalFieldsInActual(true)
.addfieldToExist("SomeName")
.setIgnoreMissingFieldsInActual(false);

When you specify an exact number, maximum and minimum don’t make sense, but will still get reported

Field Summary

Fields inherited from class com.hcl.domino.keep.testhelper.TestSubscriberGeneric

_additionalTests

Constructor Summary

Constructors

Constructor and Description
TestSubscriberJson() Default constructor

Method Summary

Modifier and Type	Method and Description
TestSubscriberJson	addExpectedValue(io.vertx.core.json.JsonObject expected) Add an expected entry onto a queue, expectation is a strict sequence in return
TestSubscriberJson	addfieldToExist(java.lang.String fieldName) CHecks for the existence of a field in JSON without checking type or content, Just the bare existence
TestSubscriberJson	expectedOnNextCount(int expectedOnNextCount) Sets the exact number of returned items we expect default is -1 = no expectations
TestSubscriberJson	expectEmpty(boolean expectEmpty) When set to true, an empty {} is acceptable in JSON default is false
TestSubscriberJson	failOnAdditionalFieldsInActual(boolean failOnAdditionalFieldsInActual) If we compare Json elements, actual might have more elements than expected, if we need to ensure that, we can set this property to true, default is false, additional fields get ignored
TestSubscriberJson	ignoreMissingFieldsInActual(boolean ignoreMissingFieldsInActual) By default missing fields in actual throw an error, setting this to true will only compared fields found.
TestSubscriberJson	maximumOnNextCount(int maximumOnNextCount) Sets the maximum of returned items we expect, default is -1 = no expectations
TestSubscriberJson	minimumOnNextCount(int minimumOnNextCount) Sets the minimum of returned items we expect, default is -1 = no expectations
void	onNext(io.vertx.core.json.JsonObject actual)
TestSubscriberJson	setAdditionalTests(java.util.function.Consumer<io.vertx.core.json.JsonObject> additionalTests) Callback to hook additional tests into the onNext phase of the Subscriber

Methods inherited from class com.hcl.domino.keep.testhelper.TestSubscriberGeneric

close, expectFailure, externalErrorHandling, getDataCount, isDisposed, onComplete, onError, onSubscribe, serialize, setCancellable, setDisposable, tryOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSubscriberJson

public TestSubscriberJson()

Default constructor

Method Detail

addExpectedValue

public TestSubscriberJson addExpectedValue(@Nonnull
                                           io.vertx.core.json.JsonObject expected)

Add an expected entry onto a queue, expectation is a strict sequence in return

Parameters:

expected -

• expected value

Returns:

fluent

addfieldToExist

public TestSubscriberJson addfieldToExist(java.lang.String fieldName)

CHecks for the existence of a field in JSON without checking type or content, Just the bare existence

Parameters:

fieldName -

• name of a field that needs to exist

Returns:

fluent

expectedOnNextCount

public TestSubscriberJson expectedOnNextCount(int expectedOnNextCount)

Description copied from class: TestSubscriberGeneric

Sets the exact number of returned items we expect default is -1 = no expectations

Overrides:

expectedOnNextCount in class TestSubscriberGeneric<io.vertx.core.json.JsonObject>

Returns:

fluent

expectEmpty

public TestSubscriberJson expectEmpty(boolean expectEmpty)

When set to true, an empty {} is acceptable in JSON default is false

Parameters:

expectEmpty - true = accept {}, false = complaint

Returns:

fluent

failOnAdditionalFieldsInActual

public TestSubscriberJson failOnAdditionalFieldsInActual(boolean failOnAdditionalFieldsInActual)

If we compare Json elements, actual might have more elements than expected, if we need to ensure that, we can set this property to true, default is false, additional fields get ignored

Parameters:

failOnAdditionalFieldsInActual - true for no extra fields, false for ignore extra fields

Returns:

fluent

ignoreMissingFieldsInActual

public TestSubscriberJson ignoreMissingFieldsInActual(boolean ignoreMissingFieldsInActual)

By default missing fields in actual throw an error, setting this to true will only compared fields found. Default = false

Parameters:

ignoreMissingFieldsInActual - true: only fields in actual are compared, false throws and error

Returns:

fluent

maximumOnNextCount

public TestSubscriberJson maximumOnNextCount(int maximumOnNextCount)

Description copied from class: TestSubscriberGeneric

Sets the maximum of returned items we expect, default is -1 = no expectations

Overrides:

maximumOnNextCount in class TestSubscriberGeneric<io.vertx.core.json.JsonObject>

Returns:

fluent

minimumOnNextCount

public TestSubscriberJson minimumOnNextCount(int minimumOnNextCount)

Description copied from class: TestSubscriberGeneric

Sets the minimum of returned items we expect, default is -1 = no expectations

Overrides:

minimumOnNextCount in class TestSubscriberGeneric<io.vertx.core.json.JsonObject>

Returns:

fluent

onNext

public void onNext(io.vertx.core.json.JsonObject actual)

Specified by:

onNext in interface io.reactivex.Emitter<io.vertx.core.json.JsonObject>

Specified by:

onNext in interface io.reactivex.Observer<io.vertx.core.json.JsonObject>

Overrides:

onNext in class TestSubscriberGeneric<io.vertx.core.json.JsonObject>

setAdditionalTests

public TestSubscriberJson setAdditionalTests(java.util.function.Consumer<io.vertx.core.json.JsonObject> additionalTests)

Callback to hook additional tests into the onNext phase of the Subscriber

Overrides:

setAdditionalTests in class TestSubscriberGeneric<io.vertx.core.json.JsonObject>

Parameters:

additionalTests - additional tests and assertions to run

Returns:

fluent