#970 single logging framework should be enforced (#982)

* #496 Add pipeline module to parent pom ✨ * #496: Add main application class and test for pipeline * #496: Checkstyle format and add log messages on pipeline stages 🎨 * #496: Fill readme sections of pipeline ✨ * #496: Javadocs and checkstyle formatting 🎨 * #496: Follow PMD checks and add more explanation as block comment on App.java * #496: Apply requested PR changes by iluwatar 🎨 * #970: Replace log4j usage on commander pattern to Slf4j API 🎨 * #970: Replace log4j usage on dao pattern to Slf4j API 🎨 * #970: Replace log4j usage on data mapper pattern to Slf4j API 🎨 * #970: Remove log4j dependency on data transfer object pom 🔥 * #970: Replace log4j usage on module pattern to Slf4j API 🎨 * #970: Replace log4j usage on serverless pattern to Slf4j API 🎨 This also removes the aws log4j dependency * #970: Remove unnecessary gitignore line for log4j.xml 🔥 * #970: Remove remaining remnants of log4j 🔥 * #970: Replace System.out logging with appropriate logging methods 🎨 * #970: Replace System.out method references to Logger::info 🎨

Author: jjjimenez100

.gitignore

@@ -16,5 +16,4 @@ datanucleus.log
 /bin/
 /bin/
 *.log
-data-mapper/src/main/resources/log4j.xml
 event-sourcing/Journal.json

collection-pipeline/src/test/java/com/iluwatar/collectionpipeline/AppTest.java

@@ -30,12 +30,15 @@
 import java.util.Map;
 
 import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Tests that Collection Pipeline methods work as expected.
  */
 public class AppTest {
- 
+ private static final Logger LOGGER = LoggerFactory.getLogger(AppTest.class);
+
  private List<Car> cars = CarFactory.createCars();
 
  @Test
@@ -61,7 +64,7 @@ public void testGetGroupingOfCarsByCategory() {
  new Car("Jeep", "Comanche", 1990, Category.JEEP)));
  Map<Category, List<Car>> modelsFunctional = FunctionalProgramming.getGroupingOfCarsByCategory(cars);
  Map<Category, List<Car>> modelsImperative = ImperativeProgramming.getGroupingOfCarsByCategory(cars);
- System.out.println("Category " + modelsFunctional);
+ LOGGER.info("Category " + modelsFunctional);
  assertEquals(modelsExpected, modelsFunctional);
  assertEquals(modelsExpected, modelsImperative);
  }

commander/pom.xml

@@ -36,10 +36,5 @@
  <artifactId>junit-jupiter-engine</artifactId>
  <scope>test</scope>
  </dependency>
- <dependency>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- <version>1.2.17</version>
- </dependency>
  </dependencies>
 </project>

commander/properties/log4j.properties

@@ -23,7 +23,6 @@
 package com.iluwatar.commander;
 
 import java.util.ArrayList;
-import org.apache.log4j.Logger;
 import com.iluwatar.commander.employeehandle.EmployeeHandle;
 import com.iluwatar.commander.exceptions.DatabaseUnavailableException;
 import com.iluwatar.commander.exceptions.ItemUnavailableException;
@@ -37,6 +36,8 @@
 import com.iluwatar.commander.queue.QueueTask;
 import com.iluwatar.commander.queue.QueueTask.TaskType;
 import com.iluwatar.commander.shippingservice.ShippingService;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  *<p>Commander pattern is used to handle all issues that can come up while making a
@@ -86,7 +87,7 @@ public class Commander {
  private final long messageTime;
  private final long employeeTime; 
  private boolean finalSiteMsgShown;
- static final Logger LOG = Logger.getLogger(Commander.class);
+ static final Logger LOG = LoggerFactory.getLogger(Commander.class);
  //we could also have another db where it stores all orders
 
  Commander(EmployeeHandle empDb, PaymentService pService, ShippingService sService,
@@ -125,27 +126,27 @@ private void sendShippingRequest(Order order) throws Exception {
  String transactionId = shippingService.receiveRequest(order.item, order.user.address); 
  //could save this transaction id in a db too
  LOG.info("Order " + order.id + ": Shipping placed successfully, transaction id: " + transactionId);
- System.out.println("Order has been placed and will be shipped to you. Please wait while we make your"
+ LOG.info("Order has been placed and will be shipped to you. Please wait while we make your"
  + " payment... "); 
  sendPaymentRequest(order); 
  return; 
  };
  Retry.HandleErrorIssue<Order> handleError = (o,err) -> {
  if (ShippingNotPossibleException.class.isAssignableFrom(err.getClass())) {
- System.out.println("Shipping is currently not possible to your address. We are working on the problem "
+ LOG.info("Shipping is currently not possible to your address. We are working on the problem "
  + "and will get back to you asap.");
  finalSiteMsgShown = true;
  LOG.info("Order " + order.id + ": Shipping not possible to address, trying to add problem to employee db..");
  employeeHandleIssue(o);
  } else if (ItemUnavailableException.class.isAssignableFrom(err.getClass())) {
- System.out.println("This item is currently unavailable. We will inform you as soon as the item becomes "
+ LOG.info("This item is currently unavailable. We will inform you as soon as the item becomes "
  + "available again.");
  finalSiteMsgShown = true;
  LOG.info("Order " + order.id + ": Item " + order.item + " unavailable, trying to add problem to employee "
  + "handle..");
  employeeHandleIssue(o);
  } else {
- System.out.println("Sorry, there was a problem in creating your order. Please try later.");
+ LOG.info("Sorry, there was a problem in creating your order. Please try later.");
  LOG.error("Order " + order.id + ": Shipping service unavailable, order not placed..");
  finalSiteMsgShown = true;
  }
@@ -183,7 +184,7 @@ public void run() {
  order.paid = PaymentStatus.Done; 
  LOG.info("Order " + order.id + ": Payment successful, transaction Id: " + transactionId);
  if (!finalSiteMsgShown) { 
- System.out.println("Payment made successfully, thank you for shopping with us!!"); 
+ LOG.info("Payment made successfully, thank you for shopping with us!!"); 
  finalSiteMsgShown = true; 
  } 
  sendSuccessMessage(order); 
@@ -193,7 +194,7 @@ public void run() {
  Retry.HandleErrorIssue<Order> handleError = (o,err) -> {
  if (PaymentDetailsErrorException.class.isAssignableFrom(err.getClass())) {
  if (!finalSiteMsgShown) {
- System.out.println("There was an error in payment. Your account/card details may have been incorrect. "
+ LOG.info("There was an error in payment. Your account/card details may have been incorrect. "
  + "Meanwhile, your order has been converted to COD and will be shipped.");
  finalSiteMsgShown = true;
  }
@@ -204,7 +205,7 @@ public void run() {
  try {
  if (o.messageSent.equals(MessageSent.NoneSent)) {
  if (!finalSiteMsgShown) {
- System.out.println("There was an error in payment. We are on it, and will get back to you "
+ LOG.info("There was an error in payment. We are on it, and will get back to you "
  + "asap. Don't worry, your order has been placed and will be shipped.");
  finalSiteMsgShown = true;
  }

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

@@ -24,6 +24,8 @@
 
 import com.iluwatar.commander.Service;
 import com.iluwatar.commander.exceptions.DatabaseUnavailableException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * The MessagingService is used to send messages to user regarding their order and 
@@ -32,6 +34,7 @@
  */
 
 public class MessagingService extends Service {
+ private static final Logger LOGGER = LoggerFactory.getLogger(MessagingService.class);
 
  enum MessageToSend {
  PaymentFail, PaymentTrying, PaymentSuccessful
@@ -74,7 +77,7 @@ protected String updateDb(Object...parameters) throws DatabaseUnavailableExcepti
  MessageRequest req = (MessageRequest) parameters[0];
  if (this.database.get(req.reqId) == null) { //idempotence, in case db fails here
  database.add(req); //if successful:
- System.out.println(sendMessage(req.msg));
+ LOGGER.info(sendMessage(req.msg));
  return req.reqId;
  }
  return null;

commander/src/main/java/com/iluwatar/commander/messagingservice/MessagingService.java

@@ -24,6 +24,8 @@
 
 
 import com.google.common.collect.Lists;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -35,6 +37,8 @@
  * objects between types.
  */
 public class App {
+ 
+ private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
  /**
  * Program entry point
  *
@@ -45,16 +49,16 @@ public static void main(String[] args) {
 
  UserDto dtoUser = new UserDto("John", "Doe", true, "whatever[at]wherever.com");
  User user = userConverter.convertFromDto(dtoUser);
- System.out.println("Entity converted from DTO:" + user);
+ LOGGER.info("Entity converted from DTO:" + user);
 
  ArrayList<User> users = Lists.newArrayList(new User("Camile", "Tough", false, "124sad"),
  new User("Marti", "Luther", true, "42309fd"), new User("Kate", "Smith", true, "if0243"));
- System.out.println("Domain entities:");
- users.forEach(System.out::println);
+ LOGGER.info("Domain entities:");
+ users.stream().map(User::toString).forEach(LOGGER::info);
 
- System.out.println("DTO entities converted from domain:");
+ LOGGER.info("DTO entities converted from domain:");
  List<UserDto> dtoEntities = userConverter.createFromEntities(users);
- dtoEntities.forEach(System.out::println);
+ dtoEntities.stream().map(UserDto::toString).forEach(LOGGER::info);
 
  }
 }

converter/src/main/java/com/iluwatar/converter/App.java

@@ -40,10 +40,6 @@
  <artifactId>junit-jupiter-engine</artifactId>
  <scope>test</scope>
  </dependency>
- <dependency>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- </dependency>
  <dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
@@ -53,49 +49,4 @@
  <artifactId>mockito-core</artifactId>
  </dependency>
  </dependencies>
-
- <build>
-
- <!-- 
- log4j.xml file will be copied both in ${project.build.outputDirectory} 
- and ${project.build.directory}. Thanks to Sean Patrick Floyd 
- (http://stackoverflow.com/questions/5637532/maven-how-to-place-resource-file-together-with-jar) 
- -->
- 
- <resources>
- <resource> <!-- regular processing for every resource file -->
- <directory>src/main/resources</directory>
- </resource>
- <resource> <!-- processing with a different output directory for log4j.xml -->
- <directory>src/main/resources</directory>
- <includes>
- <include>log4j.xml</include>
- </includes>
- <targetPath>..</targetPath> <!-- relative to target/classes i.e. ${project.build.directory} -->
- </resource>
- </resources>
-
- <plugins>
-
- <!-- 
- This will exclude log4j.xml file from generated JAR 
- -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jar-plugin</artifactId>
- <version>2.6</version>
- <configuration>
- <excludes>
- <exclude>log4j.xml</exclude>
- </excludes>
- <archive>
- <manifest>
- <addClasspath>true</addClasspath>
- </manifest>
- </archive>
- </configuration>
- </plugin>
-
- </plugins>
- </build>
 </project>

dao/pom.xml

@@ -31,8 +31,9 @@
 
 import javax.sql.DataSource;
 
-import org.apache.log4j.Logger;
 import org.h2.jdbcx.JdbcDataSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Data Access Object (DAO) is an object that provides an abstract interface to some type of
@@ -50,7 +51,7 @@
  */
 public class App {
  private static final String DB_URL = "jdbc:h2:~/dao";
- private static Logger log = Logger.getLogger(App.class);
+ private static Logger log = LoggerFactory.getLogger(App.class);
  private static final String ALL_CUSTOMERS = "customerDao.getAllCustomers(): ";
 
  /**
@@ -94,7 +95,7 @@ private static void performOperationsUsing(final CustomerDao customerDao) throws
  addCustomers(customerDao);
  log.info(ALL_CUSTOMERS);
  try (Stream<Customer> customerStream = customerDao.getAll()) {
- customerStream.forEach((customer) -> log.info(customer));
+ customerStream.forEach((customer) -> log.info(customer.toString()));
  }
  log.info("customerDao.getCustomerById(2): " + customerDao.getById(2));
  final Customer customer = new Customer(4, "Dan", "Danson");
@@ -105,7 +106,7 @@ private static void performOperationsUsing(final CustomerDao customerDao) throws
  customerDao.update(customer);
  log.info(ALL_CUSTOMERS);
  try (Stream<Customer> customerStream = customerDao.getAll()) {
- customerStream.forEach((cust) -> log.info(cust));
+ customerStream.forEach((cust) -> log.info(cust.toString()));
  }
  customerDao.delete(customer);
  log.info(ALL_CUSTOMERS + customerDao.getAll());

dao/src/main/java/com/iluwatar/dao/App.java

@@ -22,6 +22,9 @@
  */
 package com.iluwatar.dao;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
@@ -35,15 +38,13 @@
 
 import javax.sql.DataSource;
 
-import org.apache.log4j.Logger;
-
 /**
  * An implementation of {@link CustomerDao} that persists customers in RDBMS.
  *
  */
 public class DbCustomerDao implements CustomerDao {
 
- private static final Logger LOGGER = Logger.getLogger(DbCustomerDao.class);
+ private static final Logger LOGGER = LoggerFactory.getLogger(DbCustomerDao.class);
 
  private final DataSource dataSource;