openrewrite: apply Slf4jBestPractices

codefromthecrypt · codefromthecrypt · commit cabb73b7d03a · 2024-03-08T06:53:52.000+08:00
This fixes some practice not all of which easy to notice manually,
notably use SLF4J parameters instead of string concatenation.

```bash
./mvnw -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-logging-frameworks:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.logging.slf4j.Slf4jBestPractices
```

Signed-off-by: Adrian Cole &lt;adrian@tetrate.io&gt;
diff --git a/examples/examples-release-17/src/main/java/io/kubernetes/client/examples/ExpandedExample.java b/examples/examples-release-17/src/main/java/io/kubernetes/client/examples/ExpandedExample.java
@@ -73,7 +73,7 @@ public static void main(String[] args) {
                   System.out.println("----- " + namespace + " -----");
                   getNamespacedPod(namespace).stream().forEach(System.out::println);
                 } catch (ApiException ex) {
-                  LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);
+                  LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);
                 }
               });
 
@@ -242,7 +242,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)
             appsV1Api.replaceNamespacedDeployment(
                 deploymentName, DEFAULT_NAME_SPACE, newDeploy, null, null, null, null);
           } catch (ApiException ex) {
-            LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);
+            LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);
           }
         });
   }
diff --git a/examples/examples-release-18/src/main/java/io/kubernetes/client/examples/ExpandedExample.java b/examples/examples-release-18/src/main/java/io/kubernetes/client/examples/ExpandedExample.java
@@ -73,7 +73,7 @@ public static void main(String[] args) {
                   System.out.println("----- " + namespace + " -----");
                   getNamespacedPod(namespace).stream().forEach(System.out::println);
                 } catch (ApiException ex) {
-                  LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);
+                  LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);
                 }
               });
 
@@ -242,7 +242,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)
             appsV1Api.replaceNamespacedDeployment(
                 deploymentName, DEFAULT_NAME_SPACE, newDeploy, null, null, null, null);
           } catch (ApiException ex) {
-            LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);
+            LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);
           }
         });
   }
diff --git a/examples/examples-release-19/src/main/java/io/kubernetes/client/examples/ExpandedExample.java b/examples/examples-release-19/src/main/java/io/kubernetes/client/examples/ExpandedExample.java
@@ -73,7 +73,7 @@ public static void main(String[] args) {
                   System.out.println("----- " + namespace + " -----");
                   getNamespacedPod(namespace).stream().forEach(System.out::println);
                 } catch (ApiException ex) {
-                  LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);
+                  LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);
                 }
               });
 
@@ -245,7 +245,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)
             appsV1Api.replaceNamespacedDeployment(
                 deploymentName, DEFAULT_NAME_SPACE, newDeploy, null, null, null, null);
           } catch (ApiException ex) {
-            LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);
+            LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);
           }
         });
   }
diff --git a/examples/examples-release-20/src/main/java/io/kubernetes/client/examples/ExpandedExample.java b/examples/examples-release-20/src/main/java/io/kubernetes/client/examples/ExpandedExample.java
@@ -73,7 +73,7 @@ public static void main(String[] args) {
                   System.out.println("----- " + namespace + " -----");
                   getNamespacedPod(namespace).stream().forEach(System.out::println);
                 } catch (ApiException ex) {
-                  LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);
+                  LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);
                 }
               });
 
@@ -218,7 +218,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)
             appsV1Api.replaceNamespacedDeployment(
                 deploymentName, DEFAULT_NAME_SPACE, newDeploy).execute();
           } catch (ApiException ex) {
-            LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);
+            LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);
           }
         });
   }
diff --git a/examples/examples-release-latest/src/main/java/io/kubernetes/client/examples/ExpandedExample.java b/examples/examples-release-latest/src/main/java/io/kubernetes/client/examples/ExpandedExample.java
@@ -73,7 +73,7 @@ public static void main(String[] args) {
                   System.out.println("----- " + namespace + " -----");
                   getNamespacedPod(namespace).stream().forEach(System.out::println);
                 } catch (ApiException ex) {
-                  LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);
+                  LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);
                 }
               });
 
