-
Notifications
You must be signed in to change notification settings - Fork 32
Add a recipe to migrate from JBoss Logging to SLF4J #241
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
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4abf443
dependencies
pdelagrave a1c1292
Simple logger invocations
pdelagrave ccfe1e1
Minimize modifiers in tests
timtebeek 28ed9ad
Minimize test using AssertJ's `actual()`
timtebeek c7b8933
Merge branch 'main' into jboss-to-slf4j
timtebeek 38bed3c
Merge branch 'main' into jboss-to-slf4j
timtebeek 2d4d346
Merge branch 'main' into jboss-to-slf4j
timtebeek 640fc8d
Inline `JBossLoggingToSlf4jUpdateDependencies` and run best practices…
timtebeek fc88352
Simplify tests
timtebeek 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
216 changes: 216 additions & 0 deletions
216
src/test/java/org/openrewrite/java/logging/slf4j/JBossLoggingToSlf4jTest.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,216 @@ | ||
| /* | ||
| * 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.logging.slf4j; | ||
|
|
||
| import org.junit.jupiter.api.Nested; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.openrewrite.DocumentExample; | ||
| import org.openrewrite.test.RecipeSpec; | ||
| import org.openrewrite.test.RewriteTest; | ||
| import org.openrewrite.test.SourceSpec; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.openrewrite.gradle.Assertions.buildGradle; | ||
| import static org.openrewrite.gradle.toolingapi.Assertions.withToolingApi; | ||
| import static org.openrewrite.java.Assertions.*; | ||
| import static org.openrewrite.maven.Assertions.pomXml; | ||
|
|
||
| class JBossLoggingToSlf4jTest implements RewriteTest { | ||
| @Override | ||
| public void defaults(RecipeSpec spec) { | ||
| spec.recipeFromResources("org.openrewrite.java.logging.slf4j.JBossLoggingToSlf4j"); | ||
| } | ||
|
|
||
| @DocumentExample | ||
| @Test | ||
timtebeek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| void simpleLogInvocationMapping() { | ||
| rewriteRun( | ||
| //language=java | ||
| java( | ||
| """ | ||
| import org.jboss.logging.Logger; | ||
|
|
||
| class A { | ||
| void doLog(Logger logger, String msg, Throwable t) { | ||
| logger.trace(msg); | ||
| logger.trace(msg, t); | ||
| logger.debug(msg); | ||
| logger.debug(msg, t); | ||
| logger.info(msg); | ||
| logger.info(msg, t); | ||
| logger.warn(msg); | ||
| logger.warn(msg, t); | ||
| logger.error(msg); | ||
| logger.error(msg, t); | ||
| logger.fatal(msg); | ||
| logger.fatal(msg, t); | ||
| } | ||
| } | ||
| """, | ||
| """ | ||
| import org.slf4j.Logger; | ||
|
|
||
| class A { | ||
| void doLog(Logger logger, String msg, Throwable t) { | ||
| logger.trace(msg); | ||
| logger.trace(msg, t); | ||
| logger.debug(msg); | ||
| logger.debug(msg, t); | ||
| logger.info(msg); | ||
| logger.info(msg, t); | ||
| logger.warn(msg); | ||
| logger.warn(msg, t); | ||
| logger.error(msg); | ||
| logger.error(msg, t); | ||
| logger.error(msg); | ||
| logger.error(msg, t); | ||
| } | ||
| } | ||
| """ | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Nested | ||
| class DependenciesTest { | ||
| @Test | ||
| void stillUsingJBossLoggingKeepsTheDependencyUsingMaven() { | ||
| rewriteRun( | ||
| mavenProject( | ||
| "project", | ||
| srcMainJava( | ||
| //language=java | ||
| java( | ||
| """ | ||
| import org.jboss.logging.Logger; | ||
|
|
||
| class A { | ||
| Logger LOGGER = Logger.getLogger(A.class); | ||
| } | ||
| """, | ||
| SourceSpec::skip | ||
| ) | ||
| ), | ||
| //language=xml | ||
| pomXml( | ||
| """ | ||
| <project> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>example-lib</artifactId> | ||
| <version>1</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.jboss.logging</groupId> | ||
| <artifactId>jboss-logging</artifactId> | ||
| <version>3.6.1.Final</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.jboss.logmanager</groupId> | ||
| <artifactId>jboss-logmanager</artifactId> | ||
| <version>3.1.2.Final</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
| """, | ||
| sourceSpecs -> sourceSpecs.after(after -> assertThat(after) | ||
| .contains("<artifactId>slf4j-jboss-logmanager</artifactId>") | ||
| .containsPattern("<version>(2.*)</version>") | ||
| .actual()) | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| void noMoreJBossLoggingUsagesRemovesTheDependencyUsingMaven() { | ||
| rewriteRun( | ||
| mavenProject( | ||
| "project", | ||
| //language=xml | ||
| pomXml( | ||
| """ | ||
| <project> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>example-lib</artifactId> | ||
| <version>1</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.jboss.logging</groupId> | ||
| <artifactId>jboss-logging</artifactId> | ||
| <version>3.6.1.Final</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.jboss.logmanager</groupId> | ||
| <artifactId>jboss-logmanager</artifactId> | ||
| <version>3.1.2.Final</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
| """, | ||
| """ | ||
| <project> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>example-lib</artifactId> | ||
| <version>1</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.jboss.logmanager</groupId> | ||
| <artifactId>jboss-logmanager</artifactId> | ||
| <version>3.1.2.Final</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.jboss.slf4j</groupId> | ||
| <artifactId>slf4j-jboss-logmanager</artifactId> | ||
| <version>2.0.1.Final</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
| """ | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| void noMoreJBossLoggingUsagesRemovesTheDependencyUsingGradle() { | ||
| rewriteRun( | ||
| spec -> spec.beforeRecipe(withToolingApi()), | ||
| mavenProject( | ||
| "project", | ||
| //language=gradle | ||
| buildGradle( | ||
| """ | ||
| plugins { id "java" } | ||
| repositories { mavenCentral() } | ||
| dependencies { | ||
| implementation "org.jboss.logmanager:jboss-logmanager:3.1.2.Final" | ||
| implementation "org.jboss.logging:jboss-logging:3.6.1.Final" | ||
| } | ||
| """, | ||
| """ | ||
| plugins { id "java" } | ||
| repositories { mavenCentral() } | ||
| dependencies { | ||
| implementation "org.jboss.logmanager:jboss-logmanager:3.1.2.Final" | ||
| implementation "org.jboss.slf4j:slf4j-jboss-logmanager:2.0.1.Final" | ||
| } | ||
| """ | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
| } | ||
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.