Skip to content

Add recipe to replace MockitoTestExecutionListener#924

Merged
steve-aom-elliott merged 5 commits intomainfrom
replace-mockito-test-execution-listener
Mar 4, 2026
Merged

Add recipe to replace MockitoTestExecutionListener#924
steve-aom-elliott merged 5 commits intomainfrom
replace-mockito-test-execution-listener

Conversation

@steve-aom-elliott
Copy link
Contributor

@steve-aom-elliott steve-aom-elliott commented Mar 2, 2026

Summary

  • Adds ReplaceMockitoTestExecutionListener recipe that migrates away from @TestExecutionListeners(MockitoTestExecutionListener.class) to the appropriate Mockito initialization for the test framework in use
  • Supports JUnit 5 (@ExtendWith(MockitoExtension.class)), JUnit 4 (@RunWith(MockitoJUnitRunner.class) when no @RunWith exists), and TestNG (MockitoAnnotations.openMocks(this) lifecycle methods)
  • Registered in the Mockito1to3Migration composite recipe

TestNG approach

For TestNG classes (where JUnit's @ExtendWith and @RunWith are not available), the recipe adds MockitoAnnotations.openMocks(this) in a @BeforeMethod lifecycle method with the corresponding close() in @AfterMethod. This is a direct equivalent of what MockitoTestExecutionListener does internally:

  • MockitoTestExecutionListener calls openMocks() under the hood. Decompiling Spring Boot 3.x shows its initMocks() method calls MockitoAnnotations.openMocks(testContext.getTestInstance()) and stores the returned AutoCloseable for cleanup in afterTestMethod(). The recipe produces the same call sequence.

  • TestNG inherits @BeforeMethod/@AfterMethod from parent classes. When the recipe transforms a base class (e.g. BaseTest extends AbstractTestNGSpringContextTests), subclasses with @Mock fields inherit the lifecycle methods automatically. TestNG executes parent @BeforeMethod before child methods, and parent @AfterMethod after child methods.

  • openMocks(this) in a parent class initializes subclass @Mock fields. In Java, this always refers to the actual runtime instance (the subclass), so Mockito's reflection-based field scanning traverses the full class hierarchy and initializes all @Mock-annotated fields regardless of where they are declared.

Test plan

  • 14 unit tests covering JUnit 5, JUnit 4, TestNG, and negative cases
  • Full test suite passes
  • recipeCsvGenerate regenerated and validated

@github-project-automation github-project-automation bot moved this to In Progress in OpenRewrite Mar 2, 2026
@steve-aom-elliott steve-aom-elliott force-pushed the replace-mockito-test-execution-listener branch from 30f5ce0 to e2cd397 Compare March 2, 2026 17:53
…ropriate Mockito initialization

Adds ReplaceMockitoTestExecutionListener recipe that migrates away from
@TestExecutionListeners(MockitoTestExecutionListener.class) to the
appropriate Mockito initialization for the test framework in use:
- JUnit 5: @ExtendWith(MockitoExtension.class)
- JUnit 4: @RunWith(MockitoJUnitRunner.class) when no @RunWith exists
- TestNG: MockitoAnnotations.openMocks(this) lifecycle methods

Registered in the Mockito1to3Migration composite recipe.
- Update copyrights to 2026
- Skip TestNG migration when MockitoAnnotations.openMocks() is already used
- Place field at class top, initMocks before first method, closeMocks at end
- Regenerate recipes.csv
@steve-aom-elliott steve-aom-elliott force-pushed the replace-mockito-test-execution-listener branch from e2cd397 to 911e972 Compare March 2, 2026 19:39
…nMocks

- Replace manual isTestNGType recursion with TypeUtils.isAssignableTo
  for AbstractTestNGSpringContextTests, properly handling full hierarchy
- When openMocks is already present but close() is missing, add
  @AfterMethod closeMocks and still remove @TestExecutionListeners
- When both openMocks and @AfterMethod exist, only remove the annotation
@steve-aom-elliott steve-aom-elliott moved this from In Progress to Ready to Review in OpenRewrite Mar 2, 2026
Replace @Getter with @Value/@EqualsAndHashCode on the recipe class.
Replace hasOpenMocksCall() with MethodAccess.Matcher and
hasAfterMethodAnnotation() with Annotated.Matcher trait patterns.
}

