-
Notifications
You must be signed in to change notification settings - Fork 534
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.
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
Clarification on Whitebox subscriber verification #236
Comments
Since the TCK is aimed at testing real implementations, they'll probably be doing something with the received data (emit it somewhere, write it to a file, drop it, ...), this is what is meant by "normal subscribe work". Basically it boils down to: You should not write a subscriber just for the sake of "I have a subscriber which passes the TCK", and then have completely different ones do the actual work in your library :-) If you can, you can adapt an existing implementation by subclassing - calling the probe methods where needed (see tck/README.md for an example) and call super so that it actually performs the work you're testing. If you can't subclass, perhaps delegating to the tested subscriber would work... it's dependent on what hooks your impl has and if it's async / sync etc. Hope this helps |
Thanks, I got that I should subclass my Subscriber method by looking at the example in the README. However that example does not call super class implementation, and I can't infer from that whether the probe should be called before or after the call to the super class. |
(I think it would be helpful to edit the example in the README so it actually calls the super class methods) |
I'm not sure we will be able to give an universal recipe for this... Feels like the exact "where" are implementation specific. They may be doing weird async things in there etc. |
I don't think we need a universal recipe here. Just want to know what I should be doing in the case that the Subscriber class is easily subclassable, like ours is (and many others will be). |
Yeap, agree on that one :-) |
Can this be closed or does something need to be answered/fixed? |
Not yet, the PR fixing this precise question is not in yet - hoping to get it in today. |
Awesome, thanks Konrad |
And the PR came into existence! #244 |
+tck #236 example subscriber whitebox tested, and whitebox fixed
* Repairs formatting issue of tables in spec README * Modifies rules 1.09 and 2.13 to mandate `java.lang.NullPointerException` be thrown. Updates the TCK, Spec and example implementations. * Fixes reactive-streams#211 by clarifying * Fixes reactive-streams#210 by removing 1.12 and repurposing its TCK checks for 1.09 * Clarifies the signalling sequence in the spec and adds TCK verification to ensure signal ordering is proper, also amends the examples to reflect the spec change. * Publish 1.0.0.RC2 fix reactive-streams#215 * Fixes reactive-streams#217 by including the examples project in the publish task * =tck minor test name fixup, it is a required test * fix reactive-streams#212 issue on spec 213 testing wrt Processor * RC3 release /w reactive-streams#222 fix * remove rule 1:12 (produce same elements to all Subscribers) This rule is in conflict with 1:11 which allows a Publisher to treat multiple Subscribers as either as unicast or multicast recipients. The verification of proper multicast behavior (which 1:12 specified) has been retained, the test methods renamed accordingly. * fix three left-over references to deleted rule 1:12 * Fixed wrong footnote reference in README.md * Addresses a couple of typos in the examples for AsyncSubscriber and SyncSubscriber * !TCK clarify what error publisher is + add better readme on what this method is + add better javadoc on this method - removes reference to old style spec annotation from readme + proposing to change method name to "createFailed..." as it is the wording used in the spec and reactive manifesto (footnote 1.1) + more info in tck/README that it is not legal to signal on* before sub Resolves reactive-streams#237, reactive-streams#235 * +tck reactive-streams#236 example subscriber whitebox tested, and whitebox fixed * add space to javadoc * +TCK verifyNoAsyncErrors now by default waits, fixes spec111 Resolves reactive-streams#239 * =tck general tck/readme.md cleanup so it matches current code / spec Resolves reactive-streams#99 Depends on reactive-streams#241 * Addresses PR review comments for reactive-streams#246 * Update CopyrightWaivers.txt * +tck explains createElement in more useful terms resolves reactive-streams#231 * +tck reactive-streams#232 explain which tests are mendatory to be "compliant" * Update SubscriberWhiteboxVerification.java Fixes Javadoc generation on Java8+ by having to manually qualify nested classes. * Fixes reactive-streams#233 by implementing support for triggered demand in in the SubscriberBlackboxVerification * Travis PR validation using both JDK 6 and 8 By validating on both JDKs we know the project even builds on 8, while not using features (classes) from JDK8 - so it's still usable for JDK6 projects. Resolves reactive-streams#254 * Small touchups to the TCK README.md * Release 1.0.0.RC4 * Cancel the subscription after receiving all of the pertinent emissions (reactive-streams#259). * Test that 'required_spec317_mustNotSignalOnErrorWhenPendingAboveLongMaxValue' completes in a timely manner for fully synchronous publishers (reactive-streams#259). * =tck untested spec308 rule method name adjusted * -tck rm undocumented and unused publisherReferenceGCTimeoutMillis method * update version to 1.0.0.RC5 * Updating documentation to reflect the current version: RC5 * update ref to 1.0.0.final * change 1.0.0.final to 1.0.0 and make sure OSGI manifest has the bundle version * OSGI fix * OSGI fix... * Disambiguate "processing elements" The document generally refers to "elements" as objects traversing a stream. I initially considered simply editing "processing elements" to read "processing components", but there's a section devoted to the definition of this, so better to link them. * Added per request of @viktorklang in reactive-streams#269 * add CC0 label to README * =tck reactive-streams#279 improve completion latch error message * Rename SyncSybscriber.foreach to whenNext * Update README.md Spelling of the company name is Red Hat, not RedHat. * I hereby represent [...] public domain [...] entirety of my contributions. Requested by @viktorklang. * Log test output events to the console * Remove "preview" qualifier from README. * Unbreaks TravisCI OpenJDK6 hostname too long crash * Second attempt at unbreaking the Travis build * Third attempt at fixing the Travis builds * +tck reactive-streams#308 allow configuring "no events during N time" separately * Update to Gradle 2.12 * Reintegrate dangling footnote in Publisher section. - integrate the footnote in rule 1.9 - sign the Copyright Statement * Asynchronous vs Synchronous Processing: reword "push-based stream" * =tck fixes minor misalignment between code and comment, found via .NET port Semantics remain exacly the same, the error we're testing here is about signaling one more element if request comes in again (which we'll do anyway, regardless of status of this flag) * adjust Subscription.cancel javadoc because cancel command does not have to be called asynchronously * Updating Typesafe to Lightbend * Fix a typo in org.reactivestreams.example.unicast.AsyncSubscriber * Add @seratch to CopyrightWaivers.txt * Fixes reactive-streams#333 by adding license headers to /examples/* * Adds a Glossary, Intent-sections and harmonizes verbiage * Clarifying that object equality is a.equals(b) in Intent for 2.12 * add license header to API directory * add license header to TCK * Fix missing cancel() from in tests that don't consume the entire source * Run with default TestEnvironment settings. * Update CopyrightWaivers.txt * =build reactive-streams#349 equal osgi manifest version as real version To have a tangible PR to talk about. Probably enough to resolve reactive-streams#349 Would be followed up with change to 1.0.1 eventually. * Add Javadoc explanation to the TCK test methods about what they do * Don't import org.reactivestreams.tck.TestEnvironment * Fix missing Javadoc tags * TCK: Request -1 in 309 instead of a random non-positive number * Remove the Random instance as well. * Keep the randomness. * Fixing typos in README.md * Minor rewording of 2.6 to make it easier to understand. (reactive-streams#342) * Minor rewording of 2.6 to make it easier to understand. * Fix spelling errors and clarify a couple of sentences * extra coordination * Remove vague statements, be more specific in others * Update javadoc based on ktoso's feedback * Use the wording eagery for error publisher test 104 * Address feedback, add links to the rules in the javadoc * SubscriberBlackboxVerificationRules explained * Non-BC for TCK: Corrects a typo in test method from *Compuatation to *Computation * Adding a glossary item for external synchronization * Repointing links to sources in README to current main release * =tck reactive-streams#362 signal onComplete in 201 blackbox verification * +tck reactive-streams#362 complete subscriber under test once done in 205 * +tck reactive-streams#362 wait for request signal in 209, and new additional tests * =tck check isCancelled in 205 blackbox; sample the state sometimes * =tck reactive-streams#362 blackbox 209 must issue onSubscribe before any other signal * Clarifies the meaning of "stochastic" for skipStochasticTests() * add additional test for optional_spec111. * now test verifies https://github.com/reactive-streams/reactive-streams-jvm#1.11 and https://github.com/reactive-streams/reactive-streams-jvm#1.5 for publishers, if they support multiple subscribers. * add delegate to IdentityProcessorVerification. * add tests for optional_spec111_registeredSubscribersMustReceiveOnNextOrOnCompleteSignals. * additional happy and the failure cases. * clear typos and change comments. * add new PublisherVerification for multi-subscribers tests. * removed onSubscribe constructor call. renamed Demand -> CancelableSubscription. * Change subscription remove logic. * add myself to CopyrightWaivers. * fix tests by using proxied subscriber, thanks Viktor for helping push this fix * Be consistent in reference style We use the `#.##` style in referring to rules everywhere, this one ref was using a different style - fixed that. * Switching to consistent use of apostrophe in spec * More apostrophe fixes * add patriknw to CopyrightWaivers * Version 1.0.1 * =spec reactive-streams#384 amend spec to allow not mentioning rule number in exception message * Update README.md * =tck reactive-streams#384 dont check for cause message when checking 3.9 * Updating versions to 1.0.1-RC2 and clarifying changes in RELEASE-NOTES.md * Fix links to "Terminal state" (reactive-streams#389) * Fix links to "Terminal state" * add angelsanz to CopyrightWaivers.txt * Preparing 1.0.1 (reactive-streams#390) * Bridge between Reactive-Streams and JDK 9 Flow API (reactive-streams#296) * Bridge between Reactive-Streams and JDK 9 Flow API * Apply changes based on ktoso's feedback * Use oraclejdk9, resolve build.gradle conflict * Change txt/code to use "Reactive Streams" as designator * NPE to use the updated parameter name. * Rename bridge class, tester class (+javadoc) * Java 9 Flow bridge: add Subscriber converters (reactive-streams#399) * Java 9 Flow bridge: add Subscriber converters * Fix return type javadoc * Example synchronous range Publisher (reactive-streams#395) * Example synchronous range Publisher * Udpated with rule numbers in comments * Mentioning rule 3.9 again in emit() * Move classes to the unicast package. * [WIP] TCK for j.u.c.Flow types "directly" (reactive-streams#398) * Add JDK9 TCK, using adapters * Fixing wrapping and unwrapping of the wrappers themselves. * Renames the converters to "toX" for RS and "toFlowX" for Flow. Fixes so that the dist url for gradle is http iso https (TravisCI bug?) Adds regression test for bridge converters. * fix formatting * cleanup
I am attempting to implement Whitebox subscriber verification as explained in the docs, but I am unsure what I supposed to do in the createSubscriber() method.
I understand that this should return an instance of my subscriber class, but with the methods overridden to call the probe, but I do not understand what "in addition to normal Subscriber work that you're testing," means.
Does this mean I should call the super class method first before calling the probe, or perhaps I should call the super class method after I call the probe, or perhaps something else?
Any clarification on what is expected by the TCK here would be greatly appreciated :)
The text was updated successfully, but these errors were encountered: