Develop

pom.xml

@@ -14,7 +14,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.0.2.RELEASE</version>
+		<version>2.3.1.RELEASE</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 
@@ -42,6 +42,17 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>org.springframework.boot</groupId>
+					<artifactId>spring-boot-starter-logging</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
         <dependency>
             <groupId>log4j</groupId>
             <artifactId>log4j</artifactId>
@@ -51,13 +62,13 @@
 		<dependency>
 			<groupId>io.springfox</groupId>
 			<artifactId>springfox-swagger2</artifactId>
-			<version>2.8.0</version>
+			<version>2.9.2</version>
 		</dependency>
 
 		<dependency>
 			<groupId>io.springfox</groupId>
 			<artifactId>springfox-swagger-ui</artifactId>
-			<version>2.8.0</version>
+			<version>2.9.2</version>
 			<scope>compile</scope>
 		</dependency>
 

src/main/java/cloud/fogbow/ms/api/http/request/Membership.java

@@ -16,7 +16,6 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.io.FileNotFoundException;
 import java.util.List;
 
 @CrossOrigin
@@ -32,11 +31,7 @@ public class Membership {
     private MembershipService membershipService;
 
     public Membership() {
-        try {
-            this.membershipService = new WhiteList();
-        } catch (FileNotFoundException e) {
-            LOGGER.error(String.format(Messages.Error.CONFIGURATION_FILE_NOT_FOUND), e);
-        }
+        this.membershipService = new WhiteList();
     }
 
     /**
@@ -54,7 +49,7 @@ public ResponseEntity<MembersList> listMembers() {
             MembersList membersList = new MembersList(membersId);
             return new ResponseEntity<MembersList>(membersList, HttpStatus.OK);
         } catch (Exception e) {
-            LOGGER.error(Messages.Error.INTERNAL_SERVER_ERROR, e);
+            LOGGER.error(Messages.Log.INTERNAL_SERVER_ERROR, e);
             return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
         }
     }

src/main/java/cloud/fogbow/ms/api/http/request/Version.java

@@ -1,24 +1,20 @@
 package cloud.fogbow.ms.api.http.request;
 
-import cloud.fogbow.common.util.HomeDir;
-import cloud.fogbow.common.constants.ApiDocumentation;
-import cloud.fogbow.ms.api.http.response.VersionNumber;
-import cloud.fogbow.ms.constants.*;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import org.apache.log4j.Logger;
+import cloud.fogbow.ms.core.PropertiesHolder;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.CrossOrigin;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
+import cloud.fogbow.common.constants.ApiDocumentation;
+import cloud.fogbow.ms.api.http.response.VersionNumber;
+import cloud.fogbow.ms.constants.ConfigurationPropertyDefaults;
+import cloud.fogbow.ms.constants.ConfigurationPropertyKeys;
+import cloud.fogbow.ms.constants.SystemConstants;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 
 @CrossOrigin
 @RestController
@@ -28,45 +24,21 @@ public class Version {
 
     public static final String VERSION_ENDPOINT = SystemConstants.SERVICE_BASE_ENDPOINT + "version";
 
-    private final Logger LOGGER = Logger.getLogger(Version.class);
-
     @ApiOperation(value = ApiDocumentation.Version.GET_OPERATION)
     @RequestMapping(method = RequestMethod.GET)
-    public ResponseEntity<VersionNumber> getVersion() throws FileNotFoundException {
+    public ResponseEntity<VersionNumber> getVersion() {
         String versionNumber = getVersionNumber();
         return new ResponseEntity<VersionNumber>(new VersionNumber(versionNumber), HttpStatus.OK);
     }
 
-    public String getVersionNumber() throws FileNotFoundException {
-        String path = HomeDir.getPath();
-        return getVersionNumber(path + SystemConstants.CONF_FILE_NAME);
-    }
-
-    // Used in tests only
-    protected String getVersionNumber(String filePath) throws FileNotFoundException {
-        return SystemConstants.API_VERSION_NUMBER + "-" + readBuildFromFile(filePath);
+    public String getVersionNumber() {
+        return SystemConstants.API_VERSION_NUMBER + "-" + readBuildNumber();
     }
 
-    private String readBuildFromFile(String membershipConfPath) throws FileNotFoundException {
-        Properties properties = new Properties();
-        InputStream input = new FileInputStream(membershipConfPath);
-        String build = "empty";
-
-        try {
-            properties.load(input);
-
-            build = properties.getProperty(ConfigurationPropertyKeys.BUILD_NUMBER_KEY,
+    private String readBuildNumber() {
+        String build;
+        build = PropertiesHolder.getInstance().getProperty(ConfigurationPropertyKeys.BUILD_NUMBER_KEY,
                     ConfigurationPropertyDefaults.BUILD_NUMBER);
-        } catch (IOException e) {
-            LOGGER.warn(String.format(Messages.Warn.ERROR_READING_CONF_FILE, membershipConfPath), e);
-        } finally {
-            try {
-                input.close();
-            } catch (IOException e) {
-                LOGGER.warn(String.format(Messages.Warn.ERROR_CLOSING_CONF_FILE, membershipConfPath), e);
-            }
-        }
-
         return build;
     }
 }

src/main/java/cloud/fogbow/ms/constants/Messages.java

@@ -4,19 +4,7 @@ public class Messages {
     public static class Exception {
     }
 
-    public static class Fatal {
-    }
-
-    public static class Warn {
-        public static final String ERROR_READING_CONF_FILE = "Error trying to read configuration file: %s.";
-        public static final String ERROR_CLOSING_CONF_FILE = "Error trying to close configuration file: %s.";
-    }
-
-    public static class Info {
-    }
-
-    public static class Error {
-        public static final String CONFIGURATION_FILE_NOT_FOUND = "Configuration file not found.";
+    public static class Log {
         public static final String INTERNAL_SERVER_ERROR = "Internal server error.";
     }
 }

src/main/java/cloud/fogbow/ms/core/PropertiesHolder.java

@@ -0,0 +1,38 @@
+package cloud.fogbow.ms.core;
+
+import cloud.fogbow.common.util.PropertiesUtil;
+import cloud.fogbow.common.exceptions.FatalErrorException;
+import cloud.fogbow.common.util.HomeDir;
+import cloud.fogbow.ms.constants.SystemConstants;
+
+import java.util.Properties;
+
+public class PropertiesHolder {
+    private Properties properties;
+    private static PropertiesHolder instance;
+
+    private PropertiesHolder() throws FatalErrorException {
+        String path = HomeDir.getPath();
+        String configFileName = path + SystemConstants.CONF_FILE_NAME;
+        this.properties = PropertiesUtil.readProperties(configFileName);
+    }
+
+    public static synchronized PropertiesHolder getInstance() throws FatalErrorException {
+        if (instance == null) {
+            instance = new PropertiesHolder();
+        }
+        return instance;
+    }
+
+    public String getProperty(String propertyName) {
+        return properties.getProperty(propertyName);
+    }
+
+    public String getProperty(String propertyName, String defaultPropertyValue) {
+        String propertyValue = this.properties.getProperty(propertyName, defaultPropertyValue);
+        if (propertyValue.trim().isEmpty()) {
+            propertyValue = defaultPropertyValue;
+        }
+        return propertyValue;
+    }
+}

src/main/java/cloud/fogbow/ms/core/service/WhiteList.java

@@ -1,65 +1,38 @@
 package cloud.fogbow.ms.core.service;
 
-import cloud.fogbow.common.util.HomeDir;
-import cloud.fogbow.ms.MembershipService;
+import java.util.ArrayList;
+import java.util.List;
 
 import cloud.fogbow.ms.constants.ConfigurationPropertyKeys;
-import org.apache.log4j.Logger;
-import cloud.fogbow.ms.constants.Messages;
-import cloud.fogbow.ms.constants.SystemConstants;
+import cloud.fogbow.ms.core.PropertiesHolder;
 
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Properties;
+import cloud.fogbow.ms.MembershipService;
 
 public class WhiteList implements MembershipService {
 
-    private static final Logger LOGGER = Logger.getLogger(WhiteList.class);
+    private static final String SEPARATOR = ",";
 
     private List<String> membersList;
 
-    public WhiteList(String membershipConfPath) throws FileNotFoundException {
-        this.membersList = readMembersFromFile(membershipConfPath);
-    }
-
-    public WhiteList() throws FileNotFoundException {
-        this.membersList = readMembersFromFile(SystemConstants.CONF_FILE_NAME);
+    public WhiteList() {
+        this.membersList = readMembers();
     }
 
     /**
      * Read list of XMPP members ID from membership config file.
-     *
      */
     @Override
     public List<String> listMembers() {
         return this.membersList;
     }
 
-    private List<String> readMembersFromFile(String membershipConfPath) throws FileNotFoundException {
-        Properties properties = new Properties();
-        InputStream input = new FileInputStream(HomeDir.getPath() + membershipConfPath);
+    private List<String> readMembers() {
         List<String> membersList = new ArrayList<>();
 
-        try {
-            properties.load(input);
-
-            String membersListStr = properties.getProperty(ConfigurationPropertyKeys.MEMBERS_LIST_KEY);
-            for (String member : membersListStr.split(",")) {
-                member = member.trim();
-                membersList.add(member);
-            }
-        } catch (IOException e) {
-            LOGGER.warn(String.format(Messages.Warn.ERROR_READING_CONF_FILE, membershipConfPath), e);
-        } finally {
-            try {
-                input.close();
-            } catch (IOException e) {
-                LOGGER.warn(String.format(Messages.Warn.ERROR_CLOSING_CONF_FILE, membershipConfPath), e);
-            }
+        String membersListStr = PropertiesHolder.getInstance().getProperty(ConfigurationPropertyKeys.MEMBERS_LIST_KEY);
+        for (String member : membersListStr.split(SEPARATOR)) {
+            member = member.trim();
+            membersList.add(member);
         }
 
         return membersList;

src/main/resources/template/ms.conf

@@ -1,2 +1,3 @@
 # copy this file into src/main/resources/private
-members_list=member1,member2,member3
+members_list=member1,member2,member3
+build_number=[testing mode]

src/test/java/cloud/fogbow/ms/api/http/request/VersionTests.java

@@ -1,38 +1,70 @@
 package cloud.fogbow.ms.api.http.request;
 
-import cloud.fogbow.common.util.HomeDir;
-import cloud.fogbow.ms.constants.SystemConstants;
+import java.io.FileNotFoundException;
+
 import org.junit.Assert;
+import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
 
-import java.io.FileNotFoundException;
+import cloud.fogbow.ms.constants.SystemConstants;
 
+@RunWith(SpringRunner.class)
+@WebMvcTest
 public class VersionTests {
-    private String VALID_CONF = "ms-test.conf";
-    private String VALID_CONF_WITHOUT_BUILD_PROPERTY = "ms-test-nobuild.conf";
-    private String INVALID_CONF = "invalid.conf";
 
-    @Test
-    public void testVersion() throws Exception {
-        Version version = new Version();
+    private static final String BASE_ENDPOINT = "/";
+    private static final String BUILD_PROPERTY = "abcd";
+    private static final String VERSION_NUMBER_SEPARATOR = "-";
 
-        String build = version.getVersionNumber(HomeDir.getPath() + this.VALID_CONF);
+    @Autowired
+    private MockMvc mockMvc;
 
-        Assert.assertEquals(SystemConstants.API_VERSION_NUMBER + "-" + "abcd", build);
+    private Version version;
+
+    @Before
+    public void setup() {
+        this.version = new Version();
     }
 
+    // test case: When invoking the getVersionNumber method with no parameters, it
+    // must use a default file and return the version number concatenated the value
+    // of the default file build number property.
     @Test
-    public void testVersionWithoutBuildProperty() throws Exception {
-        Version version = new Version();
+    public void testVersionWithoutConfPath() throws Exception {
+        // exercise
+        String build = this.version.getVersionNumber();
 
-        String build = version.getVersionNumber(HomeDir.getPath() + this.VALID_CONF_WITHOUT_BUILD_PROPERTY);
+        // verify
+        Assert.assertEquals(SystemConstants.API_VERSION_NUMBER + VERSION_NUMBER_SEPARATOR + BUILD_PROPERTY, build);
+    }
 
-        Assert.assertTrue(build.equals(SystemConstants.API_VERSION_NUMBER + "-" + "[testing mode]"));
+    // test case: When executing a GET request for the "/ms/version" endpoint, it
+    // must invoke the getVersion method by returning the Status OK and the version
+    // content in format json.
+    @Test
+    public void testGetVersion() throws Exception {
+        // set up
+        String expected = getJsonResponseContent();
+
+        // exercise
+        this.mockMvc.perform(MockMvcRequestBuilders.get(BASE_ENDPOINT + Version.VERSION_ENDPOINT))
+                // verify
+                .andExpect(MockMvcResultMatchers.status().isOk())
+                .andExpect(MockMvcResultMatchers.content().json(expected));
     }
 
-    @Test(expected = FileNotFoundException.class)
-    public void testListMembersWithInvalidConfPath() throws FileNotFoundException {
-        Version version = new Version();
-        version.getVersionNumber(this.INVALID_CONF);
+    private String getJsonResponseContent() {
+        return "{\"version\":" + SystemConstants.API_VERSION_NUMBER
+                + VERSION_NUMBER_SEPARATOR
+                + BUILD_PROPERTY
+                + "}";
     }
+
 }