Skip to content

Use assertTimeoutPreemptively to preserve JUnit 4 timeout semantics #2

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

Open
mattdepaula wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Use assertTimeoutPreemptively to preserve JUnit 4 timeout semantics #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a0020db
Replace @Timeout with assertTimeoutPreemptively to preserve JUnit 4 s…
mattdepaula Aug 5, 2026
0ce7296
Replace inline comment with @Issue annotation, following file convent…
mattdepaula Aug 5, 2026
fb81530
Add test for timeout wrapping with non-empty method body
mattdepaula Aug 5, 2026
7eec1e8
Fix test formatting to match file conventions
mattdepaula Aug 5, 2026
c80bcf8
Add @Issue to annotationWithTimeoutAndException
mattdepaula Aug 5, 2026
1a9c8c6
Skip assertTimeoutPreemptively when timeout=0 (JUnit 4 no-timeout sen…
mattdepaula Aug 5, 2026
e4f1765
Add test asserting throws clause is preserved for checked exceptions …
mattdepaula Aug 5, 2026
4af3442
Revert "Add test asserting throws clause is preserved for checked exc…
mattdepaula Aug 5, 2026
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
29 changes: 21 additions & 8 deletions src/main/java/org/openrewrite/java/testing/junit5/UpdateTestAnnotation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import org.openrewrite.marker.Markup;
import org.openrewrite.staticanalysis.LambdaBlockToExpression;

import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import java.util.Set;
Expand Down Expand Up @@ -156,18 +155,32 @@ public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, Ex
maybeAddImport("org.junit.jupiter.api.Assertions", "assertThrows", false);
}
}
if (cta.timeout != null) {
m = JavaTemplate.builder("@Timeout(value = #{any(long)}, unit = TimeUnit.MILLISECONDS)")
if (cta.timeout != null &&
!J.Literal.isLiteralValue(cta.timeout, 0L) &&
!J.Literal.isLiteralValue(cta.timeout, 0)) {
m = JavaTemplate.builder("org.junit.jupiter.api.function.Executable o = () -> #{};")
.javaParser(javaParser)
.imports("org.junit.jupiter.api.Timeout", "java.util.concurrent.TimeUnit")
.build()
.apply(
updateCursor(m),
m.getCoordinates().addAnnotation(Comparator.comparing(J.Annotation::getSimpleName)),
cta.timeout
m.getCoordinates().replaceBody(),
m.getBody()
);
maybeAddImport("org.junit.jupiter.api.Timeout");
maybeAddImport("java.util.concurrent.TimeUnit");

assert m.getBody() != null;
J.Lambda lambda = (J.Lambda) ((J.VariableDeclarations) m.getBody().getStatements().get(0))
.getVariables().get(0).getInitializer();

assert lambda != null;

m = JavaTemplate.builder("assertTimeoutPreemptively(Duration.ofMillis(#{any(long)}), #{any(org.junit.jupiter.api.function.Executable)});")
.javaParser(javaParser)
.staticImports("org.junit.jupiter.api.Assertions.assertTimeoutPreemptively")
.imports("java.time.Duration")
.build()
.apply(updateCursor(m), m.getCoordinates().replaceBody(), cta.timeout, lambda);
maybeAddImport("org.junit.jupiter.api.Assertions", "assertTimeoutPreemptively", false);
maybeAddImport("java.time.Duration");
}
maybeAddImport("org.junit.jupiter.api.Test");

Expand Down
98 changes: 87 additions & 11 deletions src/test/java/org/openrewrite/java/testing/junit5/UpdateTestAnnotationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,7 @@ public void test2() {
}

@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/450")
@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/1073")
@Test
void annotationWithTimeout() {
//language=java
Expand All @@ -352,15 +353,89 @@ public void test() {
""",
"""
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

import java.util.concurrent.TimeUnit;
import java.time.Duration;

import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;

public class MyTest {

@Test
@Timeout(value = 500, unit = TimeUnit.MILLISECONDS)
public void test() {
assertTimeoutPreemptively(Duration.ofMillis(500), () -> {
});
}
}
"""
)
);
}

@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/1073")
@Test
void timeoutZeroIsNoOpInJUnit4SoAnnotationOnlyMigrated() {
//language=java
rewriteRun(
java(
"""
import org.junit.Test;

public class MyTest {

@Test(timeout = 0)
public void test() {
String foo = "foo";
}
}
""",
"""
import org.junit.jupiter.api.Test;

public class MyTest {

@Test
public void test() {
String foo = "foo";
}
}
"""
)
);
}

@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/1073")
@Test
void annotationWithTimeoutAndStatements() {
//language=java
rewriteRun(
java(
"""
import org.junit.Test;

public class MyTest {

@Test(timeout = 500)
public void test() {
String foo = "foo";
System.out.println(foo);
}
}
""",
"""
import org.junit.jupiter.api.Test;

import java.time.Duration;

import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;

public class MyTest {

@Test
public void test() {
assertTimeoutPreemptively(Duration.ofMillis(500), () -> {
String foo = "foo";
System.out.println(foo);
});
}
}
"""
Expand Down Expand Up @@ -415,6 +490,7 @@ public void test() {
);
}

@Issue("https://github.com/openrewrite/rewrite-testing-frameworks/issues/1073")
@Test
void annotationWithTimeoutAndException() {
//language=java
Expand All @@ -433,19 +509,20 @@ public void test() {
""",
"""
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

import java.util.concurrent.TimeUnit;
import java.time.Duration;

import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;

public class MyTest {

@Test
@Timeout(value = 500, unit = TimeUnit.MILLISECONDS)
public void test() {
assertThrows(IllegalArgumentException.class, () -> {
throw new IllegalArgumentException("boom");
assertTimeoutPreemptively(Duration.ofMillis(500), () -> {
assertThrows(IllegalArgumentException.class, () -> {
throw new IllegalArgumentException("boom");
});
});
}
}
Expand Down Expand Up @@ -496,7 +573,6 @@ public void foo() {
);
}


@Test
void migrateDotClass() {
//language=java
Expand Down Expand Up @@ -550,8 +626,8 @@ public void test() {

@Test
void fullyQualified() {
//language=java
rewriteRun(
//language=java
java(
"""
public class MyTest {
Expand All @@ -575,8 +651,8 @@ public void feature1() {

@Test
void mixedFullyQualifiedAndNot() {
//language=java
rewriteRun(
//language=java
java(
"""
import org.junit.Test;
Expand Down