diff --git a/tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java b/tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java index 617e0673..05b5ccee 100644 --- a/tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java +++ b/tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java @@ -204,7 +204,6 @@ public void required_validate_boundedDepthOfOnNextAndRequestRecursion() throws E ////////////////////// SPEC RULE VERIFICATION /////////////////////////////// - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.1 @Override @Test public void required_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElements() throws Throwable { activePublisherTest(5, false, new PublisherTestRun() { @@ -227,7 +226,6 @@ public void run(Publisher pub) throws InterruptedException { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.2 @Override @Test public void required_spec102_maySignalLessThanRequestedAndTerminateSubscription() throws Throwable { final int elements = 3; @@ -244,7 +242,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.3 @Override @Test public void stochastic_spec103_mustSignalOnMethodsSequentially() throws Throwable { final int iterations = 100; @@ -353,7 +350,6 @@ public void onComplete() { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.4 @Override @Test public void optional_spec104_mustSignalOnErrorWhenFails() throws Throwable { try { @@ -391,7 +387,6 @@ public void onError(Throwable cause) { } } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.5 @Override @Test public void required_spec105_mustSignalOnCompleteWhenFiniteStreamTerminates() throws Throwable { activePublisherTest(3, true, new PublisherTestRun() { @@ -407,7 +402,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.5 @Override @Test public void optional_spec105_emptyStreamMustTerminateBySignallingOnComplete() throws Throwable { optionalActivePublisherTest(0, true, new PublisherTestRun() { @@ -421,13 +415,11 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.6 @Override @Test public void untested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalled() throws Throwable { notVerified(); // not really testable without more control over the Publisher } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.7 @Override @Test public void required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled() throws Throwable { activePublisherTest(1, true, new PublisherTestRun() { @@ -444,25 +436,21 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.7 @Override @Test public void untested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalled() throws Throwable { notVerified(); // can we meaningfully test this, without more control over the publisher? } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.8 @Override @Test public void untested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignals() throws Throwable { notVerified(); // can we meaningfully test this? } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.9 @Override @Test public void untested_spec109_subscribeShouldNotThrowNonFatalThrowable() throws Throwable { notVerified(); // can we meaningfully test this? } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.9 @Override @Test public void required_spec109_subscribeThrowNPEOnNullSubscriber() throws Throwable { activePublisherTest(0, false, new PublisherTestRun() { @@ -479,7 +467,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.9 @Override @Test public void required_spec109_mustIssueOnSubscribeForNonNullSubscriber() throws Throwable { activePublisherTest(0, false, new PublisherTestRun() { @@ -514,7 +501,6 @@ public void onComplete() { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.9 @Override @Test public void required_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribe() throws Throwable { whenHasErrorPublisherTest(new PublisherTestRun() { @@ -545,7 +531,6 @@ public void onSubscribe(Subscription subs) { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.10 @Override @Test public void untested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwice() throws Throwable { notVerified(); // can we meaningfully test this? @@ -565,7 +550,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.11 @Override @Test public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOne() throws Throwable { optionalActivePublisherTest(5, true, new PublisherTestRun() { // This test is skipped if the publisher is unbounded (never sends onComplete) @@ -616,7 +600,6 @@ public void run(Publisher pub) throws InterruptedException { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.11 @Override @Test public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfront() throws Throwable { optionalActivePublisherTest(3, false, new PublisherTestRun() { // This test is skipped if the publisher cannot produce enough elements @@ -649,7 +632,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#1.11 @Override @Test public void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpected() throws Throwable { optionalActivePublisherTest(3, true, new PublisherTestRun() { // This test is skipped if the publisher is unbounded (never sends onComplete) @@ -685,7 +667,6 @@ public void run(Publisher pub) throws Throwable { ///////////////////// SUBSCRIPTION TESTS ////////////////////////////////// - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.2 @Override @Test public void required_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribe() throws Throwable { activePublisherTest(6, false, new PublisherTestRun() { @@ -715,7 +696,6 @@ public void onNext(T element) { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.3 @Override @Test public void required_spec303_mustNotAllowUnboundedRecursion() throws Throwable { final long oneMoreThanBoundedLimit = boundedDepthOfOnNextAndRequestRecursion() + 1; @@ -798,19 +778,16 @@ public void onError(Throwable cause) { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.4 @Override @Test public void untested_spec304_requestShouldNotPerformHeavyComputations() throws Exception { notVerified(); // cannot be meaningfully tested, or can it? } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.5 @Override @Test public void untested_spec305_cancelMustNotSynchronouslyPerformHeavyCompuatation() throws Exception { notVerified(); // cannot be meaningfully tested, or can it? } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.6 @Override @Test public void required_spec306_afterSubscriptionIsCancelledRequestMustBeNops() throws Throwable { activePublisherTest(3, false, new PublisherTestRun() { @@ -844,7 +821,6 @@ public void cancel() { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.7 @Override @Test public void required_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNops() throws Throwable { activePublisherTest(1, false, new PublisherTestRun() { @@ -865,7 +841,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.9 @Override @Test public void required_spec309_requestZeroMustSignalIllegalArgumentException() throws Throwable { activePublisherTest(10, false, new PublisherTestRun() { @@ -877,7 +852,6 @@ public void required_spec309_requestZeroMustSignalIllegalArgumentException() thr }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.9 @Override @Test public void required_spec309_requestNegativeNumberMustSignalIllegalArgumentException() throws Throwable { activePublisherTest(10, false, new PublisherTestRun() { @@ -891,7 +865,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.12 @Override @Test public void required_spec312_cancelMustMakeThePublisherToEventuallyStopSignaling() throws Throwable { // the publisher is able to signal more elements than the subscriber will be requesting in total @@ -954,7 +927,6 @@ > AsyncPublisher receives cancel() - handles it right away, by "stopping itself" env.verifyNoAsyncErrorsNoDelay(); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.13 @Override @Test public void required_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriber() throws Throwable { final ReferenceQueue> queue = new ReferenceQueue>(); @@ -992,7 +964,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.17 @Override @Test public void required_spec317_mustSupportAPendingElementCountUpToLongMaxValue() throws Throwable { final int totalElements = 3; @@ -1011,7 +982,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.17 @Override @Test public void required_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValue() throws Throwable { final int totalElements = 3; @@ -1037,7 +1007,6 @@ public void run(Publisher pub) throws Throwable { }); } - // Verifies rule: https://github.com/reactive-streams/reactive-streams-jvm#3.17 @Override @Test public void required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue() throws Throwable { activePublisherTest(Integer.MAX_VALUE, false, new PublisherTestRun() { diff --git a/tck/src/main/java/org/reactivestreams/tck/support/PublisherVerificationRules.java b/tck/src/main/java/org/reactivestreams/tck/support/PublisherVerificationRules.java index 5a3116bd..392c184d 100644 --- a/tck/src/main/java/org/reactivestreams/tck/support/PublisherVerificationRules.java +++ b/tck/src/main/java/org/reactivestreams/tck/support/PublisherVerificationRules.java @@ -11,46 +11,597 @@ package org.reactivestreams.tck.support; - /** * Internal TCK use only. * Add / Remove tests for PublisherVerification here to make sure that they arre added/removed in the other places. */ public interface PublisherVerificationRules { + /** + * Validates that the override of {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} + * returns a non-negative value. + */ void required_validate_maxElementsFromPublisher() throws Exception; + /** + * Validates that the override of {@link org.reactivestreams.tck.PublisherVerification#boundedDepthOfOnNextAndRequestRecursion()} + * returns a positive value. + */ void required_validate_boundedDepthOfOnNextAndRequestRecursion() throws Exception; + /** + * Asks for a {@code Publisher} that should emit exactly one item and complete (both within a + * timeout specified by {@link org.reactivestreams.tck.TestEnvironment#defaultTimeoutMillis()}) + * in response to a request(1). + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} returns zero. + * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code Publisher.subscribe(Subscriber)} method has actual implementation,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, if there is an upstream {@code Publisher}, + * that {@code Publisher} is actually subscribed to,
    • + *
  • if the {@code Publisher} is part of a chain, all elements actually issue a {@code request()} call + * in response to the test subscriber or by default to their upstream,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, the {@code Subscriber.onSubscribe} is called + * as part of the preparation process (usually before subscribing to other {@code Publisher}s),
    • + *
  • if the {@code Publisher} implementation works for a consumer that calls {@code request(1)},
    • + *
  • if the {@code Publisher} implementation is able to emit an {@code onComplete} without requests,
    • + *
  • that the {@code Publisher} implementation does not emit more than the allowed elements (exactly one).
    • + *
