Skip to content

Adding jakarta.servlet:jakarta.servlet-api explicitly when the javax.servlet:javax.servlet-api it is trying to migrate from was only available transitively. #835

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
merged 2 commits into from
Aug 26, 2025
Merged

Adding jakarta.servlet:jakarta.servlet-api explicitly when the javax.servlet:javax.servlet-api it is trying to migrate from was only available transitively. #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60865c6
Adding `jakarta.servlet:jakarta.servlet-api` explicitly when the `jav…
steve-aom-elliott Aug 25, 2025
52191bd
Removing unnecessary DTDs and XML tags
steve-aom-elliott Aug 25, 2025
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
1 change: 1 addition & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ dependencies {
testRuntimeOnly("com.google.code.findbugs:jsr305:3.0.2")
testRuntimeOnly("javax.mail:mail:1.4.7")
testRuntimeOnly("javax.mail:javax.mail-api:1.6.2")
testRuntimeOnly("javax.servlet:javax.servlet-api:4.0.1")
testRuntimeOnly("javax.ws.rs:javax.ws.rs-api:2.1.1")
testRuntimeOnly(gradleApi())
}
Expand Down
5 changes: 5 additions & 0 deletions src/main/resources/META-INF/rewrite/jakarta-ee-9.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,11 @@ recipeList:
groupId: jakarta.servlet
artifactId: jakarta.servlet-api
newVersion: 5.0.x
- org.openrewrite.java.dependencies.AddDependency:
groupId: jakarta.servlet
artifactId: jakarta.servlet-api
version: 5.0.x
onlyIfUsing: javax.servlet.*
- org.openrewrite.java.ChangePackage:
oldPackageName: javax.servlet
newPackageName: jakarta.servlet
Expand Down
88 changes: 71 additions & 17 deletions src/test/java/org/openrewrite/java/migrate/jakarta/JavaxMailToJakartaMailTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ void switchesJavaxMailApiDependencyToJakartaMailApiDependency() {
//language=xml
pomXml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
Expand All @@ -59,7 +57,11 @@ void switchesJavaxMailApiDependencyToJakartaMailApiDependency() {
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.contains("jakarta.mail-api")
.contains("<groupId>jakarta.mail</groupId>")
.contains("<artifactId>jakarta.mail-api</artifactId>")
.containsPattern("<version>2.0.\\d+</version>")
.doesNotContain("<groupId>javax.mail</groupId>")
.doesNotContain("<artifactId>javax.mail-api</artifactId>")
.actual())
)
),
Expand Down Expand Up @@ -89,9 +91,7 @@ void switchesJavaxMailDependencyToJakartaMailApiDependency() {
//language=xml
pomXml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
Expand All @@ -106,7 +106,11 @@ void switchesJavaxMailDependencyToJakartaMailApiDependency() {
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.contains("jakarta.mail-api")
.contains("<groupId>jakarta.mail</groupId>")
.contains("<artifactId>jakarta.mail-api</artifactId>")
.containsPattern("<version>2.0.\\d+</version>")
.doesNotContain("<groupId>javax.mail</groupId>")
.doesNotContain("<artifactId>mail</artifactId>")
.actual())
)
),
Expand All @@ -129,7 +133,7 @@ public class TestApplication {
}

@Test
void addsJakartaMailDependencyIfExistingInTransitive() {
void addsJakartaMailApiDependencyIfJavaxMailApiOnlyExistingInTransitive() {
rewriteRun(
mavenProject(
"Sample",
Expand All @@ -151,34 +155,84 @@ public class TestApplication {
//language=xml
pomXml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.1.0.RELEASE</version>
</dependency>
</dependencies>
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.contains("jakarta.mail-api")
.contains("<groupId>jakarta.mail</groupId>")
.contains("<artifactId>jakarta.mail-api</artifactId>")
.containsPattern("<version>2.0.\\d+</version>")
.actual())
)
)
);
}

@Test
void ignoresJakartaMailDependencyIfAlreadyExisting() {
void upgradesJakartaMailApiDependencyIfAlreadyExistingAtALowerVersion() {
rewriteRun(
mavenProject(
"Sample",
//language=xml
pomXml(
"""
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>jakarta.mail</groupId>
<artifactId>jakarta.mail-api</artifactId>
<version>1.6.8</version>
</dependency>
</dependencies>
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.containsPattern("<version>2.0.\\d+</version>")
.actual())
)
)
);
}

@Test
void ignoresJakartaMailApiDependencyIfAlreadyExisting() {
rewriteRun(
mavenProject(
"Sample",
srcMainJava(
//language=java
java(
"""
import javax.mail.Session;
public class TestApplication {
}
""",
"""
import jakarta.mail.Session;
public class TestApplication {
}
"""
)
),
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
Expand Down
204 changes: 204 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/jakarta/JavaxServletToJakartaServletTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.migrate.jakarta;

import org.junit.jupiter.api.Test;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

import static org.assertj.core.api.Assertions.assertThat;
import static org.openrewrite.java.Assertions.*;
import static org.openrewrite.maven.Assertions.pomXml;

class JavaxServletToJakartaServletTest implements RewriteTest {
@Override
public void defaults(RecipeSpec spec) {
spec.parser(JavaParser.fromJavaVersion()
.classpath("javax.servlet-api-4.0.1"))
.recipeFromResource(
"/META-INF/rewrite/jakarta-ee-9.yml",
"org.openrewrite.java.migrate.jakarta.JavaxServletToJakartaServlet");
}

@Test
void switchesJavaxServletApiDependencyToJakartaServletApiDependency() {
rewriteRun(
mavenProject(
"Sample",
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
</dependency>
</dependencies>
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.contains("<groupId>jakarta.servlet</groupId>")
.contains("<artifactId>jakarta.servlet-api</artifactId>")
.containsPattern("<version>5.0.\\d+</version>")
.doesNotContain("<groupId>javax.servlet</groupId>")
.doesNotContain("<artifactId>javax.servlet-api</artifactId>")
.actual())
)
),
srcMainJava(
//language=java
java(
"""
import javax.servlet.Filter;
public class TestApplication {
}
""",
"""
import jakarta.servlet.Filter;
public class TestApplication {
}
"""
)
)
);
}

@Test
void addsJakartaServletApiDependencyIfJavaxServletApiOnlyExistsInTransitive() {
rewriteRun(
mavenProject(
"Sample",
srcMainJava(
//language=java
java(
"""
import javax.servlet.Filter;
public class TestApplication {
}
""",
"""
import jakarta.servlet.Filter;
public class TestApplication {
}
"""
)
),
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<version>2.1.9.RELEASE</version>
</dependency>
</dependencies>
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.contains("<groupId>jakarta.servlet</groupId>")
.contains("<artifactId>jakarta.servlet-api</artifactId>")
.containsPattern("<version>5.0.\\d+</version>")
.actual())
)
)
);
}

@Test
void upgradesJakartaServletApiDependencyIfAlreadyExistingAtLowerVersion() {
rewriteRun(
mavenProject(
"Sample",
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
<version>4.0.4</version>
</dependency>
</dependencies>
</project>
""",
spec -> spec.after(pom -> assertThat(pom)
.containsPattern("<version>5.0.\\d+</version>")
.actual())
)
)
);
}

@Test
void ignoresJakartaServletApiDependencyIfAlreadyExisting() {
rewriteRun(
mavenProject(
"Sample",
srcMainJava(
//language=java
java(
"""
import javax.servlet.Filter;
public class TestApplication {
}
""",
"""
import jakarta.servlet.Filter;
public class TestApplication {
}
"""
)
),
//language=xml
pomXml(
"""
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
<version>5.0.0</version>
</dependency>
</dependencies>
</project>
"""
)
)
);
}
}