EI Backend Instances fault handling and logging improvements. (#199)

tobiasake · web-flow · commit 4c23f0211632 · 2019-05-07T09:30:42.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -31,7 +31,7 @@ install:
   - chmod +x pom.xml
   - mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
   - export EIFFEL_WAR=$(ls target/*.war)
-  - java -Dspring.config.location=file:../src/integrationtest/resources/integration-test.properties -Dserver.port=${EI_BACKEND_PORT} -jar ${EIFFEL_WAR} &
+  - java -Dspring.config.additional-location=file:../src/integrationtest/resources/integration-test.properties -Dserver.port=${EI_BACKEND_PORT} -jar ${EIFFEL_WAR} &
   - cd ..
 
 
diff --git a/src/integrationtest/resources/integration-test.properties b/src/integrationtest/resources/integration-test.properties
@@ -93,6 +93,7 @@ testaggregated.enabled: true
 threads.corePoolSize: 100
 threads.queueCapacity: 5000
 threads.maxPoolSize: 150
+
 # name of the collection where missed notifications are stored
 missedNotificationCollectionName: Notification
 # name of the database where missed notifications are stored
diff --git a/src/main/java/com/ericsson/ei/frontend/BackEndInformationController.java b/src/main/java/com/ericsson/ei/frontend/BackEndInformationController.java
@@ -42,15 +42,15 @@ public class BackEndInformationController {
     @CrossOrigin
     @RequestMapping(value = "/backend", method = RequestMethod.GET)
     public ResponseEntity<String> getInstances(Model model, HttpServletRequest request) {
-        LOG.debug("Recieved request for instances.");
+        LOG.debug("Received request for retrieving EI Backend instances list.");
         ResponseEntity<String> response = backEndInfoContUtils.handleRequestForInstances(request);
         return response;
     }
 
     @CrossOrigin
     @RequestMapping(value = "/backend", method = RequestMethod.PUT)
     public ResponseEntity<String> switchBackEndInstance(Model model, HttpServletRequest request) {
-        LOG.debug("Recieved request to switch back end.");
+        LOG.debug("Received request to switch EI back end instance.");
         ResponseEntity<String> response  = backEndInfoContUtils.handleRequestToSwitchBackEnd(request);
         return response;
 
@@ -59,15 +59,15 @@ public ResponseEntity<String> switchBackEndInstance(Model model, HttpServletRequ
     @CrossOrigin
     @RequestMapping(value = "/backend", method = RequestMethod.DELETE)
     public ResponseEntity<String> deleteBackEndInstance(Model model, HttpServletRequest request) {
-        LOG.debug("Recieved request to delete back end.");
+        LOG.debug("Received request to delete EI back end instance.");
         ResponseEntity<String> response  = backEndInfoContUtils.handleRequestToDeleteBackEnd(request);
         return response;
     }
 
     @CrossOrigin
     @RequestMapping(value = "/backend", method = RequestMethod.POST)
     public ResponseEntity<String> addInstanceInformation(Model model, HttpServletRequest request) {
-        LOG.debug("Recieved request to add back end.");
+        LOG.debug("Received request to add EI back end instance.");
         ResponseEntity<String> response  = backEndInfoContUtils.handleRequestToAddBackEnd(request);
         return response;
     }
diff --git a/src/main/java/com/ericsson/ei/frontend/EIRequestsController.java b/src/main/java/com/ericsson/ei/frontend/EIRequestsController.java
@@ -48,6 +48,7 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RestController;
 
+import com.ericsson.ei.frontend.exceptions.EiBackendInstancesException;
 import com.ericsson.ei.frontend.utils.EIRequestsControllerUtils;
 
 @RestController
@@ -73,7 +74,14 @@ public class EIRequestsController {
             "/queryAggregatedObject", "/queryMissedNotifications", "/query",
             "/rules/rule-check/testRulePageEnabled" }, method = RequestMethod.GET)
     public ResponseEntity<String> getRequests(Model model, HttpServletRequest incomingRequest) {
-        String eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        String eiRequestUrl;
+        try {
+            eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        } catch (EiBackendInstancesException e) {
+            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
+            return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
+        }
         HttpGet outgoingRequest = new HttpGet(eiRequestUrl);
 
         outgoingRequest = (HttpGet) addHeadersToRequest(outgoingRequest, incomingRequest);
@@ -92,7 +100,14 @@ public ResponseEntity<String> getRequests(Model model, HttpServletRequest incomi
     @RequestMapping(value = { "/subscriptions", "/rules/rule-check/aggregation",
             "/query" }, method = RequestMethod.POST)
     public ResponseEntity<String> postRequests(Model model, HttpServletRequest incomingRequest) {
-        String eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        String eiRequestUrl;
+        try {
+            eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        } catch (EiBackendInstancesException e) {
+            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
+            return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
+        }
         String requestBody = "";
 
         try {
@@ -129,7 +144,14 @@ public ResponseEntity<String> postRequests(Model model, HttpServletRequest incom
     @CrossOrigin
     @RequestMapping(value = "/subscriptions", method = RequestMethod.PUT)
     public ResponseEntity<String> putRequests(Model model, HttpServletRequest incomingRequest) {
-        String eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        String eiRequestUrl;
+        try {
+            eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        } catch (EiBackendInstancesException e) {
+            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
+            return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
+        }
         String requestBody = "";
 
         try {
@@ -164,8 +186,14 @@ public ResponseEntity<String> putRequests(Model model, HttpServletRequest incomi
     @CrossOrigin
     @RequestMapping(value = "/subscriptions/*", method = RequestMethod.DELETE)
     public ResponseEntity<String> deleteRequests(Model model, HttpServletRequest incomingRequest) {
-        String eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
-
+        String eiRequestUrl;
+        try {
+            eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
+        } catch (EiBackendInstancesException e) {
+            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
+            return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
+        }
         HttpDelete outgoingRequest = new HttpDelete(eiRequestUrl);
 
         outgoingRequest = (HttpDelete) addHeadersToRequest(outgoingRequest, incomingRequest);
diff --git a/src/main/java/com/ericsson/ei/frontend/config/CheckEIConfigurations.java b/src/main/java/com/ericsson/ei/frontend/config/CheckEIConfigurations.java
@@ -0,0 +1,39 @@
+package com.ericsson.ei.frontend.config;
+
+import java.io.IOException;
+
+import javax.annotation.PostConstruct;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Component;
+
+
+@Component
+public class CheckEIConfigurations {
+    
+    private static final Logger LOGGER = LoggerFactory.getLogger(CheckEIConfigurations.class);
+    
+    @Autowired
+    Environment env;
+    
+    @PostConstruct
+    public void logAndCheckConfiguration() {
+            
+        LOGGER.debug("EI Frontend started with following configurations:\n"
+                + "server.port: " + env.getProperty("server.port") + "\n"
+                + "ei.frontend.service.port: " + env.getProperty("ei.frontend.service.port") + "\n"
+                + "ei.frontend.service.host: " + env.getProperty("ei.frontend.service.host") + "\n"
+                + "ei.frontend.context.path: " + env.getProperty("ei.frontend.context.path") + "\n"
+                + "ei.use.secure.http.frontend: " + env.getProperty("ei.use.secure.http.frontend") + "\n"
+                + "ei.backend.instances.filepath: " + env.getProperty("ei.backend.instances.filepath") + "\n"
+                + "ei.backend.instances.list.json.content: " + env.getProperty("ei.backend.instances.list.json.content") + "\n"
+                + "ei.eiffel.documentation.urls: " + env.getProperty("ei.eiffel.documentation.urls") + "\n"
+                + "logging.level.root: " + env.getProperty("logging.level.root") + "\n"
+                + "logging.level.org.springframework.web: " + env.getProperty("logging.level.org.springframework.web") + "\n"
+                + "logging.level.com.ericsson.ei: " + env.getProperty("logging.level.com.ericsson.ei") + "\n"
+                + "\nThese properties is only some of the configurations, more configurations may have been provided.\n");
+    }
+}
diff --git a/src/main/java/com/ericsson/ei/frontend/exceptions/EiBackendInstancesException.java b/src/main/java/com/ericsson/ei/frontend/exceptions/EiBackendInstancesException.java
@@ -0,0 +1,35 @@
+/*
+   Copyright 2019 Ericsson AB.
+   For a full list of individual contributors, please see the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+package com.ericsson.ei.frontend.exceptions;
+
+public class EiBackendInstancesException extends Exception {
+    
+    private static final long serialVersionUID = 2L;
+    
+    public EiBackendInstancesException() {
+        super();
+    }
+    
+    public EiBackendInstancesException(String message) {
+        super(message);
+    }
+    
+    public EiBackendInstancesException(String message, Throwable e) {
+        super(message, e);
+    }
+    
+}
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstanceFileUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstanceFileUtils.java
@@ -2,6 +2,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.PrintWriter;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -75,6 +76,7 @@ public void init() throws IOException {
                     LOG.debug("EI Instances List file path is not provided! " +
                             "Will create a default EI Instances List file at file path: " + eiInstancesPath);
                 }
+                LOG.info("Loading EI-Backend instances from EI Instances List file: " + eiInstancesPath);
                 parseAndSetEiInstancesList();
             }
 
@@ -155,14 +157,19 @@ private void setDefaultEiBackendInstance(JsonArray jArray) {
      * @return JsonArray
      */
     public JsonArray getInstancesFromFile() {
+        LOG.debug("Reading EI Instances File: " + eiInstancesPath);
         try {
             ensureValidFile();
 
             JsonArray inputBackEndInstances = new JsonParser()
                     .parse(new String(Files.readAllBytes(Paths.get(eiInstancesPath)))).getAsJsonArray();
+            if (inputBackEndInstances.isJsonNull() || inputBackEndInstances.size() < 1) {
+                LOG.debug("EI Instance file does not exist or is empty. Returning an empty EI Instance json list.");
+                return new JsonArray();
+            }
             return inputBackEndInstances;
-        } catch (IOException e) {
-            LOG.error("Failure when try to parse json file" + e.getMessage());
+        } catch (Exception e) {
+            LOG.error("Failure when try to parse EI instances json file. Error: " + e.getMessage());
             return new JsonArray();
         }
     }
@@ -176,7 +183,7 @@ public void dumpJsonArray(JsonArray jsonArrayToDump) {
         try {
             Files.write(Paths.get(eiInstancesPath), jsonArrayToDump.toString().getBytes());
         } catch (IOException e) {
-            LOG.error("Couldn't add instance to file " + e.getMessage());
+            LOG.error("Couldn't add EI instance to EI Instances file. Error: " + e.getMessage());
         }
 
     }
@@ -189,7 +196,7 @@ private void ensureValidFile() {
             }
 
             if (!fileContainsJsonArray()) {
-                LOG.error("File does not contain valid json! JSON:' "
+                LOG.error("EI Instances file does not contain valid json! JSON:' "
                         + new String(Files.readAllBytes(Paths.get(eiInstancesPath))) + "'.");
                 System.exit(-1);
             }
@@ -211,17 +218,19 @@ private void createFileWithDirs() throws IOException {
             eiInstancesParentFolder.mkdirs();
         }
 
-        LOG.debug("File does not exist! Trying to create file.");
+        LOG.debug("EI Instances file does not exist! Trying to create file.");
         Files.createFile(Paths.get(eiInstancesPath));
-        Files.write(Paths.get(eiInstancesPath), "[]".getBytes());
+        PrintWriter eiInstanceFilePrintWriter = new PrintWriter(eiInstancesPath);
+        eiInstanceFilePrintWriter.println("[]");
+        eiInstanceFilePrintWriter.close();
     }
 
     private boolean fileContainsJsonArray() {
         try {
             new JsonParser().parse(new String(Files.readAllBytes(Paths.get(eiInstancesPath)))).getAsJsonArray();
             return true;
         } catch (Exception e) {
-            LOG.error("Failure when try to parse json file" + e.getMessage());
+            LOG.error("Failure when try to parse EI Instances json file. Error: " + e.getMessage());
             return false;
         }
     }
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstancesUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstancesUtils.java
@@ -194,7 +194,6 @@ public BackEndInformation getBackEndInformationByName(String backEndName) {
         }
 
         if (backEndInformationList.size() == 0) {
-            LOG.error("No backend information found!");
             return null;
         }
 
@@ -240,6 +239,7 @@ public void deleteBackEnd(JsonObject objectToDelete) {
      * @return JsonArray with back end information data.
      */
     public JsonArray getBackEndsAsJsonArray() {
+        LOG.debug("Read and return EI Backend instances as JsonArray.");
         parseBackEndInstances();
         return parseBackEndsAsJsonArray();
     }
@@ -261,6 +261,7 @@ public void setDefaultBackEndInstanceToNull() {
      * @param def
      */
     public void setDefaultBackEndInstance(String name, String host, int port, String contextPath, boolean def) {
+        LOG.debug("Setting default EI Instance: " + name + ", " + host + ":" + port);
         getDefaultBackendInformation().setName(name);
         getDefaultBackendInformation().setHost(host);
         getDefaultBackendInformation().setPort(String.valueOf(port));
@@ -348,7 +349,7 @@ private boolean parsingIsApplicable() {
 
     private void ensureDefaultBackEnd() {
         if (defaultBackendInformation.getHost() == null || defaultBackendInformation.getPort() == null) {
-            LOG.debug("No default Host or Port set!");
+            LOG.debug("No default EI Backend instance Host and/or Port has been set!");
             return;
         }
         defaultBackendInformation.setDefaultBackend(true);
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/EIRequestsControllerUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/EIRequestsControllerUtils.java
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