+ */ void required_createPublisher1MustProduceAStreamOfExactly1Element() throws Throwable; + /** + * Asks for a {@code Publisher} that should emit exactly three items and complete (all within a + * timeout specified by {@link org.reactivestreams.tck.TestEnvironment#defaultTimeoutMillis()}). + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#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 {@code Publisher} implementation: + *

    + *
  • the {@code Publisher.subscribe(Subscriber)} method has actual implementation,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, if there is an upstream {@code Publisher}, + * that {@code Publisher} is actually subscribed to,
    • + *
  • if the {@code Publisher} is part of a chain, all elements actually issue a {@code request()} call + * in response to the test subscriber or by default to their upstream,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, the {@code Subscriber.onSubscribe} is called + * as part of the preparation process (usually before subscribing to other {@code Publisher}s),
    • + *
  • if the {@code Publisher} implementation works for a subscriber that calls {@code request(1)} after consuming an item,
    • + *
  • if the {@code Publisher} implementation is able to emit an {@code onComplete} without requests.
    • + *
+ */ void required_createPublisher3MustProduceAStreamOfExactly3Elements() throws Throwable; + /** + * Asks for a {@code Publisher} that 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 5. + *

+ * This test ensures that the {@code Publisher} implementation correctly responds to {@code request()} calls that in + * total are less than the number of elements this {@code Publisher} could emit (thus the completion event won't be emitted). + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void required_spec101_subscriptionRequestMustResultInTheCorrectNumberOfProducedElements() throws Throwable; + /** + * Asks for a short {@code Publisher} and 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 an {@code onComplete} signal. + *

+ * Verifies rule: 1.2 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * This test ensures that the {@code Publisher} implementation can deal with larger requests than the number of items it can produce. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass.
    • + *
+ */ void required_spec102_maySignalLessThanRequestedAndTerminateSubscription() throws Throwable; + /** + * Asks for a short {@code Publisher} (i.e., length 10), repeatedly subscribes to this {@code Publisher}, requests items + * one by one and verifies the {@code Publisher} calls the {@code onXXX} methods non-overlappingly. + *

+ * Verifies rule: 1.3 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#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 {@code request()} call in {@code onSubscribe()} triggers an asynchronous + * call to the other {@code onXXX} methods. In contrast, the test allows synchronous call chain of + * {@code onSubscribe -> request -> onNext}. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if a {@code request()} call from {@code onSubscribe()} could trigger an asynchronous call to {@code onNext()} and if so, make sure + * such {@code request()} calls are deferred until the call to {@code onSubscribe()} returns normally.
    • + *
+ */ void stochastic_spec103_mustSignalOnMethodsSequentially() throws Throwable; + /** + * Asks for an error {@code Publisher} that should call {@code onSubscribe} exactly once + * followed by a single call to {@code onError()} without receiving any requests and otherwise + * not throwing any exception. + *

+ * Verifies rule: 1.4 + *

+ * The test is not executed if {@code PublisherVerification.createErrorPublisher()} returns null. + *

+ * If this test fails, the following could be checked within the error {@code Publisher} implementation: + *

    + *
  • the {@code Publisher.subscribe(Subscriber)} method has actual implementation,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, if there is an upstream {@code Publisher}, + * that {@code Publisher} is actually subscribed to,
    • + *
  • if the {@code Publisher} implementation does signal an {@code onSubscribe} before signalling {@code onError},
    • + *
  • if the {@code Publisher} implementation is able to emit an {@code onError} without requests,
    • + *
  • if the {@code Publisher} is non-empty as this test requires a {@code Publisher} to signal an + * {@code onError} eagerly.
    • + *
+ */ void optional_spec104_mustSignalOnErrorWhenFails() throws Throwable; + /** + * Asks for a short {@code Publisher} (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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * Note that the tests requests 1 after the items have been received and before expecting an {@code onComplete} signal. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
+ */ void required_spec105_mustSignalOnCompleteWhenFiniteStreamTerminates() throws Throwable; + /** + * Asks for an empty {@code Publisher} (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 {@code onComplete} signal. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • if the {@code Publisher} is non-empty as this test requires a {@code Publisher} without items.
    • + *
+ */ void optional_spec105_emptyStreamMustTerminateBySignallingOnComplete() throws Throwable; + /** + * Currently, this test is skipped because it is unclear this rule can be effectively checked + * on a {@code Publisher} instance without looking into or hooking into the implementation of it. + *

+ * Verifies rule: 1.6 + */ void untested_spec106_mustConsiderSubscriptionCancelledAfterOnErrorOrOnCompleteHasBeenCalled() throws Throwable; + /** + * Asks for a single-element {@code Publisher} and 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 1. + *

+ * The tests requests more items than the expected {@code Publisher} length upfront and some more items after its completion. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has 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.
    • + *
+ */ void required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled() throws Throwable; + /** + * Currently, this test is skipped, although it is possible to validate an error {@code Publisher} along + * the same lines as {@link #required_spec107_mustNotEmitFurtherSignalsOnceOnCompleteHasBeenSignalled()}. + *

+ * Verifies rule: 1.7 + */ void untested_spec107_mustNotEmitFurtherSignalsOnceOnErrorHasBeenSignalled() throws Throwable; + /** + * Currently, this test is skipped because there was no agreement on how to verify its "eventually" requirement. + *

+ * Verifies rule: 1.8 + */ void untested_spec108_possiblyCanceledSubscriptionShouldNotReceiveOnErrorOrOnCompleteSignals() throws Throwable; + /** + * Asks for an empty {@code Publisher} and verifies if {@code onSubscribe} signal was emitted before + * any other {@code onNext}, {@code onError} or {@code onComplete} signal. + *

+ * Verifies rule: 1.9 + *

+ * Note that this test doesn't request anything, however, an {@code onNext} is not considered as a failure. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • the {@code Publisher.subscribe(Subscriber)} method has actual implementation,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, if there is an upstream {@code Publisher}, + * that {@code Publisher} is actually subscribed to,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, the {@code Subscriber.onSubscribe} is called + * as part of the preparation process (usually before subscribing to other {@code Publisher}s).
    • + *
+ */ void required_spec109_mustIssueOnSubscribeForNonNullSubscriber() throws Throwable; + /** + * Currently, this test is skipped because there is no common agreement on what is to be considered a fatal exception and + * besides, {@code Publisher.subscribe} is only allowed throw a {@code NullPointerException} and any other + * exception would require looking into or hooking into the implementation of the {@code Publisher}. + *

+ * Verifies rule: 1.9 + */ void untested_spec109_subscribeShouldNotThrowNonFatalThrowable() throws Throwable; + /** + * Asks for an empty {@code Publisher} and calls {@code subscribe} on it with {@code null} that should result in + * a {@code NullPointerException} to be thrown. + *

+ * Verifies rule: 1.9 + *

+ * If this test fails, check if the {@code subscribe()} implementation has an explicit null check (or a method dereference + * on the {@code Subscriber}), especially if the incoming {@code Subscriber} is wrapped or stored to be used later. + */ void required_spec109_subscribeThrowNPEOnNullSubscriber() throws Throwable; + /** + * Asks for an error {@code Publisher} that should call {@code onSubscribe} exactly once + * followed by a single call to {@code onError()} without receiving any requests. + *

+ * Verifies rule: 1.9 + *

+ * The test is not executed if {@code PublisherVerification.createErrorPublisher()} returns null. + *

+ * The difference between this test and {@link #optional_spec104_mustSignalOnErrorWhenFails()} is that there is + * no explicit verification if exceptions were thrown in addition to the regular {@code onSubscribe+onError} signal pair. + *

+ * If this test fails, the following could be checked within the error {@code Publisher} implementation: + *

    + *
  • the {@code Publisher.subscribe(Subscriber)} method has actual implementation,
    • + *
  • in the {@code Publisher.subscribe(Subscriber)} method, if there is an upstream {@code Publisher}, + * that {@code Publisher} is actually subscribed to,
    • + *
  • if the {@code Publisher} implementation is able to emit an {@code onError} without requests,
    • + *
  • if the {@code Publisher} is non-empty as this test expects a {@code Publisher} without items.
    • + *
+ */ void required_spec109_mayRejectCallsToSubscribeIfPublisherIsUnableOrUnwillingToServeThemRejectionMustTriggerOnErrorAfterOnSubscribe() throws Throwable; + /** + * Currently, this test is skipped because enforcing rule ยง1.10 requires unlimited retention and reference-equal checks on + * all incoming {@code Subscriber} which is generally infeasible, plus reusing the same {@code Subscriber} instance is + * better detected (or ignored) inside {@code Subscriber.onSubscribe} when the method is called multiple times. + *

+ * Verifies rule: 1.10 + */ void untested_spec110_rejectASubscriptionRequestIfTheSameSubscriberSubscribesTwice() throws Throwable; + /** + * Ask for a single-element {@code Publisher} and subscribes to it twice, without consuming with either {@code Subscriber} instance + * (i.e., no requests are issued). + *

+ * Verifies rule: 1.11 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 1. + *

+ * Note that this test ignores what signals the {@code Publisher} emits. Any exception thrown through non-regular + * means will indicate a skipped test. + */ void optional_spec111_maySupportMultiSubscribe() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 5), subscribes 3 {@code Subscriber}s 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 5. + *

+ * The request pattern for the first {@code Subscriber} is (1, 1, 2, 1); for the second is (2, 3) and for the third is (3, 1, 1). + *

+ * Note that this test requires a {@code Publisher} that always emits the same signals to any {@code Subscriber}, regardless of + * when they subscribe and how they request elements. I.e., a "live" {@code Publisher} emitting 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 {@code Publisher}, + * see the skip message for an indication of this. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingOneByOne() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 3), subscribes 3 {@code Subscriber}s 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * Note that this test requires a {@code Publisher} that always emits the same signals to any {@code Subscriber}, regardless of + * when they subscribe and how they request elements. I.e., a "live" {@code Publisher} emitting 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 {@code Publisher}, + * see the skip message for an indication of this. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfront() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 3), subscribes 3 {@code Subscriber}s 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 an {@code onComplete} signal. + *

+ * Verifies rule: 1.11 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * Note that this test requires a {@code Publisher} that always emits the same signals to any {@code Subscriber}, regardless of + * when they subscribe and how they request elements. I.e., a "live" {@code Publisher} emitting 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 {@code Publisher}, + * see the skip message for an indication of this. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void optional_spec111_multicast_mustProduceTheSameElementsInTheSameSequenceToAllOfItsSubscribersWhenRequestingManyUpfrontAndCompleteAsExpected() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 6), requests several times from within {@code onSubscribe} and then requests + * one-by-one from {@code onNext}. + *

+ * Verifies rule: 3.2 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 6. + *

+ * The request pattern is 3 x 1 from within {@code onSubscribe} and one from within each {@code onNext} invocation. + *

+ * The test consumes the {@code Publisher} but otherwise doesn't verify the {@code Publisher} completes (however, it checks + * for errors). + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void required_spec302_mustAllowSynchronousRequestCallsFromOnNextAndOnSubscribe() throws Throwable; + /** + * Asks for a {@code Publisher} with length equal to the value returned by {@link #required_validate_boundedDepthOfOnNextAndRequestRecursion()} plus 1, + * calls {@code request(1)} externally and then from within {@code onNext} and checks if the stack depth did not increase beyond the + * amount permitted by {@link #required_validate_boundedDepthOfOnNextAndRequestRecursion()}. + *

+ * Verifies rule: 3.3 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than + * {@link #required_validate_boundedDepthOfOnNextAndRequestRecursion()} plus 1. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the implementation doesn't allow unbounded recursion when {@code request()} is called from within {@code onNext}, i.e., the lack of + * reentrant-safe state machine around the request amount (such as a for loop with a bound on the parameter {@code n} that calls {@code onNext}). + *
+ */ void required_spec303_mustNotAllowUnboundedRecursion() throws Throwable; + /** + * Currently, this test is skipped because a {@code request} could enter into a synchronous computation via {@code onNext} + * legally and otherwise there is no common agreement how to detect such heavy computation reliably. + *

+ * Verifies rule: 3.4 + */ void untested_spec304_requestShouldNotPerformHeavyComputations() throws Exception; + /** + * Currently, this test is skipped because there is no reliable agreed upon way to detect a heavy computation. + *

+ * Verifies rule: 3.5 + */ void untested_spec305_cancelMustNotSynchronouslyPerformHeavyCompuatation() throws Exception; + /** + * Asks for a short {@code Publisher} (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 {@link org.reactivestreams.tck.PublisherVerification#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 {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
    • + *
+ */ void required_spec306_afterSubscriptionIsCancelledRequestMustBeNops() throws Throwable; + /** + * Asks for a single-element {@code Publisher} and 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 1. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
    • + *
+ */ void required_spec307_afterSubscriptionIsCancelledAdditionalCancelationsMustBeNops() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 10) and issues a {@code request(0)} which should trigger an {@code onError} call + * with an {@code IllegalArgumentException} and the message containing the string "3.9" (reference to the rule number). + *

+ * Verifies rule: 3.9 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 10. + *

+ * Note that this test expects the {@code IllegalArgumentException} being signalled through {@code onError}, not by + * throwing from {@code request()} (which is also forbidden) or signalling the error by any other means (i.e., through the + * {@code Thread.currentThread().getUncaughtExceptionHandler()} for example). + *

+ * Note also that requesting and emission may happen concurrently and honoring this rule may require extra coordination within + * the {@code Publisher}. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the {@code Publisher} can emit an {@code onError} in this particular case, even if there was no prior and legal + * {@code request} call and even if the {@code Publisher} would like to emit items first before emitting an {@code onError} + * in general. + *
+ */ void required_spec309_requestZeroMustSignalIllegalArgumentException() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 10) and issues a random, negative {@code request()} call which should trigger an {@code onError} call + * with an {@code IllegalArgumentException} and the message containing the string "3.9" (reference to the rule number). + *

+ * Verifies rule: 3.9 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 10. + *

+ * Note that this test expects the {@code IllegalArgumentException} being signalled through {@code onError}, not by + * throwing from {@code request()} (which is also forbidden) or signalling the error by any other means (i.e., through the + * {@code Thread.currentThread().getUncaughtExceptionHandler()} for example). + *

+ * Note also that requesting and emission may happen concurrently and honoring this rule may require extra coordination within + * the {@code Publisher}. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the {@code Publisher} can emit an {@code onError} in this particular case, even if there was no prior and legal + * {@code request} call and even if the {@code Publisher} would like to emit items first before emitting an {@code onError} + * in general. + *
+ */ void required_spec309_requestNegativeNumberMustSignalIllegalArgumentException() throws Throwable; + /** + * Asks for a short {@code Publisher} (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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 20. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
    • + *
+ */ void required_spec312_cancelMustMakeThePublisherToEventuallyStopSignaling() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 3) requests and consumes one element from it, cancels the {@code Subscription} + * , calls {@code System.gc()} and then checks if all references to the test {@code Subscriber} has been dropped (by checking + * the {@code WeakReference} has been emptied). + *

