lhotari commented on code in PR #19376: URL: https://github.com/apache/pulsar/pull/19376#discussion_r1092825923
########## pulsar-broker/src/test/java/org/apache/pulsar/broker/testcontext/PulsarTestContext.java: ########## @@ -66,7 +66,58 @@ import org.apache.zookeeper.MockZooKeeperSession; import org.apache.zookeeper.data.ACL; import org.jetbrains.annotations.NotNull; +import org.mockito.Mockito; +import org.mockito.internal.util.MockUtil; +/** + * A test context that can be used to set up a Pulsar broker and associated resources. + * + * There are 2 types of Pulsar unit tests that use a PulsarService: + * <ul> + * <li>Some Pulsar unit tests use a PulsarService that isn't started</li> + * <li>Some Pulsar unit tests start the PulsarService and use less mocking</li> + * </ul> + * + * This class can be used to set up a PulsarService that can be used in both types of tests. + * + * There are few motivations for PulsarTestContext: + * <ul> + * <li>It reduces the reliance on Mockito for hooking into the PulsarService for injecting mocks or customizing the behavior of some + * collaborators. Mockito is not thread-safe and some mocking operations get corrupted. Some examples of the issuess: https://github.com/apache/pulsar/issues/13620, https://github.com/apache/pulsar/issues/16444 and https://github.com/apache/pulsar/issues/16427.</li> + * <li>Since the Mockito issue causes test flakiness, this change will improve reliability.</li> + * <li>It makes it possible to use composition over inheritance in test classes. This can help reduce the dependency on + * deep test base cases hierarchies.</li> + * <li>It reduces code duplication across test classes.</li> + * <li>Previous tests were using SameThreadOrderedExecutor for PulsarService's orderedExecutor. The reason is unknown. Executing in the same thread could hide real concurrency issues.</li> + * </ul> + * + * <h2>Example usage of a PulsarService that is started</h2> + * <pre>{@code + * PulsarTestContext testContext = PulsarTestContext.startableBuilder() Review Comment: That's for catching that. I did a last minute renaming of the methods. (builder for the "startable" PulsarService should be the recommended usage) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