// Check compilation unit imports
J.CompilationUnit cu = getCursor().firstEnclosingOrThrow(J.CompilationUnit.class);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use FindImports here I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just saw these. I'll make another PR quickly


// Check compilation unit imports
J.CompilationUnit cu = getCursor().firstEnclosingOrThrow(J.CompilationUnit.class);
for (J.Import imp : cu.getImports()) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could use 2-3 FindImport here

@steve-aom-elliott steve-aom-elliott merged commit 5c07d95 into main Mar 4, 2026
1 check passed
@steve-aom-elliott steve-aom-elliott deleted the replace-mockito-test-execution-listener branch March 4, 2026 15:07
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Mar 4, 2026
mergify bot added a commit to robfrank/linklift that referenced this pull request Mar 10, 2026
…rom 3.28.0 to 3.29.0 [skip ci]

Bumps [org.openrewrite.recipe:rewrite-testing-frameworks](https://github.com/openrewrite/rewrite-testing-frameworks) from 3.28.0 to 3.29.0.
Release notes

*Sourced from [org.openrewrite.recipe:rewrite-testing-frameworks's releases](https://github.com/openrewrite/rewrite-testing-frameworks/releases).*

> 3.29.0
> ------
>
> What's Changed
> --------------
>
> * Detect JUnit version in PowerMockitoMockStaticToMockito by [`@​MBoegers`](https://github.com/MBoegers) in [openrewrite/rewrite-testing-frameworks#919](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/919)
> * ReplacePowerMockito: ensure mockito-core is added when PowerMock is removed by [`@​MBoegers`](https://github.com/MBoegers) in [openrewrite/rewrite-testing-frameworks#920](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/920)
> * Remove all remaining PowerMock dependencies in ReplacePowerMockito recipe by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#921](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/921)
> * Add JUnit 4 support to AddMockitoExtensionIfAnnotationsUsed by [`@​bmuschko`](https://github.com/bmuschko) in [openrewrite/rewrite-testing-frameworks#922](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/922)
> * Use mockito-inline instead of mockito-core where applicable by [`@​bmuschko`](https://github.com/bmuschko) in [openrewrite/rewrite-testing-frameworks#923](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/923)
> * Add recipe to replace MockitoTestExecutionListener by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#924](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/924)
> * Remove empty constructors and suite() methods in MigrateJUnitTestCase by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#926](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/926)
>
> New Contributors
> ----------------
>
> * [`@​bmuschko`](https://github.com/bmuschko) made their first contribution in [openrewrite/rewrite-testing-frameworks#922](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/922)
>
> **Full Changelog**: <openrewrite/rewrite-testing-frameworks@v3.28.0...v3.29.0>


Commits

* [`7796693`](openrewrite/rewrite-testing-frameworks@7796693) Remove empty constructors and suite() methods in MigrateJUnitTestCase ([#926](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/926))
* [`5c07d95`](openrewrite/rewrite-testing-frameworks@5c07d95) Add recipe to replace MockitoTestExecutionListener ([#924](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/924))
* [`f1b202d`](openrewrite/rewrite-testing-frameworks@f1b202d) Use mockito-inline instead of mockito-core where applicable ([#923](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/923))
* [`63820f4`](openrewrite/rewrite-testing-frameworks@63820f4) Add JUnit 4 support to AddMockitoExtensionIfAnnotationsUsed ([#1932](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/1932)) ([#922](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/922))
* [`e8bbdf0`](openrewrite/rewrite-testing-frameworks@e8bbdf0) Remove all remaining PowerMock dependencies in ReplacePowerMockito recipe ([#921](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/921))
* [`0e3d076`](openrewrite/rewrite-testing-frameworks@0e3d076) ReplacePowerMockito: ensure mockito-core is added when PowerMock is removed (...
* [`af19fad`](openrewrite/rewrite-testing-frameworks@af19fad) Detect JUnit version in PowerMockitoMockStaticToMockito ([#919](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/919))
* See full diff in [compare view](openrewrite/rewrite-testing-frameworks@v3.28.0...v3.29.0)
  
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility\_score?dependency-name=org.openrewrite.recipe:rewrite-testing-frameworks&package-manager=maven&previous-version=3.28.0&new-version=3.29.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
  
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot show  ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants