Skip to content

[fix][ci] Fix tests memory leak due to mockito-inline #15513

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
nicoloboschi merged 1 commit into from
Jun 3, 2022
Merged

[fix][ci] Fix tests memory leak due to mockito-inline #15513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions buildtools/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<guava.version>31.0.1-jre</guava.version>
<ant.version>1.10.12</ant.version>
<snakeyaml.version>1.30</snakeyaml.version>
<mockito.version>3.12.4</mockito.version>
<!-- required for running tests on JDK11+ -->
<test.additional.args>
--add-opens java.base/jdk.internal.loader=ALL-UNNAMED
Expand Down Expand Up @@ -141,6 +142,16 @@
<version>4.1.76.Final</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>${mockito.version}</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-inline</artifactId>
<version>${mockito.version}</version>
</dependency>
</dependencies>

<build>
Expand Down
19 changes: 16 additions & 3 deletions buildtools/src/main/java/org/apache/pulsar/tests/MockitoCleanupListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
*/
package org.apache.pulsar.tests;

import org.mockito.Mockito;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -36,10 +37,22 @@ public class MockitoCleanupListener extends BetweenTestClassesListenerAdapter {

@Override
protected void onBetweenTestClasses(Class<?> endedTestClass, Class<?> startedTestClass) {
if (MOCKITO_CLEANUP_ENABLED && MockitoThreadLocalStateCleaner.INSTANCE.isEnabled()) {
LOG.info("Cleaning up Mockito's ThreadSafeMockingProgress.MOCKING_PROGRESS_PROVIDER thread local state.");
MockitoThreadLocalStateCleaner.INSTANCE.cleanup();
if (MOCKITO_CLEANUP_ENABLED) {
if (MockitoThreadLocalStateCleaner.INSTANCE.isEnabled()) {
LOG.info("Cleaning up Mockito's ThreadSafeMockingProgress.MOCKING_PROGRESS_PROVIDER thread local state.");
MockitoThreadLocalStateCleaner.INSTANCE.cleanup();
}
cleanupMockitoInline();
}
}

/**
* Mockito-inline can leak mocked objects, we need to clean up the inline mocks after every test.
* See <a href="https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Mockito.html#47"}>
* mockito docs</a>.
*/
private void cleanupMockitoInline() {
Mockito.framework().clearInlineMocks();
}

}