Class PublisherVerification<T>
- java.lang.Object
-
- org.reactivestreams.tck.PublisherVerification<T>
-
- All Implemented Interfaces:
PublisherVerificationRules
public abstract class PublisherVerification<T> extends java.lang.Object implements PublisherVerificationRules
Provides tests for verifyingPublisherspecification rules.- See Also:
Publisher
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePublisherVerification.PublisherTestRun<T>
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringSKIPPING_NO_ERROR_PUBLISHER_AVAILABLEstatic java.lang.StringSKIPPING_OPTIONAL_TEST_FAILED
-
Constructor Summary
Constructors Constructor Description PublisherVerification(TestEnvironment env)Constructs a new verification class using the given env and configuration.PublisherVerification(TestEnvironment env, long publisherReferenceGCTimeoutMillis)Constructs a new verification class using the given env and configuration.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidactivePublisherTest(long elements, boolean completionSignalRequired, PublisherVerification.PublisherTestRun<T> body)Test for feature that SHOULD/MUST be implemented, using a live publisher.longboundedDepthOfOnNextAndRequestRecursion()In order to verify rule 3.3 of the reactive streams spec, this number will be used to check if aSubscriptionactually solves the "unbounded recursion" problem by not allowing the number of recursive calls to exceed the number returned by this method.abstract org.reactivestreams.Publisher<T>createFailedPublisher()By implementing this method, additional TCK tests concerning a "failed" publishers will be run.abstract org.reactivestreams.Publisher<T>createPublisher(long elements)This is the main method you must implement in your test incarnation.static longenvPublisherReferenceGCTimeoutMillis()Tries to parse the env variablePUBLISHER_REFERENCE_GC_TIMEOUT_MILLISas long and returns the value if present, OR its default value (DEFAULT_PUBLISHER_REFERENCE_GC_TIMEOUT_MILLIS).longmaxElementsFromPublisher()Override and return lower value if your Publisher is only able to produce a known number of elements.voidnotVerified()voidnotVerified(java.lang.String message)voidoptional_spec104_mustSignalOnErrorWhenFails()Asks for an errorPublisherthat should callonSubscribeexactly once followed by a single call toonError()without receiving any requests and otherwise not throwing any exception.voidoptional_spec105_emptyStreamMustTerminateBySignallingOnComplete()Asks for an emptyPublisher(i.e., length 0) and verifies it completes in a timely manner.voidoptional_spec111_maySupportMultiSubscribe()Asks for a single-elementPublisherand subscribes to it twice, without consuming with eitherSubscriberinstance (i.e., no requests are issued).voidoptional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfront()Asks for a shortPublisher(length 3), subscribes 3Subscribers to it, requests more than the length items upfront with each and verifies they all received the same items in the same order (but does not verify they all complete).voidoptional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpected()Asks for a shortPublisher(length 3), subscribes 3Subscribers to it, requests more than the length items upfront with each and verifies they all received the same items in the same order followed by anonCompletesignal.voidoptional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOne()Asks for a shortPublisher(length 5), subscribes 3Subscribers to it, requests with different patterns and checks if all 3 received the same events in the same order.voidoptional_spec111_registeredSubscribersMustReceiveOnNextOrOnCompleteSignals()Asks for a single-elementPublisherand subscribes to it twice.voidoptional_spec309_requestNegativeNumberMaySignalIllegalArgumentExceptionWithSpecificMessage()Asks for a shortPublisher(length 10) and issues a random, negativerequest()call which should trigger anonErrorcall with anIllegalArgumentException.voidoptionalActivePublisherTest(long elements, boolean completionSignalRequired, PublisherVerification.PublisherTestRun<T> body)Test for feature that MAY be implemented.voidpotentiallyPendingTest(org.reactivestreams.Publisher<T> pub, PublisherVerification.PublisherTestRun<T> body)voidpotentiallyPendingTest(org.reactivestreams.Publisher<T> pub, PublisherVerification.PublisherTestRun<T> body, java.lang.String message)longpublisherUnableToSignalOnComplete()Return this value frommaxElementsFromPublisher()to mark that the givenPublisher, is not able to signal completion.voidrequired_createPublisher1MustProduceAStreamOfExactly1Element()Asks for aPublisherthat should emit exactly one item and complete (both within a timeout specified byTestEnvironment.defaultTimeoutMillis()) in response to a request(1).voidrequired_createPublisher3MustProduceAStreamOfExactly3Elements()Asks for aPublisherthat should emit exactly three items and complete (all within a timeout specified byTestEnvironment.defaultTimeoutMillis()).voidrequired_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElements()Asks for aPublisherthat responds to a request pattern of 0 (not requesting upfront), 1, 1 and 2 in a timely manner.voidrequired_spec102_maySignalLessThanRequestedAndTerminateSubscription()Asks for a shortPublisherand verifies that requesting once and with more than the length (but bounded) results in the correct number of items to be emitted (i.e., length 3 and request 10) followed by anonCompletesignal.voidrequired_spec105_mustSignalOnCompleteWhenFiniteStreamTerminates()Asks for a shortPublisher(i.e., length 3) and verifies, after requesting one by one, the sequence completes normally.voidrequired_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled()Asks for a single-elementPublisherand checks if requesting after the terminal event doesn't lead to more items or terminal signals to be emitted.voidrequired_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribe()Asks for an errorPublisherthat should callonSubscribeexactly once followed by a single call toonError()without receiving any requests.voidrequired_spec109_mustIssueOnSubscribeForNonNullSubscriber()Asks for an emptyPublisherand verifies ifonSubscribesignal was emitted before any otheronNext,onErrororonCompletesignal.voidrequired_spec109_subscribeThrowNPEOnNullSubscriber()Asks for an emptyPublisherand callssubscribeon it withnullthat should result in aNullPointerExceptionto be thrown.voidrequired_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribe()Asks for a shortPublisher(length 6), requests several times from withinonSubscribeand then requests one-by-one fromonNext.voidrequired_spec303_mustNotAllowUnboundedRecursion()Asks for aPublisherwith length equal to the value returned byPublisherVerificationRules.required_validate_boundedDepthOfOnNextAndRequestRecursion()plus 1, callsrequest(1)externally and then from withinonNextand checks if the stack depth did not increase beyond the amount permitted byPublisherVerificationRules.required_validate_boundedDepthOfOnNextAndRequestRecursion().voidrequired_spec306_afterSubscriptionIsCancelledRequestMustBeNops()Asks for a shortPublisher(length 3) and verifies that cancelling without requesting anything, then requesting items should result in no signals to be emitted.voidrequired_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNops()Asks for a single-elementPublisherand verifies that without requesting anything, cancelling the sequence multiple times should result in no signals to be emitted and should result in an thrown exception.voidrequired_spec309_requestNegativeNumberMustSignalIllegalArgumentException()Asks for a shortPublisher(length 10) and issues a random, negativerequest()call which should trigger anonErrorcall with anIllegalArgumentException.voidrequired_spec309_requestZeroMustSignalIllegalArgumentException()Asks for a shortPublisher(length 10) and issues arequest(0)which should trigger anonErrorcall with anIllegalArgumentException.voidrequired_spec312_cancelMustMakeThePublisherToEventuallyStopSignaling()Asks for a shortPublisher(length 20), requests some items (less than the length), consumes one item then cancels the sequence and verifies the publisher emitted at most the requested amount and stopped emitting (or terminated).voidrequired_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriber()Asks for a shortPublisher(length 3) requests and consumes one element from it, cancels theSubscription, callsSystem.gc()and then checks if all references to the testSubscriberhas been dropped (by checking theWeakReferencehas been emptied).voidrequired_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue()Asks for a very longPublisher(up toInteger.MAX_VALUE), requestsLong.MAX_VALUE - 1after each received item and expects no failure due to a potential overflow in the pending emission count while consuming 10 items and cancelling the sequence.voidrequired_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValue()Asks for a shortPublisher(length 3) and requestsLong.MAX_VALUEfrom it in total (split across twoLong.MAX_VALUE / 2and onerequest(1)), verifying that thePublisheremits all of its items and completes normally.voidrequired_spec317_mustSupportAPendingElementCountUpToLongMaxValue()Asks for a shortPublisher(length 3) and requestsLong.MAX_VALUEfrom it, verifying that thePublisheremits all of its items and completes normally and does not keep spinning attempting to fulfill theLong.MAX_VALUEdemand by some means.voidrequired_validate_boundedDepthOfOnNextAndRequestRecursion()Validates that the override ofboundedDepthOfOnNextAndRequestRecursion()returns a positive value.voidrequired_validate_maxElementsFromPublisher()Validates that the override ofmaxElementsFromPublisher()returns a non-negative value.voidsetUp()booleanskipStochasticTests()Override and returntruein order to skip executing tests marked asStochastic.voidstochastic_spec103_mustSignalOnMethodsSequentially()Asks for a shortPublisher(i.e., length 10), repeatedly subscribes to thisPublisher, requests items one by one and verifies thePublishercalls theonXXXmethods non-overlappingly.voidstochasticTest(int n, Function<java.lang.Integer,java.lang.Void> body)Executes a given test bodyntimes.voiduntested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalled()Currently, this test is skipped because it is unclear this rule can be effectively checked on aPublisherinstance without looking into or hooking into the implementation of it.voiduntested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalled()Currently, this test is skipped, although it is possible to validate an errorPublisheralong the same lines asPublisherVerificationRules.required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled().voiduntested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignals()Currently, this test is skipped because there was no agreement on how to verify its "eventually" requirement.voiduntested_spec109_subscribeShouldNotThrowNonFatalThrowable()Currently, this test is skipped because there is no common agreement on what is to be considered a fatal exception and besides,Publisher.subscribeis only allowed throw aNullPointerExceptionand any other exception would require looking into or hooking into the implementation of thePublisher.voiduntested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwice()Currently, this test is skipped because enforcing rule §1.10 requires unlimited retention and reference-equal checks on all incomingSubscriberwhich is generally infeasible, plus reusing the sameSubscriberinstance is better detected (or ignored) insideSubscriber.onSubscribewhen the method is called multiple times.voiduntested_spec304_requestShouldNotPerformHeavyComputations()Currently, this test is skipped because arequestcould enter into a synchronous computation viaonNextlegally and otherwise there is no common agreement how to detect such heavy computation reliably.voiduntested_spec305_cancelMustNotSynchronouslyPerformHeavyComputation()Currently, this test is skipped because there is no reliable agreed upon way to detect a heavy computation.voidwhenHasErrorPublisherTest(PublisherVerification.PublisherTestRun<T> body)Additional test for Publisher in error state
-
-
-
Field Detail
-
SKIPPING_NO_ERROR_PUBLISHER_AVAILABLE
public static final java.lang.String SKIPPING_NO_ERROR_PUBLISHER_AVAILABLE
- See Also:
- Constant Field Values
-
SKIPPING_OPTIONAL_TEST_FAILED
public static final java.lang.String SKIPPING_OPTIONAL_TEST_FAILED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PublisherVerification
public PublisherVerification(TestEnvironment env, long publisherReferenceGCTimeoutMillis)
Constructs a new verification class using the given env and configuration.- Parameters:
publisherReferenceGCTimeoutMillis- used to determine after how much time a reference to a Subscriber should be already dropped by the Publisher.
-
PublisherVerification
public PublisherVerification(TestEnvironment env)
Constructs a new verification class using the given env and configuration. The value forpublisherReferenceGCTimeoutMilliswill be obtained by usingenvPublisherReferenceGCTimeoutMillis().
-
-
Method Detail
-
envPublisherReferenceGCTimeoutMillis
public static long envPublisherReferenceGCTimeoutMillis()
Tries to parse the env variablePUBLISHER_REFERENCE_GC_TIMEOUT_MILLISas long and returns the value if present, OR its default value (DEFAULT_PUBLISHER_REFERENCE_GC_TIMEOUT_MILLIS). This value is used to determine after how much time a reference to a Subscriber should be already dropped by the Publisher.- Throws:
java.lang.IllegalArgumentException- when unable to parse the env variable
-
createPublisher
public abstract org.reactivestreams.Publisher<T> createPublisher(long elements)
This is the main method you must implement in your test incarnation. It must create a Publisher for a stream with exactly the given number of elements. If `elements` is `Long.MAX_VALUE` the produced stream must be infinite.
-
createFailedPublisher
public abstract org.reactivestreams.Publisher<T> createFailedPublisher()
By implementing this method, additional TCK tests concerning a "failed" publishers will be run. The expected behaviour of thePublisherreturned by this method is hand out a subscription, followed by signallingonErroron it, as specified by Rule 1.9. If you ignore these additional tests, returnnullfrom this method.
-
maxElementsFromPublisher
public long maxElementsFromPublisher()
Override and return lower value if your Publisher is only able to produce a known number of elements. For example, if it is designed to return at-most-one element, return1from this method. Defaults toLong.MAX_VALUE - 1, meaning that the Publisher can be produce a huge but NOT an unbounded number of elements. To mark your Publisher will *never* signal anonCompleteoverride this method and returnLong.MAX_VALUE, which will result in *skipping all tests which require an onComplete to be triggered* (!).
-
skipStochasticTests
public boolean skipStochasticTests()
Override and returntruein order to skip executing tests marked asStochastic. Stochastic in this case means that the Rule is impossible or infeasible to deterministically verify— usually this means that this test case can yield false positives ("be green") even if for some case, the given implementation may violate the tested behaviour.
-
boundedDepthOfOnNextAndRequestRecursion
public long boundedDepthOfOnNextAndRequestRecursion()
In order to verify rule 3.3 of the reactive streams spec, this number will be used to check if aSubscriptionactually solves the "unbounded recursion" problem by not allowing the number of recursive calls to exceed the number returned by this method.
-
setUp
@BeforeMethod public void setUp() throws java.lang.Exception
- Throws:
java.lang.Exception
-
required_createPublisher1MustProduceAStreamOfExactly1Element
public void required_createPublisher1MustProduceAStreamOfExactly1Element() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for aPublisherthat should emit exactly one item and complete (both within a timeout specified byTestEnvironment.defaultTimeoutMillis()) in response to a request(1).The test is not executed if
maxElementsFromPublisher()returns zero. If this test fails, the following could be checked within thePublisherimplementation:- the
Publisher.subscribe(Subscriber)method has actual implementation, - in the
Publisher.subscribe(Subscriber)method, if there is an upstreamPublisher, thatPublisheris actually subscribed to, - if the
Publisheris part of a chain, all elements actually issue arequest()call in response to the test subscriber or by default to their upstream, - in the
Publisher.subscribe(Subscriber)method, theSubscriber.onSubscribeis called as part of the preparation process (usually before subscribing to otherPublishers), - if the
Publisherimplementation works for a consumer that callsrequest(1), - if the
Publisherimplementation is able to emit anonCompletewithout requests, - that the
Publisherimplementation does not emit more than the allowed elements (exactly one).
- Specified by:
required_createPublisher1MustProduceAStreamOfExactly1Elementin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_createPublisher3MustProduceAStreamOfExactly3Elements
public void required_createPublisher3MustProduceAStreamOfExactly3Elements() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for aPublisherthat should emit exactly three items and complete (all within a timeout specified byTestEnvironment.defaultTimeoutMillis()).The test is not executed if
maxElementsFromPublisher()is less than 3.The tests requests one-by-one and verifies each single response item arrives in time.
If this test fails, the following could be checked within the
Publisherimplementation:- the
Publisher.subscribe(Subscriber)method has actual implementation, - in the
Publisher.subscribe(Subscriber)method, if there is an upstreamPublisher, thatPublisheris actually subscribed to, - if the
Publisheris part of a chain, all elements actually issue arequest()call in response to the test subscriber or by default to their upstream, - in the
Publisher.subscribe(Subscriber)method, theSubscriber.onSubscribeis called as part of the preparation process (usually before subscribing to otherPublishers), - if the
Publisherimplementation works for a subscriber that callsrequest(1)after consuming an item, - if the
Publisherimplementation is able to emit anonCompletewithout requests.
- Specified by:
required_createPublisher3MustProduceAStreamOfExactly3Elementsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_validate_maxElementsFromPublisher
public void required_validate_maxElementsFromPublisher() throws java.lang.Exception
Description copied from interface:PublisherVerificationRulesValidates that the override ofmaxElementsFromPublisher()returns a non-negative value.- Specified by:
required_validate_maxElementsFromPublisherin interfacePublisherVerificationRules- Throws:
java.lang.Exception
-
required_validate_boundedDepthOfOnNextAndRequestRecursion
public void required_validate_boundedDepthOfOnNextAndRequestRecursion() throws java.lang.Exception
Description copied from interface:PublisherVerificationRulesValidates that the override ofboundedDepthOfOnNextAndRequestRecursion()returns a positive value.- Specified by:
required_validate_boundedDepthOfOnNextAndRequestRecursionin interfacePublisherVerificationRules- Throws:
java.lang.Exception
-
required_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElements
public void required_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElements() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for aPublisherthat responds to a request pattern of 0 (not requesting upfront), 1, 1 and 2 in a timely manner.Verifies rule: 1.1
The test is not executed if
maxElementsFromPublisher()is less than 5.This test ensures that the
Publisherimplementation correctly responds torequest()calls that in total are less than the number of elements thisPublishercould emit (thus the completion event won't be emitted).If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
required_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElementsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec102_maySignalLessThanRequestedAndTerminateSubscription
public void required_spec102_maySignalLessThanRequestedAndTerminateSubscription() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisherand verifies that requesting once and with more than the length (but bounded) results in the correct number of items to be emitted (i.e., length 3 and request 10) followed by anonCompletesignal.Verifies rule: 1.2
The test is not executed if
maxElementsFromPublisher()is less than 3.This test ensures that the
Publisherimplementation can deal with larger requests than the number of items it can produce.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass.
- Specified by:
required_spec102_maySignalLessThanRequestedAndTerminateSubscriptionin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
stochastic_spec103_mustSignalOnMethodsSequentially
public void stochastic_spec103_mustSignalOnMethodsSequentially() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(i.e., length 10), repeatedly subscribes to thisPublisher, requests items one by one and verifies thePublishercalls theonXXXmethods non-overlappingly.Verifies rule: 1.3
The test is not executed if
maxElementsFromPublisher()is less than 10.Note that this test is probabilistic, that is, may not capture any concurrent invocation in a {code Publisher} implementation. Note also that this test is sensitive to cases when a
request()call inonSubscribe()triggers an asynchronous call to the otheronXXXmethods. In contrast, the test allows synchronous call chain ofonSubscribe -> request -> onNext.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if a
request()call fromonSubscribe()could trigger an asynchronous call toonNext()and if so, make sure suchrequest()calls are deferred until the call toonSubscribe()returns normally.
- Specified by:
stochastic_spec103_mustSignalOnMethodsSequentiallyin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
optional_spec104_mustSignalOnErrorWhenFails
public void optional_spec104_mustSignalOnErrorWhenFails() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for an errorPublisherthat should callonSubscribeexactly once followed by a single call toonError()without receiving any requests and otherwise not throwing any exception.Verifies rule: 1.4
The test is not executed if
PublisherVerification.createErrorPublisher()returns null.If this test fails, the following could be checked within the error
Publisherimplementation:- the
Publisher.subscribe(Subscriber)method has actual implementation, - in the
Publisher.subscribe(Subscriber)method, if there is an upstreamPublisher, thatPublisheris actually subscribed to, - if the
Publisherimplementation does signal anonSubscribebefore signallingonError, - if the
Publisherimplementation is able to emit anonErrorwithout requests, - if the
Publisheris non-empty as this test requires aPublisherto signal anonErroreagerly.
- Specified by:
optional_spec104_mustSignalOnErrorWhenFailsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec105_mustSignalOnCompleteWhenFiniteStreamTerminates
public void required_spec105_mustSignalOnCompleteWhenFiniteStreamTerminates() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(i.e., length 3) and verifies, after requesting one by one, the sequence completes normally.Verifies rule: 1.5
The test is not executed if
maxElementsFromPublisher()is less than 3.Note that the tests requests 1 after the items have been received and before expecting an
onCompletesignal.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass,
- Specified by:
required_spec105_mustSignalOnCompleteWhenFiniteStreamTerminatesin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
optional_spec105_emptyStreamMustTerminateBySignallingOnComplete
public void optional_spec105_emptyStreamMustTerminateBySignallingOnComplete() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for an emptyPublisher(i.e., length 0) and verifies it completes in a timely manner.Verifies rule: 1.5
Note that the tests requests 1 before expecting an
onCompletesignal.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - if the
Publisheris non-empty as this test requires aPublisherwithout items.
- Specified by:
optional_spec105_emptyStreamMustTerminateBySignallingOnCompletein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
untested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalled
public void untested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalled() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because it is unclear this rule can be effectively checked on aPublisherinstance without looking into or hooking into the implementation of it.Verifies rule: 1.6
- Specified by:
untested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalledin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled
public void required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a single-elementPublisherand checks if requesting after the terminal event doesn't lead to more items or terminal signals to be emitted.Verifies rule: 1.7
The test is not executed if
maxElementsFromPublisher()is less than 1.The tests requests more items than the expected
Publisherlength upfront and some more items after its completion.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - the indication for the terminal state is properly persisted and a request call can't trigger emission of more items or another terminal signal.
- Specified by:
required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalledin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
untested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalled
public void untested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalled() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped, although it is possible to validate an errorPublisheralong the same lines asPublisherVerificationRules.required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled().Verifies rule: 1.7
- Specified by:
untested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalledin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
untested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignals
public void untested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignals() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because there was no agreement on how to verify its "eventually" requirement.Verifies rule: 1.8
- Specified by:
untested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignalsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
untested_spec109_subscribeShouldNotThrowNonFatalThrowable
public void untested_spec109_subscribeShouldNotThrowNonFatalThrowable() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because there is no common agreement on what is to be considered a fatal exception and besides,Publisher.subscribeis only allowed throw aNullPointerExceptionand any other exception would require looking into or hooking into the implementation of thePublisher.Verifies rule: 1.9
- Specified by:
untested_spec109_subscribeShouldNotThrowNonFatalThrowablein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
required_spec109_subscribeThrowNPEOnNullSubscriber
public void required_spec109_subscribeThrowNPEOnNullSubscriber() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for an emptyPublisherand callssubscribeon it withnullthat should result in aNullPointerExceptionto be thrown.Verifies rule: 1.9
If this test fails, check if the
subscribe()implementation has an explicit null check (or a method dereference on theSubscriber), especially if the incomingSubscriberis wrapped or stored to be used later.- Specified by:
required_spec109_subscribeThrowNPEOnNullSubscriberin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
required_spec109_mustIssueOnSubscribeForNonNullSubscriber
public void required_spec109_mustIssueOnSubscribeForNonNullSubscriber() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for an emptyPublisherand verifies ifonSubscribesignal was emitted before any otheronNext,onErrororonCompletesignal.Verifies rule: 1.9
Note that this test doesn't request anything, however, an
onNextis not considered as a failure.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - the
Publisher.subscribe(Subscriber)method has actual implementation, - in the
Publisher.subscribe(Subscriber)method, if there is an upstreamPublisher, thatPublisheris actually subscribed to, - in the
Publisher.subscribe(Subscriber)method, theSubscriber.onSubscribeis called as part of the preparation process (usually before subscribing to otherPublishers).
- Specified by:
required_spec109_mustIssueOnSubscribeForNonNullSubscriberin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribe
public void required_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribe() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for an errorPublisherthat should callonSubscribeexactly once followed by a single call toonError()without receiving any requests.Verifies rule: 1.9
The test is not executed if
PublisherVerification.createErrorPublisher()returns null.The difference between this test and
PublisherVerificationRules.optional_spec104_mustSignalOnErrorWhenFails()is that there is no explicit verification if exceptions were thrown in addition to the regularonSubscribe+onErrorsignal pair.If this test fails, the following could be checked within the error
Publisherimplementation:- the
Publisher.subscribe(Subscriber)method has actual implementation, - in the
Publisher.subscribe(Subscriber)method, if there is an upstreamPublisher, thatPublisheris actually subscribed to, - if the
Publisherimplementation is able to emit anonErrorwithout requests, - if the
Publisheris non-empty as this test expects aPublisherwithout items.
- Specified by:
required_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
untested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwice
public void untested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwice() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because enforcing rule §1.10 requires unlimited retention and reference-equal checks on all incomingSubscriberwhich is generally infeasible, plus reusing the sameSubscriberinstance is better detected (or ignored) insideSubscriber.onSubscribewhen the method is called multiple times.Verifies rule: 1.10
- Specified by:
untested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwicein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
optional_spec111_maySupportMultiSubscribe
public void optional_spec111_maySupportMultiSubscribe() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a single-elementPublisherand subscribes to it twice, without consuming with eitherSubscriberinstance (i.e., no requests are issued).Verifies rule: 1.11
The test is not executed if
maxElementsFromPublisher()is less than 1.Note that this test ignores what signals the
Publisheremits. Any exception thrown through non-regular means will indicate a skipped test.- Specified by:
optional_spec111_maySupportMultiSubscribein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
optional_spec111_registeredSubscribersMustReceiveOnNextOrOnCompleteSignals
public void optional_spec111_registeredSubscribersMustReceiveOnNextOrOnCompleteSignals() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a single-elementPublisherand subscribes to it twice. EachSubscriberrequests for 1 element and checks if onNext or onComplete signals was received.Verifies rule: 1.11, and depends on valid implementation of rule 1.5 in order to verify this.
The test is not executed if
maxElementsFromPublisher()is less than 1.Any exception thrown through non-regular means will indicate a skipped test.
- Specified by:
optional_spec111_registeredSubscribersMustReceiveOnNextOrOnCompleteSignalsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
-
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOne
public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOne() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 5), subscribes 3Subscribers to it, requests with different patterns and checks if all 3 received the same events in the same order.Verifies rule: 1.11
The test is not executed if
maxElementsFromPublisher()is less than 5.The request pattern for the first
Subscriberis (1, 1, 2, 1); for the second is (2, 3) and for the third is (3, 1, 1).Note that this test requires a
Publisherthat always emits the same signals to anySubscriber, regardless of when they subscribe and how they request elements. I.e., a "live"Publisheremitting the current time would not pass this test.Note that this test is optional and may appear skipped even if the behavior should be actually supported by the
Publisher, see the skip message for an indication of this.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOnein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfront
public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfront() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3), subscribes 3Subscribers to it, requests more than the length items upfront with each and verifies they all received the same items in the same order (but does not verify they all complete).Verifies rule: 1.11
The test is not executed if
maxElementsFromPublisher()is less than 3.Note that this test requires a
Publisherthat always emits the same signals to anySubscriber, regardless of when they subscribe and how they request elements. I.e., a "live"Publisheremitting the current time would not pass this test.Note that this test is optional and may appear skipped even if the behavior should be actually supported by the
Publisher, see the skip message for an indication of this.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpected
public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpected() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3), subscribes 3Subscribers to it, requests more than the length items upfront with each and verifies they all received the same items in the same order followed by anonCompletesignal.Verifies rule: 1.11
The test is not executed if
maxElementsFromPublisher()is less than 3.Note that this test requires a
Publisherthat always emits the same signals to anySubscriber, regardless of when they subscribe and how they request elements. I.e., a "live"Publisheremitting the current time would not pass this test.Note that this test is optional and may appear skipped even if the behavior should be actually supported by the
Publisher, see the skip message for an indication of this.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpectedin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribe
public void required_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribe() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 6), requests several times from withinonSubscribeand then requests one-by-one fromonNext.Verifies rule: 3.2
The test is not executed if
maxElementsFromPublisher()is less than 6.The request pattern is 3 x 1 from within
onSubscribeand one from within eachonNextinvocation.The test consumes the
Publisherbut otherwise doesn't verify thePublishercompletes (however, it checks for errors).If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
required_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec303_mustNotAllowUnboundedRecursion
public void required_spec303_mustNotAllowUnboundedRecursion() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for aPublisherwith length equal to the value returned byPublisherVerificationRules.required_validate_boundedDepthOfOnNextAndRequestRecursion()plus 1, callsrequest(1)externally and then from withinonNextand checks if the stack depth did not increase beyond the amount permitted byPublisherVerificationRules.required_validate_boundedDepthOfOnNextAndRequestRecursion().Verifies rule: 3.3
The test is not executed if
maxElementsFromPublisher()is less thanPublisherVerificationRules.required_validate_boundedDepthOfOnNextAndRequestRecursion()plus 1.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the implementation doesn't allow unbounded recursion when
request()is called from withinonNext, i.e., the lack of reentrant-safe state machine around the request amount (such as a for loop with a bound on the parameternthat callsonNext).
- Specified by:
required_spec303_mustNotAllowUnboundedRecursionin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
untested_spec304_requestShouldNotPerformHeavyComputations
public void untested_spec304_requestShouldNotPerformHeavyComputations() throws java.lang.Exception
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because arequestcould enter into a synchronous computation viaonNextlegally and otherwise there is no common agreement how to detect such heavy computation reliably.Verifies rule: 3.4
- Specified by:
untested_spec304_requestShouldNotPerformHeavyComputationsin interfacePublisherVerificationRules- Throws:
java.lang.Exception
-
untested_spec305_cancelMustNotSynchronouslyPerformHeavyComputation
public void untested_spec305_cancelMustNotSynchronouslyPerformHeavyComputation() throws java.lang.Exception
Description copied from interface:PublisherVerificationRulesCurrently, this test is skipped because there is no reliable agreed upon way to detect a heavy computation.Verifies rule: 3.5
- Specified by:
untested_spec305_cancelMustNotSynchronouslyPerformHeavyComputationin interfacePublisherVerificationRules- Throws:
java.lang.Exception
-
required_spec306_afterSubscriptionIsCancelledRequestMustBeNops
public void required_spec306_afterSubscriptionIsCancelledRequestMustBeNops() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3) and verifies that cancelling without requesting anything, then requesting items should result in no signals to be emitted.Verifies rule: 3.6
The test is not executed if
maxElementsFromPublisher()is less than 3.The post-cancellation request pattern is (1, 1, 1).
If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
- Specified by:
required_spec306_afterSubscriptionIsCancelledRequestMustBeNopsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNops
public void required_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNops() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a single-elementPublisherand verifies that without requesting anything, cancelling the sequence multiple times should result in no signals to be emitted and should result in an thrown exception.Verifies rule: 3.7
The test is not executed if
maxElementsFromPublisher()is less than 1.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
- Specified by:
required_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNopsin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec309_requestZeroMustSignalIllegalArgumentException
public void required_spec309_requestZeroMustSignalIllegalArgumentException() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 10) and issues arequest(0)which should trigger anonErrorcall with anIllegalArgumentException.Verifies rule: 3.9
The test is not executed if
maxElementsFromPublisher()is less than 10.Note that this test expects the
IllegalArgumentExceptionbeing signalled throughonError, not by throwing fromrequest()(which is also forbidden) or signalling the error by any other means (i.e., through theThread.currentThread().getUncaughtExceptionHandler()for example).Note also that requesting and emission may happen concurrently and honoring this rule may require extra coordination within the
Publisher.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the
Publishercan emit anonErrorin this particular case, even if there was no prior and legalrequestcall and even if thePublisherwould like to emit items first before emitting anonErrorin general.
- Specified by:
required_spec309_requestZeroMustSignalIllegalArgumentExceptionin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec309_requestNegativeNumberMustSignalIllegalArgumentException
public void required_spec309_requestNegativeNumberMustSignalIllegalArgumentException() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 10) and issues a random, negativerequest()call which should trigger anonErrorcall with anIllegalArgumentException.Verifies rule: 3.9
The test is not executed if
maxElementsFromPublisher()is less than 10.Note that this test expects the
IllegalArgumentExceptionbeing signalled throughonError, not by throwing fromrequest()(which is also forbidden) or signalling the error by any other means (i.e., through theThread.currentThread().getUncaughtExceptionHandler()for example).Note also that requesting and emission may happen concurrently and honoring this rule may require extra coordination within the
Publisher.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the
Publishercan emit anonErrorin this particular case, even if there was no prior and legalrequestcall and even if thePublisherwould like to emit items first before emitting anonErrorin general.
- Specified by:
required_spec309_requestNegativeNumberMustSignalIllegalArgumentExceptionin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
optional_spec309_requestNegativeNumberMaySignalIllegalArgumentExceptionWithSpecificMessage
public void optional_spec309_requestNegativeNumberMaySignalIllegalArgumentExceptionWithSpecificMessage() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 10) and issues a random, negativerequest()call which should trigger anonErrorcall with anIllegalArgumentException.Verifies rule: 3.9
The test is not executed if
maxElementsFromPublisher()is less than 10.Note that this test expects the
IllegalArgumentExceptionbeing signalled throughonError, not by throwing fromrequest()(which is also forbidden) or signalling the error by any other means (i.e., through theThread.currentThread().getUncaughtExceptionHandler()for example).Note also that requesting and emission may happen concurrently and honoring this rule may require extra coordination within the
Publisher.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the
Publishercan emit anonErrorin this particular case, even if there was no prior and legalrequestcall and even if thePublisherwould like to emit items first before emitting anonErrorin general.
- Specified by:
optional_spec309_requestNegativeNumberMaySignalIllegalArgumentExceptionWithSpecificMessagein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec312_cancelMustMakeThePublisherToEventuallyStopSignaling
public void required_spec312_cancelMustMakeThePublisherToEventuallyStopSignaling() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 20), requests some items (less than the length), consumes one item then cancels the sequence and verifies the publisher emitted at most the requested amount and stopped emitting (or terminated).Verifies rule: 3.12
The test is not executed if
maxElementsFromPublisher()is less than 20.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
- Specified by:
required_spec312_cancelMustMakeThePublisherToEventuallyStopSignalingin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriber
public void required_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriber() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3) requests and consumes one element from it, cancels theSubscription, callsSystem.gc()and then checks if all references to the testSubscriberhas been dropped (by checking theWeakReferencehas been emptied).Verifies rule: 3.13
The test is not executed if
maxElementsFromPublisher()is less than 3.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
- the
Publisherstores theSubscriberreference somewhere which is then not cleaned up when theSubscriberis cancelled. Note that this may happen on many code paths in aPublisher, for example in an emission loop that terminates because of thecancelsignal or because reaching a terminal state. Note also that eagerly nullingSubscriberreferences may not be necessary for this test to pass in case there is a self-contained chain of them (i.e.,Publisher.subscribe()creates a chain of freshSubscriberinstances where each of them only references their downstreamSubscriberthus the chain can get GC'd when the reference to the finalSubscriberis dropped).
- Specified by:
required_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriberin interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec317_mustSupportAPendingElementCountUpToLongMaxValue
public void required_spec317_mustSupportAPendingElementCountUpToLongMaxValue() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3) and requestsLong.MAX_VALUEfrom it, verifying that thePublisheremits all of its items and completes normally and does not keep spinning attempting to fulfill theLong.MAX_VALUEdemand by some means.Verifies rule: 3.17
The test is not executed if
maxElementsFromPublisher()is less than 3.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
required_spec317_mustSupportAPendingElementCountUpToLongMaxValuein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValue
public void required_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValue() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a shortPublisher(length 3) and requestsLong.MAX_VALUEfrom it in total (split across twoLong.MAX_VALUE / 2and onerequest(1)), verifying that thePublisheremits all of its items and completes normally.Verifies rule: 3.17
The test is not executed if
maxElementsFromPublisher()is less than 3.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherimplements adding individual request amounts together properly (not overflowing into zero or negative pending request amounts) or not properly deducing the number of emitted items from the pending amount, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
required_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValuein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue
public void required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue() throws java.lang.Throwable
Description copied from interface:PublisherVerificationRulesAsks for a very longPublisher(up toInteger.MAX_VALUE), requestsLong.MAX_VALUE - 1after each received item and expects no failure due to a potential overflow in the pending emission count while consuming 10 items and cancelling the sequence.Verifies rule: 3.17
The test is not executed if
maxElementsFromPublisher()is less thanInteger.MAX_VALUE.The request pattern is one
request(1)upfront and tenrequest(Long.MAX_VALUE - 1)after.If this test fails, the following could be checked within the
Publisherimplementation:- the
TestEnvironmenthas large enough timeout specified in case thePublisherhas some time-delay behavior, - make sure the
PublisherVerificationRules.required_createPublisher1MustProduceAStreamOfExactly1Element()andPublisherVerificationRules.required_createPublisher3MustProduceAStreamOfExactly3Elements()tests pass, - if the
Publisherimplementation considers the cumulative request amount it receives, - if the
Publisherimplements adding individual request amounts together properly (not overflowing into zero or negative pending request amounts) or not properly deducing the number of emitted items from the pending amount, - if the
Publisherdoesn't lose anyrequest()signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
- Specified by:
required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValuein interfacePublisherVerificationRules- Throws:
java.lang.Throwable
- the
-
activePublisherTest
public void activePublisherTest(long elements, boolean completionSignalRequired, PublisherVerification.PublisherTestRun<T> body) throws java.lang.Throwable
Test for feature that SHOULD/MUST be implemented, using a live publisher.- Parameters:
elements- the number of elements the Publisher under test must be able to emit to run this testcompletionSignalRequired- true if anonCompletesignal is required by this test to run. If the tested Publisher is unable to signal completion, tests requireing onComplete signals will be skipped. To signal if your Publisher is able to signal completion seemaxElementsFromPublisher().- Throws:
java.lang.Throwable
-
optionalActivePublisherTest
public void optionalActivePublisherTest(long elements, boolean completionSignalRequired, PublisherVerification.PublisherTestRun<T> body) throws java.lang.Throwable
Test for feature that MAY be implemented. This test will be marked as SKIPPED if it fails.- Parameters:
elements- the number of elements the Publisher under test must be able to emit to run this testcompletionSignalRequired- true if anonCompletesignal is required by this test to run. If the tested Publisher is unable to signal completion, tests requireing onComplete signals will be skipped. To signal if your Publisher is able to signal completion seemaxElementsFromPublisher().- Throws:
java.lang.Throwable
-
whenHasErrorPublisherTest
public void whenHasErrorPublisherTest(PublisherVerification.PublisherTestRun<T> body) throws java.lang.Throwable
Additional test for Publisher in error state- Throws:
java.lang.Throwable
-
potentiallyPendingTest
public void potentiallyPendingTest(org.reactivestreams.Publisher<T> pub, PublisherVerification.PublisherTestRun<T> body) throws java.lang.Throwable
- Throws:
java.lang.Throwable
-
potentiallyPendingTest
public void potentiallyPendingTest(org.reactivestreams.Publisher<T> pub, PublisherVerification.PublisherTestRun<T> body, java.lang.String message) throws java.lang.Throwable
- Throws:
java.lang.Throwable
-
stochasticTest
public void stochasticTest(int n, Function<java.lang.Integer,java.lang.Void> body) throws java.lang.Throwable
Executes a given test bodyntimes. All the test runs must pass in order for the stochastic test to pass.- Throws:
java.lang.Throwable
-
notVerified
public void notVerified()
-
publisherUnableToSignalOnComplete
public long publisherUnableToSignalOnComplete()
Return this value frommaxElementsFromPublisher()to mark that the givenPublisher, is not able to signal completion. For example it is strictly a time-bound or unbounded source of data. Returning this value frommaxElementsFromPublisher()will result in skipping all TCK tests which require onComplete signals!
-
notVerified
public void notVerified(java.lang.String message)
-
-