@@ -218,7 +218,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)
             appsV1Api.replaceNamespacedDeployment(
                 deploymentName, DEFAULT_NAME_SPACE, newDeploy).execute();
           } catch (ApiException ex) {
-            LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);
+            LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);
           }
         });
   }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/controller/ControllerManager.java b/extended/src/main/java/io/kubernetes/client/extended/controller/ControllerManager.java
@@ -24,7 +24,7 @@
  * factory.
  */
 public class ControllerManager implements Controller {
-  private static final Logger log = LoggerFactory.getLogger(DefaultController.class);
+  private static final Logger log = LoggerFactory.getLogger(ControllerManager.class);
   private Controller[] controllers;
   private ExecutorService controllerThreadPool;
   private SharedInformerFactory informerFactory;
diff --git a/spring-aot/src/main/java/io/kubernetes/client/spring/aot/KubernetesBeanFactoryInitializationAotProcessor.java b/spring-aot/src/main/java/io/kubernetes/client/spring/aot/KubernetesBeanFactoryInitializationAotProcessor.java
@@ -64,7 +64,7 @@ public BeanFactoryInitializationAotContribution processAheadOfTime(
             "io.kubernetes.client.util.Watch$Response" //
           };
       for (String className : classNames) {
-        LOGGER.info("registering " + className + " for reflection");
+        LOGGER.info("registering {} for reflection", className);
         hints.reflection().registerType(TypeReference.of(className), allMemberCategories);
       }
       registerForPackage("io.kubernetes", hints);
@@ -85,7 +85,7 @@ private void registerForPackage(String packageName, RuntimeHints hints) {
     all.addAll(controllers);
     all.addAll(apiModels);
     for (Class<?> clazz : all) {
-      LOGGER.info("registering " + clazz.getName() + " for reflection");
+      LOGGER.info("registering {} for reflection", clazz.getName());
       hints.reflection().registerType(clazz, allMemberCategories);
     }
   }
diff --git a/spring/src/main/java/io/kubernetes/client/spring/extended/controller/config/KubernetesInformerAutoConfiguration.java b/spring/src/main/java/io/kubernetes/client/spring/extended/controller/config/KubernetesInformerAutoConfiguration.java
@@ -41,10 +41,7 @@ public ApiClient defaultApiClient() throws IOException {
       ApiClient apiClient = ClientBuilder.defaultClient();
       return apiClient;
     } catch (Exception e) {
-      LOGGER.warn(
-          "Could not create a Kubernetes ApiClient from either a cluster or standard environment. "
-              + "Will return one that always connects to localhost:8080",
-          e);
+      LOGGER.warn("Could not create a Kubernetes ApiClient from either a cluster or standard environment. " + "Will return one that always connects to localhost:8080", e);
       return new ClientBuilder().build();
     }
   }
