Primary version fetched from pom not application.properties

Anders Breid · web-flow · commit e4135e282366 · 2018-12-11T11:12:07.000+01:00
Improvements:
* Now fetches version and application name from pom.xml
* New default-application.properties contains properties that should not be changed after release.
* build.version property in application.properties may be set but should be empty by default, will render an extra version after the primary version within ()

Minor fixes to responses when adding back-end instances.
diff --git a/pom.xml b/pom.xml
@@ -133,6 +133,22 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+                <includes>
+                    <include>**/default-application.properties</include>
+                </includes>
+            </resource>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>false</filtering>
+                <excludes>
+                    <exclude>**/default-application.properties</exclude>
+                </excludes>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
diff --git a/src/main/java/com/ericsson/ei/frontend/WebController.java b/src/main/java/com/ericsson/ei/frontend/WebController.java
@@ -54,7 +54,8 @@ public String testRules(Model model) {
     @RequestMapping("/eiInfo.html")
     public String eiInfo(Model model, HttpServletRequest request) {
         model.addAttribute("frontendServiceUrl", frontEndUtils.getFrontEndServiceUrl());
-        model.addAttribute("frontendServiceVersion", frontEndUtils.getVersion());
+        model.addAttribute("version", frontEndUtils.getVersion());
+        model.addAttribute("applicationPropertiesVersion", frontEndUtils.getApplicationPropertiesVersion());
         model.addAttribute("frontendAppName", frontEndUtils.getApplicationName());
         model.addAttribute("backendServerUrl", frontEndUtils.getBackEndServiceUrl(request.getSession()));
         return "eiInfo";
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstanceFileUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstanceFileUtils.java
@@ -14,7 +14,6 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
-import com.ericsson.ei.frontend.model.BackEndInformation;
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
@@ -57,7 +56,7 @@ public void init() throws IOException {
             if (!eiHomeExists) {
                 createEiHomeFolder(eiHome);
             }
-            
+
             Path eiInstancesListFilePath = Paths.get(eiHome, BACKEND_INSTANCES_DEFAULT_FILENAME);
             setEiInstancesPath(eiInstancesListFilePath.toString());
             File eiInstancesListFile = new File(eiInstancesListFilePath.toString());
@@ -94,7 +93,7 @@ public void init() throws IOException {
     /**
      * Parses Ei Instances list from backendInstancesListJsonContent property and
      * sets default EI-Backend instance.
-     * 
+     *
      */
     private void parseAndSetEiInstancesList() {
         JsonArray parsedBackendInstancesListJsonArray = null;
@@ -111,7 +110,7 @@ private void parseAndSetEiInstancesList() {
 
     /**
      * Parses Ei Instances list from backendInstancesListJsonContent property.
-     * 
+     *
      * @return JsonArray
      */
     private JsonArray parseEiInstancesListJsonObject() {
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstancesUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/BackEndInstancesUtils.java
@@ -23,7 +23,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 import com.ericsson.ei.frontend.model.BackEndInformation;
diff --git a/src/main/java/com/ericsson/ei/frontend/utils/WebControllerUtils.java b/src/main/java/com/ericsson/ei/frontend/utils/WebControllerUtils.java
@@ -16,6 +16,10 @@
 */
 package com.ericsson.ei.frontend.utils;
 
+import java.io.IOException;
+import java.util.Properties;
+
+import javax.annotation.PostConstruct;
 import javax.servlet.http.HttpSession;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -36,30 +40,39 @@
 @AllArgsConstructor
 public class WebControllerUtils {
 
-    @Value("${ei.frontendServiceHost}")
+    @Value("${ei.frontendServiceHost:#{null}}")
     private String frontendServiceHost;
 
-    @Value("${ei.frontendServicePort}")
+    @Value("${ei.frontendServicePort:#{null}}")
     private int frontendServicePort;
 
-    @Value("${ei.frontendContextPath}")
+    @Value("${ei.frontendContextPath:#{null}}")
     private String frontendContextPath;
 
-    @Value("${ei.useSecureHttpFrontend}")
+    @Value("${ei.useSecureHttpFrontend:#{null}}")
     private boolean useSecureHttpFrontend;
 
-    @Value("${ei.eiffelDocumentationUrls}")
+    @Value("${ei.eiffelDocumentationUrls:#{null}}")
     private String eiffelDocumentationUrls;
 
-    @Value("${spring.application.name}")
-    private String applicationName;
+    @Value("${build.version:#{null}}")
+    private String applicationPropertiesVersion;
 
-    @Value("${build.version}")
     private String version;
 
+    private String applicationName;
+
     @Autowired
     private BackEndInstancesUtils backEndInstancesUtils;
 
+    @PostConstruct
+    public void init() throws IOException {
+        Properties properties = new Properties();
+        properties.load(WebControllerUtils.class.getResourceAsStream("/default-application.properties"));
+        version = properties.getProperty("version");
+        applicationName = properties.getProperty("artifactId");
+    }
+
     /**
      * Formats the parameters in the class to an URL as String.
      *
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -1,9 +1,9 @@
 # REST api returns json in pretty format with jackson
 spring.jackson.default-property-inclusion=non_null
 
-spring.application.name=ei-frontend
-  #${project.artifactId}
-build.version=@project.version@
+# An extra optional version tag, version will be added after github release version 
+# Example if build.version=1.2.3-internal becomes Version 0.0.18 (1.2.3-internal)
+build.version=
 
 server.port=8080
 #server.ssl.key-store: <keystore.p12>
diff --git a/src/main/resources/default-application.properties b/src/main/resources/default-application.properties
@@ -0,0 +1,2 @@
+artifactId=@project.artifactId@
+version=@project.version@
diff --git a/src/main/resources/static/js/eiInfo.js b/src/main/resources/static/js/eiInfo.js
@@ -1,9 +1,15 @@
 jQuery(document).ready(function() {
     // Fetch injected URL from DOM
-    var frontendServiceUrl = $('#frontendServiceUrl').text();
-    var backendServerUrl = $('#backendServerUrl').text();
+    var frontEndServiceUrl = $('#frontendServiceUrl').text();
+    var frontEndVersion = $('#frontEndVersion').text();
+    var frontEndApplicationPropertiesVersion = $('#frontEndApplicationPropertiesVersion').text();
+    var frontEndAppName = $('#frontendAppName').text();
+
+    var backEndServerUrl = $('#backendServerUrl').text();
 
     var body = document.getElementById('eiPageFrame');
+    var generalEIInfoLabel = "General Eiffel Intelligence Information";
+    var generalEIFrontEndInfoLabel = "General Eiffel Intelligence Front-End Information";
 
     function createTable() {
         var tbl = document.createElement('table');
@@ -25,24 +31,47 @@ jQuery(document).ready(function() {
         return element;
     }
 
-    function generateGeneralEiInfo(data) {
-        var tbdy = document.createElement('tbody');
+    function createFrontEndGeneralInfo() {
+        if (frontEndApplicationPropertiesVersion) {
+            frontEndVersion = frontEndVersion + " (" + frontEndApplicationPropertiesVersion + ")";
+        }
+        var tableContent = [
+            { key: 'Application Name', value: frontEndAppName },
+            { key: 'Version', value: frontEndVersion },
+            { key: 'EI Front-End URL', value: frontEndServiceUrl }
+        ];
 
-        var label = createLabel('General Eiffel Intelligence Information');
-        body.appendChild(label);
+        generateGeneralInfo(tableContent, generalEIFrontEndInfoLabel);
+    }
 
-        var div = document.createElement('div');
-        div.setAttribute('class','table-responsive');
+    function createGeneralEIInfo(data) {
 
-        var tbl = createTable();
+        if (data.applicationPropertiesVersion) {
+            data.version = data.version + " (" + data.applicationPropertiesVersion + ")";
+        }
 
         var tableContent = [
             { key: 'Application Name', value: data.applicationName },
             { key: 'Version', value: data.version },
-            { key: 'EI Backend Connected Server', value: backendServerUrl },
-            { key: 'EI Test Rules functionality enabled', value: data.testRulesEnabled },
+            { key: 'Rules File Path', value: data.rulesPath },
+            { key: 'EI Back-End Connected Server', value: backEndServerUrl },
+            { key: 'EI Test Rules functionality enabled', value: data.testRulesEnabled }
         ];
 
+        generateGeneralInfo(tableContent, generalEIInfoLabel);
+    }
+
+    function generateGeneralInfo(tableContent, labelText) {
+        var tbdy = document.createElement('tbody');
+
+        var label = createLabel(labelText);
+        body.appendChild(label);
+
+        var div = document.createElement('div');
+        div.setAttribute('class','table-responsive');
+
+        var tbl = createTable();
+
         for (i = 0; i < tableContent.length; i++) {
             key = tableContent[i].key;
             value = tableContent[i].value;
@@ -96,24 +125,19 @@ jQuery(document).ready(function() {
 
     function getInstanceInfo() {
         $.ajax({
-            url: frontendServiceUrl + "/information",
+            url: frontEndServiceUrl + "/information",
             contentType : 'application/json;charset=UTF-8',
             type: 'GET',
             error : function (XMLHttpRequest, textStatus, errorThrown) {
-                var label = createLabel('General Eiffel Intelligence Information');
+                var label = createLabel(generalEIInfoLabel);
                 body.appendChild(label);
-                if (XMLHttpRequest.responseText == "") {
-                    var element = createErrorMessage('<strong>Error</strong> There is no response from backend!');
-                    body.appendChild(element);
-                } else {
-                    var element = createErrorMessage('Error: ' + XMLHttpRequest.responseText + '!');
-                    body.appendChild(element);
-                }
+                var element = createErrorMessage('<strong>Error:</strong> Could not fetch information from back-end!');
+                body.appendChild(element);
             },
             success : function (data, textStatus, xhr) {
                 var eiInfoContainer = document.getElementById('eiInfoContainer');
                 var data = JSON.parse(xhr.responseText);
-                generateGeneralEiInfo(data);
+                createGeneralEIInfo(data);
                 generateEIInformationBasedOnList(data.rabbitmq, "Eiffel Intelligence Connected RabbitMq Instances");
                 generateEIInformationBasedOnList(data.mongodb, "Eiffel Intelligence Connected MongoDb Instances");
                 generateEIInformationBasedOnList(data.threads, "Eiffel Intelligence Backend Java Threads Settings");
@@ -130,6 +154,7 @@ jQuery(document).ready(function() {
         });
     }
 
+    createFrontEndGeneralInfo();
     getInstanceInfo();
 
 });
diff --git a/src/main/resources/templates/eiInfo.html b/src/main/resources/templates/eiInfo.html
@@ -10,42 +10,12 @@
 
 <body class="nav-link">
     <div class="d-none" id="frontendServiceUrl" th:text="${frontendServiceUrl}"></div>
-    <div class="d-none" id="frontendServiceVersion" th:text="${frontendServiceVersion}"></div>
+    <div class="d-none" id="frontEndVersion" th:text="${version}"></div>
+    <div class="d-none" id="frontEndApplicationPropertiesVersion" th:text="${applicationPropertiesVersion}"></div>
+    <div class="d-none" id="frontendAppName" th:text="${frontendAppName}"></div>
     <div class="d-none" id="backendServerUrl" th:text="${backendServerUrl}"></div>
 
-    <div class="col-12" id="eiPageFrame">
-        <p class="section-p-text table-text-setting">General Eiffel Intelligence Front End Information</p>
-        <div class="table-responsive">
-            <table class="table table-bordered table-striped dataTable table-text-setting">
-                <tbody>
-                    <tr>
-                        <td class="left-table-pane">
-                            Application Name
-                        </td>
-                        <td>
-                            <span th:text="${frontendAppName}"></span>
-                        </td>
-                    </tr>
-                    <tr>
-                        <td class="left-table-pane">
-                            Application Version
-                        </td>
-                        <td>
-                            <span th:text="${frontendServiceVersion}"></span>
-                        </td>
-                    </tr>
-                    <tr>
-                        <td class="left-table-pane">
-                            Application URL
-                        </td>
-                        <td>
-                            <span th:text="${frontendServiceUrl}"></span>
-                        </td>
-                    </tr>
-                </tbody>
-            </table>
-        </div>
-    </div>
+    <div class="col-12" id="eiPageFrame"></div>
 
     <script type="text/javascript" src="js/eiInfo.js"></script>
 
diff --git a/src/test/java/com/ericsson/ei/frontend/WebControllerUtilsTest.java b/src/test/java/com/ericsson/ei/frontend/WebControllerUtilsTest.java
@@ -35,7 +35,7 @@ public class WebControllerUtilsTest {
     @Test
     public void testGetFrontEndServiceUrl() throws Exception {
       String expectedUrl = String.format("http://%s:%s%s", HOST, PORT, CONTEXT_PATH);
-      controllerUtils = new WebControllerUtils(HOST, PORT, CONTEXT_PATH, false, null, null, null, null);
+      controllerUtils = new WebControllerUtils(HOST, PORT, CONTEXT_PATH, false, null, null, null, null, null);
       assertEquals(expectedUrl, controllerUtils.getFrontEndServiceUrl());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+artifactId=@project.artifactId@`
	`2`	`+version=@project.version@`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public class WebControllerUtilsTest {`
`35`	`35`	`@Test`
`36`	`36`	`public void testGetFrontEndServiceUrl() throws Exception {`
`37`	`37`	`String expectedUrl = String.format("http://%s:%s%s", HOST, PORT, CONTEXT_PATH);`
`38`		`- controllerUtils = new WebControllerUtils(HOST, PORT, CONTEXT_PATH, false, null, null, null, null);`
	`38`	`+ controllerUtils = new WebControllerUtils(HOST, PORT, CONTEXT_PATH, false, null, null, null, null, null);`
`39`	`39`	`assertEquals(expectedUrl, controllerUtils.getFrontEndServiceUrl());`
`40`	`40`	`}`
`41`	`41`