gh-2657: Cherry-pick gh-2618: Cleanup inconsistent use of logging str…

…ings (#2651) (#2658) * gh-2618: Cleanup inconsistent use of logging strings (#2651) * Found 1 extra inconsistency than the mentioned one * found and fixed other inconsitencies * further fixes * further fixes 2 * fixed 3 out of 4 checkstyle errors - 1 more to fix * all checkstyle errors fixed * removed use of String.format * removed another instance of using String.format * more changes * additional change * reverted changes * gh-2657: Revert accidental change * gh-2657: Update copyright with spotless Co-authored-by: Robert <33911814+RobertG111@users.noreply.github.com>
gchq · May 27, 2022 · f217c92 · f217c92
1 parent 4e33a78
commit f217c92
Show file tree

Hide file tree

Showing 15 changed files with 38 additions and 34 deletions.
diff --git a/core/common-util/src/main/java/uk/gov/gchq/gaffer/commonutil/ExecutorService.java b/core/common-util/src/main/java/uk/gov/gchq/gaffer/commonutil/ExecutorService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Crown Copyright
+ * Copyright 2019-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.commonutil;
 
 import org.slf4j.Logger;
@@ -38,7 +39,7 @@ private ExecutorService() {
 
     public static synchronized void initialise(final int jobExecutorThreadCount) {
         if (service == null) {
-            LOGGER.debug("Initialising ExecutorService with " + jobExecutorThreadCount + " threads");
+            LOGGER.debug("Initialising ExecutorService with {} threads", jobExecutorThreadCount);
             service = Executors.newScheduledThreadPool(jobExecutorThreadCount, runnable -> {
                 final Thread thread = new Thread(runnable);
                 thread.setDaemon(true);

diff --git a/core/common-util/src/main/java/uk/gov/gchq/gaffer/commonutil/StreamUtil.java b/core/common-util/src/main/java/uk/gov/gchq/gaffer/commonutil/StreamUtil.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 Crown Copyright
+ * Copyright 2016-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -154,7 +154,7 @@ public static InputStream[] openStreams(final Class clazz, final String folderPa
                                 inputStreams.add(openStream(clazz, file));
                             } catch (final Exception e) {
                                 int closedStreamsCount = closeStreams(inputStreams.toArray(new InputStream[inputStreams.size()]));
-                                LOGGER.info(String.format("Closed %s input streams", closedStreamsCount));
+                                LOGGER.info("Closed {} input streams", closedStreamsCount);
                             }
                         }
                 );

diff --git a/core/graph/src/main/java/uk/gov/gchq/gaffer/graph/Graph.java b/core/graph/src/main/java/uk/gov/gchq/gaffer/graph/Graph.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -284,7 +284,7 @@ public JobDetail executeJob(final Job job, final Context context) throws Operati
                 try {
                     result = graphHook.onFailure(result, clonedOpChain, clonedContext, e);
                 } catch (final Exception graphHookE) {
-                    LOGGER.warn("Error in graphHook " + graphHook.getClass().getSimpleName() + ": " + graphHookE.getMessage(), graphHookE);
+                    LOGGER.warn("Error in graphHook {} : {}", graphHook.getClass().getSimpleName(), graphHookE.getMessage(), graphHookE);
                 }
             }
             CloseableUtil.close(clonedOpChain);
@@ -341,7 +341,7 @@ private <O> GraphResult<O> _execute(final StoreExecuter<O> storeExecuter, final
                 try {
                     result = graphHook.onFailure(result, clonedOpChain, clonedContext, e);
                 } catch (final Exception graphHookE) {
-                    LOGGER.warn("Error in graphHook " + graphHook.getClass().getSimpleName() + ": " + graphHookE.getMessage(), graphHookE);
+                    LOGGER.warn("Error in graphHook {} : {}", graphHook.getClass().getSimpleName(), graphHookE.getMessage(), graphHookE);
                 }
             }
             CloseableUtil.close(clonedOpChain);

diff --git a/core/graph/src/main/java/uk/gov/gchq/gaffer/graph/hook/FunctionAuthoriser.java b/core/graph/src/main/java/uk/gov/gchq/gaffer/graph/hook/FunctionAuthoriser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Crown Copyright
+ * Copyright 2020-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.graph.hook;
 
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@@ -71,7 +72,7 @@ public void preExecute(final OperationChain<?> opChain, final Context context) {
             // This should never happen in real life as operation chains should
             // always be json serialisable. However this could happen if using a
             // mock in testing. To account for this, it will be logged.
-            LOGGER.warn("Failed to serialise operation chain: " + opChain + " due to " + e.getMessage());
+            LOGGER.warn("Failed to serialise operation chain: {} due to {}", opChain, e.getMessage());
             return;
         } finally {
             if (input != null) {

diff --git a/...n/java/uk/gov/gchq/gaffer/store/operation/resolver/named/NamedOperationScoreResolver.java b/...n/java/uk/gov/gchq/gaffer/store/operation/resolver/named/NamedOperationScoreResolver.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.store.operation.resolver.named;
 
 import org.slf4j.Logger;
@@ -61,7 +62,7 @@ public Integer getScore(final NamedOperation operation, final ScoreResolver defa
         try {
             namedOpDetail = cache.getFromCache(operation.getOperationName());
         } catch (final CacheOperationFailedException e) {
-            LOGGER.warn("Error accessing cache for Operation '{}': " + e.getMessage(), operation.getClass().getName());
+            LOGGER.warn("Error accessing cache for Operation '{}': {}", operation.getClass().getName(), e.getMessage());
         }
 
         if (null != namedOpDetail) {

diff --git a/...cast-cache-service/src/main/java/uk/gov/gchq/gaffer/cache/impl/HazelcastCacheService.java b/...cast-cache-service/src/main/java/uk/gov/gchq/gaffer/cache/impl/HazelcastCacheService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 Crown Copyright
+ * Copyright 2016-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,8 +42,7 @@ private void configureHazelcast(final Properties properties) {
         if (null == hazelcast || !Hazelcast.getAllHazelcastInstances().contains(hazelcast)) {
             String configFile = properties.getProperty(CACHE_CONFIG_FILE);
             if (null == configFile) {
-                LOGGER.warn("Config file not set using system property: " + CACHE_CONFIG_FILE
-                        + ". Using default settings");
+                LOGGER.warn("Config file not set using system property: {}. Using default settings", CACHE_CONFIG_FILE);
 
                 hazelcast = Hazelcast.newHazelcastInstance();
             } else {

diff --git a/...src/test/java/uk/gov/gchq/gaffer/hdfs/integration/loader/AddElementsFromHdfsLoaderIT.java b/...src/test/java/uk/gov/gchq/gaffer/hdfs/integration/loader/AddElementsFromHdfsLoaderIT.java
@@ -113,8 +113,7 @@ public void _setup() throws Exception {
                     .replaceFirst("/$", "")
                     + testFolder.getAbsolutePath();
 
-
-            logger.info("using root dir: " + root);
+            logger.info("using root dir: {}", root);
 
             inputDir1 = root + "/inputDir1";
             inputDir2 = root + "/inputDir2";

diff --git a/...er/sparkaccumulo/integration/operation/handler/scalardd/GetRDDOfAllElementsHandlerIT.java b/...er/sparkaccumulo/integration/operation/handler/scalardd/GetRDDOfAllElementsHandlerIT.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2021 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.sparkaccumulo.integration.operation.handler.scalardd;
 
 import com.google.common.collect.Sets;
@@ -473,7 +474,7 @@ private Graph getGraphForDirectRDDForIngestAggregation(final KeyPackage keyPacka
                 filesDir.mkdir();
                 failuresDir.mkdir();
             } catch (Exception e) {
-                LOGGER.error("Failed to create directory: " + e.getMessage());
+                LOGGER.error("Failed to create directory: {}", e.getMessage());
             }
 
             writeFile(keyPackage, graph.getSchema(), file);

diff --git a/...ulo-rest/src/test/java/uk/gov/gchq/gaffer/rest/factory/AccumuloDisableOperationsTest.java b/...ulo-rest/src/test/java/uk/gov/gchq/gaffer/rest/factory/AccumuloDisableOperationsTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 Crown Copyright
+ * Copyright 2016-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,7 +52,7 @@ private void createUpdatedPropertiesFile(AccumuloProperties accumuloProperties,
             properties.store(fos, "AccumuloDisableOperationsTest - " + filename + " with current zookeeper");
             fos.close();
         } catch (IOException e) {
-            LOGGER.error("Failed to write Properties file: " + filename + ": " + e.getMessage());
+            LOGGER.error("Failed to write Properties file: {} : {}", filename, e.getMessage());
         }
     }
 

diff --git a/...g-rest/src/main/java/uk/gov/gchq/gaffer/rest/controller/GraphConfigurationController.java b/...g-rest/src/main/java/uk/gov/gchq/gaffer/rest/controller/GraphConfigurationController.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Crown Copyright
+ * Copyright 2020-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -96,7 +96,7 @@ public Set<Class> getFilterFunctions(@PathVariable("inputClass") final String in
             try {
                 predicate = (Predicate) predicateClass.newInstance();
             } catch (final IllegalAccessException | InstantiationException e) {
-                LOGGER.warn("Failed to create new instance of " + predicateClass, e);
+                LOGGER.warn("Failed to create new instance of {}", predicateClass, e);
                 LOGGER.warn("Skipping");
                 continue;
             }

diff --git a/...a/uk/gov/gchq/gaffer/accumulostore/operation/hdfs/handler/AddElementsFromHdfsHandler.java b/...a/uk/gov/gchq/gaffer/accumulostore/operation/hdfs/handler/AddElementsFromHdfsHandler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 Crown Copyright
+ * Copyright 2016-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,7 +63,7 @@ public void doOperation(final AddElementsFromHdfs operation,
 
         if (null == operation.getSplitsFilePath()) {
             final String splitsFilePath = getPathWithSlashSuffix(operation.getWorkingPath()) + context.getJobId() + "/splits";
-            LOGGER.info("Using working directory for splits files: " + splitsFilePath);
+            LOGGER.info("Using working directory for splits files: {}", splitsFilePath);
             operation.setSplitsFilePath(splitsFilePath);
         }
 

diff --git a/...cumulostore/operation/hdfs/handler/job/factory/AccumuloAddElementsFromHdfsJobFactory.java b/...cumulostore/operation/hdfs/handler/job/factory/AccumuloAddElementsFromHdfsJobFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 Crown Copyright
+ * Copyright 2016-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.accumulostore.operation.hdfs.handler.job.factory;
 
 import org.apache.accumulo.core.client.mapreduce.AccumuloFileOutputFormat;
@@ -102,7 +103,7 @@ public void setupJob(final Job job, final AddElementsFromHdfs operation, final S
         if (!NoPartitioner.class.equals(operation.getPartitioner())) {
             if (null != operation.getPartitioner()) {
                 operation.setPartitioner(GafferKeyRangePartitioner.class);
-                LOGGER.warn("Partitioner class " + operation.getPartitioner().getName() + " will be replaced with " + GafferKeyRangePartitioner.class.getName());
+                LOGGER.warn("Partitioner class {} will be replaced with {}", operation.getPartitioner().getName(), GafferKeyRangePartitioner.class.getName());
             }
             setupPartitioner(job, operation, (AccumuloStore) store);
         }

diff --git a/.../src/test/java/uk/gov/gchq/gaffer/accumulostore/operation/impl/CreateSplitPointsTest.java b/.../src/test/java/uk/gov/gchq/gaffer/accumulostore/operation/impl/CreateSplitPointsTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2021 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -86,7 +86,7 @@ public void setup() throws IOException {
                 + testFolder.getAbsolutePath();
 
 
-        LOGGER.info("using root dir: " + root);
+        LOGGER.info("using root dir: {}", root);
 
         inputDir = root + "/inputDir";
         outputDir = root + "/outputDir";

diff --git a/...ederated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedGraphStorage.java b/...ederated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedGraphStorage.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2021 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -451,7 +451,7 @@ private void makeAllGraphsFromCache() throws StorageException {
             try {
                 makeGraphFromCache(graphId);
             } catch (final Exception e) {
-                LOGGER.error(String.format("Skipping graphId: %s due to: %s", graphId, e.getMessage()), e);
+                LOGGER.error("Skipping graphId: {} due to: {}", graphId, e.getMessage(), e);
             }
         }
     }
@@ -511,7 +511,7 @@ private boolean changeGraphAccess(final String graphId, final FederatedAccess ne
                 } catch (final CacheOperationException e) {
                     //TODO FS recovery
                     String s = "Error occurred updating graphAccess. GraphStorage=updated, Cache=outdated. graphId:" + graphId;
-                    LOGGER.error(s + " graphStorage access:{} cache access:{}", newFederatedAccess, oldAccess);
+                    LOGGER.error("{} graphStorage access:{} cache access:{}", s, newFederatedAccess, oldAccess);
                     throw new StorageException(s, e);
                 }
             }
@@ -590,7 +590,7 @@ private boolean changeGraphId(final String graphId, final String newGraphId, fin
                     federatedStoreCache.addGraphToCache(newGraphSerialisable, key, true);
                 } catch (final CacheOperationException e) {
                     String s = "Contact Admin for recovery. Error occurred updating graphId. GraphStorage=updated, Cache=outdated graphId.";
-                    LOGGER.error(s + " graphStorage graphId:{} cache graphId:{}", newGraphId, graphId);
+                    LOGGER.error("{} graphStorage graphId:{} cache graphId:{}", s, newGraphId, graphId);
                     throw new StorageException(s, e);
                 }
                 federatedStoreCache.deleteGraphFromCache(graphId);

diff --git a/...entation/map-store/src/main/java/uk/gov/gchq/gaffer/mapstore/impl/AddElementsHandler.java b/...entation/map-store/src/main/java/uk/gov/gchq/gaffer/mapstore/impl/AddElementsHandler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.gaffer.mapstore.impl;
 
 import org.slf4j.Logger;
@@ -65,7 +66,7 @@ private void addElements(final Iterable<? extends Element> elements, final MapSt
             // Add all elements directly
             addBatch(mapImpl, schema, elements);
         } else {
-            LOGGER.info("Adding elements in batches, batch size = " + bufferSize);
+            LOGGER.info("Adding elements in batches, batch size = {}", bufferSize);
             int count = 0;
             final List<Element> batch = new ArrayList<>(bufferSize);
             for (final Element element : elements) {