diff --git a/util/src/main/java/io/kubernetes/client/Copy.java b/util/src/main/java/io/kubernetes/client/Copy.java
@@ -185,7 +185,7 @@ public Future<Integer> copyDirectoryFromPodAsync(
           entry != null;
           entry = archive.getNextEntry()) {
         if (!archive.canReadEntryData(entry)) {
-          log.error("Can't read: " + entry);
+          log.error("Can't read: {}", entry);
           continue;
         }
         String normalName = FilenameUtils.normalize(entry.getName());
diff --git a/util/src/main/java/io/kubernetes/client/informer/cache/ReflectorRunnable.java b/util/src/main/java/io/kubernetes/client/informer/cache/ReflectorRunnable.java
@@ -282,7 +282,7 @@ private void watchHandler(Watchable<ApiType> watch) {
 
   static <ApiType extends KubernetesObject> void defaultWatchErrorHandler(
       Class<ApiType> watchingApiTypeClass, Throwable t) {
-    log.error(String.format("%s#Reflector loop failed unexpectedly", watchingApiTypeClass), t);
+    log.error("{}#Reflector loop failed unexpectedly", watchingApiTypeClass, t);
   }
 
   private boolean isConnectException(Throwable t) {
diff --git a/util/src/main/java/io/kubernetes/client/util/ClientBuilder.java b/util/src/main/java/io/kubernetes/client/util/ClientBuilder.java
@@ -159,9 +159,7 @@ private String parseKubeConfigPath(String kubeConfigEnv) {
       final String[] filePaths = kubeConfigEnv.split(File.pathSeparator);
       final String kubeConfigPath = filePaths[0];
       if (filePaths.length > 1) {
-        log.warn(
-            "Found multiple kubeconfigs files, $KUBECONFIG: " + kubeConfigEnv + " using first: {}",
-            kubeConfigPath);
+        log.warn("Found multiple kubeconfigs files, $KUBECONFIG: {} using first: {}", kubeConfigEnv, kubeConfigPath);
       }
 
       return kubeConfigPath;
diff --git a/util/src/main/java/io/kubernetes/client/util/KubeConfig.java b/util/src/main/java/io/kubernetes/client/util/KubeConfig.java
@@ -231,7 +231,7 @@ public Map<String, String> getCredentials() {
           credentials.put(CRED_TOKEN_KEY, auth.getToken(authConfig));
           return credentials;
         } else {
-          log.error("Unknown auth provider: " + name);
+          log.error("Unknown auth provider: {}", name);
         }
       }
     }
@@ -358,7 +358,7 @@ private JsonElement runExec(String command, List<String> args, List<Map<String,
           Reader r = new InputStreamReader(is, StandardCharsets.UTF_8)) {
         root = JsonParser.parseReader(r);
       } catch (JsonParseException x) {
-        log.error("Failed to parse output of " + command, x);
+        log.error("Failed to parse output of {}", command, x);
         return null;
       }
       int r = proc.waitFor();
@@ -368,7 +368,7 @@ private JsonElement runExec(String command, List<String> args, List<Map<String,
       }
       return root;
     } catch (IOException | InterruptedException x) {
-      log.error("Failed to run " + command, x);
+      log.error("Failed to run {}", command, x);
       return null;
     }
   }
diff --git a/util/src/main/java/io/kubernetes/client/util/ModelMapper.java b/util/src/main/java/io/kubernetes/client/util/ModelMapper.java
@@ -422,9 +422,7 @@ private static void initModelMap() throws IOException {
       preBuiltClassesByGVK.put(new GroupVersionKind(group, version, kind), clazz);
     }
     if (preBuiltClassesByGVK.size() == 0) {
-      logger.warn(
-          "No kubernetes api model classes found from classloader, "
-              + "this may break automatic api discovery");
+      logger.warn("No kubernetes api model classes found from classloader, " + "this may break automatic api discovery");
     }
   }
 
diff --git a/util/src/main/java/io/kubernetes/client/util/Yaml.java b/util/src/main/java/io/kubernetes/client/util/Yaml.java
@@ -178,7 +178,7 @@ public static List<Object> loadAll(Reader reader) throws IOException {
         try {
           list.add(modelMapper((Map<String, Object>) object));
         } catch (ClassCastException ex) {
-          logger.error("Unexpected exception while casting: " + ex);
+          logger.error("Unexpected exception while casting: {}", ex);
         }
       }
     }