+ * Verifies rule: 3.13 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • the cancellation indicator flag is properly persisted (may require volatile) and checked as part of the signal emission process.
    • + *
  • the {@code Publisher} stores the {@code Subscriber} reference somewhere which is then not cleaned up when the {@code Subscriber} is cancelled. + * Note that this may happen on many code paths in a {@code Publisher}, for example in an emission loop that terminates because of the + * {@code cancel} signal or because reaching a terminal state. Note also that eagerly nulling {@code Subscriber} references may not be necessary + * for this test to pass in case there is a self-contained chain of them (i.e., {@code Publisher.subscribe()} creates a chain of fresh + * {@code Subscriber} instances where each of them only references their downstream {@code Subscriber} thus the chain can get GC'd + * when the reference to the final {@code Subscriber} is dropped). + *
+ */ void required_spec313_cancelMustMakeThePublisherEventuallyDropAllReferencesToTheSubscriber() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 3) and requests {@code Long.MAX_VALUE} from it, verifying that the + * {@code Publisher} emits all of its items and completes normally + * and does not keep spinning attempting to fulfill the {@code Long.MAX_VALUE} demand by some means. + *

+ * Verifies rule: 3.17 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void required_spec317_mustSupportAPendingElementCountUpToLongMaxValue() throws Throwable; + /** + * Asks for a short {@code Publisher} (length 3) and requests {@code Long.MAX_VALUE} from it in total (split across + * two {@code Long.MAX_VALUE / 2} and one {@code request(1)}), verifying that the + * {@code Publisher} emits all of its items and completes normally. + *

+ * Verifies rule: 3.17 + *

+ * The test is not executed if {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than 3. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} implements 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 {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void required_spec317_mustSupportACumulativePendingElementCountUpToLongMaxValue() throws Throwable; + /** + * Asks for a very long {@code Publisher} (up to {@code Integer.MAX_VALUE}), requests {@code Long.MAX_VALUE - 1} after + * 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 {@link org.reactivestreams.tck.PublisherVerification#maxElementsFromPublisher()} is less than {@code Integer.MAX_VALUE}. + *

+ * The request pattern is one {@code request(1)} upfront and ten {@code request(Long.MAX_VALUE - 1)} after. + *

+ * If this test fails, the following could be checked within the {@code Publisher} implementation: + *

    + *
  • the {@code TestEnvironment} has large enough timeout specified in case the {@code Publisher} has some time-delay behavior,
    • + *
  • make sure the {@link #required_createPublisher1MustProduceAStreamOfExactly1Element()} and {@link #required_createPublisher3MustProduceAStreamOfExactly3Elements()} tests pass,
    • + *
  • if the {@code Publisher} implementation considers the cumulative request amount it receives,
    • + *
  • if the {@code Publisher} implements 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 {@code Publisher} doesn't lose any {@code request()} signal and the state transition from idle -> emitting or emitting -> keep emitting works properly.
    • + *
+ */ void required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue() throws Throwable; }