fix: Fix sonar issues (iluwatar#2925)

* Remove unused member which was also causing a false positive sonar issue.
Fixes sonar issue https://sonarcloud.io/project/issues?open=AY3gHwu5DIZTZkppqVEG&id=iluwatar_java-design-patterns

* Fixes sonar issue https://sonarcloud.io/project/issues?open=AXK0OzDA-CiGJS70dLki&id=iluwatar_java-design-patterns
related to "Refactor the code of the lambda to not have multiple invocations throwing the same checked exception."

Also, updated the code to use Instant and Duration to deal with time instead of int. Added the awaitility
library to perform assertions in test which is more reliable than using Thread.sleep directly to wait for events to happen.

* checkstyle fix

* Add sneaky throws to fix sonar lint issue. This is fine as the newFile method is not being tested but instead the new SimpleFileWriter(...) is.

* The first booking needs to happen outside the assertions. Fixed other warnings

* Use records to pass around related objects instead of using a large number of
individual params, which sonar did not like.

* Checkstyle fixes

* checkstyle fixes

* Remove complexity to keep sonar happy.

* Split into different methods to reduce complexity. Could be broken down even further but currently Sonar is happy.

* Move files to correct package

* Add valid assertions to tests

* rename constants to avoid confusion

* Sonar warning related to cognitive complexity can be suppressed as the methods are quite generic and not functional enough to be separated out.

* Use constants to keep Sonar happy

* Use correct constant naming conventions

* Use correct constant naming conventions

* Use lombok to define noargsconstructor

* Use a single method to do the logging

* Remove unused constructor and redundant method

* Use a reusable method for logging

Author: k1w1dev

commander/src/main/java/com/iluwatar/commander/AppEmployeeDbFailCases.java

@@ -41,15 +41,11 @@
  * available/unavailable.
  */
 public class AppEmployeeDbFailCases {
-  private final int numOfRetries = 3;
-  private final long retryDuration = 30000;
-  private final long queueTime = 240000; //4 mins
-  private final long queueTaskTime = 60000; //1 min
-  private final long paymentTime = 120000; //2 mins
-  private final long messageTime = 150000; //2.5 mins
-  private final long employeeTime = 240000; //4 mins
+  private static final RetryParams retryParams = RetryParams.DEFAULT;
 
-  void employeeDatabaseUnavailableCase() throws Exception {
+  private static final TimeLimits timeLimits = TimeLimits.DEFAULT;
+
+  void employeeDatabaseUnavailableCase() {
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -64,22 +60,20 @@ void employeeDatabaseUnavailableCase() throws Exception {
         new QueueDatabase(new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void employeeDbSuccessCase() throws Exception {
+  void employeeDbSuccessCase() {
     var ps = new PaymentService(new PaymentDatabase());
     var ss = new ShippingService(new ShippingDatabase(), new ItemUnavailableException());
     var ms = new MessagingService(new MessagingDatabase());
     var eh = new EmployeeHandle(new EmployeeDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException());
     var qdb = new QueueDatabase();
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
@@ -91,9 +85,8 @@ void employeeDbSuccessCase() throws Exception {
    * @param args command line args
    */
 
-  public static void main(String[] args) throws Exception {
+  public static void main(String[] args) {
     var aefc = new AppEmployeeDbFailCases();
-    //aefc.employeeDatabaseUnavailableCase();
     aefc.employeeDbSuccessCase();
   }
-}
+}

commander/src/main/java/com/iluwatar/commander/AppMessagingFailCases.java

@@ -41,15 +41,12 @@
  */
 
 public class AppMessagingFailCases {
-  private final int numOfRetries = 3;
-  private final long retryDuration = 30000;
-  private final long queueTime = 240000; //4 mins
-  private final long queueTaskTime = 60000; //1 min
-  private final long paymentTime = 120000; //2 mins
-  private final long messageTime = 150000; //2.5 mins
-  private final long employeeTime = 240000; //4 mins
+  private static final RetryParams retryParams = RetryParams.DEFAULT;
 
-  void messagingDatabaseUnavailableCasePaymentSuccess() throws Exception {
+  private static final TimeLimits timeLimits = TimeLimits.DEFAULT;
+
+
+  void messagingDatabaseUnavailableCasePaymentSuccess() {
     //rest is successful
     var ps = new PaymentService(new PaymentDatabase());
     var ss = new ShippingService(new ShippingDatabase());
@@ -59,14 +56,13 @@ void messagingDatabaseUnavailableCasePaymentSuccess() throws Exception {
         new DatabaseUnavailableException());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase();
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void messagingDatabaseUnavailableCasePaymentError() throws Exception {
+  void messagingDatabaseUnavailableCasePaymentError() {
     //rest is successful
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -84,14 +80,13 @@ void messagingDatabaseUnavailableCasePaymentError() throws Exception {
         new DatabaseUnavailableException());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase();
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void messagingDatabaseUnavailableCasePaymentFailure() throws Exception {
+  void messagingDatabaseUnavailableCasePaymentFailure() {
     //rest is successful
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -107,15 +102,13 @@ void messagingDatabaseUnavailableCasePaymentFailure() throws Exception {
         new QueueDatabase(new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c =
-        new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration, queueTime, queueTaskTime,
-            paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void messagingSuccessCase() throws Exception {
+  void messagingSuccessCase() {
     //done here
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -126,8 +119,7 @@ void messagingSuccessCase() throws Exception {
         new DatabaseUnavailableException());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase();
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
@@ -139,11 +131,8 @@ void messagingSuccessCase() throws Exception {
    * @param args command line args
    */
 
-  public static void main(String[] args) throws Exception {
+  public static void main(String[] args) {
     var amfc = new AppMessagingFailCases();
-    //amfc.messagingDatabaseUnavailableCasePaymentSuccess();
-    //amfc.messagingDatabaseUnavailableCasePaymentError(); 
-    //amfc.messagingDatabaseUnavailableCasePaymentFailure(); 
     amfc.messagingSuccessCase();
   }
-}
+}

commander/src/main/java/com/iluwatar/commander/AppPaymentFailCases.java

@@ -41,29 +41,24 @@
  */
 
 public class AppPaymentFailCases {
-  private final int numOfRetries = 3;
-  private final long retryDuration = 30000;
-  private final long queueTime = 240000; //4 mins
-  private final long queueTaskTime = 60000; //1 min
-  private final long paymentTime = 120000; //2 mins
-  private final long messageTime = 150000; //2.5 mins
-  private final long employeeTime = 240000; //4 mins
+  private static final RetryParams retryParams = RetryParams.DEFAULT;
 
-  void paymentNotPossibleCase() throws Exception {
+  private static final TimeLimits timeLimits = TimeLimits.DEFAULT;
+
+  void paymentNotPossibleCase() {
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new PaymentDetailsErrorException());
     var ss = new ShippingService(new ShippingDatabase());
     var ms = new MessagingService(new MessagingDatabase(), new DatabaseUnavailableException());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase(new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void paymentDatabaseUnavailableCase() throws Exception {
+  void paymentDatabaseUnavailableCase() {
     //rest is successful
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -73,14 +68,13 @@ void paymentDatabaseUnavailableCase() throws Exception {
     var ms = new MessagingService(new MessagingDatabase());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase();
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void paymentSuccessCase() throws Exception {
+  void paymentSuccessCase() {
     //goes to message after 2 retries maybe - rest is successful for now
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException());
@@ -89,8 +83,7 @@ void paymentSuccessCase() throws Exception {
         new MessagingService(new MessagingDatabase(), new DatabaseUnavailableException());
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb = new QueueDatabase(new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
@@ -102,10 +95,8 @@ void paymentSuccessCase() throws Exception {
    * @param args command line args
    */
 
-  public static void main(String[] args) throws Exception {
+  public static void main(String[] args) {
     var apfc = new AppPaymentFailCases();
-    //apfc.paymentNotPossibleCase();
-    //apfc.paymentDatabaseUnavailableCase();
     apfc.paymentSuccessCase();
   }
-}
+}

commander/src/main/java/com/iluwatar/commander/AppQueueFailCases.java

@@ -41,15 +41,12 @@
  */
 
 public class AppQueueFailCases {
-  private final int numOfRetries = 3;
-  private final long retryDuration = 30000;
-  private final long queueTime = 240000; //4 mins
-  private final long queueTaskTime = 60000; //1 min
-  private final long paymentTime = 120000; //2 mins
-  private final long messageTime = 150000; //2.5 mins
-  private final long employeeTime = 240000; //4 mins
+  private static final RetryParams retryParams = RetryParams.DEFAULT;
 
-  void queuePaymentTaskDatabaseUnavailableCase() throws Exception {
+  private static final TimeLimits timeLimits = TimeLimits.DEFAULT;
+
+
+  void queuePaymentTaskDatabaseUnavailableCase() {
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -61,14 +58,13 @@ void queuePaymentTaskDatabaseUnavailableCase() throws Exception {
         new QueueDatabase(new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void queueMessageTaskDatabaseUnavailableCase() throws Exception {
+  void queueMessageTaskDatabaseUnavailableCase() {
     var ps = new PaymentService(new PaymentDatabase());
     var ss = new ShippingService(new ShippingDatabase());
     var ms = new MessagingService(new MessagingDatabase(), new DatabaseUnavailableException(),
@@ -80,14 +76,13 @@ void queueMessageTaskDatabaseUnavailableCase() throws Exception {
         new QueueDatabase(new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void queueEmployeeDbTaskDatabaseUnavailableCase() throws Exception {
+  void queueEmployeeDbTaskDatabaseUnavailableCase() {
     var ps = new PaymentService(new PaymentDatabase());
     var ss = new ShippingService(new ShippingDatabase(), new ItemUnavailableException());
     var ms = new MessagingService(new MessagingDatabase());
@@ -105,14 +100,13 @@ void queueEmployeeDbTaskDatabaseUnavailableCase() throws Exception {
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException(),
             new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
   }
 
-  void queueSuccessCase() throws Exception {
+  void queueSuccessCase() {
     var ps = new PaymentService(new PaymentDatabase(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
         new DatabaseUnavailableException(), new DatabaseUnavailableException(),
@@ -124,8 +118,7 @@ void queueSuccessCase() throws Exception {
     var eh = new EmployeeHandle(new EmployeeDatabase());
     var qdb =
         new QueueDatabase(new DatabaseUnavailableException(), new DatabaseUnavailableException());
-    var c = new Commander(eh, ps, ss, ms, qdb, numOfRetries, retryDuration,
-        queueTime, queueTaskTime, paymentTime, messageTime, employeeTime);
+    var c = new Commander(eh, ps, ss, ms, qdb, retryParams, timeLimits);
     var user = new User("Jim", "ABCD");
     var order = new Order(user, "book", 10f);
     c.placeOrder(order);
@@ -137,11 +130,8 @@ void queueSuccessCase() throws Exception {
    * @param args command line args
    */
 
-  public static void main(String[] args) throws Exception {
+  public static void main(String[] args) {
     var aqfc = new AppQueueFailCases();
-    //aqfc.queuePaymentTaskDatabaseUnavailableCase();
-    //aqfc.queueMessageTaskDatabaseUnavailableCase();
-    //aqfc.queueEmployeeDbTaskDatabaseUnavailableCase();
     aqfc.queueSuccessCase();
   }
-}
+}