fix: align logger names

loggers should be named the same throughout the project, if applicable. following the pattern: `private static final Logger logger`.
citrusframework · Sep 15, 2023 · d79831a · d79831a
1 parent 8ea65e2
commit d79831a
Show file tree

Hide file tree

Showing 343 changed files with 1,559 additions and 1,552 deletions.
diff --git a/...s/citrus-docker/src/main/java/org/citrusframework/docker/actions/DockerExecuteAction.java b/...s/citrus-docker/src/main/java/org/citrusframework/docker/actions/DockerExecuteAction.java
@@ -76,7 +76,7 @@ public class DockerExecuteAction extends AbstractTestAction {
     public static final String DEFAULT_JSON_MESSAGE_VALIDATOR = "defaultJsonMessageValidator";
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(DockerExecuteAction.class);
+    private static final Logger logger = LoggerFactory.getLogger(DockerExecuteAction.class);
 
     /**
      * Default constructor.
@@ -94,14 +94,14 @@ public DockerExecuteAction(Builder builder) {
     @Override
     public void doExecute(TestContext context) {
         try {
-            if (log.isDebugEnabled()) {
-                log.debug(String.format("Executing Docker command '%s'", command.getName()));
+            if (logger.isDebugEnabled()) {
+                logger.debug(String.format("Executing Docker command '%s'", command.getName()));
             }
             command.execute(dockerClient, context);
 
             validateCommandResult(command, context);
 
-            log.info(String.format("Docker command execution successful: '%s'", command.getName()));
+            logger.info(String.format("Docker command execution successful: '%s'", command.getName()));
         } catch (CitrusRuntimeException e) {
             throw e;
         } catch (Exception e) {
@@ -115,8 +115,8 @@ public void doExecute(TestContext context) {
      * @param context
      */
     private void validateCommandResult(DockerCommand command, TestContext context) {
-        if (log.isDebugEnabled()) {
-            log.debug("Starting Docker command result validation");
+        if (logger.isDebugEnabled()) {
+            logger.debug("Starting Docker command result validation");
         }
 
         if (StringUtils.hasText(expectedCommandResult)) {
@@ -128,7 +128,7 @@ private void validateCommandResult(DockerCommand command, TestContext context) {
                 String commandResultJson = jsonMapper.writeValueAsString(command.getCommandResult());
                 JsonMessageValidationContext validationContext = new JsonMessageValidationContext();
                 getMessageValidator(context).validateMessage(new DefaultMessage(commandResultJson), new DefaultMessage(expectedCommandResult), context, Collections.singletonList(validationContext));
-                log.info("Docker command result validation successful - all values OK!");
+                logger.info("Docker command result validation successful - all values OK!");
             } catch (JsonProcessingException e) {
                 throw new CitrusRuntimeException(e);
             }

diff --git a/connectors/citrus-docker/src/main/java/org/citrusframework/docker/client/DockerClient.java b/connectors/citrus-docker/src/main/java/org/citrusframework/docker/client/DockerClient.java
@@ -41,7 +41,7 @@
 public class DockerClient extends AbstractEndpoint implements Producer, ReplyConsumer {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(DockerClient.class);
+    private static final Logger logger = LoggerFactory.getLogger(DockerClient.class);
 
     /** Store of reply messages */
     private CorrelationManager<DockerCommand> correlationManager;
@@ -74,14 +74,14 @@ public void send(Message message, TestContext context) {
         String correlationKey = getEndpointConfiguration().getCorrelator().getCorrelationKey(message);
         correlationManager.saveCorrelationKey(correlationKeyName, correlationKey, context);
 
-        if (log.isDebugEnabled()) {
-            log.debug("Sending Docker request to: '" + getEndpointConfiguration().getDockerClientConfig().getDockerHost() + "'");
+        if (logger.isDebugEnabled()) {
+            logger.debug("Sending Docker request to: '" + getEndpointConfiguration().getDockerClientConfig().getDockerHost() + "'");
         }
 
         DockerCommand command = message.getPayload(DockerCommand.class);
         command.execute(this, context);
 
-        log.info("Docker request was sent to endpoint: '" + getEndpointConfiguration().getDockerClientConfig().getDockerHost() + "'");
+        logger.info("Docker request was sent to endpoint: '" + getEndpointConfiguration().getDockerClientConfig().getDockerHost() + "'");
 
         correlationManager.store(correlationKey, command);
 

diff --git a/...tors/citrus-docker/src/main/java/org/citrusframework/docker/command/ContainerInspect.java b/...tors/citrus-docker/src/main/java/org/citrusframework/docker/command/ContainerInspect.java
@@ -31,7 +31,7 @@
 public class ContainerInspect extends AbstractDockerCommand<InspectContainerResponse> {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(ContainerInspect.class);
+    private static final Logger logger = LoggerFactory.getLogger(ContainerInspect.class);
 
     /**
      * Default constructor initializing the command name.
@@ -47,7 +47,7 @@ public void execute(DockerClient dockerClient, TestContext context) {
 
         setCommandResult(response);
 
-        log.debug(response.toString());
+        logger.debug(response.toString());
     }
 
     /**

diff --git a/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/ImageInspect.java b/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/ImageInspect.java
@@ -31,7 +31,7 @@
 public class ImageInspect extends AbstractDockerCommand<InspectImageResponse> {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(ImageInspect.class);
+    private static final Logger logger = LoggerFactory.getLogger(ImageInspect.class);
 
     /**
      * Default constructor initializing the command name.
@@ -46,7 +46,7 @@ public void execute(DockerClient dockerClient, TestContext context) {
         InspectImageResponse response = command.exec();
 
         setCommandResult(response);
-        log.debug(response.toString());
+        logger.debug(response.toString());
     }
 
     /**

diff --git a/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/Info.java b/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/Info.java
@@ -29,7 +29,7 @@
 public class Info extends AbstractDockerCommand<com.github.dockerjava.api.model.Info> {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(Info.class);
+    private static final Logger logger = LoggerFactory.getLogger(Info.class);
 
     /**
      * Default constructor initializing the command name.
@@ -41,7 +41,7 @@ public Info() {
     @Override
     public void execute(DockerClient dockerClient, TestContext context) {
         setCommandResult(dockerClient.getEndpointConfiguration().getDockerClient().infoCmd().exec());
-        log.debug(getCommandResult().toString());
+        logger.debug(getCommandResult().toString());
     }
 
     /**

diff --git a/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/Version.java b/connectors/citrus-docker/src/main/java/org/citrusframework/docker/command/Version.java
@@ -30,7 +30,7 @@
 public class Version extends AbstractDockerCommand<com.github.dockerjava.api.model.Version> {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(Version.class);
+    private static final Logger logger = LoggerFactory.getLogger(Version.class);
 
     /**
      * Default constructor initializing the command name.
@@ -44,7 +44,7 @@ public void execute(DockerClient dockerClient, TestContext context) {
         VersionCmd command = dockerClient.getEndpointConfiguration().getDockerClient().versionCmd();
         setCommandResult(command.exec());
 
-        log.debug(getCommandResult().toString());
+        logger.debug(getCommandResult().toString());
     }
 
     /**

diff --git a/.../citrus-docker/src/test/java/org/citrusframework/docker/integration/AbstractDockerIT.java b/.../citrus-docker/src/test/java/org/citrusframework/docker/integration/AbstractDockerIT.java
@@ -37,7 +37,7 @@
 public class AbstractDockerIT extends TestNGCitrusSpringSupport {
 
     /** Logger */
-    private static final Logger log = LoggerFactory.getLogger(AbstractDockerIT.class);
+    private static final Logger logger = LoggerFactory.getLogger(AbstractDockerIT.class);
 
     /** Docker connection state, checks connectivity only once per test run */
     private static boolean connected = false;
@@ -57,7 +57,7 @@ public void checkDockerEnvironment() {
 
                 connected = future.get(5000, TimeUnit.MILLISECONDS);
             } catch (Exception e) {
-                log.warn("Skipping Docker test execution as no proper Docker environment is available on host system!", e);
+                logger.warn("Skipping Docker test execution as no proper Docker environment is available on host system!", e);
             }
         }
     }

diff --git a/...ernetes/src/main/java/org/citrusframework/kubernetes/actions/KubernetesExecuteAction.java b/...ernetes/src/main/java/org/citrusframework/kubernetes/actions/KubernetesExecuteAction.java
@@ -104,7 +104,7 @@ public class KubernetesExecuteAction extends AbstractTestAction {
     public static final String DEFAULT_JSON_PATH_MESSAGE_VALIDATOR = "defaultJsonPathMessageValidator";
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(KubernetesExecuteAction.class);
+    private static final Logger logger = LoggerFactory.getLogger(KubernetesExecuteAction.class);
 
     /**
      * Default constructor.
@@ -123,14 +123,14 @@ public KubernetesExecuteAction(Builder builder) {
     @Override
     public void doExecute(TestContext context) {
         try {
-            if (log.isDebugEnabled()) {
-                log.debug(String.format("Executing Kubernetes command '%s'", command.getName()));
+            if (logger.isDebugEnabled()) {
+                logger.debug(String.format("Executing Kubernetes command '%s'", command.getName()));
             }
             command.execute(kubernetesClient, context);
 
             validateCommandResult(command, context);
 
-            log.info(String.format("Kubernetes command execution successful: '%s'", command.getName()));
+            logger.info(String.format("Kubernetes command execution successful: '%s'", command.getName()));
         } catch (CitrusRuntimeException e) {
             throw e;
         } catch (Exception e) {
@@ -144,8 +144,8 @@ public void doExecute(TestContext context) {
      * @param context
      */
     private void validateCommandResult(KubernetesCommand command, TestContext context) {
-        if (log.isDebugEnabled()) {
-            log.debug("Starting Kubernetes command result validation");
+        if (logger.isDebugEnabled()) {
+            logger.debug("Starting Kubernetes command result validation");
         }
 
         CommandResult<?> result = command.getCommandResult();
@@ -159,15 +159,15 @@ private void validateCommandResult(KubernetesCommand command, TestContext contex
                         .getObjectMapper().writeValueAsString(result);
                 if (StringUtils.hasText(commandResult)) {
                     getMessageValidator(context).validateMessage(new DefaultMessage(commandResultJson), new DefaultMessage(commandResult), context, Collections.singletonList(new JsonMessageValidationContext()));
-                    log.info("Kubernetes command result validation successful - all values OK!");
+                    logger.info("Kubernetes command result validation successful - all values OK!");
                 }
 
                 if (!CollectionUtils.isEmpty(commandResultExpressions)) {
                     JsonPathMessageValidationContext validationContext = new JsonPathMessageValidationContext.Builder()
                             .expressions(commandResultExpressions)
                             .build();
                     getPathValidator(context).validateMessage(new DefaultMessage(commandResultJson), new DefaultMessage(commandResult), context, Collections.singletonList(validationContext));
-                    log.info("Kubernetes command result path validation successful - all values OK!");
+                    logger.info("Kubernetes command result path validation successful - all values OK!");
                 }
             } catch (JsonProcessingException e) {
                 throw new CitrusRuntimeException(e);

diff --git a/...trus-kubernetes/src/main/java/org/citrusframework/kubernetes/client/KubernetesClient.java b/...trus-kubernetes/src/main/java/org/citrusframework/kubernetes/client/KubernetesClient.java
@@ -39,7 +39,7 @@
 public class KubernetesClient extends AbstractEndpoint implements Producer, ReplyConsumer {
 
     /** Logger */
-    private static Logger log = LoggerFactory.getLogger(KubernetesClient.class);
+    private static final Logger logger = LoggerFactory.getLogger(KubernetesClient.class);
 
     /** Store of reply messages */
     private CorrelationManager<KubernetesCommand> correlationManager;
@@ -72,14 +72,14 @@ public void send(Message message, TestContext context) {
         String correlationKey = getEndpointConfiguration().getCorrelator().getCorrelationKey(message);
         correlationManager.saveCorrelationKey(correlationKeyName, correlationKey, context);
 
-        if (log.isDebugEnabled()) {
-            log.debug("Sending Kubernetes request to: '" + getEndpointConfiguration().getKubernetesClientConfig().getMasterUrl() + "'");
+        if (logger.isDebugEnabled()) {
+            logger.debug("Sending Kubernetes request to: '" + getEndpointConfiguration().getKubernetesClientConfig().getMasterUrl() + "'");
         }
 
         KubernetesCommand<?> command = getEndpointConfiguration().getMessageConverter().convertOutbound(message, getEndpointConfiguration(), context);
         command.execute(this, context);
 
-        log.info("Kubernetes request was sent to endpoint: '" + getEndpointConfiguration().getKubernetesClientConfig().getMasterUrl() + "'");
+        logger.info("Kubernetes request was sent to endpoint: '" + getEndpointConfiguration().getKubernetesClientConfig().getMasterUrl() + "'");
 
         correlationManager.store(correlationKey, command);
     }

diff --git a/...netes/src/main/java/org/citrusframework/kubernetes/command/AbstractKubernetesCommand.java b/...netes/src/main/java/org/citrusframework/kubernetes/command/AbstractKubernetesCommand.java
@@ -33,7 +33,7 @@
 public abstract class AbstractKubernetesCommand<R extends KubernetesResource, T extends KubernetesCommand<R>> implements KubernetesCommand<R> {
 
     /** Logger */
-    protected Logger log = LoggerFactory.getLogger(getClass());
+    private static final Logger logger = LoggerFactory.getLogger(getClass());
 
     /** Self reference for generics support */
     private final T self;

diff --git a/...kubernetes/src/main/java/org/citrusframework/kubernetes/command/AbstractWatchCommand.java b/...kubernetes/src/main/java/org/citrusframework/kubernetes/command/AbstractWatchCommand.java
@@ -61,7 +61,7 @@ public void eventReceived(Action action, R resource) {
                 if (results.isEmpty() && cachedResult == null) {
                     results.add(new WatchEventResult<>(resource, action));
                 } else {
-                    log.debug("Ignoring watch result: " + action.name());
+                    logger.debug("Ignoring watch result: " + action.name());
                 }
             }
 
@@ -89,7 +89,7 @@ public WatchEventResult<R> getCommandResult() {
             try {
                 watch.close();
             } catch (KubernetesClientException e) {
-                log.warn("Failed to gracefully close watch", e);
+                logger.warn("Failed to gracefully close watch", e);
             }
 
             watchEventResult.setWatch(watch);

diff --git a/...rnetes/src/test/java/org/citrusframework/kubernetes/integration/AbstractKubernetesIT.java b/...rnetes/src/test/java/org/citrusframework/kubernetes/integration/AbstractKubernetesIT.java
@@ -36,7 +36,7 @@
 public class AbstractKubernetesIT extends TestNGCitrusSpringSupport {
 
     /** Logger */
-    private static final Logger log = LoggerFactory.getLogger(AbstractKubernetesIT.class);
+    private static final Logger logger = LoggerFactory.getLogger(AbstractKubernetesIT.class);
 
     /** Kubernetes' connection state, checks connectivity only once per test run */
     private static boolean connected = false;
@@ -54,7 +54,7 @@ public void checkKubernetesEnvironment() {
 
                 connected = future.get(5000, TimeUnit.MILLISECONDS);
             } catch (Exception e) {
-                log.warn("Skipping Kubernetes test execution as no proper Kubernetes environment is available on host system!", e);
+                logger.warn("Skipping Kubernetes test execution as no proper Kubernetes environment is available on host system!", e);
             }
         }
     }

diff --git a/...s-selenium/src/main/java/org/citrusframework/selenium/actions/AbstractSeleniumAction.java b/...s-selenium/src/main/java/org/citrusframework/selenium/actions/AbstractSeleniumAction.java
@@ -32,7 +32,7 @@
 public abstract class AbstractSeleniumAction extends AbstractTestAction implements SeleniumAction {
 
     /** Logger */
-    protected Logger log = LoggerFactory.getLogger(getClass());
+    private static final Logger logger = LoggerFactory.getLogger(getClass());
 
     /** Selenium browser instance  */
     private final SeleniumBrowser browser;
@@ -45,8 +45,8 @@ public AbstractSeleniumAction(String name, Builder<?, ?> builder) {
 
     @Override
     public void doExecute(TestContext context) {
-        if (log.isDebugEnabled()) {
-            log.debug(String.format("Executing Selenium browser command '%s'", getName()));
+        if (logger.isDebugEnabled()) {
+            logger.debug(String.format("Executing Selenium browser command '%s'", getName()));
         }
 
         SeleniumBrowser browserToUse = browser;
@@ -61,7 +61,7 @@ public void doExecute(TestContext context) {
 
         execute(browserToUse, context);
 
-        log.info(String.format("Selenium browser command execution successful: '%s'", getName()));
+        logger.info(String.format("Selenium browser command execution successful: '%s'", getName()));
     }
 
     protected abstract void execute(SeleniumBrowser browser, TestContext context);

diff --git a/...ctors/citrus-selenium/src/main/java/org/citrusframework/selenium/actions/AlertAction.java b/...ctors/citrus-selenium/src/main/java/org/citrusframework/selenium/actions/AlertAction.java
@@ -58,7 +58,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
         }
 
         if (StringUtils.hasText(text)) {
-            log.info("Validating alert text");
+            logger.info("Validating alert text");
 
             String alertText = context.replaceDynamicContentInString(text);
 
@@ -70,7 +70,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
                                 "expected '%s', but was '%s'", alertText, alert.getText()));
 
             }
-            log.info("Alert text validation successful - All values Ok");
+            logger.info("Alert text validation successful - All values Ok");
         }
 
         context.setVariable(SeleniumHeaders.SELENIUM_ALERT_TEXT, alert.getText());

diff --git a/...citrus-selenium/src/main/java/org/citrusframework/selenium/actions/CloseWindowAction.java b/...citrus-selenium/src/main/java/org/citrusframework/selenium/actions/CloseWindowAction.java
@@ -54,13 +54,13 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
             throw new CitrusRuntimeException("Failed to find window for handle " + context.getVariable(windowName));
         }
 
-        log.info("Current window: " + browser.getWebDriver().getWindowHandle());
-        log.info("Window to close: " + context.getVariable(windowName));
+        logger.info("Current window: " + browser.getWebDriver().getWindowHandle());
+        logger.info("Window to close: " + context.getVariable(windowName));
 
         if (browser.getWebDriver().getWindowHandle().equals((context.getVariable(windowName)))) {
             browser.getWebDriver().close();
 
-            log.info("Switch back to main window!");
+            logger.info("Switch back to main window!");
             if (context.getVariables().containsKey(SeleniumHeaders.SELENIUM_LAST_WINDOW)) {
                 browser.getWebDriver().switchTo().window(context.getVariable(SeleniumHeaders.SELENIUM_LAST_WINDOW));
                 context.setVariable(SeleniumHeaders.SELENIUM_ACTIVE_WINDOW, context.getVariable(SeleniumHeaders.SELENIUM_LAST_WINDOW));

diff --git a/.../citrus-selenium/src/main/java/org/citrusframework/selenium/actions/JavaScriptAction.java b/.../citrus-selenium/src/main/java/org/citrusframework/selenium/actions/JavaScriptAction.java
@@ -79,7 +79,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
                     }
                 }
             } else {
-                log.warn("Skip javascript action because web driver is missing javascript features");
+                logger.warn("Skip javascript action because web driver is missing javascript features");
             }
         } catch (WebDriverException e) {
             throw new CitrusRuntimeException("Failed to execute JavaScript code", e);

diff --git a/...rus-selenium/src/main/java/org/citrusframework/selenium/actions/MakeScreenshotAction.java b/...rus-selenium/src/main/java/org/citrusframework/selenium/actions/MakeScreenshotAction.java
@@ -54,7 +54,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
         if (browser.getWebDriver() instanceof TakesScreenshot) {
             screenshot = ((TakesScreenshot) browser.getWebDriver()).getScreenshotAs(OutputType.FILE);
         } else {
-            log.warn("Skip screenshot action because web driver is missing screenshot features");
+            logger.warn("Skip screenshot action because web driver is missing screenshot features");
         }
 
         if (screenshot != null) {
@@ -76,7 +76,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
 
                     FileCopyUtils.copy(screenshot, new File(targetDir, testName + "_" + screenshot.getName()));
                 } catch (IOException e) {
-                    log.error("Failed to save screenshot to target storage", e);
+                    logger.error("Failed to save screenshot to target storage", e);
                 }
             } else {
                 browser.storeFile(new FileSystemResource(screenshot));

diff --git a/.../citrus-selenium/src/main/java/org/citrusframework/selenium/actions/OpenWindowAction.java b/.../citrus-selenium/src/main/java/org/citrusframework/selenium/actions/OpenWindowAction.java
@@ -64,7 +64,7 @@ protected void execute(SeleniumBrowser browser, TestContext context) {
 
         if (!StringUtils.isEmpty(newWindow)) {
             browser.getWebDriver().switchTo().window(newWindow);
-            log.info("Open window: " + newWindow);
+            logger.info("Open window: " + newWindow);
             context.setVariable(SeleniumHeaders.SELENIUM_ACTIVE_WINDOW, newWindow);
             context.setVariable(windowName, newWindow);
         } else {