-
Notifications
You must be signed in to change notification settings - Fork 121
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.
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
steve-aom-elliott
merged 2 commits into
main
from
javax-servlet-api-implicit-to-jakarta-servlet-api-explicit
Aug 26, 2025
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
212 changes: 212 additions & 0 deletions
212
src/test/java/org/openrewrite/java/migrate/jakarta/JavaxServletToJakartaServletTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| /* | ||
| * 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( | ||
| """ | ||
| <?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"> | ||
| <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( | ||
| """ | ||
| <?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"> | ||
| <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( | ||
| """ | ||
| <?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"> | ||
| <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( | ||
| """ | ||
| <?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"> | ||
| <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> | ||
| """ | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.