You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/11/01 17:05:17 UTC
[GitHub] [kafka] C0urante commented on a diff in pull request #12728: KAFKA-14132; Replace EasyMock with Mockito in StandaloneHerderTest
C0urante commented on code in PR #12728:
URL: https://github.com/apache/kafka/pull/12728#discussion_r1010676688
##########
connect/runtime/src/test/java/org/apache/kafka/connect/runtime/standalone/StandaloneHerderTest.java:
##########
@@ -123,91 +134,91 @@ private enum SourceSink {
private final ConnectorClientConfigOverridePolicy
noneConnectorClientConfigOverridePolicy = new NoneConnectorClientConfigOverridePolicy();
+ private MockedStatic<Plugins> pluginsStatic;
+
+ private MockedStatic<WorkerConnector> workerConnectorStatic;
@Before
public void setup() {
- worker = PowerMock.createMock(Worker.class);
- String[] methodNames = new String[]{"connectorTypeForClass"/*, "validateConnectorConfig"*/, "buildRestartPlan", "recordRestarting"};
- herder = PowerMock.createPartialMock(StandaloneHerder.class, methodNames,
- worker, WORKER_ID, KAFKA_CLUSTER_ID, statusBackingStore, new MemoryConfigBackingStore(transformer), noneConnectorClientConfigOverridePolicy);
+ worker = mock(Worker.class);
+ herder = mock(StandaloneHerder.class, withSettings()
+ .useConstructor(worker, WORKER_ID, KAFKA_CLUSTER_ID, statusBackingStore, new MemoryConfigBackingStore(transformer), noneConnectorClientConfigOverridePolicy)
+ .defaultAnswer(CALLS_REAL_METHODS));
createCallback = new FutureCallback<>();
- plugins = PowerMock.createMock(Plugins.class);
- pluginLoader = PowerMock.createMock(PluginClassLoader.class);
- delegatingLoader = PowerMock.createMock(DelegatingClassLoader.class);
- PowerMock.mockStatic(Plugins.class);
- PowerMock.mockStatic(WorkerConnector.class);
- Capture<Map<String, String>> configCapture = Capture.newInstance();
- EasyMock.expect(transformer.transform(eq(CONNECTOR_NAME), EasyMock.capture(configCapture))).andAnswer(configCapture::getValue).anyTimes();
+ plugins = mock(Plugins.class);
+ pluginLoader = mock(PluginClassLoader.class);
+ delegatingLoader = mock(DelegatingClassLoader.class);
+ pluginsStatic = mockStatic(Plugins.class);
+ workerConnectorStatic = mockStatic(WorkerConnector.class);
+ final ArgumentCaptor<Map<String, String>> configCapture = ArgumentCaptor.forClass(Map.class);
+ when(transformer.transform(eq(CONNECTOR_NAME), configCapture.capture())).thenAnswer(invocation -> configCapture.getValue());
+ }
+
+ @After
+ public void tearDown() {
+ pluginsStatic.close();
+ workerConnectorStatic.close();
}
@Test
public void testCreateSourceConnector() throws Exception {
- connector = PowerMock.createMock(BogusSourceConnector.class);
+ connector = mock(BogusSourceConnector.class);
expectAdd(SourceSink.SOURCE);
Map<String, String> config = connectorConfig(SourceSink.SOURCE);
- Connector connectorMock = PowerMock.createMock(SourceConnector.class);
+ Connector connectorMock = mock(SourceConnector.class);
expectConfigValidation(connectorMock, true, config);
- PowerMock.replayAll();
-
herder.putConnectorConfig(CONNECTOR_NAME, config, false, createCallback);
Herder.Created<ConnectorInfo> connectorInfo = createCallback.get(1000L, TimeUnit.SECONDS);
assertEquals(createdInfo(SourceSink.SOURCE), connectorInfo.result());
-
- PowerMock.verifyAll();
}
@Test
public void testCreateConnectorFailedValidation() {
// Basic validation should be performed and return an error, but should still evaluate the connector's config
- connector = PowerMock.createMock(BogusSourceConnector.class);
+ connector = mock(BogusSourceConnector.class);
Map<String, String> config = connectorConfig(SourceSink.SOURCE);
config.remove(ConnectorConfig.NAME_CONFIG);
- Connector connectorMock = PowerMock.createMock(SourceConnector.class);
- EasyMock.expect(worker.configTransformer()).andReturn(transformer).times(2);
- final Capture<Map<String, String>> configCapture = EasyMock.newCapture();
- EasyMock.expect(transformer.transform(EasyMock.capture(configCapture))).andAnswer(configCapture::getValue);
- EasyMock.expect(worker.getPlugins()).andReturn(plugins).times(3);
- EasyMock.expect(plugins.compareAndSwapLoaders(connectorMock)).andReturn(delegatingLoader);
- EasyMock.expect(plugins.newConnector(EasyMock.anyString())).andReturn(connectorMock);
+ Connector connectorMock = mock(SourceConnector.class);
+ when(worker.configTransformer()).thenReturn(transformer);
+ final ArgumentCaptor<Map<String, String>> configCapture = ArgumentCaptor.forClass(Map.class);
+ when(transformer.transform(configCapture.capture())).thenAnswer(invocation -> configCapture.getValue());
+ when(worker.getPlugins()).thenReturn(plugins);
+ when(plugins.compareAndSwapLoaders(connectorMock)).thenReturn(delegatingLoader);
+ when(plugins.newConnector(anyString())).thenReturn(connectorMock);
- EasyMock.expect(connectorMock.config()).andStubReturn(new ConfigDef());
+ when(connectorMock.config()).thenReturn(new ConfigDef());
ConfigValue validatedValue = new ConfigValue("foo.bar");
- EasyMock.expect(connectorMock.validate(config)).andReturn(new Config(singletonList(validatedValue)));
- EasyMock.expect(Plugins.compareAndSwapLoaders(delegatingLoader)).andReturn(pluginLoader);
-
- PowerMock.replayAll();
+ when(connectorMock.validate(config)).thenReturn(new Config(singletonList(validatedValue)));
+ when(Plugins.compareAndSwapLoaders(delegatingLoader)).thenReturn(pluginLoader);
Review Comment:
Thanks @mdedetrich. I really appreciate the time you've taken to preserve the guarantees we get from these tests, without introducing other complications like switching the thread's context classloader to a mocked classloader during testing.
I'm still not sure this is safe to merge as-is, though. The `runOnHerderConnectorExecutor` method is fairly brittle, and may not serve our needs in the future if we end up needing to test concurrent connector validations. In addition, it does not prevent classloaders from being swapped out on other threads, such as the main testing thread or ones created and used by the standalone herder's `requestExecutorService`.
These issues are not impossible to work around; however, they would add a fair amount of clutter to our unit tests, and make it harder to read and write new tests in the future.
Instead, I've filed KAFKA-14346 with a proposal that we eliminate these static method-based APIs altogether. This isn't the first time that they've caused significant friction with our unit tests, and it's likely that it won't be the last. Instead of investing more effort in accommodating these APIs with changes to our testing logic, I think it's time to change the APIs to be easier to test.
Are you comfortable with either taking on the work of that ticket yourself, or pausing work on this PR until it has been completed?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org