diff --git a/src/main/java/org/openrewrite/java/logging/ChangeLoggersToPrivate.java b/src/main/java/org/openrewrite/java/logging/ChangeLoggersToPrivate.java new file mode 100644 index 00000000..2379e623 --- /dev/null +++ b/src/main/java/org/openrewrite/java/logging/ChangeLoggersToPrivate.java @@ -0,0 +1,122 @@ +/* + * Copyright 2025 the original author or authors. + *
+ * 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 + *
+ * https://docs.moderne.io/licensing/moderne-source-available-license + *
+ * 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;
+
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+import org.jspecify.annotations.Nullable;
+import org.openrewrite.*;
+import org.openrewrite.internal.ListUtils;
+import org.openrewrite.java.JavaIsoVisitor;
+import org.openrewrite.java.search.UsesType;
+import org.openrewrite.java.tree.J;
+import org.openrewrite.java.tree.JavaType;
+import org.openrewrite.java.tree.Space;
+import org.openrewrite.java.tree.TypeUtils;
+import org.openrewrite.marker.Markers;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Set;
+
+import static java.util.Collections.emptyList;
+import static java.util.stream.Collectors.toSet;
+
+@Value
+@EqualsAndHashCode(callSuper = false)
+public class ChangeLoggersToPrivate extends Recipe {
+
+ private static final Set
+ * 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
+ *
+ * https://docs.moderne.io/licensing/moderne-source-available-license
+ *
+ * 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;
+
+import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
+import org.openrewrite.test.RecipeSpec;
+import org.openrewrite.test.RewriteTest;
+
+import static org.openrewrite.java.Assertions.java;
+
+class ChangeLoggersToPrivateTest implements RewriteTest {
+
+ @Override
+ public void defaults(RecipeSpec spec) {
+ spec.recipe(new ChangeLoggersToPrivate());
+ }
+
+ @DocumentExample
+ @Test
+ void changePublicSlf4jLoggerPrivate() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.slf4j.Logger;
+ import org.slf4j.LoggerFactory;
+
+ class Test {
+ public static final Logger LOGGER = LoggerFactory.getLogger(Test.class);
+ }
+ """,
+ """
+ import org.slf4j.Logger;
+ import org.slf4j.LoggerFactory;
+
+ class Test {
+ private static final Logger LOGGER = LoggerFactory.getLogger(Test.class);
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void changePublicLog4j2LoggerPrivate() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.apache.logging.log4j.Logger;
+ import org.apache.logging.log4j.LogManager;
+
+ class Test {
+ public static final Logger LOGGER = LogManager.getLogger(Test.class);
+ }
+ """,
+ """
+ import org.apache.logging.log4j.Logger;
+ import org.apache.logging.log4j.LogManager;
+
+ class Test {
+ private static final Logger LOGGER = LogManager.getLogger(Test.class);
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void changeProtectedLog4jLoggerPrivate() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.apache.log4j.Logger;
+
+ class Test {
+ protected Logger log = Logger.getLogger(Test.class);
+ }
+ """,
+ """
+ import org.apache.log4j.Logger;
+
+ class Test {
+ private Logger log = Logger.getLogger(Test.class);
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void changeDefaultJulLoggerPrivate() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import java.util.logging.Logger;
+
+ class Test {
+ static final Logger LOG = Logger.getLogger(Test.class.getName());
+ }
+ """,
+ """
+ import java.util.logging.Logger;
+
+ class Test {
+ private static final Logger LOG = Logger.getLogger(Test.class.getName());
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void keepExistingPrivateLogger() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.slf4j.Logger;
+ import org.slf4j.LoggerFactory;
+
+ class Test {
+ private final Logger logger = LoggerFactory.getLogger(Test.class);
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void notALoggerField() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ class Test {
+ public String name = "test";
+ protected int count = 0;
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void loggerInInterfaceShouldNotChange() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.slf4j.Logger;
+ import org.slf4j.LoggerFactory;
+
+ interface Constants {
+ Logger logger = LoggerFactory.getLogger(Constants.class);
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void localVariableLoggerShouldNotChange() {
+ rewriteRun(
+ //language=java
+ java(
+ """
+ import org.slf4j.Logger;
+ import org.slf4j.LoggerFactory;
+
+ class Test {
+ public void doSomething() {
+ Logger localLog = LoggerFactory.getLogger(Test.class);
+ localLog.info("Hello");
+ }
+ }
+ """
+ )
+ );
+ }
+}
diff --git a/src/test/java/org/openrewrite/java/logging/slf4j/Slf4jBestPracticesTest.java b/src/test/java/org/openrewrite/java/logging/slf4j/Slf4jBestPracticesTest.java
index afb79d7f..4d5475a0 100644
--- a/src/test/java/org/openrewrite/java/logging/slf4j/Slf4jBestPracticesTest.java
+++ b/src/test/java/org/openrewrite/java/logging/slf4j/Slf4jBestPracticesTest.java
@@ -63,7 +63,7 @@ void test() {
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
class Test {
- Logger logger = LoggerFactory.getLogger(Test.class);
+ private Logger logger = LoggerFactory.getLogger(Test.class);
void test() {
Object obj1 = new Object();
Object obj2 = new Object();
@@ -105,7 +105,7 @@ void test() {
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
class Test {
- Logger logger = LoggerFactory.getLogger(Test.class);
+ private Logger logger = LoggerFactory.getLogger(Test.class);
void test() {
try {
throw new IllegalStateException("oops");