diff --git a/util/src/main/java/io/kubernetes/client/util/eks/HttpUtils.java b/util/src/main/java/io/kubernetes/client/util/eks/HttpUtils.java
@@ -92,7 +92,7 @@ public static HttpURLConnection createHttpConnection(URL endpointUrl,
             if ( headers != null ) {
                 log.debug("--------- Request headers ---------");
                 for ( String headerKey : headers.keySet() ) {
-                    log.debug(headerKey + ": " + headers.get(headerKey));
+                    log.debug("{}: {}", headerKey, headers.get(headerKey));
                     connection.setRequestProperty(headerKey, headers.get(headerKey));
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public static void main(String[] args) {`
`73`	`73`	`System.out.println("----- " + namespace + " -----");`
`74`	`74`	`getNamespacedPod(namespace).stream().forEach(System.out::println);`
`75`	`75`	`} catch (ApiException ex) {`
`76`		`- LOGGER.warn("Couldn't get the pods in namespace:" + namespace, ex);`
	`76`	`+ LOGGER.warn("Couldn't get the pods in namespace:{}", namespace, ex);`
`77`	`77`	`}`
`78`	`78`	`});`
`79`	`79`
`@@ -242,7 +242,7 @@ public static void scaleDeployment(String deploymentName, int numberOfReplicas)`
`242`	`242`	`appsV1Api.replaceNamespacedDeployment(`
`243`	`243`	`deploymentName, DEFAULT_NAME_SPACE, newDeploy, null, null, null, null);`
`244`	`244`	`} catch (ApiException ex) {`
`245`		`- LOGGER.warn("Scale the pod failed for Deployment:" + deploymentName, ex);`
	`245`	`+ LOGGER.warn("Scale the pod failed for Deployment:{}", deploymentName, ex);`
`246`	`246`	`}`
`247`	`247`	`});`
`248`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public BeanFactoryInitializationAotContribution processAheadOfTime(`
`64`	`64`	`"io.kubernetes.client.util.Watch$Response" //`
`65`	`65`	`};`
`66`	`66`	`for (String className : classNames) {`
`67`		`- LOGGER.info("registering " + className + " for reflection");`
	`67`	`+ LOGGER.info("registering {} for reflection", className);`
`68`	`68`	`hints.reflection().registerType(TypeReference.of(className), allMemberCategories);`
`69`	`69`	`}`
`70`	`70`	`registerForPackage("io.kubernetes", hints);`
`@@ -85,7 +85,7 @@ private void registerForPackage(String packageName, RuntimeHints hints) {`
`85`	`85`	`all.addAll(controllers);`
`86`	`86`	`all.addAll(apiModels);`
`87`	`87`	`for (Class<?> clazz : all) {`
`88`		`- LOGGER.info("registering " + clazz.getName() + " for reflection");`
	`88`	`+ LOGGER.info("registering {} for reflection", clazz.getName());`
`89`	`89`	`hints.reflection().registerType(clazz, allMemberCategories);`
`90`	`90`	`}`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,7 @@ public ApiClient defaultApiClient() throws IOException {`
`41`	`41`	`ApiClient apiClient = ClientBuilder.defaultClient();`
`42`	`42`	`return apiClient;`
`43`	`43`	`} catch (Exception e) {`
`44`		`- LOGGER.warn(`
`45`		`- "Could not create a Kubernetes ApiClient from either a cluster or standard environment. "`
`46`		`- + "Will return one that always connects to localhost:8080",`
`47`		`- e);`
	`44`	`+ LOGGER.warn("Could not create a Kubernetes ApiClient from either a cluster or standard environment. " + "Will return one that always connects to localhost:8080", e);`
`48`	`45`	`return new ClientBuilder().build();`
`49`	`46`	`}`
`50`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ public Future<Integer> copyDirectoryFromPodAsync(`
`185`	`185`	`entry != null;`
`186`	`186`	`entry = archive.getNextEntry()) {`
`187`	`187`	`if (!archive.canReadEntryData(entry)) {`
`188`		`- log.error("Can't read: " + entry);`
	`188`	`+ log.error("Can't read: {}", entry);`
`189`	`189`	`continue;`
`190`	`190`	`}`
`191`	`191`	`String normalName = FilenameUtils.normalize(entry.getName());`
Original file line number	Diff line number	Diff line change
`@@ -282,7 +282,7 @@ private void watchHandler(Watchable<ApiType> watch) {`
`282`	`282`
`283`	`283`	`static <ApiType extends KubernetesObject> void defaultWatchErrorHandler(`
`284`	`284`	`Class<ApiType> watchingApiTypeClass, Throwable t) {`
`285`		`- log.error(String.format("%s#Reflector loop failed unexpectedly", watchingApiTypeClass), t);`
	`285`	`+ log.error("{}#Reflector loop failed unexpectedly", watchingApiTypeClass, t);`
`286`	`286`	`}`
`287`	`287`
`288`	`288`	`private boolean isConnectException(Throwable t) {`