Skip to content

Added implementation to extract any expression arguments from last statement in assertThrows#724

Merged
timtebeek merged 28 commits into
mainfrom
1137-extract-nested-method-invocations-to-variables-before-assertthrowsonlaststatement
Jul 31, 2025
Merged

Added implementation to extract any expression arguments from last statement in assertThrows#724
timtebeek merged 28 commits into
mainfrom
1137-extract-nested-method-invocations-to-variables-before-assertthrowsonlaststatement

Conversation

@JohannisK

Copy link
Copy Markdown
Contributor

What's changed?

This PR changes the recipe to extract all expression arguments into variables outside the assertThrows() call.

What's your motivation?

assertThrows(..) should only contain the expression that is expected to throw.

@Test
void test() {
    assertThrows(Exception.class, () -> {
        doA();
        doB();
        testThing(getC());
    });
}

breaks that convention because getC() could throw.

@github-project-automation github-project-automation Bot moved this to In Progress in OpenRewrite May 9, 2025
github-actions[bot]

This comment was marked as resolved.

JohannisK and others added 3 commits May 9, 2025 12:20
…OnLastStatement.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…OnLastStatement.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…OnLastStatementTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@timtebeek timtebeek added the enhancement New feature or request label May 9, 2025
github-actions[bot]

This comment was marked as spam.

github-actions[bot]

This comment was marked as spam.

github-actions[bot]

This comment was marked as spam.

@timtebeek timtebeek self-requested a review May 9, 2025 16:44
github-actions[bot]

This comment was marked as spam.

@timtebeek timtebeek self-requested a review May 20, 2025 17:58
);
}

@Disabled("Creates duplicate variables `b`")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not yet clear how to resolve this presently, as we can not update the cursor while generating variables inside ListUtils I think.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I stored a map<basename, suffixcounter> so I can use VariableNameUtils for the generation of the name and then just change the suffix counter if applicable. No updates of the cursor etc needed in that case. Bit more custom code in this visitor here.

);
}

@Disabled("Not implemented yet")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We could restructure the logic to first and separately pull out variable from method invocaton arguments, and only then look to retain the last argument. Right now those two are mixed, which is why this case is not handled.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I just removed a size check that limited this behaviour to the ones where we have more than 1 line inside.
As the rest of the code already properly used the withers and ListUtils, no new lst element was generated if size was 1 and no variables needed to be extracted.

@timtebeek timtebeek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Already addressed quite a few of the earlier criticisms by now adopting JavaTemplate, and making better use of ListUtils. Also discovered two limitations that I've called out with tests for now. Without fixes there we could potentially do harm, so perhaps best addressed. Fixing the last one might help the second to last one as well.

@timtebeek timtebeek marked this pull request as draft June 10, 2025 07:42

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Some suggestions could not be made:

  • src/test/java/org/openrewrite/java/testing/junit5/AssertThrowsOnLastStatementTest.java
    • lines 18-18

@openrewrite openrewrite deleted a comment from github-actions Bot Jul 30, 2025
@Jenson3210 Jenson3210 marked this pull request as ready for review July 30, 2025 08:22
@github-project-automation github-project-automation Bot moved this from In Progress to Ready to Review in OpenRewrite Jul 30, 2025

@timtebeek timtebeek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks all! Appreciate the extensive test coverage here.

@timtebeek timtebeek merged commit c9289cc into main Jul 31, 2025
2 checks passed
@timtebeek timtebeek deleted the 1137-extract-nested-method-invocations-to-variables-before-assertthrowsonlaststatement branch July 31, 2025 12:57
@github-project-automation github-project-automation Bot moved this from Ready to Review to Done in OpenRewrite Jul 31, 2025
mergify Bot added a commit to robfrank/linklift that referenced this pull request Aug 15, 2025
…rom 3.11.0 to 3.15.0 [skip ci]

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

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

