refactoring: Critical Sonar Issues (iluwatar#1833)

sims-keshri · ohbus · web-flow · commit 5a644f109207 · 2021-10-13T13:15:22.000+05:30
* Resolve Sonar Code Smell: Define a constant instead of duplicating this literal 'Space rocket &lt;' 4 times.

* Resolve Sonar Critical Code Smell: Define a constant instead of duplicating this literal 'Error connecting to MongoDB' 4 times.

* Fix checkstyle violation.

* Resolve Sonar Critical Code Smell: Define a constant instead of duplicating this literal 'LITERAL 0' 4 times.

Co-authored-by: Subhrodip Mohanta &lt;hello@subho.xyz&gt;
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java
@@ -59,9 +59,12 @@
 @Slf4j
 public class App {
 
+  private static final String ROCKET_LAUNCH_LOG_PATTERN = "Space rocket <%s> launched successfully";
+
   /**
    * Program entry point.
    */
+
   public static void main(String[] args) throws Exception {
     // construct a new executor that will run async tasks
     var executor = new ThreadAsyncExecutor();
@@ -87,9 +90,9 @@ public static void main(String[] args) throws Exception {
     asyncResult5.await();
 
     // log the results of the tasks, callbacks log immediately when complete
-    log("Space rocket <" + result1 + "> launch complete");
-    log("Space rocket <" + result2 + "> launch complete");
-    log("Space rocket <" + result3 + "> launch complete");
+    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result1));
+    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result2));
+    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result3));
   }
 
   /**
@@ -102,7 +105,7 @@ public static void main(String[] args) throws Exception {
   private static <T> Callable<T> lazyval(T value, long delayMillis) {
     return () -> {
       Thread.sleep(delayMillis);
-      log("Space rocket <" + value + "> launched successfully");
+      log(String.format(ROCKET_LAUNCH_LOG_PATTERN, value));
       return value;
     };
   }
diff --git a/bytecode/src/main/java/com/iluwatar/bytecode/App.java b/bytecode/src/main/java/com/iluwatar/bytecode/App.java
@@ -42,6 +42,14 @@
 @Slf4j
 public class App {
 
+  private static final String LITERAL_0 = "LITERAL 0";
+  private static final String HEALTH_PATTERN = "%s_HEALTH";
+  private static final String GET_AGILITY = "GET_AGILITY";
+  private static final String GET_WISDOM = "GET_WISDOM";
+  private static final String ADD = "ADD";
+  private static final String LITERAL_2 = "LITERAL 2";
+  private static final String DIVIDE = "DIVIDE";
+
   /**
    * Main app method.
    *
@@ -53,17 +61,17 @@ public static void main(String[] args) {
         new Wizard(45, 7, 11, 0, 0),
         new Wizard(36, 18, 8, 0, 0));
 
-    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("GET_HEALTH"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("GET_AGILITY"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("GET_WISDOM"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("ADD"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 2"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("DIVIDE"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("ADD"));
-    vm.execute(InstructionConverterUtil.convertToByteCode("SET_HEALTH"));
+    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode(String.format(HEALTH_PATTERN, "GET")));
+    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode(GET_AGILITY));
+    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode(GET_WISDOM));
+    vm.execute(InstructionConverterUtil.convertToByteCode(ADD));
+    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_2));
+    vm.execute(InstructionConverterUtil.convertToByteCode(DIVIDE));
+    vm.execute(InstructionConverterUtil.convertToByteCode(ADD));
+    vm.execute(InstructionConverterUtil.convertToByteCode(String.format(HEALTH_PATTERN, "SET")));
   }
 }
diff --git a/caching/src/main/java/com/iluwatar/caching/DbManager.java b/caching/src/main/java/com/iluwatar/caching/DbManager.java
@@ -50,6 +50,7 @@ public final class DbManager {
   private static boolean useMongoDB;
 
   private static Map<String, UserAccount> virtualDB;
+  private static final String ERROR_MESSAGE_LOG = "Error connecting to MongoDB";
 
   private DbManager() {
   }
@@ -85,7 +86,7 @@ public static UserAccount readFromDb(String userId) {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error("Error connecting to MongoDB", e);
+        LOGGER.error(ERROR_MESSAGE_LOG, e);
       }
     }
     var iterable = db
@@ -112,7 +113,7 @@ public static void writeToDb(UserAccount userAccount) {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error("Error connecting to MongoDB", e);
+        LOGGER.error(ERROR_MESSAGE_LOG, e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).insertOne(
@@ -134,7 +135,7 @@ public static void updateDb(UserAccount userAccount) {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error("Error connecting to MongoDB", e);
+        LOGGER.error(ERROR_MESSAGE_LOG, e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(
@@ -155,7 +156,7 @@ public static void upsertDb(UserAccount userAccount) {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error("Error connecting to MongoDB", e);
+        LOGGER.error(ERROR_MESSAGE_LOG, e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@ public final class DbManager {`
`50`	`50`	`private static boolean useMongoDB;`
`51`	`51`
`52`	`52`	`private static Map<String, UserAccount> virtualDB;`
	`53`	`+ private static final String ERROR_MESSAGE_LOG = "Error connecting to MongoDB";`
`53`	`54`
`54`	`55`	`private DbManager() {`
`55`	`56`	`}`
`@@ -85,7 +86,7 @@ public static UserAccount readFromDb(String userId) {`
`85`	`86`	`try {`
`86`	`87`	`connect();`
`87`	`88`	`} catch (ParseException e) {`
`88`		`- LOGGER.error("Error connecting to MongoDB", e);`
	`89`	`+ LOGGER.error(ERROR_MESSAGE_LOG, e);`
`89`	`90`	`}`
`90`	`91`	`}`
`91`	`92`	`var iterable = db`
`@@ -112,7 +113,7 @@ public static void writeToDb(UserAccount userAccount) {`
`112`	`113`	`try {`
`113`	`114`	`connect();`
`114`	`115`	`} catch (ParseException e) {`
`115`		`- LOGGER.error("Error connecting to MongoDB", e);`
	`116`	`+ LOGGER.error(ERROR_MESSAGE_LOG, e);`
`116`	`117`	`}`
`117`	`118`	`}`
`118`	`119`	`db.getCollection(CachingConstants.USER_ACCOUNT).insertOne(`
`@@ -134,7 +135,7 @@ public static void updateDb(UserAccount userAccount) {`
`134`	`135`	`try {`
`135`	`136`	`connect();`
`136`	`137`	`} catch (ParseException e) {`
`137`		`- LOGGER.error("Error connecting to MongoDB", e);`
	`138`	`+ LOGGER.error(ERROR_MESSAGE_LOG, e);`
`138`	`139`	`}`
`139`	`140`	`}`
`140`	`141`	`db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(`
`@@ -155,7 +156,7 @@ public static void upsertDb(UserAccount userAccount) {`
`155`	`156`	`try {`
`156`	`157`	`connect();`
`157`	`158`	`} catch (ParseException e) {`
`158`		`- LOGGER.error("Error connecting to MongoDB", e);`
	`159`	`+ LOGGER.error(ERROR_MESSAGE_LOG, e);`
`159`	`160`	`}`
`160`	`161`	`}`
`161`	`162`	`db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(`