Logging improvements and changes (#297)

* Descriptions have been added/improved on exception logs
* Stack trace are always attached in exception logs
* Logs are parameterized instead of concatenated, with the exception of ConfigurationLogger because of its gargantuan size
* Trailing white spaces are removed from all files

Author: Christoffer-Cortes

CONTRIBUTING.md

@@ -59,20 +59,20 @@ Pull requests can be merged by members of the [the repository maintainers' team]
 ### License Management
 To be accepted into the repository, contributions must be licensed under the Apache License 2.0. Consequently, a license notice shall be included in suitable comment syntax where applicable. This license notice shall state the copyright holder(s) and point to the commit history for a full list of individual contributors, on the following format:
 
-> Copyright <Year(s)> <Copyright holder of original contribution [and others].>  
+> Copyright <Year(s)> <Copyright holder of original contribution [and others].>
 > For a full list of individual contributors, please see the commit history.
 
 The copyright holder is either the individual contributor if they act on their own behalf, or any organization on whose behalf they contribute. When multiple copyright holders have contributed to the same file, the copyright notice shall be appended "and others". The copyright year(s) shall reflect the year(s) of contribution(s) and be updated accordingly when new contributions are made to the file. To exemplify, the copyright notice of an original contribution made by Jane Doe acting on behalf of Ericsson AB may read:
 
-> Copyright 2018 Ericsson AB.  
+> Copyright 2018 Ericsson AB.
 > For a full list of individual contributors, please see the commit history.
 
 When John Doe, acting on his own behalf, makes a subsequent addition to the same file, the notice will be updated accordingly:
 
-> Copyright 2018 Ericsson AB and others.  
+> Copyright 2018 Ericsson AB and others.
 > For a full list of individual contributors, please see the commit history.
 
 When John Doe makes a subsequent contribution the following year, the notice will again be updated:
 
-> Copyright 2018-2019 Ericsson AB and others.  
+> Copyright 2018-2019 Ericsson AB and others.
 > For a full list of individual contributors, please see the commit history.

pom.xml

@@ -401,7 +401,7 @@
                 <version>${springBootVersion}</version>
             </plugin>
 
-            <!-- PhoenixNAP RAML Code Generator plugin used to generate sources 
+            <!-- PhoenixNAP RAML Code Generator plugin used to generate sources
                 from raml -->
             <plugin>
                 <groupId>com.phoenixnap.oss</groupId>
@@ -548,7 +548,7 @@
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <!-- site plugin requires all resources to exist 
+                            <!-- site plugin requires all resources to exist
                                 within resources/ directory -->
                             <!-- but we don't want to break links in documentation -->
                             <outputDirectory>${basedir}/wiki/resources/images</outputDirectory>
@@ -572,7 +572,7 @@
                 <configuration>
                     <!-- This is where site.xml is located -->
                     <siteDirectory>${basedir}/wiki</siteDirectory>
-                    <!-- Github pages only generates documentation from docs 
+                    <!-- Github pages only generates documentation from docs
                         directory -->
                     <outputDirectory>${basedir}/docs</outputDirectory>
                 </configuration>

src/functionaltests/java/com/ericsson/ei/files/DownloadFilesTestSteps.java

@@ -27,15 +27,15 @@
 public class DownloadFilesTestSteps extends FunctionalTestBase {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(DownloadFilesTestSteps.class);
-    
+
     private static final String SUBSCRIPTIONS_TEMPLATE_FILEPATH = "src/main/resources/templates/subscriptionsTemplate.json";
     private static final String RULES_TEMPLATE_FILEPATH = "src/main/resources/templates/rulesTemplate.json";
     private static final String EVENTS_TEMPLATE_FILEPATH = "src/main/resources/templates/eventsTemplate.json";
-    
+
     private ObjectMapper objMapper = new ObjectMapper();
     private HttpRequest httpRequest = new HttpRequest(HttpMethod.GET);
     ResponseEntity<String> response;
-    
+
     @LocalServerPort
     private int applicationPort;
     private String hostName = getHostName();
@@ -52,53 +52,53 @@ public void eiffel_intelligence_instance_is_up_and_running() throws Exception {
         response = httpRequest.performRequest();
         assertEquals(response.getStatusCode(), HttpStatus.OK);
     }
-    
+
     @Then("^List available files$")
     public void list_available_files() throws Exception {
         LOGGER.debug("Listing all availble files that can be download via RestApi.");
         String expectedSubscriptionsValue =  "/download/subscriptionsTemplate";
 
         httpRequest.setEndpoint("/download");
         response = httpRequest.performRequest();
-        
+
         assertEquals(HttpStatus.OK, response.getStatusCode());
-        
+
         String actualSubscriptionsValue = objMapper.readValue(response.getBody(), JsonNode.class).get("subscriptions").asText();
         assertEquals("List all files don't return expected subscriptions file value. \nExpected: "
         + expectedSubscriptionsValue + "\nActual: "+ actualSubscriptionsValue,
         expectedSubscriptionsValue, actualSubscriptionsValue);
     }
-    
+
     @And("^Get subscription template file$")
     public void get_subscription_template_file() throws Exception {
         String expectedSubscriptionTemplateContent = FileUtils.readFileToString(new File(SUBSCRIPTIONS_TEMPLATE_FILEPATH), "UTF-8");
 
         httpRequest.setEndpoint("/download/subscriptionsTemplate");
         response = httpRequest.performRequest();
-        
+
         assertEquals(HttpStatus.OK, response.getStatusCode());
-        
+
         String actualSubscriptionTemplateContent = response.getBody();
         assertEquals("Get SubscriptionTemplate file failed or contents is not as expected. \nExpected: "
         + expectedSubscriptionTemplateContent + "\nActual: "+ actualSubscriptionTemplateContent,
         expectedSubscriptionTemplateContent, actualSubscriptionTemplateContent);
     }
-    
+
     @And("^Get rules template file$")
     public void get_rules_template_file() throws Exception {
         String expectedRulesTemplateContent = FileUtils.readFileToString(new File(RULES_TEMPLATE_FILEPATH), "UTF-8");
-        
+
         httpRequest.setEndpoint("/download/rulesTemplate");
         response = httpRequest.performRequest();
-        
+
         assertEquals(HttpStatus.OK, response.getStatusCode());
-        
+
         String actualRulesTemplateContent = response.getBody();
         assertEquals("Get RulesTemplate file failed or contents is not as expected. \nExpected: "
         + expectedRulesTemplateContent + "\nActual: "+ actualRulesTemplateContent,
         expectedRulesTemplateContent, actualRulesTemplateContent);
     }
-    
+
     @And("^Get event template file$")
     public void get_event_template_file() throws Exception {
         String expectedEventsTemplateContent = FileUtils.readFileToString(new File(EVENTS_TEMPLATE_FILEPATH), "UTF-8");

src/functionaltests/java/com/ericsson/ei/threadingAndWaitlistRepeat/ThreadingAndWaitlistRepeatSteps.java

@@ -46,7 +46,7 @@ public class ThreadingAndWaitlistRepeatSteps extends FunctionalTestBase {
     @Before("@ThreadingAndWaitlistRepeatScenario")
     public void beforeScenario() throws IOException {
         tempLogFile = File.createTempFile("logfile", ".tmp");
-        tempLogFile.deleteOnExit(); 
+        tempLogFile.deleteOnExit();
         System.setOut(new PrintStream(tempLogFile));
     }
 
@@ -76,15 +76,15 @@ public void the_waitlist_will_try_to_resend_the_events_at_given_time_interval()
         List<String> lines = new ArrayList<>(Files.readAllLines(tempLogFile.toPath()));
 
         for (String line : lines) {
-            Pattern pattern = Pattern.compile("\\[EIFFEL EVENT RESENT\\] id:([a-zA-Z\\d-]+)");
+            Pattern pattern = Pattern.compile("\\[EIFFEL EVENT RESENT\\] id: ([a-zA-Z\\d-]+)");
             Matcher matcher = pattern.matcher(line);
             if (matcher.find() && !matcher.group(1).equals("")) {
                 if (!resentEvents.contains(matcher.group(1))) {
                     resentEvents.add(matcher.group(1));
                 }
             }
         }
-        assertEquals(resentEvents.size(), getEventNamesToSend().size());
+        assertEquals(getEventNamesToSend().size(), resentEvents.size());
     }
 
     @Then("^correct amount of threads should be spawned$")

src/functionaltests/java/com/ericsson/ei/utils/DataBaseManager.java

@@ -153,7 +153,7 @@ private List<String> compareSentEventsWithEventsInDB(List<String> checklist) {
 
     /**
      * Retrieve a value from a database query result
-     * 
+     *
      * @param key
      * @param index
      * @return String value matching the given key

src/functionaltests/java/com/ericsson/ei/utils/EventManager.java

@@ -45,7 +45,7 @@ public void sendEiffelEvents(String eiffelEventsJsonPath, List<String> eventName
      * Send Eiffel Event to the waitlist queue. Takes a Json String containing a
      * single event.
 
-     * 
+     *
      * @param eiffelEventJson
      */
     public void sendEiffelEvent(String eiffelEventJson) {
@@ -87,7 +87,7 @@ public JsonNode getJSONFromFile(String filePath) throws IOException {
 
     /**
      * Converts a JSON string into a tree model.
-     * 
+     *
      * @param document
      *            string of json
      * @return JsonNode tree model

src/functionaltests/java/com/ericsson/ei/utils/HttpExecutor.java

@@ -23,17 +23,17 @@ public final class HttpExecutor {
     private static final Logger LOGGER = LoggerFactory.getLogger(HttpExecutor.class);
 
     private HttpExecutor() {
-        
+
     }
-    
+
     public static HttpExecutor getInstance() {
         if(instance == null) {
             instance = new HttpExecutor();
         }
-        
+
         return instance;
     }
-    
+
     /**
      * Close existing HttpClient and create a new one.
      *
@@ -49,7 +49,7 @@ public void recreateHttpClient() {
         }
         this.client = HttpClientBuilder.create().build();
     }
-    
+
     /**
      * Handle the response from a HTTP request
      * @param request
@@ -71,7 +71,7 @@ public ResponseEntity<String> executeRequest(HttpRequestBase request) {
         } catch(IOException e) {
             LOGGER.error(e.getMessage(), e);
         }
-        
+
         MultiValueMap<String, String> headersMap = new LinkedMultiValueMap<String, String>();
         for (Header header : headers) {
             headersMap.add(header.getName(), header.getValue());

src/functionaltests/java/com/ericsson/ei/utils/HttpRequest.java

@@ -62,17 +62,17 @@ public HttpRequest(HttpMethod method) {
             break;
         }
     }
-    
+
     /*
      * Function that clean parameters field only.
      */
     public void cleanParams() {
         params.clear();
     }
-    
+
     /*
      * Function that resets the HTTP Request object so it can be reused.
-     * 
+     *
      */
     public void resetHttpRequestObject() {
         this.cleanParams();
@@ -81,10 +81,10 @@ public void resetHttpRequestObject() {
 
     /*
      * Function for adding headers to the http request.
-     * 
+     *
      * @param key , the key of the header
      * @param value, the value of the header
-     * 
+     *
      * @return HTTPRequest
      */
     public HttpRequest addHeader(String key, String value) {
@@ -94,10 +94,10 @@ public HttpRequest addHeader(String key, String value) {
 
     /*
      * Function for adding parameters to the http request.
-     * 
+     *
      * @param key , the key of the parameter
      * @param value, the value of the parameter
-     * 
+     *
      * @return HTTPRequest
      */
     public HttpRequest addParam(String key, String value) {
@@ -107,9 +107,9 @@ public HttpRequest addParam(String key, String value) {
 
     /*
      * Function that set the body of the http request.
-     * 
+     *
      * @param body , the body to be set in the http request.
-     * 
+     *
      * @return HTTPRequest
      */
     public HttpRequest setBody(String body) {
@@ -119,7 +119,7 @@ public HttpRequest setBody(String body) {
 
     /*
      * Function that set the body of the http request.
-     * 
+     *
      * @param body , the file with body content to be set in the http request.
      */
     public void setBody(File file) {
@@ -134,7 +134,7 @@ public void setBody(File file) {
 
     /*
      * Function that execute http request.
-     * 
+     *
      * @return ResponseEntity<String> , the response of the performed http request.
      */
     public ResponseEntity<String> performRequest() throws URISyntaxException {

src/functionaltests/resources/eiffel_events_for_test.json

@@ -52,7 +52,7 @@
         "classifier": ""
       }
       ],
-            
+
       "identity": "pkg:maven/com.mycompany.myproduct/artifact-name@1.0.0"
     }
   },