> 3.15.0
> ------
>
> What's Changed
> --------------
>
> * Include additional AssertJ migrations by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#773](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/773)
> * Include recipes in larger composites where possible by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#774](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/774)
> * Retain comments when chaining assertions by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#775](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/775)
> * refactor: Static imports for Collections and Collectors by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#779](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/779)
> * Added implementation to extract any expression arguments from last statement in assertThrows by [`@​JohannisK`](https://github.com/JohannisK) in [openrewrite/rewrite-testing-frameworks#724](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/724)
> * Don't clean up mockito imports for Kotlin by [`@​jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-testing-frameworks#782](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/782)
> * Adding dependency guards to the Junit 4 -> 5 migration for when the POM or build.gradle have a dependency on `org.testng:testng`. by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#760](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/760)
> * rename settings.local.json to settings.json by [`@​zieka`](https://github.com/zieka) in [openrewrite/rewrite-testing-frameworks#783](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/783)
> * Fix ClassCastException in PowerMockitoWhenNewToMockito by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#786](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/786)
> * MockitoJUnitRunnerToExtension: Handle existing MockitoExtension by [`@​amishra-u`](https://github.com/amishra-u) in [openrewrite/rewrite-testing-frameworks#788](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/788)
>
> **Full Changelog**: <openrewrite/rewrite-testing-frameworks@v3.14.0...v3.15.0>
>
> 3.14.1
> ------
>
> What's Changed
> --------------
>
> * OpenRewrite v8.59.1: <https://github.com/openrewrite/rewrite>
>
> **Full Changelog**: <https://github.com/openrewrite/rewrite-testing-frameworks>
>
> 3.14.0
> ------
>
> What's Changed
> --------------
>
> * Collapse more consecutive assertions by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#769](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/769)
> * refactor: Unwrap else block after return or throw statement by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-testing-frameworks#771](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/771)
> * Remove all PowerMock imports after migration by [`@​JohannisK`](https://github.com/JohannisK) in [openrewrite/rewrite-testing-frameworks#770](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/770)
> * Remove `assertTrue(true)` and `assertFalse(false)` by [`@​aet2505`](https://github.com/aet2505) in [openrewrite/rewrite-testing-frameworks#767](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/767)
>
> New Contributors
> ----------------
>
> * [`@​aet2505`](https://github.com/aet2505) made their first contribution in [openrewrite/rewrite-testing-frameworks#767](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/767)
>
> **Full Changelog**: <openrewrite/rewrite-testing-frameworks@v3.13.0...v3.14.0>
>
> 3.13.0
> ------
>
> What's Changed
> --------------
>
> * Removing `NoInitializationForInjectMock` recipe due to side effects when using recipe by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#765](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/765)
> * Adding functionality to `MockitoWhenOnStaticToMockStatic` for recognizing an existing try-with-resources `MockedStatic<T>` can be reused instead of creating a new one. by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#766](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/766)
> * Inconvertible Mockito `when` situation involving lambda and static method. by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#763](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/763)
> * Changing order of `mockito-all` -> `mockito-core` change vs `org.mockito:*` upgrade, and made the former upgrade to `3.x` at the same time, as there aren't aligned versions between the two. by [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) in [openrewrite/rewrite-testing-frameworks#768](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/768)
>
> New Contributors
> ----------------
>
> * [`@​steve-aom-elliott`](https://github.com/steve-aom-elliott) made their first contribution in [openrewrite/rewrite-testing-frameworks#765](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/765)
>
> **Full Changelog**: <openrewrite/rewrite-testing-frameworks@v3.12.0...v3.13.0>
>
> 3.12.0
> ------
>
> What's Changed
> --------------
>
> * Fix for JUnit test method throws clause preservation by [`@​knutwannheden`](https://github.com/knutwannheden) in [openrewrite/rewrite-testing-frameworks#755](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/755)
> * refactor: org.openrewrite.mavencentral by [`@​Laurens-W`](https://github.com/Laurens-W) in [openrewrite/rewrite-testing-frameworks#756](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/pull/756)

... (truncated)


Commits

* [`76c6888`](openrewrite/rewrite-testing-frameworks@76c6888) MockitoJUnitRunnerToExtension: Handle existing MockitoExtension ([#788](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/788))
* [`75d2019`](openrewrite/rewrite-testing-frameworks@75d2019) Retain `Throwable` in `SimplifyTestThrows`
* [`0ea47e9`](openrewrite/rewrite-testing-frameworks@0ea47e9) Include `SimplifyTestThrows` with `JUnit5BestPractices`
* [`efb0a4e`](openrewrite/rewrite-testing-frameworks@efb0a4e) Add AssertJ change type recipes for classes deprecated in v3.27.4
* [`f203a20`](openrewrite/rewrite-testing-frameworks@f203a20) Update documentation examples
* [`69d7716`](openrewrite/rewrite-testing-frameworks@69d7716) Fix ClassCastException in PowerMockitoWhenNewToMockito ([#786](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/786))
* [`dc6f272`](openrewrite/rewrite-testing-frameworks@dc6f272) rename settings.local.json to settings.json ([#783](https://redirect.github.com/openrewrite/rewrite-testing-frameworks/issues/783))
* [`96fca52`](openrewrite/rewrite-testing-frameworks@96fca52) Documentation example for MockitoJUnitRunnerToExtensionTest
* [`9a2082a`](openrewrite/rewrite-testing-frameworks@9a2082a) Adding dependency guards to the Junit 4 -> 5 migration for when the POM or bu...
* [`74366cf`](openrewrite/rewrite-testing-frameworks@74366cf) OpenRewrite recipe best practices
* Additional commits viewable in [compare view](openrewrite/rewrite-testing-frameworks@v3.11.0...v3.15.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.11.0&new-version=3.15.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 merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@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

enhancement New feature or request junit

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants