Skip to content

Add Javadoc explanation to the TCK test methods about what they do #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 28, 2017
Merged

Add Javadoc explanation to the TCK test methods about what they do #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4e0ce72
Add Javadoc explanation to the TCK test methods about what they do
akarnokd Apr 4, 2017
b3fef0f
Don't import org.reactivestreams.tck.TestEnvironment
akarnokd Apr 4, 2017
8dad5d0
Fix missing Javadoc tags
akarnokd Apr 4, 2017
089af04
Fix spelling errors and clarify a couple of sentences
akarnokd Apr 21, 2017
5c2746a
extra coordination
akarnokd Apr 21, 2017
8dbe718
Remove vague statements, be more specific in others
akarnokd Apr 21, 2017
27cb9a2
Update javadoc based on ktoso's feedback
akarnokd Apr 26, 2017
ec793cc
Use the wording eagery for error publisher test 104
akarnokd Apr 27, 2017
8fa3a27
Address feedback, add links to the rules in the javadoc
akarnokd Apr 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<T>() {
Expand All @@ -227,7 +226,6 @@ public void run(Publisher<T> 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;
Expand All @@ -244,7 +242,6 @@ public void run(Publisher<T> 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;
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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<T>() {
Expand All @@ -407,7 +402,6 @@ public void run(Publisher<T> 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<T>() {
Expand All @@ -421,13 +415,11 @@ public void run(Publisher<T> 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<T>() {
Expand All @@ -444,25 +436,21 @@ public void run(Publisher<T> 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<T>() {
Expand All @@ -479,7 +467,6 @@ public void run(Publisher<T> 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<T>() {
Expand Down Expand Up @@ -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<T>() {
Expand Down Expand Up @@ -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?
Expand All @@ -565,7 +550,6 @@ public void run(Publisher<T> 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<T>() { // This test is skipped if the publisher is unbounded (never sends onComplete)
Expand Down Expand Up @@ -616,7 +600,6 @@ public void run(Publisher<T> 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<T>() { // This test is skipped if the publisher cannot produce enough elements
Expand Down Expand Up @@ -649,7 +632,6 @@ public void run(Publisher<T> 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<T>() { // This test is skipped if the publisher is unbounded (never sends onComplete)
Expand Down Expand Up @@ -685,7 +667,6 @@ public void run(Publisher<T> 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<T>() {
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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<T>() {
Expand Down Expand Up @@ -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<T>() {
Expand All @@ -865,7 +841,6 @@ public void run(Publisher<T> 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<T>() {
Expand All @@ -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<T>() {
Expand All @@ -891,7 +865,6 @@ public void run(Publisher<T> 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
Expand Down Expand Up @@ -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<ManualSubscriber<T>> queue = new ReferenceQueue<ManualSubscriber<T>>();
Expand Down Expand Up @@ -992,7 +964,6 @@ public void run(Publisher<T> 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;
Expand All @@ -1011,7 +982,6 @@ public void run(Publisher<T> 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;
Expand All @@ -1037,7 +1007,6 @@ public void run(Publisher<T> 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<T>() {
Expand Down
Loading